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