9170e7f6b519bc8baa049b5a04b14e8cbd548dd1
5 * Created on Sep 25, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ('ApiQueryBase.php');
32 class ApiQueryWatchlist
extends ApiQueryGeneratorBase
{
34 public function __construct($query, $moduleName) {
35 parent
:: __construct($query, $moduleName, 'wl');
38 public function execute() {
42 public function executeGenerator($resultPageSet) {
43 $this->run($resultPageSet);
46 private function run($resultPageSet = null) {
49 if (!$wgUser->isLoggedIn())
50 $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
52 $allrev = $start = $end = $namespace = $dir = $limit = null;
53 extract($this->extractRequestParams());
63 'rc_namespace AS page_namespace',
64 'rc_title AS page_title',
65 'rc_comment AS rev_comment',
66 'rc_cur_id AS page_id',
67 'rc_user AS rev_user',
68 'rc_user_text AS rev_user_text',
69 'rc_timestamp AS rev_timestamp',
70 'rc_minor AS rev_minor_edit',
71 'rc_this_oldid AS rev_id',
75 'rc_new AS page_is_new'
78 $dirNewer = ($dir === 'newer');
79 $before = ($dirNewer ?
'<=' : '>=');
80 $after = ($dirNewer ?
'>=' : '<=');
83 'wl_namespace = rc_namespace',
84 'wl_title = rc_title',
85 'rc_cur_id = page_id',
86 'wl_user' => $wgUser->getID());
89 $where[] = 'rc_this_oldid=page_latest';
90 if (isset ($namespace))
91 $where['wl_namespace'] = $namespace;
93 $where[] = 'rev_timestamp' . $after . $db->addQuotes($start);
95 $where[] = 'rev_timestamp' . $before . $db->addQuotes($end);
97 // if (is_null($resultPageSet)) {
104 // $fields = $resultPageSet->getPageTableFields();
108 'LIMIT' => $limit +
1,
109 'ORDER BY' => 'rc_timestamp' . ($dirNewer ?
'' : ' DESC'
112 $this->profileDBIn();
113 $res = $db->select($tables, $fields, $where, __METHOD__
, $options);
114 $this->profileDBOut();
118 while ($row = $db->fetchObject($res)) {
119 if (++
$count > $limit) {
120 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
122 'continue' => $this->encodeParamName('from'
123 ) . '=' . $row->rev_timestamp
);
124 $this->getResult()->addValue('query-status', 'watchlist', $msg);
128 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
129 // skip any pages that user has no rights to read
130 if ($title->userCanRead()) {
132 if (is_null($resultPageSet)) {
133 $id = intval($row->page_id
);
136 'ns' => $title->getNamespace(),
137 'title' => $title->getPrefixedText(),
138 'id' => intval($row->page_id
),
139 'comment' => $row->rev_comment
,
140 'isuser' => $row->rev_user
,
141 'user' => $row->rev_user_text
,
142 'timestamp' => $row->rev_timestamp
,
143 'minor' => $row->rev_minor_edit
,
144 'rev_id' => $row->rev_id
,
145 'rc_last_oldid' => $row->rc_last_oldid
,
146 'rc_id' => $row->rc_id
,
147 // 'rc_patrolled' => $row->rc_patrolled,
148 'isnew' => $row->page_is_new
151 // $resultPageSet->processDbRow($row);
155 $db->freeResult($res);
157 if (is_null($resultPageSet)) {
158 ApiResult
:: setIndexedTagName($data, 'p');
159 $this->getResult()->addValue('query', 'watchlist', $data);
163 protected function getAllowedParams() {
164 $namespaces = $this->getQuery()->getValidNamespaces();
168 ApiBase
:: PARAM_TYPE
=> 'timestamp'
171 ApiBase
:: PARAM_TYPE
=> 'timestamp'
173 'namespace' => array (
174 ApiBase
:: PARAM_ISMULTI
=> true,
175 ApiBase
:: PARAM_TYPE
=> $namespaces
178 ApiBase
:: PARAM_DFLT
=> 'older',
179 ApiBase
:: PARAM_TYPE
=> array (
185 ApiBase
:: PARAM_DFLT
=> 10,
186 ApiBase
:: PARAM_TYPE
=> 'limit',
187 ApiBase
:: PARAM_MIN
=> 1,
188 ApiBase
:: PARAM_MAX1
=> 500,
189 ApiBase
:: PARAM_MAX2
=> 5000
194 protected function getParamDescription() {
196 'allrev' => 'Include multiple revisions of the same page within given timeframe',
197 'start' => 'The timestamp to start enumerating from.',
198 'end' => 'The timestamp to end enumerating.',
199 'namespace' => 'Filter changes to only the given namespace(s).',
200 'dir' => 'In which direction to enumerate pages "older" (default), or "newer")',
201 'limit' => 'How many total pages to return per request'
205 protected function getDescription() {
209 protected function getExamples() {
211 'api.php?action=query&list=watchlist',
212 'api.php?action=query&list=watchlist&wlallrev'
216 public function getVersion() {
217 return __CLASS__
. ': $Id$';