Merge "ApiSandbox: Use CopyTextLayouts for snippets"
[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->fld_user ) {
157 $opts[] = 'user';
158 }
159 $revQuery = $revisionStore->getQueryInfo( $opts );
160
161 if ( $idField !== 'rev_id' ) {
162 $aliasFields = [ 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField ];
163 $revQuery['fields'] = array_merge(
164 $aliasFields,
165 array_diff( $revQuery['fields'], array_keys( $aliasFields ) )
166 );
167 }
168
169 $this->addTables( $revQuery['tables'] );
170 $this->addFields( $revQuery['fields'] );
171 $this->addJoinConds( $revQuery['joins'] );
172 } else {
173 $this->limit = $this->getParameter( 'limit' ) ?: 10;
174 // Always join 'page' so orphaned revisions are filtered out
175 $this->addTables( [ 'revision', 'page' ] );
176 $this->addJoinConds(
177 [ 'page' => [ 'JOIN', [ 'page_id = rev_page' ] ] ]
178 );
179 $this->addFields( [
180 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField
181 ] );
182 }
183
184 if ( $this->fld_tags ) {
185 $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'revision' ) ] );
186 }
187
188 if ( $params['tag'] !== null ) {
189 $this->addTables( 'change_tag' );
190 $this->addJoinConds(
191 [ 'change_tag' => [ 'JOIN', [ 'rev_id=ct_rev_id' ] ] ]
192 );
193 $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
194 try {
195 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
196 } catch ( NameTableAccessException $exception ) {
197 // Return nothing.
198 $this->addWhere( '1=0' );
199 }
200 }
201
202 if ( $resultPageSet === null && $this->fetchContent ) {
203 // For each page we will request, the user must have read rights for that page
204 $user = $this->getUser();
205 $status = Status::newGood();
206 /** @var Title $title */
207 foreach ( $pageSet->getGoodTitles() as $title ) {
208 if ( !$title->userCan( 'read', $user ) ) {
209 $status->fatal( ApiMessage::create(
210 [ 'apierror-cannotviewtitle', wfEscapeWikiText( $title->getPrefixedText() ) ],
211 'accessdenied'
212 ) );
213 }
214 }
215 if ( !$status->isGood() ) {
216 $this->dieStatus( $status );
217 }
218 }
219
220 if ( $enumRevMode ) {
221 // Indexes targeted:
222 // page_timestamp if we don't have rvuser
223 // page_actor_timestamp (on revision_actor_temp) if we have rvuser in READ_NEW mode
224 // page_user_timestamp if we have a logged-in rvuser
225 // page_timestamp or usertext_timestamp if we have an IP rvuser
226
227 // This is mostly to prevent parameter errors (and optimize SQL?)
228 $this->requireMaxOneParameter( $params, 'startid', 'start' );
229 $this->requireMaxOneParameter( $params, 'endid', 'end' );
230 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
231
232 if ( $params['continue'] !== null ) {
233 $cont = explode( '|', $params['continue'] );
234 $this->dieContinueUsageIf( count( $cont ) != 2 );
235 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
236 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
237 $continueId = (int)$cont[1];
238 $this->dieContinueUsageIf( $continueId != $cont[1] );
239 $this->addWhere( "$tsField $op $continueTimestamp OR " .
240 "($tsField = $continueTimestamp AND " .
241 "$idField $op= $continueId)"
242 );
243 }
244
245 // Convert startid/endid to timestamps (T163532)
246 $revids = [];
247 if ( $params['startid'] !== null ) {
248 $revids[] = (int)$params['startid'];
249 }
250 if ( $params['endid'] !== null ) {
251 $revids[] = (int)$params['endid'];
252 }
253 if ( $revids ) {
254 $db = $this->getDB();
255 $sql = $db->unionQueries( [
256 $db->selectSQLText(
257 'revision',
258 [ 'id' => 'rev_id', 'ts' => 'rev_timestamp' ],
259 [ 'rev_id' => $revids ],
260 __METHOD__
261 ),
262 $db->selectSQLText(
263 'archive',
264 [ 'id' => 'ar_rev_id', 'ts' => 'ar_timestamp' ],
265 [ 'ar_rev_id' => $revids ],
266 __METHOD__
267 ),
268 ], $db::UNION_DISTINCT );
269 $res = $db->query( $sql, __METHOD__ );
270 foreach ( $res as $row ) {
271 if ( (int)$row->id === (int)$params['startid'] ) {
272 $params['start'] = $row->ts;
273 }
274 if ( (int)$row->id === (int)$params['endid'] ) {
275 $params['end'] = $row->ts;
276 }
277 }
278 if ( $params['startid'] !== null && $params['start'] === null ) {
279 $p = $this->encodeParamName( 'startid' );
280 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
281 }
282 if ( $params['endid'] !== null && $params['end'] === null ) {
283 $p = $this->encodeParamName( 'endid' );
284 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
285 }
286
287 if ( $params['start'] !== null ) {
288 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
289 $ts = $db->addQuotes( $db->timestampOrNull( $params['start'] ) );
290 if ( $params['startid'] !== null ) {
291 $this->addWhere( "$tsField $op $ts OR "
292 . "$tsField = $ts AND $idField $op= " . (int)$params['startid'] );
293 } else {
294 $this->addWhere( "$tsField $op= $ts" );
295 }
296 }
297 if ( $params['end'] !== null ) {
298 $op = ( $params['dir'] === 'newer' ? '<' : '>' ); // Yes, opposite of the above
299 $ts = $db->addQuotes( $db->timestampOrNull( $params['end'] ) );
300 if ( $params['endid'] !== null ) {
301 $this->addWhere( "$tsField $op $ts OR "
302 . "$tsField = $ts AND $idField $op= " . (int)$params['endid'] );
303 } else {
304 $this->addWhere( "$tsField $op= $ts" );
305 }
306 }
307 } else {
308 $this->addTimestampWhereRange( $tsField, $params['dir'],
309 $params['start'], $params['end'] );
310 }
311
312 $sort = ( $params['dir'] === 'newer' ? '' : 'DESC' );
313 $this->addOption( 'ORDER BY', [ "rev_timestamp $sort", "rev_id $sort" ] );
314
315 // There is only one ID, use it
316 $ids = array_keys( $pageSet->getGoodTitles() );
317 $this->addWhereFld( $pageField, reset( $ids ) );
318
319 if ( $params['user'] !== null ) {
320 $actorQuery = ActorMigration::newMigration()
321 ->getWhere( $db, 'rev_user', User::newFromName( $params['user'], false ) );
322 $this->addTables( $actorQuery['tables'] );
323 $this->addJoinConds( $actorQuery['joins'] );
324 $this->addWhere( $actorQuery['conds'] );
325 } elseif ( $params['excludeuser'] !== null ) {
326 $actorQuery = ActorMigration::newMigration()
327 ->getWhere( $db, 'rev_user', User::newFromName( $params['excludeuser'], false ) );
328 $this->addTables( $actorQuery['tables'] );
329 $this->addJoinConds( $actorQuery['joins'] );
330 $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
331 }
332 if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
333 // Paranoia: avoid brute force searches (T19342)
334 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
335 $bitmask = RevisionRecord::DELETED_USER;
336 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
337 $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
338 } else {
339 $bitmask = 0;
340 }
341 if ( $bitmask ) {
342 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
343 }
344 }
345 } elseif ( $revCount > 0 ) {
346 // Always targets the PRIMARY index
347
348 $revs = $pageSet->getLiveRevisionIDs();
349
350 // Get all revision IDs
351 $this->addWhereFld( 'rev_id', array_keys( $revs ) );
352
353 if ( $params['continue'] !== null ) {
354 $this->addWhere( 'rev_id >= ' . (int)$params['continue'] );
355 }
356 $this->addOption( 'ORDER BY', 'rev_id' );
357 } elseif ( $pageCount > 0 ) {
358 // Always targets the rev_page_id index
359
360 $titles = $pageSet->getGoodTitles();
361
362 // When working in multi-page non-enumeration mode,
363 // limit to the latest revision only
364 $this->addWhere( 'page_latest=rev_id' );
365
366 // Get all page IDs
367 $this->addWhereFld( 'page_id', array_keys( $titles ) );
368 // Every time someone relies on equality propagation, god kills a kitten :)
369 $this->addWhereFld( 'rev_page', array_keys( $titles ) );
370
371 if ( $params['continue'] !== null ) {
372 $cont = explode( '|', $params['continue'] );
373 $this->dieContinueUsageIf( count( $cont ) != 2 );
374 $pageid = (int)$cont[0];
375 $revid = (int)$cont[1];
376 $this->addWhere(
377 "rev_page > $pageid OR " .
378 "(rev_page = $pageid AND " .
379 "rev_id >= $revid)"
380 );
381 }
382 $this->addOption( 'ORDER BY', [
383 'rev_page',
384 'rev_id'
385 ] );
386 } else {
387 ApiBase::dieDebug( __METHOD__, 'param validation?' );
388 }
389
390 $this->addOption( 'LIMIT', $this->limit + 1 );
391
392 $count = 0;
393 $generated = [];
394 $hookData = [];
395 $res = $this->select( __METHOD__, [], $hookData );
396
397 foreach ( $res as $row ) {
398 if ( ++$count > $this->limit ) {
399 // We've reached the one extra which shows that there are
400 // additional pages to be had. Stop here...
401 if ( $enumRevMode ) {
402 $this->setContinueEnumParameter( 'continue',
403 $row->rev_timestamp . '|' . (int)$row->rev_id );
404 } elseif ( $revCount > 0 ) {
405 $this->setContinueEnumParameter( 'continue', (int)$row->rev_id );
406 } else {
407 $this->setContinueEnumParameter( 'continue', (int)$row->rev_page .
408 '|' . (int)$row->rev_id );
409 }
410 break;
411 }
412
413 if ( $resultPageSet !== null ) {
414 $generated[] = $row->rev_id;
415 } else {
416 $revision = $revisionStore->newRevisionFromRow( $row );
417 $rev = $this->extractRevisionInfo( $revision, $row );
418
419 if ( $this->token !== null ) {
420 $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
421 $revisionCompat = new Revision( $revision );
422 $tokenFunctions = $this->getTokenFunctions();
423 foreach ( $this->token as $t ) {
424 $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revisionCompat );
425 if ( $val === false ) {
426 $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
427 } else {
428 $rev[$t . 'token'] = $val;
429 }
430 }
431 }
432
433 $fit = $this->processRow( $row, $rev, $hookData ) &&
434 $this->addPageSubItem( $row->rev_page, $rev, 'rev' );
435 if ( !$fit ) {
436 if ( $enumRevMode ) {
437 $this->setContinueEnumParameter( 'continue',
438 $row->rev_timestamp . '|' . (int)$row->rev_id );
439 } elseif ( $revCount > 0 ) {
440 $this->setContinueEnumParameter( 'continue', (int)$row->rev_id );
441 } else {
442 $this->setContinueEnumParameter( 'continue', (int)$row->rev_page .
443 '|' . (int)$row->rev_id );
444 }
445 break;
446 }
447 }
448 }
449
450 if ( $resultPageSet !== null ) {
451 $resultPageSet->populateFromRevisionIDs( $generated );
452 }
453 }
454
455 public function getCacheMode( $params ) {
456 if ( isset( $params['token'] ) ) {
457 return 'private';
458 }
459 return parent::getCacheMode( $params );
460 }
461
462 public function getAllowedParams() {
463 $ret = parent::getAllowedParams() + [
464 'startid' => [
465 ApiBase::PARAM_TYPE => 'integer',
466 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
467 ],
468 'endid' => [
469 ApiBase::PARAM_TYPE => 'integer',
470 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
471 ],
472 'start' => [
473 ApiBase::PARAM_TYPE => 'timestamp',
474 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
475 ],
476 'end' => [
477 ApiBase::PARAM_TYPE => 'timestamp',
478 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
479 ],
480 'dir' => [
481 ApiBase::PARAM_DFLT => 'older',
482 ApiBase::PARAM_TYPE => [
483 'newer',
484 'older'
485 ],
486 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
487 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
488 ],
489 'user' => [
490 ApiBase::PARAM_TYPE => 'user',
491 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
492 ],
493 'excludeuser' => [
494 ApiBase::PARAM_TYPE => 'user',
495 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
496 ],
497 'tag' => null,
498 'token' => [
499 ApiBase::PARAM_DEPRECATED => true,
500 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
501 ApiBase::PARAM_ISMULTI => true
502 ],
503 'continue' => [
504 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
505 ],
506 ];
507
508 $ret['limit'][ApiBase::PARAM_HELP_MSG_INFO] = [ [ 'singlepageonly' ] ];
509
510 return $ret;
511 }
512
513 protected function getExamplesMessages() {
514 return [
515 'action=query&prop=revisions&titles=API|Main%20Page&' .
516 'rvslots=*&rvprop=timestamp|user|comment|content'
517 => 'apihelp-query+revisions-example-content',
518 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
519 'rvprop=timestamp|user|comment'
520 => 'apihelp-query+revisions-example-last5',
521 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
522 'rvprop=timestamp|user|comment&rvdir=newer'
523 => 'apihelp-query+revisions-example-first5',
524 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
525 'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
526 => 'apihelp-query+revisions-example-first5-after',
527 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
528 'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
529 => 'apihelp-query+revisions-example-first5-not-localhost',
530 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
531 'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
532 => 'apihelp-query+revisions-example-first5-user',
533 ];
534 }
535
536 public function getHelpUrls() {
537 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions';
538 }
539 }