X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/mediawiki.git/blobdiff_plain/d7967d5e4460e08b6b258307afbca0596b18a3dd..74c929b24b048c9f1e31e17db757ae4195cd7673:/includes/api/ApiQueryRevisions.php diff --git a/includes/api/ApiQueryRevisions.php b/includes/api/ApiQueryRevisions.php index 2672478b..977e792b 100644 --- a/includes/api/ApiQueryRevisions.php +++ b/includes/api/ApiQueryRevisions.php @@ -30,10 +30,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 + * 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. + * + * @ingroup API */ class ApiQueryRevisions extends ApiQueryBase { @@ -44,15 +44,47 @@ class ApiQueryRevisions extends ApiQueryBase { private $fld_ids = false, $fld_flags = false, $fld_timestamp = false, $fld_size = false, $fld_comment = false, $fld_user = false, $fld_content = false; + protected function getTokenFunctions() { + // tokenname => function + // function prototype is func($pageid, $title, $rev) + // should return token or false + + // Don't call the hooks twice + if(isset($this->tokenFunctions)) + return $this->tokenFunctions; + + // If we're in JSON callback mode, no tokens can be obtained + if(!is_null($this->getMain()->getRequest()->getVal('callback'))) + return array(); + + $this->tokenFunctions = array( + 'rollback' => array( 'ApiQueryRevisions', 'getRollbackToken' ) + ); + wfRunHooks('APIQueryRevisionsTokens', array(&$this->tokenFunctions)); + return $this->tokenFunctions; + } + + public static function getRollbackToken($pageid, $title, $rev) + { + global $wgUser; + if(!$wgUser->isAllowed('rollback')) + return false; + return $wgUser->editToken(array($title->getPrefixedText(), + $rev->getUserText())); + } + public function execute() { - $limit = $startid = $endid = $start = $end = $dir = $prop = $user = $excludeuser = null; - extract($this->extractRequestParams()); + $params = $this->extractRequestParams(false); // 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($user) || !is_null($excludeuser) || !is_null($limit) || !is_null($startid) || !is_null($endid) || $dir === 'newer' || !is_null($start) || !is_null($end)); + // Enumerating revisions on multiple pages make it extremely + // difficult to manage continuations and require additional SQL indexes + $enumRevMode = (!is_null($params['user']) || !is_null($params['excludeuser']) || + !is_null($params['limit']) || !is_null($params['startid']) || + !is_null($params['endid']) || $params['dir'] === 'newer' || + !is_null($params['start']) || !is_null($params['end'])); + $pageSet = $this->getPageSet(); $pageCount = $pageSet->getGoodTitleCount(); @@ -66,30 +98,29 @@ 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, user, excludeuser, 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->addWhere('rev_deleted=0'); - - $prop = array_flip($prop); + $this->addFields( Revision::selectFields() ); + $this->addTables( 'page' ); + $this->addWhere('page_id = rev_page'); - // These field are needed regardless of the client requesting them - $this->addFields('rev_id'); - $this->addFields('rev_page'); + $prop = array_flip($params['prop']); // 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; + $this->fld_flags = isset ($prop['flags']); + $this->fld_timestamp = isset ($prop['timestamp']); + $this->fld_comment = isset ($prop['comment']); + $this->fld_size = isset ($prop['size']); + $this->fld_user = isset ($prop['user']); + $this->token = $params['token']; + + if ( !is_null($this->token) || $pageCount > 0) { + $this->addFields( Revision::selectPageFields() ); } + if (isset ($prop['content'])) { // For each page we will request, the user must have read rights for that page @@ -103,37 +134,51 @@ class ApiQueryRevisions extends ApiQueryBase { $this->addTables('text'); $this->addWhere('rev_text_id=old_id'); $this->addFields('old_id'); - $this->addFields('old_text'); - $this->addFields('old_flags'); + $this->addFields( Revision::selectTextFields() ); + $this->fld_content = true; + + $this->expandTemplates = $params['expandtemplates']; + $this->generateXML = $params['generatexml']; + if(isset($params['section'])) + $this->section = $params['section']; + else + $this->section = false; } - $userMax = ($this->fld_content ? 50 : 500); - $botMax = ($this->fld_content ? 200 : 10000); + $userMax = ( $this->fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1 ); + $botMax = ( $this->fld_content ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2 ); + $limit = $params['limit']; + if( $limit == 'max' ) { + $limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax; + $this->getResult()->addValue( 'limits', $this->getModuleName(), $limit ); + } if ($enumRevMode) { - // This is mostly to prevent parameter errors (and optimize sql?) - if (!is_null($startid) && !is_null($start)) + // This is mostly to prevent parameter errors (and optimize SQL?) + if (!is_null($params['startid']) && !is_null($params['start'])) $this->dieUsage('start and startid cannot be used together', 'badparams'); - if (!is_null($endid) && !is_null($end)) + if (!is_null($params['endid']) && !is_null($params['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'); - + if(!is_null($params['user']) && !is_null($params['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. - // Switching to rev_id removes the potential problem of having more than - // one row with the same timestamp for the same page. + // Switching to rev_id removes the potential problem of having more than + // one row with the same timestamp for the same page. // The order needs to be the same as start parameter to avoid SQL filesort. - if (is_null($startid)) - $this->addWhereRange('rev_timestamp', $dir, $start, $end); + if (is_null($params['startid']) && is_null($params['endid'])) + $this->addWhereRange('rev_timestamp', $params['dir'], + $params['start'], $params['end']); else - $this->addWhereRange('rev_id', $dir, $startid, $endid); + $this->addWhereRange('rev_id', $params['dir'], + $params['startid'], $params['endid']); // must manually initialize unset limit if (is_null($limit)) @@ -142,32 +187,39 @@ class ApiQueryRevisions extends ApiQueryBase { // 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)); + + if(!is_null($params['user'])) { + $this->addWhereFld('rev_user_text', $params['user']); + } elseif (!is_null( $params['excludeuser'])) { + $this->addWhere('rev_user_text != ' . + $this->getDB()->addQuotes($params['excludeuser'])); } } elseif ($revCount > 0) { - $this->validateLimit('rev_count', $revCount, 1, $userMax, $botMax); + $max = $this->getMain()->canApiHighLimits() ? $botMax : $userMax; + $revs = $pageSet->getRevisionIDs(); + if(self::truncateArray($revs, $max)) + $this->setWarning("Too many values supplied for parameter 'revids': the limit is $max"); // Get all revision IDs - $this->addWhereFld('rev_id', array_keys($pageSet->getRevisionIDs())); + $this->addWhereFld('rev_id', array_keys($revs)); // assumption testing -- we should never get more then $revCount rows. $limit = $revCount; } elseif ($pageCount > 0) { + $max = $this->getMain()->canApiHighLimits() ? $botMax : $userMax; + $titles = $pageSet->getGoodTitles(); + if(self::truncateArray($titles, $max)) + $this->setWarning("Too many values supplied for parameter 'titles': the limit is $max"); + // When working in multi-page non-enumeration mode, // limit to the latest revision only - $this->addTables('page'); $this->addWhere('page_id=rev_page'); $this->addWhere('page_latest=rev_id'); - $this->validateLimit('page_count', $pageCount, 1, $userMax, $botMax); - + // Get all page IDs - $this->addWhereFld('page_id', array_keys($pageSet->getGoodTitles())); + $this->addWhereFld('page_id', array_keys($titles)); // assumption testing -- we should never get more then $pageCount rows. $limit = $pageCount; @@ -191,14 +243,15 @@ class ApiQueryRevisions extends ApiQueryBase { break; } + $revision = new Revision( $row ); $this->getResult()->addValue( array ( 'query', 'pages', - intval($row->rev_page), + $revision->getPage(), 'revisions'), null, - $this->extractRowInfo($row)); + $this->extractRowInfo( $revision )); } $db->freeResult($res); @@ -214,44 +267,85 @@ class ApiQueryRevisions extends ApiQueryBase { } } - private function extractRowInfo($row) { + private function extractRowInfo( $revision ) { $vals = array (); if ($this->fld_ids) { - $vals['revid'] = intval($row->rev_id); + $vals['revid'] = $revision->getId(); // $vals['oldid'] = intval($row->rev_text_id); // todo: should this be exposed? } - - if ($this->fld_flags && $row->rev_minor_edit) + + if ($this->fld_flags && $revision->isMinor()) $vals['minor'] = ''; if ($this->fld_user) { - $vals['user'] = $row->rev_user_text; - if (!$row->rev_user) + $vals['user'] = $revision->getUserText(); + if (!$revision->getUser()) $vals['anon'] = ''; } if ($this->fld_timestamp) { - $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rev_timestamp); + $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $revision->getTimestamp()); + } + + if ($this->fld_size && !is_null($revision->getSize())) { + $vals['size'] = $revision->getSize(); } - - if ($this->fld_size && !is_null($row->rev_len)) { - $vals['size'] = intval($row->rev_len); + + if ($this->fld_comment) { + $comment = $revision->getComment(); + if (strval($comment) !== '') + $vals['comment'] = $comment; } - if ($this->fld_comment && !empty ($row->rev_comment)) { - $vals['comment'] = $row->rev_comment; + if(!is_null($this->token) || ($this->fld_content && $this->expandTemplates)) + $title = $revision->getTitle(); + + if(!is_null($this->token)) + { + $tokenFunctions = $this->getTokenFunctions(); + foreach($this->token as $t) + { + $val = call_user_func($tokenFunctions[$t], $title->getArticleID(), $title, $revision); + if($val === false) + $this->setWarning("Action '$t' is not allowed for the current user"); + else + $vals[$t . 'token'] = $val; + } } - + if ($this->fld_content) { - ApiResult :: setContent($vals, Revision :: getRevisionText($row)); + global $wgParser; + $text = $revision->getText(); + # Expand templates after getting section content because + # template-added sections don't count and Parser::preprocess() + # will have less input + if ($this->section !== false) { + $text = $wgParser->getSection( $text, $this->section, false); + if($text === false) + $this->dieUsage("There is no section {$this->section} in r".$revision->getId(), 'nosuchsection'); + } + if ($this->generateXML) { + $wgParser->startExternalParse( $title, new ParserOptions(), OT_PREPROCESS ); + $dom = $wgParser->preprocessToDom( $text ); + if ( is_callable( array( $dom, 'saveXML' ) ) ) { + $xml = $dom->saveXML(); + } else { + $xml = $dom->__toString(); + } + $vals['parsetree'] = $xml; + + } + if ($this->expandTemplates) { + $text = $wgParser->preprocess( $text, $title, new ParserOptions() ); + } + ApiResult :: setContent($vals, $text); } - return $vals; } - protected function getAllowedParams() { + public function getAllowedParams() { return array ( 'prop' => array ( ApiBase :: PARAM_ISMULTI => true, @@ -269,8 +363,8 @@ class ApiQueryRevisions extends ApiQueryBase { 'limit' => array ( ApiBase :: PARAM_TYPE => 'limit', ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX => ApiBase :: LIMIT_SML1, - ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_SML2 + ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, + ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 ), 'startid' => array ( ApiBase :: PARAM_TYPE => 'integer' @@ -296,11 +390,18 @@ class ApiQueryRevisions extends ApiQueryBase { ), 'excludeuser' => array( ApiBase :: PARAM_TYPE => 'user' - ) + ), + 'expandtemplates' => false, + 'generatexml' => false, + 'section' => null, + 'token' => array( + ApiBase :: PARAM_TYPE => array_keys($this->getTokenFunctions()), + ApiBase :: PARAM_ISMULTI => true + ), ); } - protected function getParamDescription() { + public function getParamDescription() { return array ( 'prop' => 'Which properties to get for each revision.', 'limit' => 'limit how many revisions will be returned (enum)', @@ -311,10 +412,14 @@ class ApiQueryRevisions extends ApiQueryBase { 'dir' => 'direction of enumeration - towards "newer" or "older" revisions (enum)', 'user' => 'only include revisions made by user', 'excludeuser' => 'exclude revisions made by user', + 'expandtemplates' => 'expand templates in revision content', + 'generatexml' => 'generate XML parse tree for revision content', + 'section' => 'only retrieve the content of this section', + 'token' => 'Which tokens to obtain for each revision', ); } - protected function getDescription() { + public function getDescription() { return array ( 'Get revision information.', 'This module may be used in several ways:', @@ -343,7 +448,6 @@ class ApiQueryRevisions extends ApiQueryBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryRevisions.php 25407 2007-09-02 14:00:11Z tstarling $'; + return __CLASS__ . ': $Id: ApiQueryRevisions.php 44719 2008-12-17 16:34:01Z catrope $'; } } -