4 * Created on Sep 25, 2006
6 * API for MediaWiki 1.8+
8 * Copyright © 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,
52 $fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_parsedcomment = false, $fld_sizes = false,
53 $fld_notificationtimestamp = false;
55 private function run( $resultPageSet = null ) {
56 $this->selectNamedDB( 'watchlist', DB_SLAVE
, 'watchlist' );
58 $params = $this->extractRequestParams();
60 $user = ApiQueryWatchlist
::getWatchlistUser( $params );
62 if ( !is_null( $params['prop'] ) && is_null( $resultPageSet ) ) {
63 $prop = array_flip( $params['prop'] );
65 $this->fld_ids
= isset( $prop['ids'] );
66 $this->fld_title
= isset( $prop['title'] );
67 $this->fld_flags
= isset( $prop['flags'] );
68 $this->fld_user
= isset( $prop['user'] );
69 $this->fld_comment
= isset( $prop['comment'] );
70 $this->fld_parsedcomment
= isset ( $prop['parsedcomment'] );
71 $this->fld_timestamp
= isset( $prop['timestamp'] );
72 $this->fld_sizes
= isset( $prop['sizes'] );
73 $this->fld_patrol
= isset( $prop['patrol'] );
74 $this->fld_notificationtimestamp
= isset( $prop['notificationtimestamp'] );
76 if ( $this->fld_patrol
) {
77 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
78 $this->dieUsage( 'patrol property is not available', 'patrol' );
83 $this->addFields( array(
89 if ( is_null( $resultPageSet ) ) {
90 $this->addFields( array(
95 $this->addFieldsIf( 'rc_new', $this->fld_flags
);
96 $this->addFieldsIf( 'rc_minor', $this->fld_flags
);
97 $this->addFieldsIf( 'rc_bot', $this->fld_flags
);
98 $this->addFieldsIf( 'rc_user', $this->fld_user
);
99 $this->addFieldsIf( 'rc_user_text', $this->fld_user
);
100 $this->addFieldsIf( 'rc_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
101 $this->addFieldsIf( 'rc_patrolled', $this->fld_patrol
);
102 $this->addFieldsIf( 'rc_old_len', $this->fld_sizes
);
103 $this->addFieldsIf( 'rc_new_len', $this->fld_sizes
);
104 $this->addFieldsIf( 'wl_notificationtimestamp', $this->fld_notificationtimestamp
);
105 } elseif ( $params['allrev'] ) {
106 $this->addFields( 'rc_this_oldid' );
108 $this->addFields( 'rc_cur_id' );
111 $this->addTables( array(
117 $userId = $user->getId();
118 $this->addWhere( array(
119 'wl_namespace = rc_namespace',
120 'wl_title = rc_title',
121 'rc_cur_id = page_id',
122 'wl_user' => $userId,
126 $this->addWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
127 $this->addWhereFld( 'wl_namespace', $params['namespace'] );
128 $this->addWhereIf( 'rc_this_oldid=page_latest', !$params['allrev'] );
130 if ( !is_null( $params['show'] ) ) {
131 $show = array_flip( $params['show'] );
133 /* Check for conflicting parameters. */
134 if ( ( isset ( $show['minor'] ) && isset ( $show['!minor'] ) )
135 ||
( isset ( $show['bot'] ) && isset ( $show['!bot'] ) )
136 ||
( isset ( $show['anon'] ) && isset ( $show['!anon'] ) )
137 ||
( isset ( $show['patrolled'] ) && isset ( $show['!patrolled'] ) )
140 $this->dieUsageMsg( array( 'show' ) );
143 // Check permissions. FIXME: should this check $user instead of $wgUser?
144 if ( ( isset( $show['patrolled'] ) ||
isset( $show['!patrolled'] ) ) && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() )
146 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
149 /* Add additional conditions to query depending upon parameters. */
150 $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
151 $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
152 $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
153 $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
154 $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
155 $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
156 $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
157 $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
160 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
161 $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
163 if ( !is_null( $params['user'] ) ) {
164 $this->addWhereFld( 'rc_user_text', $params['user'] );
166 if ( !is_null( $params['excludeuser'] ) ) {
167 $this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
170 $db = $this->getDB();
172 // This is an index optimization for mysql, as done in the Special:Watchlist page
173 $this->addWhereIf( "rc_timestamp > ''", !isset( $params['start'] ) && !isset( $params['end'] ) && $db->getType() == 'mysql' );
175 $this->addOption( 'LIMIT', $params['limit'] +
1 );
179 $res = $this->select( __METHOD__
);
181 foreach ( $res as $row ) {
182 if ( ++
$count > $params['limit'] ) {
183 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
184 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
188 if ( is_null( $resultPageSet ) ) {
189 $vals = $this->extractRowInfo( $row );
190 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
192 $this->setContinueEnumParameter( 'start',
193 wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
197 if ( $params['allrev'] ) {
198 $ids[] = intval( $row->rc_this_oldid
);
200 $ids[] = intval( $row->rc_cur_id
);
205 if ( is_null( $resultPageSet ) ) {
206 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
207 } elseif ( $params['allrev'] ) {
208 $resultPageSet->populateFromRevisionIDs( $ids );
210 $resultPageSet->populateFromPageIDs( $ids );
214 private function extractRowInfo( $row ) {
217 if ( $this->fld_ids
) {
218 $vals['pageid'] = intval( $row->rc_cur_id
);
219 $vals['revid'] = intval( $row->rc_this_oldid
);
222 $title = Title
::makeTitle( $row->rc_namespace
, $row->rc_title
);
224 if ( $this->fld_title
) {
225 ApiQueryBase
::addTitleInfo( $vals, $title );
228 if ( $this->fld_user
) {
229 $vals['user'] = $row->rc_user_text
;
230 if ( !$row->rc_user
) {
235 if ( $this->fld_flags
) {
236 if ( $row->rc_new
) {
239 if ( $row->rc_minor
) {
242 if ( $row->rc_bot
) {
247 if ( $this->fld_patrol
&& isset( $row->rc_patrolled
) ) {
248 $vals['patrolled'] = '';
251 if ( $this->fld_timestamp
) {
252 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
);
255 if ( $this->fld_sizes
) {
256 $vals['oldlen'] = intval( $row->rc_old_len
);
257 $vals['newlen'] = intval( $row->rc_new_len
);
260 if ( $this->fld_notificationtimestamp
) {
261 $vals['notificationtimestamp'] = ( $row->wl_notificationtimestamp
== null ) ?
'' : wfTimestamp( TS_ISO_8601
, $row->wl_notificationtimestamp
);
264 if ( $this->fld_comment
&& isset( $row->rc_comment
) ) {
265 $vals['comment'] = $row->rc_comment
;
268 if ( $this->fld_parsedcomment
&& isset( $row->rc_comment
) ) {
270 $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment
, $title );
277 * Gets the user for whom to get the watchlist
281 public static function getWatchlistUser( $params ) {
283 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
284 $user = User
::newFromName( $params['owner'], false );
285 if ( !$user->getId() ) {
286 $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
288 $token = $user->getOption( 'watchlisttoken' );
289 if ( $token == '' ||
$token != $params['token'] ) {
290 $this->dieUsage( 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken' );
292 } elseif ( !$wgUser->isLoggedIn() ) {
293 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
300 public function getAllowedParams() {
304 ApiBase
::PARAM_TYPE
=> 'timestamp'
307 ApiBase
::PARAM_TYPE
=> 'timestamp'
309 'namespace' => array (
310 ApiBase
::PARAM_ISMULTI
=> true,
311 ApiBase
::PARAM_TYPE
=> 'namespace'
314 ApiBase
::PARAM_TYPE
=> 'user',
316 'excludeuser' => array(
317 ApiBase
::PARAM_TYPE
=> 'user',
320 ApiBase
::PARAM_DFLT
=> 'older',
321 ApiBase
::PARAM_TYPE
=> array(
327 ApiBase
::PARAM_DFLT
=> 10,
328 ApiBase
::PARAM_TYPE
=> 'limit',
329 ApiBase
::PARAM_MIN
=> 1,
330 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
331 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
334 APIBase
::PARAM_ISMULTI
=> true,
335 APIBase
::PARAM_DFLT
=> 'ids|title|flags',
336 APIBase
::PARAM_TYPE
=> array(
346 'notificationtimestamp'
350 ApiBase
::PARAM_ISMULTI
=> true,
351 ApiBase
::PARAM_TYPE
=> array(
363 ApiBase
::PARAM_TYPE
=> 'user'
366 ApiBase
::PARAM_TYPE
=> 'string'
371 public function getParamDescription() {
373 'allrev' => 'Include multiple revisions of the same page within given timeframe',
374 'start' => 'The timestamp to start enumerating from',
375 'end' => 'The timestamp to end enumerating',
376 'namespace' => 'Filter changes to only the given namespace(s)',
377 'user' => 'Only list changes by this user',
378 'excludeuser' => 'Don\'t list changes by this user',
379 'dir' => 'In which direction to enumerate pages',
380 'limit' => 'How many total results to return per request',
381 'prop' => 'Which additional items to get (non-generator mode only).',
383 'Show only items that meet this criteria.',
384 "For example, to see only minor edits done by logged-in users, set {$this->getModulePrefix()}show=minor|!anon"
386 'owner' => 'The name of the user whose watchlist you\'d like to access',
387 'token' => 'Give a security token (settable in preferences) to allow access to another user\'s watchlist'
391 public function getDescription() {
392 return "Get all recent changes to pages in the logged in user's watchlist";
395 public function getPossibleErrors() {
396 return array_merge( parent
::getPossibleErrors(), array(
397 array( 'code' => 'bad_wlowner', 'info' => 'Specified user does not exist' ),
398 array( 'code' => 'bad_wltoken', 'info' => 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences' ),
399 array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
400 array( 'code' => 'patrol', 'info' => 'patrol property is not available' ),
402 array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
403 array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
407 protected function getExamples() {
409 'api.php?action=query&list=watchlist',
410 'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
411 'api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment',
412 'api.php?action=query&generator=watchlist&prop=info',
413 'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user',
414 'api.php?action=query&list=watchlist&wlowner=Bob_Smith&wltoken=d8d562e9725ea1512894cdab28e5ceebc7f20237'
418 public function getVersion() {
419 return __CLASS__
. ': $Id$';