Merge "Add MessagesBi.php"
[lhc/web/wiklou.git] / includes / api / ApiQueryDeletedrevs.php
1 <?php
2 /**
3 * Copyright © 2007 Roan Kattouw "<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\Storage\NameTableAccessException;
25
26 /**
27 * Query module to enumerate all deleted revisions.
28 *
29 * @ingroup API
30 * @deprecated since 1.25
31 */
32 class ApiQueryDeletedrevs extends ApiQueryBase {
33
34 public function __construct( ApiQuery $query, $moduleName ) {
35 parent::__construct( $query, $moduleName, 'dr' );
36 }
37
38 public function execute() {
39 global $wgChangeTagsSchemaMigrationStage;
40
41 // Before doing anything at all, let's check permissions
42 $this->checkUserRightsAny( 'deletedhistory' );
43
44 $this->addDeprecation( 'apiwarn-deprecation-deletedrevs', 'action=query&list=deletedrevs' );
45
46 $user = $this->getUser();
47 $db = $this->getDB();
48 $commentStore = CommentStore::getStore();
49 $params = $this->extractRequestParams( false );
50 $prop = array_flip( $params['prop'] );
51 $fld_parentid = isset( $prop['parentid'] );
52 $fld_revid = isset( $prop['revid'] );
53 $fld_user = isset( $prop['user'] );
54 $fld_userid = isset( $prop['userid'] );
55 $fld_comment = isset( $prop['comment'] );
56 $fld_parsedcomment = isset( $prop['parsedcomment'] );
57 $fld_minor = isset( $prop['minor'] );
58 $fld_len = isset( $prop['len'] );
59 $fld_sha1 = isset( $prop['sha1'] );
60 $fld_content = isset( $prop['content'] );
61 $fld_token = isset( $prop['token'] );
62 $fld_tags = isset( $prop['tags'] );
63
64 if ( isset( $prop['token'] ) ) {
65 $p = $this->getModulePrefix();
66 }
67
68 // If we're in a mode that breaks the same-origin policy, no tokens can
69 // be obtained
70 if ( $this->lacksSameOriginSecurity() ) {
71 $fld_token = false;
72 }
73
74 // If user can't undelete, no tokens
75 if ( !$user->isAllowed( 'undelete' ) ) {
76 $fld_token = false;
77 }
78
79 $result = $this->getResult();
80 $pageSet = $this->getPageSet();
81 $titles = $pageSet->getTitles();
82
83 // This module operates in three modes:
84 // 'revs': List deleted revs for certain titles (1)
85 // 'user': List deleted revs by a certain user (2)
86 // 'all': List all deleted revs in NS (3)
87 $mode = 'all';
88 if ( count( $titles ) > 0 ) {
89 $mode = 'revs';
90 } elseif ( !is_null( $params['user'] ) ) {
91 $mode = 'user';
92 }
93
94 if ( $mode == 'revs' || $mode == 'user' ) {
95 // Ignore namespace and unique due to inability to know whether they were purposely set
96 foreach ( [ 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ] as $p ) {
97 if ( !is_null( $params[$p] ) ) {
98 $this->dieWithError( [ 'apierror-deletedrevs-param-not-1-2', $p ], 'badparams' );
99 }
100 }
101 } else {
102 foreach ( [ 'start', 'end' ] as $p ) {
103 if ( !is_null( $params[$p] ) ) {
104 $this->dieWithError( [ 'apierror-deletedrevs-param-not-3', $p ], 'badparams' );
105 }
106 }
107 }
108
109 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
110 $this->dieWithError( 'user and excludeuser cannot be used together', 'badparams' );
111 }
112
113 $this->addTables( 'archive' );
114 $this->addFields( [ 'ar_title', 'ar_namespace', 'ar_timestamp', 'ar_deleted', 'ar_id' ] );
115
116 $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
117 $this->addFieldsIf( 'ar_rev_id', $fld_revid );
118 if ( $fld_user || $fld_userid ) {
119 $actorQuery = ActorMigration::newMigration()->getJoin( 'ar_user' );
120 $this->addTables( $actorQuery['tables'] );
121 $this->addFields( $actorQuery['fields'] );
122 $this->addJoinConds( $actorQuery['joins'] );
123 }
124 $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
125 $this->addFieldsIf( 'ar_len', $fld_len );
126 $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
127
128 if ( $fld_comment || $fld_parsedcomment ) {
129 $commentQuery = $commentStore->getJoin( 'ar_comment' );
130 $this->addTables( $commentQuery['tables'] );
131 $this->addFields( $commentQuery['fields'] );
132 $this->addJoinConds( $commentQuery['joins'] );
133 }
134
135 if ( $fld_tags ) {
136 $this->addTables( 'tag_summary' );
137 $this->addJoinConds(
138 [ 'tag_summary' => [ 'LEFT JOIN', [ 'ar_rev_id=ts_rev_id' ] ] ]
139 );
140 $this->addFields( 'ts_tags' );
141 }
142
143 if ( !is_null( $params['tag'] ) ) {
144 $this->addTables( 'change_tag' );
145 $this->addJoinConds(
146 [ 'change_tag' => [ 'INNER JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
147 );
148 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH ) {
149 $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
150 try {
151 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
152 } catch ( NameTableAccessException $exception ) {
153 // Return nothing.
154 $this->addWhere( '1=0' );
155 }
156 } else {
157 $this->addWhereFld( 'ct_tag', $params['tag'] );
158 }
159 }
160
161 if ( $fld_content ) {
162 $this->addTables( 'text' );
163 $this->addJoinConds(
164 [ 'text' => [ 'LEFT JOIN', [ 'ar_text_id=old_id' ] ] ]
165 );
166 $this->addFields( [ 'ar_text_id', 'old_text', 'old_flags' ] );
167
168 // This also means stricter restrictions
169 $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
170 }
171 // Check limits
172 $userMax = $fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1;
173 $botMax = $fld_content ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2;
174
175 $limit = $params['limit'];
176
177 if ( $limit == 'max' ) {
178 $limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
179 $this->getResult()->addParsedLimit( $this->getModuleName(), $limit );
180 }
181
182 $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
183
184 if ( $fld_token ) {
185 // Undelete tokens are identical for all pages, so we cache one here
186 $token = $user->getEditToken( '', $this->getMain()->getRequest() );
187 }
188
189 $dir = $params['dir'];
190
191 // We need a custom WHERE clause that matches all titles.
192 if ( $mode == 'revs' ) {
193 $lb = new LinkBatch( $titles );
194 $where = $lb->constructSet( 'ar', $db );
195 $this->addWhere( $where );
196 } elseif ( $mode == 'all' ) {
197 $this->addWhereFld( 'ar_namespace', $params['namespace'] );
198
199 $from = $params['from'] === null
200 ? null
201 : $this->titlePartToKey( $params['from'], $params['namespace'] );
202 $to = $params['to'] === null
203 ? null
204 : $this->titlePartToKey( $params['to'], $params['namespace'] );
205 $this->addWhereRange( 'ar_title', $dir, $from, $to );
206
207 if ( isset( $params['prefix'] ) ) {
208 $this->addWhere( 'ar_title' . $db->buildLike(
209 $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
210 $db->anyString() ) );
211 }
212 }
213
214 if ( !is_null( $params['user'] ) ) {
215 // Don't query by user ID here, it might be able to use the ar_usertext_timestamp index.
216 $actorQuery = ActorMigration::newMigration()
217 ->getWhere( $db, 'ar_user', User::newFromName( $params['user'], false ), false );
218 $this->addTables( $actorQuery['tables'] );
219 $this->addJoinConds( $actorQuery['joins'] );
220 $this->addWhere( $actorQuery['conds'] );
221 } elseif ( !is_null( $params['excludeuser'] ) ) {
222 // Here there's no chance of using ar_usertext_timestamp.
223 $actorQuery = ActorMigration::newMigration()
224 ->getWhere( $db, 'ar_user', User::newFromName( $params['excludeuser'], false ) );
225 $this->addTables( $actorQuery['tables'] );
226 $this->addJoinConds( $actorQuery['joins'] );
227 $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
228 }
229
230 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
231 // Paranoia: avoid brute force searches (T19342)
232 // (shouldn't be able to get here without 'deletedhistory', but
233 // check it again just in case)
234 if ( !$user->isAllowed( 'deletedhistory' ) ) {
235 $bitmask = Revision::DELETED_USER;
236 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
237 $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
238 } else {
239 $bitmask = 0;
240 }
241 if ( $bitmask ) {
242 $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
243 }
244 }
245
246 if ( !is_null( $params['continue'] ) ) {
247 $cont = explode( '|', $params['continue'] );
248 $op = ( $dir == 'newer' ? '>' : '<' );
249 if ( $mode == 'all' || $mode == 'revs' ) {
250 $this->dieContinueUsageIf( count( $cont ) != 4 );
251 $ns = intval( $cont[0] );
252 $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
253 $title = $db->addQuotes( $cont[1] );
254 $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
255 $ar_id = (int)$cont[3];
256 $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
257 $this->addWhere( "ar_namespace $op $ns OR " .
258 "(ar_namespace = $ns AND " .
259 "(ar_title $op $title OR " .
260 "(ar_title = $title AND " .
261 "(ar_timestamp $op $ts OR " .
262 "(ar_timestamp = $ts AND " .
263 "ar_id $op= $ar_id)))))" );
264 } else {
265 $this->dieContinueUsageIf( count( $cont ) != 2 );
266 $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
267 $ar_id = (int)$cont[1];
268 $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
269 $this->addWhere( "ar_timestamp $op $ts OR " .
270 "(ar_timestamp = $ts AND " .
271 "ar_id $op= $ar_id)" );
272 }
273 }
274
275 $this->addOption( 'LIMIT', $limit + 1 );
276 if ( $mode == 'all' ) {
277 if ( $params['unique'] ) {
278 // @todo Does this work on non-MySQL?
279 $this->addOption( 'GROUP BY', 'ar_title' );
280 } else {
281 $sort = ( $dir == 'newer' ? '' : ' DESC' );
282 $this->addOption( 'ORDER BY', [
283 'ar_title' . $sort,
284 'ar_timestamp' . $sort,
285 'ar_id' . $sort,
286 ] );
287 }
288 } else {
289 if ( $mode == 'revs' ) {
290 // Sort by ns and title in the same order as timestamp for efficiency
291 $this->addWhereRange( 'ar_namespace', $dir, null, null );
292 $this->addWhereRange( 'ar_title', $dir, null, null );
293 }
294 $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
295 // Include in ORDER BY for uniqueness
296 $this->addWhereRange( 'ar_id', $dir, null, null );
297 }
298 $res = $this->select( __METHOD__ );
299 $pageMap = []; // Maps ns&title to (fake) pageid
300 $count = 0;
301 $newPageID = 0;
302 foreach ( $res as $row ) {
303 if ( ++$count > $limit ) {
304 // We've had enough
305 if ( $mode == 'all' || $mode == 'revs' ) {
306 $this->setContinueEnumParameter( 'continue',
307 "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
308 );
309 } else {
310 $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
311 }
312 break;
313 }
314
315 $rev = [];
316 $anyHidden = false;
317
318 $rev['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ar_timestamp );
319 if ( $fld_revid ) {
320 $rev['revid'] = intval( $row->ar_rev_id );
321 }
322 if ( $fld_parentid && !is_null( $row->ar_parent_id ) ) {
323 $rev['parentid'] = intval( $row->ar_parent_id );
324 }
325 if ( $fld_user || $fld_userid ) {
326 if ( $row->ar_deleted & Revision::DELETED_USER ) {
327 $rev['userhidden'] = true;
328 $anyHidden = true;
329 }
330 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_USER, $user ) ) {
331 if ( $fld_user ) {
332 $rev['user'] = $row->ar_user_text;
333 }
334 if ( $fld_userid ) {
335 $rev['userid'] = (int)$row->ar_user;
336 }
337 }
338 }
339
340 if ( $fld_comment || $fld_parsedcomment ) {
341 if ( $row->ar_deleted & Revision::DELETED_COMMENT ) {
342 $rev['commenthidden'] = true;
343 $anyHidden = true;
344 }
345 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_COMMENT, $user ) ) {
346 $comment = $commentStore->getComment( 'ar_comment', $row )->text;
347 if ( $fld_comment ) {
348 $rev['comment'] = $comment;
349 }
350 if ( $fld_parsedcomment ) {
351 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
352 $rev['parsedcomment'] = Linker::formatComment( $comment, $title );
353 }
354 }
355 }
356
357 if ( $fld_minor ) {
358 $rev['minor'] = $row->ar_minor_edit == 1;
359 }
360 if ( $fld_len ) {
361 $rev['len'] = $row->ar_len;
362 }
363 if ( $fld_sha1 ) {
364 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
365 $rev['sha1hidden'] = true;
366 $anyHidden = true;
367 }
368 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
369 if ( $row->ar_sha1 != '' ) {
370 $rev['sha1'] = Wikimedia\base_convert( $row->ar_sha1, 36, 16, 40 );
371 } else {
372 $rev['sha1'] = '';
373 }
374 }
375 }
376 if ( $fld_content ) {
377 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
378 $rev['texthidden'] = true;
379 $anyHidden = true;
380 }
381 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
382 ApiResult::setContentValue( $rev, 'text', Revision::getRevisionText( $row ) );
383 }
384 }
385
386 if ( $fld_tags ) {
387 if ( $row->ts_tags ) {
388 $tags = explode( ',', $row->ts_tags );
389 ApiResult::setIndexedTagName( $tags, 'tag' );
390 $rev['tags'] = $tags;
391 } else {
392 $rev['tags'] = [];
393 }
394 }
395
396 if ( $anyHidden && ( $row->ar_deleted & Revision::DELETED_RESTRICTED ) ) {
397 $rev['suppressed'] = true;
398 }
399
400 if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
401 $pageID = $newPageID++;
402 $pageMap[$row->ar_namespace][$row->ar_title] = $pageID;
403 $a['revisions'] = [ $rev ];
404 ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
405 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
406 ApiQueryBase::addTitleInfo( $a, $title );
407 if ( $fld_token ) {
408 $a['token'] = $token;
409 }
410 $fit = $result->addValue( [ 'query', $this->getModuleName() ], $pageID, $a );
411 } else {
412 $pageID = $pageMap[$row->ar_namespace][$row->ar_title];
413 $fit = $result->addValue(
414 [ 'query', $this->getModuleName(), $pageID, 'revisions' ],
415 null, $rev );
416 }
417 if ( !$fit ) {
418 if ( $mode == 'all' || $mode == 'revs' ) {
419 $this->setContinueEnumParameter( 'continue',
420 "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
421 );
422 } else {
423 $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
424 }
425 break;
426 }
427 }
428 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
429 }
430
431 public function isDeprecated() {
432 return true;
433 }
434
435 public function getAllowedParams() {
436 return [
437 'start' => [
438 ApiBase::PARAM_TYPE => 'timestamp',
439 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
440 ],
441 'end' => [
442 ApiBase::PARAM_TYPE => 'timestamp',
443 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
444 ],
445 'dir' => [
446 ApiBase::PARAM_TYPE => [
447 'newer',
448 'older'
449 ],
450 ApiBase::PARAM_DFLT => 'older',
451 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
452 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 3 ] ],
453 ],
454 'from' => [
455 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
456 ],
457 'to' => [
458 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
459 ],
460 'prefix' => [
461 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
462 ],
463 'unique' => [
464 ApiBase::PARAM_DFLT => false,
465 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
466 ],
467 'namespace' => [
468 ApiBase::PARAM_TYPE => 'namespace',
469 ApiBase::PARAM_DFLT => NS_MAIN,
470 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
471 ],
472 'tag' => null,
473 'user' => [
474 ApiBase::PARAM_TYPE => 'user'
475 ],
476 'excludeuser' => [
477 ApiBase::PARAM_TYPE => 'user'
478 ],
479 'prop' => [
480 ApiBase::PARAM_DFLT => 'user|comment',
481 ApiBase::PARAM_TYPE => [
482 'revid',
483 'parentid',
484 'user',
485 'userid',
486 'comment',
487 'parsedcomment',
488 'minor',
489 'len',
490 'sha1',
491 'content',
492 'token',
493 'tags'
494 ],
495 ApiBase::PARAM_ISMULTI => true
496 ],
497 'limit' => [
498 ApiBase::PARAM_DFLT => 10,
499 ApiBase::PARAM_TYPE => 'limit',
500 ApiBase::PARAM_MIN => 1,
501 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
502 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
503 ],
504 'continue' => [
505 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
506 ],
507 ];
508 }
509
510 protected function getExamplesMessages() {
511 return [
512 'action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
513 'drprop=user|comment|content'
514 => 'apihelp-query+deletedrevs-example-mode1',
515 'action=query&list=deletedrevs&druser=Bob&drlimit=50'
516 => 'apihelp-query+deletedrevs-example-mode2',
517 'action=query&list=deletedrevs&drdir=newer&drlimit=50'
518 => 'apihelp-query+deletedrevs-example-mode3-main',
519 'action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
520 => 'apihelp-query+deletedrevs-example-mode3-talk',
521 ];
522 }
523
524 public function getHelpUrls() {
525 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Deletedrevs';
526 }
527 }