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, $mime;
  32
  33         function __construct( $name = 'MIMEsearch' ) {
  34                 parent::__construct( $name );
  35         }
  36
  37         public 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 [ 'mime' => "{$this->major}/{$this->minor}" ];
  51         }
  52
  53         public function getQueryInfo() {
  54                 $minorType = [];
  55                 if ( $this->minor !== '*' ) {
  56                         // Allow wildcard searching
  57                         $minorType['img_minor_mime'] = $this->minor;
  58                 }
  59                 $imgQuery = LocalFile::getQueryInfo();
  60                 $qi = [
  61                         'tables' => $imgQuery['tables'],
  62                         'fields' => [
  63                                 'namespace' => NS_FILE,
  64                                 'title' => 'img_name',
  65                                 // Still have a value field just in case,
  66                                 // but it isn't actually used for sorting.
  67                                 'value' => 'img_name',
  68                                 'img_size',
  69                                 'img_width',
  70                                 'img_height',
  71                                 'img_user_text' => $imgQuery['fields']['img_user_text'],
  72                                 'img_timestamp'
  73                         ],
  74                         'conds' => [
  75                                 'img_major_mime' => $this->major,
  76                                 // This is in order to trigger using
  77                                 // the img_media_mime index in "range" mode.
  78                                 // @todo how is order defined? use MimeAnalyzer::getMediaTypes?
  79                                 'img_media_type' => [
  80                                         MEDIATYPE_BITMAP,
  81                                         MEDIATYPE_DRAWING,
  82                                         MEDIATYPE_AUDIO,
  83                                         MEDIATYPE_VIDEO,
  84                                         MEDIATYPE_MULTIMEDIA,
  85                                         MEDIATYPE_UNKNOWN,
  86                                         MEDIATYPE_OFFICE,
  87                                         MEDIATYPE_TEXT,
  88                                         MEDIATYPE_EXECUTABLE,
  89                                         MEDIATYPE_ARCHIVE,
  90                                         MEDIATYPE_3D,
  91                                 ],
  92                         ] + $minorType,
  93                         'join_conds' => $imgQuery['joins'],
  94                 ];
  95
  96                 return $qi;
  97         }
  98
  99         /**
 100          * The index is on (img_media_type, img_major_mime, img_minor_mime)
 101          * which unfortunately doesn't have img_name at the end for sorting.
 102          * So tell db to sort it however it wishes (Its not super important
 103          * that this report gives results in a logical order). As an aditional
 104          * note, mysql seems to by default order things by img_name ASC, which
 105          * is what we ideally want, so everything works out fine anyhow.
 106          * @return array
 107          */
 108         function getOrderFields() {
 109                 return [];
 110         }
 111
 112         /**
 113          * Generate and output the form
 114          */
 115         function getPageHeader() {
 116                 $formDescriptor = [
 117                         'mime' => [
 118                                 'type' => 'combobox',
 119                                 'options' => $this->getSuggestionsForTypes(),
 120                                 'name' => 'mime',
 121                                 'label-message' => 'mimetype',
 122                                 'required' => true,
 123                                 'default' => $this->mime,
 124                         ],
 125                 ];
 126
 127                 HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
 128                         ->setSubmitTextMsg( 'ilsubmit' )
 129                         ->setAction( $this->getPageTitle()->getLocalURL() )
 130                         ->setMethod( 'get' )
 131                         ->prepareForm()
 132                         ->displayForm( false );
 133         }
 134
 135         protected function getSuggestionsForTypes() {
 136                 $dbr = wfGetDB( DB_REPLICA );
 137                 $lastMajor = null;
 138                 $suggestions = [];
 139                 $result = $dbr->select(
 140                         [ 'image' ],
 141                         // We ignore img_media_type, but using it in the query is needed for MySQL to choose a
 142                         // sensible execution plan
 143                         [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ],
 144                         [],
 145                         __METHOD__,
 146                         [ 'GROUP BY' => [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ] ]
 147                 );
 148                 foreach ( $result as $row ) {
 149                         $major = $row->img_major_mime;
 150                         $minor = $row->img_minor_mime;
 151                         $suggestions[ "$major/$minor" ] = "$major/$minor";
 152                         if ( $lastMajor === $major ) {
 153                                 // If there are at least two with the same major mime type, also include the wildcard
 154                                 $suggestions[ "$major/*" ] = "$major/*";
 155                         }
 156                         $lastMajor = $major;
 157                 }
 158                 ksort( $suggestions );
 159                 return $suggestions;
 160         }
 161
 162         public function execute( $par ) {
 163                 $this->mime = $par ? $par : $this->getRequest()->getText( 'mime' );
 164                 $this->mime = trim( $this->mime );
 165                 list( $this->major, $this->minor ) = File::splitMime( $this->mime );
 166
 167                 if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
 168                         !self::isValidType( $this->major )
 169                 ) {
 170                         $this->setHeaders();
 171                         $this->outputHeader();
 172                         $this->getPageHeader();
 173                         return;
 174                 }
 175
 176                 parent::execute( $par );
 177         }
 178
 179         /**
 180          * @param Skin $skin
 181          * @param object $result Result row
 182          * @return string
 183          */
 184         function formatResult( $skin, $result ) {
 185                 global $wgContLang;
 186
 187                 $linkRenderer = $this->getLinkRenderer();
 188                 $nt = Title::makeTitle( $result->namespace, $result->title );
 189                 $text = $wgContLang->convert( $nt->getText() );
 190                 $plink = $linkRenderer->makeLink(
 191                         Title::newFromText( $nt->getPrefixedText() ),
 192                         $text
 193                 );
 194
 195                 $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
 196                 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
 197                 $lang = $this->getLanguage();
 198                 $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
 199                 $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
 200                         $result->img_height )->escaped();
 201                 $user = $linkRenderer->makeLink(
 202                         Title::makeTitle( NS_USER, $result->img_user_text ),
 203                         $result->img_user_text
 204                 );
 205
 206                 $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
 207                 $time = htmlspecialchars( $time );
 208
 209                 return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
 210         }
 211
 212         /**
 213          * @param string $type
 214          * @return bool
 215          */
 216         protected static function isValidType( $type ) {
 217                 // From maintenance/tables.sql => img_major_mime
 218                 $types = [
 219                         'unknown',
 220                         'application',
 221                         'audio',
 222                         'image',
 223                         'text',
 224                         'video',
 225                         'message',
 226                         'model',
 227                         'multipart',
 228                         'chemical'
 229                 ];
 230
 231                 return in_array( $type, $types );
 232         }
 233
 234         public function preprocessResults( $db, $res ) {
 235                 $this->executeLBFromResultWrapper( $res );
 236         }
 237
 238         protected function getGroupName() {
 239                 return 'media';
 240         }
 241 }