4 * Created on Sep 7, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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 * A query action to enumerate revisions of a given page, or show top revisions of multiple pages.
33 * Various pieces of information may be shown - flags, comments, and the actual wiki markup of the rev.
34 * In the enumeration mode, ranges of revisions may be requested and filtered.
38 class ApiQueryRevisions
extends ApiQueryBase
{
40 public function __construct($query, $moduleName) {
41 parent
:: __construct($query, $moduleName, 'rv');
44 private $fld_ids = false, $fld_flags = false, $fld_timestamp = false, $fld_size = false,
45 $fld_comment = false, $fld_user = false, $fld_content = false;
47 public function execute() {
48 $limit = $startid = $endid = $start = $end = $dir = $prop = $user = $excludeuser = $diffto = $difftoprev = $diffformat = null;
49 extract($this->extractRequestParams());
51 // If any of those parameters are used, work in 'enumeration' mode.
52 // Enum mode can only be used when exactly one page is provided.
53 // Enumerating revisions on multiple pages make it extremely
54 // difficult to manage continuations and require additional SQL indexes
55 $enumRevMode = (!is_null($user) ||
!is_null($excludeuser) ||
!is_null($limit) ||
!is_null($startid) ||
!is_null($endid) ||
$dir === 'newer' ||
!is_null($start) ||
!is_null($end) |
!$difftoprev);
58 $pageSet = $this->getPageSet();
59 $pageCount = $pageSet->getGoodTitleCount();
60 $revCount = $pageSet->getRevisionCount();
62 // Optimization -- nothing to do
63 if ($revCount === 0 && $pageCount === 0)
66 if ($revCount > 0 && $enumRevMode)
67 $this->dieUsage('The revids= parameter may not be used with the list options (limit, startid, endid, dirNewer, start, end).', 'revids');
69 if ($pageCount > 1 && $enumRevMode)
70 $this->dieUsage('titles, pageids or a generator was used to supply multiple pages, but the limit, startid, endid, dirNewer, user, excludeuser, start, end and difftoprev parameters may only be used on a single page.', 'multpages');
72 $this->addTables('revision');
73 $this->addWhere('rev_deleted=0');
75 $prop = array_flip($prop);
77 // These field are needed regardless of the client requesting them
78 $this->addFields('rev_id');
79 $this->addFields('rev_page');
82 $this->fld_ids
= isset ($prop['ids']);
83 // $this->addFieldsIf('rev_text_id', $this->fld_ids); // should this be exposed?
84 $this->fld_flags
= $this->addFieldsIf('rev_minor_edit', isset ($prop['flags']));
85 $this->fld_timestamp
= $this->addFieldsIf('rev_timestamp', isset ($prop['timestamp']));
86 $this->fld_comment
= $this->addFieldsIf('rev_comment', isset ($prop['comment']));
87 $this->fld_size
= $this->addFieldsIf('rev_len', isset ($prop['size']));
89 if($diffto ||
$difftoprev)
93 $this->formatter
= new DiffFormatter
;
96 $this->formatter
= new UnifiedDiffFormatter
;
99 $this->formatter
= new ArrayDiffFormatter
;
104 $difftoRev = Revision
::newFromID($diffto);
105 if(!($difftoRev instanceof Revision
))
106 $this->dieUsage("There is no revision with ID $diffto", 'nosuchrev');
107 $this->diffOldText
= $difftoRev->revText();
108 if($this->diffOldText
== '') // deleted revision
109 $this->dieUsage("There is no revision with ID $diffto", 'nosuchrev'); // fake non-existence
110 $this->diffOldText
= explode("\n", $wgContLang->segmentForDiff($this->diffOldText
));
111 $this->diffto
= $diffto;
114 $this->diffto
= false;
117 $this->revCache
= array();
118 $this->difftoprev
= true;
121 $this->difftoprev
= false;
123 if (isset ($prop['user'])) {
124 $this->addFields('rev_user');
125 $this->addFields('rev_user_text');
126 $this->fld_user
= true;
128 if (isset ($prop['content']) ||
!is_null($diffto) ||
$difftoprev) {
130 // For each page we will request, the user must have read rights for that page
131 foreach ($pageSet->getGoodTitles() as $title) {
132 if( !$title->userCanRead() )
134 'The current user is not allowed to read ' . $title->getPrefixedText(),
138 $this->addTables('text');
139 $this->addWhere('rev_text_id=old_id');
140 $this->addFields('old_id');
141 $this->addFields('old_text');
142 $this->addFields('old_flags');
144 $this->fld_content
= isset($prop['content']);
146 $this->expandTemplates
= $expandtemplates;
149 $userMax = ($this->fld_content ||
$diffto ||
$difftoprev ?
50 : 500);
150 $botMax = ($this->fld_content ||
$diffto ||
$difftoprev ?
200 : 10000);
154 // This is mostly to prevent parameter errors (and optimize SQL?)
155 if (!is_null($startid) && !is_null($start))
156 $this->dieUsage('start and startid cannot be used together', 'badparams');
158 if (!is_null($endid) && !is_null($end))
159 $this->dieUsage('end and endid cannot be used together', 'badparams');
161 if(!is_null($user) && !is_null( $excludeuser))
162 $this->dieUsage('user and excludeuser cannot be used together', 'badparams');
164 // This code makes an assumption that sorting by rev_id and rev_timestamp produces
165 // the same result. This way users may request revisions starting at a given time,
166 // but to page through results use the rev_id returned after each page.
167 // Switching to rev_id removes the potential problem of having more than
168 // one row with the same timestamp for the same page.
169 // The order needs to be the same as start parameter to avoid SQL filesort.
171 if (is_null($startid) && is_null($endid))
172 $this->addWhereRange('rev_timestamp', $dir, $start, $end);
174 $this->addWhereRange('rev_id', $dir, $startid, $endid);
176 // must manually initialize unset limit
179 $this->validateLimit('limit', $limit, 1, $userMax, $botMax);
181 // There is only one ID, use it
182 $this->addWhereFld('rev_page', current(array_keys($pageSet->getGoodTitles())));
184 if(!is_null($user)) {
185 $this->addWhereFld('rev_user_text', $user);
186 } elseif (!is_null( $excludeuser)) {
187 $this->addWhere('rev_user_text != ' . $this->getDB()->addQuotes($excludeuser));
190 elseif ($revCount > 0) {
191 $this->validateLimit('rev_count', $revCount, 1, $userMax, $botMax);
193 // Get all revision IDs
194 $this->addWhereFld('rev_id', array_keys($pageSet->getRevisionIDs()));
196 // assumption testing -- we should never get more then $revCount rows.
199 elseif ($pageCount > 0) {
200 // When working in multi-page non-enumeration mode,
201 // limit to the latest revision only
202 $this->addTables('page');
203 $this->addWhere('page_id=rev_page');
204 $this->addWhere('page_latest=rev_id');
205 $this->validateLimit('page_count', $pageCount, 1, $userMax, $botMax);
208 $this->addWhereFld('page_id', array_keys($pageSet->getGoodTitles()));
210 // assumption testing -- we should never get more then $pageCount rows.
213 ApiBase
:: dieDebug(__METHOD__
, 'param validation?');
215 $this->addOption('LIMIT', $limit +
1);
219 $res = $this->select(__METHOD__
);
221 $db = $this->getDB();
222 while ($row = $db->fetchObject($res)) {
224 if (++
$count > $limit) {
225 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
227 ApiBase
:: dieDebug(__METHOD__
, 'Got more rows then expected'); // bug report
228 $this->setContinueEnumParameter('startid', intval($row->rev_id
));
232 $this->getResult()->addValue(
236 intval($row->rev_page
),
239 $this->extractRowInfo($row));
241 $db->freeResult($res);
243 if($this->difftoprev
)
246 ksort($this->revCache
, SORT_NUMERIC
);
247 $previousRevID = null;
249 $data =& $this->getResult()->getData();
250 $pageID = current(array_keys($pageSet->getGoodTitles()));
251 $this->diffArr
= array();
252 foreach($this->revCache
as $revid => $revtext)
255 if(is_null($previousRevID))
258 $previousRevID = $revid;
259 $oldText = explode("\n", $wgContLang->segmentForDiff($revtext));
262 $newText = explode("\n", $wgContLang->segmentForDiff($revtext));
263 $diff = new Diff($oldText, $newText);
264 $r['from'] = $previousRevID;
265 $formatted = $this->formatter
->format($diff);
266 if(!is_array($formatted))
267 ApiResult
::setContent($r, $wgContLang->unsegmentForDiff($this->formatter
->format($diff)));
270 $r['differences'] = $formatted;
271 $this->getResult()->setIndexedTagName($r['differences'], 'diff');
273 $this->diffArr
[$revid] = $r;
275 $previousRevID = $revid;
279 if ( $this->diffArr
) {
280 # Populate the query result with the contents of $this->diffArr.
281 $knownrevs = array_keys($this->diffArr
);
282 $i = count($knownrevs) - 1;
283 foreach($data['query']['pages'][$pageID]['revisions'] as &$rev) {
284 if ( $i >= 0 && isset ( $this->diffArr
[$knownrevs[$i]] ) )
285 $rev['difftoprev'] = $this->diffArr
[$knownrevs[$i]];
291 // Ensure that all revisions are shown as '<rev>' elements
292 $result = $this->getResult();
293 if ($result->getIsRawMode()) {
294 $data =& $result->getData();
295 foreach ($data['query']['pages'] as & $page) {
296 if (is_array($page) && array_key_exists('revisions', $page)) {
297 $result->setIndexedTagName($page['revisions'], 'rev');
303 private function extractRowInfo($row) {
307 if ($this->fld_ids
) {
308 $vals['revid'] = intval($row->rev_id
);
309 // $vals['oldid'] = intval($row->rev_text_id); // todo: should this be exposed?
312 if ($this->fld_flags
&& $row->rev_minor_edit
)
315 if ($this->fld_user
) {
316 $vals['user'] = $row->rev_user_text
;
321 if ($this->fld_timestamp
) {
322 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->rev_timestamp
);
325 if ($this->fld_size
&& !is_null($row->rev_len
)) {
326 $vals['size'] = intval($row->rev_len
);
329 if ($this->fld_comment
&& !empty ($row->rev_comment
)) {
330 $vals['comment'] = $row->rev_comment
;
333 if ($this->fld_content ||
$this->diffto ||
$this->difftoprev
)
334 $text = Revision
:: getRevisionText($row);
335 if ($this->fld_content
) {
336 if ($this->expandTemplates
) {
338 $text = $wgParser->preprocess( $text, Title
::newFromID($row->rev_page
), new ParserOptions() );
340 ApiResult
:: setContent($vals, $text);
346 $newText = explode("\n", $wgContLang->segmentForDiff($text));
347 $diff = new Diff($this->diffOldText
, $newText);
348 $vals['diffto']['from'] = $this->diffto
;
349 $arraydiff = $this->formatter
instanceof ArrayDiffFormatter
;
351 $changes = $wgContLang->unsegmentForDiff($this->formatter
->format($diff));
352 $this->getResult()->setIndexedTagName( $changes, 'change' );
353 $vals['diffto'] = $changes;
355 ApiResult
::setContent($vals['diffto'], $wgContLang->unsegmentForDiff($this->formatter
->format($diff)));
358 if($this->difftoprev
)
359 // Cache the revision's content for later use
360 $this->revCache
[$row->rev_id
] = $text;
365 protected function getAllowedParams() {
368 ApiBase
:: PARAM_ISMULTI
=> true,
369 ApiBase
:: PARAM_DFLT
=> 'ids|timestamp|flags|comment|user',
370 ApiBase
:: PARAM_TYPE
=> array (
381 ApiBase
:: PARAM_TYPE
=> 'limit',
382 ApiBase
:: PARAM_MIN
=> 1,
383 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
384 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
387 ApiBase
:: PARAM_TYPE
=> 'integer'
390 ApiBase
:: PARAM_TYPE
=> 'integer'
393 ApiBase
:: PARAM_TYPE
=> 'timestamp'
396 ApiBase
:: PARAM_TYPE
=> 'timestamp'
399 ApiBase
:: PARAM_DFLT
=> 'older',
400 ApiBase
:: PARAM_TYPE
=> array (
406 ApiBase
:: PARAM_TYPE
=> 'user'
408 'excludeuser' => array(
409 ApiBase
:: PARAM_TYPE
=> 'user'
412 'expandtemplates' => false,
414 ApiBase
:: PARAM_TYPE
=> 'integer'
416 'difftoprev' => false,
417 'diffformat' => array(
418 ApiBase
:: PARAM_TYPE
=> array(
423 ApiBase
::PARAM_DFLT
=> 'unified'
428 protected function getParamDescription() {
430 'prop' => 'Which properties to get for each revision.',
431 'limit' => 'limit how many revisions will be returned (enum)',
432 'startid' => 'from which revision id to start enumeration (enum)',
433 'endid' => 'stop revision enumeration on this revid (enum)',
434 'start' => 'from which revision timestamp to start enumeration (enum)',
435 'end' => 'enumerate up to this timestamp (enum)',
436 'dir' => 'direction of enumeration - towards "newer" or "older" revisions (enum)',
437 'user' => 'only include revisions made by user',
438 'excludeuser' => 'exclude revisions made by user',
439 'expandtemplates' => 'expand templates in revision content',
440 'diffto' => 'Revision number to compare all revisions with',
441 'difftoprev' => 'Diff each revision to the previous one (enum)',
442 'diffformat' => 'Format to use for diffs',
446 protected function getDescription() {
448 'Get revision information.',
449 'This module may be used in several ways:',
450 ' 1) Get data about a set of pages (last revision), by setting titles or pageids parameter.',
451 ' 2) Get revisions for one given page, by using titles/pageids with start/end/limit params.',
452 ' 3) Get data about a set of revisions by setting their IDs with revids parameter.',
453 'All parameters marked as (enum) may only be used with a single page (#2).'
457 protected function getExamples() {
459 'Get data with content for the last revision of titles "API" and "Main Page":',
460 ' api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content',
461 'Get last 5 revisions of the "Main Page":',
462 ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment',
463 'Get first 5 revisions of the "Main Page":',
464 ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer',
465 'Get first 5 revisions of the "Main Page" made after 2006-05-01:',
466 ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000',
467 'Get first 5 revisions of the "Main Page" that were not made made by anonymous user "127.0.0.1"',
468 ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1',
469 'Get first 5 revisions of the "Main Page" that were made by the user "MediaWiki default"',
470 ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default',
474 public function getVersion() {
475 return __CLASS__
. ': $Id$';