MediaWiki  master
ApiQueryAllDeletedRevisions.php
Go to the documentation of this file.
1 <?php
29 
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  parent::__construct( $query, $moduleName, 'adr' );
39  }
40 
45  protected function run( ApiPageSet $resultPageSet = null ) {
46  $user = $this->getUser();
47  $db = $this->getDB();
48  $params = $this->extractRequestParams( false );
49  $services = MediaWikiServices::getInstance();
50  $revisionStore = $services->getRevisionStore();
51 
52  $result = $this->getResult();
53 
54  // If the user wants no namespaces, they get no pages.
55  if ( $params['namespace'] === [] ) {
56  if ( $resultPageSet === null ) {
57  $result->addValue( 'query', $this->getModuleName(), [] );
58  }
59  return;
60  }
61 
62  // This module operates in two modes:
63  // 'user': List deleted revs by a certain user
64  // 'all': List all deleted revs in NS
65  $mode = 'all';
66  if ( !is_null( $params['user'] ) ) {
67  $mode = 'user';
68  }
69 
70  if ( $mode == 'user' ) {
71  foreach ( [ 'from', 'to', 'prefix', 'excludeuser' ] as $param ) {
72  if ( !is_null( $params[$param] ) ) {
73  $p = $this->getModulePrefix();
74  $this->dieWithError(
75  [ 'apierror-invalidparammix-cannotusewith', $p . $param, "{$p}user" ],
76  'invalidparammix'
77  );
78  }
79  }
80  } else {
81  foreach ( [ 'start', 'end' ] as $param ) {
82  if ( !is_null( $params[$param] ) ) {
83  $p = $this->getModulePrefix();
84  $this->dieWithError(
85  [ 'apierror-invalidparammix-mustusewith', $p . $param, "{$p}user" ],
86  'invalidparammix'
87  );
88  }
89  }
90  }
91 
92  // If we're generating titles only, we can use DISTINCT for a better
93  // query. But we can't do that in 'user' mode (wrong index), and we can
94  // only do it when sorting ASC (because MySQL apparently can't use an
95  // index backwards for grouping even though it can for ORDER BY, WTF?)
96  $dir = $params['dir'];
97  $optimizeGenerateTitles = false;
98  if ( $mode === 'all' && $params['generatetitles'] && $resultPageSet !== null ) {
99  if ( $dir === 'newer' ) {
100  $optimizeGenerateTitles = true;
101  } else {
102  $p = $this->getModulePrefix();
103  $this->addWarning( [ 'apiwarn-alldeletedrevisions-performance', $p ], 'performance' );
104  }
105  }
106 
107  if ( $resultPageSet === null ) {
108  $this->parseParameters( $params );
109  $arQuery = $revisionStore->getArchiveQueryInfo();
110  $this->addTables( $arQuery['tables'] );
111  $this->addJoinConds( $arQuery['joins'] );
112  $this->addFields( $arQuery['fields'] );
113  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
114  } else {
115  $this->limit = $this->getParameter( 'limit' ) ?: 10;
116  $this->addTables( 'archive' );
117  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
118  if ( $optimizeGenerateTitles ) {
119  $this->addOption( 'DISTINCT' );
120  } else {
121  $this->addFields( [ 'ar_timestamp', 'ar_rev_id', 'ar_id' ] );
122  }
123  }
124 
125  if ( $this->fld_tags ) {
126  $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'archive' ) ] );
127  }
128 
129  if ( !is_null( $params['tag'] ) ) {
130  $this->addTables( 'change_tag' );
131  $this->addJoinConds(
132  [ 'change_tag' => [ 'JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
133  );
134  $changeTagDefStore = $services->getChangeTagDefStore();
135  try {
136  $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
137  } catch ( NameTableAccessException $exception ) {
138  // Return nothing.
139  $this->addWhere( '1=0' );
140  }
141  }
142 
143  // This means stricter restrictions
144  if ( ( $this->fld_comment || $this->fld_parsedcomment ) &&
145  !$this->getPermissionManager()->userHasRight( $user, 'deletedhistory' )
146  ) {
147  $this->dieWithError( 'apierror-cantview-deleted-comment', 'permissiondenied' );
148  }
149  if ( $this->fetchContent &&
150  !$this->getPermissionManager()->userHasAnyRight( $user, 'deletedtext', 'undelete' )
151  ) {
152  $this->dieWithError( 'apierror-cantview-deleted-revision-content', 'permissiondenied' );
153  }
154 
155  $miser_ns = null;
156 
157  if ( $mode == 'all' ) {
158  $namespaces = $params['namespace'] ??
159  $services->getNamespaceInfo()->getValidNamespaces();
160  $this->addWhereFld( 'ar_namespace', $namespaces );
161 
162  // For from/to/prefix, we have to consider the potential
163  // transformations of the title in all specified namespaces.
164  // Generally there will be only one transformation, but wikis with
165  // some namespaces case-sensitive could have two.
166  if ( $params['from'] !== null || $params['to'] !== null ) {
167  $isDirNewer = ( $dir === 'newer' );
168  $after = ( $isDirNewer ? '>=' : '<=' );
169  $before = ( $isDirNewer ? '<=' : '>=' );
170  $where = [];
171  foreach ( $namespaces as $ns ) {
172  $w = [];
173  if ( $params['from'] !== null ) {
174  $w[] = 'ar_title' . $after .
175  $db->addQuotes( $this->titlePartToKey( $params['from'], $ns ) );
176  }
177  if ( $params['to'] !== null ) {
178  $w[] = 'ar_title' . $before .
179  $db->addQuotes( $this->titlePartToKey( $params['to'], $ns ) );
180  }
181  $w = $db->makeList( $w, LIST_AND );
182  $where[$w][] = $ns;
183  }
184  if ( count( $where ) == 1 ) {
185  $where = key( $where );
186  $this->addWhere( $where );
187  } else {
188  $where2 = [];
189  foreach ( $where as $w => $ns ) {
190  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
191  }
192  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
193  }
194  }
195 
196  if ( isset( $params['prefix'] ) ) {
197  $where = [];
198  foreach ( $namespaces as $ns ) {
199  $w = 'ar_title' . $db->buildLike(
200  $this->titlePartToKey( $params['prefix'], $ns ),
201  $db->anyString() );
202  $where[$w][] = $ns;
203  }
204  if ( count( $where ) == 1 ) {
205  $where = key( $where );
206  $this->addWhere( $where );
207  } else {
208  $where2 = [];
209  foreach ( $where as $w => $ns ) {
210  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
211  }
212  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
213  }
214  }
215  } else {
216  if ( $this->getConfig()->get( 'MiserMode' ) ) {
217  $miser_ns = $params['namespace'];
218  } else {
219  $this->addWhereFld( 'ar_namespace', $params['namespace'] );
220  }
221  $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
222  }
223 
224  if ( !is_null( $params['user'] ) ) {
225  // Don't query by user ID here, it might be able to use the ar_usertext_timestamp index.
226  $actorQuery = ActorMigration::newMigration()
227  ->getWhere( $db, 'ar_user', User::newFromName( $params['user'], false ), false );
228  $this->addTables( $actorQuery['tables'] );
229  $this->addJoinConds( $actorQuery['joins'] );
230  $this->addWhere( $actorQuery['conds'] );
231  } elseif ( !is_null( $params['excludeuser'] ) ) {
232  // Here there's no chance of using ar_usertext_timestamp.
233  $actorQuery = ActorMigration::newMigration()
234  ->getWhere( $db, 'ar_user', User::newFromName( $params['excludeuser'], false ) );
235  $this->addTables( $actorQuery['tables'] );
236  $this->addJoinConds( $actorQuery['joins'] );
237  $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
238  }
239 
240  if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
241  // Paranoia: avoid brute force searches (T19342)
242  if ( !$this->getPermissionManager()->userHasRight( $user, 'deletedhistory' ) ) {
243  $bitmask = RevisionRecord::DELETED_USER;
244  } elseif ( !$this->getPermissionManager()
245  ->userHasAnyRight( $user, 'suppressrevision', 'viewsuppressed' )
246  ) {
247  $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
248  } else {
249  $bitmask = 0;
250  }
251  if ( $bitmask ) {
252  $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
253  }
254  }
255 
256  if ( !is_null( $params['continue'] ) ) {
257  $cont = explode( '|', $params['continue'] );
258  $op = ( $dir == 'newer' ? '>' : '<' );
259  if ( $optimizeGenerateTitles ) {
260  $this->dieContinueUsageIf( count( $cont ) != 2 );
261  $ns = (int)$cont[0];
262  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
263  $title = $db->addQuotes( $cont[1] );
264  $this->addWhere( "ar_namespace $op $ns OR " .
265  "(ar_namespace = $ns AND ar_title $op= $title)" );
266  } elseif ( $mode == 'all' ) {
267  $this->dieContinueUsageIf( count( $cont ) != 4 );
268  $ns = (int)$cont[0];
269  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
270  $title = $db->addQuotes( $cont[1] );
271  $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
272  $ar_id = (int)$cont[3];
273  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
274  $this->addWhere( "ar_namespace $op $ns OR " .
275  "(ar_namespace = $ns AND " .
276  "(ar_title $op $title OR " .
277  "(ar_title = $title AND " .
278  "(ar_timestamp $op $ts OR " .
279  "(ar_timestamp = $ts AND " .
280  "ar_id $op= $ar_id)))))" );
281  } else {
282  $this->dieContinueUsageIf( count( $cont ) != 2 );
283  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
284  $ar_id = (int)$cont[1];
285  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
286  $this->addWhere( "ar_timestamp $op $ts OR " .
287  "(ar_timestamp = $ts AND " .
288  "ar_id $op= $ar_id)" );
289  }
290  }
291 
292  $this->addOption( 'LIMIT', $this->limit + 1 );
293 
294  $sort = ( $dir == 'newer' ? '' : ' DESC' );
295  $orderby = [];
296  if ( $optimizeGenerateTitles ) {
297  // Targeting index name_title_timestamp
298  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
299  $orderby[] = "ar_namespace $sort";
300  }
301  $orderby[] = "ar_title $sort";
302  } elseif ( $mode == 'all' ) {
303  // Targeting index name_title_timestamp
304  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
305  $orderby[] = "ar_namespace $sort";
306  }
307  $orderby[] = "ar_title $sort";
308  $orderby[] = "ar_timestamp $sort";
309  $orderby[] = "ar_id $sort";
310  } else {
311  // Targeting index usertext_timestamp
312  // 'user' is always constant.
313  $orderby[] = "ar_timestamp $sort";
314  $orderby[] = "ar_id $sort";
315  }
316  $this->addOption( 'ORDER BY', $orderby );
317 
318  $res = $this->select( __METHOD__ );
319  $pageMap = []; // Maps ns&title to array index
320  $count = 0;
321  $nextIndex = 0;
322  $generated = [];
323  foreach ( $res as $row ) {
324  if ( ++$count > $this->limit ) {
325  // We've had enough
326  if ( $optimizeGenerateTitles ) {
327  $this->setContinueEnumParameter( 'continue', "$row->ar_namespace|$row->ar_title" );
328  } elseif ( $mode == 'all' ) {
329  $this->setContinueEnumParameter( 'continue',
330  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
331  );
332  } else {
333  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
334  }
335  break;
336  }
337 
338  // Miser mode namespace check
339  if ( $miser_ns !== null && !in_array( $row->ar_namespace, $miser_ns ) ) {
340  continue;
341  }
342 
343  if ( $resultPageSet !== null ) {
344  if ( $params['generatetitles'] ) {
345  $key = "{$row->ar_namespace}:{$row->ar_title}";
346  if ( !isset( $generated[$key] ) ) {
347  $generated[$key] = Title::makeTitle( $row->ar_namespace, $row->ar_title );
348  }
349  } else {
350  $generated[] = $row->ar_rev_id;
351  }
352  } else {
353  $revision = $revisionStore->newRevisionFromArchiveRow( $row );
354  $rev = $this->extractRevisionInfo( $revision, $row );
355 
356  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
357  $index = $nextIndex++;
358  $pageMap[$row->ar_namespace][$row->ar_title] = $index;
359  $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
360  $a = [
361  'pageid' => $title->getArticleID(),
362  'revisions' => [ $rev ],
363  ];
364  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
366  $fit = $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
367  } else {
368  $index = $pageMap[$row->ar_namespace][$row->ar_title];
369  $fit = $result->addValue(
370  [ 'query', $this->getModuleName(), $index, 'revisions' ],
371  null, $rev );
372  }
373  if ( !$fit ) {
374  if ( $mode == 'all' ) {
375  $this->setContinueEnumParameter( 'continue',
376  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
377  );
378  } else {
379  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
380  }
381  break;
382  }
383  }
384  }
385 
386  if ( $resultPageSet !== null ) {
387  if ( $params['generatetitles'] ) {
388  $resultPageSet->populateFromTitles( $generated );
389  } else {
390  $resultPageSet->populateFromRevisionIDs( $generated );
391  }
392  } else {
393  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
394  }
395  }
396 
397  public function getAllowedParams() {
398  $ret = parent::getAllowedParams() + [
399  'user' => [
400  ApiBase::PARAM_TYPE => 'user'
401  ],
402  'namespace' => [
403  ApiBase::PARAM_ISMULTI => true,
404  ApiBase::PARAM_TYPE => 'namespace',
405  ],
406  'start' => [
407  ApiBase::PARAM_TYPE => 'timestamp',
408  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
409  ],
410  'end' => [
411  ApiBase::PARAM_TYPE => 'timestamp',
412  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
413  ],
414  'dir' => [
416  'newer',
417  'older'
418  ],
419  ApiBase::PARAM_DFLT => 'older',
420  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
421  ],
422  'from' => [
423  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
424  ],
425  'to' => [
426  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
427  ],
428  'prefix' => [
429  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
430  ],
431  'excludeuser' => [
432  ApiBase::PARAM_TYPE => 'user',
433  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
434  ],
435  'tag' => null,
436  'continue' => [
437  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
438  ],
439  'generatetitles' => [
440  ApiBase::PARAM_DFLT => false
441  ],
442  ];
443 
444  if ( $this->getConfig()->get( 'MiserMode' ) ) {
445  $ret['user'][ApiBase::PARAM_HELP_MSG_APPEND] = [
446  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
447  ];
448  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
449  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
450  ];
451  }
452 
453  return $ret;
454  }
455 
456  protected function getExamplesMessages() {
457  return [
458  'action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50'
459  => 'apihelp-query+alldeletedrevisions-example-user',
460  'action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50'
461  => 'apihelp-query+alldeletedrevisions-example-ns-main',
462  ];
463  }
464 
465  public function getHelpUrls() {
466  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Alldeletedrevisions';
467  }
468 }
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)
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
getResult()
Get the result object.
Definition: ApiBase.php:640
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
Exception representing a failure to look up a row from a name table.
$sort
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:148
A base class for functions common to producing a list of revisions.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2005
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:876
__construct(ApiQuery $query, $moduleName)
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:138
static newMigration()
Static constructor.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
const LIST_AND
Definition: Defines.php:39
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2199
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
addFields( $value)
Add a set of fields to select to the internal array.
This is the main query class.
Definition: ApiQuery.php:37
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
const LIST_OR
Definition: Defines.php:42
static newFromLinkTarget(LinkTarget $linkTarget, $forceClone='')
Returns a Title given a LinkTarget.
Definition: Title.php:271
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:586
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:528
addWhere( $value)
Add a set of WHERE clauses to the internal array.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1924
Query module to enumerate all deleted revisions.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
getPermissionManager()
Obtain a PermissionManager instance that subclasses may use in their authorization checks...
Definition: ApiBase.php:710
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
extractRevisionInfo(RevisionRecord $revision, $row)
Extract information from the RevisionRecord.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
parseParameters( $params)
Parse the parameters into the various instance fields.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:515
static makeTagSummarySubquery( $tables)
Make the tag summary subquery based on the given tables and return it.
Definition: ChangeTags.php:837
run(ApiPageSet $resultPageSet=null)