MediaWiki  master
SpecialMIMEsearch.php
Go to the documentation of this file.
1 <?php
26 
32 class MIMEsearchPage 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' => [
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  }
136 
137  protected function getSuggestionsForTypes() {
138  $dbr = wfGetDB( DB_REPLICA );
139  $lastMajor = null;
140  $suggestions = [];
141  $result = $dbr->select(
142  [ 'image' ],
143  // We ignore img_media_type, but using it in the query is needed for MySQL to choose a
144  // sensible execution plan
145  [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ],
146  [],
147  __METHOD__,
148  [ 'GROUP BY' => [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ] ]
149  );
150  foreach ( $result as $row ) {
151  $major = $row->img_major_mime;
152  $minor = $row->img_minor_mime;
153  $suggestions[ "$major/$minor" ] = "$major/$minor";
154  if ( $lastMajor === $major ) {
155  // If there are at least two with the same major mime type, also include the wildcard
156  $suggestions[ "$major/*" ] = "$major/*";
157  }
158  $lastMajor = $major;
159  }
160  ksort( $suggestions );
161  return $suggestions;
162  }
163 
164  public function execute( $par ) {
165  $this->mime = $par ?: $this->getRequest()->getText( 'mime' );
166  $this->mime = trim( $this->mime );
167  list( $this->major, $this->minor ) = File::splitMime( $this->mime );
168 
169  if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
170  !self::isValidType( $this->major )
171  ) {
172  $this->setHeaders();
173  $this->outputHeader();
174  $this->getPageHeader();
175  return;
176  }
177 
178  parent::execute( $par );
179  }
180 
186  function formatResult( $skin, $result ) {
187  $linkRenderer = $this->getLinkRenderer();
188  $nt = Title::makeTitle( $result->namespace, $result->title );
189  $text = MediaWikiServices::getInstance()->getContentLanguage()
190  ->convert( htmlspecialchars( $nt->getText() ) );
191  $plink = $linkRenderer->makeLink(
192  Title::newFromText( $nt->getPrefixedText() ),
193  new HtmlArmor( $text )
194  );
195 
196  $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
197  $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
198  $lang = $this->getLanguage();
199  $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
200  $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
201  $result->img_height )->escaped();
202  $user = $linkRenderer->makeLink(
203  Title::makeTitle( NS_USER, $result->img_user_text ),
204  $result->img_user_text
205  );
206 
207  $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
208  $time = htmlspecialchars( $time );
209 
210  return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
211  }
212 
217  protected static function isValidType( $type ) {
218  // From maintenance/tables.sql => img_major_mime
219  $types = [
220  'unknown',
221  'application',
222  'audio',
223  'image',
224  'text',
225  'video',
226  'message',
227  'model',
228  'multipart',
229  'chemical'
230  ];
231 
232  return in_array( $type, $types );
233  }
234 
235  public function preprocessResults( $db, $res ) {
237  }
238 
239  protected function getGroupName() {
240  return 'media';
241  }
242 }
static makeMediaLinkObj( $title, $html='', $time=false)
Create a direct link to a given uploaded file.
Definition: Linker.php:749
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
__construct( $name='MIMEsearch')
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
$batch execute()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead & $formDescriptor
Definition: hooks.txt:2125
if(!isset( $args[0])) $lang
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
const MEDIATYPE_MULTIMEDIA
Definition: defines.php:37
getPageHeader()
Generate and output the form.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
const MEDIATYPE_DRAWING
Definition: defines.php:30
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:286
preprocessResults( $db, $res)
const MEDIATYPE_BITMAP
Definition: defines.php:28
const MEDIATYPE_UNKNOWN
Definition: defines.php:26
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:2044
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:35
const MEDIATYPE_EXECUTABLE
Definition: defines.php:43
const MEDIATYPE_VIDEO
Definition: defines.php:35
$res
Definition: database.txt:21
getOrderFields()
The index is on (img_media_type, img_major_mime, img_minor_mime) which unfortunately doesn&#39;t have img...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
const NS_FILE
Definition: Defines.php:70
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:2046
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
formatResult( $skin, $result)
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:545
static isValidType( $type)
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const MEDIATYPE_OFFICE
Definition: defines.php:39
const MEDIATYPE_AUDIO
Definition: defines.php:32
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
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:273
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Searches the database for files of the requested MIME type, comparing this with the &#39;img_major_mime&#39; ...
const DB_REPLICA
Definition: defines.php:25
executeLBFromResultWrapper(IResultWrapper $res, $ns=null)
Creates a new LinkBatch object, adds all pages from the passed ResultWrapper (MUST include title and ...
Definition: QueryPage.php:860
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:244
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.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1851
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:244
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280