includes/api/ApiWatch.php

   1 <?php
   2
   3 /*
   4  * Created on Jan 4, 2008
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 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                 $this->getMain()->requestWriteMode();
  45                 if(!$wgUser->isLoggedIn())
  46                         $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
  47                 $params = $this->extractRequestParams();
  48                 $title = Title::newFromText($params['title']);
  49                 if(!$title)
  50                         $this->dieUsageMsg(array('invalidtitle', $params['title']));
  51                 $article = new Article($title);
  52                 $res = array('title' => $title->getPrefixedText());
  53                 if($params['unwatch'])
  54                 {
  55                         $res['unwatched'] = '';
  56                         $success = $article->doUnwatch();
  57                 }
  58                 else
  59                 {
  60                         $res['watched'] = '';
  61                         $success = $article->doWatch();
  62                 }
  63                 if(!$success)
  64                         $this->dieUsageMsg(array('hookaborted'));
  65                 $this->getResult()->addValue(null, $this->getModuleName(), $res);
  66         }
  67
  68         public function getAllowedParams() {
  69                 return array (
  70                         'title' => null,
  71                         'unwatch' => false,
  72                 );
  73         }
  74
  75         public function getParamDescription() {
  76                 return array (
  77                         'title' => 'The page to (un)watch',
  78                         'unwatch' => 'If set the page will be unwatched rather than watched',
  79                 );
  80         }
  81
  82         public function getDescription() {
  83                 return array (
  84                         'Add or remove a page from/to the current user\'s watchlist'
  85                 );
  86         }
  87
  88         protected function getExamples() {
  89                 return array(
  90                         'api.php?action=watch&title=Main_Page',
  91                         'api.php?action=watch&title=Main_Page&unwatch',
  92                 );
  93         }
  94
  95         public function getVersion() {
  96                 return __CLASS__ . ': $Id$';
  97         }
  98 }