MediaWiki  master
SpecialMIMESearch.php
Go to the documentation of this file.
1 <?php
26 
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' => [
93  ],
94  ] + $minorType,
95  'join_conds' => $imgQuery['joins'],
96  ];
97 
98  return $qi;
99  }
100 
110  function getOrderFields() {
111  return [];
112  }
113 
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 
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 
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 ) {
239  }
240 
241  protected function getGroupName() {
242  return 'media';
243  }
244 }
static makeMediaLinkObj( $title, $html='', $time=false)
Create a direct link to a given uploaded file.
Definition: Linker.php:762
const MEDIATYPE_3D
Definition: defines.php:47
getContext()
Gets the context this SpecialPage is executed in.
const MEDIATYPE_ARCHIVE
Definition: defines.php:45
const MEDIATYPE_TEXT
Definition: defines.php:41
formatResult( $skin, $result)
static isValidType( $type)
if(!isset( $args[0])) $lang
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
const MEDIATYPE_MULTIMEDIA
Definition: defines.php:37
preprocessResults( $db, $res)
Searches the database for files of the requested MIME type, comparing this with the &#39;img_major_mime&#39; ...
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
const MEDIATYPE_DRAWING
Definition: defines.php:30
const MEDIATYPE_BITMAP
Definition: defines.php:28
const MEDIATYPE_UNKNOWN
Definition: defines.php:26
This is a class for doing query pages; since they&#39;re almost all the same, we factor out some of the f...
Definition: QueryPage.php:36
const MEDIATYPE_EXECUTABLE
Definition: defines.php:43
const MEDIATYPE_VIDEO
Definition: defines.php:35
msg( $key,... $params)
Wrapper around wfMessage that sets the current context.
static factory( $displayFormat,... $arguments)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:307
getPageHeader()
Generate and output the form.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
const NS_FILE
Definition: Defines.php:66
__construct( $name='MIMEsearch')
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:586
const MEDIATYPE_OFFICE
Definition: defines.php:39
const MEDIATYPE_AUDIO
Definition: defines.php:32
getOrderFields()
The index is on (img_media_type, img_major_mime, img_minor_mime) which unfortunately doesn&#39;t have img...
getLanguage()
Shortcut to get user&#39;s language.
static splitMime( $mime)
Split an internet media type into its two components; if not a two-part name, set the minor type to &#39;...
Definition: File.php:283
const DB_REPLICA
Definition: defines.php:25
executeLBFromResultWrapper(IResultWrapper $res, $ns=null)
Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include title and...
Definition: QueryPage.php:800
getRequest()
Get the WebRequest being used for this instance.
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new localfile object...
Definition: LocalFile.php:216
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319