3 * API for MediaWiki 1.8+
5 * Created on Jul 2, 2007
7 * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
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
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * Query module to enumerate all deleted revisions.
37 class ApiQueryDeletedrevs
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'dr' );
43 public function execute() {
45 // Before doing anything at all, let's check permissions
46 if ( !$wgUser->isAllowed( 'deletedhistory' ) ) {
47 $this->dieUsage( 'You don\'t have permission to view deleted revision information', 'permissiondenied' );
51 $params = $this->extractRequestParams( false );
52 $prop = array_flip( $params['prop'] );
53 $fld_revid = isset( $prop['revid'] );
54 $fld_user = isset( $prop['user'] );
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_content = isset( $prop['content'] );
60 $fld_token = isset( $prop['token'] );
62 $result = $this->getResult();
63 $pageSet = $this->getPageSet();
64 $titles = $pageSet->getTitles();
66 // This module operates in three modes:
67 // 'revs': List deleted revs for certain titles
68 // 'user': List deleted revs by a certain user
69 // 'all': List all deleted revs
71 if ( count( $titles ) > 0 ) {
73 } elseif ( !is_null( $params['user'] ) ) {
77 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
78 $this->dieUsage( 'user and excludeuser cannot be used together', 'badparams' );
81 $this->addTables( 'archive' );
82 $this->addWhere( 'ar_deleted = 0' );
83 $this->addFields( array( 'ar_title', 'ar_namespace', 'ar_timestamp' ) );
85 $this->addFields( 'ar_rev_id' );
88 $this->addFields( 'ar_user_text' );
90 if ( $fld_comment ||
$fld_parsedcomment ) {
91 $this->addFields( 'ar_comment' );
94 $this->addFields( 'ar_minor_edit' );
97 $this->addFields( 'ar_len' );
100 $this->addTables( 'text' );
101 $this->addFields( array( 'ar_text', 'ar_text_id', 'old_text', 'old_flags' ) );
102 $this->addWhere( 'ar_text_id = old_id' );
104 // This also means stricter restrictions
105 if ( !$wgUser->isAllowed( 'undelete' ) ) {
106 $this->dieUsage( 'You don\'t have permission to view deleted revision content', 'permissiondenied' );
110 $userMax = $fld_content ? ApiBase
::LIMIT_SML1
: ApiBase
::LIMIT_BIG1
;
111 $botMax = $fld_content ? ApiBase
::LIMIT_SML2
: ApiBase
::LIMIT_BIG2
;
113 $limit = $params['limit'];
115 if ( $limit == 'max' ) {
116 $limit = $this->getMain()->canApiHighLimits() ?
$botMax : $userMax;
117 $this->getResult()->setParsedLimit( $this->getModuleName(), $limit );
120 $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
123 // Undelete tokens are identical for all pages, so we cache one here
124 $token = $wgUser->editToken();
127 // We need a custom WHERE clause that matches all titles.
128 if ( $mode == 'revs' ) {
129 $lb = new LinkBatch( $titles );
130 $where = $lb->constructSet( 'ar', $db );
131 $this->addWhere( $where );
132 } elseif ( $mode == 'all' ) {
133 $this->addWhereFld( 'ar_namespace', $params['namespace'] );
134 if ( !is_null( $params['from'] ) ) {
135 $from = $this->getDB()->strencode( $this->titleToKey( $params['from'] ) );
136 $this->addWhere( "ar_title >= '$from'" );
140 if ( !is_null( $params['user'] ) ) {
141 $this->addWhereFld( 'ar_user_text', $params['user'] );
142 } elseif ( !is_null( $params['excludeuser'] ) ) {
143 $this->addWhere( 'ar_user_text != ' .
144 $this->getDB()->addQuotes( $params['excludeuser'] ) );
147 if ( !is_null( $params['continue'] ) && ( $mode == 'all' ||
$mode == 'revs' ) )
149 $cont = explode( '|', $params['continue'] );
150 if ( count( $cont ) != 3 ) {
151 $this->dieUsage( 'Invalid continue param. You should pass the original value returned by the previous query', 'badcontinue' );
153 $ns = intval( $cont[0] );
154 $title = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
155 $ts = $this->getDB()->strencode( $cont[2] );
156 $op = ( $params['dir'] == 'newer' ?
'>' : '<' );
157 $this->addWhere( "ar_namespace $op $ns OR " .
158 "(ar_namespace = $ns AND " .
159 "(ar_title $op '$title' OR " .
160 "(ar_title = '$title' AND " .
161 "ar_timestamp $op= '$ts')))" );
164 $this->addOption( 'LIMIT', $limit +
1 );
165 $this->addOption( 'USE INDEX', array( 'archive' => ( $mode == 'user' ?
'usertext_timestamp' : 'name_title_timestamp' ) ) );
166 if ( $mode == 'all' ) {
167 if ( $params['unique'] ) {
168 $this->addOption( 'GROUP BY', 'ar_title' );
169 $this->addOption( 'ORDER BY', 'ar_title' );
171 $this->addOption( 'ORDER BY', 'ar_title, ar_timestamp' );
174 if ( $mode == 'revs' ) {
175 // Sort by ns and title in the same order as timestamp for efficiency
176 $this->addWhereRange( 'ar_namespace', $params['dir'], null, null );
177 $this->addWhereRange( 'ar_title', $params['dir'], null, null );
179 $this->addWhereRange( 'ar_timestamp', $params['dir'], $params['start'], $params['end'] );
181 $res = $this->select( __METHOD__
);
182 $pageMap = array(); // Maps ns&title to (fake) pageid
185 foreach ( $res as $row ) {
186 if ( ++
$count > $limit ) {
188 if ( $mode == 'all' ||
$mode == 'revs' ) {
189 $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace
) . '|' .
190 $this->keyToTitle( $row->ar_title
) . '|' . $row->ar_timestamp
);
192 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->ar_timestamp
) );
198 $rev['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->ar_timestamp
);
200 $rev['revid'] = intval( $row->ar_rev_id
);
203 $rev['user'] = $row->ar_user_text
;
205 if ( $fld_comment ) {
206 $rev['comment'] = $row->ar_comment
;
209 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
211 if ( $fld_parsedcomment ) {
212 $rev['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->ar_comment
, $title );
214 if ( $fld_minor && $row->ar_minor_edit
== 1 ) {
218 $rev['len'] = $row->ar_len
;
220 if ( $fld_content ) {
221 ApiResult
::setContent( $rev, Revision
::getRevisionText( $row ) );
224 if ( !isset( $pageMap[$row->ar_namespace
][$row->ar_title
] ) ) {
225 $pageID = $newPageID++
;
226 $pageMap[$row->ar_namespace
][$row->ar_title
] = $pageID;
227 $a['revisions'] = array( $rev );
228 $result->setIndexedTagName( $a['revisions'], 'rev' );
229 ApiQueryBase
::addTitleInfo( $a, $title );
231 $a['token'] = $token;
233 $fit = $result->addValue( array( 'query', $this->getModuleName() ), $pageID, $a );
235 $pageID = $pageMap[$row->ar_namespace
][$row->ar_title
];
236 $fit = $result->addValue(
237 array( 'query', $this->getModuleName(), $pageID, 'revisions' ),
241 if ( $mode == 'all' ||
$mode == 'revs' ) {
242 $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace
) . '|' .
243 $this->keyToTitle( $row->ar_title
) . '|' . $row->ar_timestamp
);
245 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->ar_timestamp
) );
250 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
253 public function getAllowedParams() {
256 ApiBase
::PARAM_TYPE
=> 'timestamp'
259 ApiBase
::PARAM_TYPE
=> 'timestamp',
262 ApiBase
::PARAM_TYPE
=> array(
266 ApiBase
::PARAM_DFLT
=> 'older'
272 ApiBase
::PARAM_TYPE
=> 'user'
274 'excludeuser' => array(
275 ApiBase
::PARAM_TYPE
=> 'user'
277 'namespace' => array(
278 ApiBase
::PARAM_TYPE
=> 'namespace',
279 ApiBase
::PARAM_DFLT
=> 0,
282 ApiBase
::PARAM_DFLT
=> 10,
283 ApiBase
::PARAM_TYPE
=> 'limit',
284 ApiBase
::PARAM_MIN
=> 1,
285 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
286 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
289 ApiBase
::PARAM_DFLT
=> 'user|comment',
290 ApiBase
::PARAM_TYPE
=> array(
300 ApiBase
::PARAM_ISMULTI
=> true
305 public function getParamDescription() {
307 'start' => 'The timestamp to start enumerating from (1,2)',
308 'end' => 'The timestamp to stop enumerating at (1,2)',
309 'dir' => 'The direction in which to enumerate (1,2)',
310 'limit' => 'The maximum amount of revisions to list',
312 'Which properties to get',
313 ' revid - Adds the revision id of the deleted revision',
314 ' user - Adds user who made the revision',
315 ' comment - Adds the comment of the revision',
316 ' parsedcomment - Adds the parsed comment of the revision',
317 ' minor - Tags if the revision is minor',
318 ' len - Adds the length of the revision',
319 ' content - Adds the content of the revision',
320 ' token - Gives the edit token',
322 'namespace' => 'Only list pages in this namespace (3)',
323 'user' => 'Only list revisions by this user',
324 'excludeuser' => 'Don\'t list revisions by this user',
325 'from' => 'Start listing at this title (3)',
326 'continue' => 'When more results are available, use this to continue (3)',
327 'unique' => 'List only one revision for each page (3)',
331 public function getDescription() {
333 'List deleted revisions.',
334 'This module operates in three modes:',
335 '1) List deleted revisions for the given title(s), sorted by timestamp',
336 '2) List deleted contributions for the given user, sorted by timestamp (no titles specified)',
337 '3) List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set)',
338 'Certain parameters only apply to some modes and are ignored in others.',
339 'For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3',
343 public function getPossibleErrors() {
344 return array_merge( parent
::getPossibleErrors(), array(
345 array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revision information' ),
346 array( 'code' => 'badparams', 'info' => 'user and excludeuser cannot be used together' ),
347 array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revision content' ),
348 array( 'code' => 'badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
352 protected function getExamples() {
354 'List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1):',
355 ' api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content',
356 'List the last 50 deleted contributions by Bob (mode 2):',
357 ' api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50',
358 'List the first 50 deleted revisions in the main namespace (mode 3):',
359 ' api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50',
360 'List the first 50 deleted pages in the Talk namespace (mode 3):',
361 ' api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique',
365 public function getVersion() {
366 return __CLASS__
. ': $Id$';