MediaWiki  master
ApiQueryWatchlistRaw.php
Go to the documentation of this file.
1 <?php
24 
32 
33  public function __construct( ApiQuery $query, $moduleName ) {
34  parent::__construct( $query, $moduleName, 'wr' );
35  }
36 
37  public function execute() {
38  $this->run();
39  }
40 
41  public function executeGenerator( $resultPageSet ) {
42  $this->run( $resultPageSet );
43  }
44 
49  private function run( $resultPageSet = null ) {
50  $params = $this->extractRequestParams();
51 
52  $user = $this->getWatchlistUser( $params );
53 
54  $prop = array_flip( (array)$params['prop'] );
55  $show = array_flip( (array)$params['show'] );
56  if ( isset( $show[WatchedItemQueryService::FILTER_CHANGED] )
58  ) {
59  $this->dieWithError( 'apierror-show' );
60  }
61 
62  $options = [];
63  if ( $params['namespace'] ) {
64  $options['namespaceIds'] = $params['namespace'];
65  }
66  if ( isset( $show[WatchedItemQueryService::FILTER_CHANGED] ) ) {
68  }
69  if ( isset( $show[WatchedItemQueryService::FILTER_NOT_CHANGED] ) ) {
71  }
72 
73  if ( isset( $params['continue'] ) ) {
74  $cont = explode( '|', $params['continue'] );
75  $this->dieContinueUsageIf( count( $cont ) != 2 );
76  $ns = (int)$cont[0];
77  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
78  $title = $cont[1];
79  $options['startFrom'] = TitleValue::tryNew( $ns, $title );
80  $this->dieContinueUsageIf( !$options['startFrom'] );
81  }
82 
83  if ( isset( $params['fromtitle'] ) ) {
84  $options['from'] = $this->parsePrefixedTitlePart( $params['fromtitle'] );
85  }
86 
87  if ( isset( $params['totitle'] ) ) {
88  $options['until'] = $this->parsePrefixedTitlePart( $params['totitle'] );
89  }
90 
92  if ( $params['dir'] === 'descending' ) {
94  }
95  $options['limit'] = $params['limit'] + 1;
96 
97  $titles = [];
98  $count = 0;
99  $services = MediaWikiServices::getInstance();
100  $items = $services->getWatchedItemQueryService()
101  ->getWatchedItemsForUser( $user, $options );
102 
103  // Get gender information
104  if ( $items !== [] && $resultPageSet === null &&
105  $services->getContentLanguage()->needsGenderDistinction()
106  ) {
107  $nsInfo = $services->getNamespaceInfo();
108  $usernames = [];
109  foreach ( $items as $item ) {
110  $linkTarget = $item->getLinkTarget();
111  if ( $nsInfo->hasGenderDistinction( $linkTarget->getNamespace() ) ) {
112  $usernames[] = $linkTarget->getText();
113  }
114  }
115  if ( $usernames !== [] ) {
116  $services->getGenderCache()->doQuery( $usernames, __METHOD__ );
117  }
118  }
119 
120  foreach ( $items as $item ) {
121  $ns = $item->getLinkTarget()->getNamespace();
122  $dbKey = $item->getLinkTarget()->getDBkey();
123  if ( ++$count > $params['limit'] ) {
124  // We've reached the one extra which shows that there are
125  // additional pages to be had. Stop here...
126  $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
127  break;
128  }
129  $t = Title::makeTitle( $ns, $dbKey );
130 
131  if ( $resultPageSet === null ) {
132  $vals = [];
133  ApiQueryBase::addTitleInfo( $vals, $t );
134  if ( isset( $prop['changed'] ) && $item->getNotificationTimestamp() !== null ) {
135  $vals['changed'] = wfTimestamp( TS_ISO_8601, $item->getNotificationTimestamp() );
136  }
137  $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals );
138  if ( !$fit ) {
139  $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
140  break;
141  }
142  } else {
143  $titles[] = $t;
144  }
145  }
146  if ( $resultPageSet === null ) {
147  $this->getResult()->addIndexedTagName( $this->getModuleName(), 'wr' );
148  } else {
149  $resultPageSet->populateFromTitles( $titles );
150  }
151  }
152 
153  public function getAllowedParams() {
154  return [
155  'continue' => [
156  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
157  ],
158  'namespace' => [
159  ApiBase::PARAM_ISMULTI => true,
160  ApiBase::PARAM_TYPE => 'namespace'
161  ],
162  'limit' => [
163  ApiBase::PARAM_DFLT => 10,
164  ApiBase::PARAM_TYPE => 'limit',
165  ApiBase::PARAM_MIN => 1,
168  ],
169  'prop' => [
170  ApiBase::PARAM_ISMULTI => true,
172  'changed',
173  ],
175  ],
176  'show' => [
177  ApiBase::PARAM_ISMULTI => true,
181  ]
182  ],
183  'owner' => [
184  ApiBase::PARAM_TYPE => 'user'
185  ],
186  'token' => [
187  ApiBase::PARAM_TYPE => 'string',
188  ApiBase::PARAM_SENSITIVE => true,
189  ],
190  'dir' => [
191  ApiBase::PARAM_DFLT => 'ascending',
193  'ascending',
194  'descending'
195  ],
196  ],
197  'fromtitle' => [
198  ApiBase::PARAM_TYPE => 'string'
199  ],
200  'totitle' => [
201  ApiBase::PARAM_TYPE => 'string'
202  ],
203  ];
204  }
205 
206  protected function getExamplesMessages() {
207  return [
208  'action=query&list=watchlistraw'
209  => 'apihelp-query+watchlistraw-example-simple',
210  'action=query&generator=watchlistraw&gwrshow=changed&prop=info'
211  => 'apihelp-query+watchlistraw-example-generator',
212  ];
213  }
214 
215  public function getHelpUrls() {
216  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlistraw';
217  }
218 }
ApiQueryWatchlistRaw\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryWatchlistRaw.php:153
ApiQuery
This is the main query class.
Definition: ApiQuery.php:37
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:130
ApiQueryWatchlistRaw\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryWatchlistRaw.php:33
ApiQueryWatchlistRaw\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryWatchlistRaw.php:41
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2015
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:132
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1871
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:95
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:644
ApiQueryWatchlistRaw\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryWatchlistRaw.php:37
ApiQueryWatchlistRaw
This query action allows clients to retrieve a list of pages on the logged-in user's watchlist.
Definition: ApiQueryWatchlistRaw.php:31
ApiQueryBase\$options
$options
Definition: ApiQueryBase.php:37
ApiBase\PARAM_SENSITIVE
const PARAM_SENSITIVE
(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of ...
Definition: ApiBase.php:201
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:107
TitleValue\tryNew
static tryNew( $namespace, $title, $fragment='', $interwiki='')
Constructs a TitleValue, or returns null if the parameters are not valid.
Definition: TitleValue.php:91
WatchedItemQueryService\FILTER_NOT_CHANGED
const FILTER_NOT_CHANGED
Definition: WatchedItemQueryService.php:52
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:260
WatchedItemStoreInterface\SORT_DESC
const SORT_DESC
Definition: WatchedItemStoreInterface.php:40
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:98
ApiQueryWatchlistRaw\run
run( $resultPageSet=null)
Definition: ApiQueryWatchlistRaw.php:49
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:765
$title
$title
Definition: testCompression.php:36
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:584
ApiBase\getWatchlistUser
getWatchlistUser( $params)
Gets the user for whom to get the watchlist.
Definition: ApiBase.php:1766
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2210
ApiQueryWatchlistRaw\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryWatchlistRaw.php:215
WatchedItemStoreInterface\SORT_ASC
const SORT_ASC
Definition: WatchedItemStoreInterface.php:35
ApiQueryWatchlistRaw\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryWatchlistRaw.php:206
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:262
WatchedItemQueryService\FILTER_CHANGED
const FILTER_CHANGED
Definition: WatchedItemQueryService.php:51
ApiQueryBase\parsePrefixedTitlePart
parsePrefixedTitlePart( $titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a TitleValue.
Definition: ApiQueryBase.php:551
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:56
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:524
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:59
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:104
$t
$t
Definition: testCompression.php:71
ApiBase\PARAM_HELP_MSG_PER_VALUE
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:165
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:462