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