includes/api/ApiPatrol.php

   1 <?php
   2
   3 /**
   4  * Created on Sep 2, 2008
   5  *
   6  * API for MediaWiki 1.14+
   7  *
   8  * Copyright © 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  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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                 $params = $this->extractRequestParams();
  45
  46                 $rc = RecentChange::newFromID( $params['rcid'] );
  47                 if ( !$rc instanceof RecentChange ) {
  48                         $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
  49                 }
  50                 $retval = RecentChange::markPatrolled( $params['rcid'] );
  51
  52                 if ( $retval ) {
  53                         $this->dieUsageMsg( reset( $retval ) );
  54                 }
  55
  56                 $result = array( 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) );
  57                 ApiQueryBase::addTitleInfo( $result, $rc->getTitle() );
  58                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
  59         }
  60
  61         public function isWriteMode() {
  62                 return true;
  63         }
  64
  65         public function getAllowedParams() {
  66                 return array(
  67                         'token' => null,
  68                         'rcid' => array(
  69                                 ApiBase::PARAM_TYPE => 'integer',
  70                                 ApiBase::PARAM_REQUIRED => true
  71                         ),
  72                 );
  73         }
  74
  75         public function getParamDescription() {
  76                 return array(
  77                         'token' => 'Patrol token obtained from list=recentchanges',
  78                         'rcid' => 'Recentchanges ID to patrol',
  79                 );
  80         }
  81
  82         public function getDescription() {
  83                 return 'Patrol a page or revision';
  84         }
  85
  86         public function getPossibleErrors() {
  87                 return array_merge( parent::getPossibleErrors(), array(
  88                         array( 'missingparam', 'rcid' ),
  89                         array( 'nosuchrcid', 'rcid' ),
  90                 ) );
  91         }
  92
  93         public function getTokenSalt() {
  94                 return '';
  95         }
  96
  97         protected function getExamples() {
  98                 return array(
  99                         'api.php?action=patrol&token=123abc&rcid=230672766'
 100                 );
 101         }
 102
 103         public function getVersion() {
 104                 return __CLASS__ . ': $Id$';
 105         }
 106 }