includes/api/ApiWatch.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Jan 4, 2008
   6  *
   7  * Copyright © 2008 Yuri Astrakhan "<Firstname><Lastname>@gmail.com",
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * API module to allow users to watch a page
  29  *
  30  * @ingroup API
  31  */
  32 class ApiWatch extends ApiBase {
  33         private $mPageSet = null;
  34
  35         public function execute() {
  36                 $user = $this->getUser();
  37                 if ( !$user->isLoggedIn() ) {
  38                         $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
  39                 }
  40
  41                 if ( !$user->isAllowed( 'editmywatchlist' ) ) {
  42                         $this->dieUsage( 'You don\'t have permission to edit your watchlist', 'permissiondenied' );
  43                 }
  44
  45                 $params = $this->extractRequestParams();
  46
  47                 $continuationManager = new ApiContinuationManager( $this, [], [] );
  48                 $this->setContinuationManager( $continuationManager );
  49
  50                 $pageSet = $this->getPageSet();
  51                 // by default we use pageset to extract the page to work on.
  52                 // title is still supported for backward compatibility
  53                 if ( !isset( $params['title'] ) ) {
  54                         $pageSet->execute();
  55                         $res = $pageSet->getInvalidTitlesAndRevisions( [
  56                                 'invalidTitles',
  57                                 'special',
  58                                 'missingIds',
  59                                 'missingRevIds',
  60                                 'interwikiTitles'
  61                         ] );
  62
  63                         foreach ( $pageSet->getMissingTitles() as $title ) {
  64                                 $r = $this->watchTitle( $title, $user, $params );
  65                                 $r['missing'] = 1;
  66                                 $res[] = $r;
  67                         }
  68
  69                         foreach ( $pageSet->getGoodTitles() as $title ) {
  70                                 $r = $this->watchTitle( $title, $user, $params );
  71                                 $res[] = $r;
  72                         }
  73                         ApiResult::setIndexedTagName( $res, 'w' );
  74                 } else {
  75                         // dont allow use of old title parameter with new pageset parameters.
  76                         $extraParams = array_keys( array_filter( $pageSet->extractRequestParams(), function ( $x ) {
  77                                 return $x !== null && $x !== false;
  78                         } ) );
  79
  80                         if ( $extraParams ) {
  81                                 $p = $this->getModulePrefix();
  82                                 $this->dieUsage(
  83                                         "The parameter {$p}title can not be used with " . implode( ', ', $extraParams ),
  84                                         'invalidparammix'
  85                                 );
  86                         }
  87
  88                         $title = Title::newFromText( $params['title'] );
  89                         if ( !$title || !$title->isWatchable() ) {
  90                                 $this->dieUsageMsg( [ 'invalidtitle', $params['title'] ] );
  91                         }
  92                         $res = $this->watchTitle( $title, $user, $params, true );
  93                 }
  94                 $this->getResult()->addValue( null, $this->getModuleName(), $res );
  95
  96                 $this->setContinuationManager( null );
  97                 $continuationManager->setContinuationIntoResult( $this->getResult() );
  98         }
  99
 100         private function watchTitle( Title $title, User $user, array $params,
 101                 $compatibilityMode = false
 102         ) {
 103                 if ( !$title->isWatchable() ) {
 104                         return [ 'title' => $title->getPrefixedText(), 'watchable' => 0 ];
 105                 }
 106
 107                 $res = [ 'title' => $title->getPrefixedText() ];
 108
 109                 if ( $params['unwatch'] ) {
 110                         $status = UnwatchAction::doUnwatch( $title, $user );
 111                         $res['unwatched'] = $status->isOK();
 112                         if ( $status->isOK() ) {
 113                                 $res['message'] = $this->msg( 'removedwatchtext', $title->getPrefixedText() )
 114                                         ->title( $title )->parseAsBlock();
 115                         }
 116                 } else {
 117                         $status = WatchAction::doWatch( $title, $user );
 118                         $res['watched'] = $status->isOK();
 119                         if ( $status->isOK() ) {
 120                                 $res['message'] = $this->msg( 'addedwatchtext', $title->getPrefixedText() )
 121                                         ->title( $title )->parseAsBlock();
 122                         }
 123                 }
 124
 125                 if ( !$status->isOK() ) {
 126                         if ( $compatibilityMode ) {
 127                                 $this->dieStatus( $status );
 128                         }
 129                         $res['error'] = $this->getErrorFromStatus( $status );
 130                 }
 131
 132                 return $res;
 133         }
 134
 135         /**
 136          * Get a cached instance of an ApiPageSet object
 137          * @return ApiPageSet
 138          */
 139         private function getPageSet() {
 140                 if ( $this->mPageSet === null ) {
 141                         $this->mPageSet = new ApiPageSet( $this );
 142                 }
 143
 144                 return $this->mPageSet;
 145         }
 146
 147         public function mustBePosted() {
 148                 return true;
 149         }
 150
 151         public function isWriteMode() {
 152                 return true;
 153         }
 154
 155         public function needsToken() {
 156                 return 'watch';
 157         }
 158
 159         public function getAllowedParams( $flags = 0 ) {
 160                 $result = [
 161                         'title' => [
 162                                 ApiBase::PARAM_TYPE => 'string',
 163                                 ApiBase::PARAM_DEPRECATED => true
 164                         ],
 165                         'unwatch' => false,
 166                         'continue' => [
 167                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 168                         ],
 169                 ];
 170                 if ( $flags ) {
 171                         $result += $this->getPageSet()->getFinalParams( $flags );
 172                 }
 173
 174                 return $result;
 175         }
 176
 177         protected function getExamplesMessages() {
 178                 return [
 179                         'action=watch&titles=Main_Page&token=123ABC'
 180                                 => 'apihelp-watch-example-watch',
 181                         'action=watch&titles=Main_Page&unwatch=&token=123ABC'
 182                                 => 'apihelp-watch-example-unwatch',
 183                         'action=watch&generator=allpages&gapnamespace=0&token=123ABC'
 184                                 => 'apihelp-watch-example-generator',
 185                 ];
 186         }
 187
 188         public function getHelpUrls() {
 189                 return 'https://www.mediawiki.org/wiki/API:Watch';
 190         }
 191 }