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
  34         public function __construct( $main, $action ) {
  35                 parent::__construct( $main, $action );
  36         }
  37
  38         public function execute() {
  39                 $user = $this->getUser();
  40                 if ( !$user->isLoggedIn() ) {
  41                         $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
  42                 }
  43                 $params = $this->extractRequestParams();
  44                 // titles can handle basic request of 1 title,
  45                 // but title is still supported for backward compatability
  46                 if ( isset( $params['title'] ) ) {
  47                         $title = Title::newFromText( $params['title'] );
  48                         if ( !$title || $title->getNamespace() < 0 ) {
  49                                 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
  50                         }
  51                         $res = $this->watchTitle( $title, $user, $params);
  52                 } else {
  53                         $pageSet = new ApiPageSet( $this );
  54                         $pageSet->execute();
  55                         $res = array();
  56                         foreach ( $pageSet->getTitles() as $title ) {
  57                                 $r = $this->watchTitle( $title, $user, $params);
  58                                 $res[] = $r;
  59                         }
  60                 }
  61                 $this->getResult()->addValue( null, $this->getModuleName(), $res );
  62         }
  63         private function watchTitle( $title, $user, $params ) {
  64                 $res = array( 'title' => $title->getPrefixedText() );
  65
  66                 if ( $params['unwatch'] ) {
  67                         $res['unwatched'] = '';
  68                         $res['message'] = $this->msg( 'removedwatchtext', $title->getPrefixedText() )->title( $title )->parseAsBlock();
  69                         $success = UnwatchAction::doUnwatch( $title, $user );
  70                 } else {
  71                         $res['watched'] = '';
  72                         $res['message'] = $this->msg( 'addedwatchtext', $title->getPrefixedText() )->title( $title )->parseAsBlock();
  73                         $success = WatchAction::doWatch( $title, $user );
  74                 }
  75                 if ( !$success ) {
  76                         $this->dieUsageMsg( 'hookaborted' );
  77                 }
  78                 return $res;
  79         }
  80
  81         public function mustBePosted() {
  82                 return true;
  83         }
  84
  85         public function isWriteMode() {
  86                 return true;
  87         }
  88
  89         public function needsToken() {
  90                 return true;
  91         }
  92
  93         public function getTokenSalt() {
  94                 return 'watch';
  95         }
  96
  97         public function getAllowedParams() {
  98                 return array(
  99                         'title' => array(
 100                                 ApiBase::PARAM_TYPE => 'string',
 101                         ),
 102                         'titles' => array(
 103                                 ApiBase::PARAM_TYPE => 'string',
 104                                 ApiBase::PARAM_ISMULTI => true
 105                         ),
 106                         'unwatch' => false,
 107                         'token' => array(
 108                                 ApiBase::PARAM_TYPE => 'string',
 109                                 ApiBase::PARAM_REQUIRED => true
 110                         ),
 111                 );
 112         }
 113
 114         public function getParamDescription() {
 115                 return array(
 116                         'title' => 'The page to (un)watch',
 117                         'unwatch' => 'If set the page will be unwatched rather than watched',
 118                         'token' => 'A token previously acquired via prop=info',
 119                 );
 120         }
 121
 122         public function getResultProperties() {
 123                 return array(
 124                         '' => array(
 125                                 'title' => 'string',
 126                                 'unwatched' => 'boolean',
 127                                 'watched' => 'boolean',
 128                                 'message' => 'string'
 129                         )
 130                 );
 131         }
 132
 133         public function getDescription() {
 134                 return 'Add or remove a page from/to the current user\'s watchlist';
 135         }
 136
 137         public function getPossibleErrors() {
 138                 return array_merge( parent::getPossibleErrors(), array(
 139                         array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
 140                         array( 'invalidtitle', 'title' ),
 141                         array( 'hookaborted' ),
 142                 ) );
 143         }
 144
 145         public function getExamples() {
 146                 return array(
 147                         'api.php?action=watch&title=Main_Page' => 'Watch the page "Main Page"',
 148                         'api.php?action=watch&title=Main_Page&unwatch=' => 'Unwatch the page "Main Page"',
 149                 );
 150         }
 151
 152         public function getHelpUrls() {
 153                 return 'https://www.mediawiki.org/wiki/API:Watch';
 154         }
 155
 156         public function getVersion() {
 157                 return __CLASS__ . ': $Id$';
 158         }
 159 }