74 parent::__construct( $info );
77 $this->mApiBase = isset( $info[
'apibase'] ) ? $info[
'apibase'] : null;
79 if ( isset( $info[
'apiThumbCacheExpiry'] ) ) {
80 $this->apiThumbCacheExpiry = $info[
'apiThumbCacheExpiry'];
82 if ( isset( $info[
'fileCacheExpiry'] ) ) {
83 $this->fileCacheExpiry = $info[
'fileCacheExpiry'];
85 if ( !$this->scriptDirUrl ) {
87 $this->scriptDirUrl = dirname( $this->mApiBase );
91 $this->url = $wgLocalFileRepo[
'url'];
94 $this->thumbUrl = $this->url .
'/thumb';
128 foreach ( $files
as $k => $f ) {
129 if ( isset( $this->mFileExists[$f] ) ) {
130 $results[$k] = $this->mFileExists[$f];
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
136 $results[$k] =
false;
139 $results[$k] =
false;
141 wfWarn(
"Got mwstore:// path '$f'." );
146 'titles' => implode( $files,
'|' ),
147 'prop' =>
'imageinfo' ]
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'] !==
'' );
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']];
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']];
168 # Finally, copy the results to the output
169 foreach ( $files
as $key => $file ) {
170 $results[$key] = $this->mFileExists[$file];
196 'redirects' =>
'true'
199 if ( !isset(
$query[
'uselang'] ) ) {
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'];
238 'aisha1base36' => $hash,
240 'list' =>
'allimages',
243 if ( isset( $results[
'query'][
'allimages'] ) ) {
244 foreach ( $results[
'query'][
'allimages']
as $img ) {
246 if ( !isset( $img[
'name'] ) ) {
267 'titles' =>
'File:' .
$name,
268 'iiprop' => self::getIIProps(),
269 'iiurlwidth' => $width,
270 'iiurlheight' => $height,
271 'iiurlparam' => $otherParams,
272 'prop' =>
'imageinfo' ] );
275 if ( $data && $info && isset( $info[
'thumburl'] ) ) {
276 wfDebug( __METHOD__ .
" got remote thumb " . $info[
'thumburl'] .
"\n" );
279 return $info[
'thumburl'];
296 'titles' =>
'File:' .
$name,
297 'iiprop' => self::getIIProps(),
298 'iiurlwidth' => $width,
299 'iiurlheight' => $height,
300 'iiurlparam' => $otherParams,
301 'prop' =>
'imageinfo',
306 if ( $data && $info && isset( $info[
'thumberror'] ) ) {
307 wfDebug( __METHOD__ .
" got remote thumb error " . $info[
'thumberror'] .
"\n" );
310 'thumbnail_error_remote',
345 $sizekey =
"$width:$height:$params";
348 $knownThumbUrls =
$cache->get( $key );
349 if ( !$knownThumbUrls ) {
351 $knownThumbUrls = [];
353 if ( isset( $knownThumbUrls[$sizekey] ) ) {
354 wfDebug( __METHOD__ .
': Got thumburl from local cache: ' .
355 "{$knownThumbUrls[$sizekey]} \n" );
357 return $knownThumbUrls[$sizekey];
365 if ( !$foreignUrl ) {
366 wfDebug( __METHOD__ .
" Could not find thumburl\n" );
372 $fileName = rawurldecode( pathinfo( $foreignUrl, PATHINFO_BASENAME ) );
374 wfDebug( __METHOD__ .
" The deduced filename $fileName is not safe\n" );
379 $localFilename = $localPath .
"/" . $fileName;
381 rawurlencode(
$name ) .
"/" . rawurlencode( $fileName );
384 && isset( $metadata[
'timestamp'] )
386 wfDebug( __METHOD__ .
" Thumbnail was already downloaded before\n" );
388 $remoteModified = strtotime( $metadata[
'timestamp'] );
390 $diff = abs( $modified - $current );
391 if ( $remoteModified < $modified && $diff < $this->fileCacheExpiry ) {
393 $knownThumbUrls[$sizekey] = $localUrl;
394 $cache->set( $key, $knownThumbUrls, $this->apiThumbCacheExpiry );
401 $thumb = self::httpGet( $foreignUrl,
'default', [], $mtime );
403 wfDebug( __METHOD__ .
" Could not download thumb\n" );
408 # @todo FIXME: Delete old thumbs that aren't being used. Maintenance script?
410 $params = [
'dst' => $localFilename,
'content' => $thumb ];
412 wfDebug( __METHOD__ .
" could not write to thumb path '$localFilename'\n" );
416 $knownThumbUrls[$sizekey] = $localUrl;
419 ?
$cache->adaptiveTTL( $mtime, $this->apiThumbCacheExpiry )
421 $cache->set( $key, $knownThumbUrls, $ttl );
422 wfDebug( __METHOD__ .
" got local thumb $localUrl, saving to cache \n" );
440 return parent::getZoneUrl( $zone,
$ext );
450 $supported = [
'public',
'thumb' ];
451 if ( in_array( $zone, $supported ) ) {
452 return parent::getZonePath( $zone );
463 return ( $this->apiThumbCacheExpiry > 0 );
481 $info = parent::getInfo();
487 'meta' =>
'siteinfo',
488 'siprop' =>
'general',
495 $general = $siteInfo[
'query'][
'general'];
497 $info[
'articlepath'] = $general[
'articlepath'];
498 $info[
'server'] = $general[
'server'];
500 if ( isset( $general[
'favicon'] ) ) {
501 $info[
'favicon'] = $general[
'favicon'];
518 $url, $timeout =
'default',
$options = [], &$mtime =
false
523 wfDebug(
"ForeignAPIRepo: HTTP GET: $url\n" );
526 if ( !isset(
$options[
'timeout'] ) ) {
535 $lmod =
$req->getResponseHeader(
'Last-Modified' );
538 return $req->getContent();
540 $logger = LoggerFactory::getInstance(
'http' );
542 $status->getWikiText(
false,
false,
'en' ),
543 [
'caller' =>
'ForeignAPIRepo::httpGet' ]
555 return implode(
'|', self::$imageInfoProps );
566 if ( $this->mApiBase ) {
573 return $cache->getWithSetCallback(
577 $html = self::httpGet(
$url,
'default', [], $mtime );
578 if (
$html !==
false ) {
579 $ttl = $mtime ?
$cache->adaptiveTTL( $mtime, $ttl ) : $ttl;
581 $ttl =
$cache->adaptiveTTL( $mtime, $ttl );
587 [
'pcTTL' => $cache::TTL_PROC_LONG ]
596 throw new MWException(
'enumFiles is not supported by ' . get_class( $this ) );
603 throw new MWException( get_class( $this ) .
': write operations are not supported.' );
getHashPath($name)
Get a relative path including trailing slash, e.g.
static getMainWANInstance()
Get the main WAN cache object.
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
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
getZoneUrl($zone, $ext=null)
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
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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.
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
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)
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.
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
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
makeUrl($query= '', $entry= 'index')
Make an url to this repo.
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
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.
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.
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
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.
static $imageInfoProps
List of iiprop values for the thumbnail fetch queries.
string $thumbUrl
The base thumbnail URL.
validateFilename($filename)
Determine if a relative path is valid, i.e.
namespace and then decline to actually register it file or subcat img or subcat $title
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
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
this hook is for auditing only $req
getInfo()
Get information about the repo - overrides/extends the parent class's information.
getDisplayName()
Get the human-readable name of the repo.
Base class for file repositories.
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
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
A foreign repository with a remote MediaWiki with an API thingy.
getFileProps($virtualUrl)
static factory($url, $options=null, $caller=__METHOD__)
Generate a new request object.
canCacheThumbs()
Are we locally caching the thumbnails?
static httpGet($url, $timeout= 'default', $options=[], &$mtime=false)
Like a Http:get request, but with custom User-Agent.
int $fileCacheExpiry
Redownload thumbnail files after this expiry.
getZonePath($zone)
Get the local directory corresponding to one of the basic zones.
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
static getUserAgent()
The user agent the ForeignAPIRepo will use.
see documentation in includes Linker php for Linker::makeImageLink & $time
getThumbUrl($name, $width=-1, $height=-1, &$result=null, $otherParams= '')
Allows to change the fields on the form that will be generated $name