3 * API for MediaWiki 1.8+
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;
56 private function run( $resultPageSet = null ) {
57 $this->selectNamedDB( 'watchlist', DB_SLAVE
, 'watchlist' );
59 $params = $this->extractRequestParams();
61 $user = $this->getWatchlistUser( $params );
63 if ( !is_null( $params['prop'] ) && is_null( $resultPageSet ) ) {
64 $prop = array_flip( $params['prop'] );
66 $this->fld_ids
= isset( $prop['ids'] );
67 $this->fld_title
= isset( $prop['title'] );
68 $this->fld_flags
= isset( $prop['flags'] );
69 $this->fld_user
= isset( $prop['user'] );
70 $this->fld_comment
= isset( $prop['comment'] );
71 $this->fld_parsedcomment
= isset ( $prop['parsedcomment'] );
72 $this->fld_timestamp
= isset( $prop['timestamp'] );
73 $this->fld_sizes
= isset( $prop['sizes'] );
74 $this->fld_patrol
= isset( $prop['patrol'] );
75 $this->fld_notificationtimestamp
= isset( $prop['notificationtimestamp'] );
77 if ( $this->fld_patrol
) {
78 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
79 $this->dieUsage( 'patrol property is not available', 'patrol' );
84 $this->addFields( array(
90 if ( is_null( $resultPageSet ) ) {
91 $this->addFields( array(
96 $this->addFieldsIf( 'rc_new', $this->fld_flags
);
97 $this->addFieldsIf( 'rc_minor', $this->fld_flags
);
98 $this->addFieldsIf( 'rc_bot', $this->fld_flags
);
99 $this->addFieldsIf( 'rc_user', $this->fld_user
);
100 $this->addFieldsIf( 'rc_user_text', $this->fld_user
);
101 $this->addFieldsIf( 'rc_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
102 $this->addFieldsIf( 'rc_patrolled', $this->fld_patrol
);
103 $this->addFieldsIf( 'rc_old_len', $this->fld_sizes
);
104 $this->addFieldsIf( 'rc_new_len', $this->fld_sizes
);
105 $this->addFieldsIf( 'wl_notificationtimestamp', $this->fld_notificationtimestamp
);
106 } elseif ( $params['allrev'] ) {
107 $this->addFields( 'rc_this_oldid' );
109 $this->addFields( 'rc_cur_id' );
112 $this->addTables( array(
118 $userId = $user->getId();
119 $this->addWhere( array(
120 'wl_namespace = rc_namespace',
121 'wl_title = rc_title',
122 'rc_cur_id = page_id',
123 'wl_user' => $userId,
127 $this->addWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
128 $this->addWhereFld( 'wl_namespace', $params['namespace'] );
129 $this->addWhereIf( 'rc_this_oldid=page_latest', !$params['allrev'] );
131 if ( !is_null( $params['show'] ) ) {
132 $show = array_flip( $params['show'] );
134 /* Check for conflicting parameters. */
135 if ( ( isset ( $show['minor'] ) && isset ( $show['!minor'] ) )
136 ||
( isset ( $show['bot'] ) && isset ( $show['!bot'] ) )
137 ||
( isset ( $show['anon'] ) && isset ( $show['!anon'] ) )
138 ||
( isset ( $show['patrolled'] ) && isset ( $show['!patrolled'] ) )
141 $this->dieUsageMsg( array( 'show' ) );
144 // Check permissions.
145 if ( isset( $show['patrolled'] ) ||
isset( $show['!patrolled'] ) ) {
147 if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
148 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
152 /* Add additional conditions to query depending upon parameters. */
153 $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
154 $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
155 $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
156 $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
157 $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
158 $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
159 $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
160 $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
163 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
164 $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
166 if ( !is_null( $params['user'] ) ) {
167 $this->addWhereFld( 'rc_user_text', $params['user'] );
169 if ( !is_null( $params['excludeuser'] ) ) {
170 $this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
173 $db = $this->getDB();
175 // This is an index optimization for mysql, as done in the Special:Watchlist page
176 $this->addWhereIf( "rc_timestamp > ''", !isset( $params['start'] ) && !isset( $params['end'] ) && $db->getType() == 'mysql' );
178 $this->addOption( 'LIMIT', $params['limit'] +
1 );
182 $res = $this->select( __METHOD__
);
184 foreach ( $res as $row ) {
185 if ( ++
$count > $params['limit'] ) {
186 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
187 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
191 if ( is_null( $resultPageSet ) ) {
192 $vals = $this->extractRowInfo( $row );
193 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
195 $this->setContinueEnumParameter( 'start',
196 wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
200 if ( $params['allrev'] ) {
201 $ids[] = intval( $row->rc_this_oldid
);
203 $ids[] = intval( $row->rc_cur_id
);
208 if ( is_null( $resultPageSet ) ) {
209 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
210 } elseif ( $params['allrev'] ) {
211 $resultPageSet->populateFromRevisionIDs( $ids );
213 $resultPageSet->populateFromPageIDs( $ids );
217 private function extractRowInfo( $row ) {
220 if ( $this->fld_ids
) {
221 $vals['pageid'] = intval( $row->rc_cur_id
);
222 $vals['revid'] = intval( $row->rc_this_oldid
);
225 $title = Title
::makeTitle( $row->rc_namespace
, $row->rc_title
);
227 if ( $this->fld_title
) {
228 ApiQueryBase
::addTitleInfo( $vals, $title );
231 if ( $this->fld_user
) {
232 $vals['user'] = $row->rc_user_text
;
233 if ( !$row->rc_user
) {
238 if ( $this->fld_flags
) {
239 if ( $row->rc_new
) {
242 if ( $row->rc_minor
) {
245 if ( $row->rc_bot
) {
250 if ( $this->fld_patrol
&& isset( $row->rc_patrolled
) ) {
251 $vals['patrolled'] = '';
254 if ( $this->fld_timestamp
) {
255 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
);
258 if ( $this->fld_sizes
) {
259 $vals['oldlen'] = intval( $row->rc_old_len
);
260 $vals['newlen'] = intval( $row->rc_new_len
);
263 if ( $this->fld_notificationtimestamp
) {
264 $vals['notificationtimestamp'] = ( $row->wl_notificationtimestamp
== null )
266 : wfTimestamp( TS_ISO_8601
, $row->wl_notificationtimestamp
);
269 if ( $this->fld_comment
&& isset( $row->rc_comment
) ) {
270 $vals['comment'] = $row->rc_comment
;
273 if ( $this->fld_parsedcomment
&& isset( $row->rc_comment
) ) {
275 $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment
, $title );
281 public function getAllowedParams() {
285 ApiBase
::PARAM_TYPE
=> 'timestamp'
288 ApiBase
::PARAM_TYPE
=> 'timestamp'
290 'namespace' => array (
291 ApiBase
::PARAM_ISMULTI
=> true,
292 ApiBase
::PARAM_TYPE
=> 'namespace'
295 ApiBase
::PARAM_TYPE
=> 'user',
297 'excludeuser' => array(
298 ApiBase
::PARAM_TYPE
=> 'user',
301 ApiBase
::PARAM_DFLT
=> 'older',
302 ApiBase
::PARAM_TYPE
=> array(
308 ApiBase
::PARAM_DFLT
=> 10,
309 ApiBase
::PARAM_TYPE
=> 'limit',
310 ApiBase
::PARAM_MIN
=> 1,
311 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
312 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
315 ApiBase
::PARAM_ISMULTI
=> true,
316 ApiBase
::PARAM_DFLT
=> 'ids|title|flags',
317 ApiBase
::PARAM_TYPE
=> array(
327 'notificationtimestamp'
331 ApiBase
::PARAM_ISMULTI
=> true,
332 ApiBase
::PARAM_TYPE
=> array(
344 ApiBase
::PARAM_TYPE
=> 'user'
347 ApiBase
::PARAM_TYPE
=> 'string'
352 public function getParamDescription() {
354 'allrev' => 'Include multiple revisions of the same page within given timeframe',
355 'start' => 'The timestamp to start enumerating from',
356 'end' => 'The timestamp to end enumerating',
357 'namespace' => 'Filter changes to only the given namespace(s)',
358 'user' => 'Only list changes by this user',
359 'excludeuser' => 'Don\'t list changes by this user',
360 'dir' => 'In which direction to enumerate pages',
361 'limit' => 'How many total results to return per request',
363 'Which additional items to get (non-generator mode only).',
364 ' ids - Adds revision ids and page ids',
365 ' title - Adds title of the page',
366 ' flags - Adds flags for the edit',
367 ' user - Adds user who made the edit',
368 ' comment - Adds comment of the edit',
369 ' parsedcomment - Adds parsed comment of the edit',
370 ' timestamp - Adds timestamp of the edit',
371 ' patrol - Tags edits that are patrolled',
372 ' size - Adds the old and new lengths of the page',
373 ' notificationtimestamp - Adds timestamp of when the user was last notified about the edit',
376 'Show only items that meet this criteria.',
377 "For example, to see only minor edits done by logged-in users, set {$this->getModulePrefix()}show=minor|!anon"
379 'owner' => 'The name of the user whose watchlist you\'d like to access',
380 'token' => 'Give a security token (settable in preferences) to allow access to another user\'s watchlist'
384 public function getDescription() {
385 return "Get all recent changes to pages in the logged in user's watchlist";
388 public function getPossibleErrors() {
389 return array_merge( parent
::getPossibleErrors(), array(
390 array( 'code' => 'bad_wlowner', 'info' => 'Specified user does not exist' ),
391 array( 'code' => 'bad_wltoken', 'info' => 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences' ),
392 array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
393 array( 'code' => 'patrol', 'info' => 'patrol property is not available' ),
395 array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
396 array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
400 protected function getExamples() {
402 'api.php?action=query&list=watchlist',
403 'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
404 'api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment',
405 'api.php?action=query&generator=watchlist&prop=info',
406 'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user',
407 'api.php?action=query&list=watchlist&wlowner=Bob_Smith&wltoken=d8d562e9725ea1512894cdab28e5ceebc7f20237'
411 public function getVersion() {
412 return __CLASS__
. ': $Id$';