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                 $minorType = array();
  55                 if ( $this->minor !== '*' ) {
  56                         // Allow wildcard searching
  57                         $minorType['img_minor_mime'] = $this->minor;
  58                 }
  59                 $qi = array(
  60                         'tables' => array( 'image' ),
  61                         'fields' => array(
  62                                 'namespace' => NS_FILE,
  63                                 'title' => 'img_name',
  64                                 // Still have a value field just in case,
  65                                 // but it isn't actually used for sorting.
  66                                 'value' => 'img_name',
  67                                 'img_size',
  68                                 'img_width',
  69                                 'img_height',
  70                                 'img_user_text',
  71                                 'img_timestamp'
  72                         ),
  73                         'conds' => array(
  74                                 'img_major_mime' => $this->major,
  75                                 // This is in order to trigger using
  76                                 // the img_media_mime index in "range" mode.
  77                                 'img_media_type' => array(
  78                                         MEDIATYPE_BITMAP,
  79                                         MEDIATYPE_DRAWING,
  80                                         MEDIATYPE_AUDIO,
  81                                         MEDIATYPE_VIDEO,
  82                                         MEDIATYPE_MULTIMEDIA,
  83                                         MEDIATYPE_UNKNOWN,
  84                                         MEDIATYPE_OFFICE,
  85                                         MEDIATYPE_TEXT,
  86                                         MEDIATYPE_EXECUTABLE,
  87                                         MEDIATYPE_ARCHIVE,
  88                                 ),
  89                         ) + $minorType,
  90                 );
  91
  92                 return $qi;
  93         }
  94
  95         /**
  96          * The index is on (img_media_type, img_major_mime, img_minor_mime)
  97          * which unfortunately doesn't have img_name at the end for sorting.
  98          * So tell db to sort it however it wishes (Its not super important
  99          * that this report gives results in a logical order). As an aditional
 100          * note, mysql seems to by default order things by img_name ASC, which
 101          * is what we ideally want, so everything works out fine anyhow.
 102          */
 103         function getOrderFields() {
 104                 return array();
 105         }
 106
 107         function execute( $par ) {
 108                 global $wgScript;
 109
 110                 $mime = $par ? $par : $this->getRequest()->getText( 'mime' );
 111                 $mime = trim( $mime );
 112
 113                 $this->setHeaders();
 114                 $this->outputHeader();
 115                 $this->getOutput()->addHTML(
 116                         Xml::openElement(
 117                                 'form',
 118                                 array( 'id' => 'specialmimesearch', 'method' => 'get', 'action' => $wgScript )
 119                         ) .
 120                                 Xml::openElement( 'fieldset' ) .
 121                                 Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
 122                                 Xml::element( 'legend', null, $this->msg( 'mimesearch' )->text() ) .
 123                                 Xml::inputLabel( $this->msg( 'mimetype' )->text(), 'mime', 'mime', 20, $mime ) .
 124                                 ' ' .
 125                                 Xml::submitButton( $this->msg( 'ilsubmit' )->text() ) .
 126                                 Xml::closeElement( 'fieldset' ) .
 127                                 Xml::closeElement( 'form' )
 128                 );
 129
 130                 list( $this->major, $this->minor ) = File::splitMime( $mime );
 131
 132                 if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
 133                         !self::isValidType( $this->major )
 134                 ) {
 135                         return;
 136                 }
 137
 138                 parent::execute( $par );
 139         }
 140
 141         /**
 142          * @param Skin $skin
 143          * @param object $result Result row
 144          * @return string
 145          */
 146         function formatResult( $skin, $result ) {
 147                 global $wgContLang;
 148
 149                 $nt = Title::makeTitle( $result->namespace, $result->title );
 150                 $text = $wgContLang->convert( $nt->getText() );
 151                 $plink = Linker::link(
 152                         Title::newFromText( $nt->getPrefixedText() ),
 153                         htmlspecialchars( $text )
 154                 );
 155
 156                 $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
 157                 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
 158                 $lang = $this->getLanguage();
 159                 $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
 160                 $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
 161                         $result->img_height )->escaped();
 162                 $user = Linker::link(
 163                         Title::makeTitle( NS_USER, $result->img_user_text ),
 164                         htmlspecialchars( $result->img_user_text )
 165                 );
 166
 167                 $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
 168                 $time = htmlspecialchars( $time );
 169
 170                 return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
 171         }
 172
 173         /**
 174          * @param string $type
 175          * @return bool
 176          */
 177         protected static function isValidType( $type ) {
 178                 // From maintenance/tables.sql => img_major_mime
 179                 $types = array(
 180                         'unknown',
 181                         'application',
 182                         'audio',
 183                         'image',
 184                         'text',
 185                         'video',
 186                         'message',
 187                         'model',
 188                         'multipart'
 189                 );
 190
 191                 return in_array( $type, $types );
 192         }
 193
 194         protected function getGroupName() {
 195                 return 'media';
 196         }
 197 }