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