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