3 * Copyright © 2008 Roan Kattouw "<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 pages
27 * on the logged-in user's watchlist.
31 class ApiQueryWatchlistRaw
extends ApiQueryGeneratorBase
{
33 public function __construct( ApiQuery
$query, $moduleName ) {
34 parent
::__construct( $query, $moduleName, 'wr' );
37 public function execute() {
41 public function executeGenerator( $resultPageSet ) {
42 $this->run( $resultPageSet );
46 * @param ApiPageSet $resultPageSet
49 private function run( $resultPageSet = null ) {
50 $params = $this->extractRequestParams();
52 $user = $this->getWatchlistUser( $params );
54 $prop = array_flip( (array)$params['prop'] );
55 $show = array_flip( (array)$params['show'] );
56 if ( isset( $show[WatchedItemQueryService
::FILTER_CHANGED
] )
57 && isset( $show[WatchedItemQueryService
::FILTER_NOT_CHANGED
] )
59 $this->dieWithError( 'apierror-show' );
63 if ( $params['namespace'] ) {
64 $options['namespaceIds'] = $params['namespace'];
66 if ( isset( $show[WatchedItemQueryService
::FILTER_CHANGED
] ) ) {
67 $options['filter'] = WatchedItemQueryService
::FILTER_CHANGED
;
69 if ( isset( $show[WatchedItemQueryService
::FILTER_NOT_CHANGED
] ) ) {
70 $options['filter'] = WatchedItemQueryService
::FILTER_NOT_CHANGED
;
73 if ( isset( $params['continue'] ) ) {
74 $cont = explode( '|', $params['continue'] );
75 $this->dieContinueUsageIf( count( $cont ) != 2 );
76 $ns = intval( $cont[0] );
77 $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
79 $options['startFrom'] = new TitleValue( $ns, $title );
82 if ( isset( $params['fromtitle'] ) ) {
83 list( $ns, $title ) = $this->prefixedTitlePartToKey( $params['fromtitle'] );
84 $options['from'] = new TitleValue( $ns, $title );
87 if ( isset( $params['totitle'] ) ) {
88 list( $ns, $title ) = $this->prefixedTitlePartToKey( $params['totitle'] );
89 $options['until'] = new TitleValue( $ns, $title );
92 $options['sort'] = WatchedItemStore
::SORT_ASC
;
93 if ( $params['dir'] === 'descending' ) {
94 $options['sort'] = WatchedItemStore
::SORT_DESC
;
96 $options['limit'] = $params['limit'] +
1;
100 $items = MediaWikiServices
::getInstance()->getWatchedItemQueryService()
101 ->getWatchedItemsForUser( $user, $options );
102 foreach ( $items as $item ) {
103 $ns = $item->getLinkTarget()->getNamespace();
104 $dbKey = $item->getLinkTarget()->getDBkey();
105 if ( ++
$count > $params['limit'] ) {
106 // We've reached the one extra which shows that there are
107 // additional pages to be had. Stop here...
108 $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
111 $t = Title
::makeTitle( $ns, $dbKey );
113 if ( is_null( $resultPageSet ) ) {
115 ApiQueryBase
::addTitleInfo( $vals, $t );
116 if ( isset( $prop['changed'] ) && !is_null( $item->getNotificationTimestamp() ) ) {
117 $vals['changed'] = wfTimestamp( TS_ISO_8601
, $item->getNotificationTimestamp() );
119 $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals );
121 $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
128 if ( is_null( $resultPageSet ) ) {
129 $this->getResult()->addIndexedTagName( $this->getModuleName(), 'wr' );
131 $resultPageSet->populateFromTitles( $titles );
135 public function getAllowedParams() {
138 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
141 ApiBase
::PARAM_ISMULTI
=> true,
142 ApiBase
::PARAM_TYPE
=> 'namespace'
145 ApiBase
::PARAM_DFLT
=> 10,
146 ApiBase
::PARAM_TYPE
=> 'limit',
147 ApiBase
::PARAM_MIN
=> 1,
148 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
149 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
152 ApiBase
::PARAM_ISMULTI
=> true,
153 ApiBase
::PARAM_TYPE
=> [
156 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
159 ApiBase
::PARAM_ISMULTI
=> true,
160 ApiBase
::PARAM_TYPE
=> [
161 WatchedItemQueryService
::FILTER_CHANGED
,
162 WatchedItemQueryService
::FILTER_NOT_CHANGED
166 ApiBase
::PARAM_TYPE
=> 'user'
169 ApiBase
::PARAM_TYPE
=> 'string',
170 ApiBase
::PARAM_SENSITIVE
=> true,
173 ApiBase
::PARAM_DFLT
=> 'ascending',
174 ApiBase
::PARAM_TYPE
=> [
180 ApiBase
::PARAM_TYPE
=> 'string'
183 ApiBase
::PARAM_TYPE
=> 'string'
188 protected function getExamplesMessages() {
190 'action=query&list=watchlistraw'
191 => 'apihelp-query+watchlistraw-example-simple',
192 'action=query&generator=watchlistraw&gwrshow=changed&prop=info'
193 => 'apihelp-query+watchlistraw-example-generator',
197 public function getHelpUrls() {
198 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlistraw';