includes/api/ApiPatrol.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.14+
   4  *
   5  * Created on Sep 2, 2008
   6  *
   7  * Copyright © 2008 Soxred93 soxred93@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 if ( !defined( 'MEDIAWIKI' ) ) {
  28         require_once ( 'ApiBase.php' );
  29 }
  30
  31 /**
  32  * Allows user to patrol pages
  33  * @ingroup API
  34  */
  35 class ApiPatrol extends ApiBase {
  36
  37         public function __construct( $main, $action ) {
  38                 parent::__construct( $main, $action );
  39         }
  40
  41         /**
  42          * Patrols the article or provides the reason the patrol failed.
  43          */
  44         public function execute() {
  45                 $params = $this->extractRequestParams();
  46
  47                 $rc = RecentChange::newFromID( $params['rcid'] );
  48                 if ( !$rc instanceof RecentChange ) {
  49                         $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
  50                 }
  51                 $retval = $rc->doMarkPatrolled( $this->getUser() );
  52
  53                 if ( $retval ) {
  54                         $this->dieUsageMsg( reset( $retval ) );
  55                 }
  56
  57                 $result = array( 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) );
  58                 ApiQueryBase::addTitleInfo( $result, $rc->getTitle() );
  59                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
  60         }
  61
  62         public function mustBePosted() {
  63                 return true;
  64         }
  65
  66         public function isWriteMode() {
  67                 return true;
  68         }
  69
  70         public function getAllowedParams() {
  71                 return array(
  72                         'token' => null,
  73                         'rcid' => array(
  74                                 ApiBase::PARAM_TYPE => 'integer',
  75                                 ApiBase::PARAM_REQUIRED => true
  76                         ),
  77                 );
  78         }
  79
  80         public function getParamDescription() {
  81                 return array(
  82                         'token' => 'Patrol token obtained from list=recentchanges',
  83                         'rcid' => 'Recentchanges ID to patrol',
  84                 );
  85         }
  86
  87         public function getDescription() {
  88                 return 'Patrol a page or revision';
  89         }
  90
  91         public function getPossibleErrors() {
  92                 return array_merge( parent::getPossibleErrors(), array(
  93                         array( 'nosuchrcid', 'rcid' ),
  94                 ) );
  95         }
  96
  97         public function needsToken() {
  98                 return true;
  99         }
 100
 101         public function getTokenSalt() {
 102                 return 'patrol';
 103         }
 104
 105         public function getExamples() {
 106                 return array(
 107                         'api.php?action=patrol&token=123abc&rcid=230672766'
 108                 );
 109         }
 110
 111         public function getHelpUrls() {
 112                 return 'http://www.mediawiki.org/wiki/API:Patrol';
 113         }
 114
 115         public function getVersion() {
 116                 return __CLASS__ . ': $Id$';
 117         }
 118 }