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