MediaWiki REL1_32
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
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 ) ) {
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
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 if ( $resultPageSet === null ) {
137 $this->parseParameters( $params );
138 $this->token = $params['token'];
139 $opts = [];
140 if ( $this->token !== null || $pageCount > 0 ) {
141 $opts[] = 'page';
142 }
143 if ( $this->fetchContent ) {
144 $opts[] = 'text';
145 }
146 if ( $this->fld_user ) {
147 $opts[] = 'user';
148 }
149 $revQuery = $revisionStore->getQueryInfo( $opts );
150 $this->addTables( $revQuery['tables'] );
151 $this->addFields( $revQuery['fields'] );
152 $this->addJoinConds( $revQuery['joins'] );
153 } else {
154 $this->limit = $this->getParameter( 'limit' ) ?: 10;
155 // Always join 'page' so orphaned revisions are filtered out
156 $this->addTables( [ 'revision', 'page' ] );
157 $this->addJoinConds(
158 [ 'page' => [ 'INNER JOIN', [ 'page_id = rev_page' ] ] ]
159 );
160 $this->addFields( [ 'rev_id', 'rev_timestamp', 'rev_page' ] );
161 }
162
163 if ( $this->fld_tags ) {
164 $this->addTables( 'tag_summary' );
165 $this->addJoinConds(
166 [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
167 );
168 $this->addFields( 'ts_tags' );
169 }
170
171 if ( $params['tag'] !== null ) {
172 $this->addTables( 'change_tag' );
173 $this->addJoinConds(
174 [ 'change_tag' => [ 'INNER JOIN', [ 'rev_id=ct_rev_id' ] ] ]
175 );
176 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH ) {
177 $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
178 try {
179 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
180 } catch ( NameTableAccessException $exception ) {
181 // Return nothing.
182 $this->addWhere( '1=0' );
183 }
184 } else {
185 $this->addWhereFld( 'ct_tag', $params['tag'] );
186 }
187 }
188
189 if ( $resultPageSet === null && $this->fetchContent ) {
190 // For each page we will request, the user must have read rights for that page
191 $user = $this->getUser();
192 $status = Status::newGood();
194 foreach ( $pageSet->getGoodTitles() as $title ) {
195 if ( !$title->userCan( 'read', $user ) ) {
197 [ 'apierror-cannotviewtitle', wfEscapeWikiText( $title->getPrefixedText() ) ],
198 'accessdenied'
199 ) );
200 }
201 }
202 if ( !$status->isGood() ) {
203 $this->dieStatus( $status );
204 }
205 }
206
207 if ( $enumRevMode ) {
208 // Indexes targeted:
209 // page_timestamp if we don't have rvuser
210 // page_user_timestamp if we have a logged-in rvuser
211 // page_timestamp or usertext_timestamp if we have an IP rvuser
212
213 // This is mostly to prevent parameter errors (and optimize SQL?)
214 $this->requireMaxOneParameter( $params, 'startid', 'start' );
215 $this->requireMaxOneParameter( $params, 'endid', 'end' );
216 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
217
218 if ( $params['continue'] !== null ) {
219 $cont = explode( '|', $params['continue'] );
220 $this->dieContinueUsageIf( count( $cont ) != 2 );
221 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
222 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
223 $continueId = (int)$cont[1];
224 $this->dieContinueUsageIf( $continueId != $cont[1] );
225 $this->addWhere( "rev_timestamp $op $continueTimestamp OR " .
226 "(rev_timestamp = $continueTimestamp AND " .
227 "rev_id $op= $continueId)"
228 );
229 }
230
231 // Convert startid/endid to timestamps (T163532)
232 $revids = [];
233 if ( $params['startid'] !== null ) {
234 $revids[] = (int)$params['startid'];
235 }
236 if ( $params['endid'] !== null ) {
237 $revids[] = (int)$params['endid'];
238 }
239 if ( $revids ) {
240 $db = $this->getDB();
241 $sql = $db->unionQueries( [
242 $db->selectSQLText(
243 'revision',
244 [ 'id' => 'rev_id', 'ts' => 'rev_timestamp' ],
245 [ 'rev_id' => $revids ],
246 __METHOD__
247 ),
248 $db->selectSQLText(
249 'archive',
250 [ 'id' => 'ar_rev_id', 'ts' => 'ar_timestamp' ],
251 [ 'ar_rev_id' => $revids ],
252 __METHOD__
253 ),
254 ], false );
255 $res = $db->query( $sql, __METHOD__ );
256 foreach ( $res as $row ) {
257 if ( (int)$row->id === (int)$params['startid'] ) {
258 $params['start'] = $row->ts;
259 }
260 if ( (int)$row->id === (int)$params['endid'] ) {
261 $params['end'] = $row->ts;
262 }
263 }
264 if ( $params['startid'] !== null && $params['start'] === null ) {
265 $p = $this->encodeParamName( 'startid' );
266 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
267 }
268 if ( $params['endid'] !== null && $params['end'] === null ) {
269 $p = $this->encodeParamName( 'endid' );
270 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
271 }
272
273 if ( $params['start'] !== null ) {
274 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
275 $ts = $db->addQuotes( $db->timestampOrNull( $params['start'] ) );
276 if ( $params['startid'] !== null ) {
277 $this->addWhere( "rev_timestamp $op $ts OR "
278 . "rev_timestamp = $ts AND rev_id $op= " . intval( $params['startid'] ) );
279 } else {
280 $this->addWhere( "rev_timestamp $op= $ts" );
281 }
282 }
283 if ( $params['end'] !== null ) {
284 $op = ( $params['dir'] === 'newer' ? '<' : '>' ); // Yes, opposite of the above
285 $ts = $db->addQuotes( $db->timestampOrNull( $params['end'] ) );
286 if ( $params['endid'] !== null ) {
287 $this->addWhere( "rev_timestamp $op $ts OR "
288 . "rev_timestamp = $ts AND rev_id $op= " . intval( $params['endid'] ) );
289 } else {
290 $this->addWhere( "rev_timestamp $op= $ts" );
291 }
292 }
293 } else {
294 $this->addTimestampWhereRange( 'rev_timestamp', $params['dir'],
295 $params['start'], $params['end'] );
296 }
297
298 $sort = ( $params['dir'] === 'newer' ? '' : 'DESC' );
299 $this->addOption( 'ORDER BY', [ "rev_timestamp $sort", "rev_id $sort" ] );
300
301 // There is only one ID, use it
302 $ids = array_keys( $pageSet->getGoodTitles() );
303 $this->addWhereFld( 'rev_page', reset( $ids ) );
304
305 if ( $params['user'] !== null ) {
306 $actorQuery = ActorMigration::newMigration()
307 ->getWhere( $db, 'rev_user', User::newFromName( $params['user'], false ) );
308 $this->addTables( $actorQuery['tables'] );
309 $this->addJoinConds( $actorQuery['joins'] );
310 $this->addWhere( $actorQuery['conds'] );
311 } elseif ( $params['excludeuser'] !== null ) {
312 $actorQuery = ActorMigration::newMigration()
313 ->getWhere( $db, 'rev_user', User::newFromName( $params['excludeuser'], false ) );
314 $this->addTables( $actorQuery['tables'] );
315 $this->addJoinConds( $actorQuery['joins'] );
316 $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
317 }
318 if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
319 // Paranoia: avoid brute force searches (T19342)
320 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
321 $bitmask = RevisionRecord::DELETED_USER;
322 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
323 $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
324 } else {
325 $bitmask = 0;
326 }
327 if ( $bitmask ) {
328 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
329 }
330 }
331 } elseif ( $revCount > 0 ) {
332 // Always targets the PRIMARY index
333
334 $revs = $pageSet->getLiveRevisionIDs();
335
336 // Get all revision IDs
337 $this->addWhereFld( 'rev_id', array_keys( $revs ) );
338
339 if ( $params['continue'] !== null ) {
340 $this->addWhere( 'rev_id >= ' . intval( $params['continue'] ) );
341 }
342 $this->addOption( 'ORDER BY', 'rev_id' );
343 } elseif ( $pageCount > 0 ) {
344 // Always targets the rev_page_id index
345
346 $titles = $pageSet->getGoodTitles();
347
348 // When working in multi-page non-enumeration mode,
349 // limit to the latest revision only
350 $this->addWhere( 'page_latest=rev_id' );
351
352 // Get all page IDs
353 $this->addWhereFld( 'page_id', array_keys( $titles ) );
354 // Every time someone relies on equality propagation, god kills a kitten :)
355 $this->addWhereFld( 'rev_page', array_keys( $titles ) );
356
357 if ( $params['continue'] !== null ) {
358 $cont = explode( '|', $params['continue'] );
359 $this->dieContinueUsageIf( count( $cont ) != 2 );
360 $pageid = intval( $cont[0] );
361 $revid = intval( $cont[1] );
362 $this->addWhere(
363 "rev_page > $pageid OR " .
364 "(rev_page = $pageid AND " .
365 "rev_id >= $revid)"
366 );
367 }
368 $this->addOption( 'ORDER BY', [
369 'rev_page',
370 'rev_id'
371 ] );
372 } else {
373 ApiBase::dieDebug( __METHOD__, 'param validation?' );
374 }
375
376 $this->addOption( 'LIMIT', $this->limit + 1 );
377
378 $count = 0;
379 $generated = [];
380 $hookData = [];
381 $res = $this->select( __METHOD__, [], $hookData );
382
383 foreach ( $res as $row ) {
384 if ( ++$count > $this->limit ) {
385 // We've reached the one extra which shows that there are
386 // additional pages to be had. Stop here...
387 if ( $enumRevMode ) {
388 $this->setContinueEnumParameter( 'continue',
389 $row->rev_timestamp . '|' . intval( $row->rev_id ) );
390 } elseif ( $revCount > 0 ) {
391 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
392 } else {
393 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
394 '|' . intval( $row->rev_id ) );
395 }
396 break;
397 }
398
399 if ( $resultPageSet !== null ) {
400 $generated[] = $row->rev_id;
401 } else {
402 $revision = $revisionStore->newRevisionFromRow( $row );
403 $rev = $this->extractRevisionInfo( $revision, $row );
404
405 if ( $this->token !== null ) {
406 $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
407 $revisionCompat = new Revision( $revision );
409 foreach ( $this->token as $t ) {
410 $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revisionCompat );
411 if ( $val === false ) {
412 $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
413 } else {
414 $rev[$t . 'token'] = $val;
415 }
416 }
417 }
418
419 $fit = $this->processRow( $row, $rev, $hookData ) &&
420 $this->addPageSubItem( $row->rev_page, $rev, 'rev' );
421 if ( !$fit ) {
422 if ( $enumRevMode ) {
423 $this->setContinueEnumParameter( 'continue',
424 $row->rev_timestamp . '|' . intval( $row->rev_id ) );
425 } elseif ( $revCount > 0 ) {
426 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
427 } else {
428 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
429 '|' . intval( $row->rev_id ) );
430 }
431 break;
432 }
433 }
434 }
435
436 if ( $resultPageSet !== null ) {
437 $resultPageSet->populateFromRevisionIDs( $generated );
438 }
439 }
440
441 public function getCacheMode( $params ) {
442 if ( isset( $params['token'] ) ) {
443 return 'private';
444 }
445 return parent::getCacheMode( $params );
446 }
447
448 public function getAllowedParams() {
449 $ret = parent::getAllowedParams() + [
450 'startid' => [
451 ApiBase::PARAM_TYPE => 'integer',
452 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
453 ],
454 'endid' => [
455 ApiBase::PARAM_TYPE => 'integer',
456 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
457 ],
458 'start' => [
459 ApiBase::PARAM_TYPE => 'timestamp',
460 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
461 ],
462 'end' => [
463 ApiBase::PARAM_TYPE => 'timestamp',
464 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
465 ],
466 'dir' => [
467 ApiBase::PARAM_DFLT => 'older',
469 'newer',
470 'older'
471 ],
472 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
473 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
474 ],
475 'user' => [
476 ApiBase::PARAM_TYPE => 'user',
477 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
478 ],
479 'excludeuser' => [
480 ApiBase::PARAM_TYPE => 'user',
481 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
482 ],
483 'tag' => null,
484 'token' => [
486 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
488 ],
489 'continue' => [
490 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
491 ],
492 ];
493
494 $ret['limit'][ApiBase::PARAM_HELP_MSG_INFO] = [ [ 'singlepageonly' ] ];
495
496 return $ret;
497 }
498
499 protected function getExamplesMessages() {
500 return [
501 'action=query&prop=revisions&titles=API|Main%20Page&' .
502 'rvslots=*&rvprop=timestamp|user|comment|content'
503 => 'apihelp-query+revisions-example-content',
504 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
505 'rvprop=timestamp|user|comment'
506 => 'apihelp-query+revisions-example-last5',
507 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
508 'rvprop=timestamp|user|comment&rvdir=newer'
509 => 'apihelp-query+revisions-example-first5',
510 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
511 'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
512 => 'apihelp-query+revisions-example-first5-after',
513 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
514 'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
515 => 'apihelp-query+revisions-example-first5-not-localhost',
516 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
517 'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
518 => 'apihelp-query+revisions-example-first5-user',
519 ];
520 }
521
522 public function getHelpUrls() {
523 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions';
524 }
525}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
int $wgChangeTagsSchemaMigrationStage
change_tag table schema migration stage.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition ApiBase.php:547
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:105
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition ApiBase.php:884
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1987
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2155
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition ApiBase.php:2167
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition ApiBase.php:141
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:770
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:939
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:124
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1906
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition ApiBase.php:2052
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition ApiBase.php:587
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
This class contains a list of pages that the client has requested.
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
getDB()
Get the Query database connection (read-only)
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
addWhere( $value)
Add a set of WHERE clauses to the internal array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
getPageSet()
Get the PageSet object to work on.
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
A base class for functions common to producing a list of revisions.
parseParameters( $params)
Parse the parameters into the various instance fields.
extractRevisionInfo(RevisionRecord $revision, $row)
Extract information from the RevisionRecord.
A query action to enumerate revisions of a given page, or show top revisions of multiple pages.
__construct(ApiQuery $query, $moduleName)
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getHelpUrls()
Return links to more detailed help pages about the module.
run(ApiPageSet $resultPageSet=null)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
static getRollbackToken( $pageid, $title, $rev)
getExamplesMessages()
Returns usage examples for this module.
This is the main query class.
Definition ApiQuery.php:36
MediaWikiServices is the service locator for the application scope of MediaWiki.
Page revision base class.
Exception representing a failure to look up a row from a name table.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like select() and insert() are usually more convenient. They take care of things like table prefixes and escaping for you. If you really need to make your own SQL
$res
Definition database.txt:21
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
const MIGRATION_WRITE_BOTH
Definition Defines.php:316
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 '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). '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:1305
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
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:2055
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:2054
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:1656
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:1818
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
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:37
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
$sort
$params