/**
* This query action allows clients to retrieve a list of recently modified pages
* that are part of the logged-in user's watchlist.
- *
- * @addtogroup API
+ *
+ * @ingroup API
*/
class ApiQueryWatchlist extends ApiQueryGeneratorBase {
}
private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false,
- $fld_timestamp = false, $fld_user = false, $fld_comment = false;
-
+ $fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_sizes = false;
+
private function run($resultPageSet = null) {
global $wgUser, $wgDBtype;
$this->selectNamedDB('watchlist', DB_SLAVE, 'watchlist');
- if (!$wgUser->isLoggedIn())
- $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
+ $params = $this->extractRequestParams();
- $allrev = $start = $end = $namespace = $dir = $limit = $prop = null;
- extract($this->extractRequestParams());
+ if (!is_null($params['owner']) && !is_null($params['token'])) {
+ $user = User::newFromName($params['owner'],false);
+ if( !$user->getId() ) {
+ $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
+ }
+ $token = $user->getOption('watchlisttoken');
+ if ($token == '' || $token != $params['token']) {
+ $this->dieUsage('Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken');
+ }
+ } elseif (!$wgUser->isLoggedIn()) {
+ $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
+ } else {
+ $user = $wgUser;
+ }
- if (!is_null($prop) && is_null($resultPageSet)) {
+ if (!is_null($params['prop']) && is_null($resultPageSet)) {
- $prop = array_flip($prop);
+ $prop = array_flip($params['prop']);
$this->fld_ids = isset($prop['ids']);
$this->fld_title = isset($prop['title']);
$this->fld_user = isset($prop['user']);
$this->fld_comment = isset($prop['comment']);
$this->fld_timestamp = isset($prop['timestamp']);
+ $this->fld_sizes = isset($prop['sizes']);
$this->fld_patrol = isset($prop['patrol']);
if ($this->fld_patrol) {
- global $wgUseRCPatrol, $wgUser;
- if (!$wgUseRCPatrol || !$wgUser->isAllowed('patrol'))
+ if (!$user->useRCPatrol() && !$user->useNPPatrol())
$this->dieUsage('patrol property is not available', 'patrol');
}
}
$this->addFieldsIf('rc_new', $this->fld_flags);
$this->addFieldsIf('rc_minor', $this->fld_flags);
+ $this->addFieldsIf('rc_bot', $this->fld_flags);
$this->addFieldsIf('rc_user', $this->fld_user);
$this->addFieldsIf('rc_user_text', $this->fld_user);
$this->addFieldsIf('rc_comment', $this->fld_comment);
$this->addFieldsIf('rc_patrolled', $this->fld_patrol);
+ $this->addFieldsIf('rc_old_len', $this->fld_sizes);
+ $this->addFieldsIf('rc_new_len', $this->fld_sizes);
}
- elseif ($allrev) {
+ elseif ($params['allrev']) {
$this->addFields(array (
'rc_this_oldid',
'rc_namespace',
'recentchanges'
));
- $userId = $wgUser->getID();
+ $userId = $user->getId();
$this->addWhere(array (
'wl_namespace = rc_namespace',
'wl_title = rc_title',
'rc_deleted' => 0,
));
- $this->addWhereRange('rc_timestamp', $dir, $start, $end);
- $this->addWhereFld('wl_namespace', $namespace);
- $this->addWhereIf('rc_this_oldid=page_latest', !$allrev);
-
- # This is a index optimization for mysql, as done in the Special:Watchlist page
- $this->addWhereIf("rc_timestamp > ''", !isset ($start) && !isset ($end) && $wgDBtype == 'mysql');
+ $this->addWhereRange('rc_timestamp', $params['dir'], $params['start'], $params['end']);
+ $this->addWhereFld('wl_namespace', $params['namespace']);
+ $this->addWhereIf('rc_this_oldid=page_latest', !$params['allrev']);
+
+ if (!is_null($params['show'])) {
+ $show = array_flip($params['show']);
+
+ /* Check for conflicting parameters. */
+ if ((isset ($show['minor']) && isset ($show['!minor']))
+ || (isset ($show['bot']) && isset ($show['!bot']))
+ || (isset ($show['anon']) && isset ($show['!anon']))
+ || (isset ($show['patrolled']) && isset ($show['!patrolled']))) {
+
+ $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
+ }
+
+ // Check permissions. FIXME: should this check $user instead of
+ // $wgUser?
+ global $wgUser;
+ if((isset($show['patrolled']) || isset($show['!patrolled'])) && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol())
+ $this->dieUsage("You need the patrol right to request the patrolled flag", 'permissiondenied');
+
+ /* Add additional conditions to query depending upon parameters. */
+ $this->addWhereIf('rc_minor = 0', isset ($show['!minor']));
+ $this->addWhereIf('rc_minor != 0', isset ($show['minor']));
+ $this->addWhereIf('rc_bot = 0', isset ($show['!bot']));
+ $this->addWhereIf('rc_bot != 0', isset ($show['bot']));
+ $this->addWhereIf('rc_user = 0', isset ($show['anon']));
+ $this->addWhereIf('rc_user != 0', isset ($show['!anon']));
+ $this->addWhereIf('rc_patrolled = 0', isset($show['!patrolled']));
+ $this->addWhereIf('rc_patrolled != 0', isset($show['patrolled']));
+ }
+
+ if(!is_null($params['user']) && !is_null($params['excludeuser']))
+ $this->dieUsage('user and excludeuser cannot be used together', 'user-excludeuser');
+ if(!is_null($params['user']))
+ $this->addWhereFld('rc_user_text', $params['user']);
+ if(!is_null($params['excludeuser']))
+ $this->addWhere('rc_user_text != ' . $this->getDB()->addQuotes($params['excludeuser']));
+
- $this->addOption('LIMIT', $limit +1);
+ # This is an index optimization for mysql, as done in the Special:Watchlist page
+ $this->addWhereIf("rc_timestamp > ''", !isset ($params['start']) && !isset ($params['end']) && $wgDBtype == 'mysql');
- $data = array ();
+ $this->addOption('LIMIT', $params['limit'] +1);
+
+ $ids = array ();
$count = 0;
$res = $this->select(__METHOD__);
$db = $this->getDB();
while ($row = $db->fetchObject($res)) {
- if (++ $count > $limit) {
+ if (++ $count > $params['limit']) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
- $this->setContinueEnumParameter('start', $row->rc_timestamp);
+ $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->rc_timestamp));
break;
}
if (is_null($resultPageSet)) {
$vals = $this->extractRowInfo($row);
- if ($vals)
- $data[] = $vals;
+ $fit = $this->getResult()->addValue(array('query', $this->getModuleName()), null, $vals);
+ if(!$fit)
+ {
+ $this->setContinueEnumParameter('start',
+ wfTimestamp(TS_ISO_8601, $row->rc_timestamp));
+ break;
+ }
} else {
- $title = Title :: makeTitle($row->rc_namespace, $row->rc_title);
- // skip any pages that user has no rights to read
- if ($title->userCanRead()) {
- if ($allrev) {
- $data[] = intval($row->rc_this_oldid);
- } else {
- $data[] = intval($row->rc_cur_id);
- }
+ if ($params['allrev']) {
+ $ids[] = intval($row->rc_this_oldid);
+ } else {
+ $ids[] = intval($row->rc_cur_id);
}
}
}
$db->freeResult($res);
if (is_null($resultPageSet)) {
- $this->getResult()->setIndexedTagName($data, 'item');
- $this->getResult()->addValue('query', $this->getModuleName(), $data);
+ $this->getResult()->setIndexedTagName_internal(array('query', $this->getModuleName()), 'item');
}
- elseif ($allrev) {
- $resultPageSet->populateFromRevisionIDs($data);
+ elseif ($params['allrev']) {
+ $resultPageSet->populateFromRevisionIDs($ids);
} else {
- $resultPageSet->populateFromPageIDs($data);
+ $resultPageSet->populateFromPageIDs($ids);
}
}
private function extractRowInfo($row) {
- $title = Title :: makeTitle($row->rc_namespace, $row->rc_title);
- if (!$title->userCanRead())
- return false;
-
$vals = array ();
if ($this->fld_ids) {
$vals['pageid'] = intval($row->rc_cur_id);
- $vals['revid'] = intval($row->rc_this_oldid);
+ $vals['revid'] = intval($row->rc_this_oldid);
}
-
+
if ($this->fld_title)
- ApiQueryBase :: addTitleInfo($vals, $title);
+ ApiQueryBase :: addTitleInfo($vals, Title :: makeTitle($row->rc_namespace, $row->rc_title));
if ($this->fld_user) {
$vals['user'] = $row->rc_user_text;
$vals['new'] = '';
if ($row->rc_minor)
$vals['minor'] = '';
+ if ($row->rc_bot)
+ $vals['bot'] = '';
}
if ($this->fld_patrol && isset($row->rc_patrolled))
if ($this->fld_timestamp)
$vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rc_timestamp);
- if ($this->fld_comment && !empty ($row->rc_comment))
+ if ($this->fld_sizes) {
+ $vals['oldlen'] = intval($row->rc_old_len);
+ $vals['newlen'] = intval($row->rc_new_len);
+ }
+
+ if ($this->fld_comment && isset( $row->rc_comment ))
$vals['comment'] = $row->rc_comment;
return $vals;
}
- protected function getAllowedParams() {
+ public function getAllowedParams() {
return array (
'allrev' => false,
'start' => array (
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => 'namespace'
),
+ 'user' => array(
+ ApiBase :: PARAM_TYPE => 'user',
+ ),
+ 'excludeuser' => array(
+ ApiBase :: PARAM_TYPE => 'user',
+ ),
'dir' => array (
ApiBase :: PARAM_DFLT => 'older',
ApiBase :: PARAM_TYPE => array (
'user',
'comment',
'timestamp',
- 'patrol'
+ 'patrol',
+ 'sizes',
)
+ ),
+ 'show' => array (
+ ApiBase :: PARAM_ISMULTI => true,
+ ApiBase :: PARAM_TYPE => array (
+ 'minor',
+ '!minor',
+ 'bot',
+ '!bot',
+ 'anon',
+ '!anon',
+ 'patrolled',
+ '!patrolled',
+ )
+ ),
+ 'owner' => array (
+ ApiBase :: PARAM_TYPE => 'user'
+ ),
+ 'token' => array (
+ ApiBase :: PARAM_TYPE => 'string'
)
);
}
- protected function getParamDescription() {
+ public function getParamDescription() {
return array (
'allrev' => 'Include multiple revisions of the same page within given timeframe.',
'start' => 'The timestamp to start enumerating from.',
'end' => 'The timestamp to end enumerating.',
'namespace' => 'Filter changes to only the given namespace(s).',
+ 'user' => 'Only list changes by this user',
+ 'excludeuser' => 'Don\'t list changes by this user',
'dir' => 'In which direction to enumerate pages.',
- 'limit' => 'How many total pages to return per request.',
- 'prop' => 'Which additional items to get (non-generator mode only).'
+ 'limit' => 'How many total results to return per request.',
+ 'prop' => 'Which additional items to get (non-generator mode only).',
+ 'show' => array (
+ 'Show only items that meet this criteria.',
+ 'For example, to see only minor edits done by logged-in users, set show=minor|!anon'
+ ),
+ 'owner' => "The name of the user whose watchlist you'd like to access",
+ 'token' => "Give a security token (settable in preferences) to allow access to another user's watchlist"
);
}
- protected function getDescription() {
- return '';
+ public function getDescription() {
+ return "Get all recent changes to pages in the logged in user's watchlist";
}
protected function getExamples() {
'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
'api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment',
'api.php?action=query&generator=watchlist&prop=info',
- 'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user'
+ 'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user',
+ 'api.php?action=query&list=watchlist&wlowner=Bob_Smith&wltoken=d8d562e9725ea1512894cdab28e5ceebc7f20237'
);
}
return __CLASS__ . ': $Id$';
}
}
-?>
dépôts / lhc / web / wiklou.git / blobdiff