4 * API for MediaWiki 1.14+
6 * Created on Jun 18, 2012
8 * Copyright © 2012 Brad Jorsch
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
29 * API interface for setting the wl_notificationtimestamp field
32 class ApiSetNotificationTimestamp
extends ApiBase
{
36 public function execute() {
37 $user = $this->getUser();
39 if ( $user->isAnon() ) {
40 $this->dieUsage( 'Anonymous users cannot use watchlist change notifications', 'notloggedin' );
42 if ( !$user->isAllowed( 'editmywatchlist' ) ) {
43 $this->dieUsage( 'You don\'t have permission to edit your watchlist', 'permissiondenied' );
46 $params = $this->extractRequestParams();
47 $this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );
49 $this->getResult()->beginContinuation( $params['continue'], array(), array() );
51 $pageSet = $this->getPageSet();
52 if ( $params['entirewatchlist'] && $pageSet->getDataSource() !== null ) {
54 "Cannot use 'entirewatchlist' at the same time as '{$pageSet->getDataSource()}'",
59 $dbw = wfGetDB( DB_MASTER
, 'api' );
62 if ( isset( $params['timestamp'] ) ) {
63 $timestamp = $dbw->timestamp( $params['timestamp'] );
66 if ( !$params['entirewatchlist'] ) {
70 if ( isset( $params['torevid'] ) ) {
71 if ( $params['entirewatchlist'] ||
$pageSet->getGoodTitleCount() > 1 ) {
72 $this->dieUsage( 'torevid may only be used with a single page', 'multpages' );
74 $title = reset( $pageSet->getGoodTitles() );
76 $timestamp = Revision
::getTimestampFromId(
77 $title, $params['torevid'], Revision
::READ_LATEST
);
79 $timestamp = $dbw->timestamp( $timestamp );
84 } elseif ( isset( $params['newerthanrevid'] ) ) {
85 if ( $params['entirewatchlist'] ||
$pageSet->getGoodTitleCount() > 1 ) {
86 $this->dieUsage( 'newerthanrevid may only be used with a single page', 'multpages' );
88 $title = reset( $pageSet->getGoodTitles() );
90 $revid = $title->getNextRevisionID(
91 $params['newerthanrevid'], Title
::GAID_FOR_UPDATE
);
93 $timestamp = $dbw->timestamp( Revision
::getTimestampFromId( $title, $revid ) );
100 $apiResult = $this->getResult();
102 if ( $params['entirewatchlist'] ) {
103 // Entire watchlist mode: Just update the thing and return a success indicator
104 $dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => $timestamp ),
105 array( 'wl_user' => $user->getID() ),
109 $result['notificationtimestamp'] = is_null( $timestamp )
111 : wfTimestamp( TS_ISO_8601
, $timestamp );
113 // First, log the invalid titles
114 foreach ( $pageSet->getInvalidTitles() as $title ) {
116 $r['title'] = $title;
120 foreach ( $pageSet->getMissingPageIDs() as $p ) {
122 $page['pageid'] = $p;
123 $page['missing'] = '';
124 $page['notwatched'] = '';
127 foreach ( $pageSet->getMissingRevisionIDs() as $r ) {
130 $rev['missing'] = '';
131 $rev['notwatched'] = '';
135 if ( $pageSet->getTitles() ) {
136 // Now process the valid titles
137 $lb = new LinkBatch( $pageSet->getTitles() );
138 $dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => $timestamp ),
139 array( 'wl_user' => $user->getID(), $lb->constructSet( 'wl', $dbw ) ),
143 // Query the results of our update
144 $timestamps = array();
147 array( 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ),
148 array( 'wl_user' => $user->getID(), $lb->constructSet( 'wl', $dbw ) ),
151 foreach ( $res as $row ) {
152 $timestamps[$row->wl_namespace
][$row->wl_title
] = $row->wl_notificationtimestamp
;
155 // Now, put the valid titles into the result
156 /** @var $title Title */
157 foreach ( $pageSet->getTitles() as $title ) {
158 $ns = $title->getNamespace();
159 $dbkey = $title->getDBkey();
161 'ns' => intval( $ns ),
162 'title' => $title->getPrefixedText(),
164 if ( !$title->exists() ) {
167 if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
168 $r['notificationtimestamp'] = '';
169 if ( $timestamps[$ns][$dbkey] !== null ) {
170 $r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601
, $timestamps[$ns][$dbkey] );
173 $r['notwatched'] = '';
179 $apiResult->setIndexedTagName( $result, 'page' );
181 $apiResult->addValue( null, $this->getModuleName(), $result );
183 $apiResult->endContinuation();
187 * Get a cached instance of an ApiPageSet object
190 private function getPageSet() {
191 if ( !isset( $this->mPageSet
) ) {
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' => array(
213 ApiBase
::PARAM_TYPE
=> 'boolean'
215 'timestamp' => array(
216 ApiBase
::PARAM_TYPE
=> 'timestamp'
219 ApiBase
::PARAM_TYPE
=> 'integer'
221 'newerthanrevid' => array(
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/API:SetNotificationTimestamp';