MediaWiki  master
ForeignAPIRepo.php
Go to the documentation of this file.
1 <?php
25 
41 class ForeignAPIRepo extends FileRepo {
42  /* This version string is used in the user agent for requests and will help
43  * server maintainers in identify ForeignAPI usage.
44  * Update the version every time you make breaking or significant changes. */
45  const VERSION = "2.1";
46 
51  protected static $imageInfoProps = [
52  'url',
53  'timestamp',
54  ];
55 
56  protected $fileFactory = [ ForeignAPIFile::class, 'newFromTitle' ];
58  protected $apiThumbCacheExpiry = 86400; // 1 day (24*3600)
59 
61  protected $fileCacheExpiry = 2592000; // 1 month (30*24*3600)
62 
64  protected $mFileExists = [];
65 
67  private $mApiBase;
68 
72  function __construct( $info ) {
73  global $wgLocalFileRepo;
74  parent::__construct( $info );
75 
76  // https://commons.wikimedia.org/w/api.php
77  $this->mApiBase = $info['apibase'] ?? null;
78 
79  if ( isset( $info['apiThumbCacheExpiry'] ) ) {
80  $this->apiThumbCacheExpiry = $info['apiThumbCacheExpiry'];
81  }
82  if ( isset( $info['fileCacheExpiry'] ) ) {
83  $this->fileCacheExpiry = $info['fileCacheExpiry'];
84  }
85  if ( !$this->scriptDirUrl ) {
86  // hack for description fetches
87  $this->scriptDirUrl = dirname( $this->mApiBase );
88  }
89  // If we can cache thumbs we can guess sane defaults for these
90  if ( $this->canCacheThumbs() && !$this->url ) {
91  $this->url = $wgLocalFileRepo['url'];
92  }
93  if ( $this->canCacheThumbs() && !$this->thumbUrl ) {
94  $this->thumbUrl = $this->url . '/thumb';
95  }
96  }
97 
102  function getApiUrl() {
103  return $this->mApiBase;
104  }
105 
114  function newFile( $title, $time = false ) {
115  if ( $time ) {
116  return false;
117  }
118 
119  return parent::newFile( $title, $time );
120  }
121 
126  function fileExistsBatch( array $files ) {
127  $results = [];
128  foreach ( $files as $k => $f ) {
129  if ( isset( $this->mFileExists[$f] ) ) {
130  $results[$k] = $this->mFileExists[$f];
131  unset( $files[$k] );
132  } elseif ( self::isVirtualUrl( $f ) ) {
133  # @todo FIXME: We need to be able to handle virtual
134  # URLs better, at least when we know they refer to the
135  # same repo.
136  $results[$k] = false;
137  unset( $files[$k] );
138  } elseif ( FileBackend::isStoragePath( $f ) ) {
139  $results[$k] = false;
140  unset( $files[$k] );
141  wfWarn( "Got mwstore:// path '$f'." );
142  }
143  }
144 
145  $data = $this->fetchImageQuery( [
146  'titles' => implode( '|', $files ),
147  'prop' => 'imageinfo' ]
148  );
149 
150  if ( isset( $data['query']['pages'] ) ) {
151  # First, get results from the query. Note we only care whether the image exists,
152  # not whether it has a description page.
153  foreach ( $data['query']['pages'] as $p ) {
154  $this->mFileExists[$p['title']] = ( $p['imagerepository'] !== '' );
155  }
156  # Second, copy the results to any redirects that were queried
157  if ( isset( $data['query']['redirects'] ) ) {
158  foreach ( $data['query']['redirects'] as $r ) {
159  $this->mFileExists[$r['from']] = $this->mFileExists[$r['to']];
160  }
161  }
162  # Third, copy the results to any non-normalized titles that were queried
163  if ( isset( $data['query']['normalized'] ) ) {
164  foreach ( $data['query']['normalized'] as $n ) {
165  $this->mFileExists[$n['from']] = $this->mFileExists[$n['to']];
166  }
167  }
168  # Finally, copy the results to the output
169  foreach ( $files as $key => $file ) {
170  $results[$key] = $this->mFileExists[$file];
171  }
172  }
173 
174  return $results;
175  }
176 
181  function getFileProps( $virtualUrl ) {
182  return false;
183  }
184 
189  function fetchImageQuery( $query ) {
190  global $wgLanguageCode;
191 
192  $query = array_merge( $query,
193  [
194  'format' => 'json',
195  'action' => 'query',
196  'redirects' => 'true'
197  ] );
198 
199  if ( !isset( $query['uselang'] ) ) { // uselang is unset or null
200  $query['uselang'] = $wgLanguageCode;
201  }
202 
203  $data = $this->httpGetCached( 'Metadata', $query );
204 
205  if ( $data ) {
206  return FormatJson::decode( $data, true );
207  } else {
208  return null;
209  }
210  }
211 
216  function getImageInfo( $data ) {
217  if ( $data && isset( $data['query']['pages'] ) ) {
218  foreach ( $data['query']['pages'] as $info ) {
219  if ( isset( $info['imageinfo'][0] ) ) {
220  $return = $info['imageinfo'][0];
221  if ( isset( $info['pageid'] ) ) {
222  $return['pageid'] = $info['pageid'];
223  }
224  return $return;
225  }
226  }
227  }
228 
229  return false;
230  }
231 
236  function findBySha1( $hash ) {
237  $results = $this->fetchImageQuery( [
238  'aisha1base36' => $hash,
239  'aiprop' => ForeignAPIFile::getProps(),
240  'list' => 'allimages',
241  ] );
242  $ret = [];
243  if ( isset( $results['query']['allimages'] ) ) {
244  foreach ( $results['query']['allimages'] as $img ) {
245  // 1.14 was broken, doesn't return name attribute
246  if ( !isset( $img['name'] ) ) {
247  continue;
248  }
249  $ret[] = new ForeignAPIFile( Title::makeTitle( NS_FILE, $img['name'] ), $this, $img );
250  }
251  }
252 
253  return $ret;
254  }
255 
265  function getThumbUrl( $name, $width = -1, $height = -1, &$result = null, $otherParams = '' ) {
266  $data = $this->fetchImageQuery( [
267  'titles' => 'File:' . $name,
268  'iiprop' => self::getIIProps(),
269  'iiurlwidth' => $width,
270  'iiurlheight' => $height,
271  'iiurlparam' => $otherParams,
272  'prop' => 'imageinfo' ] );
273  $info = $this->getImageInfo( $data );
274 
275  if ( $data && $info && isset( $info['thumburl'] ) ) {
276  wfDebug( __METHOD__ . " got remote thumb " . $info['thumburl'] . "\n" );
277  $result = $info;
278 
279  return $info['thumburl'];
280  } else {
281  return false;
282  }
283  }
284 
294  function getThumbError( $name, $width = -1, $height = -1, $otherParams = '', $lang = null ) {
295  $data = $this->fetchImageQuery( [
296  'titles' => 'File:' . $name,
297  'iiprop' => self::getIIProps(),
298  'iiurlwidth' => $width,
299  'iiurlheight' => $height,
300  'iiurlparam' => $otherParams,
301  'prop' => 'imageinfo',
302  'uselang' => $lang,
303  ] );
304  $info = $this->getImageInfo( $data );
305 
306  if ( $data && $info && isset( $info['thumberror'] ) ) {
307  wfDebug( __METHOD__ . " got remote thumb error " . $info['thumberror'] . "\n" );
308 
309  return new MediaTransformError(
310  'thumbnail_error_remote',
311  $width,
312  $height,
313  $this->getDisplayName(),
314  $info['thumberror'] // already parsed message from foreign repo
315  );
316  } else {
317  return false;
318  }
319  }
320 
334  function getThumbUrlFromCache( $name, $width, $height, $params = "" ) {
335  // We can't check the local cache using FileRepo functions because
336  // we override fileExistsBatch(). We have to use the FileBackend directly.
337  $backend = $this->getBackend(); // convenience
338 
339  if ( !$this->canCacheThumbs() ) {
340  $result = null; // can't pass "null" by reference, but it's ok as default value
341  return $this->getThumbUrl( $name, $width, $height, $result, $params );
342  }
343  $key = $this->getLocalCacheKey( 'ForeignAPIRepo', 'ThumbUrl', $name );
344  $sizekey = "$width:$height:$params";
345 
346  /* Get the array of urls that we already know */
347  $knownThumbUrls = $this->wanCache->get( $key );
348  if ( !$knownThumbUrls ) {
349  /* No knownThumbUrls for this file */
350  $knownThumbUrls = [];
351  } elseif ( isset( $knownThumbUrls[$sizekey] ) ) {
352  wfDebug( __METHOD__ . ': Got thumburl from local cache: ' .
353  "{$knownThumbUrls[$sizekey]} \n" );
354 
355  return $knownThumbUrls[$sizekey];
356  }
357 
358  $metadata = null;
359  $foreignUrl = $this->getThumbUrl( $name, $width, $height, $metadata, $params );
360 
361  if ( !$foreignUrl ) {
362  wfDebug( __METHOD__ . " Could not find thumburl\n" );
363 
364  return false;
365  }
366 
367  // We need the same filename as the remote one :)
368  $fileName = rawurldecode( pathinfo( $foreignUrl, PATHINFO_BASENAME ) );
369  if ( !$this->validateFilename( $fileName ) ) {
370  wfDebug( __METHOD__ . " The deduced filename $fileName is not safe\n" );
371 
372  return false;
373  }
374  $localPath = $this->getZonePath( 'thumb' ) . "/" . $this->getHashPath( $name ) . $name;
375  $localFilename = $localPath . "/" . $fileName;
376  $localUrl = $this->getZoneUrl( 'thumb' ) . "/" . $this->getHashPath( $name ) .
377  rawurlencode( $name ) . "/" . rawurlencode( $fileName );
378 
379  if ( $backend->fileExists( [ 'src' => $localFilename ] )
380  && isset( $metadata['timestamp'] )
381  ) {
382  wfDebug( __METHOD__ . " Thumbnail was already downloaded before\n" );
383  $modified = $backend->getFileTimestamp( [ 'src' => $localFilename ] );
384  $remoteModified = strtotime( $metadata['timestamp'] );
385  $current = time();
386  $diff = abs( $modified - $current );
387  if ( $remoteModified < $modified && $diff < $this->fileCacheExpiry ) {
388  /* Use our current and already downloaded thumbnail */
389  $knownThumbUrls[$sizekey] = $localUrl;
390  $this->wanCache->set( $key, $knownThumbUrls, $this->apiThumbCacheExpiry );
391 
392  return $localUrl;
393  }
394  /* There is a new Commons file, or existing thumbnail older than a month */
395  }
396 
397  $thumb = self::httpGet( $foreignUrl, 'default', [], $mtime );
398  if ( !$thumb ) {
399  wfDebug( __METHOD__ . " Could not download thumb\n" );
400 
401  return false;
402  }
403 
404  # @todo FIXME: Delete old thumbs that aren't being used. Maintenance script?
405  $backend->prepare( [ 'dir' => dirname( $localFilename ) ] );
406  $params = [ 'dst' => $localFilename, 'content' => $thumb ];
407  if ( !$backend->quickCreate( $params )->isOK() ) {
408  wfDebug( __METHOD__ . " could not write to thumb path '$localFilename'\n" );
409 
410  return $foreignUrl;
411  }
412  $knownThumbUrls[$sizekey] = $localUrl;
413 
414  $ttl = $mtime
415  ? $this->wanCache->adaptiveTTL( $mtime, $this->apiThumbCacheExpiry )
417  $this->wanCache->set( $key, $knownThumbUrls, $ttl );
418  wfDebug( __METHOD__ . " got local thumb $localUrl, saving to cache \n" );
419 
420  return $localUrl;
421  }
422 
429  function getZoneUrl( $zone, $ext = null ) {
430  switch ( $zone ) {
431  case 'public':
432  return $this->url;
433  case 'thumb':
434  return $this->thumbUrl;
435  default:
436  return parent::getZoneUrl( $zone, $ext );
437  }
438  }
439 
445  function getZonePath( $zone ) {
446  $supported = [ 'public', 'thumb' ];
447  if ( in_array( $zone, $supported ) ) {
448  return parent::getZonePath( $zone );
449  }
450 
451  return false;
452  }
453 
458  public function canCacheThumbs() {
459  return ( $this->apiThumbCacheExpiry > 0 );
460  }
461 
466  public static function getUserAgent() {
467  return Http::userAgent() . " ForeignAPIRepo/" . self::VERSION;
468  }
469 
476  function getInfo() {
477  $info = parent::getInfo();
478  $info['apiurl'] = $this->getApiUrl();
479 
480  $query = [
481  'format' => 'json',
482  'action' => 'query',
483  'meta' => 'siteinfo',
484  'siprop' => 'general',
485  ];
486 
487  $data = $this->httpGetCached( 'SiteInfo', $query, 7200 );
488 
489  if ( $data ) {
490  $siteInfo = FormatJson::decode( $data, true );
491  $general = $siteInfo['query']['general'];
492 
493  $info['articlepath'] = $general['articlepath'];
494  $info['server'] = $general['server'];
495 
496  if ( isset( $general['favicon'] ) ) {
497  $info['favicon'] = $general['favicon'];
498  }
499  }
500 
501  return $info;
502  }
503 
514  public static function httpGet(
515  $url, $timeout = 'default', $options = [], &$mtime = false
516  ) {
517  $options['timeout'] = $timeout;
518  /* Http::get */
520  wfDebug( "ForeignAPIRepo: HTTP GET: $url\n" );
521  $options['method'] = "GET";
522 
523  if ( !isset( $options['timeout'] ) ) {
524  $options['timeout'] = 'default';
525  }
526 
527  $req = MWHttpRequest::factory( $url, $options, __METHOD__ );
528  $req->setUserAgent( self::getUserAgent() );
529  $status = $req->execute();
530 
531  if ( $status->isOK() ) {
532  $lmod = $req->getResponseHeader( 'Last-Modified' );
533  $mtime = $lmod ? wfTimestamp( TS_UNIX, $lmod ) : false;
534 
535  return $req->getContent();
536  } else {
537  $logger = LoggerFactory::getInstance( 'http' );
538  $logger->warning(
539  $status->getWikiText( false, false, 'en' ),
540  [ 'caller' => 'ForeignAPIRepo::httpGet' ]
541  );
542 
543  return false;
544  }
545  }
546 
551  protected static function getIIProps() {
552  return implode( '|', self::$imageInfoProps );
553  }
554 
562  public function httpGetCached( $target, $query, $cacheTTL = 3600 ) {
563  if ( $this->mApiBase ) {
564  $url = wfAppendQuery( $this->mApiBase, $query );
565  } else {
566  $url = $this->makeUrl( $query, 'api' );
567  }
568 
569  return $this->wanCache->getWithSetCallback(
570  $this->getLocalCacheKey( static::class, $target, md5( $url ) ),
571  $cacheTTL,
572  function ( $curValue, &$ttl ) use ( $url ) {
573  $html = self::httpGet( $url, 'default', [], $mtime );
574  if ( $html !== false ) {
575  $ttl = $mtime ? $this->wanCache->adaptiveTTL( $mtime, $ttl ) : $ttl;
576  } else {
577  $ttl = $this->wanCache->adaptiveTTL( $mtime, $ttl );
578  $html = null; // caches negatives
579  }
580 
581  return $html;
582  },
583  [ 'pcTTL' => WANObjectCache::TTL_PROC_LONG ]
584  );
585  }
586 
591  function enumFiles( $callback ) {
592  throw new MWException( 'enumFiles is not supported by ' . static::class );
593  }
594 
598  protected function assertWritableRepo() {
599  throw new MWException( static::class . ': write operations are not supported.' );
600  }
601 }
getThumbUrlFromCache( $name, $width, $height, $params="")
Return the imageurl from cache if possible.
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 and may include noclasses & $html
Definition: hooks.txt:1982
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1585
getZonePath( $zone)
Get the local directory corresponding to one of the basic zones.
httpGetCached( $target, $query, $cacheTTL=3600)
HTTP GET request to a mediawiki API (with caching)
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 & $ret
Definition: hooks.txt:1982
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
makeUrl( $query='', $entry='index')
Make an url to this repo.
Definition: FileRepo.php:741
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
if(!isset( $args[0])) $lang
string false $url
Public zone URL.
Definition: FileRepo.php:101
$wgLocalFileRepo
File repository structures.
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1834
enumFiles( $callback)
int $apiThumbCacheExpiry
Check back with Commons after this expiry.
getFileTimestamp(array $params)
Get the last-modified timestamp of the file at a storage path.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
fileExistsBatch(array $files)
static userAgent()
A standard user-agent we can use for external requests.
Definition: Http.php:98
getBackend()
Get the file backend instance.
Definition: FileRepo.php:216
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. '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 '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:1980
$wgLanguageCode
Site language code.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Foreign file accessible through api.php requests.
fetchImageQuery( $query)
quickCreate(array $params)
Performs a single quick create operation.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:174
static getProps()
Get the property string for iiprop and aiprop.
fileExists(array $params)
Check if a file exists at a storage path in the backend.
$params
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 & $options
Definition: hooks.txt:1982
static $imageInfoProps
List of iiprop values for the thumbnail fetch queries.
string $thumbUrl
The base thumbnail URL.
Definition: FileRepo.php:104
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
static httpGet( $url, $timeout='default', $options=[], &$mtime=false)
Like a HttpRequestFactory::get request, but with custom User-Agent.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
const NS_FILE
Definition: Defines.php:66
getThumbUrl( $name, $width=-1, $height=-1, &$result=null, $otherParams='')
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
const PROTO_HTTP
Definition: Defines.php:215
prepare(array $params)
Prepare a storage directory for usage.
getThumbError( $name, $width=-1, $height=-1, $otherParams='', $lang=null)
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
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
this hook is for auditing only $req
Definition: hooks.txt:979
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
getInfo()
Get information about the repo - overrides/extends the parent class&#39;s information.
getDisplayName()
Get the human-readable name of the repo.
Definition: FileRepo.php:1779
if(!is_readable( $file)) $ext
Definition: router.php:48
Base class for file repositories.
Definition: FileRepo.php:39
$f
Definition: router.php:79
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
getHashPath( $name)
Get a relative path including trailing slash, e.g.
Definition: FileRepo.php:680
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
A foreign repository with a remote MediaWiki with an API thingy.
FileBackend $backend
Definition: FileRepo.php:61
canCacheThumbs()
Are we locally caching the thumbnails?
validateFilename( $filename)
Determine if a relative path is valid, i.e.
Definition: FileRepo.php:1681
int $fileCacheExpiry
Redownload thumbnail files after this expiry.
getFileProps( $virtualUrl)
newFile( $title, $time=false)
Per docs in FileRepo, this needs to return false if we don&#39;t support versioned files.
static getUserAgent()
The user agent the ForeignAPIRepo will use.
Basic media transform error class.
getZoneUrl( $zone, $ext=null)