MediaWiki  1.28.1
SpecialMIMEsearch.php
Go to the documentation of this file.
1 <?php
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  $qi = [
60  'tables' => [ 'image' ],
61  'fields' => [
62  'namespace' => NS_FILE,
63  'title' => 'img_name',
64  // Still have a value field just in case,
65  // but it isn't actually used for sorting.
66  'value' => 'img_name',
67  'img_size',
68  'img_width',
69  'img_height',
70  'img_user_text',
71  'img_timestamp'
72  ],
73  'conds' => [
74  'img_major_mime' => $this->major,
75  // This is in order to trigger using
76  // the img_media_mime index in "range" mode.
77  'img_media_type' => [
88  ],
89  ] + $minorType,
90  ];
91 
92  return $qi;
93  }
94 
104  function getOrderFields() {
105  return [];
106  }
107 
111  function getPageHeader() {
112  $formDescriptor = [
113  'mime' => [
114  'type' => 'text',
115  'name' => 'mime',
116  'label-message' => 'mimetype',
117  'required' => true,
118  'default' => $this->mime,
119  ],
120  ];
121 
122  $form = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
123  ->setWrapperLegendMsg( 'mimesearch' )
124  ->setSubmitTextMsg( 'ilsubmit' )
125  ->setAction( $this->getPageTitle()->getLocalURL() )
126  ->setMethod( 'get' )
127  ->prepareForm()
128  ->displayForm( false );
129  }
130 
131  public function execute( $par ) {
132  $this->mime = $par ? $par : $this->getRequest()->getText( 'mime' );
133  $this->mime = trim( $this->mime );
134  list( $this->major, $this->minor ) = File::splitMime( $this->mime );
135 
136  if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
137  !self::isValidType( $this->major )
138  ) {
139  $this->setHeaders();
140  $this->outputHeader();
141  $this->getPageHeader();
142  return;
143  }
144 
145  parent::execute( $par );
146  }
147 
153  function formatResult( $skin, $result ) {
155 
156  $nt = Title::makeTitle( $result->namespace, $result->title );
157  $text = $wgContLang->convert( $nt->getText() );
158  $plink = Linker::link(
159  Title::newFromText( $nt->getPrefixedText() ),
160  htmlspecialchars( $text )
161  );
162 
163  $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
164  $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
165  $lang = $this->getLanguage();
166  $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
167  $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
168  $result->img_height )->escaped();
170  Title::makeTitle( NS_USER, $result->img_user_text ),
171  htmlspecialchars( $result->img_user_text )
172  );
173 
174  $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
175  $time = htmlspecialchars( $time );
176 
177  return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
178  }
179 
184  protected static function isValidType( $type ) {
185  // From maintenance/tables.sql => img_major_mime
186  $types = [
187  'unknown',
188  'application',
189  'audio',
190  'image',
191  'text',
192  'video',
193  'message',
194  'model',
195  'multipart',
196  'chemical'
197  ];
198 
199  return in_array( $type, $types );
200  }
201 
202  protected function getGroupName() {
203  return 'media';
204  }
205 }
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
getContext()
Gets the context this SpecialPage is executed in.
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:272
const MEDIATYPE_ARCHIVE
Definition: defines.php:45
const MEDIATYPE_TEXT
Definition: defines.php:41
$batch execute()
static isValidType($type)
if(!isset($args[0])) $lang
static factory($displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:275
const MEDIATYPE_MULTIMEDIA
Definition: defines.php:37
getPageHeader()
Generate and output the form.
msg()
Wrapper around wfMessage that sets the current context.
const MEDIATYPE_DRAWING
Definition: defines.php:30
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
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 '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!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:Associative array mapping language codes to prefixed links of the form"language:title".&$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!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:1934
outputHeader($summaryMessageKey= '')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
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:30
static makeMediaLinkObj($title, $html= '', $time=false)
Create a direct link to a given uploaded file.
Definition: Linker.php:857
const MEDIATYPE_EXECUTABLE
Definition: defines.php:43
const MEDIATYPE_VIDEO
Definition: defines.php:35
getOrderFields()
The index is on (img_media_type, img_major_mime, img_minor_mime) which unfortunately doesn't have img...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
const NS_FILE
Definition: Defines.php:62
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:1936
formatResult($skin, $result)
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:242
static link($target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
Definition: Linker.php:203
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's language.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
Searches the database for files of the requested MIME type, comparing this with the 'img_major_mime' ...
__construct($name= 'MIMEsearch')
getRequest()
Get the WebRequest being used for this instance.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1749
getPageTitle($subpage=false)
Get a self-referential title object.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300