5 * Created on Sep 25, 2006
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * This query action allows clients to retrieve a list of recently modified pages
34 * that are part of the logged-in user's watchlist.
38 class ApiQueryWatchlist
extends ApiQueryGeneratorBase
{
40 public function __construct( $query, $moduleName ) {
41 parent
::__construct( $query, $moduleName, 'wl' );
44 public function execute() {
48 public function executeGenerator( $resultPageSet ) {
49 $this->run( $resultPageSet );
52 private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false,
53 $fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_parsedcomment = false, $fld_sizes = false,
54 $fld_notificationtimestamp = false, $fld_userid = false;
57 * @param $resultPageSet ApiPageSet
60 private function run( $resultPageSet = null ) {
61 $this->selectNamedDB( 'watchlist', DB_SLAVE
, 'watchlist' );
63 $params = $this->extractRequestParams();
65 $user = $this->getWatchlistUser( $params );
67 if ( !is_null( $params['prop'] ) && is_null( $resultPageSet ) ) {
68 $prop = array_flip( $params['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_userid
= isset( $prop['userid'] );
75 $this->fld_comment
= isset( $prop['comment'] );
76 $this->fld_parsedcomment
= isset ( $prop['parsedcomment'] );
77 $this->fld_timestamp
= isset( $prop['timestamp'] );
78 $this->fld_sizes
= isset( $prop['sizes'] );
79 $this->fld_patrol
= isset( $prop['patrol'] );
80 $this->fld_notificationtimestamp
= isset( $prop['notificationtimestamp'] );
82 if ( $this->fld_patrol
) {
83 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
84 $this->dieUsage( 'patrol property is not available', 'patrol' );
89 $this->addFields( array(
95 if ( is_null( $resultPageSet ) ) {
96 $this->addFields( array(
101 $this->addFieldsIf( 'rc_new', $this->fld_flags
);
102 $this->addFieldsIf( 'rc_minor', $this->fld_flags
);
103 $this->addFieldsIf( 'rc_bot', $this->fld_flags
);
104 $this->addFieldsIf( 'rc_user', $this->fld_user ||
$this->fld_userid
);
105 $this->addFieldsIf( 'rc_user_text', $this->fld_user
);
106 $this->addFieldsIf( 'rc_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
107 $this->addFieldsIf( 'rc_patrolled', $this->fld_patrol
);
108 $this->addFieldsIf( 'rc_old_len', $this->fld_sizes
);
109 $this->addFieldsIf( 'rc_new_len', $this->fld_sizes
);
110 $this->addFieldsIf( 'wl_notificationtimestamp', $this->fld_notificationtimestamp
);
111 } elseif ( $params['allrev'] ) {
112 $this->addFields( 'rc_this_oldid' );
114 $this->addFields( 'rc_cur_id' );
117 $this->addTables( array(
123 $userId = $user->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', $params['dir'], $params['start'], $params['end'] );
133 $this->addWhereFld( 'wl_namespace', $params['namespace'] );
134 $this->addWhereIf( 'rc_this_oldid=page_latest', !$params['allrev'] );
136 if ( !is_null( $params['show'] ) ) {
137 $show = array_flip( $params['show'] );
139 /* Check for conflicting parameters. */
140 if ( ( isset ( $show['minor'] ) && isset ( $show['!minor'] ) )
141 ||
( isset ( $show['bot'] ) && isset ( $show['!bot'] ) )
142 ||
( isset ( $show['anon'] ) && isset ( $show['!anon'] ) )
143 ||
( isset ( $show['patrolled'] ) && isset ( $show['!patrolled'] ) )
146 $this->dieUsageMsg( array( 'show' ) );
149 // Check permissions.
150 if ( isset( $show['patrolled'] ) ||
isset( $show['!patrolled'] ) ) {
152 if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
153 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
157 /* Add additional conditions to query depending upon parameters. */
158 $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
159 $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
160 $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
161 $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
162 $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
163 $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
164 $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
165 $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
168 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
169 $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
171 if ( !is_null( $params['user'] ) ) {
172 $this->addWhereFld( 'rc_user_text', $params['user'] );
174 if ( !is_null( $params['excludeuser'] ) ) {
175 $this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
178 $db = $this->getDB();
180 // This is an index optimization for mysql, as done in the Special:Watchlist page
181 $this->addWhereIf( "rc_timestamp > ''", !isset( $params['start'] ) && !isset( $params['end'] ) && $db->getType() == 'mysql' );
183 $this->addOption( 'LIMIT', $params['limit'] +
1 );
187 $res = $this->select( __METHOD__
);
189 foreach ( $res as $row ) {
190 if ( ++
$count > $params['limit'] ) {
191 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
192 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
196 if ( is_null( $resultPageSet ) ) {
197 $vals = $this->extractRowInfo( $row );
198 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
200 $this->setContinueEnumParameter( 'start',
201 wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
205 if ( $params['allrev'] ) {
206 $ids[] = intval( $row->rc_this_oldid
);
208 $ids[] = intval( $row->rc_cur_id
);
213 if ( is_null( $resultPageSet ) ) {
214 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
215 } elseif ( $params['allrev'] ) {
216 $resultPageSet->populateFromRevisionIDs( $ids );
218 $resultPageSet->populateFromPageIDs( $ids );
222 private function extractRowInfo( $row ) {
225 if ( $this->fld_ids
) {
226 $vals['pageid'] = intval( $row->rc_cur_id
);
227 $vals['revid'] = intval( $row->rc_this_oldid
);
230 $title = Title
::makeTitle( $row->rc_namespace
, $row->rc_title
);
232 if ( $this->fld_title
) {
233 ApiQueryBase
::addTitleInfo( $vals, $title );
236 if ( $this->fld_user ||
$this->fld_userid
) {
238 if ( $this->fld_user
) {
239 $vals['user'] = $row->rc_user_text
;
242 if ( $this->fld_userid
) {
243 $vals['user'] = $row->rc_user
;
246 if ( !$row->rc_user
) {
251 if ( $this->fld_flags
) {
252 if ( $row->rc_new
) {
255 if ( $row->rc_minor
) {
258 if ( $row->rc_bot
) {
263 if ( $this->fld_patrol
&& isset( $row->rc_patrolled
) ) {
264 $vals['patrolled'] = '';
267 if ( $this->fld_timestamp
) {
268 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
);
271 if ( $this->fld_sizes
) {
272 $vals['oldlen'] = intval( $row->rc_old_len
);
273 $vals['newlen'] = intval( $row->rc_new_len
);
276 if ( $this->fld_notificationtimestamp
) {
277 $vals['notificationtimestamp'] = ( $row->wl_notificationtimestamp
== null )
279 : wfTimestamp( TS_ISO_8601
, $row->wl_notificationtimestamp
);
282 if ( $this->fld_comment
&& isset( $row->rc_comment
) ) {
283 $vals['comment'] = $row->rc_comment
;
286 if ( $this->fld_parsedcomment
&& isset( $row->rc_comment
) ) {
288 $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment
, $title );
294 public function getAllowedParams() {
298 ApiBase
::PARAM_TYPE
=> 'timestamp'
301 ApiBase
::PARAM_TYPE
=> 'timestamp'
303 'namespace' => array (
304 ApiBase
::PARAM_ISMULTI
=> true,
305 ApiBase
::PARAM_TYPE
=> 'namespace'
308 ApiBase
::PARAM_TYPE
=> 'user',
310 'excludeuser' => array(
311 ApiBase
::PARAM_TYPE
=> 'user',
314 ApiBase
::PARAM_DFLT
=> 'older',
315 ApiBase
::PARAM_TYPE
=> array(
321 ApiBase
::PARAM_DFLT
=> 10,
322 ApiBase
::PARAM_TYPE
=> 'limit',
323 ApiBase
::PARAM_MIN
=> 1,
324 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
325 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
328 ApiBase
::PARAM_ISMULTI
=> true,
329 ApiBase
::PARAM_DFLT
=> 'ids|title|flags',
330 ApiBase
::PARAM_TYPE
=> array(
341 'notificationtimestamp'
345 ApiBase
::PARAM_ISMULTI
=> true,
346 ApiBase
::PARAM_TYPE
=> array(
358 ApiBase
::PARAM_TYPE
=> 'user'
361 ApiBase
::PARAM_TYPE
=> 'string'
366 public function getParamDescription() {
368 'allrev' => 'Include multiple revisions of the same page within given timeframe',
369 'start' => 'The timestamp to start enumerating from',
370 'end' => 'The timestamp to end enumerating',
371 'namespace' => 'Filter changes to only the given namespace(s)',
372 'user' => 'Only list changes by this user',
373 'excludeuser' => 'Don\'t list changes by this user',
374 'dir' => 'In which direction to enumerate pages',
375 'limit' => 'How many total results to return per request',
377 'Which additional items to get (non-generator mode only).',
378 ' ids - Adds revision ids and page ids',
379 ' title - Adds title of the page',
380 ' flags - Adds flags for the edit',
381 ' user - Adds the user who made the edit',
382 ' userid - Adds user id of whom made the edit',
383 ' comment - Adds comment of the edit',
384 ' parsedcomment - Adds parsed comment of the edit',
385 ' timestamp - Adds timestamp of the edit',
386 ' patrol - Tags edits that are patrolled',
387 ' size - Adds the old and new lengths of the page',
388 ' notificationtimestamp - Adds timestamp of when the user was last notified about the edit',
391 'Show only items that meet this criteria.',
392 "For example, to see only minor edits done by logged-in users, set {$this->getModulePrefix()}show=minor|!anon"
394 'owner' => 'The name of the user whose watchlist you\'d like to access',
395 'token' => 'Give a security token (settable in preferences) to allow access to another user\'s watchlist'
399 public function getDescription() {
400 return "Get all recent changes to pages in the logged in user's watchlist";
403 public function getPossibleErrors() {
404 return array_merge( parent
::getPossibleErrors(), array(
405 array( 'code' => 'bad_wlowner', 'info' => 'Specified user does not exist' ),
406 array( 'code' => 'bad_wltoken', 'info' => 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences' ),
407 array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
408 array( 'code' => 'patrol', 'info' => 'patrol property is not available' ),
410 array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
411 array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
415 protected function getExamples() {
417 'api.php?action=query&list=watchlist',
418 'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
419 'api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment',
420 'api.php?action=query&generator=watchlist&prop=info',
421 'api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user',
422 'api.php?action=query&list=watchlist&wlowner=Bob_Smith&wltoken=d8d562e9725ea1512894cdab28e5ceebc7f20237'
426 public function getVersion() {
427 return __CLASS__
. ': $Id$';