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 
118  function getPageHeader() {
119  $formDescriptor = [
120  'mime' => [
121  'type' => 'combobox',
122  'options' => $this->getSuggestionsForTypes(),
123  'name' => 'mime',
124  'label-message' => 'mimetype',
125  'required' => true,
126  'default' => $this->mime,
127  ],
128  ];
129 
130  HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
131  ->setSubmitTextMsg( 'ilsubmit' )
132  ->setAction( $this->getPageTitle()->getLocalURL() )
133  ->setMethod( 'get' )
134  ->prepareForm()
135  ->displayForm( false );
136  return '';
137  }
138 
139  protected function getSuggestionsForTypes() {
140  $dbr = wfGetDB( DB_REPLICA );
141  $lastMajor = null;
142  $suggestions = [];
143  $result = $dbr->select(
144  [ 'image' ],
145  // We ignore img_media_type, but using it in the query is needed for MySQL to choose a
146  // sensible execution plan
147  [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ],
148  [],
149  __METHOD__,
150  [ 'GROUP BY' => [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ] ]
151  );
152  foreach ( $result as $row ) {
153  $major = $row->img_major_mime;
154  $minor = $row->img_minor_mime;
155  $suggestions[ "$major/$minor" ] = "$major/$minor";
156  if ( $lastMajor === $major ) {
157  // If there are at least two with the same major mime type, also include the wildcard
158  $suggestions[ "$major/*" ] = "$major/*";
159  }
160  $lastMajor = $major;
161  }
162  ksort( $suggestions );
163  return $suggestions;
164  }
165 
166  public function execute( $par ) {
167  $this->addHelpLink( 'Help:Managing_files' );
168  $this->mime = $par ?: $this->getRequest()->getText( 'mime' );
169  $this->mime = trim( $this->mime );
170  list( $this->major, $this->minor ) = File::splitMime( $this->mime );
171 
172  if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
173  !self::isValidType( $this->major )
174  ) {
175  $this->setHeaders();
176  $this->outputHeader();
177  $this->getPageHeader();
178  return;
179  }
180 
181  parent::execute( $par );
182  }
183 
189  function formatResult( $skin, $result ) {
190  $linkRenderer = $this->getLinkRenderer();
191  $nt = Title::makeTitle( $result->namespace, $result->title );
192  $text = MediaWikiServices::getInstance()->getContentLanguage()
193  ->convert( htmlspecialchars( $nt->getText() ) );
194  $plink = $linkRenderer->makeLink(
195  Title::newFromText( $nt->getPrefixedText() ),
196  new HtmlArmor( $text )
197  );
198 
199  $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
200  $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
201  $lang = $this->getLanguage();
202  $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
203  $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
204  $result->img_height )->escaped();
205  $user = $linkRenderer->makeLink(
206  Title::makeTitle( NS_USER, $result->img_user_text ),
207  $result->img_user_text
208  );
209 
210  $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
211  $time = htmlspecialchars( $time );
212 
213  return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
214  }
215 
220  protected static function isValidType( $type ) {
221  // From maintenance/tables.sql => img_major_mime
222  $types = [
223  'unknown',
224  'application',
225  'audio',
226  'image',
227  'text',
228  'video',
229  'message',
230  'model',
231  'multipart',
232  'chemical'
233  ];
234 
235  return in_array( $type, $types );
236  }
237 
238  public function preprocessResults( $db, $res ) {
240  }
241 
242  protected function getGroupName() {
243  return 'media';
244  }
245 }
SpecialMIMESearch\$mime
$mime
Definition: SpecialMIMESearch.php:33
SpecialMIMESearch\getOrderFields
getOrderFields()
The index is on (img_media_type, img_major_mime, img_minor_mime) which unfortunately doesn't have img...
Definition: SpecialMIMESearch.php:110
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:672
SpecialPage\msg
msg( $key,... $params)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:792
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:317
HtmlArmor
Marks HTML that shouldn't be escaped.
Definition: HtmlArmor.php:28
MEDIATYPE_AUDIO
const MEDIATYPE_AUDIO
Definition: defines.php:32
SpecialMIMESearch\getPageHeader
getPageHeader()
Generate and output the form.
Definition: SpecialMIMESearch.php:118
SpecialMIMESearch\linkParameters
linkParameters()
If using extra form wheely-dealies, return a set of parameters here as an associative array.
Definition: SpecialMIMESearch.php:51
SpecialMIMESearch
Searches the database for files of the requested MIME type, comparing this with the 'img_major_mime' ...
Definition: SpecialMIMESearch.php:32
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:130
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:35
MEDIATYPE_OFFICE
const MEDIATYPE_OFFICE
Definition: defines.php:39
MEDIATYPE_DRAWING
const MEDIATYPE_DRAWING
Definition: defines.php:30
NS_FILE
const NS_FILE
Definition: Defines.php:66
MEDIATYPE_UNKNOWN
const MEDIATYPE_UNKNOWN
Definition: defines.php:26
File\splitMime
static splitMime( $mime)
Split an internet media type into its two components; if not a two-part name, set the minor type to '...
Definition: File.php:283
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:749
$res
$res
Definition: testCompression.php:54
SpecialMIMESearch\isExpensive
isExpensive()
Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.
Definition: SpecialMIMESearch.php:39
SpecialMIMESearch\getQueryInfo
getQueryInfo()
Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s...
Definition: SpecialMIMESearch.php:55
QueryPage
This is a class for doing query pages; since they're almost all the same, we factor out some of the f...
Definition: QueryPage.php:36
QueryPage\executeLBFromResultWrapper
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
$dbr
$dbr
Definition: testCompression.php:52
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:828
SpecialMIMESearch\getSuggestionsForTypes
getSuggestionsForTypes()
Definition: SpecialMIMESearch.php:139
Linker\makeMediaLinkObj
static makeMediaLinkObj( $title, $html='', $time=false)
Create a direct link to a given uploaded file.
Definition: Linker.php:763
SpecialMIMESearch\__construct
__construct( $name='MIMEsearch')
Definition: SpecialMIMESearch.php:35
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2562
MEDIATYPE_3D
const MEDIATYPE_3D
Definition: defines.php:47
SpecialMIMESearch\preprocessResults
preprocessResults( $db, $res)
Do any necessary preprocessing of the result object.
Definition: SpecialMIMESearch.php:238
SpecialMIMESearch\$major
$major
Definition: SpecialMIMESearch.php:33
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:537
MEDIATYPE_BITMAP
const MEDIATYPE_BITMAP
Definition: defines.php:28
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:584
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:692
SpecialMIMESearch\isCacheable
isCacheable()
Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode a...
Definition: SpecialMIMESearch.php:47
MEDIATYPE_EXECUTABLE
const MEDIATYPE_EXECUTABLE
Definition: defines.php:43
MEDIATYPE_MULTIMEDIA
const MEDIATYPE_MULTIMEDIA
Definition: defines.php:37
SpecialMIMESearch\isSyndicated
isSyndicated()
Sometime we don't want to build rss / atom feeds.
Definition: SpecialMIMESearch.php:43
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:709
MEDIATYPE_ARCHIVE
const MEDIATYPE_ARCHIVE
Definition: defines.php:45
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:904
LocalFile\getQueryInfo
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new localfile object.
Definition: LocalFile.php:216
MEDIATYPE_TEXT
const MEDIATYPE_TEXT
Definition: defines.php:41
SpecialMIMESearch\formatResult
formatResult( $skin, $result)
Definition: SpecialMIMESearch.php:189
MEDIATYPE_VIDEO
const MEDIATYPE_VIDEO
Definition: defines.php:35
SpecialMIMESearch\$minor
$minor
Definition: SpecialMIMESearch.php:33
SpecialMIMESearch\isValidType
static isValidType( $type)
Definition: SpecialMIMESearch.php:220
NS_USER
const NS_USER
Definition: Defines.php:62
SpecialMIMESearch\execute
execute( $par)
This is the actual workhorse.
Definition: SpecialMIMESearch.php:166
SpecialMIMESearch\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialMIMESearch.php:242
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67
HTMLForm\factory
static factory( $displayFormat,... $arguments)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:307
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:639
$type
$type
Definition: testCompression.php:50