diff options
Diffstat (limited to 'includes/api/ApiQueryRevisions.php')
| -rw-r--r-- | includes/api/ApiQueryRevisions.php | 187 |
1 files changed, 133 insertions, 54 deletions
diff --git a/includes/api/ApiQueryRevisions.php b/includes/api/ApiQueryRevisions.php index fc5f6241..2672478b 100644 --- a/includes/api/ApiQueryRevisions.php +++ b/includes/api/ApiQueryRevisions.php @@ -5,7 +5,7 @@ * * API for MediaWiki 1.8+ * - * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com> + * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -29,6 +29,10 @@ if (!defined('MEDIAWIKI')) { } /** + * A query action to enumerate revisions of a given page, or show top revisions of multiple pages. + * Various pieces of information may be shown - flags, comments, and the actual wiki markup of the rev. + * In the enumeration mode, ranges of revisions may be requested and filtered. + * * @addtogroup API */ class ApiQueryRevisions extends ApiQueryBase { @@ -37,15 +41,18 @@ class ApiQueryRevisions extends ApiQueryBase { parent :: __construct($query, $moduleName, 'rv'); } + private $fld_ids = false, $fld_flags = false, $fld_timestamp = false, $fld_size = false, + $fld_comment = false, $fld_user = false, $fld_content = false; + public function execute() { - $limit = $startid = $endid = $start = $end = $dir = $prop = null; + $limit = $startid = $endid = $start = $end = $dir = $prop = $user = $excludeuser = null; extract($this->extractRequestParams()); // If any of those parameters are used, work in 'enumeration' mode. // Enum mode can only be used when exactly one page is provided. // Enumerating revisions on multiple pages make it extremelly // difficult to manage continuations and require additional sql indexes - $enumRevMode = (!is_null($limit) || !is_null($startid) || !is_null($endid) || $dir === 'newer' || !is_null($start) || !is_null($end)); + $enumRevMode = (!is_null($user) || !is_null($excludeuser) || !is_null($limit) || !is_null($startid) || !is_null($endid) || $dir === 'newer' || !is_null($start) || !is_null($end)); $pageSet = $this->getPageSet(); $pageCount = $pageSet->getGoodTitleCount(); @@ -59,39 +66,50 @@ class ApiQueryRevisions extends ApiQueryBase { $this->dieUsage('The revids= parameter may not be used with the list options (limit, startid, endid, dirNewer, start, end).', 'revids'); if ($pageCount > 1 && $enumRevMode) - $this->dieUsage('titles, pageids or a generator was used to supply multiple pages, but the limit, startid, endid, dirNewer, start, and end parameters may only be used on a single page.', 'multpages'); + $this->dieUsage('titles, pageids or a generator was used to supply multiple pages, but the limit, startid, endid, dirNewer, user, excludeuser, start, and end parameters may only be used on a single page.', 'multpages'); $this->addTables('revision'); - $this->addFields(array ( - 'rev_id', - 'rev_page', - 'rev_text_id', - 'rev_minor_edit' - )); $this->addWhere('rev_deleted=0'); - $showContent = false; + $prop = array_flip($prop); - if (!is_null($prop)) { - $prop = array_flip($prop); - $this->addFieldsIf('rev_timestamp', isset ($prop['timestamp'])); - $this->addFieldsIf('rev_comment', isset ($prop['comment'])); - if (isset ($prop['user'])) { - $this->addFields('rev_user'); - $this->addFields('rev_user_text'); - } - if (isset ($prop['content'])) { - $this->addTables('text'); - $this->addWhere('rev_text_id=old_id'); - $this->addFields('old_id'); - $this->addFields('old_text'); - $this->addFields('old_flags'); - $showContent = true; + // These field are needed regardless of the client requesting them + $this->addFields('rev_id'); + $this->addFields('rev_page'); + + // Optional fields + $this->fld_ids = isset ($prop['ids']); + // $this->addFieldsIf('rev_text_id', $this->fld_ids); // should this be exposed? + $this->fld_flags = $this->addFieldsIf('rev_minor_edit', isset ($prop['flags'])); + $this->fld_timestamp = $this->addFieldsIf('rev_timestamp', isset ($prop['timestamp'])); + $this->fld_comment = $this->addFieldsIf('rev_comment', isset ($prop['comment'])); + $this->fld_size = $this->addFieldsIf('rev_len', isset ($prop['size'])); + + if (isset ($prop['user'])) { + $this->addFields('rev_user'); + $this->addFields('rev_user_text'); + $this->fld_user = true; + } + if (isset ($prop['content'])) { + + // For each page we will request, the user must have read rights for that page + foreach ($pageSet->getGoodTitles() as $title) { + if( !$title->userCanRead() ) + $this->dieUsage( + 'The current user is not allowed to read ' . $title->getPrefixedText(), + 'accessdenied'); } + + $this->addTables('text'); + $this->addWhere('rev_text_id=old_id'); + $this->addFields('old_id'); + $this->addFields('old_text'); + $this->addFields('old_flags'); + $this->fld_content = true; } - $userMax = ($showContent ? 50 : 500); - $botMax = ($showContent ? 200 : 10000); + $userMax = ($this->fld_content ? 50 : 500); + $botMax = ($this->fld_content ? 200 : 10000); if ($enumRevMode) { @@ -102,6 +120,9 @@ class ApiQueryRevisions extends ApiQueryBase { if (!is_null($endid) && !is_null($end)) $this->dieUsage('end and endid cannot be used together', 'badparams'); + if(!is_null($user) && !is_null( $excludeuser)) + $this->dieUsage('user and excludeuser cannot be used together', 'badparams'); + // This code makes an assumption that sorting by rev_id and rev_timestamp produces // the same result. This way users may request revisions starting at a given time, // but to page through results use the rev_id returned after each page. @@ -117,10 +138,25 @@ class ApiQueryRevisions extends ApiQueryBase { // must manually initialize unset limit if (is_null($limit)) $limit = 10; - $this->validateLimit($this->encodeParamName('limit'), $limit, 1, $userMax, $botMax); + $this->validateLimit('limit', $limit, 1, $userMax, $botMax); // There is only one ID, use it $this->addWhereFld('rev_page', current(array_keys($pageSet->getGoodTitles()))); + + if(!is_null($user)) { + $this->addWhereFld('rev_user_text', $user); + } elseif (!is_null( $excludeuser)) { + $this->addWhere('rev_user_text != ' . $this->getDB()->addQuotes($excludeuser)); + } + } + elseif ($revCount > 0) { + $this->validateLimit('rev_count', $revCount, 1, $userMax, $botMax); + + // Get all revision IDs + $this->addWhereFld('rev_id', array_keys($pageSet->getRevisionIDs())); + + // assumption testing -- we should never get more then $revCount rows. + $limit = $revCount; } elseif ($pageCount > 0) { // When working in multi-page non-enumeration mode, @@ -133,15 +169,8 @@ class ApiQueryRevisions extends ApiQueryBase { // Get all page IDs $this->addWhereFld('page_id', array_keys($pageSet->getGoodTitles())); - $limit = $pageCount; // assumption testing -- we should never get more then $pageCount rows. - } - elseif ($revCount > 0) { - $this->validateLimit('rev_count', $revCount, 1, $userMax, $botMax); - - // Get all revision IDs - $this->addWhereFld('rev_id', array_keys($pageSet->getRevisionIDs())); - - $limit = $revCount; // assumption testing -- we should never get more then $revCount rows. + // assumption testing -- we should never get more then $pageCount rows. + $limit = $pageCount; } else ApiBase :: dieDebug(__METHOD__, 'param validation?'); @@ -158,21 +187,18 @@ class ApiQueryRevisions extends ApiQueryBase { // We've reached the one extra which shows that there are additional pages to be had. Stop here... if (!$enumRevMode) ApiBase :: dieDebug(__METHOD__, 'Got more rows then expected'); // bug report - $this->setContinueEnumParameter('startid', $row->rev_id); + $this->setContinueEnumParameter('startid', intval($row->rev_id)); break; } - $vals = $this->addRowInfo('rev', $row); - if ($vals) { - if ($showContent) - ApiResult :: setContent($vals, Revision :: getRevisionText($row)); - - $this->getResult()->addValue(array ( + $this->getResult()->addValue( + array ( 'query', 'pages', - intval($row->rev_page - ), 'revisions'), intval($row->rev_id), $vals); - } + intval($row->rev_page), + 'revisions'), + null, + $this->extractRowInfo($row)); } $db->freeResult($res); @@ -188,21 +214,62 @@ class ApiQueryRevisions extends ApiQueryBase { } } + private function extractRowInfo($row) { + + $vals = array (); + + if ($this->fld_ids) { + $vals['revid'] = intval($row->rev_id); + // $vals['oldid'] = intval($row->rev_text_id); // todo: should this be exposed? + } + + if ($this->fld_flags && $row->rev_minor_edit) + $vals['minor'] = ''; + + if ($this->fld_user) { + $vals['user'] = $row->rev_user_text; + if (!$row->rev_user) + $vals['anon'] = ''; + } + + if ($this->fld_timestamp) { + $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rev_timestamp); + } + + if ($this->fld_size && !is_null($row->rev_len)) { + $vals['size'] = intval($row->rev_len); + } + + if ($this->fld_comment && !empty ($row->rev_comment)) { + $vals['comment'] = $row->rev_comment; + } + + if ($this->fld_content) { + ApiResult :: setContent($vals, Revision :: getRevisionText($row)); + } + + return $vals; + } + protected function getAllowedParams() { return array ( 'prop' => array ( ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_DFLT => 'ids|timestamp|flags|comment|user', ApiBase :: PARAM_TYPE => array ( + 'ids', + 'flags', 'timestamp', 'user', + 'size', 'comment', - 'content' + 'content', ) ), 'limit' => array ( ApiBase :: PARAM_TYPE => 'limit', ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX1 => ApiBase :: LIMIT_SML1, + ApiBase :: PARAM_MAX => ApiBase :: LIMIT_SML1, ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_SML2 ), 'startid' => array ( @@ -223,6 +290,12 @@ class ApiQueryRevisions extends ApiQueryBase { 'newer', 'older' ) + ), + 'user' => array( + ApiBase :: PARAM_TYPE => 'user' + ), + 'excludeuser' => array( + ApiBase :: PARAM_TYPE => 'user' ) ); } @@ -235,7 +308,9 @@ class ApiQueryRevisions extends ApiQueryBase { 'endid' => 'stop revision enumeration on this revid (enum)', 'start' => 'from which revision timestamp to start enumeration (enum)', 'end' => 'enumerate up to this timestamp (enum)', - 'dir' => 'direction of enumeration - towards "newer" or "older" revisions (enum)' + 'dir' => 'direction of enumeration - towards "newer" or "older" revisions (enum)', + 'user' => 'only include revisions made by user', + 'excludeuser' => 'exclude revisions made by user', ); } @@ -259,12 +334,16 @@ class ApiQueryRevisions extends ApiQueryBase { 'Get first 5 revisions of the "Main Page":', ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer', 'Get first 5 revisions of the "Main Page" made after 2006-05-01:', - ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000' + ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000', + 'Get first 5 revisions of the "Main Page" that were not made made by anonymous user "127.0.0.1"', + ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1', + 'Get first 5 revisions of the "Main Page" that were made by the user "MediaWiki default"', + ' api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default', ); } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryRevisions.php 21402 2007-04-20 08:55:14Z nickj $'; + return __CLASS__ . ': $Id: ApiQueryRevisions.php 25407 2007-09-02 14:00:11Z tstarling $'; } } -?> + |