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