includes/api/ApiWatch.php

   1 <?php
   2
   3 /**
   4  * Created on Jan 4, 2008
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright © 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
   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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once( 'ApiBase.php' );
  29 }
  30
  31 /**
  32  * API module to allow users to watch a page
  33  *
  34  * @ingroup API
  35  */
  36 class ApiWatch extends ApiBase {
  37
  38         public function __construct( $main, $action ) {
  39                 parent::__construct( $main, $action );
  40         }
  41
  42         public function execute() {
  43                 global $wgUser;
  44                 if ( !$wgUser->isLoggedIn() ) {
  45                         $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
  46                 }
  47
  48                 $params = $this->extractRequestParams();
  49                 $title = Title::newFromText( $params['title'] );
  50
  51                 if ( !$title ) {
  52                         $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
  53                 }
  54
  55                 $article = new Article( $title );
  56                 $res = array( 'title' => $title->getPrefixedText() );
  57
  58                 if ( $params['unwatch'] ) {
  59                         $res['unwatched'] = '';
  60                         $success = $article->doUnwatch();
  61                 } else {
  62                         $res['watched'] = '';
  63                         $success = $article->doWatch();
  64                 }
  65                 if ( !$success ) {
  66                         $this->dieUsageMsg( array( 'hookaborted' ) );
  67                 }
  68                 $this->getResult()->addValue( null, $this->getModuleName(), $res );
  69         }
  70
  71         public function isWriteMode() {
  72                 return true;
  73         }
  74
  75         public function getAllowedParams() {
  76                 return array(
  77                         'title' => null,
  78                         'unwatch' => false,
  79                 );
  80         }
  81
  82         public function getParamDescription() {
  83                 return array(
  84                         'title' => 'The page to (un)watch',
  85                         'unwatch' => 'If set the page will be unwatched rather than watched',
  86                 );
  87         }
  88
  89         public function getDescription() {
  90                 return array(
  91                         'Add or remove a page from/to the current user\'s watchlist'
  92                 );
  93         }
  94
  95         public function getPossibleErrors() {
  96                 return array_merge( parent::getPossibleErrors(), array(
  97                         array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
  98                         array( 'invalidtitle', 'title' ),
  99                         array( 'hookaborted' ),
 100                 ) );
 101         }
 102
 103         protected function getExamples() {
 104                 return array(
 105                         'api.php?action=watch&title=Main_Page',
 106                         'api.php?action=watch&title=Main_Page&unwatch',
 107                 );
 108         }
 109
 110         public function getVersion() {
 111                 return __CLASS__ . ': $Id$';
 112         }
 113 }