<?php
-
/*
* Created on Sep 25, 2006
*
* API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
require_once ('ApiQueryBase.php');
}
+/**
+ * This query action allows clients to retrieve a list of recently modified pages
+ * that are part of the logged-in user's watchlist.
+ *
+ * @ingroup API
+ */
class ApiQueryWatchlist extends ApiQueryGeneratorBase {
public function __construct($query, $moduleName) {
$this->run($resultPageSet);
}
+ private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false,
+ $fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_sizes = false;
+
private function run($resultPageSet = null) {
- global $wgUser;
+ global $wgUser, $wgDBtype;
+
+ $this->selectNamedDB('watchlist', DB_SLAVE, 'watchlist');
if (!$wgUser->isLoggedIn())
$this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
- $allrev = $start = $end = $namespace = $dir = $limit = $prop = null;
+ $allrev = $start = $end = $namespace = $dir = $limit = $prop = $show = null;
extract($this->extractRequestParams());
- $db = $this->getDB();
-
- $dirNewer = ($dir === 'newer');
- $before = ($dirNewer ? '<=' : '>=');
- $after = ($dirNewer ? '>=' : '<=');
-
- $tables = array (
- 'watchlist',
- 'page',
- 'recentchanges'
- );
-
- $options = array (
- 'LIMIT' => $limit +1,
- 'ORDER BY' => 'rc_timestamp' . ($dirNewer ? '' : ' DESC'
- ));
+ if (!is_null($prop) && is_null($resultPageSet)) {
- $patrol = $timestamp = $user = $comment = false;
- if (!is_null($prop)) {
- if (!is_null($resultPageSet))
- $this->dieUsage('prop parameter may not be used in a generator', 'params');
+ $prop = array_flip($prop);
- $user = (false !== array_search('user', $prop));
- $comment = (false !== array_search('comment', $prop));
- $timestamp = (false !== array_search('timestamp', $prop));
- $patrol = (false !== array_search('patrol', $prop));
+ $this->fld_ids = isset($prop['ids']);
+ $this->fld_title = isset($prop['title']);
+ $this->fld_flags = isset($prop['flags']);
+ $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 ($patrol) {
+ if ($this->fld_patrol) {
global $wgUseRCPatrol, $wgUser;
if (!$wgUseRCPatrol || !$wgUser->isAllowed('patrol'))
$this->dieUsage('patrol property is not available', 'patrol');
}
if (is_null($resultPageSet)) {
- $fields = array (
- 'rc_cur_id AS page_id',
- 'rc_this_oldid AS rev_id',
- 'rc_namespace AS page_namespace',
- 'rc_title AS page_title',
- 'rc_new AS page_is_new',
- 'rc_minor AS rev_minor_edit'
- );
- if ($user) {
- $fields[] = 'rc_user AS rev_user';
- $fields[] = 'rc_user_text AS rev_user_text';
- }
- if ($comment)
- $fields[] = 'rc_comment AS rev_comment';
- if ($timestamp)
- $fields[] = 'rc_timestamp AS rev_timestamp';
- if ($patrol)
- $fields[] = 'rc_patrolled';
+ $this->addFields(array (
+ 'rc_cur_id',
+ 'rc_this_oldid',
+ 'rc_namespace',
+ 'rc_title',
+ 'rc_timestamp'
+ ));
+
+ $this->addFieldsIf('rc_new', $this->fld_flags);
+ $this->addFieldsIf('rc_minor', $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) {
- $fields = array (
- 'rc_this_oldid AS rev_id',
- 'rc_namespace AS page_namespace',
- 'rc_title AS page_title',
- 'rc_timestamp AS rev_timestamp'
- );
+ $this->addFields(array (
+ 'rc_this_oldid',
+ 'rc_namespace',
+ 'rc_title',
+ 'rc_timestamp'
+ ));
} else {
- $fields = array (
- 'rc_cur_id AS page_id',
- 'rc_namespace AS page_namespace',
- 'rc_title AS page_title',
- 'rc_timestamp AS rev_timestamp'
- );
+ $this->addFields(array (
+ 'rc_cur_id',
+ 'rc_namespace',
+ 'rc_title',
+ 'rc_timestamp'
+ ));
}
- $where = array (
+ $this->addTables(array (
+ 'watchlist',
+ 'page',
+ 'recentchanges'
+ ));
+
+ $userId = $wgUser->getId();
+ $this->addWhere(array (
'wl_namespace = rc_namespace',
'wl_title = rc_title',
'rc_cur_id = page_id',
- 'wl_user' => $wgUser->getID());
+ 'wl_user' => $userId,
+ 'rc_deleted' => 0,
+ ));
- if (!$allrev)
- $where[] = 'rc_this_oldid=page_latest';
- if (isset ($namespace))
- $where['wl_namespace'] = $namespace;
+ $this->addWhereRange('rc_timestamp', $dir, $start, $end);
+ $this->addWhereFld('wl_namespace', $namespace);
+ $this->addWhereIf('rc_this_oldid=page_latest', !$allrev);
- if (isset ($start))
- $where[] = 'rc_timestamp' . $after . $db->addQuotes($start);
+ if (!is_null($show)) {
+ $show = array_flip($show);
- if (isset ($end))
- $where[] = 'rc_timestamp' . $before . $db->addQuotes($end);
+ /* Check for conflicting parameters. */
+ if ((isset ($show['minor']) && isset ($show['!minor']))
+ || (isset ($show['bot']) && isset ($show['!bot']))
+ || (isset ($show['anon']) && isset ($show['!anon']))) {
- if (!isset ($start) && !isset ($end))
- $where[] = "rc_timestamp > ''";
+ $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
+ }
+
+ /* 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->profileDBIn();
- $res = $db->select($tables, $fields, $where, __METHOD__, $options);
- $this->profileDBOut();
+
+ # This is an index optimization for mysql, as done in the Special:Watchlist page
+ $this->addWhereIf("rc_timestamp > ''", !isset ($start) && !isset ($end) && $wgDBtype == 'mysql');
+
+ $this->addOption('LIMIT', $limit +1);
$data = array ();
$count = 0;
+ $res = $this->select(__METHOD__);
+
+ $db = $this->getDB();
while ($row = $db->fetchObject($res)) {
if (++ $count > $limit) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
- $this->setContinueEnumParameter('from', $row->rev_timestamp);
+ $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->rc_timestamp));
break;
}
- $title = Title :: makeTitle($row->page_namespace, $row->page_title);
- // skip any pages that user has no rights to read
- if ($title->userCanRead()) {
-
- if (is_null($resultPageSet)) {
- $vals = array ();
- $vals['pageid'] = intval($row->page_id);
- $vals['revid'] = intval($row->rev_id);
- $vals['ns'] = $title->getNamespace();
- $vals['title'] = $title->getPrefixedText();
-
- if ($row->page_is_new)
- $vals['new'] = '';
- if ($row->rev_minor_edit)
- $vals['minor'] = '';
-
- if ($user) {
- if (!$row->rev_user)
- $vals['anon'] = '';
- $vals['user'] = $row->rev_user_text;
- }
- if ($comment)
- $vals['comment'] = $row->rev_comment;
- if ($timestamp)
- $vals['timestamp'] = $row->rev_timestamp;
- if ($patrol && $row->rc_patrolled)
- $vals['patrolled'] = '';
-
+ if (is_null($resultPageSet)) {
+ $vals = $this->extractRowInfo($row);
+ if ($vals)
$data[] = $vals;
- }
- elseif ($allrev) {
- $data[] = intval($row->rev_id);
+ } else {
+ if ($allrev) {
+ $data[] = intval($row->rc_this_oldid);
} else {
- $data[] = intval($row->page_id);
+ $data[] = intval($row->rc_cur_id);
}
}
}
+
$db->freeResult($res);
if (is_null($resultPageSet)) {
- ApiResult :: setIndexedTagName($data, 'item');
+ $this->getResult()->setIndexedTagName($data, 'item');
$this->getResult()->addValue('query', $this->getModuleName(), $data);
}
elseif ($allrev) {
}
}
- protected function getAllowedParams() {
- $namespaces = $this->getQuery()->getValidNamespaces();
+ private function extractRowInfo($row) {
+
+ $vals = array ();
+
+ if ($this->fld_ids) {
+ $vals['pageid'] = intval($row->rc_cur_id);
+ $vals['revid'] = intval($row->rc_this_oldid);
+ }
+
+ if ($this->fld_title)
+ ApiQueryBase :: addTitleInfo($vals, Title :: makeTitle($row->rc_namespace, $row->rc_title));
+
+ if ($this->fld_user) {
+ $vals['user'] = $row->rc_user_text;
+ if (!$row->rc_user)
+ $vals['anon'] = '';
+ }
+
+ if ($this->fld_flags) {
+ if ($row->rc_new)
+ $vals['new'] = '';
+ if ($row->rc_minor)
+ $vals['minor'] = '';
+ }
+
+ if ($this->fld_patrol && isset($row->rc_patrolled))
+ $vals['patrolled'] = '';
+
+ if ($this->fld_timestamp)
+ $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rc_timestamp);
+
+ $this->addFieldsIf('rc_new_len', $this->fld_sizes);
+
+ if ($this->fld_sizes) {
+ $vals['oldlen'] = intval($row->rc_old_len);
+ $vals['newlen'] = intval($row->rc_new_len);
+ }
+
+ if ($this->fld_comment && !empty ($row->rc_comment))
+ $vals['comment'] = $row->rc_comment;
+
+ return $vals;
+ }
+
+ public function getAllowedParams() {
return array (
'allrev' => false,
'start' => array (
),
'namespace' => array (
ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_TYPE => $namespaces
+ ApiBase :: PARAM_TYPE => 'namespace'
),
'dir' => array (
ApiBase :: PARAM_DFLT => 'older',
ApiBase :: PARAM_DFLT => 10,
ApiBase :: PARAM_TYPE => 'limit',
ApiBase :: PARAM_MIN => 1,
- ApiBase :: PARAM_MAX1 => ApiBase :: LIMIT_BIG1,
+ ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
),
'prop' => array (
APIBase :: PARAM_ISMULTI => true,
+ APIBase :: PARAM_DFLT => 'ids|title|flags',
APIBase :: PARAM_TYPE => array (
+ 'ids',
+ 'title',
+ 'flags',
'user',
'comment',
'timestamp',
- 'patrol'
+ 'patrol',
+ 'sizes',
+ )
+ ),
+ 'show' => array (
+ ApiBase :: PARAM_ISMULTI => true,
+ ApiBase :: PARAM_TYPE => array (
+ 'minor',
+ '!minor',
+ 'bot',
+ '!bot',
+ 'anon',
+ '!anon'
)
)
);
}
- 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).',
'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'
+ )
);
}
- protected function getDescription() {
- return '';
+ public function getDescription() {
+ return "Get all recent changes to pages in the logged in user's watchlist";
}
protected function getExamples() {
return array (
'api.php?action=query&list=watchlist',
- 'api.php?action=query&list=watchlist&wlallrev',
+ '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'
);
return __CLASS__ . ': $Id$';
}
}
-?>
\ No newline at end of file
dépôts / lhc / web / wiklou.git / blobdiff