5 * Created on Jul 2, 2007
7 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
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.
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.
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
28 * Query module to enumerate all deleted revisions.
32 class ApiQueryDeletedrevs
extends ApiQueryBase
{
34 public function __construct( $query, $moduleName ) {
35 parent
::__construct( $query, $moduleName, 'dr' );
38 public function execute() {
39 $user = $this->getUser();
40 // Before doing anything at all, let's check permissions
41 if ( !$user->isAllowed( 'deletedhistory' ) ) {
43 'You don\'t have permission to view deleted revision information',
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'] );
64 // If we're in JSON callback mode, no tokens can be obtained
65 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
69 $result = $this->getResult();
70 $pageSet = $this->getPageSet();
71 $titles = $pageSet->getTitles();
73 // This module operates in three modes:
74 // 'revs': List deleted revs for certain titles (1)
75 // 'user': List deleted revs by a certain user (2)
76 // 'all': List all deleted revs in NS (3)
78 if ( count( $titles ) > 0 ) {
80 } elseif ( !is_null( $params['user'] ) ) {
84 if ( $mode == 'revs' ||
$mode == 'user' ) {
85 // Ignore namespace and unique due to inability to know whether they were purposely set
86 foreach ( array( 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ) as $p ) {
87 if ( !is_null( $params[$p] ) ) {
88 $this->dieUsage( "The '{$p}' parameter cannot be used in modes 1 or 2", 'badparams' );
92 foreach ( array( 'start', 'end' ) as $p ) {
93 if ( !is_null( $params[$p] ) ) {
94 $this->dieUsage( "The {$p} parameter cannot be used in mode 3", 'badparams' );
99 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
100 $this->dieUsage( 'user and excludeuser cannot be used together', 'badparams' );
103 $this->addTables( 'archive' );
104 $this->addWhere( 'ar_deleted = 0' );
105 $this->addFields( array( 'ar_title', 'ar_namespace', 'ar_timestamp' ) );
107 $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
108 $this->addFieldsIf( 'ar_rev_id', $fld_revid );
109 $this->addFieldsIf( 'ar_user_text', $fld_user );
110 $this->addFieldsIf( 'ar_user', $fld_userid );
111 $this->addFieldsIf( 'ar_comment', $fld_comment ||
$fld_parsedcomment );
112 $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
113 $this->addFieldsIf( 'ar_len', $fld_len );
114 $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
117 $this->addTables( 'tag_summary' );
119 array( 'tag_summary' => array( 'LEFT JOIN', array( 'ar_rev_id=ts_rev_id' ) ) )
121 $this->addFields( 'ts_tags' );
124 if ( !is_null( $params['tag'] ) ) {
125 $this->addTables( 'change_tag' );
127 array( 'change_tag' => array( 'INNER JOIN', array( 'ar_rev_id=ct_rev_id' ) ) )
129 $this->addWhereFld( 'ct_tag', $params['tag'] );
132 if ( $fld_content ) {
133 $this->addTables( 'text' );
134 $this->addFields( array( 'ar_text', 'ar_text_id', 'old_text', 'old_flags' ) );
135 $this->addWhere( 'ar_text_id = old_id' );
137 // This also means stricter restrictions
138 if ( !$user->isAllowed( 'undelete' ) ) {
140 'You don\'t have permission to view deleted revision content',
146 $userMax = $fld_content ? ApiBase
::LIMIT_SML1
: ApiBase
::LIMIT_BIG1
;
147 $botMax = $fld_content ? ApiBase
::LIMIT_SML2
: ApiBase
::LIMIT_BIG2
;
149 $limit = $params['limit'];
151 if ( $limit == 'max' ) {
152 $limit = $this->getMain()->canApiHighLimits() ?
$botMax : $userMax;
153 $this->getResult()->setParsedLimit( $this->getModuleName(), $limit );
156 $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
159 // Undelete tokens are identical for all pages, so we cache one here
160 $token = $user->getEditToken( '', $this->getMain()->getRequest() );
163 $dir = $params['dir'];
165 // We need a custom WHERE clause that matches all titles.
166 if ( $mode == 'revs' ) {
167 $lb = new LinkBatch( $titles );
168 $where = $lb->constructSet( 'ar', $db );
169 $this->addWhere( $where );
170 } elseif ( $mode == 'all' ) {
171 $this->addWhereFld( 'ar_namespace', $params['namespace'] );
173 $from = $params['from'] === null ?
null : $this->titlePartToKey( $params['from'], $params['namespace'] );
174 $to = $params['to'] === null ?
null : $this->titlePartToKey( $params['to'], $params['namespace'] );
175 $this->addWhereRange( 'ar_title', $dir, $from, $to );
177 if ( isset( $params['prefix'] ) ) {
178 $this->addWhere( 'ar_title' . $db->buildLike(
179 $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
180 $db->anyString() ) );
184 if ( !is_null( $params['user'] ) ) {
185 $this->addWhereFld( 'ar_user_text', $params['user'] );
186 } elseif ( !is_null( $params['excludeuser'] ) ) {
187 $this->addWhere( 'ar_user_text != ' .
188 $db->addQuotes( $params['excludeuser'] ) );
191 if ( !is_null( $params['continue'] ) && ( $mode == 'all' ||
$mode == 'revs' ) ) {
192 $cont = explode( '|', $params['continue'] );
193 $this->dieContinueUsageIf( count( $cont ) != 3 );
194 $ns = intval( $cont[0] );
195 $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
196 $title = $db->addQuotes( $cont[1] );
197 $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
198 $op = ( $dir == 'newer' ?
'>' : '<' );
199 $this->addWhere( "ar_namespace $op $ns OR " .
200 "(ar_namespace = $ns AND " .
201 "(ar_title $op $title OR " .
202 "(ar_title = $title AND " .
203 "ar_timestamp $op= $ts)))" );
206 $this->addOption( 'LIMIT', $limit +
1 );
209 array( 'archive' => ( $mode == 'user' ?
'usertext_timestamp' : 'name_title_timestamp' ) )
211 if ( $mode == 'all' ) {
212 if ( $params['unique'] ) {
213 $this->addOption( 'GROUP BY', 'ar_title' );
215 $sort = ( $dir == 'newer' ?
'' : ' DESC' );
216 $this->addOption( 'ORDER BY', array(
218 'ar_timestamp' . $sort
222 if ( $mode == 'revs' ) {
223 // Sort by ns and title in the same order as timestamp for efficiency
224 $this->addWhereRange( 'ar_namespace', $dir, null, null );
225 $this->addWhereRange( 'ar_title', $dir, null, null );
227 $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
229 $res = $this->select( __METHOD__
);
230 $pageMap = array(); // Maps ns&title to (fake) pageid
233 foreach ( $res as $row ) {
234 if ( ++
$count > $limit ) {
236 if ( $mode == 'all' ||
$mode == 'revs' ) {
237 $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace
) . '|' .
238 $row->ar_title
. '|' . $row->ar_timestamp
);
240 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->ar_timestamp
) );
246 $rev['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->ar_timestamp
);
248 $rev['revid'] = intval( $row->ar_rev_id
);
250 if ( $fld_parentid && !is_null( $row->ar_parent_id
) ) {
251 $rev['parentid'] = intval( $row->ar_parent_id
);
254 $rev['user'] = $row->ar_user_text
;
257 $rev['userid'] = $row->ar_user
;
259 if ( $fld_comment ) {
260 $rev['comment'] = $row->ar_comment
;
263 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
265 if ( $fld_parsedcomment ) {
266 $rev['parsedcomment'] = Linker
::formatComment( $row->ar_comment
, $title );
268 if ( $fld_minor && $row->ar_minor_edit
== 1 ) {
272 $rev['len'] = $row->ar_len
;
275 if ( $row->ar_sha1
!= '' ) {
276 $rev['sha1'] = wfBaseConvert( $row->ar_sha1
, 36, 16, 40 );
281 if ( $fld_content ) {
282 ApiResult
::setContent( $rev, Revision
::getRevisionText( $row ) );
286 if ( $row->ts_tags
) {
287 $tags = explode( ',', $row->ts_tags
);
288 $this->getResult()->setIndexedTagName( $tags, 'tag' );
289 $rev['tags'] = $tags;
291 $rev['tags'] = array();
295 if ( !isset( $pageMap[$row->ar_namespace
][$row->ar_title
] ) ) {
296 $pageID = $newPageID++
;
297 $pageMap[$row->ar_namespace
][$row->ar_title
] = $pageID;
298 $a['revisions'] = array( $rev );
299 $result->setIndexedTagName( $a['revisions'], 'rev' );
300 ApiQueryBase
::addTitleInfo( $a, $title );
302 $a['token'] = $token;
304 $fit = $result->addValue( array( 'query', $this->getModuleName() ), $pageID, $a );
306 $pageID = $pageMap[$row->ar_namespace
][$row->ar_title
];
307 $fit = $result->addValue(
308 array( 'query', $this->getModuleName(), $pageID, 'revisions' ),
312 if ( $mode == 'all' ||
$mode == 'revs' ) {
313 $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace
) . '|' .
314 $row->ar_title
. '|' . $row->ar_timestamp
);
316 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->ar_timestamp
) );
321 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
324 public function getAllowedParams() {
327 ApiBase
::PARAM_TYPE
=> 'timestamp'
330 ApiBase
::PARAM_TYPE
=> 'timestamp',
333 ApiBase
::PARAM_TYPE
=> array(
337 ApiBase
::PARAM_DFLT
=> 'older'
346 ApiBase
::PARAM_TYPE
=> 'user'
348 'excludeuser' => array(
349 ApiBase
::PARAM_TYPE
=> 'user'
351 'namespace' => array(
352 ApiBase
::PARAM_TYPE
=> 'namespace',
353 ApiBase
::PARAM_DFLT
=> NS_MAIN
,
356 ApiBase
::PARAM_DFLT
=> 10,
357 ApiBase
::PARAM_TYPE
=> 'limit',
358 ApiBase
::PARAM_MIN
=> 1,
359 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
360 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
363 ApiBase
::PARAM_DFLT
=> 'user|comment',
364 ApiBase
::PARAM_TYPE
=> array(
378 ApiBase
::PARAM_ISMULTI
=> true
383 public function getParamDescription() {
385 'start' => 'The timestamp to start enumerating from (1, 2)',
386 'end' => 'The timestamp to stop enumerating at (1, 2)',
387 'dir' => $this->getDirectionDescription( $this->getModulePrefix(), ' (1, 3)' ),
388 'from' => 'Start listing at this title (3)',
389 'to' => 'Stop listing at this title (3)',
390 'prefix' => 'Search for all page titles that begin with this value (3)',
391 'limit' => 'The maximum amount of revisions to list',
393 'Which properties to get',
394 ' revid - Adds the revision ID of the deleted revision',
395 ' parentid - Adds the revision ID of the previous revision to the page',
396 ' user - Adds the user who made the revision',
397 ' userid - Adds the user ID whom made the revision',
398 ' comment - Adds the comment of the revision',
399 ' parsedcomment - Adds the parsed comment of the revision',
400 ' minor - Tags if the revision is minor',
401 ' len - Adds the length (bytes) of the revision',
402 ' sha1 - Adds the SHA-1 (base 16) of the revision',
403 ' content - Adds the content of the revision',
404 ' token - Gives the edit token',
405 ' tags - Tags for the revision',
407 'namespace' => 'Only list pages in this namespace (3)',
408 'user' => 'Only list revisions by this user',
409 'excludeuser' => 'Don\'t list revisions by this user',
410 'continue' => 'When more results are available, use this to continue (1, 3)',
411 'unique' => 'List only one revision for each page (3)',
412 'tag' => 'Only list revisions tagged with this tag',
416 public function getResultProperties() {
428 public function getDescription() {
429 $p = $this->getModulePrefix();
432 'List deleted revisions.',
433 'Operates in three modes:',
434 ' 1) List deleted revisions for the given title(s), sorted by timestamp',
435 ' 2) List deleted contributions for the given user, sorted by timestamp (no titles specified)',
436 " 3) List all deleted revisions in the given namespace, sorted by title and timestamp',
437 ' (no titles specified, {$p}user not set)",
438 'Certain parameters only apply to some modes and are ignored in others.',
439 'For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3',
443 public function getPossibleErrors() {
444 return array_merge( parent
::getPossibleErrors(), array(
446 'code' => 'permissiondenied',
447 'info' => 'You don\'t have permission to view deleted revision information'
449 array( 'code' => 'badparams', 'info' => 'user and excludeuser cannot be used together'
452 'code' => 'permissiondenied',
453 'info' => 'You don\'t have permission to view deleted revision content'
455 array( 'code' => 'badparams', 'info' => "The 'from' parameter cannot be used in modes 1 or 2" ),
456 array( 'code' => 'badparams', 'info' => "The 'to' parameter cannot be used in modes 1 or 2" ),
458 'code' => 'badparams',
459 'info' => "The 'prefix' parameter cannot be used in modes 1 or 2"
461 array( 'code' => 'badparams', 'info' => "The 'start' parameter cannot be used in mode 3" ),
462 array( 'code' => 'badparams', 'info' => "The 'end' parameter cannot be used in mode 3" ),
466 public function getExamples() {
468 'api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
469 'drprop=user|comment|content'
470 => 'List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1)',
471 'api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50'
472 => 'List the last 50 deleted contributions by Bob (mode 2)',
473 'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50'
474 => 'List the first 50 deleted revisions in the main namespace (mode 3)',
475 'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
476 => 'List the first 50 deleted pages in the Talk namespace (mode 3):',
480 public function getHelpUrls() {
481 return 'https://www.mediawiki.org/wiki/API:Deletedrevs';