<?php
/**
- * API for MediaWiki 1.8+
+ *
*
* Created on Sep 7, 2006
*
*/
class ApiQueryRevisions extends ApiQueryBase {
+ private $diffto, $difftotext, $expandTemplates, $generateXML, $section,
+ $token, $parseContent;
+
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'rv' );
}
$fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
$fld_content = false, $fld_tags = false;
+ private $tokenFunctions;
+
protected function getTokenFunctions() {
// tokenname => function
// function prototype is func($pageid, $title, $rev)
return $this->tokenFunctions;
}
+ /**
+ * @param $pageid
+ * @param $title Title
+ * @param $rev Revision
+ * @return bool|String
+ */
public static function getRollbackToken( $pageid, $title, $rev ) {
global $wgUser;
if ( !$wgUser->isAllowed( 'rollback' ) ) {
$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->diffto = $this->difftotext = null;
if ( !is_null( $params['difftotext'] ) ) {
$this->difftotext = $params['difftotext'];
} elseif ( !is_null( $params['diffto'] ) ) {
$params['diffto'] = 0;
}
if ( ( !ctype_digit( $params['diffto'] ) || $params['diffto'] < 0 )
- && $params['diffto'] != 'prev' && $params['diffto'] != 'next' )
- {
+ && $params['diffto'] != 'prev' && $params['diffto'] != 'next' ) {
$this->dieUsage( 'rvdiffto must be set to a non-negative number, "prev", "next" or "cur"', 'diffto' );
}
// Check whether the revision exists and is readable,
}
$db = $this->getDB();
- $this->addTables( array( 'page', 'revision' ) );
+ $this->addTables( 'page' );
$this->addFields( Revision::selectFields() );
$this->addWhere( 'page_id = rev_page' );
// Possible indexes used
$index = array();
+ $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()->setParsedLimit( $this->getModuleName(), $limit );
+ }
+
if ( !is_null( $this->token ) || $pageCount > 0 ) {
$this->addFields( Revision::selectPageFields() );
}
$this->expandTemplates = $params['expandtemplates'];
$this->generateXML = $params['generatexml'];
+ $this->parseContent = $params['parse'];
+ if ( $this->parseContent ) {
+ // Must manually initialize unset limit
+ if ( is_null( $limit ) ) {
+ $limit = 1;
+ }
+ // We are only going to parse 1 revision per request
+ $this->validateLimit( 'limit', $limit, 1, 1, 1 );
+ }
if ( isset( $params['section'] ) ) {
$this->section = $params['section'];
} else {
}
}
- $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()->setParsedLimit( $this->getModuleName(), $limit );
- }
+ // Bug 24166 - API error when using rvprop=tags
+ $this->addTables( 'revision' );
if ( $enumRevMode ) {
// This is mostly to prevent parameter errors (and optimize SQL?)
if ( $this->fld_user ) {
$vals['user'] = $revision->getUserText();
}
- if ( $this->fld_userid ) {
- $user = User::newFromText( $revision->getUserText() );
- $vals['userid'] = $user->getId();
- }
- if ( !$revision->getUser() ) {
+ $userid = $revision->getUser();
+ if ( !$userid ) {
$vals['anon'] = '';
}
+
+ if ( $this->fld_userid ) {
+ $vals['userid'] = $userid;
+ }
}
}
}
if ( $this->fld_parsedcomment ) {
- global $wgUser;
- $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $comment, $title );
+ $vals['parsedcomment'] = Linker::formatComment( $comment, $title );
}
}
}
$vals['parsetree'] = $xml;
}
- if ( $this->expandTemplates ) {
+ if ( $this->expandTemplates && !$this->parseContent ) {
$text = $wgParser->preprocess( $text, $title, new ParserOptions() );
}
+ if ( $this->parseContent ) {
+ $text = $wgParser->parse( $text, $title, new ParserOptions() )->getText();
+ }
ApiResult::setContent( $vals, $text );
} elseif ( $this->fld_content ) {
$vals['texthidden'] = '';
'tag' => null,
'expandtemplates' => false,
'generatexml' => false,
+ 'parse' => false,
'section' => null,
'token' => array(
ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
' flags - Revision flags (minor)',
' timestamp - The timestamp of the revision',
' user - User that made the revision',
- ' userid - User id of revision creator',
+ ' userid - User id of revision creator',
' size - Length of the revision',
' comment - Comment by the user for revision',
' parsedcomment - Parsed comment by the user for the revision',
'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' => $this->getDirectionDescription( $p ),
'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',
+ 'parse' => 'Parse revision content. For performance reasons if this option is used, rvlimit is enforced to 1.',
'section' => 'Only retrieve the content of this section number',
'token' => 'Which tokens to obtain for each revision',
'continue' => 'When more results are available, use this to continue',
public function getDescription() {
return array(
'Get revision information',
- 'This module may be used in several ways:',
+ 'May be used in several ways:',
' 1) Get data about a set of pages (last revision), by setting titles or pageids parameter',
' 2) Get revisions for one given page, by using titles/pageids with start/end/limit params',
' 3) Get data about a set of revisions by setting their IDs with revids parameter',
) );
}
- protected function getExamples() {
+ public function getExamples() {
return array(
'Get data with content for the last revision of titles "API" and "Main Page":',
' api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content',
);
}
+ public function getHelpUrls() {
+ return 'http://www.mediawiki.org/wiki/API:Properties#revisions_.2F_rv';
+ }
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}