MediaWiki  1.27.1
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', '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 $mQueryCache = [];
68 
72  function __construct( $info ) {
74  parent::__construct( $info );
75 
76  // https://commons.wikimedia.org/w/api.php
77  $this->mApiBase = isset( $info['apibase'] ) ? $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 
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 ) {
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 = "" ) {
336  // We can't check the local cache using FileRepo functions because
337  // we override fileExistsBatch(). We have to use the FileBackend directly.
338  $backend = $this->getBackend(); // convenience
339 
340  if ( !$this->canCacheThumbs() ) {
341  $result = null; // can't pass "null" by reference, but it's ok as default value
342  return $this->getThumbUrl( $name, $width, $height, $result, $params );
343  }
344  $key = $this->getLocalCacheKey( 'ForeignAPIRepo', 'ThumbUrl', $name );
345  $sizekey = "$width:$height:$params";
346 
347  /* Get the array of urls that we already know */
348  $knownThumbUrls = $cache->get( $key );
349  if ( !$knownThumbUrls ) {
350  /* No knownThumbUrls for this file */
351  $knownThumbUrls = [];
352  } else {
353  if ( isset( $knownThumbUrls[$sizekey] ) ) {
354  wfDebug( __METHOD__ . ': Got thumburl from local cache: ' .
355  "{$knownThumbUrls[$sizekey]} \n" );
356 
357  return $knownThumbUrls[$sizekey];
358  }
359  /* This size is not yet known */
360  }
361 
362  $metadata = null;
363  $foreignUrl = $this->getThumbUrl( $name, $width, $height, $metadata, $params );
364 
365  if ( !$foreignUrl ) {
366  wfDebug( __METHOD__ . " Could not find thumburl\n" );
367 
368  return false;
369  }
370 
371  // We need the same filename as the remote one :)
372  $fileName = rawurldecode( pathinfo( $foreignUrl, PATHINFO_BASENAME ) );
373  if ( !$this->validateFilename( $fileName ) ) {
374  wfDebug( __METHOD__ . " The deduced filename $fileName is not safe\n" );
375 
376  return false;
377  }
378  $localPath = $this->getZonePath( 'thumb' ) . "/" . $this->getHashPath( $name ) . $name;
379  $localFilename = $localPath . "/" . $fileName;
380  $localUrl = $this->getZoneUrl( 'thumb' ) . "/" . $this->getHashPath( $name ) .
381  rawurlencode( $name ) . "/" . rawurlencode( $fileName );
382 
383  if ( $backend->fileExists( [ 'src' => $localFilename ] )
384  && isset( $metadata['timestamp'] )
385  ) {
386  wfDebug( __METHOD__ . " Thumbnail was already downloaded before\n" );
387  $modified = $backend->getFileTimestamp( [ 'src' => $localFilename ] );
388  $remoteModified = strtotime( $metadata['timestamp'] );
389  $current = time();
390  $diff = abs( $modified - $current );
391  if ( $remoteModified < $modified && $diff < $this->fileCacheExpiry ) {
392  /* Use our current and already downloaded thumbnail */
393  $knownThumbUrls[$sizekey] = $localUrl;
394  $cache->set( $key, $knownThumbUrls, $this->apiThumbCacheExpiry );
395 
396  return $localUrl;
397  }
398  /* There is a new Commons file, or existing thumbnail older than a month */
399  }
400  $thumb = self::httpGet( $foreignUrl );
401  if ( !$thumb ) {
402  wfDebug( __METHOD__ . " Could not download thumb\n" );
403 
404  return false;
405  }
406 
407  # @todo FIXME: Delete old thumbs that aren't being used. Maintenance script?
408  $backend->prepare( [ 'dir' => dirname( $localFilename ) ] );
409  $params = [ 'dst' => $localFilename, 'content' => $thumb ];
410  if ( !$backend->quickCreate( $params )->isOK() ) {
411  wfDebug( __METHOD__ . " could not write to thumb path '$localFilename'\n" );
412 
413  return $foreignUrl;
414  }
415  $knownThumbUrls[$sizekey] = $localUrl;
416  $cache->set( $key, $knownThumbUrls, $this->apiThumbCacheExpiry );
417  wfDebug( __METHOD__ . " got local thumb $localUrl, saving to cache \n" );
418 
419  return $localUrl;
420  }
421 
428  function getZoneUrl( $zone, $ext = null ) {
429  switch ( $zone ) {
430  case 'public':
431  return $this->url;
432  case 'thumb':
433  return $this->thumbUrl;
434  default:
435  return parent::getZoneUrl( $zone, $ext );
436  }
437  }
438 
444  function getZonePath( $zone ) {
445  $supported = [ 'public', 'thumb' ];
446  if ( in_array( $zone, $supported ) ) {
447  return parent::getZonePath( $zone );
448  }
449 
450  return false;
451  }
452 
457  public function canCacheThumbs() {
458  return ( $this->apiThumbCacheExpiry > 0 );
459  }
460 
465  public static function getUserAgent() {
466  return Http::userAgent() . " ForeignAPIRepo/" . self::VERSION;
467  }
468 
475  function getInfo() {
476  $info = parent::getInfo();
477  $info['apiurl'] = $this->getApiUrl();
478 
479  $query = [
480  'format' => 'json',
481  'action' => 'query',
482  'meta' => 'siteinfo',
483  'siprop' => 'general',
484  ];
485 
486  $data = $this->httpGetCached( 'SiteInfo', $query, 7200 );
487 
488  if ( $data ) {
489  $siteInfo = FormatJson::decode( $data, true );
490  $general = $siteInfo['query']['general'];
491 
492  $info['articlepath'] = $general['articlepath'];
493  $info['server'] = $general['server'];
494 
495  if ( isset( $general['favicon'] ) ) {
496  $info['favicon'] = $general['favicon'];
497  }
498  }
499 
500  return $info;
501  }
502 
511  public static function httpGet( $url, $timeout = 'default', $options = [] ) {
512  $options['timeout'] = $timeout;
513  /* Http::get */
515  wfDebug( "ForeignAPIRepo: HTTP GET: $url\n" );
516  $options['method'] = "GET";
517 
518  if ( !isset( $options['timeout'] ) ) {
519  $options['timeout'] = 'default';
520  }
521 
522  $req = MWHttpRequest::factory( $url, $options, __METHOD__ );
523  $req->setUserAgent( ForeignAPIRepo::getUserAgent() );
524  $status = $req->execute();
525 
526  if ( $status->isOK() ) {
527  return $req->getContent();
528  } else {
529  $logger = LoggerFactory::getInstance( 'http' );
530  $logger->warning(
531  $status->getWikiText( false, false, 'en' ),
532  [ 'caller' => 'ForeignAPIRepo::httpGet' ]
533  );
534  return false;
535  }
536  }
537 
542  protected static function getIIProps() {
543  return implode( '|', self::$imageInfoProps );
544  }
545 
553  public function httpGetCached( $target, $query, $cacheTTL = 3600 ) {
554  if ( $this->mApiBase ) {
555  $url = wfAppendQuery( $this->mApiBase, $query );
556  } else {
557  $url = $this->makeUrl( $query, 'api' );
558  }
559 
560  if ( !isset( $this->mQueryCache[$url] ) ) {
561  $data = ObjectCache::getMainWANInstance()->getWithSetCallback(
562  $this->getLocalCacheKey( get_class( $this ), $target, md5( $url ) ),
563  $cacheTTL,
564  function () use ( $url ) {
565  return ForeignAPIRepo::httpGet( $url );
566  }
567  );
568 
569  if ( !$data ) {
570  return null;
571  }
572 
573  if ( count( $this->mQueryCache ) > 100 ) {
574  // Keep the cache from growing infinitely
575  $this->mQueryCache = [];
576  }
577 
578  $this->mQueryCache[$url] = $data;
579  }
580 
581  return $this->mQueryCache[$url];
582  }
583 
588  function enumFiles( $callback ) {
589  throw new MWException( 'enumFiles is not supported by ' . get_class( $this ) );
590  }
591 
595  protected function assertWritableRepo() {
596  throw new MWException( get_class( $this ) . ': write operations are not supported.' );
597  }
598 }
getHashPath($name)
Get a relative path including trailing slash, e.g.
Definition: FileRepo.php:660
static getMainWANInstance()
Get the main WAN cache object.
the array() calling protocol came about after MediaWiki 1.4rc1.
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:1418
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
getZoneUrl($zone, $ext=null)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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:1798
if(!isset($args[0])) $lang
getThumbError($name, $width=-1, $height=-1, $otherParams= '', $lang=null)
$wgLocalFileRepo
File repository structures.
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1816
$files
int $apiThumbCacheExpiry
Check back with Commons after this expiry.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
getFileTimestamp(array $params)
Get the last-modified timestamp of the file at a storage path.
fileExistsBatch(array $files)
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1612
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static userAgent()
A standard user-agent we can use for external requests.
getBackend()
Get the file backend instance.
Definition: FileRepo.php:215
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':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:1796
makeUrl($query= '', $entry= 'index')
Make an url to this repo.
Definition: FileRepo.php:721
newFile($title, $time=false)
Per docs in FileRepo, this needs to return false if we don't support versioned files.
$wgLanguageCode
Site language code.
Foreign file accessible through api.php requests.
quickCreate(array $params)
Performs a single quick create operation.
static httpGet($url, $timeout= 'default', $options=[])
Like a Http:get request, but with custom User-Agent.
wfAppendQuery($url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfWarn($msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
bool $url
Public zone URL.
Definition: FileRepo.php:103
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1004
static isStoragePath($path)
Check if a given path is a "mwstore://" path.
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.
$cache
Definition: mcc.php:33
$params
static $imageInfoProps
List of iiprop values for the thumbnail fetch queries.
string $thumbUrl
The base thumbnail URL.
Definition: FileRepo.php:106
validateFilename($filename)
Determine if a relative path is valid, i.e.
Definition: FileRepo.php:1663
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
const NS_FILE
Definition: Defines.php:75
getThumbUrlFromCache($name, $width, $height, $params="")
Return the imageurl from cache if possible.
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:261
prepare(array $params)
Prepare a storage directory for usage.
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:965
enumFiles($callback)
getInfo()
Get information about the repo - overrides/extends the parent class's information.
getDisplayName()
Get the human-readable name of the repo.
Definition: FileRepo.php:1761
Base class for file repositories.
Definition: FileRepo.php:37
httpGetCached($target, $query, $cacheTTL=3600)
HTTP GET request to a mediawiki API (with caching)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1004
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
A foreign repository with a remote MediaWiki with an API thingy.
FileBackend $backend
Definition: FileRepo.php:59
getFileProps($virtualUrl)
static factory($url, $options=null, $caller=__METHOD__)
Generate a new request object.
canCacheThumbs()
Are we locally caching the thumbnails?
static decode($value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:187
int $fileCacheExpiry
Redownload thumbnail files after this expiry.
getZonePath($zone)
Get the local directory corresponding to one of the basic zones.
static getUserAgent()
The user agent the ForeignAPIRepo will use.
static & makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:524
getThumbUrl($name, $width=-1, $height=-1, &$result=null, $otherParams= '')
Basic media transform error class.
fetchImageQuery($query)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310