class ApiQueryRevisions extends ApiQueryBase {
- public function __construct($query, $moduleName, $generator = false) {
- parent :: __construct($query, $moduleName, $generator);
+ public function __construct($query, $moduleName) {
+ parent :: __construct($query, $moduleName, 'rv');
}
public function execute() {
- $rvlimit = $rvstartid = $rvendid = $rvstart = $rvend = $rvdir = $rvprop = null;
+ $limit = $startid = $endid = $start = $end = $dir = $prop = null;
extract($this->extractRequestParams());
- $db = $this->getDB();
-
- // true when ordered by timestamp from older to newer, false otherwise
- $dirNewer = ($rvdir === 'newer');
-
// 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 = ($rvlimit !== 0 || $rvstartid !== 0 || $rvendid !== 0 || $dirNewer || isset ($rvstart) || isset ($rvend));
+ $enumRevMode = (!is_null($limit) || !is_null($startid) || !is_null($endid) || $dir === 'newer' || !is_null($start) || !is_null($end));
$pageSet = $this->getPageSet();
$pageCount = $pageSet->getGoodTitleCount();
if ($revCount === 0 && $pageCount === 0)
return;
- if ($revCount > 0 && $pageCount > 0)
- $this->dieUsage('The revids= parameter may not be used with titles, pageids, or generator options.', 'rv_revids');
-
if ($revCount > 0 && $enumRevMode)
- $this->dieUsage('The revids= parameter may not be used with the list options (rvlimit, rvstartid, rvendid, dirNewer, rvstart, rvend).', 'rv_revids');
+ $this->dieUsage('The revids= parameter may not be used with the list options (limit, startid, endid, dirNewer, start, end).', 'revids');
- if ($revCount === 0 && $pageCount > 1 && $enumRevMode)
- $this->dieUsage('titles, pageids or a generator was used to supply multiple pages, but the rvlimit, rvstartid, rvendid, dirNewer, rvstart, and rvend parameters may only be used on a single page.', 'rv_multpages');
+ 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');
- $tables = array (
- 'revision'
- );
- $fields = array (
+ $this->addTables('revision');
+ $this->addFields(array (
'rev_id',
'rev_page',
'rev_text_id',
'rev_minor_edit'
- );
- $conds = array (
- 'rev_deleted' => 0
- );
- $options = array ();
-
- $showTimestamp = $showUser = $showComment = $showContent = false;
- if (isset ($rvprop)) {
- foreach ($rvprop as $prop) {
- switch ($prop) {
- case 'timestamp' :
- $fields[] = 'rev_timestamp';
- $showTimestamp = true;
- break;
- case 'user' :
- $fields[] = 'rev_user';
- $fields[] = 'rev_user_text';
- $showUser = true;
- break;
- case 'comment' :
- $fields[] = 'rev_comment';
- $showComment = true;
- break;
- case 'content' :
- $tables[] = 'text';
- $conds[] = 'rev_text_id=old_id';
- $fields[] = 'old_id';
- $fields[] = 'old_text';
- $fields[] = 'old_flags';
- $showContent = true;
- break;
- default :
- ApiBase :: dieDebug(__METHOD__, "unknown rvprop $prop");
- }
+ ));
+ $this->addWhere('rev_deleted=0');
+
+ $showContent = false;
+
+ 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;
}
}
if ($enumRevMode) {
// This is mostly to prevent parameter errors (and optimize sql?)
- if ($rvstartid !== 0 && isset ($rvstart))
- $this->dieUsage('rvstart and rvstartid cannot be used together', 'rv_badparams');
+ if (!is_null($startid) && !is_null($start))
+ $this->dieUsage('start and startid cannot be used together', 'badparams');
- if ($rvendid !== 0 && isset ($rvend))
- $this->dieUsage('rvend and rvend cannot be used together', 'rv_badparams');
+ if (!is_null($endid) && !is_null($end))
+ $this->dieUsage('end and endid 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,
// 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.
- $options['ORDER BY'] = ($rvstartid !== 0 ? 'rev_id' : 'rev_timestamp') . ($dirNewer ? '' : ' DESC');
-
- $before = ($dirNewer ? '<=' : '>=');
- $after = ($dirNewer ? '>=' : '<=');
- if ($rvstartid !== 0)
- $conds[] = 'rev_id' . $after . intval($rvstartid);
- if ($rvendid !== 0)
- $conds[] = 'rev_id' . $before . intval($rvendid);
- if (isset ($rvstart))
- $conds[] = 'rev_timestamp' . $after . $db->addQuotes($rvstart);
- if (isset ($rvend))
- $conds[] = 'rev_timestamp' . $before . $db->addQuotes($rvend);
+ if (is_null($startid))
+ $this->addWhereRange('rev_timestamp', $dir, $start, $end);
+ else
+ $this->addWhereRange('rev_id', $dir, $startid, $endid);
- // must manually initialize unset rvlimit
- if (!isset ($rvlimit))
- $rvlimit = 10;
-
- $this->validateLimit('rvlimit', $rvlimit, 1, $userMax, $botMax);
+ // must manually initialize unset limit
+ if (is_null($limit))
+ $limit = 10;
+ $this->validateLimit($this->encodeParamName('limit'), $limit, 1, $userMax, $botMax);
// There is only one ID, use it
- $conds['rev_page'] = array_pop(array_keys($pageSet->getGoodTitles()));
-
+ $this->addWhereFld('rev_page', current(array_keys($pageSet->getGoodTitles())));
}
elseif ($pageCount > 0) {
// When working in multi-page non-enumeration mode,
// limit to the latest revision only
- $tables[] = 'page';
- $conds[] = 'page_id=rev_page';
- $conds[] = 'page_latest=rev_id';
+ $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
- $conds['page_id'] = array_keys($pageSet->getGoodTitles());
+ $this->addWhereFld('page_id', array_keys($pageSet->getGoodTitles()));
- $rvlimit = $pageCount; // assumption testing -- we should never get more then $pageCount rows.
+ $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
- $conds['rev_id'] = array_keys($pageSet->getRevisionIDs());
+ $this->addWhereFld('rev_id', array_keys($pageSet->getRevisionIDs()));
- $rvlimit = $revCount; // assumption testing -- we should never get more then $revCount rows.
+ $limit = $revCount; // assumption testing -- we should never get more then $revCount rows.
} else
ApiBase :: dieDebug(__METHOD__, 'param validation?');
- $options['LIMIT'] = $rvlimit +1;
-
- $this->profileDBIn();
- $res = $db->select($tables, $fields, $conds, __METHOD__, $options);
- $this->profileDBOut();
+ $this->addOption('LIMIT', $limit +1);
$data = array ();
$count = 0;
+ $res = $this->select(__METHOD__);
+
+ $db = & $this->getDB();
while ($row = $db->fetchObject($res)) {
- if (++ $count > $rvlimit) {
+ if (++ $count > $limit) {
// 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
-
- $startStr = 'rvstartid=' . $row->rev_id;
- $msg = array (
- 'continue' => $startStr
- );
- $this->getResult()->addValue('query-status', 'revisions', $msg);
+ $this->setContinueEnumParameter('startid', $row->rev_id);
break;
}
- $vals = array (
- 'revid' => intval($row->rev_id
- ), 'oldid' => intval($row->rev_text_id));
-
- if ($row->rev_minor_edit) {
- $vals['minor'] = '';
- }
-
- if ($showTimestamp)
- $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rev_timestamp);
-
- if ($showUser) {
- $vals['user'] = $row->rev_user_text;
- if (!$row->rev_user)
- $vals['anon'] = '';
- }
-
- if ($showComment)
- $vals['comment'] = $row->rev_comment;
+ $vals = $this->addRowInfo('rev', $row);
+ if ($vals) {
+ if ($showContent)
+ ApiResult :: setContent($vals, Revision :: getRevisionText($row));
- if ($showContent) {
- ApiResult :: setContent($vals, Revision :: getRevisionText($row));
+ $this->getResult()->addValue(array (
+ 'query',
+ 'pages',
+ intval($row->rev_page
+ ), 'revisions'), intval($row->rev_id), $vals);
}
-
- $this->getResult()->addValue(array (
- 'query',
- 'pages',
- intval($row->rev_page
- ), 'revisions'), intval($row->rev_id), $vals);
}
$db->freeResult($res);
- // Ensure that all revisions are shown as '<r>' elements
- $data = & $this->getResultData();
- foreach ($data['query']['pages'] as & $page) {
- if (is_array($page) && array_key_exists('revisions', $page)) {
- ApiResult :: setIndexedTagName($page['revisions'], 'rev');
+ // Ensure that all revisions are shown as '<rev>' elements
+ $result = $this->getResult();
+ if ($result->getIsRawMode()) {
+ $data =& $result->getData();
+ foreach ($data['query']['pages'] as & $page) {
+ if (is_array($page) && array_key_exists('revisions', $page)) {
+ $result->setIndexedTagName($page['revisions'], 'rev');
+ }
}
}
}
protected function getAllowedParams() {
return array (
- 'rvprop' => array (
+ 'prop' => array (
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array (
'timestamp',
'content'
)
),
- 'rvlimit' => array (
- ApiBase :: PARAM_DFLT => 0,
+ 'limit' => array (
ApiBase :: PARAM_TYPE => 'limit',
- ApiBase :: PARAM_MIN => 0,
- ApiBase :: PARAM_MAX1 => 50,
- ApiBase :: PARAM_MAX2 => 500
+ ApiBase :: PARAM_MIN => 1,
+ ApiBase :: PARAM_MAX1 => ApiBase :: LIMIT_SML1,
+ ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_SML2
+ ),
+ 'startid' => array (
+ ApiBase :: PARAM_TYPE => 'integer'
+ ),
+ 'endid' => array (
+ ApiBase :: PARAM_TYPE => 'integer'
),
- 'rvstartid' => 0,
- 'rvendid' => 0,
- 'rvstart' => array (
+ 'start' => array (
ApiBase :: PARAM_TYPE => 'timestamp'
),
- 'rvend' => array (
+ 'end' => array (
ApiBase :: PARAM_TYPE => 'timestamp'
),
- 'rvdir' => array (
+ 'dir' => array (
ApiBase :: PARAM_DFLT => 'older',
ApiBase :: PARAM_TYPE => array (
'newer',
protected function getParamDescription() {
return array (
- 'rvprop' => 'Which properties to get for each revision: user|timestamp|comment|content',
- 'rvlimit' => 'limit how many revisions will be returned (enum)',
- 'rvstartid' => 'from which revision id to start enumeration (enum)',
- 'rvendid' => 'stop revision enumeration on this revid (enum)',
- 'rvstart' => 'from which revision timestamp to start enumeration (enum)',
- 'rvend' => 'enumerate up to this timestamp (enum)',
- 'rvdir' => 'direction of enumeration - towards "newer" or "older" revisions (enum)'
+ 'prop' => 'Which properties to get for each revision.',
+ 'limit' => 'limit how many revisions will be returned (enum)',
+ 'startid' => 'from which revision id to start enumeration (enum)',
+ '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)'
);
}
'Get revision information.',
'This module 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 rvstart/rvend/rvlimit params.',
+ ' 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.',
'All parameters marked as (enum) may only be used with a single page (#2).'
);
return __CLASS__ . ': $Id$';
}
}
-?>
\ No newline at end of file
+?>
dépôts / lhc / web / wiklou.git / blobdiff