Merge "Avoid undefined index when query old block logs with api"
[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 * @deprecated since 1.25
32 */
33 class ApiQueryDeletedrevs extends ApiQueryBase {
34
35 public function __construct( ApiQuery $query, $moduleName ) {
36 parent::__construct( $query, $moduleName, 'dr' );
37 }
38
39 public function execute() {
40 $user = $this->getUser();
41 // Before doing anything at all, let's check permissions
42 if ( !$user->isAllowed( 'deletedhistory' ) ) {
43 $this->dieUsage(
44 'You don\'t have permission to view deleted revision information',
45 'permissiondenied'
46 );
47 }
48
49 $this->setWarning(
50 'list=deletedrevs has been deprecated. Please use prop=deletedrevisions or ' .
51 'list=alldeletedrevisions instead.'
52 );
53 $this->logFeatureUsage( 'action=query&list=deletedrevs' );
54
55 $db = $this->getDB();
56 $params = $this->extractRequestParams( false );
57 $prop = array_flip( $params['prop'] );
58 $fld_parentid = isset( $prop['parentid'] );
59 $fld_revid = isset( $prop['revid'] );
60 $fld_user = isset( $prop['user'] );
61 $fld_userid = isset( $prop['userid'] );
62 $fld_comment = isset( $prop['comment'] );
63 $fld_parsedcomment = isset( $prop['parsedcomment'] );
64 $fld_minor = isset( $prop['minor'] );
65 $fld_len = isset( $prop['len'] );
66 $fld_sha1 = isset( $prop['sha1'] );
67 $fld_content = isset( $prop['content'] );
68 $fld_token = isset( $prop['token'] );
69 $fld_tags = isset( $prop['tags'] );
70
71 if ( isset( $prop['token'] ) ) {
72 $p = $this->getModulePrefix();
73 $this->setWarning(
74 "{$p}prop=token has been deprecated. Please use action=query&meta=tokens instead."
75 );
76 }
77
78 // If we're in JSON callback mode, no tokens can be obtained
79 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
80 $fld_token = false;
81 }
82
83 // If user can't undelete, no tokens
84 if ( !$user->isAllowed( 'undelete' ) ) {
85 $fld_token = false;
86 }
87
88 $result = $this->getResult();
89 $pageSet = $this->getPageSet();
90 $titles = $pageSet->getTitles();
91
92 // This module operates in three modes:
93 // 'revs': List deleted revs for certain titles (1)
94 // 'user': List deleted revs by a certain user (2)
95 // 'all': List all deleted revs in NS (3)
96 $mode = 'all';
97 if ( count( $titles ) > 0 ) {
98 $mode = 'revs';
99 } elseif ( !is_null( $params['user'] ) ) {
100 $mode = 'user';
101 }
102
103 if ( $mode == 'revs' || $mode == 'user' ) {
104 // Ignore namespace and unique due to inability to know whether they were purposely set
105 foreach ( array( 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ) as $p ) {
106 if ( !is_null( $params[$p] ) ) {
107 $this->dieUsage( "The '{$p}' parameter cannot be used in modes 1 or 2", 'badparams' );
108 }
109 }
110 } else {
111 foreach ( array( 'start', 'end' ) as $p ) {
112 if ( !is_null( $params[$p] ) ) {
113 $this->dieUsage( "The {$p} parameter cannot be used in mode 3", 'badparams' );
114 }
115 }
116 }
117
118 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
119 $this->dieUsage( 'user and excludeuser cannot be used together', 'badparams' );
120 }
121
122 $this->addTables( 'archive' );
123 $this->addFields( array( 'ar_title', 'ar_namespace', 'ar_timestamp', 'ar_deleted', 'ar_id' ) );
124
125 $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
126 $this->addFieldsIf( 'ar_rev_id', $fld_revid );
127 $this->addFieldsIf( 'ar_user_text', $fld_user );
128 $this->addFieldsIf( 'ar_user', $fld_userid );
129 $this->addFieldsIf( 'ar_comment', $fld_comment || $fld_parsedcomment );
130 $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
131 $this->addFieldsIf( 'ar_len', $fld_len );
132 $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
133
134 if ( $fld_tags ) {
135 $this->addTables( 'tag_summary' );
136 $this->addJoinConds(
137 array( 'tag_summary' => array( 'LEFT JOIN', array( 'ar_rev_id=ts_rev_id' ) ) )
138 );
139 $this->addFields( 'ts_tags' );
140 }
141
142 if ( !is_null( $params['tag'] ) ) {
143 $this->addTables( 'change_tag' );
144 $this->addJoinConds(
145 array( 'change_tag' => array( 'INNER JOIN', array( 'ar_rev_id=ct_rev_id' ) ) )
146 );
147 $this->addWhereFld( 'ct_tag', $params['tag'] );
148 }
149
150 if ( $fld_content ) {
151 // Modern MediaWiki has the content for deleted revs in the 'text'
152 // table using fields old_text and old_flags. But revisions deleted
153 // pre-1.5 store the content in the 'archive' table directly using
154 // fields ar_text and ar_flags, and no corresponding 'text' row. So
155 // we have to LEFT JOIN and fetch all four fields, plus ar_text_id
156 // to be able to tell the difference.
157 $this->addTables( 'text' );
158 $this->addJoinConds(
159 array( 'text' => array( 'LEFT JOIN', array( 'ar_text_id=old_id' ) ) )
160 );
161 $this->addFields( array( 'ar_text', 'ar_flags', 'ar_text_id', 'old_text', 'old_flags' ) );
162
163 // This also means stricter restrictions
164 if ( !$user->isAllowedAny( 'undelete', 'deletedtext' ) ) {
165 $this->dieUsage(
166 'You don\'t have permission to view deleted revision content',
167 'permissiondenied'
168 );
169 }
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()->setParsedLimit( $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 $this->addWhereFld( 'ar_user_text', $params['user'] );
216 } elseif ( !is_null( $params['excludeuser'] ) ) {
217 $this->addWhere( 'ar_user_text != ' .
218 $db->addQuotes( $params['excludeuser'] ) );
219 }
220
221 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
222 // Paranoia: avoid brute force searches (bug 17342)
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 $this->addOption(
268 'USE INDEX',
269 array( 'archive' => ( $mode == 'user' ? 'usertext_timestamp' : 'name_title_timestamp' ) )
270 );
271 if ( $mode == 'all' ) {
272 if ( $params['unique'] ) {
273 // @todo Does this work on non-MySQL?
274 $this->addOption( 'GROUP BY', 'ar_title' );
275 } else {
276 $sort = ( $dir == 'newer' ? '' : ' DESC' );
277 $this->addOption( 'ORDER BY', array(
278 'ar_title' . $sort,
279 'ar_timestamp' . $sort,
280 'ar_id' . $sort,
281 ) );
282 }
283 } else {
284 if ( $mode == 'revs' ) {
285 // Sort by ns and title in the same order as timestamp for efficiency
286 $this->addWhereRange( 'ar_namespace', $dir, null, null );
287 $this->addWhereRange( 'ar_title', $dir, null, null );
288 }
289 $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
290 // Include in ORDER BY for uniqueness
291 $this->addWhereRange( 'ar_id', $dir, null, null );
292 }
293 $res = $this->select( __METHOD__ );
294 $pageMap = array(); // Maps ns&title to (fake) pageid
295 $count = 0;
296 $newPageID = 0;
297 foreach ( $res as $row ) {
298 if ( ++$count > $limit ) {
299 // We've had enough
300 if ( $mode == 'all' || $mode == 'revs' ) {
301 $this->setContinueEnumParameter( 'continue',
302 "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
303 );
304 } else {
305 $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
306 }
307 break;
308 }
309
310 $rev = array();
311 $anyHidden = false;
312
313 $rev['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ar_timestamp );
314 if ( $fld_revid ) {
315 $rev['revid'] = intval( $row->ar_rev_id );
316 }
317 if ( $fld_parentid && !is_null( $row->ar_parent_id ) ) {
318 $rev['parentid'] = intval( $row->ar_parent_id );
319 }
320 if ( $fld_user || $fld_userid ) {
321 if ( $row->ar_deleted & Revision::DELETED_USER ) {
322 $rev['userhidden'] = '';
323 $anyHidden = true;
324 }
325 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_USER, $user ) ) {
326 if ( $fld_user ) {
327 $rev['user'] = $row->ar_user_text;
328 }
329 if ( $fld_userid ) {
330 $rev['userid'] = $row->ar_user;
331 }
332 }
333 }
334
335 if ( $fld_comment || $fld_parsedcomment ) {
336 if ( $row->ar_deleted & Revision::DELETED_COMMENT ) {
337 $rev['commenthidden'] = '';
338 $anyHidden = true;
339 }
340 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_COMMENT, $user ) ) {
341 if ( $fld_comment ) {
342 $rev['comment'] = $row->ar_comment;
343 }
344 if ( $fld_parsedcomment ) {
345 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
346 $rev['parsedcomment'] = Linker::formatComment( $row->ar_comment, $title );
347 }
348 }
349 }
350
351 if ( $fld_minor && $row->ar_minor_edit == 1 ) {
352 $rev['minor'] = '';
353 }
354 if ( $fld_len ) {
355 $rev['len'] = $row->ar_len;
356 }
357 if ( $fld_sha1 ) {
358 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
359 $rev['sha1hidden'] = '';
360 $anyHidden = true;
361 }
362 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
363 if ( $row->ar_sha1 != '' ) {
364 $rev['sha1'] = wfBaseConvert( $row->ar_sha1, 36, 16, 40 );
365 } else {
366 $rev['sha1'] = '';
367 }
368 }
369 }
370 if ( $fld_content ) {
371 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
372 $rev['texthidden'] = '';
373 $anyHidden = true;
374 }
375 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
376 if ( isset( $row->ar_text ) && !$row->ar_text_id ) {
377 // Pre-1.5 ar_text row (if condition from Revision::newFromArchiveRow)
378 ApiResult::setContent( $rev, Revision::getRevisionText( $row, 'ar_' ) );
379 } else {
380 ApiResult::setContent( $rev, Revision::getRevisionText( $row ) );
381 }
382 }
383 }
384
385 if ( $fld_tags ) {
386 if ( $row->ts_tags ) {
387 $tags = explode( ',', $row->ts_tags );
388 $this->getResult()->setIndexedTagName( $tags, 'tag' );
389 $rev['tags'] = $tags;
390 } else {
391 $rev['tags'] = array();
392 }
393 }
394
395 if ( $anyHidden && ( $row->ar_deleted & Revision::DELETED_RESTRICTED ) ) {
396 $rev['suppressed'] = '';
397 }
398
399 if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
400 $pageID = $newPageID++;
401 $pageMap[$row->ar_namespace][$row->ar_title] = $pageID;
402 $a['revisions'] = array( $rev );
403 $result->setIndexedTagName( $a['revisions'], 'rev' );
404 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
405 ApiQueryBase::addTitleInfo( $a, $title );
406 if ( $fld_token ) {
407 $a['token'] = $token;
408 }
409 $fit = $result->addValue( array( 'query', $this->getModuleName() ), $pageID, $a );
410 } else {
411 $pageID = $pageMap[$row->ar_namespace][$row->ar_title];
412 $fit = $result->addValue(
413 array( 'query', $this->getModuleName(), $pageID, 'revisions' ),
414 null, $rev );
415 }
416 if ( !$fit ) {
417 if ( $mode == 'all' || $mode == 'revs' ) {
418 $this->setContinueEnumParameter( 'continue',
419 "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
420 );
421 } else {
422 $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
423 }
424 break;
425 }
426 }
427 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
428 }
429
430 public function isDeprecated() {
431 return true;
432 }
433
434 public function getAllowedParams() {
435 return array(
436 'start' => array(
437 ApiBase::PARAM_TYPE => 'timestamp',
438 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 1, 2 ) ),
439 ),
440 'end' => array(
441 ApiBase::PARAM_TYPE => 'timestamp',
442 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 1, 2 ) ),
443 ),
444 'dir' => array(
445 ApiBase::PARAM_TYPE => array(
446 'newer',
447 'older'
448 ),
449 ApiBase::PARAM_DFLT => 'older',
450 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
451 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 1, 3 ) ),
452 ),
453 'from' => array(
454 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
455 ),
456 'to' => array(
457 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
458 ),
459 'prefix' => array(
460 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
461 ),
462 'unique' => array(
463 ApiBase::PARAM_DFLT => false,
464 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
465 ),
466 'namespace' => array(
467 ApiBase::PARAM_TYPE => 'namespace',
468 ApiBase::PARAM_DFLT => NS_MAIN,
469 ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
470 ),
471 'tag' => null,
472 'user' => array(
473 ApiBase::PARAM_TYPE => 'user'
474 ),
475 'excludeuser' => array(
476 ApiBase::PARAM_TYPE => 'user'
477 ),
478 'prop' => array(
479 ApiBase::PARAM_DFLT => 'user|comment',
480 ApiBase::PARAM_TYPE => array(
481 'revid',
482 'parentid',
483 'user',
484 'userid',
485 'comment',
486 'parsedcomment',
487 'minor',
488 'len',
489 'sha1',
490 'content',
491 'token',
492 'tags'
493 ),
494 ApiBase::PARAM_ISMULTI => true
495 ),
496 'limit' => array(
497 ApiBase::PARAM_DFLT => 10,
498 ApiBase::PARAM_TYPE => 'limit',
499 ApiBase::PARAM_MIN => 1,
500 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
501 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
502 ),
503 'continue' => array(
504 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
505 ),
506 );
507 }
508
509 protected function getExamplesMessages() {
510 return array(
511 'action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
512 'drprop=user|comment|content'
513 => 'apihelp-query+deletedrevs-example-mode1',
514 'action=query&list=deletedrevs&druser=Bob&drlimit=50'
515 => 'apihelp-query+deletedrevs-example-mode2',
516 'action=query&list=deletedrevs&drdir=newer&drlimit=50'
517 => 'apihelp-query+deletedrevs-example-mode3-main',
518 'action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
519 => 'apihelp-query+deletedrevs-example-mode3-talk',
520 );
521 }
522
523 public function getHelpUrls() {
524 return 'https://www.mediawiki.org/wiki/API:Deletedrevs';
525 }
526 }