MediaWiki REL1_30
ForeignAPIRepo.php
Go to the documentation of this file.
1<?php
25
41class 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 $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 = 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
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
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 $cache = ObjectCache::getMainWANInstance();
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
401 $thumb = self::httpGet( $foreignUrl, 'default', [], $mtime );
402 if ( !$thumb ) {
403 wfDebug( __METHOD__ . " Could not download thumb\n" );
404
405 return false;
406 }
407
408 # @todo FIXME: Delete old thumbs that aren't being used. Maintenance script?
409 $backend->prepare( [ 'dir' => dirname( $localFilename ) ] );
410 $params = [ 'dst' => $localFilename, 'content' => $thumb ];
411 if ( !$backend->quickCreate( $params )->isOK() ) {
412 wfDebug( __METHOD__ . " could not write to thumb path '$localFilename'\n" );
413
414 return $foreignUrl;
415 }
416 $knownThumbUrls[$sizekey] = $localUrl;
417
418 $ttl = $mtime
419 ? $cache->adaptiveTTL( $mtime, $this->apiThumbCacheExpiry )
421 $cache->set( $key, $knownThumbUrls, $ttl );
422 wfDebug( __METHOD__ . " got local thumb $localUrl, saving to cache \n" );
423
424 return $localUrl;
425 }
426
433 function getZoneUrl( $zone, $ext = null ) {
434 switch ( $zone ) {
435 case 'public':
436 return $this->url;
437 case 'thumb':
438 return $this->thumbUrl;
439 default:
440 return parent::getZoneUrl( $zone, $ext );
441 }
442 }
443
449 function getZonePath( $zone ) {
450 $supported = [ 'public', 'thumb' ];
451 if ( in_array( $zone, $supported ) ) {
452 return parent::getZonePath( $zone );
453 }
454
455 return false;
456 }
457
462 public function canCacheThumbs() {
463 return ( $this->apiThumbCacheExpiry > 0 );
464 }
465
470 public static function getUserAgent() {
471 return Http::userAgent() . " ForeignAPIRepo/" . self::VERSION;
472 }
473
480 function getInfo() {
481 $info = parent::getInfo();
482 $info['apiurl'] = $this->getApiUrl();
483
484 $query = [
485 'format' => 'json',
486 'action' => 'query',
487 'meta' => 'siteinfo',
488 'siprop' => 'general',
489 ];
490
491 $data = $this->httpGetCached( 'SiteInfo', $query, 7200 );
492
493 if ( $data ) {
494 $siteInfo = FormatJson::decode( $data, true );
495 $general = $siteInfo['query']['general'];
496
497 $info['articlepath'] = $general['articlepath'];
498 $info['server'] = $general['server'];
499
500 if ( isset( $general['favicon'] ) ) {
501 $info['favicon'] = $general['favicon'];
502 }
503 }
504
505 return $info;
506 }
507
517 public static function httpGet(
518 $url, $timeout = 'default', $options = [], &$mtime = false
519 ) {
520 $options['timeout'] = $timeout;
521 /* Http::get */
523 wfDebug( "ForeignAPIRepo: HTTP GET: $url\n" );
524 $options['method'] = "GET";
525
526 if ( !isset( $options['timeout'] ) ) {
527 $options['timeout'] = 'default';
528 }
529
530 $req = MWHttpRequest::factory( $url, $options, __METHOD__ );
531 $req->setUserAgent( self::getUserAgent() );
532 $status = $req->execute();
533
534 if ( $status->isOK() ) {
535 $lmod = $req->getResponseHeader( 'Last-Modified' );
536 $mtime = $lmod ? wfTimestamp( TS_UNIX, $lmod ) : false;
537
538 return $req->getContent();
539 } else {
540 $logger = LoggerFactory::getInstance( 'http' );
541 $logger->warning(
542 $status->getWikiText( false, false, 'en' ),
543 [ 'caller' => 'ForeignAPIRepo::httpGet' ]
544 );
545
546 return false;
547 }
548 }
549
554 protected static function getIIProps() {
555 return implode( '|', self::$imageInfoProps );
556 }
557
565 public function httpGetCached( $target, $query, $cacheTTL = 3600 ) {
566 if ( $this->mApiBase ) {
567 $url = wfAppendQuery( $this->mApiBase, $query );
568 } else {
569 $url = $this->makeUrl( $query, 'api' );
570 }
571
572 $cache = ObjectCache::getMainWANInstance();
573 return $cache->getWithSetCallback(
574 $this->getLocalCacheKey( static::class, $target, md5( $url ) ),
575 $cacheTTL,
576 function ( $curValue, &$ttl ) use ( $url, $cache ) {
577 $html = self::httpGet( $url, 'default', [], $mtime );
578 if ( $html !== false ) {
579 $ttl = $mtime ? $cache->adaptiveTTL( $mtime, $ttl ) : $ttl;
580 } else {
581 $ttl = $cache->adaptiveTTL( $mtime, $ttl );
582 $html = null; // caches negatives
583 }
584
585 return $html;
586 },
587 [ 'pcTTL' => $cache::TTL_PROC_LONG ]
588 );
589 }
590
595 function enumFiles( $callback ) {
596 throw new MWException( 'enumFiles is not supported by ' . static::class );
597 }
598
602 protected function assertWritableRepo() {
603 throw new MWException( static::class . ': write operations are not supported.' );
604 }
605}
$wgLanguageCode
Site language code.
$wgLocalFileRepo
File repository structures.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
fileExists(array $params)
Check if a file exists at a storage path in the backend.
getFileTimestamp(array $params)
Get the last-modified timestamp of the file at a storage path.
prepare(array $params)
Prepare a storage directory for usage.
quickCreate(array $params)
Performs a single quick create operation.
Base class for file repositories.
Definition FileRepo.php:37
getLocalCacheKey()
Get a key for this repo in the local cache domain.
getDisplayName()
Get the human-readable name of the repo.
makeUrl( $query='', $entry='index')
Make an url to this repo.
Definition FileRepo.php:720
FileBackend $backend
Definition FileRepo.php:59
string $thumbUrl
The base thumbnail URL.
Definition FileRepo.php:106
string false $url
Public zone URL.
Definition FileRepo.php:103
validateFilename( $filename)
Determine if a relative path is valid, i.e.
getHashPath( $name)
Get a relative path including trailing slash, e.g.
Definition FileRepo.php:659
getBackend()
Get the file backend instance.
Definition FileRepo.php:215
Foreign file accessible through api.php requests.
static getProps()
Get the property string for iiprop and aiprop.
A foreign repository with a remote MediaWiki with an API thingy.
int $fileCacheExpiry
Redownload thumbnail files after this expiry.
newFile( $title, $time=false)
Per docs in FileRepo, this needs to return false if we don't support versioned files.
httpGetCached( $target, $query, $cacheTTL=3600)
HTTP GET request to a mediawiki API (with caching)
static httpGet( $url, $timeout='default', $options=[], &$mtime=false)
Like a Http:get request, but with custom User-Agent.
getThumbUrl( $name, $width=-1, $height=-1, &$result=null, $otherParams='')
enumFiles( $callback)
getInfo()
Get information about the repo - overrides/extends the parent class's information.
static getUserAgent()
The user agent the ForeignAPIRepo will use.
fetchImageQuery( $query)
getThumbError( $name, $width=-1, $height=-1, $otherParams='', $lang=null)
canCacheThumbs()
Are we locally caching the thumbnails?
int $apiThumbCacheExpiry
Check back with Commons after this expiry.
static $imageInfoProps
List of iiprop values for the thumbnail fetch queries.
getFileProps( $virtualUrl)
getThumbUrlFromCache( $name, $width, $height, $params="")
Return the imageurl from cache if possible.
fileExistsBatch(array $files)
getZoneUrl( $zone, $ext=null)
getZonePath( $zone)
Get the local directory corresponding to one of the basic zones.
MediaWiki exception.
Basic media transform error class.
PSR-3 logger instance factory.
this hook is for auditing only $req
Definition hooks.txt:988
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition hooks.txt:1778
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:1971
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:1975
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:1983
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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). '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:1049
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:1610
const NS_FILE
Definition Defines.php:71
const PROTO_HTTP
Definition Defines.php:220
$cache
Definition mcc.php:33
$params
if(!isset( $args[0])) $lang