MediaWiki  REL1_31
ApiQueryDeletedrevs.php
Go to the documentation of this file.
1 <?php
30 
31  public function __construct( ApiQuery $query, $moduleName ) {
32  parent::__construct( $query, $moduleName, 'dr' );
33  }
34 
35  public function execute() {
36  // Before doing anything at all, let's check permissions
37  $this->checkUserRightsAny( 'deletedhistory' );
38 
39  $this->addDeprecation( 'apiwarn-deprecation-deletedrevs', 'action=query&list=deletedrevs' );
40 
41  $user = $this->getUser();
42  $db = $this->getDB();
43  $commentStore = CommentStore::getStore();
44  $params = $this->extractRequestParams( false );
45  $prop = array_flip( $params['prop'] );
46  $fld_parentid = isset( $prop['parentid'] );
47  $fld_revid = isset( $prop['revid'] );
48  $fld_user = isset( $prop['user'] );
49  $fld_userid = isset( $prop['userid'] );
50  $fld_comment = isset( $prop['comment'] );
51  $fld_parsedcomment = isset( $prop['parsedcomment'] );
52  $fld_minor = isset( $prop['minor'] );
53  $fld_len = isset( $prop['len'] );
54  $fld_sha1 = isset( $prop['sha1'] );
55  $fld_content = isset( $prop['content'] );
56  $fld_token = isset( $prop['token'] );
57  $fld_tags = isset( $prop['tags'] );
58 
59  if ( isset( $prop['token'] ) ) {
60  $p = $this->getModulePrefix();
61  }
62 
63  // If we're in a mode that breaks the same-origin policy, no tokens can
64  // be obtained
65  if ( $this->lacksSameOriginSecurity() ) {
66  $fld_token = false;
67  }
68 
69  // If user can't undelete, no tokens
70  if ( !$user->isAllowed( 'undelete' ) ) {
71  $fld_token = false;
72  }
73 
74  $result = $this->getResult();
75  $pageSet = $this->getPageSet();
76  $titles = $pageSet->getTitles();
77 
78  // This module operates in three modes:
79  // 'revs': List deleted revs for certain titles (1)
80  // 'user': List deleted revs by a certain user (2)
81  // 'all': List all deleted revs in NS (3)
82  $mode = 'all';
83  if ( count( $titles ) > 0 ) {
84  $mode = 'revs';
85  } elseif ( !is_null( $params['user'] ) ) {
86  $mode = 'user';
87  }
88 
89  if ( $mode == 'revs' || $mode == 'user' ) {
90  // Ignore namespace and unique due to inability to know whether they were purposely set
91  foreach ( [ 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ] as $p ) {
92  if ( !is_null( $params[$p] ) ) {
93  $this->dieWithError( [ 'apierror-deletedrevs-param-not-1-2', $p ], 'badparams' );
94  }
95  }
96  } else {
97  foreach ( [ 'start', 'end' ] as $p ) {
98  if ( !is_null( $params[$p] ) ) {
99  $this->dieWithError( [ 'apierror-deletedrevs-param-not-3', $p ], 'badparams' );
100  }
101  }
102  }
103 
104  if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
105  $this->dieWithError( 'user and excludeuser cannot be used together', 'badparams' );
106  }
107 
108  $this->addTables( 'archive' );
109  $this->addFields( [ 'ar_title', 'ar_namespace', 'ar_timestamp', 'ar_deleted', 'ar_id' ] );
110 
111  $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
112  $this->addFieldsIf( 'ar_rev_id', $fld_revid );
113  if ( $fld_user || $fld_userid ) {
114  $actorQuery = ActorMigration::newMigration()->getJoin( 'ar_user' );
115  $this->addTables( $actorQuery['tables'] );
116  $this->addFields( $actorQuery['fields'] );
117  $this->addJoinConds( $actorQuery['joins'] );
118  }
119  $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
120  $this->addFieldsIf( 'ar_len', $fld_len );
121  $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
122 
123  if ( $fld_comment || $fld_parsedcomment ) {
124  $commentQuery = $commentStore->getJoin( 'ar_comment' );
125  $this->addTables( $commentQuery['tables'] );
126  $this->addFields( $commentQuery['fields'] );
127  $this->addJoinConds( $commentQuery['joins'] );
128  }
129 
130  if ( $fld_tags ) {
131  $this->addTables( 'tag_summary' );
132  $this->addJoinConds(
133  [ 'tag_summary' => [ 'LEFT JOIN', [ 'ar_rev_id=ts_rev_id' ] ] ]
134  );
135  $this->addFields( 'ts_tags' );
136  }
137 
138  if ( !is_null( $params['tag'] ) ) {
139  $this->addTables( 'change_tag' );
140  $this->addJoinConds(
141  [ 'change_tag' => [ 'INNER JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
142  );
143  $this->addWhereFld( 'ct_tag', $params['tag'] );
144  }
145 
146  if ( $fld_content ) {
147  $this->addTables( 'text' );
148  $this->addJoinConds(
149  [ 'text' => [ 'LEFT JOIN', [ 'ar_text_id=old_id' ] ] ]
150  );
151  $this->addFields( [ 'ar_text_id', 'old_text', 'old_flags' ] );
152 
153  // This also means stricter restrictions
154  $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
155  }
156  // Check limits
157  $userMax = $fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1;
158  $botMax = $fld_content ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2;
159 
160  $limit = $params['limit'];
161 
162  if ( $limit == 'max' ) {
163  $limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
164  $this->getResult()->addParsedLimit( $this->getModuleName(), $limit );
165  }
166 
167  $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
168 
169  if ( $fld_token ) {
170  // Undelete tokens are identical for all pages, so we cache one here
171  $token = $user->getEditToken( '', $this->getMain()->getRequest() );
172  }
173 
174  $dir = $params['dir'];
175 
176  // We need a custom WHERE clause that matches all titles.
177  if ( $mode == 'revs' ) {
178  $lb = new LinkBatch( $titles );
179  $where = $lb->constructSet( 'ar', $db );
180  $this->addWhere( $where );
181  } elseif ( $mode == 'all' ) {
182  $this->addWhereFld( 'ar_namespace', $params['namespace'] );
183 
184  $from = $params['from'] === null
185  ? null
186  : $this->titlePartToKey( $params['from'], $params['namespace'] );
187  $to = $params['to'] === null
188  ? null
189  : $this->titlePartToKey( $params['to'], $params['namespace'] );
190  $this->addWhereRange( 'ar_title', $dir, $from, $to );
191 
192  if ( isset( $params['prefix'] ) ) {
193  $this->addWhere( 'ar_title' . $db->buildLike(
194  $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
195  $db->anyString() ) );
196  }
197  }
198 
199  if ( !is_null( $params['user'] ) ) {
200  // Don't query by user ID here, it might be able to use the ar_usertext_timestamp index.
201  $actorQuery = ActorMigration::newMigration()
202  ->getWhere( $db, 'ar_user', User::newFromName( $params['user'], false ), false );
203  $this->addTables( $actorQuery['tables'] );
204  $this->addJoinConds( $actorQuery['joins'] );
205  $this->addWhere( $actorQuery['conds'] );
206  } elseif ( !is_null( $params['excludeuser'] ) ) {
207  // Here there's no chance of using ar_usertext_timestamp.
208  $actorQuery = ActorMigration::newMigration()
209  ->getWhere( $db, 'ar_user', User::newFromName( $params['excludeuser'], false ) );
210  $this->addTables( $actorQuery['tables'] );
211  $this->addJoinConds( $actorQuery['joins'] );
212  $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
213  }
214 
215  if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
216  // Paranoia: avoid brute force searches (T19342)
217  // (shouldn't be able to get here without 'deletedhistory', but
218  // check it again just in case)
219  if ( !$user->isAllowed( 'deletedhistory' ) ) {
220  $bitmask = Revision::DELETED_USER;
221  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
223  } else {
224  $bitmask = 0;
225  }
226  if ( $bitmask ) {
227  $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
228  }
229  }
230 
231  if ( !is_null( $params['continue'] ) ) {
232  $cont = explode( '|', $params['continue'] );
233  $op = ( $dir == 'newer' ? '>' : '<' );
234  if ( $mode == 'all' || $mode == 'revs' ) {
235  $this->dieContinueUsageIf( count( $cont ) != 4 );
236  $ns = intval( $cont[0] );
237  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
238  $title = $db->addQuotes( $cont[1] );
239  $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
240  $ar_id = (int)$cont[3];
241  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
242  $this->addWhere( "ar_namespace $op $ns OR " .
243  "(ar_namespace = $ns AND " .
244  "(ar_title $op $title OR " .
245  "(ar_title = $title AND " .
246  "(ar_timestamp $op $ts OR " .
247  "(ar_timestamp = $ts AND " .
248  "ar_id $op= $ar_id)))))" );
249  } else {
250  $this->dieContinueUsageIf( count( $cont ) != 2 );
251  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
252  $ar_id = (int)$cont[1];
253  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
254  $this->addWhere( "ar_timestamp $op $ts OR " .
255  "(ar_timestamp = $ts AND " .
256  "ar_id $op= $ar_id)" );
257  }
258  }
259 
260  $this->addOption( 'LIMIT', $limit + 1 );
261  if ( $mode == 'all' ) {
262  if ( $params['unique'] ) {
263  // @todo Does this work on non-MySQL?
264  $this->addOption( 'GROUP BY', 'ar_title' );
265  } else {
266  $sort = ( $dir == 'newer' ? '' : ' DESC' );
267  $this->addOption( 'ORDER BY', [
268  'ar_title' . $sort,
269  'ar_timestamp' . $sort,
270  'ar_id' . $sort,
271  ] );
272  }
273  } else {
274  if ( $mode == 'revs' ) {
275  // Sort by ns and title in the same order as timestamp for efficiency
276  $this->addWhereRange( 'ar_namespace', $dir, null, null );
277  $this->addWhereRange( 'ar_title', $dir, null, null );
278  }
279  $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
280  // Include in ORDER BY for uniqueness
281  $this->addWhereRange( 'ar_id', $dir, null, null );
282  }
283  $res = $this->select( __METHOD__ );
284  $pageMap = []; // Maps ns&title to (fake) pageid
285  $count = 0;
286  $newPageID = 0;
287  foreach ( $res as $row ) {
288  if ( ++$count > $limit ) {
289  // We've had enough
290  if ( $mode == 'all' || $mode == 'revs' ) {
291  $this->setContinueEnumParameter( 'continue',
292  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
293  );
294  } else {
295  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
296  }
297  break;
298  }
299 
300  $rev = [];
301  $anyHidden = false;
302 
303  $rev['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ar_timestamp );
304  if ( $fld_revid ) {
305  $rev['revid'] = intval( $row->ar_rev_id );
306  }
307  if ( $fld_parentid && !is_null( $row->ar_parent_id ) ) {
308  $rev['parentid'] = intval( $row->ar_parent_id );
309  }
310  if ( $fld_user || $fld_userid ) {
311  if ( $row->ar_deleted & Revision::DELETED_USER ) {
312  $rev['userhidden'] = true;
313  $anyHidden = true;
314  }
315  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_USER, $user ) ) {
316  if ( $fld_user ) {
317  $rev['user'] = $row->ar_user_text;
318  }
319  if ( $fld_userid ) {
320  $rev['userid'] = (int)$row->ar_user;
321  }
322  }
323  }
324 
325  if ( $fld_comment || $fld_parsedcomment ) {
326  if ( $row->ar_deleted & Revision::DELETED_COMMENT ) {
327  $rev['commenthidden'] = true;
328  $anyHidden = true;
329  }
330  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_COMMENT, $user ) ) {
331  $comment = $commentStore->getComment( 'ar_comment', $row )->text;
332  if ( $fld_comment ) {
333  $rev['comment'] = $comment;
334  }
335  if ( $fld_parsedcomment ) {
336  $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
337  $rev['parsedcomment'] = Linker::formatComment( $comment, $title );
338  }
339  }
340  }
341 
342  if ( $fld_minor ) {
343  $rev['minor'] = $row->ar_minor_edit == 1;
344  }
345  if ( $fld_len ) {
346  $rev['len'] = $row->ar_len;
347  }
348  if ( $fld_sha1 ) {
349  if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
350  $rev['sha1hidden'] = true;
351  $anyHidden = true;
352  }
353  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
354  if ( $row->ar_sha1 != '' ) {
355  $rev['sha1'] = Wikimedia\base_convert( $row->ar_sha1, 36, 16, 40 );
356  } else {
357  $rev['sha1'] = '';
358  }
359  }
360  }
361  if ( $fld_content ) {
362  if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
363  $rev['texthidden'] = true;
364  $anyHidden = true;
365  }
366  if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
368  }
369  }
370 
371  if ( $fld_tags ) {
372  if ( $row->ts_tags ) {
373  $tags = explode( ',', $row->ts_tags );
374  ApiResult::setIndexedTagName( $tags, 'tag' );
375  $rev['tags'] = $tags;
376  } else {
377  $rev['tags'] = [];
378  }
379  }
380 
381  if ( $anyHidden && ( $row->ar_deleted & Revision::DELETED_RESTRICTED ) ) {
382  $rev['suppressed'] = true;
383  }
384 
385  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
386  $pageID = $newPageID++;
387  $pageMap[$row->ar_namespace][$row->ar_title] = $pageID;
388  $a['revisions'] = [ $rev ];
389  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
390  $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
392  if ( $fld_token ) {
393  $a['token'] = $token;
394  }
395  $fit = $result->addValue( [ 'query', $this->getModuleName() ], $pageID, $a );
396  } else {
397  $pageID = $pageMap[$row->ar_namespace][$row->ar_title];
398  $fit = $result->addValue(
399  [ 'query', $this->getModuleName(), $pageID, 'revisions' ],
400  null, $rev );
401  }
402  if ( !$fit ) {
403  if ( $mode == 'all' || $mode == 'revs' ) {
404  $this->setContinueEnumParameter( 'continue',
405  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
406  );
407  } else {
408  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
409  }
410  break;
411  }
412  }
413  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
414  }
415 
416  public function isDeprecated() {
417  return true;
418  }
419 
420  public function getAllowedParams() {
421  return [
422  'start' => [
423  ApiBase::PARAM_TYPE => 'timestamp',
424  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
425  ],
426  'end' => [
427  ApiBase::PARAM_TYPE => 'timestamp',
428  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
429  ],
430  'dir' => [
432  'newer',
433  'older'
434  ],
435  ApiBase::PARAM_DFLT => 'older',
436  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
437  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 3 ] ],
438  ],
439  'from' => [
440  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
441  ],
442  'to' => [
443  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
444  ],
445  'prefix' => [
446  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
447  ],
448  'unique' => [
449  ApiBase::PARAM_DFLT => false,
450  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
451  ],
452  'namespace' => [
453  ApiBase::PARAM_TYPE => 'namespace',
455  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
456  ],
457  'tag' => null,
458  'user' => [
459  ApiBase::PARAM_TYPE => 'user'
460  ],
461  'excludeuser' => [
462  ApiBase::PARAM_TYPE => 'user'
463  ],
464  'prop' => [
465  ApiBase::PARAM_DFLT => 'user|comment',
467  'revid',
468  'parentid',
469  'user',
470  'userid',
471  'comment',
472  'parsedcomment',
473  'minor',
474  'len',
475  'sha1',
476  'content',
477  'token',
478  'tags'
479  ],
481  ],
482  'limit' => [
483  ApiBase::PARAM_DFLT => 10,
484  ApiBase::PARAM_TYPE => 'limit',
485  ApiBase::PARAM_MIN => 1,
488  ],
489  'continue' => [
490  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
491  ],
492  ];
493  }
494 
495  protected function getExamplesMessages() {
496  return [
497  'action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
498  'drprop=user|comment|content'
499  => 'apihelp-query+deletedrevs-example-mode1',
500  'action=query&list=deletedrevs&druser=Bob&drlimit=50'
501  => 'apihelp-query+deletedrevs-example-mode2',
502  'action=query&list=deletedrevs&drdir=newer&drlimit=50'
503  => 'apihelp-query+deletedrevs-example-mode3-main',
504  'action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
505  => 'apihelp-query+deletedrevs-example-mode3-talk',
506  ];
507  }
508 
509  public function getHelpUrls() {
510  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Deletedrevs';
511  }
512 }
$user
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 account $user
Definition: hooks.txt:247
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:49
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:50
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:192
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
Revision\DELETED_COMMENT
const DELETED_COMMENT
Definition: Revision.php:48
Revision\userCanBitfield
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,...
Definition: Revision.php:1205
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiQueryBase\addTimestampWhereRange
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
Definition: ApiQueryBase.php:313
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiBase\checkUserRightsAny
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:2006
$params
$params
Definition: styleTest.css.php:40
Revision\getRevisionText
static getRevisionText( $row, $prefix='old_', $wiki=false)
Get revision text associated with an old or archive row.
Definition: Revision.php:1055
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
ApiQueryDeletedrevs\isDeprecated
isDeprecated()
Indicates whether this module is deprecated.
Definition: ApiQueryDeletedrevs.php:416
ApiQueryDeletedrevs\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryDeletedrevs.php:31
$res
$res
Definition: database.txt:21
ContextSource\getRequest
getRequest()
Definition: ContextSource.php:71
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:325
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. '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: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! 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:1993
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ApiBase\lacksSameOriginSecurity
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition: ApiBase.php:569
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
true
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:2006
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:206
php
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
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
ApiResult\setContentValue
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
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
$titles
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
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:33
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:234
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:350
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
$sort
$sort
Definition: profileinfo.php:317
ApiQueryBase\$where
$where
Definition: ApiQueryBase.php:35
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:529
ApiQueryBase\addWhereRange
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.
Definition: ApiQueryBase.php:278
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2066
ApiBase\addDeprecation
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
Definition: ApiBase.php:1833
ApiBase\LIMIT_SML2
const LIMIT_SML2
Slow query, apihighlimits limit.
Definition: ApiBase.php:240
ApiQueryDeletedrevs\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryDeletedrevs.php:35
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:181
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:260
ApiBase\PARAM_HELP_MSG_INFO
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:141
ApiQueryBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryBase.php:130
Linker\formatComment
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:1109
ApiQueryDeletedrevs\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryDeletedrevs.php:420
$rev
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:1777
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:236
ApiBase\validateLimit
validateLimit( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
Validate the value against the minimum and user/bot maximum limits.
Definition: ApiBase.php:1485
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
as
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:22
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:537
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:227
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:531
ApiQueryDeletedrevs\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryDeletedrevs.php:495
$query
null for the 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:1620
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
Definition: ApiQueryBase.php:545
CommentStore\getStore
static getStore()
Definition: CommentStore.php:130
ApiQueryDeletedrevs\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryDeletedrevs.php:509
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:47
ApiQueryDeletedrevs
Query module to enumerate all deleted revisions.
Definition: ApiQueryDeletedrevs.php:29
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:482
ApiBase\LIMIT_SML1
const LIMIT_SML1
Slow query, standard limit.
Definition: ApiBase.php:238