4 * API for MediaWiki 1.14+
6 * Copyright © 2012 Wikimedia Foundation and contributors
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
26 use MediaWiki\MediaWikiServices
;
29 * API interface for setting the wl_notificationtimestamp field
32 class ApiSetNotificationTimestamp
extends ApiBase
{
34 private $mPageSet = null;
36 public function execute() {
37 $user = $this->getUser();
39 if ( $user->isAnon() ) {
40 $this->dieWithError( 'watchlistanontext', 'notloggedin' );
42 $this->checkUserRightsAny( 'editmywatchlist' );
44 $params = $this->extractRequestParams();
45 $this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );
47 $continuationManager = new ApiContinuationManager( $this, [], [] );
48 $this->setContinuationManager( $continuationManager );
50 $pageSet = $this->getPageSet();
51 if ( $params['entirewatchlist'] && $pageSet->getDataSource() !== null ) {
54 'apierror-invalidparammix-cannotusewith',
55 $this->encodeParamName( 'entirewatchlist' ),
56 $pageSet->encodeParamName( $pageSet->getDataSource() )
62 $dbw = wfGetDB( DB_MASTER
, 'api' );
65 if ( isset( $params['timestamp'] ) ) {
66 $timestamp = $dbw->timestamp( $params['timestamp'] );
69 if ( !$params['entirewatchlist'] ) {
73 if ( isset( $params['torevid'] ) ) {
74 if ( $params['entirewatchlist'] ||
$pageSet->getGoodTitleCount() > 1 ) {
75 $this->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'torevid' ) ] );
77 $titles = $pageSet->getGoodTitles();
78 $title = reset( $titles );
80 $timestamp = MediaWikiServices
::getInstance()->getRevisionStore()
81 ->getTimestampFromId( $title, $params['torevid'], IDBAccessObject
::READ_LATEST
);
83 $timestamp = $dbw->timestamp( $timestamp );
88 } elseif ( isset( $params['newerthanrevid'] ) ) {
89 if ( $params['entirewatchlist'] ||
$pageSet->getGoodTitleCount() > 1 ) {
90 $this->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'newerthanrevid' ) ] );
92 $titles = $pageSet->getGoodTitles();
93 $title = reset( $titles );
95 $revid = $title->getNextRevisionID( $params['newerthanrevid'], Title
::GAID_FOR_UPDATE
);
97 $timestamp = $dbw->timestamp(
98 MediaWikiServices
::getInstance()->getRevisionStore()->getTimestampFromId( $title, $revid )
106 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
107 $apiResult = $this->getResult();
109 if ( $params['entirewatchlist'] ) {
110 // Entire watchlist mode: Just update the thing and return a success indicator
111 $watchedItemStore->resetAllNotificationTimestampsForUser( $user, $timestamp );
113 $result['notificationtimestamp'] = is_null( $timestamp )
115 : wfTimestamp( TS_ISO_8601
, $timestamp );
117 // First, log the invalid titles
118 foreach ( $pageSet->getInvalidTitlesAndReasons() as $r ) {
119 $r['invalid'] = true;
122 foreach ( $pageSet->getMissingPageIDs() as $p ) {
124 $page['pageid'] = $p;
125 $page['missing'] = true;
126 $page['notwatched'] = true;
129 foreach ( $pageSet->getMissingRevisionIDs() as $r ) {
132 $rev['missing'] = true;
133 $rev['notwatched'] = true;
137 if ( $pageSet->getTitles() ) {
138 // Now process the valid titles
139 $watchedItemStore->setNotificationTimestampsForUser(
142 $pageSet->getTitles()
145 // Query the results of our update
146 $timestamps = $watchedItemStore->getNotificationTimestampsBatch(
148 $pageSet->getTitles()
151 // Now, put the valid titles into the result
152 /** @var Title $title */
153 foreach ( $pageSet->getTitles() as $title ) {
154 $ns = $title->getNamespace();
155 $dbkey = $title->getDBkey();
158 'title' => $title->getPrefixedText(),
160 if ( !$title->exists() ) {
161 $r['missing'] = true;
162 if ( $title->isKnown() ) {
166 if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
167 $r['notificationtimestamp'] = '';
168 if ( $timestamps[$ns][$dbkey] !== null ) {
169 $r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601
, $timestamps[$ns][$dbkey] );
172 $r['notwatched'] = true;
178 ApiResult
::setIndexedTagName( $result, 'page' );
180 $apiResult->addValue( null, $this->getModuleName(), $result );
182 $this->setContinuationManager( null );
183 $continuationManager->setContinuationIntoResult( $apiResult );
187 * Get a cached instance of an ApiPageSet object
190 private function getPageSet() {
191 if ( $this->mPageSet
=== null ) {
192 $this->mPageSet
= new ApiPageSet( $this );
195 return $this->mPageSet
;
198 public function mustBePosted() {
202 public function isWriteMode() {
206 public function needsToken() {
210 public function getAllowedParams( $flags = 0 ) {
212 'entirewatchlist' => [
213 ApiBase
::PARAM_TYPE
=> 'boolean'
216 ApiBase
::PARAM_TYPE
=> 'timestamp'
219 ApiBase
::PARAM_TYPE
=> 'integer'
221 'newerthanrevid' => [
222 ApiBase
::PARAM_TYPE
=> 'integer'
225 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
229 $result +
= $this->getPageSet()->getFinalParams( $flags );
235 protected function getExamplesMessages() {
237 'action=setnotificationtimestamp&entirewatchlist=&token=123ABC'
238 => 'apihelp-setnotificationtimestamp-example-all',
239 'action=setnotificationtimestamp&titles=Main_page&token=123ABC'
240 => 'apihelp-setnotificationtimestamp-example-page',
241 'action=setnotificationtimestamp&titles=Main_page&' .
242 'timestamp=2012-01-01T00:00:00Z&token=123ABC'
243 => 'apihelp-setnotificationtimestamp-example-pagetimestamp',
244 'action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC'
245 => 'apihelp-setnotificationtimestamp-example-allpages',
249 public function getHelpUrls() {
250 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:SetNotificationTimestamp';