MediaWiki  master
ApiQueryRevisions.php
Go to the documentation of this file.
1 <?php
26 
36 
37  private $token = null;
38 
39  public function __construct( ApiQuery $query, $moduleName ) {
40  parent::__construct( $query, $moduleName, 'rv' );
41  }
42 
43  private $tokenFunctions;
44 
46  protected function getTokenFunctions() {
47  // tokenname => function
48  // function prototype is func($pageid, $title, $rev)
49  // should return token or false
50 
51  // Don't call the hooks twice
52  if ( isset( $this->tokenFunctions ) ) {
53  return $this->tokenFunctions;
54  }
55 
56  // If we're in a mode that breaks the same-origin policy, no tokens can
57  // be obtained
58  if ( $this->lacksSameOriginSecurity() ) {
59  return [];
60  }
61 
62  $this->tokenFunctions = [
63  'rollback' => [ self::class, 'getRollbackToken' ]
64  ];
65  Hooks::run( 'APIQueryRevisionsTokens', [ &$this->tokenFunctions ] );
66 
67  return $this->tokenFunctions;
68  }
69 
77  public static function getRollbackToken( $pageid, $title, $rev ) {
78  global $wgUser;
79  if ( !$wgUser->isAllowed( 'rollback' ) ) {
80  return false;
81  }
82 
83  return $wgUser->getEditToken( 'rollback' );
84  }
85 
86  protected function run( ApiPageSet $resultPageSet = null ) {
88 
89  $params = $this->extractRequestParams( false );
90  $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
91 
92  // If any of those parameters are used, work in 'enumeration' mode.
93  // Enum mode can only be used when exactly one page is provided.
94  // Enumerating revisions on multiple pages make it extremely
95  // difficult to manage continuations and require additional SQL indexes
96  $enumRevMode = ( $params['user'] !== null || $params['excludeuser'] !== null ||
97  $params['limit'] !== null || $params['startid'] !== null ||
98  $params['endid'] !== null || $params['dir'] === 'newer' ||
99  $params['start'] !== null || $params['end'] !== null );
100 
101  $pageSet = $this->getPageSet();
102  $pageCount = $pageSet->getGoodTitleCount();
103  $revCount = $pageSet->getRevisionCount();
104 
105  // Optimization -- nothing to do
106  if ( $revCount === 0 && $pageCount === 0 ) {
107  // Nothing to do
108  return;
109  }
110  if ( $revCount > 0 && count( $pageSet->getLiveRevisionIDs() ) === 0 ) {
111  // We're in revisions mode but all given revisions are deleted
112  return;
113  }
114 
115  if ( $revCount > 0 && $enumRevMode ) {
116  $this->dieWithError(
117  [ 'apierror-revisions-nolist', $this->getModulePrefix() ], 'invalidparammix'
118  );
119  }
120 
121  if ( $pageCount > 1 && $enumRevMode ) {
122  $this->dieWithError(
123  [ 'apierror-revisions-singlepage', $this->getModulePrefix() ], 'invalidparammix'
124  );
125  }
126 
127  // In non-enum mode, rvlimit can't be directly used. Use the maximum
128  // allowed value.
129  if ( !$enumRevMode ) {
130  $this->setParsedLimit = false;
131  $params['limit'] = 'max';
132  }
133 
134  $db = $this->getDB();
135 
136  $idField = 'rev_id';
137  $tsField = 'rev_timestamp';
138  $pageField = 'rev_page';
139  if ( $params['user'] !== null &&
140  ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW )
141  ) {
142  // We're going to want to use the page_actor_timestamp index (on revision_actor_temp)
143  // so use that table's denormalized fields.
144  $idField = 'revactor_rev';
145  $tsField = 'revactor_timestamp';
146  $pageField = 'revactor_page';
147  }
148 
149  if ( $resultPageSet === null ) {
150  $this->parseParameters( $params );
151  $this->token = $params['token'];
152  $opts = [];
153  if ( $this->token !== null || $pageCount > 0 ) {
154  $opts[] = 'page';
155  }
156  if ( $this->fld_user ) {
157  $opts[] = 'user';
158  }
159  $revQuery = $revisionStore->getQueryInfo( $opts );
160 
161  if ( $idField !== 'rev_id' ) {
162  $aliasFields = [ 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField ];
163  $revQuery['fields'] = array_merge(
164  $aliasFields,
165  array_diff( $revQuery['fields'], array_keys( $aliasFields ) )
166  );
167  }
168 
169  $this->addTables( $revQuery['tables'] );
170  $this->addFields( $revQuery['fields'] );
171  $this->addJoinConds( $revQuery['joins'] );
172  } else {
173  $this->limit = $this->getParameter( 'limit' ) ?: 10;
174  // Always join 'page' so orphaned revisions are filtered out
175  $this->addTables( [ 'revision', 'page' ] );
176  $this->addJoinConds(
177  [ 'page' => [ 'JOIN', [ 'page_id = rev_page' ] ] ]
178  );
179  $this->addFields( [
180  'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField
181  ] );
182  }
183 
184  if ( $this->fld_tags ) {
185  $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'revision' ) ] );
186  }
187 
188  if ( $params['tag'] !== null ) {
189  $this->addTables( 'change_tag' );
190  $this->addJoinConds(
191  [ 'change_tag' => [ 'JOIN', [ 'rev_id=ct_rev_id' ] ] ]
192  );
193  $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
194  try {
195  $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
196  } catch ( NameTableAccessException $exception ) {
197  // Return nothing.
198  $this->addWhere( '1=0' );
199  }
200  }
201 
202  if ( $resultPageSet === null && $this->fetchContent ) {
203  // For each page we will request, the user must have read rights for that page
204  $user = $this->getUser();
207  foreach ( $pageSet->getGoodTitles() as $title ) {
208  if ( !$title->userCan( 'read', $user ) ) {
209  $status->fatal( ApiMessage::create(
210  [ 'apierror-cannotviewtitle', wfEscapeWikiText( $title->getPrefixedText() ) ],
211  'accessdenied'
212  ) );
213  }
214  }
215  if ( !$status->isGood() ) {
216  $this->dieStatus( $status );
217  }
218  }
219 
220  if ( $enumRevMode ) {
221  // Indexes targeted:
222  // page_timestamp if we don't have rvuser
223  // page_actor_timestamp (on revision_actor_temp) if we have rvuser in READ_NEW mode
224  // page_user_timestamp if we have a logged-in rvuser
225  // page_timestamp or usertext_timestamp if we have an IP rvuser
226 
227  // This is mostly to prevent parameter errors (and optimize SQL?)
228  $this->requireMaxOneParameter( $params, 'startid', 'start' );
229  $this->requireMaxOneParameter( $params, 'endid', 'end' );
230  $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
231 
232  if ( $params['continue'] !== null ) {
233  $cont = explode( '|', $params['continue'] );
234  $this->dieContinueUsageIf( count( $cont ) != 2 );
235  $op = ( $params['dir'] === 'newer' ? '>' : '<' );
236  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
237  $continueId = (int)$cont[1];
238  $this->dieContinueUsageIf( $continueId != $cont[1] );
239  $this->addWhere( "$tsField $op $continueTimestamp OR " .
240  "($tsField = $continueTimestamp AND " .
241  "$idField $op= $continueId)"
242  );
243  }
244 
245  // Convert startid/endid to timestamps (T163532)
246  $revids = [];
247  if ( $params['startid'] !== null ) {
248  $revids[] = (int)$params['startid'];
249  }
250  if ( $params['endid'] !== null ) {
251  $revids[] = (int)$params['endid'];
252  }
253  if ( $revids ) {
254  $db = $this->getDB();
255  $sql = $db->unionQueries( [
256  $db->selectSQLText(
257  'revision',
258  [ 'id' => 'rev_id', 'ts' => 'rev_timestamp' ],
259  [ 'rev_id' => $revids ],
260  __METHOD__
261  ),
262  $db->selectSQLText(
263  'archive',
264  [ 'id' => 'ar_rev_id', 'ts' => 'ar_timestamp' ],
265  [ 'ar_rev_id' => $revids ],
266  __METHOD__
267  ),
268  ], $db::UNION_DISTINCT );
269  $res = $db->query( $sql, __METHOD__ );
270  foreach ( $res as $row ) {
271  if ( (int)$row->id === (int)$params['startid'] ) {
272  $params['start'] = $row->ts;
273  }
274  if ( (int)$row->id === (int)$params['endid'] ) {
275  $params['end'] = $row->ts;
276  }
277  }
278  if ( $params['startid'] !== null && $params['start'] === null ) {
279  $p = $this->encodeParamName( 'startid' );
280  $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
281  }
282  if ( $params['endid'] !== null && $params['end'] === null ) {
283  $p = $this->encodeParamName( 'endid' );
284  $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
285  }
286 
287  if ( $params['start'] !== null ) {
288  $op = ( $params['dir'] === 'newer' ? '>' : '<' );
289  $ts = $db->addQuotes( $db->timestampOrNull( $params['start'] ) );
290  if ( $params['startid'] !== null ) {
291  $this->addWhere( "$tsField $op $ts OR "
292  . "$tsField = $ts AND $idField $op= " . (int)$params['startid'] );
293  } else {
294  $this->addWhere( "$tsField $op= $ts" );
295  }
296  }
297  if ( $params['end'] !== null ) {
298  $op = ( $params['dir'] === 'newer' ? '<' : '>' ); // Yes, opposite of the above
299  $ts = $db->addQuotes( $db->timestampOrNull( $params['end'] ) );
300  if ( $params['endid'] !== null ) {
301  $this->addWhere( "$tsField $op $ts OR "
302  . "$tsField = $ts AND $idField $op= " . (int)$params['endid'] );
303  } else {
304  $this->addWhere( "$tsField $op= $ts" );
305  }
306  }
307  } else {
308  $this->addTimestampWhereRange( $tsField, $params['dir'],
309  $params['start'], $params['end'] );
310  }
311 
312  $sort = ( $params['dir'] === 'newer' ? '' : 'DESC' );
313  $this->addOption( 'ORDER BY', [ "rev_timestamp $sort", "rev_id $sort" ] );
314 
315  // There is only one ID, use it
316  $ids = array_keys( $pageSet->getGoodTitles() );
317  $this->addWhereFld( $pageField, reset( $ids ) );
318 
319  if ( $params['user'] !== null ) {
320  $actorQuery = ActorMigration::newMigration()
321  ->getWhere( $db, 'rev_user', User::newFromName( $params['user'], false ) );
322  $this->addTables( $actorQuery['tables'] );
323  $this->addJoinConds( $actorQuery['joins'] );
324  $this->addWhere( $actorQuery['conds'] );
325  } elseif ( $params['excludeuser'] !== null ) {
326  $actorQuery = ActorMigration::newMigration()
327  ->getWhere( $db, 'rev_user', User::newFromName( $params['excludeuser'], false ) );
328  $this->addTables( $actorQuery['tables'] );
329  $this->addJoinConds( $actorQuery['joins'] );
330  $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
331  }
332  if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
333  // Paranoia: avoid brute force searches (T19342)
334  if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
335  $bitmask = RevisionRecord::DELETED_USER;
336  } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
337  $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
338  } else {
339  $bitmask = 0;
340  }
341  if ( $bitmask ) {
342  $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
343  }
344  }
345  } elseif ( $revCount > 0 ) {
346  // Always targets the PRIMARY index
347 
348  $revs = $pageSet->getLiveRevisionIDs();
349 
350  // Get all revision IDs
351  $this->addWhereFld( 'rev_id', array_keys( $revs ) );
352 
353  if ( $params['continue'] !== null ) {
354  $this->addWhere( 'rev_id >= ' . (int)$params['continue'] );
355  }
356  $this->addOption( 'ORDER BY', 'rev_id' );
357  } elseif ( $pageCount > 0 ) {
358  // Always targets the rev_page_id index
359 
360  $titles = $pageSet->getGoodTitles();
361 
362  // When working in multi-page non-enumeration mode,
363  // limit to the latest revision only
364  $this->addWhere( 'page_latest=rev_id' );
365 
366  // Get all page IDs
367  $this->addWhereFld( 'page_id', array_keys( $titles ) );
368  // Every time someone relies on equality propagation, god kills a kitten :)
369  $this->addWhereFld( 'rev_page', array_keys( $titles ) );
370 
371  if ( $params['continue'] !== null ) {
372  $cont = explode( '|', $params['continue'] );
373  $this->dieContinueUsageIf( count( $cont ) != 2 );
374  $pageid = (int)$cont[0];
375  $revid = (int)$cont[1];
376  $this->addWhere(
377  "rev_page > $pageid OR " .
378  "(rev_page = $pageid AND " .
379  "rev_id >= $revid)"
380  );
381  }
382  $this->addOption( 'ORDER BY', [
383  'rev_page',
384  'rev_id'
385  ] );
386  } else {
387  ApiBase::dieDebug( __METHOD__, 'param validation?' );
388  }
389 
390  $this->addOption( 'LIMIT', $this->limit + 1 );
391 
392  $count = 0;
393  $generated = [];
394  $hookData = [];
395  $res = $this->select( __METHOD__, [], $hookData );
396 
397  foreach ( $res as $row ) {
398  if ( ++$count > $this->limit ) {
399  // We've reached the one extra which shows that there are
400  // additional pages to be had. Stop here...
401  if ( $enumRevMode ) {
402  $this->setContinueEnumParameter( 'continue',
403  $row->rev_timestamp . '|' . (int)$row->rev_id );
404  } elseif ( $revCount > 0 ) {
405  $this->setContinueEnumParameter( 'continue', (int)$row->rev_id );
406  } else {
407  $this->setContinueEnumParameter( 'continue', (int)$row->rev_page .
408  '|' . (int)$row->rev_id );
409  }
410  break;
411  }
412 
413  if ( $resultPageSet !== null ) {
414  $generated[] = $row->rev_id;
415  } else {
416  $revision = $revisionStore->newRevisionFromRow( $row );
417  $rev = $this->extractRevisionInfo( $revision, $row );
418 
419  if ( $this->token !== null ) {
420  $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
421  $revisionCompat = new Revision( $revision );
423  foreach ( $this->token as $t ) {
424  $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revisionCompat );
425  if ( $val === false ) {
426  $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
427  } else {
428  $rev[$t . 'token'] = $val;
429  }
430  }
431  }
432 
433  $fit = $this->processRow( $row, $rev, $hookData ) &&
434  $this->addPageSubItem( $row->rev_page, $rev, 'rev' );
435  if ( !$fit ) {
436  if ( $enumRevMode ) {
437  $this->setContinueEnumParameter( 'continue',
438  $row->rev_timestamp . '|' . (int)$row->rev_id );
439  } elseif ( $revCount > 0 ) {
440  $this->setContinueEnumParameter( 'continue', (int)$row->rev_id );
441  } else {
442  $this->setContinueEnumParameter( 'continue', (int)$row->rev_page .
443  '|' . (int)$row->rev_id );
444  }
445  break;
446  }
447  }
448  }
449 
450  if ( $resultPageSet !== null ) {
451  $resultPageSet->populateFromRevisionIDs( $generated );
452  }
453  }
454 
455  public function getCacheMode( $params ) {
456  if ( isset( $params['token'] ) ) {
457  return 'private';
458  }
459  return parent::getCacheMode( $params );
460  }
461 
462  public function getAllowedParams() {
463  $ret = parent::getAllowedParams() + [
464  'startid' => [
465  ApiBase::PARAM_TYPE => 'integer',
466  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
467  ],
468  'endid' => [
469  ApiBase::PARAM_TYPE => 'integer',
470  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
471  ],
472  'start' => [
473  ApiBase::PARAM_TYPE => 'timestamp',
474  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
475  ],
476  'end' => [
477  ApiBase::PARAM_TYPE => 'timestamp',
478  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
479  ],
480  'dir' => [
481  ApiBase::PARAM_DFLT => 'older',
483  'newer',
484  'older'
485  ],
486  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
487  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
488  ],
489  'user' => [
490  ApiBase::PARAM_TYPE => 'user',
491  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
492  ],
493  'excludeuser' => [
494  ApiBase::PARAM_TYPE => 'user',
495  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
496  ],
497  'tag' => null,
498  'token' => [
500  ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
502  ],
503  'continue' => [
504  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
505  ],
506  ];
507 
508  $ret['limit'][ApiBase::PARAM_HELP_MSG_INFO] = [ [ 'singlepageonly' ] ];
509 
510  return $ret;
511  }
512 
513  protected function getExamplesMessages() {
514  return [
515  'action=query&prop=revisions&titles=API|Main%20Page&' .
516  'rvslots=*&rvprop=timestamp|user|comment|content'
517  => 'apihelp-query+revisions-example-content',
518  'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
519  'rvprop=timestamp|user|comment'
520  => 'apihelp-query+revisions-example-last5',
521  'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
522  'rvprop=timestamp|user|comment&rvdir=newer'
523  => 'apihelp-query+revisions-example-first5',
524  'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
525  'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
526  => 'apihelp-query+revisions-example-first5-after',
527  'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
528  'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
529  => 'apihelp-query+revisions-example-first5-not-localhost',
530  'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
531  'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
532  => 'apihelp-query+revisions-example-first5-user',
533  ];
534  }
535 
536  public function getHelpUrls() {
537  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions';
538  }
539 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
static getRollbackToken( $pageid, $title, $rev)
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:87
getDB()
Get the Query database connection (read-only)
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
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
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
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
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:2061
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
Exception representing a failure to look up a row from a name table.
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
$sort
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:141
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition: ApiBase.php:560
A base class for functions common to producing a list of revisions.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1990
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:743
const SCHEMA_COMPAT_READ_NEW
Definition: Defines.php:287
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 MediaWikiServices
Definition: injection.txt:23
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:858
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 true
Definition: hooks.txt:1982
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
run(ApiPageSet $resultPageSet=null)
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
static newMigration()
Static constructor.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
$res
Definition: database.txt:21
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2176
$params
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
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
addFields( $value)
Add a set of fields to select to the internal array.
This is the main query class.
Definition: ApiQuery.php:36
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1766
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
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:913
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:124
A query action to enumerate revisions of a given page, or show top revisions of multiple pages...
static newFromLinkTarget(LinkTarget $linkTarget, $forceClone='')
Returns a Title given a LinkTarget.
Definition: Title.php:271
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
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
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:520
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
addWhere( $value)
Add a set of WHERE clauses to the internal array.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1909
$revQuery
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2188
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
extractRevisionInfo(RevisionRecord $revision, $row)
Extract information from the RevisionRecord.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:105
parseParameters( $params)
Parse the parameters into the various instance fields.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:587
__construct(ApiQuery $query, $moduleName)
static makeTagSummarySubquery( $tables)
Make the tag summary subquery based on the given tables and return it.
Definition: ChangeTags.php:793
getPageSet()
Get the PageSet object to work on.
encodeParamName( $paramName)
Overrides ApiBase to prepend &#39;g&#39; to every generator parameter.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:40