cb2f6168aeb8f10b540b4215f99430563ed81382
[lhc/web/wiklou.git] / includes / api / ApiQueryRevisions.php
1 <?php
2 /**
3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 */
22
23 use MediaWiki\MediaWikiServices;
24 use MediaWiki\Revision\RevisionRecord;
25 use MediaWiki\Storage\NameTableAccessException;
26
27 /**
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.
32 *
33 * @ingroup API
34 */
35 class ApiQueryRevisions extends ApiQueryRevisionsBase {
36
37 private $token = null;
38
39 public function __construct( ApiQuery $query, $moduleName ) {
40 parent::__construct( $query, $moduleName, 'rv' );
41 }
42
43 private $tokenFunctions;
44
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
50
51 // Don't call the hooks twice
52 if ( isset( $this->tokenFunctions ) ) {
53 return $this->tokenFunctions;
54 }
55
56 // If we're in a mode that breaks the same-origin policy, no tokens can
57 // be obtained
58 if ( $this->lacksSameOriginSecurity() ) {
59 return [];
60 }
61
62 $this->tokenFunctions = [
63 'rollback' => [ self::class, 'getRollbackToken' ]
64 ];
65 Hooks::run( 'APIQueryRevisionsTokens', [ &$this->tokenFunctions ] );
66
67 return $this->tokenFunctions;
68 }
69
70 /**
71 * @deprecated since 1.24
72 * @param int $pageid
73 * @param Title $title
74 * @param Revision $rev
75 * @return bool|string
76 */
77 public static function getRollbackToken( $pageid, $title, $rev ) {
78 global $wgUser;
79 if ( !$wgUser->isAllowed( 'rollback' ) ) {
80 return false;
81 }
82
83 return $wgUser->getEditToken( 'rollback' );
84 }
85
86 protected function run( ApiPageSet $resultPageSet = null ) {
87 global $wgActorTableSchemaMigrationStage;
88
89 $params = $this->extractRequestParams( false );
90 $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
91
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 );
100
101 $pageSet = $this->getPageSet();
102 $pageCount = $pageSet->getGoodTitleCount();
103 $revCount = $pageSet->getRevisionCount();
104
105 // Optimization -- nothing to do
106 if ( $revCount === 0 && $pageCount === 0 ) {
107 // Nothing to do
108 return;
109 }
110 if ( $revCount > 0 && count( $pageSet->getLiveRevisionIDs() ) === 0 ) {
111 // We're in revisions mode but all given revisions are deleted
112 return;
113 }
114
115 if ( $revCount > 0 && $enumRevMode ) {
116 $this->dieWithError(
117 [ 'apierror-revisions-nolist', $this->getModulePrefix() ], 'invalidparammix'
118 );
119 }
120
121 if ( $pageCount > 1 && $enumRevMode ) {
122 $this->dieWithError(
123 [ 'apierror-revisions-singlepage', $this->getModulePrefix() ], 'invalidparammix'
124 );
125 }
126
127 // In non-enum mode, rvlimit can't be directly used. Use the maximum
128 // allowed value.
129 if ( !$enumRevMode ) {
130 $this->setParsedLimit = false;
131 $params['limit'] = 'max';
132 }
133
134 $db = $this->getDB();
135
136 $idField = 'rev_id';
137 $tsField = 'rev_timestamp';
138 $pageField = 'rev_page';
139 if ( $params['user'] !== null &&
140 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW )
141 ) {
142 // We're going to want to use the page_actor_timestamp index (on revision_actor_temp)
143 // so use that table's denormalized fields.
144 $idField = 'revactor_rev';
145 $tsField = 'revactor_timestamp';
146 $pageField = 'revactor_page';
147 }
148
149 if ( $resultPageSet === null ) {
150 $this->parseParameters( $params );
151 $this->token = $params['token'];
152 $opts = [];
153 if ( $this->token !== null || $pageCount > 0 ) {
154 $opts[] = 'page';
155 }
156 if ( $this->fetchContent ) {
157 $opts[] = 'text';
158 }
159 if ( $this->fld_user ) {
160 $opts[] = 'user';
161 }
162 $revQuery = $revisionStore->getQueryInfo( $opts );
163
164 if ( $idField !== 'rev_id' ) {
165 $aliasFields = [ 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField ];
166 $revQuery['fields'] = array_merge(
167 $aliasFields,
168 array_diff( $revQuery['fields'], array_keys( $aliasFields ) )
169 );
170 }
171
172 $this->addTables( $revQuery['tables'] );
173 $this->addFields( $revQuery['fields'] );
174 $this->addJoinConds( $revQuery['joins'] );
175 } else {
176 $this->limit = $this->getParameter( 'limit' ) ?: 10;
177 // Always join 'page' so orphaned revisions are filtered out
178 $this->addTables( [ 'revision', 'page' ] );
179 $this->addJoinConds(
180 [ 'page' => [ 'INNER JOIN', [ 'page_id = rev_page' ] ] ]
181 );
182 $this->addFields( [
183 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField
184 ] );
185 }
186
187 if ( $this->fld_tags ) {
188 $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'revision' ) ] );
189 }
190
191 if ( $params['tag'] !== null ) {
192 $this->addTables( 'change_tag' );
193 $this->addJoinConds(
194 [ 'change_tag' => [ 'INNER JOIN', [ 'rev_id=ct_rev_id' ] ] ]
195 );
196 $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
197 try {
198 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
199 } catch ( NameTableAccessException $exception ) {
200 // Return nothing.
201 $this->addWhere( '1=0' );
202 }
203 }
204
205 if ( $resultPageSet === null && $this->fetchContent ) {
206 // For each page we will request, the user must have read rights for that page
207 $user = $this->getUser();
208 $status = Status::newGood();
209 /** @var Title $title */
210 foreach ( $pageSet->getGoodTitles() as $title ) {
211 if ( !$title->userCan( 'read', $user ) ) {
212 $status->fatal( ApiMessage::create(
213 [ 'apierror-cannotviewtitle', wfEscapeWikiText( $title->getPrefixedText() ) ],
214 'accessdenied'
215 ) );
216 }
217 }
218 if ( !$status->isGood() ) {
219 $this->dieStatus( $status );
220 }
221 }
222
223 if ( $enumRevMode ) {
224 // Indexes targeted:
225 // page_timestamp if we don't have rvuser
226 // page_actor_timestamp (on revision_actor_temp) if we have rvuser in READ_NEW mode
227 // page_user_timestamp if we have a logged-in rvuser
228 // page_timestamp or usertext_timestamp if we have an IP rvuser
229
230 // This is mostly to prevent parameter errors (and optimize SQL?)
231 $this->requireMaxOneParameter( $params, 'startid', 'start' );
232 $this->requireMaxOneParameter( $params, 'endid', 'end' );
233 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
234
235 if ( $params['continue'] !== null ) {
236 $cont = explode( '|', $params['continue'] );
237 $this->dieContinueUsageIf( count( $cont ) != 2 );
238 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
239 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
240 $continueId = (int)$cont[1];
241 $this->dieContinueUsageIf( $continueId != $cont[1] );
242 $this->addWhere( "$tsField $op $continueTimestamp OR " .
243 "($tsField = $continueTimestamp AND " .
244 "$idField $op= $continueId)"
245 );
246 }
247
248 // Convert startid/endid to timestamps (T163532)
249 $revids = [];
250 if ( $params['startid'] !== null ) {
251 $revids[] = (int)$params['startid'];
252 }
253 if ( $params['endid'] !== null ) {
254 $revids[] = (int)$params['endid'];
255 }
256 if ( $revids ) {
257 $db = $this->getDB();
258 $sql = $db->unionQueries( [
259 $db->selectSQLText(
260 'revision',
261 [ 'id' => 'rev_id', 'ts' => 'rev_timestamp' ],
262 [ 'rev_id' => $revids ],
263 __METHOD__
264 ),
265 $db->selectSQLText(
266 'archive',
267 [ 'id' => 'ar_rev_id', 'ts' => 'ar_timestamp' ],
268 [ 'ar_rev_id' => $revids ],
269 __METHOD__
270 ),
271 ], false );
272 $res = $db->query( $sql, __METHOD__ );
273 foreach ( $res as $row ) {
274 if ( (int)$row->id === (int)$params['startid'] ) {
275 $params['start'] = $row->ts;
276 }
277 if ( (int)$row->id === (int)$params['endid'] ) {
278 $params['end'] = $row->ts;
279 }
280 }
281 if ( $params['startid'] !== null && $params['start'] === null ) {
282 $p = $this->encodeParamName( 'startid' );
283 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
284 }
285 if ( $params['endid'] !== null && $params['end'] === null ) {
286 $p = $this->encodeParamName( 'endid' );
287 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
288 }
289
290 if ( $params['start'] !== null ) {
291 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
292 $ts = $db->addQuotes( $db->timestampOrNull( $params['start'] ) );
293 if ( $params['startid'] !== null ) {
294 $this->addWhere( "$tsField $op $ts OR "
295 . "$tsField = $ts AND $idField $op= " . intval( $params['startid'] ) );
296 } else {
297 $this->addWhere( "$tsField $op= $ts" );
298 }
299 }
300 if ( $params['end'] !== null ) {
301 $op = ( $params['dir'] === 'newer' ? '<' : '>' ); // Yes, opposite of the above
302 $ts = $db->addQuotes( $db->timestampOrNull( $params['end'] ) );
303 if ( $params['endid'] !== null ) {
304 $this->addWhere( "$tsField $op $ts OR "
305 . "$tsField = $ts AND $idField $op= " . intval( $params['endid'] ) );
306 } else {
307 $this->addWhere( "$tsField $op= $ts" );
308 }
309 }
310 } else {
311 $this->addTimestampWhereRange( $tsField, $params['dir'],
312 $params['start'], $params['end'] );
313 }
314
315 $sort = ( $params['dir'] === 'newer' ? '' : 'DESC' );
316 $this->addOption( 'ORDER BY', [ "rev_timestamp $sort", "rev_id $sort" ] );
317
318 // There is only one ID, use it
319 $ids = array_keys( $pageSet->getGoodTitles() );
320 $this->addWhereFld( $pageField, reset( $ids ) );
321
322 if ( $params['user'] !== null ) {
323 $actorQuery = ActorMigration::newMigration()
324 ->getWhere( $db, 'rev_user', User::newFromName( $params['user'], false ) );
325 $this->addTables( $actorQuery['tables'] );
326 $this->addJoinConds( $actorQuery['joins'] );
327 $this->addWhere( $actorQuery['conds'] );
328 } elseif ( $params['excludeuser'] !== null ) {
329 $actorQuery = ActorMigration::newMigration()
330 ->getWhere( $db, 'rev_user', User::newFromName( $params['excludeuser'], false ) );
331 $this->addTables( $actorQuery['tables'] );
332 $this->addJoinConds( $actorQuery['joins'] );
333 $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
334 }
335 if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
336 // Paranoia: avoid brute force searches (T19342)
337 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
338 $bitmask = RevisionRecord::DELETED_USER;
339 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
340 $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
341 } else {
342 $bitmask = 0;
343 }
344 if ( $bitmask ) {
345 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
346 }
347 }
348 } elseif ( $revCount > 0 ) {
349 // Always targets the PRIMARY index
350
351 $revs = $pageSet->getLiveRevisionIDs();
352
353 // Get all revision IDs
354 $this->addWhereFld( 'rev_id', array_keys( $revs ) );
355
356 if ( $params['continue'] !== null ) {
357 $this->addWhere( 'rev_id >= ' . intval( $params['continue'] ) );
358 }
359 $this->addOption( 'ORDER BY', 'rev_id' );
360 } elseif ( $pageCount > 0 ) {
361 // Always targets the rev_page_id index
362
363 $titles = $pageSet->getGoodTitles();
364
365 // When working in multi-page non-enumeration mode,
366 // limit to the latest revision only
367 $this->addWhere( 'page_latest=rev_id' );
368
369 // Get all page IDs
370 $this->addWhereFld( 'page_id', array_keys( $titles ) );
371 // Every time someone relies on equality propagation, god kills a kitten :)
372 $this->addWhereFld( 'rev_page', array_keys( $titles ) );
373
374 if ( $params['continue'] !== null ) {
375 $cont = explode( '|', $params['continue'] );
376 $this->dieContinueUsageIf( count( $cont ) != 2 );
377 $pageid = intval( $cont[0] );
378 $revid = intval( $cont[1] );
379 $this->addWhere(
380 "rev_page > $pageid OR " .
381 "(rev_page = $pageid AND " .
382 "rev_id >= $revid)"
383 );
384 }
385 $this->addOption( 'ORDER BY', [
386 'rev_page',
387 'rev_id'
388 ] );
389 } else {
390 ApiBase::dieDebug( __METHOD__, 'param validation?' );
391 }
392
393 $this->addOption( 'LIMIT', $this->limit + 1 );
394
395 $count = 0;
396 $generated = [];
397 $hookData = [];
398 $res = $this->select( __METHOD__, [], $hookData );
399
400 foreach ( $res as $row ) {
401 if ( ++$count > $this->limit ) {
402 // We've reached the one extra which shows that there are
403 // additional pages to be had. Stop here...
404 if ( $enumRevMode ) {
405 $this->setContinueEnumParameter( 'continue',
406 $row->rev_timestamp . '|' . intval( $row->rev_id ) );
407 } elseif ( $revCount > 0 ) {
408 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
409 } else {
410 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
411 '|' . intval( $row->rev_id ) );
412 }
413 break;
414 }
415
416 if ( $resultPageSet !== null ) {
417 $generated[] = $row->rev_id;
418 } else {
419 $revision = $revisionStore->newRevisionFromRow( $row );
420 $rev = $this->extractRevisionInfo( $revision, $row );
421
422 if ( $this->token !== null ) {
423 $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
424 $revisionCompat = new Revision( $revision );
425 $tokenFunctions = $this->getTokenFunctions();
426 foreach ( $this->token as $t ) {
427 $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revisionCompat );
428 if ( $val === false ) {
429 $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
430 } else {
431 $rev[$t . 'token'] = $val;
432 }
433 }
434 }
435
436 $fit = $this->processRow( $row, $rev, $hookData ) &&
437 $this->addPageSubItem( $row->rev_page, $rev, 'rev' );
438 if ( !$fit ) {
439 if ( $enumRevMode ) {
440 $this->setContinueEnumParameter( 'continue',
441 $row->rev_timestamp . '|' . intval( $row->rev_id ) );
442 } elseif ( $revCount > 0 ) {
443 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
444 } else {
445 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
446 '|' . intval( $row->rev_id ) );
447 }
448 break;
449 }
450 }
451 }
452
453 if ( $resultPageSet !== null ) {
454 $resultPageSet->populateFromRevisionIDs( $generated );
455 }
456 }
457
458 public function getCacheMode( $params ) {
459 if ( isset( $params['token'] ) ) {
460 return 'private';
461 }
462 return parent::getCacheMode( $params );
463 }
464
465 public function getAllowedParams() {
466 $ret = parent::getAllowedParams() + [
467 'startid' => [
468 ApiBase::PARAM_TYPE => 'integer',
469 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
470 ],
471 'endid' => [
472 ApiBase::PARAM_TYPE => 'integer',
473 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
474 ],
475 'start' => [
476 ApiBase::PARAM_TYPE => 'timestamp',
477 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
478 ],
479 'end' => [
480 ApiBase::PARAM_TYPE => 'timestamp',
481 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
482 ],
483 'dir' => [
484 ApiBase::PARAM_DFLT => 'older',
485 ApiBase::PARAM_TYPE => [
486 'newer',
487 'older'
488 ],
489 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
490 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
491 ],
492 'user' => [
493 ApiBase::PARAM_TYPE => 'user',
494 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
495 ],
496 'excludeuser' => [
497 ApiBase::PARAM_TYPE => 'user',
498 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
499 ],
500 'tag' => null,
501 'token' => [
502 ApiBase::PARAM_DEPRECATED => true,
503 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
504 ApiBase::PARAM_ISMULTI => true
505 ],
506 'continue' => [
507 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
508 ],
509 ];
510
511 $ret['limit'][ApiBase::PARAM_HELP_MSG_INFO] = [ [ 'singlepageonly' ] ];
512
513 return $ret;
514 }
515
516 protected function getExamplesMessages() {
517 return [
518 'action=query&prop=revisions&titles=API|Main%20Page&' .
519 'rvslots=*&rvprop=timestamp|user|comment|content'
520 => 'apihelp-query+revisions-example-content',
521 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
522 'rvprop=timestamp|user|comment'
523 => 'apihelp-query+revisions-example-last5',
524 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
525 'rvprop=timestamp|user|comment&rvdir=newer'
526 => 'apihelp-query+revisions-example-first5',
527 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
528 'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
529 => 'apihelp-query+revisions-example-first5-after',
530 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
531 'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
532 => 'apihelp-query+revisions-example-first5-not-localhost',
533 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
534 'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
535 => 'apihelp-query+revisions-example-first5-user',
536 ];
537 }
538
539 public function getHelpUrls() {
540 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions';
541 }
542 }