includes/api/ApiSetNotificationTimestamp.php

   1 <?php
   2
   3 /**
   4  * API for MediaWiki 1.14+
   5  *
   6  * Created on Jun 18, 2012
   7  *
   8  * Copyright © 2012 Brad Jorsch
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  *
  25  * @file
  26  */
  27
  28 /**
  29  * API interface for setting the wl_notificationtimestamp field
  30  * @ingroup API
  31  */
  32 class ApiSetNotificationTimestamp extends ApiBase {
  33
  34         private $mPageSet;
  35
  36         public function execute() {
  37                 $user = $this->getUser();
  38
  39                 if ( $user->isAnon() ) {
  40                         $this->dieUsage( 'Anonymous users cannot use watchlist change notifications', 'notloggedin' );
  41                 }
  42                 if ( !$user->isAllowed( 'editmywatchlist' ) ) {
  43                         $this->dieUsage( 'You don\'t have permission to edit your watchlist', 'permissiondenied' );
  44                 }
  45
  46                 $params = $this->extractRequestParams();
  47                 $this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );
  48
  49                 $continuationManager = new ApiContinuationManager( $this, array(), array() );
  50                 $this->setContinuationManager( $continuationManager );
  51
  52                 $pageSet = $this->getPageSet();
  53                 if ( $params['entirewatchlist'] && $pageSet->getDataSource() !== null ) {
  54                         $this->dieUsage(
  55                                 "Cannot use 'entirewatchlist' at the same time as '{$pageSet->getDataSource()}'",
  56                                 'multisource'
  57                         );
  58                 }
  59
  60                 $dbw = wfGetDB( DB_MASTER, 'api' );
  61
  62                 $timestamp = null;
  63                 if ( isset( $params['timestamp'] ) ) {
  64                         $timestamp = $dbw->timestamp( $params['timestamp'] );
  65                 }
  66
  67                 if ( !$params['entirewatchlist'] ) {
  68                         $pageSet->execute();
  69                 }
  70
  71                 if ( isset( $params['torevid'] ) ) {
  72                         if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
  73                                 $this->dieUsage( 'torevid may only be used with a single page', 'multpages' );
  74                         }
  75                         $title = reset( $pageSet->getGoodTitles() );
  76                         if ( $title ) {
  77                                 $timestamp = Revision::getTimestampFromId(
  78                                         $title, $params['torevid'], Revision::READ_LATEST );
  79                                 if ( $timestamp ) {
  80                                         $timestamp = $dbw->timestamp( $timestamp );
  81                                 } else {
  82                                         $timestamp = null;
  83                                 }
  84                         }
  85                 } elseif ( isset( $params['newerthanrevid'] ) ) {
  86                         if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
  87                                 $this->dieUsage( 'newerthanrevid may only be used with a single page', 'multpages' );
  88                         }
  89                         $title = reset( $pageSet->getGoodTitles() );
  90                         if ( $title ) {
  91                                 $revid = $title->getNextRevisionID(
  92                                         $params['newerthanrevid'], Title::GAID_FOR_UPDATE );
  93                                 if ( $revid ) {
  94                                         $timestamp = $dbw->timestamp( Revision::getTimestampFromId( $title, $revid ) );
  95                                 } else {
  96                                         $timestamp = null;
  97                                 }
  98                         }
  99                 }
 100
 101                 $apiResult = $this->getResult();
 102                 $result = array();
 103                 if ( $params['entirewatchlist'] ) {
 104                         // Entire watchlist mode: Just update the thing and return a success indicator
 105                         $dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => $timestamp ),
 106                                 array( 'wl_user' => $user->getID() ),
 107                                 __METHOD__
 108                         );
 109
 110                         $result['notificationtimestamp'] = is_null( $timestamp )
 111                                 ? ''
 112                                 : wfTimestamp( TS_ISO_8601, $timestamp );
 113                 } else {
 114                         // First, log the invalid titles
 115                         foreach ( $pageSet->getInvalidTitles() as $title ) {
 116                                 $r = array();
 117                                 $r['title'] = $title;
 118                                 $r['invalid'] = true;
 119                                 $result[] = $r;
 120                         }
 121                         foreach ( $pageSet->getMissingPageIDs() as $p ) {
 122                                 $page = array();
 123                                 $page['pageid'] = $p;
 124                                 $page['missing'] = true;
 125                                 $page['notwatched'] = true;
 126                                 $result[] = $page;
 127                         }
 128                         foreach ( $pageSet->getMissingRevisionIDs() as $r ) {
 129                                 $rev = array();
 130                                 $rev['revid'] = $r;
 131                                 $rev['missing'] = true;
 132                                 $rev['notwatched'] = true;
 133                                 $result[] = $rev;
 134                         }
 135
 136                         if ( $pageSet->getTitles() ) {
 137                                 // Now process the valid titles
 138                                 $lb = new LinkBatch( $pageSet->getTitles() );
 139                                 $dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => $timestamp ),
 140                                         array( 'wl_user' => $user->getID(), $lb->constructSet( 'wl', $dbw ) ),
 141                                         __METHOD__
 142                                 );
 143
 144                                 // Query the results of our update
 145                                 $timestamps = array();
 146                                 $res = $dbw->select(
 147                                         'watchlist',
 148                                         array( 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ),
 149                                         array( 'wl_user' => $user->getID(), $lb->constructSet( 'wl', $dbw ) ),
 150                                         __METHOD__
 151                                 );
 152                                 foreach ( $res as $row ) {
 153                                         $timestamps[$row->wl_namespace][$row->wl_title] = $row->wl_notificationtimestamp;
 154                                 }
 155
 156                                 // Now, put the valid titles into the result
 157                                 /** @var $title Title */
 158                                 foreach ( $pageSet->getTitles() as $title ) {
 159                                         $ns = $title->getNamespace();
 160                                         $dbkey = $title->getDBkey();
 161                                         $r = array(
 162                                                 'ns' => intval( $ns ),
 163                                                 'title' => $title->getPrefixedText(),
 164                                         );
 165                                         if ( !$title->exists() ) {
 166                                                 $r['missing'] = true;
 167                                         }
 168                                         if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
 169                                                 $r['notificationtimestamp'] = '';
 170                                                 if ( $timestamps[$ns][$dbkey] !== null ) {
 171                                                         $r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601, $timestamps[$ns][$dbkey] );
 172                                                 }
 173                                         } else {
 174                                                 $r['notwatched'] = true;
 175                                         }
 176                                         $result[] = $r;
 177                                 }
 178                         }
 179
 180                         ApiResult::setIndexedTagName( $result, 'page' );
 181                 }
 182                 $apiResult->addValue( null, $this->getModuleName(), $result );
 183
 184                 $this->setContinuationManager( null );
 185                 $continuationManager->setContinuationIntoResult( $apiResult );
 186         }
 187
 188         /**
 189          * Get a cached instance of an ApiPageSet object
 190          * @return ApiPageSet
 191          */
 192         private function getPageSet() {
 193                 if ( !isset( $this->mPageSet ) ) {
 194                         $this->mPageSet = new ApiPageSet( $this );
 195                 }
 196
 197                 return $this->mPageSet;
 198         }
 199
 200         public function mustBePosted() {
 201                 return true;
 202         }
 203
 204         public function isWriteMode() {
 205                 return true;
 206         }
 207
 208         public function needsToken() {
 209                 return 'csrf';
 210         }
 211
 212         public function getAllowedParams( $flags = 0 ) {
 213                 $result = array(
 214                         'entirewatchlist' => array(
 215                                 ApiBase::PARAM_TYPE => 'boolean'
 216                         ),
 217                         'timestamp' => array(
 218                                 ApiBase::PARAM_TYPE => 'timestamp'
 219                         ),
 220                         'torevid' => array(
 221                                 ApiBase::PARAM_TYPE => 'integer'
 222                         ),
 223                         'newerthanrevid' => array(
 224                                 ApiBase::PARAM_TYPE => 'integer'
 225                         ),
 226                         'continue' => array(
 227                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 228                         ),
 229                 );
 230                 if ( $flags ) {
 231                         $result += $this->getPageSet()->getFinalParams( $flags );
 232                 }
 233
 234                 return $result;
 235         }
 236
 237         protected function getExamplesMessages() {
 238                 return array(
 239                         'action=setnotificationtimestamp&entirewatchlist=&token=123ABC'
 240                                 => 'apihelp-setnotificationtimestamp-example-all',
 241                         'action=setnotificationtimestamp&titles=Main_page&token=123ABC'
 242                                 => 'apihelp-setnotificationtimestamp-example-page',
 243                         'action=setnotificationtimestamp&titles=Main_page&' .
 244                                 'timestamp=2012-01-01T00:00:00Z&token=123ABC'
 245                                 => 'apihelp-setnotificationtimestamp-example-pagetimestamp',
 246                         'action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC'
 247                                 => 'apihelp-setnotificationtimestamp-example-allpages',
 248                 );
 249         }
 250
 251         public function getHelpUrls() {
 252                 return 'https://www.mediawiki.org/wiki/API:SetNotificationTimestamp';
 253         }
 254 }