4 * Created on Jul 2, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * Query module to enumerate all available pages.
36 class ApiQueryDeletedrevs
extends ApiQueryBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'dr');
42 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');
50 $params = $this->extractRequestParams(false);
51 $prop = array_flip($params['prop']);
52 $fld_revid = isset($prop['revid']);
53 $fld_user = isset($prop['user']);
54 $fld_comment = isset($prop['comment']);
55 $fld_minor = isset($prop['minor']);
56 $fld_len = isset($prop['len']);
57 $fld_content = isset($prop['content']);
58 $fld_token = isset($prop['token']);
60 $result = $this->getResult();
61 $pageSet = $this->getPageSet();
62 $titles = $pageSet->getTitles();
65 $this->addTables('archive');
66 $this->addFields(array('ar_title', 'ar_namespace', 'ar_timestamp'));
68 $this->addFields('ar_rev_id');
70 $this->addFields('ar_user_text');
72 $this->addFields('ar_comment');
74 $this->addFields('ar_minor_edit');
76 $this->addFields('ar_len');
79 $this->addTables('text');
80 $this->addFields(array('ar_text', 'ar_text_id', 'old_text', 'old_flags'));
81 $this->addWhere('ar_text_id = old_id');
83 // This also means stricter restrictions
84 if(!$wgUser->isAllowed('undelete'))
85 $this->dieUsage('You don\'t have permission to view deleted revision content', 'permissiondenied');
88 $userMax = $fld_content ? ApiBase
:: LIMIT_SML1
: ApiBase
:: LIMIT_BIG1
;
89 $botMax = $fld_content ? ApiBase
:: LIMIT_SML2
: ApiBase
:: LIMIT_BIG2
;
91 $limit = $params['limit'];
93 if( $limit == 'max' ) {
94 $limit = $this->getMain()->canApiHighLimits() ?
$botMax : $userMax;
95 $this->getResult()->addValue( 'limits', $this->getModuleName(), $limit );
98 $this->validateLimit('limit', $limit, 1, $userMax, $botMax);
101 // Undelete tokens are identical for all pages, so we cache one here
102 $token = $wgUser->editToken();
104 // We need a custom WHERE clause that matches all titles.
105 if(count($titles) > 0)
107 $lb = new LinkBatch($titles);
108 $where = $lb->constructSet('ar', $db);
109 $this->addWhere($where);
112 $this->addOption('LIMIT', $limit +
1);
113 $this->addWhereRange('ar_timestamp', $params['dir'], $params['start'], $params['end']);
114 $res = $this->select(__METHOD__
);
117 // First populate the $pages array
118 while($row = $db->fetchObject($res))
120 if(++
$count > $limit)
123 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601
, $row->ar_timestamp
));
128 $rev['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->ar_timestamp
);
130 $rev['revid'] = $row->ar_rev_id
;
132 $rev['user'] = $row->ar_user_text
;
134 $rev['comment'] = $row->ar_comment
;
136 if($row->ar_minor_edit
== 1)
139 $rev['len'] = $row->ar_len
;
141 ApiResult
::setContent($rev, Revision
::getRevisionText($row));
143 $t = Title
::makeTitle($row->ar_namespace
, $row->ar_title
);
144 if(!isset($pages[$t->getPrefixedText()]))
146 $pages[$t->getPrefixedText()] = array(
147 'title' => $t->getPrefixedText(),
148 'ns' => intval($row->ar_namespace
),
149 'revisions' => array($rev)
152 $pages[$t->getPrefixedText()]['token'] = $token;
155 $pages[$t->getPrefixedText()]['revisions'][] = $rev;
157 $db->freeResult($res);
159 // We don't want entire pagenames as keys, so let's make this array indexed
160 foreach($pages as $page)
162 $result->setIndexedTagName($page['revisions'], 'rev');
165 $result->setIndexedTagName($data, 'page');
166 $result->addValue('query', $this->getModuleName(), $data);
169 public function getAllowedParams() {
172 ApiBase
:: PARAM_TYPE
=> 'timestamp'
175 ApiBase
:: PARAM_TYPE
=> 'timestamp',
178 ApiBase
:: PARAM_TYPE
=> array(
182 ApiBase
:: PARAM_DFLT
=> 'older'
185 ApiBase
:: PARAM_DFLT
=> 10,
186 ApiBase
:: PARAM_TYPE
=> 'limit',
187 ApiBase
:: PARAM_MIN
=> 1,
188 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
189 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
192 ApiBase
:: PARAM_DFLT
=> 'user|comment',
193 ApiBase
:: PARAM_TYPE
=> array(
202 ApiBase
:: PARAM_ISMULTI
=> true
207 public function getParamDescription() {
209 'start' => 'The timestamp to start enumerating from',
210 'end' => 'The timestamp to stop enumerating at',
211 'dir' => 'The direction in which to enumerate',
212 'limit' => 'The maximum amount of revisions to list',
213 'prop' => 'Which properties to get'
217 public function getDescription() {
218 return 'List deleted revisions.';
221 protected function getExamples() {
223 'List the first 50 deleted revisions',
224 ' api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50',
225 'List the last deleted revisions of Main Page and Talk:Main Page, with content:',
226 ' api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content'
230 public function getVersion() {
231 return __CLASS__
. ': $Id$';