MediaWiki  master
ApiQueryDeletedrevs.php
Go to the documentation of this file.
1 <?php
25 
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'dr' );
36  }
37 
38  public function execute() {
39  // Before doing anything at all, let's check permissions
40  $this->checkUserRightsAny( 'deletedhistory' );
41 
42  $this->addDeprecation( 'apiwarn-deprecation-deletedrevs', 'action=query&list=deletedrevs' );
43 
44  $user = $this->getUser();
45  $db = $this->getDB();
46  $commentStore = CommentStore::getStore();
47  $params = $this->extractRequestParams( false );
48  $prop = array_flip( $params['prop'] );
49  $fld_parentid = isset( $prop['parentid'] );
50  $fld_revid = isset( $prop['revid'] );
51  $fld_user = isset( $prop['user'] );
52  $fld_userid = isset( $prop['userid'] );
53  $fld_comment = isset( $prop['comment'] );
54  $fld_parsedcomment = isset( $prop['parsedcomment'] );
55  $fld_minor = isset( $prop['minor'] );
56  $fld_len = isset( $prop['len'] );
57  $fld_sha1 = isset( $prop['sha1'] );
58  $fld_content = isset( $prop['content'] );
59  $fld_token = isset( $prop['token'] );
60  $fld_tags = isset( $prop['tags'] );
61 
62  if ( isset( $prop['token'] ) ) {
63  $p = $this->getModulePrefix();
64  }
65 
66  // If we're in a mode that breaks the same-origin policy, no tokens can
67  // be obtained
68  if ( $this->lacksSameOriginSecurity() ) {
69  $fld_token = false;
70  }
71 
72  // If user can't undelete, no tokens
73  if ( !$user->isAllowed( 'undelete' ) ) {
74  $fld_token = false;
75  }
76 
77  $result = $this->getResult();
78  $pageSet = $this->getPageSet();
79  $titles = $pageSet->getTitles();
80 
81  // This module operates in three modes:
82  // 'revs': List deleted revs for certain titles (1)
83  // 'user': List deleted revs by a certain user (2)
84  // 'all': List all deleted revs in NS (3)
85  $mode = 'all';
86  if ( count( $titles ) > 0 ) {
87  $mode = 'revs';
88  } elseif ( !is_null( $params['user'] ) ) {
89  $mode = 'user';
90  }
91 
92  if ( $mode == 'revs' || $mode == 'user' ) {
93  // Ignore namespace and unique due to inability to know whether they were purposely set
94  foreach ( [ 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ] as $p ) {
95  if ( !is_null( $params[$p] ) ) {
96  $this->dieWithError( [ 'apierror-deletedrevs-param-not-1-2', $p ], 'badparams' );
97  }
98  }
99  } else {
100  foreach ( [ 'start', 'end' ] as $p ) {
101  if ( !is_null( $params[$p] ) ) {
102  $this->dieWithError( [ 'apierror-deletedrevs-param-not-3', $p ], 'badparams' );
103  }
104  }
105  }
106 
107  if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
108  $this->dieWithError( 'user and excludeuser cannot be used together', 'badparams' );
109  }
110 
111  $this->addTables( 'archive' );
112  $this->addFields( [ 'ar_title', 'ar_namespace', 'ar_timestamp', 'ar_deleted', 'ar_id' ] );
113 
114  $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
115  $this->addFieldsIf( 'ar_rev_id', $fld_revid );
116  if ( $fld_user || $fld_userid ) {
117  $actorQuery = ActorMigration::newMigration()->getJoin( 'ar_user' );
118  $this->addTables( $actorQuery['tables'] );
119  $this->addFields( $actorQuery['fields'] );
120  $this->addJoinConds( $actorQuery['joins'] );
121  }
122  $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
123  $this->addFieldsIf( 'ar_len', $fld_len );
124  $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
125 
126  if ( $fld_comment || $fld_parsedcomment ) {
127  $commentQuery = $commentStore->getJoin( 'ar_comment' );
128  $this->addTables( $commentQuery['tables'] );
129  $this->addFields( $commentQuery['fields'] );
130  $this->addJoinConds( $commentQuery['joins'] );
131  }
132 
133  if ( $fld_tags ) {
134  $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'archive' ) ] );
135  }
136 
137  if ( !is_null( $params['tag'] ) ) {
138  $this->addTables( 'change_tag' );
139  $this->addJoinConds(
140  [ 'change_tag' => [ 'JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
141  );
142  $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
143  try {
144  $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
145  } catch ( NameTableAccessException $exception ) {
146  // Return nothing.
147  $this->addWhere( '1=0' );
148  }
149  }
150 
151  if ( $fld_content ) {
152  $this->addTables( 'text' );
153  $this->addJoinConds(
154  [ 'text' => [ 'LEFT JOIN', [ 'ar_text_id=old_id' ] ] ]
155  );
156  $this->addFields( [ 'ar_text_id', 'old_text', 'old_flags' ] );
157 
158  // This also means stricter restrictions
159  $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
160  }
161  // Check limits
162  $userMax = $fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1;
163  $botMax = $fld_content ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2;
164 
165  $limit = $params['limit'];
166 
167  if ( $limit == 'max' ) {
168  $limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
169  $this->getResult()->addParsedLimit( $this->getModuleName(), $limit );
170  }
171 
172  $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
173 
174  if ( $fld_token ) {
175  // Undelete tokens are identical for all pages, so we cache one here
176  $token = $user->getEditToken( '', $this->getMain()->getRequest() );
177  }
178 
179  $dir = $params['dir'];
180 
181  // We need a custom WHERE clause that matches all titles.
182  if ( $mode == 'revs' ) {
183  $lb = new LinkBatch( $titles );
184  $where = $lb->constructSet( 'ar', $db );
185  $this->addWhere( $where );
186  } elseif ( $mode == 'all' ) {
187  $this->addWhereFld( 'ar_namespace', $params['namespace'] );
188 
189  $from = $params['from'] === null
190  ? null
191  : $this->titlePartToKey( $params['from'], $params['namespace'] );
192  $to = $params['to'] === null
193  ? null
194  : $this->titlePartToKey( $params['to'], $params['namespace'] );
195  $this->addWhereRange( 'ar_title', $dir, $from, $to );
196 
197  if ( isset( $params['prefix'] ) ) {
198  $this->addWhere( 'ar_title' . $db->buildLike(
199  $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
200  $db->anyString() ) );
201  }
202  }
203 
204  if ( !is_null( $params['user'] ) ) {
205  // Don't query by user ID here, it might be able to use the ar_usertext_timestamp index.
206  $actorQuery = ActorMigration::newMigration()
207  ->getWhere( $db, 'ar_user', User::newFromName( $params['user'], false ), false );
208  $this->addTables( $actorQuery['tables'] );
209  $this->addJoinConds( $actorQuery['joins'] );
210  $this->addWhere( $actorQuery['conds'] );
211  } elseif ( !is_null( $params['excludeuser'] ) ) {
212  // Here there's no chance of using ar_usertext_timestamp.
213  $actorQuery = ActorMigration::newMigration()
214  ->getWhere( $db, 'ar_user', User::newFromName( $params['excludeuser'], false ) );
215  $this->addTables( $actorQuery['tables'] );
216  $this->addJoinConds( $actorQuery['joins'] );
217  $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
218  }
219 
220  if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
221  // Paranoia: avoid brute force searches (T19342)
222  // (shouldn't be able to get here without 'deletedhistory', but
223  // check it again just in case)
224  if ( !$user->isAllowed( 'deletedhistory' ) ) {
225  $bitmask = Revision::DELETED_USER;
226  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
228  } else {
229  $bitmask = 0;
230  }
231  if ( $bitmask ) {
232  $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
233  }
234  }
235 
236  if ( !is_null( $params['continue'] ) ) {
237  $cont = explode( '|', $params['continue'] );
238  $op = ( $dir == 'newer' ? '>' : '<' );
239  if ( $mode == 'all' || $mode == 'revs' ) {
240  $this->dieContinueUsageIf( count( $cont ) != 4 );
241  $ns = (int)$cont[0];
242  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
243  $title = $db->addQuotes( $cont[1] );
244  $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
245  $ar_id = (int)$cont[3];
246  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
247  $this->addWhere( "ar_namespace $op $ns OR " .
248  "(ar_namespace = $ns AND " .
249  "(ar_title $op $title OR " .
250  "(ar_title = $title AND " .
251  "(ar_timestamp $op $ts OR " .
252  "(ar_timestamp = $ts AND " .
253  "ar_id $op= $ar_id)))))" );
254  } else {
255  $this->dieContinueUsageIf( count( $cont ) != 2 );
256  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
257  $ar_id = (int)$cont[1];
258  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
259  $this->addWhere( "ar_timestamp $op $ts OR " .
260  "(ar_timestamp = $ts AND " .
261  "ar_id $op= $ar_id)" );
262  }
263  }
264 
265  $this->addOption( 'LIMIT', $limit + 1 );
266  if ( $mode == 'all' ) {
267  if ( $params['unique'] ) {
268  // @todo Does this work on non-MySQL?
269  $this->addOption( 'GROUP BY', 'ar_title' );
270  } else {
271  $sort = ( $dir == 'newer' ? '' : ' DESC' );
272  $this->addOption( 'ORDER BY', [
273  'ar_title' . $sort,
274  'ar_timestamp' . $sort,
275  'ar_id' . $sort,
276  ] );
277  }
278  } else {
279  if ( $mode == 'revs' ) {
280  // Sort by ns and title in the same order as timestamp for efficiency
281  $this->addWhereRange( 'ar_namespace', $dir, null, null );
282  $this->addWhereRange( 'ar_title', $dir, null, null );
283  }
284  $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
285  // Include in ORDER BY for uniqueness
286  $this->addWhereRange( 'ar_id', $dir, null, null );
287  }
288  $res = $this->select( __METHOD__ );
289  $pageMap = []; // Maps ns&title to (fake) pageid
290  $count = 0;
291  $newPageID = 0;
292  foreach ( $res as $row ) {
293  if ( ++$count > $limit ) {
294  // We've had enough
295  if ( $mode == 'all' || $mode == 'revs' ) {
296  $this->setContinueEnumParameter( 'continue',
297  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
298  );
299  } else {
300  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
301  }
302  break;
303  }
304 
305  $rev = [];
306  $anyHidden = false;
307 
308  $rev['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ar_timestamp );
309  if ( $fld_revid ) {
310  $rev['revid'] = (int)$row->ar_rev_id;
311  }
312  if ( $fld_parentid && !is_null( $row->ar_parent_id ) ) {
313  $rev['parentid'] = (int)$row->ar_parent_id;
314  }
315  if ( $fld_user || $fld_userid ) {
316  if ( $row->ar_deleted & Revision::DELETED_USER ) {
317  $rev['userhidden'] = true;
318  $anyHidden = true;
319  }
320  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_USER, $user ) ) {
321  if ( $fld_user ) {
322  $rev['user'] = $row->ar_user_text;
323  }
324  if ( $fld_userid ) {
325  $rev['userid'] = (int)$row->ar_user;
326  }
327  }
328  }
329 
330  if ( $fld_comment || $fld_parsedcomment ) {
331  if ( $row->ar_deleted & Revision::DELETED_COMMENT ) {
332  $rev['commenthidden'] = true;
333  $anyHidden = true;
334  }
335  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_COMMENT, $user ) ) {
336  $comment = $commentStore->getComment( 'ar_comment', $row )->text;
337  if ( $fld_comment ) {
338  $rev['comment'] = $comment;
339  }
340  if ( $fld_parsedcomment ) {
341  $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
342  $rev['parsedcomment'] = Linker::formatComment( $comment, $title );
343  }
344  }
345  }
346 
347  if ( $fld_minor ) {
348  $rev['minor'] = $row->ar_minor_edit == 1;
349  }
350  if ( $fld_len ) {
351  $rev['len'] = $row->ar_len;
352  }
353  if ( $fld_sha1 ) {
354  if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
355  $rev['sha1hidden'] = true;
356  $anyHidden = true;
357  }
358  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
359  if ( $row->ar_sha1 != '' ) {
360  $rev['sha1'] = Wikimedia\base_convert( $row->ar_sha1, 36, 16, 40 );
361  } else {
362  $rev['sha1'] = '';
363  }
364  }
365  }
366  if ( $fld_content ) {
367  if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
368  $rev['texthidden'] = true;
369  $anyHidden = true;
370  }
371  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
373  }
374  }
375 
376  if ( $fld_tags ) {
377  if ( $row->ts_tags ) {
378  $tags = explode( ',', $row->ts_tags );
379  ApiResult::setIndexedTagName( $tags, 'tag' );
380  $rev['tags'] = $tags;
381  } else {
382  $rev['tags'] = [];
383  }
384  }
385 
386  if ( $anyHidden && ( $row->ar_deleted & Revision::DELETED_RESTRICTED ) ) {
387  $rev['suppressed'] = true;
388  }
389 
390  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
391  $pageID = $newPageID++;
392  $pageMap[$row->ar_namespace][$row->ar_title] = $pageID;
393  $a['revisions'] = [ $rev ];
394  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
395  $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
397  if ( $fld_token ) {
398  $a['token'] = $token;
399  }
400  $fit = $result->addValue( [ 'query', $this->getModuleName() ], $pageID, $a );
401  } else {
402  $pageID = $pageMap[$row->ar_namespace][$row->ar_title];
403  $fit = $result->addValue(
404  [ 'query', $this->getModuleName(), $pageID, 'revisions' ],
405  null, $rev );
406  }
407  if ( !$fit ) {
408  if ( $mode == 'all' || $mode == 'revs' ) {
409  $this->setContinueEnumParameter( 'continue',
410  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
411  );
412  } else {
413  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
414  }
415  break;
416  }
417  }
418  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
419  }
420 
421  public function isDeprecated() {
422  return true;
423  }
424 
425  public function getAllowedParams() {
426  return [
427  'start' => [
428  ApiBase::PARAM_TYPE => 'timestamp',
429  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
430  ],
431  'end' => [
432  ApiBase::PARAM_TYPE => 'timestamp',
433  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
434  ],
435  'dir' => [
437  'newer',
438  'older'
439  ],
440  ApiBase::PARAM_DFLT => 'older',
441  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
442  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 3 ] ],
443  ],
444  'from' => [
445  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
446  ],
447  'to' => [
448  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
449  ],
450  'prefix' => [
451  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
452  ],
453  'unique' => [
454  ApiBase::PARAM_DFLT => false,
455  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
456  ],
457  'namespace' => [
458  ApiBase::PARAM_TYPE => 'namespace',
460  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
461  ],
462  'tag' => null,
463  'user' => [
464  ApiBase::PARAM_TYPE => 'user'
465  ],
466  'excludeuser' => [
467  ApiBase::PARAM_TYPE => 'user'
468  ],
469  'prop' => [
470  ApiBase::PARAM_DFLT => 'user|comment',
472  'revid',
473  'parentid',
474  'user',
475  'userid',
476  'comment',
477  'parsedcomment',
478  'minor',
479  'len',
480  'sha1',
481  'content',
482  'token',
483  'tags'
484  ],
486  ],
487  'limit' => [
488  ApiBase::PARAM_DFLT => 10,
489  ApiBase::PARAM_TYPE => 'limit',
490  ApiBase::PARAM_MIN => 1,
493  ],
494  'continue' => [
495  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
496  ],
497  ];
498  }
499 
500  protected function getExamplesMessages() {
501  return [
502  'action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
503  'drprop=user|comment|content'
504  => 'apihelp-query+deletedrevs-example-mode1',
505  'action=query&list=deletedrevs&druser=Bob&drlimit=50'
506  => 'apihelp-query+deletedrevs-example-mode2',
507  'action=query&list=deletedrevs&drdir=newer&drlimit=50'
508  => 'apihelp-query+deletedrevs-example-mode3-main',
509  'action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
510  => 'apihelp-query+deletedrevs-example-mode3-talk',
511  ];
512  }
513 
514  public function getHelpUrls() {
515  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Deletedrevs';
516  }
517 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
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
getResult()
Get the result object.
Definition: ApiBase.php:639
const NS_MAIN
Definition: Defines.php:60
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
Definition: ApiBase.php:1941
validateLimit( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
Validate the value against the minimum and user/bot maximum limits.
Definition: ApiBase.php:1575
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
getMain()
Get the main module.
Definition: ApiBase.php:535
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
Exception representing a failure to look up a row from a name table.
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
This is a base class for all Query modules.
$sort
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:148
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition: ApiBase.php:567
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2008
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:760
getPageSet()
Get the PageSet object to work on.
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
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:478
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
static getRevisionText( $row, $prefix='old_', $wiki=false)
Get revision text associated with an old or archive row.
Definition: Revision.php:1046
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
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
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static newMigration()
Static constructor.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1160
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
static userCanBitfield( $bitfield, $field, User $user=null, Title $title=null)
Determine if the current user is allowed to view a particular field of this revision, if it&#39;s marked as deleted.
Definition: Revision.php:1242
$res
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2199
const LIMIT_SML2
Slow query, apihighlimits limit.
Definition: ApiBase.php:265
$params
const DELETED_RESTRICTED
Definition: Revision.php:49
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
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:519
addFields( $value)
Add a set of fields to select to the internal array.
__construct(ApiQuery $query, $moduleName)
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
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
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
const DELETED_TEXT
Definition: Revision.php:46
Query module to enumerate all deleted revisions.
const LIMIT_SML1
Slow query, standard limit.
Definition: ApiBase.php:263
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
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
const DELETED_USER
Definition: Revision.php:48
static getStore()
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:527
addWhere( $value)
Add a set of WHERE clauses to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const DELETED_COMMENT
Definition: Revision.php:47
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:594
static makeTagSummarySubquery( $tables)
Make the tag summary subquery based on the given tables and return it.
Definition: ChangeTags.php:797
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:2123
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction...
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.