4 * Created on Sep 25, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * This query action allows clients to retrieve a list of recently modified pages
33 * that are part of the logged-in user's watchlist.
37 class ApiQueryWatchlist
extends ApiQueryGeneratorBase
{
39 public function __construct($query, $moduleName) {
40 parent
:: __construct($query, $moduleName, 'wl');
43 public function execute() {
47 public function executeGenerator($resultPageSet) {
48 $this->run($resultPageSet);
51 private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false, $fld_timestamp = false, $fld_user = false, $fld_comment = false;
53 private function run($resultPageSet = null) {
56 $this->selectNamedDB('watchlist', DB_SLAVE
, 'watchlist');
58 if (!$wgUser->isLoggedIn())
59 $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
61 $allrev = $start = $end = $namespace = $dir = $limit = $prop = null;
62 extract($this->extractRequestParams());
64 if (!is_null($prop)) {
65 if (!is_null($resultPageSet))
66 $this->dieUsage($this->encodeParamName('prop') . ' parameter may not be used in a generator', 'params');
68 $prop = array_flip($prop);
70 $this->fld_ids
= isset($prop['ids']);
71 $this->fld_title
= isset($prop['title']);
72 $this->fld_flags
= isset($prop['flags']);
73 $this->fld_user
= isset($prop['user']);
74 $this->fld_comment
= isset($prop['comment']);
75 $this->fld_timestamp
= isset($prop['timestamp']);
76 $this->fld_patrol
= isset($prop['patrol']);
78 if ($this->fld_patrol
) {
79 global $wgUseRCPatrol, $wgUser;
80 if (!$wgUseRCPatrol ||
!$wgUser->isAllowed('patrol'))
81 $this->dieUsage('patrol property is not available', 'patrol');
85 if (is_null($resultPageSet)) {
86 $this->addFields(array (
94 $this->addFieldsIf('rc_new', $this->fld_flags
);
95 $this->addFieldsIf('rc_minor', $this->fld_flags
);
96 $this->addFieldsIf('rc_user', $this->fld_user
);
97 $this->addFieldsIf('rc_user_text', $this->fld_user
);
98 $this->addFieldsIf('rc_comment', $this->fld_comment
);
99 $this->addFieldsIf('rc_patrolled', $this->fld_patrol
);
102 $this->addFields(array (
109 $this->addFields(array (
117 $this->addTables(array (
123 $userId = $wgUser->getID();
124 $this->addWhere(array (
125 'wl_namespace = rc_namespace',
126 'wl_title = rc_title',
127 'rc_cur_id = page_id',
128 'wl_user' => $userId,
132 $this->addWhereRange('rc_timestamp', $dir, $start, $end);
133 $this->addWhereFld('wl_namespace', $namespace);
134 $this->addWhereIf('rc_this_oldid=page_latest', !$allrev);
135 $this->addWhereIf("rc_timestamp > ''", !isset ($start) && !isset ($end));
137 $this->addOption('LIMIT', $limit +
1);
141 $res = $this->select(__METHOD__
);
143 $db = $this->getDB();
144 while ($row = $db->fetchObject($res)) {
145 if (++
$count > $limit) {
146 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
147 $this->setContinueEnumParameter('start', $row->rc_timestamp
);
151 if (is_null($resultPageSet)) {
152 $vals = $this->extractRowInfo($row);
156 $title = Title
:: makeTitle($row->rc_namespace
, $row->rc_title
);
157 // skip any pages that user has no rights to read
158 if ($title->userCanRead()) {
160 $data[] = intval($row->rc_this_oldid
);
162 $data[] = intval($row->rc_cur_id
);
168 $db->freeResult($res);
170 if (is_null($resultPageSet)) {
171 $this->getResult()->setIndexedTagName($data, 'item');
172 $this->getResult()->addValue('query', $this->getModuleName(), $data);
175 $resultPageSet->populateFromRevisionIDs($data);
177 $resultPageSet->populateFromPageIDs($data);
181 private function extractRowInfo($row) {
183 $title = Title
:: makeTitle($row->rc_namespace
, $row->rc_title
);
184 if (!$title->userCanRead())
189 if ($this->fld_ids
) {
190 $vals['pageid'] = intval($row->rc_cur_id
);
191 $vals['revid'] = intval($row->rc_this_oldid
);
194 if ($this->fld_title
)
195 ApiQueryBase
:: addTitleInfo($vals, $title);
197 if ($this->fld_user
) {
198 $vals['user'] = $row->rc_user_text
;
203 if ($this->fld_flags
) {
210 if ($this->fld_patrol
&& isset($row->rc_patrolled
))
211 $vals['patrolled'] = '';
213 if ($this->fld_timestamp
)
214 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->rc_timestamp
);
216 if ($this->fld_comment
&& !empty ($row->rc_comment
))
217 $vals['comment'] = $row->rc_comment
;
222 protected function getAllowedParams() {
226 ApiBase
:: PARAM_TYPE
=> 'timestamp'
229 ApiBase
:: PARAM_TYPE
=> 'timestamp'
231 'namespace' => array (
232 ApiBase
:: PARAM_ISMULTI
=> true,
233 ApiBase
:: PARAM_TYPE
=> 'namespace'
236 ApiBase
:: PARAM_DFLT
=> 'older',
237 ApiBase
:: PARAM_TYPE
=> array (
243 ApiBase
:: PARAM_DFLT
=> 10,
244 ApiBase
:: PARAM_TYPE
=> 'limit',
245 ApiBase
:: PARAM_MIN
=> 1,
246 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
247 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
250 APIBase
:: PARAM_ISMULTI
=> true,
251 APIBase
:: PARAM_DFLT
=> 'ids|title|flags',
252 APIBase
:: PARAM_TYPE
=> array (
265 protected function getParamDescription() {
267 'allrev' => 'Include multiple revisions of the same page within given timeframe.',
268 'start' => 'The timestamp to start enumerating from.',
269 'end' => 'The timestamp to end enumerating.',
270 'namespace' => 'Filter changes to only the given namespace(s).',
271 'dir' => 'In which direction to enumerate pages.',
272 'limit' => 'How many total pages to return per request.',
273 'prop' => 'Which additional items to get (non-generator mode only).'
277 protected function getDescription() {
281 protected function getExamples() {
283 'api.php?action=query&list=watchlist',
284 'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
285 'api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment',
286 'api.php?action=query&generator=watchlist&prop=info',
287 'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user'
291 public function getVersion() {
292 return __CLASS__
. ': $Id$';