3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
26 * This query action allows clients to retrieve a list of recently modified pages
27 * that are part of the logged-in user's watchlist.
31 class ApiQueryWatchlist
extends ApiQueryGeneratorBase
{
33 /** @var CommentStore */
34 private $commentStore;
36 public function __construct( ApiQuery
$query, $moduleName ) {
37 parent
::__construct( $query, $moduleName, 'wl' );
40 public function execute() {
44 public function executeGenerator( $resultPageSet ) {
45 $this->run( $resultPageSet );
48 private $fld_ids = false, $fld_title = false, $fld_patrol = false,
49 $fld_flags = false, $fld_timestamp = false, $fld_user = false,
50 $fld_comment = false, $fld_parsedcomment = false, $fld_sizes = false,
51 $fld_notificationtimestamp = false, $fld_userid = false,
52 $fld_loginfo = false, $fld_tags;
55 * @param ApiPageSet $resultPageSet
58 private function run( $resultPageSet = null ) {
59 $this->selectNamedDB( 'watchlist', DB_REPLICA
, 'watchlist' );
61 $params = $this->extractRequestParams();
63 $user = $this->getUser();
64 $wlowner = $this->getWatchlistUser( $params );
66 if ( !is_null( $params['prop'] ) && is_null( $resultPageSet ) ) {
67 $prop = array_flip( $params['prop'] );
69 $this->fld_ids
= isset( $prop['ids'] );
70 $this->fld_title
= isset( $prop['title'] );
71 $this->fld_flags
= isset( $prop['flags'] );
72 $this->fld_user
= isset( $prop['user'] );
73 $this->fld_userid
= isset( $prop['userid'] );
74 $this->fld_comment
= isset( $prop['comment'] );
75 $this->fld_parsedcomment
= isset( $prop['parsedcomment'] );
76 $this->fld_timestamp
= isset( $prop['timestamp'] );
77 $this->fld_sizes
= isset( $prop['sizes'] );
78 $this->fld_patrol
= isset( $prop['patrol'] );
79 $this->fld_notificationtimestamp
= isset( $prop['notificationtimestamp'] );
80 $this->fld_loginfo
= isset( $prop['loginfo'] );
81 $this->fld_tags
= isset( $prop['tags'] );
83 if ( $this->fld_patrol
) {
84 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
85 $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'patrol' );
89 if ( $this->fld_comment ||
$this->fld_parsedcomment
) {
90 $this->commentStore
= CommentStore
::getStore();
95 'dir' => $params['dir'] === 'older'
96 ? WatchedItemQueryService
::DIR_OLDER
97 : WatchedItemQueryService
::DIR_NEWER
,
100 if ( is_null( $resultPageSet ) ) {
101 $options['includeFields'] = $this->getFieldsToInclude();
103 $options['usedInGenerator'] = true;
106 if ( $params['start'] ) {
107 $options['start'] = $params['start'];
109 if ( $params['end'] ) {
110 $options['end'] = $params['end'];
114 if ( !is_null( $params['continue'] ) ) {
115 $cont = explode( '|', $params['continue'] );
116 $this->dieContinueUsageIf( count( $cont ) != 2 );
117 $continueTimestamp = $cont[0];
118 $continueId = (int)$cont[1];
119 $this->dieContinueUsageIf( $continueId != $cont[1] );
120 $startFrom = [ $continueTimestamp, $continueId ];
123 if ( $wlowner !== $user ) {
124 $options['watchlistOwner'] = $wlowner;
125 $options['watchlistOwnerToken'] = $params['token'];
128 if ( !is_null( $params['namespace'] ) ) {
129 $options['namespaceIds'] = $params['namespace'];
132 if ( $params['allrev'] ) {
133 $options['allRevisions'] = true;
136 if ( !is_null( $params['show'] ) ) {
137 $show = array_flip( $params['show'] );
139 /* Check for conflicting parameters. */
140 if ( $this->showParamsConflicting( $show ) ) {
141 $this->dieWithError( 'apierror-show' );
144 // Check permissions.
145 if ( isset( $show[WatchedItemQueryService
::FILTER_PATROLLED
] )
146 ||
isset( $show[WatchedItemQueryService
::FILTER_NOT_PATROLLED
] )
148 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
149 $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' );
153 $options['filters'] = array_keys( $show );
156 if ( !is_null( $params['type'] ) ) {
158 $rcTypes = RecentChange
::parseToRCType( $params['type'] );
160 $options['rcTypes'] = $rcTypes;
162 } catch ( Exception
$e ) {
163 ApiBase
::dieDebug( __METHOD__
, $e->getMessage() );
167 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
168 if ( !is_null( $params['user'] ) ) {
169 $options['onlyByUser'] = $params['user'];
171 if ( !is_null( $params['excludeuser'] ) ) {
172 $options['notByUser'] = $params['excludeuser'];
175 $options['limit'] = $params['limit'];
177 Hooks
::run( 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions', [
178 $this, $params, &$options
183 $watchedItemQuery = MediaWikiServices
::getInstance()->getWatchedItemQueryService();
184 $items = $watchedItemQuery->getWatchedItemsWithRecentChangeInfo( $wlowner, $options, $startFrom );
186 foreach ( $items as list( $watchedItem, $recentChangeInfo ) ) {
187 /** @var WatchedItem $watchedItem */
188 if ( is_null( $resultPageSet ) ) {
189 $vals = $this->extractOutputData( $watchedItem, $recentChangeInfo );
190 $fit = $this->getResult()->addValue( [ 'query', $this->getModuleName() ], null, $vals );
192 $startFrom = [ $recentChangeInfo['rc_timestamp'], $recentChangeInfo['rc_id'] ];
196 if ( $params['allrev'] ) {
197 $ids[] = intval( $recentChangeInfo['rc_this_oldid'] );
199 $ids[] = intval( $recentChangeInfo['rc_cur_id'] );
204 if ( $startFrom !== null ) {
205 $this->setContinueEnumParameter( 'continue', implode( '|', $startFrom ) );
208 if ( is_null( $resultPageSet ) ) {
209 $this->getResult()->addIndexedTagName(
210 [ 'query', $this->getModuleName() ],
213 } elseif ( $params['allrev'] ) {
214 $resultPageSet->populateFromRevisionIDs( $ids );
216 $resultPageSet->populateFromPageIDs( $ids );
220 private function getFieldsToInclude() {
222 if ( $this->fld_flags
) {
223 $includeFields[] = WatchedItemQueryService
::INCLUDE_FLAGS
;
225 if ( $this->fld_user ||
$this->fld_userid
) {
226 $includeFields[] = WatchedItemQueryService
::INCLUDE_USER_ID
;
228 if ( $this->fld_user
) {
229 $includeFields[] = WatchedItemQueryService
::INCLUDE_USER
;
231 if ( $this->fld_comment ||
$this->fld_parsedcomment
) {
232 $includeFields[] = WatchedItemQueryService
::INCLUDE_COMMENT
;
234 if ( $this->fld_patrol
) {
235 $includeFields[] = WatchedItemQueryService
::INCLUDE_PATROL_INFO
;
236 $includeFields[] = WatchedItemQueryService
::INCLUDE_AUTOPATROL_INFO
;
238 if ( $this->fld_sizes
) {
239 $includeFields[] = WatchedItemQueryService
::INCLUDE_SIZES
;
241 if ( $this->fld_loginfo
) {
242 $includeFields[] = WatchedItemQueryService
::INCLUDE_LOG_INFO
;
244 if ( $this->fld_tags
) {
245 $includeFields[] = WatchedItemQueryService
::INCLUDE_TAGS
;
247 return $includeFields;
250 private function showParamsConflicting( array $show ) {
251 return ( isset( $show[WatchedItemQueryService
::FILTER_MINOR
] )
252 && isset( $show[WatchedItemQueryService
::FILTER_NOT_MINOR
] ) )
253 ||
( isset( $show[WatchedItemQueryService
::FILTER_BOT
] )
254 && isset( $show[WatchedItemQueryService
::FILTER_NOT_BOT
] ) )
255 ||
( isset( $show[WatchedItemQueryService
::FILTER_ANON
] )
256 && isset( $show[WatchedItemQueryService
::FILTER_NOT_ANON
] ) )
257 ||
( isset( $show[WatchedItemQueryService
::FILTER_PATROLLED
] )
258 && isset( $show[WatchedItemQueryService
::FILTER_NOT_PATROLLED
] ) )
259 ||
( isset( $show[WatchedItemQueryService
::FILTER_AUTOPATROLLED
] )
260 && isset( $show[WatchedItemQueryService
::FILTER_NOT_AUTOPATROLLED
] ) )
261 ||
( isset( $show[WatchedItemQueryService
::FILTER_AUTOPATROLLED
] )
262 && isset( $show[WatchedItemQueryService
::FILTER_NOT_PATROLLED
] ) )
263 ||
( isset( $show[WatchedItemQueryService
::FILTER_UNREAD
] )
264 && isset( $show[WatchedItemQueryService
::FILTER_NOT_UNREAD
] ) );
267 private function extractOutputData( WatchedItem
$watchedItem, array $recentChangeInfo ) {
268 /* Determine the title of the page that has been changed. */
269 $title = Title
::newFromLinkTarget( $watchedItem->getLinkTarget() );
270 $user = $this->getUser();
272 /* Our output data. */
274 $type = intval( $recentChangeInfo['rc_type'] );
275 $vals['type'] = RecentChange
::parseFromRCType( $type );
278 /* Create a new entry in the result for the title. */
279 if ( $this->fld_title ||
$this->fld_ids
) {
280 // These should already have been filtered out of the query, but just in case.
281 if ( $type === RC_LOG
&& ( $recentChangeInfo['rc_deleted'] & LogPage
::DELETED_ACTION
) ) {
282 $vals['actionhidden'] = true;
285 if ( $type !== RC_LOG ||
286 LogEventsList
::userCanBitfield(
287 $recentChangeInfo['rc_deleted'],
288 LogPage
::DELETED_ACTION
,
292 if ( $this->fld_title
) {
293 ApiQueryBase
::addTitleInfo( $vals, $title );
295 if ( $this->fld_ids
) {
296 $vals['pageid'] = intval( $recentChangeInfo['rc_cur_id'] );
297 $vals['revid'] = intval( $recentChangeInfo['rc_this_oldid'] );
298 $vals['old_revid'] = intval( $recentChangeInfo['rc_last_oldid'] );
303 /* Add user data and 'anon' flag, if user is anonymous. */
304 if ( $this->fld_user ||
$this->fld_userid
) {
305 if ( $recentChangeInfo['rc_deleted'] & Revision
::DELETED_USER
) {
306 $vals['userhidden'] = true;
309 if ( Revision
::userCanBitfield(
310 $recentChangeInfo['rc_deleted'],
311 Revision
::DELETED_USER
,
314 if ( $this->fld_userid
) {
315 $vals['userid'] = (int)$recentChangeInfo['rc_user'];
316 // for backwards compatibility
317 $vals['user'] = (int)$recentChangeInfo['rc_user'];
320 if ( $this->fld_user
) {
321 $vals['user'] = $recentChangeInfo['rc_user_text'];
324 if ( !$recentChangeInfo['rc_user'] ) {
325 $vals['anon'] = true;
330 /* Add flags, such as new, minor, bot. */
331 if ( $this->fld_flags
) {
332 $vals['bot'] = (bool)$recentChangeInfo['rc_bot'];
333 $vals['new'] = $recentChangeInfo['rc_type'] == RC_NEW
;
334 $vals['minor'] = (bool)$recentChangeInfo['rc_minor'];
337 /* Add sizes of each revision. (Only available on 1.10+) */
338 if ( $this->fld_sizes
) {
339 $vals['oldlen'] = intval( $recentChangeInfo['rc_old_len'] );
340 $vals['newlen'] = intval( $recentChangeInfo['rc_new_len'] );
343 /* Add the timestamp. */
344 if ( $this->fld_timestamp
) {
345 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $recentChangeInfo['rc_timestamp'] );
348 if ( $this->fld_notificationtimestamp
) {
349 $vals['notificationtimestamp'] = ( $watchedItem->getNotificationTimestamp() == null )
351 : wfTimestamp( TS_ISO_8601
, $watchedItem->getNotificationTimestamp() );
354 /* Add edit summary / log summary. */
355 if ( $this->fld_comment ||
$this->fld_parsedcomment
) {
356 if ( $recentChangeInfo['rc_deleted'] & Revision
::DELETED_COMMENT
) {
357 $vals['commenthidden'] = true;
360 if ( Revision
::userCanBitfield(
361 $recentChangeInfo['rc_deleted'],
362 Revision
::DELETED_COMMENT
,
365 $comment = $this->commentStore
->getComment( 'rc_comment', $recentChangeInfo )->text
;
366 if ( $this->fld_comment
) {
367 $vals['comment'] = $comment;
370 if ( $this->fld_parsedcomment
) {
371 $vals['parsedcomment'] = Linker
::formatComment( $comment, $title );
376 /* Add the patrolled flag */
377 if ( $this->fld_patrol
) {
378 $vals['patrolled'] = $recentChangeInfo['rc_patrolled'] != RecentChange
::PRC_UNPATROLLED
;
379 $vals['unpatrolled'] = ChangesList
::isUnpatrolled( (object)$recentChangeInfo, $user );
380 $vals['autopatrolled'] = $recentChangeInfo['rc_patrolled'] == RecentChange
::PRC_AUTOPATROLLED
;
383 if ( $this->fld_loginfo
&& $recentChangeInfo['rc_type'] == RC_LOG
) {
384 if ( $recentChangeInfo['rc_deleted'] & LogPage
::DELETED_ACTION
) {
385 $vals['actionhidden'] = true;
388 if ( LogEventsList
::userCanBitfield(
389 $recentChangeInfo['rc_deleted'],
390 LogPage
::DELETED_ACTION
,
393 $vals['logid'] = intval( $recentChangeInfo['rc_logid'] );
394 $vals['logtype'] = $recentChangeInfo['rc_log_type'];
395 $vals['logaction'] = $recentChangeInfo['rc_log_action'];
396 $vals['logparams'] = LogFormatter
::newFromRow( $recentChangeInfo )->formatParametersForApi();
400 if ( $this->fld_tags
) {
401 if ( $recentChangeInfo['rc_tags'] ) {
402 $tags = explode( ',', $recentChangeInfo['rc_tags'] );
403 ApiResult
::setIndexedTagName( $tags, 'tag' );
404 $vals['tags'] = $tags;
410 if ( $anyHidden && ( $recentChangeInfo['rc_deleted'] & Revision
::DELETED_RESTRICTED
) ) {
411 $vals['suppressed'] = true;
414 Hooks
::run( 'ApiQueryWatchlistExtractOutputData', [
415 $this, $watchedItem, $recentChangeInfo, &$vals
421 public function getAllowedParams() {
425 ApiBase
::PARAM_TYPE
=> 'timestamp'
428 ApiBase
::PARAM_TYPE
=> 'timestamp'
431 ApiBase
::PARAM_ISMULTI
=> true,
432 ApiBase
::PARAM_TYPE
=> 'namespace'
435 ApiBase
::PARAM_TYPE
=> 'user',
438 ApiBase
::PARAM_TYPE
=> 'user',
441 ApiBase
::PARAM_DFLT
=> 'older',
442 ApiBase
::PARAM_TYPE
=> [
446 ApiHelp
::PARAM_HELP_MSG
=> 'api-help-param-direction',
449 ApiBase
::PARAM_DFLT
=> 10,
450 ApiBase
::PARAM_TYPE
=> 'limit',
451 ApiBase
::PARAM_MIN
=> 1,
452 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
453 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
456 ApiBase
::PARAM_ISMULTI
=> true,
457 ApiBase
::PARAM_DFLT
=> 'ids|title|flags',
458 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
459 ApiBase
::PARAM_TYPE
=> [
470 'notificationtimestamp',
476 ApiBase
::PARAM_ISMULTI
=> true,
477 ApiBase
::PARAM_TYPE
=> [
478 WatchedItemQueryService
::FILTER_MINOR
,
479 WatchedItemQueryService
::FILTER_NOT_MINOR
,
480 WatchedItemQueryService
::FILTER_BOT
,
481 WatchedItemQueryService
::FILTER_NOT_BOT
,
482 WatchedItemQueryService
::FILTER_ANON
,
483 WatchedItemQueryService
::FILTER_NOT_ANON
,
484 WatchedItemQueryService
::FILTER_PATROLLED
,
485 WatchedItemQueryService
::FILTER_NOT_PATROLLED
,
486 WatchedItemQueryService
::FILTER_AUTOPATROLLED
,
487 WatchedItemQueryService
::FILTER_NOT_AUTOPATROLLED
,
488 WatchedItemQueryService
::FILTER_UNREAD
,
489 WatchedItemQueryService
::FILTER_NOT_UNREAD
,
493 ApiBase
::PARAM_DFLT
=> 'edit|new|log|categorize',
494 ApiBase
::PARAM_ISMULTI
=> true,
495 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
496 ApiBase
::PARAM_TYPE
=> RecentChange
::getChangeTypes()
499 ApiBase
::PARAM_TYPE
=> 'user'
502 ApiBase
::PARAM_TYPE
=> 'string',
503 ApiBase
::PARAM_SENSITIVE
=> true,
506 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
511 protected function getExamplesMessages() {
513 'action=query&list=watchlist'
514 => 'apihelp-query+watchlist-example-simple',
515 'action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment'
516 => 'apihelp-query+watchlist-example-props',
517 'action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment'
518 => 'apihelp-query+watchlist-example-allrev',
519 'action=query&generator=watchlist&prop=info'
520 => 'apihelp-query+watchlist-example-generator',
521 'action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user'
522 => 'apihelp-query+watchlist-example-generator-rev',
523 'action=query&list=watchlist&wlowner=Example&wltoken=123ABC'
524 => 'apihelp-query+watchlist-example-wlowner',
528 public function getHelpUrls() {
529 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlist';