Go to the documentation of this file.
38 parent::__construct(
$query, $moduleName,
'wl' );
46 $this->
run( $resultPageSet );
59 private function run( $resultPageSet =
null ) {
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'] );
81 $this->fld_loginfo = isset( $prop[
'loginfo'] );
82 $this->fld_tags = isset( $prop[
'tags'] );
84 if ( $this->fld_patrol && !
$user->useRCPatrol() && !
$user->useNPPatrol() ) {
85 $this->
dieWithError(
'apierror-permissiondenied-patrolflag',
'patrol' );
88 if ( $this->fld_comment || $this->fld_parsedcomment ) {
94 'dir' =>
$params[
'dir'] ===
'older'
99 if ( is_null( $resultPageSet ) ) {
113 if ( !is_null(
$params[
'continue'] ) ) {
114 $cont = explode(
'|',
$params[
'continue'] );
116 $continueTimestamp = $cont[0];
117 $continueId = (int)$cont[1];
119 $startFrom = [ $continueTimestamp, $continueId ];
122 if ( $wlowner !==
$user ) {
123 $options[
'watchlistOwner'] = $wlowner;
127 if ( !is_null(
$params[
'namespace'] ) ) {
135 if ( !is_null(
$params[
'show'] ) ) {
136 $show = array_flip(
$params[
'show'] );
147 if ( !
$user->useRCPatrol() && !
$user->useNPPatrol() ) {
148 $this->
dieWithError(
'apierror-permissiondenied-patrolflag',
'permissiondenied' );
152 $options[
'filters'] = array_keys( $show );
155 if ( !is_null(
$params[
'type'] ) ) {
161 }
catch ( Exception
$e ) {
167 if ( !is_null(
$params[
'user'] ) ) {
170 if ( !is_null(
$params[
'excludeuser'] ) ) {
176 Hooks::run(
'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions', [
181 $watchedItemQuery = MediaWikiServices::getInstance()->getWatchedItemQueryService();
182 $items = $watchedItemQuery->getWatchedItemsWithRecentChangeInfo( $wlowner,
$options, $startFrom );
184 foreach ( $items
as list( $watchedItem, $recentChangeInfo ) ) {
186 if ( is_null( $resultPageSet ) ) {
190 $startFrom = [ $recentChangeInfo[
'rc_timestamp'], $recentChangeInfo[
'rc_id'] ];
193 } elseif (
$params[
'allrev'] ) {
194 $ids[] = (int)$recentChangeInfo[
'rc_this_oldid'];
196 $ids[] = (int)$recentChangeInfo[
'rc_cur_id'];
200 if ( $startFrom !==
null ) {
204 if ( is_null( $resultPageSet ) ) {
209 } elseif (
$params[
'allrev'] ) {
210 $resultPageSet->populateFromRevisionIDs( $ids );
212 $resultPageSet->populateFromPageIDs( $ids );
218 if ( $this->fld_flags ) {
221 if ( $this->fld_user || $this->fld_userid ) {
224 if ( $this->fld_user ) {
227 if ( $this->fld_comment || $this->fld_parsedcomment ) {
230 if ( $this->fld_patrol ) {
234 if ( $this->fld_sizes ) {
237 if ( $this->fld_loginfo ) {
240 if ( $this->fld_tags ) {
243 return $includeFields;
270 $type = (int)$recentChangeInfo[
'rc_type'];
275 if ( $this->fld_title || $this->fld_ids ) {
278 $vals[
'actionhidden'] =
true;
283 $recentChangeInfo[
'rc_deleted'],
288 if ( $this->fld_title ) {
291 if ( $this->fld_ids ) {
292 $vals[
'pageid'] = (int)$recentChangeInfo[
'rc_cur_id'];
293 $vals[
'revid'] = (int)$recentChangeInfo[
'rc_this_oldid'];
294 $vals[
'old_revid'] = (int)$recentChangeInfo[
'rc_last_oldid'];
300 if ( $this->fld_user || $this->fld_userid ) {
301 if ( $recentChangeInfo[
'rc_deleted'] & RevisionRecord::DELETED_USER ) {
302 $vals[
'userhidden'] =
true;
305 if ( RevisionRecord::userCanBitfield(
306 $recentChangeInfo[
'rc_deleted'],
307 RevisionRecord::DELETED_USER,
310 if ( $this->fld_userid ) {
311 $vals[
'userid'] = (int)$recentChangeInfo[
'rc_user'];
313 $vals[
'user'] = (int)$recentChangeInfo[
'rc_user'];
316 if ( $this->fld_user ) {
317 $vals[
'user'] = $recentChangeInfo[
'rc_user_text'];
320 if ( !$recentChangeInfo[
'rc_user'] ) {
321 $vals[
'anon'] =
true;
327 if ( $this->fld_flags ) {
328 $vals[
'bot'] = (bool)$recentChangeInfo[
'rc_bot'];
329 $vals[
'new'] = $recentChangeInfo[
'rc_type'] ==
RC_NEW;
330 $vals[
'minor'] = (bool)$recentChangeInfo[
'rc_minor'];
334 if ( $this->fld_sizes ) {
335 $vals[
'oldlen'] = (int)$recentChangeInfo[
'rc_old_len'];
336 $vals[
'newlen'] = (int)$recentChangeInfo[
'rc_new_len'];
340 if ( $this->fld_timestamp ) {
341 $vals[
'timestamp'] =
wfTimestamp( TS_ISO_8601, $recentChangeInfo[
'rc_timestamp'] );
344 if ( $this->fld_notificationtimestamp ) {
351 if ( $this->fld_comment || $this->fld_parsedcomment ) {
352 if ( $recentChangeInfo[
'rc_deleted'] & RevisionRecord::DELETED_COMMENT ) {
353 $vals[
'commenthidden'] =
true;
356 if ( RevisionRecord::userCanBitfield(
357 $recentChangeInfo[
'rc_deleted'],
358 RevisionRecord::DELETED_COMMENT,
361 $comment = $this->commentStore->getComment(
'rc_comment', $recentChangeInfo )->text;
362 if ( $this->fld_comment ) {
363 $vals[
'comment'] = $comment;
366 if ( $this->fld_parsedcomment ) {
373 if ( $this->fld_patrol ) {
379 if ( $this->fld_loginfo && $recentChangeInfo[
'rc_type'] ==
RC_LOG ) {
381 $vals[
'actionhidden'] =
true;
385 $recentChangeInfo[
'rc_deleted'],
389 $vals[
'logid'] = (int)$recentChangeInfo[
'rc_logid'];
390 $vals[
'logtype'] = $recentChangeInfo[
'rc_log_type'];
391 $vals[
'logaction'] = $recentChangeInfo[
'rc_log_action'];
396 if ( $this->fld_tags ) {
397 if ( $recentChangeInfo[
'rc_tags'] ) {
398 $tags = explode(
',', $recentChangeInfo[
'rc_tags'] );
400 $vals[
'tags'] = $tags;
406 if ( $anyHidden && ( $recentChangeInfo[
'rc_deleted'] & RevisionRecord::DELETED_RESTRICTED ) ) {
407 $vals[
'suppressed'] =
true;
410 Hooks::run(
'ApiQueryWatchlistExtractOutputData', [
411 $this, $watchedItem, $recentChangeInfo, &$vals
466 'notificationtimestamp',
509 'action=query&list=watchlist'
510 =>
'apihelp-query+watchlist-example-simple',
511 'action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment'
512 =>
'apihelp-query+watchlist-example-props',
513 'action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment'
514 =>
'apihelp-query+watchlist-example-allrev',
515 'action=query&generator=watchlist&prop=info'
516 =>
'apihelp-query+watchlist-example-generator',
517 'action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user'
518 =>
'apihelp-query+watchlist-example-generator-rev',
519 'action=query&list=watchlist&wlowner=Example&wltoken=123ABC'
520 =>
'apihelp-query+watchlist-example-wlowner',
525 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlist';
return true to allow those checks to and false if checking is done & $user
This is the main query class.
const FILTER_NOT_AUTOPATROLLED
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
getResult()
Get the result object.
static getChangeTypes()
Get an array of all change types.
$fld_notificationtimestamp
static parseToRCType( $type)
Parsing text to RC_* constants.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
const PARAM_SENSITIVE
(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of ...
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
namespace and then decline to actually register it file or subcat img or subcat $title
const INCLUDE_AUTOPATROL_INFO
const LIMIT_BIG1
Fast query, standard limit.
const INCLUDE_PATROL_INFO
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
executeGenerator( $resultPageSet)
Execute this module as a generator.
showParamsConflicting(array $show)
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
CommentStore $commentStore
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
getWatchlistUser( $params)
Gets the user for whom to get the watchlist.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Representation of a pair of user and title for watchlist entries.
const FILTER_NOT_PATROLLED
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
extractOutputData(WatchedItem $watchedItem, array $recentChangeInfo)
static newFromLinkTarget(LinkTarget $linkTarget, $forceClone='')
Returns a Title given a LinkTarget.
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
getHelpUrls()
Return links to more detailed help pages about the module.
This query action allows clients to retrieve a list of recently modified pages that are part of the l...
selectNamedDB( $name, $db, $groups)
Selects the query database connection with the given name.
const LIMIT_BIG2
Fast query, apihighlimits limit.
static userCanBitfield( $bitfield, $field, User $user=null)
Determine if the current user is allowed to view a particular field of this log row,...
const FILTER_AUTOPATROLLED
static parseFromRCType( $rcType)
Parsing RC_* constants to human-readable test.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
getModuleName()
Get the name of the module being executed by this instance.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getNotificationTimestamp()
Get the notification timestamp of this entry.
static isUnpatrolled( $rc, User $user)
getExamplesMessages()
Returns usage examples for this module.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
run( $resultPageSet=null)
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
__construct(ApiQuery $query, $moduleName)