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