includes/api/ApiPatrol.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 2, 2008
   5  *
   6  * API for MediaWiki 1.14+
   7  *
   8  * Copyright (C) 2008 Soxred93 soxred93@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         require_once ('ApiBase.php');
  28 }
  29
  30 /**
  31  * Allows user to patrol pages
  32  * @ingroup API
  33  */
  34 class ApiPatrol extends ApiBase {
  35
  36         public function __construct($main, $action) {
  37                 parent :: __construct($main, $action);
  38         }
  39
  40         /**
  41          * Patrols the article or provides the reason the patrol failed.
  42          */
  43         public function execute() {
  44                 global $wgUser, $wgUseRCPatrol, $wgUseNPPatrol;
  45                 $this->getMain()->requestWriteMode();
  46                 $params = $this->extractRequestParams();
  47
  48                 if(!isset($params['token']))
  49                         $this->dieUsageMsg(array('missingparam', 'token'));
  50                 if(!isset($params['rcid']))
  51                         $this->dieUsageMsg(array('missingparam', 'rcid'));
  52                 if(!$wgUser->matchEditToken($params['token']))
  53                         $this->dieUsageMsg(array('sessionfailure'));
  54
  55                 $rc = RecentChange::newFromID($params['rcid']);
  56                 if(!$rc instanceof RecentChange)
  57                         $this->dieUsageMsg(array('nosuchrcid', $params['rcid']));
  58                 $retval = RecentChange::markPatrolled($params['rcid']);
  59
  60                 if(!empty($retval))
  61                         $this->dieUsageMsg(current($retval));
  62
  63                 $result = array('rcid' => $rc->getAttribute('rc_id'));
  64                 ApiQueryBase::addTitleInfo($result, $rc->getTitle());
  65                 $this->getResult()->addValue(null, $this->getModuleName(), $result);
  66         }
  67
  68         public function getAllowedParams() {
  69                 return array (
  70                         'token' => null,
  71                         'rcid' => array(
  72                                 ApiBase :: PARAM_TYPE => 'integer'
  73                         ),
  74                 );
  75         }
  76
  77         public function getParamDescription() {
  78                 return array (
  79                         'token' => 'Patrol token obtained from list=recentchanges',
  80                         'rcid' => 'Recentchanges ID to patrol',
  81                 );
  82         }
  83
  84         public function getDescription() {
  85                 return array (
  86                         'Patrol a page or revision. '
  87                 );
  88         }
  89
  90         protected function getExamples() {
  91                 return array(
  92                         'api.php?action=patrol&token=123abc&rcid=230672766'
  93                 );
  94         }
  95
  96         public function getVersion() {
  97                 return __CLASS__ . ': $Id$';
  98         }
  99 }