3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Revision\RevisionRecord
;
25 use MediaWiki\Storage\NameTableAccessException
;
28 * A query action to enumerate revisions of a given page, or show top revisions
29 * of multiple pages. Various pieces of information may be shown - flags,
30 * comments, and the actual wiki markup of the rev. In the enumeration mode,
31 * ranges of revisions may be requested and filtered.
35 class ApiQueryRevisions
extends ApiQueryRevisionsBase
{
37 private $token = null;
39 public function __construct( ApiQuery
$query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'rv' );
43 private $tokenFunctions;
45 /** @deprecated since 1.24 */
46 protected function getTokenFunctions() {
47 // tokenname => function
48 // function prototype is func($pageid, $title, $rev)
49 // should return token or false
51 // Don't call the hooks twice
52 if ( isset( $this->tokenFunctions
) ) {
53 return $this->tokenFunctions
;
56 // If we're in a mode that breaks the same-origin policy, no tokens can
58 if ( $this->lacksSameOriginSecurity() ) {
62 $this->tokenFunctions
= [
63 'rollback' => [ self
::class, 'getRollbackToken' ]
65 Hooks
::run( 'APIQueryRevisionsTokens', [ &$this->tokenFunctions
] );
67 return $this->tokenFunctions
;
71 * @deprecated since 1.24
74 * @param Revision $rev
77 public static function getRollbackToken( $pageid, $title, $rev ) {
79 if ( !$wgUser->isAllowed( 'rollback' ) ) {
83 return $wgUser->getEditToken( 'rollback' );
86 protected function run( ApiPageSet
$resultPageSet = null ) {
87 global $wgChangeTagsSchemaMigrationStage;
89 $params = $this->extractRequestParams( false );
90 $revisionStore = MediaWikiServices
::getInstance()->getRevisionStore();
92 // If any of those parameters are used, work in 'enumeration' mode.
93 // Enum mode can only be used when exactly one page is provided.
94 // Enumerating revisions on multiple pages make it extremely
95 // difficult to manage continuations and require additional SQL indexes
96 $enumRevMode = ( $params['user'] !== null ||
$params['excludeuser'] !== null ||
97 $params['limit'] !== null ||
$params['startid'] !== null ||
98 $params['endid'] !== null ||
$params['dir'] === 'newer' ||
99 $params['start'] !== null ||
$params['end'] !== null );
101 $pageSet = $this->getPageSet();
102 $pageCount = $pageSet->getGoodTitleCount();
103 $revCount = $pageSet->getRevisionCount();
105 // Optimization -- nothing to do
106 if ( $revCount === 0 && $pageCount === 0 ) {
110 if ( $revCount > 0 && count( $pageSet->getLiveRevisionIDs() ) === 0 ) {
111 // We're in revisions mode but all given revisions are deleted
115 if ( $revCount > 0 && $enumRevMode ) {
117 [ 'apierror-revisions-nolist', $this->getModulePrefix() ], 'invalidparammix'
121 if ( $pageCount > 1 && $enumRevMode ) {
123 [ 'apierror-revisions-singlepage', $this->getModulePrefix() ], 'invalidparammix'
127 // In non-enum mode, rvlimit can't be directly used. Use the maximum
129 if ( !$enumRevMode ) {
130 $this->setParsedLimit
= false;
131 $params['limit'] = 'max';
134 $db = $this->getDB();
136 if ( $resultPageSet === null ) {
137 $this->parseParameters( $params );
138 $this->token
= $params['token'];
140 if ( $this->token
!== null ||
$pageCount > 0 ) {
143 if ( $this->fetchContent
) {
146 if ( $this->fld_user
) {
149 $revQuery = $revisionStore->getQueryInfo( $opts );
150 $this->addTables( $revQuery['tables'] );
151 $this->addFields( $revQuery['fields'] );
152 $this->addJoinConds( $revQuery['joins'] );
154 $this->limit
= $this->getParameter( 'limit' ) ?
: 10;
155 // Always join 'page' so orphaned revisions are filtered out
156 $this->addTables( [ 'revision', 'page' ] );
158 [ 'page' => [ 'INNER JOIN', [ 'page_id = rev_page' ] ] ]
160 $this->addFields( [ 'rev_id', 'rev_timestamp', 'rev_page' ] );
163 if ( $this->fld_tags
) {
164 $this->addTables( 'tag_summary' );
166 [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
168 $this->addFields( 'ts_tags' );
171 if ( $params['tag'] !== null ) {
172 $this->addTables( 'change_tag' );
174 [ 'change_tag' => [ 'INNER JOIN', [ 'rev_id=ct_rev_id' ] ] ]
176 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
177 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
179 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
180 } catch ( NameTableAccessException
$exception ) {
182 $this->addWhere( '1=0' );
185 $this->addWhereFld( 'ct_tag', $params['tag'] );
189 if ( $resultPageSet === null && $this->fetchContent
) {
190 // For each page we will request, the user must have read rights for that page
191 $user = $this->getUser();
192 $status = Status
::newGood();
193 /** @var Title $title */
194 foreach ( $pageSet->getGoodTitles() as $title ) {
195 if ( !$title->userCan( 'read', $user ) ) {
196 $status->fatal( ApiMessage
::create(
197 [ 'apierror-cannotviewtitle', wfEscapeWikiText( $title->getPrefixedText() ) ],
202 if ( !$status->isGood() ) {
203 $this->dieStatus( $status );
207 if ( $enumRevMode ) {
209 // page_timestamp if we don't have rvuser
210 // page_user_timestamp if we have a logged-in rvuser
211 // page_timestamp or usertext_timestamp if we have an IP rvuser
213 // This is mostly to prevent parameter errors (and optimize SQL?)
214 $this->requireMaxOneParameter( $params, 'startid', 'start' );
215 $this->requireMaxOneParameter( $params, 'endid', 'end' );
216 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
218 if ( $params['continue'] !== null ) {
219 $cont = explode( '|', $params['continue'] );
220 $this->dieContinueUsageIf( count( $cont ) != 2 );
221 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
222 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
223 $continueId = (int)$cont[1];
224 $this->dieContinueUsageIf( $continueId != $cont[1] );
225 $this->addWhere( "rev_timestamp $op $continueTimestamp OR " .
226 "(rev_timestamp = $continueTimestamp AND " .
227 "rev_id $op= $continueId)"
231 // Convert startid/endid to timestamps (T163532)
233 if ( $params['startid'] !== null ) {
234 $revids[] = (int)$params['startid'];
236 if ( $params['endid'] !== null ) {
237 $revids[] = (int)$params['endid'];
240 $db = $this->getDB();
241 $sql = $db->unionQueries( [
244 [ 'id' => 'rev_id', 'ts' => 'rev_timestamp' ],
245 [ 'rev_id' => $revids ],
250 [ 'id' => 'ar_rev_id', 'ts' => 'ar_timestamp' ],
251 [ 'ar_rev_id' => $revids ],
255 $res = $db->query( $sql, __METHOD__
);
256 foreach ( $res as $row ) {
257 if ( (int)$row->id
=== (int)$params['startid'] ) {
258 $params['start'] = $row->ts
;
260 if ( (int)$row->id
=== (int)$params['endid'] ) {
261 $params['end'] = $row->ts
;
264 if ( $params['startid'] !== null && $params['start'] === null ) {
265 $p = $this->encodeParamName( 'startid' );
266 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
268 if ( $params['endid'] !== null && $params['end'] === null ) {
269 $p = $this->encodeParamName( 'endid' );
270 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
273 if ( $params['start'] !== null ) {
274 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
275 $ts = $db->addQuotes( $db->timestampOrNull( $params['start'] ) );
276 if ( $params['startid'] !== null ) {
277 $this->addWhere( "rev_timestamp $op $ts OR "
278 . "rev_timestamp = $ts AND rev_id $op= " . intval( $params['startid'] ) );
280 $this->addWhere( "rev_timestamp $op= $ts" );
283 if ( $params['end'] !== null ) {
284 $op = ( $params['dir'] === 'newer' ?
'<' : '>' ); // Yes, opposite of the above
285 $ts = $db->addQuotes( $db->timestampOrNull( $params['end'] ) );
286 if ( $params['endid'] !== null ) {
287 $this->addWhere( "rev_timestamp $op $ts OR "
288 . "rev_timestamp = $ts AND rev_id $op= " . intval( $params['endid'] ) );
290 $this->addWhere( "rev_timestamp $op= $ts" );
294 $this->addTimestampWhereRange( 'rev_timestamp', $params['dir'],
295 $params['start'], $params['end'] );
298 $sort = ( $params['dir'] === 'newer' ?
'' : 'DESC' );
299 $this->addOption( 'ORDER BY', [ "rev_timestamp $sort", "rev_id $sort" ] );
301 // There is only one ID, use it
302 $ids = array_keys( $pageSet->getGoodTitles() );
303 $this->addWhereFld( 'rev_page', reset( $ids ) );
305 if ( $params['user'] !== null ) {
306 $actorQuery = ActorMigration
::newMigration()
307 ->getWhere( $db, 'rev_user', User
::newFromName( $params['user'], false ) );
308 $this->addTables( $actorQuery['tables'] );
309 $this->addJoinConds( $actorQuery['joins'] );
310 $this->addWhere( $actorQuery['conds'] );
311 } elseif ( $params['excludeuser'] !== null ) {
312 $actorQuery = ActorMigration
::newMigration()
313 ->getWhere( $db, 'rev_user', User
::newFromName( $params['excludeuser'], false ) );
314 $this->addTables( $actorQuery['tables'] );
315 $this->addJoinConds( $actorQuery['joins'] );
316 $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
318 if ( $params['user'] !== null ||
$params['excludeuser'] !== null ) {
319 // Paranoia: avoid brute force searches (T19342)
320 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
321 $bitmask = RevisionRecord
::DELETED_USER
;
322 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
323 $bitmask = RevisionRecord
::DELETED_USER | RevisionRecord
::DELETED_RESTRICTED
;
328 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
331 } elseif ( $revCount > 0 ) {
332 // Always targets the PRIMARY index
334 $revs = $pageSet->getLiveRevisionIDs();
336 // Get all revision IDs
337 $this->addWhereFld( 'rev_id', array_keys( $revs ) );
339 if ( $params['continue'] !== null ) {
340 $this->addWhere( 'rev_id >= ' . intval( $params['continue'] ) );
342 $this->addOption( 'ORDER BY', 'rev_id' );
343 } elseif ( $pageCount > 0 ) {
344 // Always targets the rev_page_id index
346 $titles = $pageSet->getGoodTitles();
348 // When working in multi-page non-enumeration mode,
349 // limit to the latest revision only
350 $this->addWhere( 'page_latest=rev_id' );
353 $this->addWhereFld( 'page_id', array_keys( $titles ) );
354 // Every time someone relies on equality propagation, god kills a kitten :)
355 $this->addWhereFld( 'rev_page', array_keys( $titles ) );
357 if ( $params['continue'] !== null ) {
358 $cont = explode( '|', $params['continue'] );
359 $this->dieContinueUsageIf( count( $cont ) != 2 );
360 $pageid = intval( $cont[0] );
361 $revid = intval( $cont[1] );
363 "rev_page > $pageid OR " .
364 "(rev_page = $pageid AND " .
368 $this->addOption( 'ORDER BY', [
373 ApiBase
::dieDebug( __METHOD__
, 'param validation?' );
376 $this->addOption( 'LIMIT', $this->limit +
1 );
381 $res = $this->select( __METHOD__
, [], $hookData );
383 foreach ( $res as $row ) {
384 if ( ++
$count > $this->limit
) {
385 // We've reached the one extra which shows that there are
386 // additional pages to be had. Stop here...
387 if ( $enumRevMode ) {
388 $this->setContinueEnumParameter( 'continue',
389 $row->rev_timestamp
. '|' . intval( $row->rev_id
) );
390 } elseif ( $revCount > 0 ) {
391 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id
) );
393 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page
) .
394 '|' . intval( $row->rev_id
) );
399 if ( $resultPageSet !== null ) {
400 $generated[] = $row->rev_id
;
402 $revision = $revisionStore->newRevisionFromRow( $row );
403 $rev = $this->extractRevisionInfo( $revision, $row );
405 if ( $this->token
!== null ) {
406 $title = Title
::newFromLinkTarget( $revision->getPageAsLinkTarget() );
407 $revisionCompat = new Revision( $revision );
408 $tokenFunctions = $this->getTokenFunctions();
409 foreach ( $this->token
as $t ) {
410 $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revisionCompat );
411 if ( $val === false ) {
412 $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
414 $rev[$t . 'token'] = $val;
419 $fit = $this->processRow( $row, $rev, $hookData ) &&
420 $this->addPageSubItem( $row->rev_page
, $rev, 'rev' );
422 if ( $enumRevMode ) {
423 $this->setContinueEnumParameter( 'continue',
424 $row->rev_timestamp
. '|' . intval( $row->rev_id
) );
425 } elseif ( $revCount > 0 ) {
426 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id
) );
428 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page
) .
429 '|' . intval( $row->rev_id
) );
436 if ( $resultPageSet !== null ) {
437 $resultPageSet->populateFromRevisionIDs( $generated );
441 public function getCacheMode( $params ) {
442 if ( isset( $params['token'] ) ) {
445 return parent
::getCacheMode( $params );
448 public function getAllowedParams() {
449 $ret = parent
::getAllowedParams() +
[
451 ApiBase
::PARAM_TYPE
=> 'integer',
452 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
455 ApiBase
::PARAM_TYPE
=> 'integer',
456 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
459 ApiBase
::PARAM_TYPE
=> 'timestamp',
460 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
463 ApiBase
::PARAM_TYPE
=> 'timestamp',
464 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
467 ApiBase
::PARAM_DFLT
=> 'older',
468 ApiBase
::PARAM_TYPE
=> [
472 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
473 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
476 ApiBase
::PARAM_TYPE
=> 'user',
477 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
480 ApiBase
::PARAM_TYPE
=> 'user',
481 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
485 ApiBase
::PARAM_DEPRECATED
=> true,
486 ApiBase
::PARAM_TYPE
=> array_keys( $this->getTokenFunctions() ),
487 ApiBase
::PARAM_ISMULTI
=> true
490 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
494 $ret['limit'][ApiBase
::PARAM_HELP_MSG_INFO
] = [ [ 'singlepageonly' ] ];
499 protected function getExamplesMessages() {
501 'action=query&prop=revisions&titles=API|Main%20Page&' .
502 'rvslots=*&rvprop=timestamp|user|comment|content'
503 => 'apihelp-query+revisions-example-content',
504 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
505 'rvprop=timestamp|user|comment'
506 => 'apihelp-query+revisions-example-last5',
507 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
508 'rvprop=timestamp|user|comment&rvdir=newer'
509 => 'apihelp-query+revisions-example-first5',
510 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
511 'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
512 => 'apihelp-query+revisions-example-first5-after',
513 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
514 'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
515 => 'apihelp-query+revisions-example-first5-not-localhost',
516 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
517 'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
518 => 'apihelp-query+revisions-example-first5-user',
522 public function getHelpUrls() {
523 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions';