Merge "Set a title for the context during import on the cli"
[lhc/web/wiklou.git] / includes / api / ApiQueryDeletedrevs.php
1 <?php
2 /**
3 *
4 *
5 * Created on Jul 2, 2007
6 *
7 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
23 *
24 * @file
25 */
26
27 /**
28 * Query module to enumerate all deleted revisions.
29 *
30 * @ingroup API
31 */
32 class ApiQueryDeletedrevs extends ApiQueryBase {
33
34 public function __construct( $query, $moduleName ) {
35 parent::__construct( $query, $moduleName, 'dr' );
36 }
37
38 public function execute() {
39 $user = $this->getUser();
40 // Before doing anything at all, let's check permissions
41 if ( !$user->isAllowed( 'deletedhistory' ) ) {
42 $this->dieUsage(
43 'You don\'t have permission to view deleted revision information',
44 'permissiondenied'
45 );
46 }
47
48 $db = $this->getDB();
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 we're in JSON callback mode, no tokens can be obtained
65 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
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 ( array( 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ) as $p ) {
92 if ( !is_null( $params[$p] ) ) {
93 $this->dieUsage( "The '{$p}' parameter cannot be used in modes 1 or 2", 'badparams' );
94 }
95 }
96 } else {
97 foreach ( array( 'start', 'end' ) as $p ) {
98 if ( !is_null( $params[$p] ) ) {
99 $this->dieUsage( "The {$p} parameter cannot be used in mode 3", 'badparams' );
100 }
101 }
102 }
103
104 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
105 $this->dieUsage( 'user and excludeuser cannot be used together', 'badparams' );
106 }
107
108 $this->addTables( 'archive' );
109 $this->addFields( array( 'ar_title', 'ar_namespace', 'ar_timestamp', 'ar_deleted' ) );
110
111 $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
112 $this->addFieldsIf( 'ar_rev_id', $fld_revid );
113 $this->addFieldsIf( 'ar_user_text', $fld_user );
114 $this->addFieldsIf( 'ar_user', $fld_userid );
115 $this->addFieldsIf( 'ar_comment', $fld_comment || $fld_parsedcomment );
116 $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
117 $this->addFieldsIf( 'ar_len', $fld_len );
118 $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
119
120 if ( $fld_tags ) {
121 $this->addTables( 'tag_summary' );
122 $this->addJoinConds(
123 array( 'tag_summary' => array( 'LEFT JOIN', array( 'ar_rev_id=ts_rev_id' ) ) )
124 );
125 $this->addFields( 'ts_tags' );
126 }
127
128 if ( !is_null( $params['tag'] ) ) {
129 $this->addTables( 'change_tag' );
130 $this->addJoinConds(
131 array( 'change_tag' => array( 'INNER JOIN', array( 'ar_rev_id=ct_rev_id' ) ) )
132 );
133 $this->addWhereFld( 'ct_tag', $params['tag'] );
134 }
135
136 if ( $fld_content ) {
137 $this->addTables( 'text' );
138 $this->addJoinConds(
139 array( 'text' => array( 'INNER JOIN', array( 'ar_text_id=old_id' ) ) )
140 );
141 $this->addFields( array( 'ar_text', 'ar_text_id', 'old_text', 'old_flags' ) );
142
143 // This also means stricter restrictions
144 if ( !$user->isAllowedAny( 'undelete', 'deletedtext' ) ) {
145 $this->dieUsage(
146 'You don\'t have permission to view deleted revision content',
147 'permissiondenied'
148 );
149 }
150 }
151 // Check limits
152 $userMax = $fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1;
153 $botMax = $fld_content ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2;
154
155 $limit = $params['limit'];
156
157 if ( $limit == 'max' ) {
158 $limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
159 $this->getResult()->setParsedLimit( $this->getModuleName(), $limit );
160 }
161
162 $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
163
164 if ( $fld_token ) {
165 // Undelete tokens are identical for all pages, so we cache one here
166 $token = $user->getEditToken( '', $this->getMain()->getRequest() );
167 }
168
169 $dir = $params['dir'];
170
171 // We need a custom WHERE clause that matches all titles.
172 if ( $mode == 'revs' ) {
173 $lb = new LinkBatch( $titles );
174 $where = $lb->constructSet( 'ar', $db );
175 $this->addWhere( $where );
176 } elseif ( $mode == 'all' ) {
177 $this->addWhereFld( 'ar_namespace', $params['namespace'] );
178
179 $from = $params['from'] === null
180 ? null
181 : $this->titlePartToKey( $params['from'], $params['namespace'] );
182 $to = $params['to'] === null
183 ? null
184 : $this->titlePartToKey( $params['to'], $params['namespace'] );
185 $this->addWhereRange( 'ar_title', $dir, $from, $to );
186
187 if ( isset( $params['prefix'] ) ) {
188 $this->addWhere( 'ar_title' . $db->buildLike(
189 $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
190 $db->anyString() ) );
191 }
192 }
193
194 if ( !is_null( $params['user'] ) ) {
195 $this->addWhereFld( 'ar_user_text', $params['user'] );
196 } elseif ( !is_null( $params['excludeuser'] ) ) {
197 $this->addWhere( 'ar_user_text != ' .
198 $db->addQuotes( $params['excludeuser'] ) );
199 }
200
201 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
202 // Paranoia: avoid brute force searches (bug 17342)
203 // (shouldn't be able to get here without 'deletedhistory', but
204 // check it again just in case)
205 if ( !$user->isAllowed( 'deletedhistory' ) ) {
206 $bitmask = Revision::DELETED_USER;
207 } elseif ( !$user->isAllowed( 'suppressrevision' ) ) {
208 $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
209 } else {
210 $bitmask = 0;
211 }
212 if ( $bitmask ) {
213 $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
214 }
215 }
216
217 if ( !is_null( $params['continue'] ) && ( $mode == 'all' || $mode == 'revs' ) ) {
218 $cont = explode( '|', $params['continue'] );
219 $this->dieContinueUsageIf( count( $cont ) != 3 );
220 $ns = intval( $cont[0] );
221 $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
222 $title = $db->addQuotes( $cont[1] );
223 $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
224 $op = ( $dir == 'newer' ? '>' : '<' );
225 $this->addWhere( "ar_namespace $op $ns OR " .
226 "(ar_namespace = $ns AND " .
227 "(ar_title $op $title OR " .
228 "(ar_title = $title AND " .
229 "ar_timestamp $op= $ts)))" );
230 }
231
232 $this->addOption( 'LIMIT', $limit + 1 );
233 $this->addOption(
234 'USE INDEX',
235 array( 'archive' => ( $mode == 'user' ? 'usertext_timestamp' : 'name_title_timestamp' ) )
236 );
237 if ( $mode == 'all' ) {
238 if ( $params['unique'] ) {
239 $this->addOption( 'GROUP BY', 'ar_title' );
240 } else {
241 $sort = ( $dir == 'newer' ? '' : ' DESC' );
242 $this->addOption( 'ORDER BY', array(
243 'ar_title' . $sort,
244 'ar_timestamp' . $sort
245 ) );
246 }
247 } else {
248 if ( $mode == 'revs' ) {
249 // Sort by ns and title in the same order as timestamp for efficiency
250 $this->addWhereRange( 'ar_namespace', $dir, null, null );
251 $this->addWhereRange( 'ar_title', $dir, null, null );
252 }
253 $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
254 }
255 $res = $this->select( __METHOD__ );
256 $pageMap = array(); // Maps ns&title to (fake) pageid
257 $count = 0;
258 $newPageID = 0;
259 foreach ( $res as $row ) {
260 if ( ++$count > $limit ) {
261 // We've had enough
262 if ( $mode == 'all' || $mode == 'revs' ) {
263 $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace ) . '|' .
264 $row->ar_title . '|' . $row->ar_timestamp );
265 } else {
266 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->ar_timestamp ) );
267 }
268 break;
269 }
270
271 $rev = array();
272 $anyHidden = false;
273
274 $rev['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ar_timestamp );
275 if ( $fld_revid ) {
276 $rev['revid'] = intval( $row->ar_rev_id );
277 }
278 if ( $fld_parentid && !is_null( $row->ar_parent_id ) ) {
279 $rev['parentid'] = intval( $row->ar_parent_id );
280 }
281 if ( $fld_user || $fld_userid ) {
282 if ( $row->ar_deleted & Revision::DELETED_USER ) {
283 $rev['userhidden'] = '';
284 $anyHidden = true;
285 }
286 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_USER, $user ) ) {
287 if ( $fld_user ) {
288 $rev['user'] = $row->ar_user_text;
289 }
290 if ( $fld_userid ) {
291 $rev['userid'] = $row->ar_user;
292 }
293 }
294 }
295
296 if ( $fld_comment || $fld_parsedcomment ) {
297 if ( $row->ar_deleted & Revision::DELETED_COMMENT ) {
298 $rev['commenthidden'] = '';
299 $anyHidden = true;
300 }
301 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_COMMENT, $user ) ) {
302 if ( $fld_comment ) {
303 $rev['comment'] = $row->ar_comment;
304 }
305 if ( $fld_parsedcomment ) {
306 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
307 $rev['parsedcomment'] = Linker::formatComment( $row->ar_comment, $title );
308 }
309 }
310 }
311
312 if ( $fld_minor && $row->ar_minor_edit == 1 ) {
313 $rev['minor'] = '';
314 }
315 if ( $fld_len ) {
316 $rev['len'] = $row->ar_len;
317 }
318 if ( $fld_sha1 ) {
319 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
320 $rev['sha1hidden'] = '';
321 $anyHidden = true;
322 }
323 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
324 if ( $row->ar_sha1 != '' ) {
325 $rev['sha1'] = wfBaseConvert( $row->ar_sha1, 36, 16, 40 );
326 } else {
327 $rev['sha1'] = '';
328 }
329 }
330 }
331 if ( $fld_content ) {
332 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
333 $rev['texthidden'] = '';
334 $anyHidden = true;
335 }
336 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
337 ApiResult::setContent( $rev, Revision::getRevisionText( $row ) );
338 }
339 }
340
341 if ( $fld_tags ) {
342 if ( $row->ts_tags ) {
343 $tags = explode( ',', $row->ts_tags );
344 $this->getResult()->setIndexedTagName( $tags, 'tag' );
345 $rev['tags'] = $tags;
346 } else {
347 $rev['tags'] = array();
348 }
349 }
350
351 if ( $anyHidden && ( $row->ar_deleted & Revision::DELETED_RESTRICTED ) ) {
352 $rev['suppressed'] = '';
353 }
354
355 if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
356 $pageID = $newPageID++;
357 $pageMap[$row->ar_namespace][$row->ar_title] = $pageID;
358 $a['revisions'] = array( $rev );
359 $result->setIndexedTagName( $a['revisions'], 'rev' );
360 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
361 ApiQueryBase::addTitleInfo( $a, $title );
362 if ( $fld_token ) {
363 $a['token'] = $token;
364 }
365 $fit = $result->addValue( array( 'query', $this->getModuleName() ), $pageID, $a );
366 } else {
367 $pageID = $pageMap[$row->ar_namespace][$row->ar_title];
368 $fit = $result->addValue(
369 array( 'query', $this->getModuleName(), $pageID, 'revisions' ),
370 null, $rev );
371 }
372 if ( !$fit ) {
373 if ( $mode == 'all' || $mode == 'revs' ) {
374 $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace ) . '|' .
375 $row->ar_title . '|' . $row->ar_timestamp );
376 } else {
377 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->ar_timestamp ) );
378 }
379 break;
380 }
381 }
382 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
383 }
384
385 public function getAllowedParams() {
386 return array(
387 'start' => array(
388 ApiBase::PARAM_TYPE => 'timestamp'
389 ),
390 'end' => array(
391 ApiBase::PARAM_TYPE => 'timestamp',
392 ),
393 'dir' => array(
394 ApiBase::PARAM_TYPE => array(
395 'newer',
396 'older'
397 ),
398 ApiBase::PARAM_DFLT => 'older'
399 ),
400 'from' => null,
401 'to' => null,
402 'prefix' => null,
403 'continue' => null,
404 'unique' => false,
405 'tag' => null,
406 'user' => array(
407 ApiBase::PARAM_TYPE => 'user'
408 ),
409 'excludeuser' => array(
410 ApiBase::PARAM_TYPE => 'user'
411 ),
412 'namespace' => array(
413 ApiBase::PARAM_TYPE => 'namespace',
414 ApiBase::PARAM_DFLT => NS_MAIN,
415 ),
416 'limit' => array(
417 ApiBase::PARAM_DFLT => 10,
418 ApiBase::PARAM_TYPE => 'limit',
419 ApiBase::PARAM_MIN => 1,
420 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
421 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
422 ),
423 'prop' => array(
424 ApiBase::PARAM_DFLT => 'user|comment',
425 ApiBase::PARAM_TYPE => array(
426 'revid',
427 'parentid',
428 'user',
429 'userid',
430 'comment',
431 'parsedcomment',
432 'minor',
433 'len',
434 'sha1',
435 'content',
436 'token',
437 'tags'
438 ),
439 ApiBase::PARAM_ISMULTI => true
440 ),
441 );
442 }
443
444 public function getParamDescription() {
445 return array(
446 'start' => 'The timestamp to start enumerating from (1, 2)',
447 'end' => 'The timestamp to stop enumerating at (1, 2)',
448 'dir' => $this->getDirectionDescription( $this->getModulePrefix(), ' (1, 3)' ),
449 'from' => 'Start listing at this title (3)',
450 'to' => 'Stop listing at this title (3)',
451 'prefix' => 'Search for all page titles that begin with this value (3)',
452 'limit' => 'The maximum amount of revisions to list',
453 'prop' => array(
454 'Which properties to get',
455 ' revid - Adds the revision ID of the deleted revision',
456 ' parentid - Adds the revision ID of the previous revision to the page',
457 ' user - Adds the user who made the revision',
458 ' userid - Adds the user ID whom made the revision',
459 ' comment - Adds the comment of the revision',
460 ' parsedcomment - Adds the parsed comment of the revision',
461 ' minor - Tags if the revision is minor',
462 ' len - Adds the length (bytes) of the revision',
463 ' sha1 - Adds the SHA-1 (base 16) of the revision',
464 ' content - Adds the content of the revision',
465 ' token - Gives the edit token',
466 ' tags - Tags for the revision',
467 ),
468 'namespace' => 'Only list pages in this namespace (3)',
469 'user' => 'Only list revisions by this user',
470 'excludeuser' => 'Don\'t list revisions by this user',
471 'continue' => 'When more results are available, use this to continue (1, 3)',
472 'unique' => 'List only one revision for each page (3)',
473 'tag' => 'Only list revisions tagged with this tag',
474 );
475 }
476
477 public function getResultProperties() {
478 return array(
479 '' => array(
480 'ns' => 'namespace',
481 'title' => 'string'
482 ),
483 'token' => array(
484 'token' => 'string'
485 )
486 );
487 }
488
489 public function getDescription() {
490 $p = $this->getModulePrefix();
491
492 return array(
493 'List deleted revisions.',
494 'Operates in three modes:',
495 ' 1) List deleted revisions for the given title(s), sorted by timestamp.',
496 ' 2) List deleted contributions for the given user, sorted by timestamp (no titles specified).',
497 " 3) List all deleted revisions in the given namespace, sorted by title and timestamp',
498 ' (no titles specified, {$p}user not set).",
499 'Certain parameters only apply to some modes and are ignored in others.',
500 'For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3.',
501 );
502 }
503
504 public function getPossibleErrors() {
505 return array_merge( parent::getPossibleErrors(), array(
506 array(
507 'code' => 'permissiondenied',
508 'info' => 'You don\'t have permission to view deleted revision information'
509 ),
510 array( 'code' => 'badparams', 'info' => 'user and excludeuser cannot be used together'
511 ),
512 array(
513 'code' => 'permissiondenied',
514 'info' => 'You don\'t have permission to view deleted revision content'
515 ),
516 array( 'code' => 'badparams', 'info' => "The 'from' parameter cannot be used in modes 1 or 2" ),
517 array( 'code' => 'badparams', 'info' => "The 'to' parameter cannot be used in modes 1 or 2" ),
518 array(
519 'code' => 'badparams',
520 'info' => "The 'prefix' parameter cannot be used in modes 1 or 2"
521 ),
522 array( 'code' => 'badparams', 'info' => "The 'start' parameter cannot be used in mode 3" ),
523 array( 'code' => 'badparams', 'info' => "The 'end' parameter cannot be used in mode 3" ),
524 ) );
525 }
526
527 public function getExamples() {
528 return array(
529 'api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
530 'drprop=user|comment|content'
531 => 'List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1)',
532 'api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50'
533 => 'List the last 50 deleted contributions by Bob (mode 2)',
534 'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50'
535 => 'List the first 50 deleted revisions in the main namespace (mode 3)',
536 'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
537 => 'List the first 50 deleted pages in the Talk namespace (mode 3):',
538 );
539 }
540
541 public function getHelpUrls() {
542 return 'https://www.mediawiki.org/wiki/API:Deletedrevs';
543 }
544 }