summaryrefslogtreecommitdiff
path: root/includes/api/ApiQueryRevisions.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/api/ApiQueryRevisions.php')
-rw-r--r--includes/api/ApiQueryRevisions.php183
1 files changed, 112 insertions, 71 deletions
diff --git a/includes/api/ApiQueryRevisions.php b/includes/api/ApiQueryRevisions.php
index e22d3b30..1fd2d7c6 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,16 +44,45 @@ 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 = $token = null;
+ $limit = $startid = $endid = $start = $end = $dir = $prop = $user = $excludeuser = $expandtemplates = $section = $token = null;
extract($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 extremely
- // difficult to manage continuations and require additional SQL indexes
+ // Enumerating revisions on multiple pages make it extremely
+ // 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));
-
+
$pageSet = $this->getPageSet();
$pageCount = $pageSet->getGoodTitleCount();
@@ -70,35 +99,26 @@ class ApiQueryRevisions extends ApiQueryBase {
$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');
+ $this->addFields( Revision::selectFields() );
$prop = array_flip($prop);
- // 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']));
- $this->tok_rollback = false; // Prevent PHP undefined property notice
- if(!is_null($token))
- {
- $this->tok_rollback = $this->getTokenFlag($token, 'rollback');
+ $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 = $token;
+
+ if ( !is_null($this->token) || ( $this->fld_content && $this->expandTemplates ) || $pageCount > 0) {
+ $this->addTables( 'page' );
+ $this->addWhere('page_id=rev_page');
+ $this->addFields( Revision::selectPageFields() );
}
- if (isset ($prop['user'])) {
- $this->addFields('rev_user');
- $this->addFields('rev_user_text');
- $this->fld_user = true;
- }
- else if($this->tok_rollback)
- $this->addFields('rev_user_text');
-
if (isset ($prop['content'])) {
// For each page we will request, the user must have read rights for that page
@@ -112,12 +132,15 @@ 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 = $expandtemplates;
+ if(isset($section))
+ $this->section = $section;
+ else
+ $this->section = false;
}
$userMax = ( $this->fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1 );
@@ -137,13 +160,13 @@ class ApiQueryRevisions extends ApiQueryBase {
$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->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) && is_null($endid))
@@ -158,7 +181,7 @@ 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)) {
@@ -177,7 +200,6 @@ class ApiQueryRevisions extends ApiQueryBase {
elseif ($pageCount > 0) {
// 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);
@@ -207,17 +229,18 @@ 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);
-
+
// Ensure that all revisions are shown as '<rev>' elements
$result = $this->getResult();
if ($result->getIsRawMode()) {
@@ -230,53 +253,70 @@ 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($row->rev_len)) {
- $vals['size'] = intval($row->rev_len);
+
+ if ($this->fld_size && !is_null($revision->getSize())) {
+ $vals['size'] = $revision->getSize();
}
- if ($this->fld_comment && !empty ($row->rev_comment)) {
- $vals['comment'] = $row->rev_comment;
+ if ($this->fld_comment) {
+ $comment = $revision->getComment();
+ if (!empty($comment))
+ $vals['comment'] = $comment;
}
-
- if($this->tok_rollback || ($this->fld_content && $this->expandTemplates))
- $title = Title::newFromID($row->rev_page);
-
- if($this->tok_rollback) {
- global $wgUser;
- $vals['rollbacktoken'] = $wgUser->editToken(array($title->getPrefixedText(), $row->rev_user_text));
+
+ 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) {
- $text = 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->expandTemplates) {
- global $wgParser;
$text = $wgParser->preprocess( $text, $title, new ParserOptions() );
}
ApiResult :: setContent($vals, $text);
- }
+ }
return $vals;
}
@@ -326,12 +366,13 @@ class ApiQueryRevisions extends ApiQueryBase {
'excludeuser' => array(
ApiBase :: PARAM_TYPE => 'user'
),
-
+
'expandtemplates' => false,
+ 'section' => array(
+ ApiBase :: PARAM_TYPE => 'integer'
+ ),
'token' => array(
- ApiBase :: PARAM_TYPE => array(
- 'rollback'
- ),
+ ApiBase :: PARAM_TYPE => array_keys($this->getTokenFunctions()),
ApiBase :: PARAM_ISMULTI => true
),
);
@@ -349,6 +390,7 @@ class ApiQueryRevisions extends ApiQueryBase {
'user' => 'only include revisions made by user',
'excludeuser' => 'exclude revisions made by user',
'expandtemplates' => 'expand templates in revision content',
+ 'section' => 'only retrieve the content of this section',
'token' => 'Which tokens to obtain for each revision',
);
}
@@ -382,7 +424,6 @@ class ApiQueryRevisions extends ApiQueryBase {
}
public function getVersion() {
- return __CLASS__ . ': $Id: ApiQueryRevisions.php 31259 2008-02-25 14:14:55Z catrope $';
+ return __CLASS__ . ': $Id: ApiQueryRevisions.php 37300 2008-07-08 08:42:27Z btongminh $';
}
}
-