includes/specials/SpecialMIMEsearch.php

   1 <?php
   2 /**
   3  * Implements Special:MIMESearch
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  23  */
  24
  25 /**
  26  * Searches the database for files of the requested MIME type, comparing this with the
  27  * 'img_major_mime' and 'img_minor_mime' fields in the image table.
  28  * @ingroup SpecialPage
  29  */
  30 class MIMEsearchPage extends QueryPage {
  31         protected $major, $minor;
  32
  33         function __construct( $name = 'MIMEsearch' ) {
  34                 parent::__construct( $name );
  35         }
  36
  37         function isExpensive() {
  38                 return false;
  39         }
  40
  41         function isSyndicated() {
  42                 return false;
  43         }
  44
  45         function isCacheable() {
  46                 return false;
  47         }
  48
  49         function linkParameters() {
  50                 return array( 'mime' => "{$this->major}/{$this->minor}" );
  51         }
  52
  53         public function getQueryInfo() {
  54                 $qi = array(
  55                         'tables' => array( 'image' ),
  56                         'fields' => array(
  57                                 'namespace' => NS_FILE,
  58                                 'title' => 'img_name',
  59                                 // Still have a value field just in case,
  60                                 // but it isn't actually used for sorting.
  61                                 'value' => 'img_name',
  62                                 'img_size',
  63                                 'img_width',
  64                                 'img_height',
  65                                 'img_user_text',
  66                                 'img_timestamp'
  67                         ),
  68                         'conds' => array(
  69                                 'img_major_mime' => $this->major,
  70                                 'img_minor_mime' => $this->minor,
  71                                 // This is in order to trigger using
  72                                 // the img_media_mime index in "range" mode.
  73                                 'img_media_type' => array(
  74                                         MEDIATYPE_BITMAP,
  75                                         MEDIATYPE_DRAWING,
  76                                         MEDIATYPE_AUDIO,
  77                                         MEDIATYPE_VIDEO,
  78                                         MEDIATYPE_MULTIMEDIA,
  79                                         MEDIATYPE_UNKNOWN,
  80                                         MEDIATYPE_OFFICE,
  81                                         MEDIATYPE_TEXT,
  82                                         MEDIATYPE_EXECUTABLE,
  83                                         MEDIATYPE_ARCHIVE,
  84                                 ),
  85                         ),
  86                 );
  87
  88                 return $qi;
  89         }
  90
  91         /**
  92          * The index is on (img_media_type, img_major_mime, img_minor_mime)
  93          * which unfortunately doesn't have img_name at the end for sorting.
  94          * So tell db to sort it however it wishes (Its not super important
  95          * that this report gives results in a logical order). As an aditional
  96          * note, mysql seems to by default order things by img_name ASC, which
  97          * is what we ideally want, so everything works out fine anyhow.
  98          */
  99         function getOrderFields() {
 100                 return array();
 101         }
 102
 103         function execute( $par ) {
 104                 global $wgScript;
 105
 106                 $mime = $par ? $par : $this->getRequest()->getText( 'mime' );
 107
 108                 $this->setHeaders();
 109                 $this->outputHeader();
 110                 $this->getOutput()->addHTML(
 111                         Xml::openElement(
 112                                 'form',
 113                                 array( 'id' => 'specialmimesearch', 'method' => 'get', 'action' => $wgScript )
 114                         ) .
 115                                 Xml::openElement( 'fieldset' ) .
 116                                 Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
 117                                 Xml::element( 'legend', null, $this->msg( 'mimesearch' )->text() ) .
 118                                 Xml::inputLabel( $this->msg( 'mimetype' )->text(), 'mime', 'mime', 20, $mime ) .
 119                                 ' ' .
 120                                 Xml::submitButton( $this->msg( 'ilsubmit' )->text() ) .
 121                                 Xml::closeElement( 'fieldset' ) .
 122                                 Xml::closeElement( 'form' )
 123                 );
 124
 125                 list( $this->major, $this->minor ) = File::splitMime( $mime );
 126
 127                 if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
 128                         !self::isValidType( $this->major )
 129                 ) {
 130                         return;
 131                 }
 132
 133                 parent::execute( $par );
 134         }
 135
 136         /**
 137          * @param Skin $skin
 138          * @param object $result Result row
 139          * @return string
 140          */
 141         function formatResult( $skin, $result ) {
 142                 global $wgContLang;
 143
 144                 $nt = Title::makeTitle( $result->namespace, $result->title );
 145                 $text = $wgContLang->convert( $nt->getText() );
 146                 $plink = Linker::link(
 147                         Title::newFromText( $nt->getPrefixedText() ),
 148                         htmlspecialchars( $text )
 149                 );
 150
 151                 $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
 152                 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
 153                 $lang = $this->getLanguage();
 154                 $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
 155                 $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
 156                         $result->img_height )->escaped();
 157                 $user = Linker::link(
 158                         Title::makeTitle( NS_USER, $result->img_user_text ),
 159                         htmlspecialchars( $result->img_user_text )
 160                 );
 161
 162                 $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
 163                 $time = htmlspecialchars( $time );
 164
 165                 return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
 166         }
 167
 168         /**
 169          * @param $type string
 170          * @return bool
 171          */
 172         protected static function isValidType( $type ) {
 173                 // From maintenance/tables.sql => img_major_mime
 174                 $types = array(
 175                         'unknown',
 176                         'application',
 177                         'audio',
 178                         'image',
 179                         'text',
 180                         'video',
 181                         'message',
 182                         'model',
 183                         'multipart'
 184                 );
 185
 186                 return in_array( $type, $types );
 187         }
 188
 189         protected function getGroupName() {
 190                 return 'media';
 191         }
 192 }