includes/api/ApiRollback.php

   1 <?php
   2
   3 /*
   4  * Created on Jun 20, 2007
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
   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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  */
  24
  25 if ( !defined( 'MEDIAWIKI' ) ) {
  26         // Eclipse helper - will be ignored in production
  27         require_once ( "ApiBase.php" );
  28 }
  29
  30 /**
  31  * @ingroup API
  32  */
  33 class ApiRollback extends ApiBase {
  34
  35         public function __construct( $main, $action ) {
  36                 parent :: __construct( $main, $action );
  37         }
  38
  39         public function execute() {
  40                 $params = $this->extractRequestParams();
  41
  42                 $titleObj = null;
  43                 if ( !isset( $params['title'] ) )
  44                         $this->dieUsageMsg( array( 'missingparam', 'title' ) );
  45                 if ( !isset( $params['user'] ) )
  46                         $this->dieUsageMsg( array( 'missingparam', 'user' ) );
  47
  48                 $titleObj = Title::newFromText( $params['title'] );
  49                 if ( !$titleObj )
  50                         $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
  51                 if ( !$titleObj->exists() )
  52                         $this->dieUsageMsg( array( 'notanarticle' ) );
  53
  54                 // We need to be able to revert IPs, but getCanonicalName rejects them
  55                 $username = User::isIP( $params['user'] )
  56                         ? $params['user']
  57                         : User::getCanonicalName( $params['user'] );
  58                 if ( !$username )
  59                         $this->dieUsageMsg( array( 'invaliduser', $params['user'] ) );
  60
  61                 $articleObj = new Article( $titleObj );
  62                 $summary = ( isset( $params['summary'] ) ? $params['summary'] : "" );
  63                 $details = null;
  64                 $retval = $articleObj->doRollback( $username, $summary, $params['token'], $params['markbot'], $details );
  65
  66                 if ( $retval )
  67                         // We don't care about multiple errors, just report one of them
  68                         $this->dieUsageMsg( reset( $retval ) );
  69
  70                 $info = array(
  71                         'title' => $titleObj->getPrefixedText(),
  72                         'pageid' => intval( $details['current']->getPage() ),
  73                         'summary' => $details['summary'],
  74                         'revid' => intval( $details['newid'] ),
  75                         'old_revid' => intval( $details['current']->getID() ),
  76                         'last_revid' => intval( $details['target']->getID() )
  77                 );
  78
  79                 $this->getResult()->addValue( null, $this->getModuleName(), $info );
  80         }
  81
  82         public function mustBePosted() { return true; }
  83
  84         public function isWriteMode() {
  85                 return true;
  86         }
  87
  88         public function getAllowedParams() {
  89                 return array (
  90                         'title' => null,
  91                         'user' => null,
  92                         'token' => null,
  93                         'summary' => null,
  94                         'markbot' => false
  95                 );
  96         }
  97
  98         public function getParamDescription() {
  99                 return array (
 100                         'title' => 'Title of the page you want to rollback.',
 101                         'user' => 'Name of the user whose edits are to be rolled back. If set incorrectly, you\'ll get a badtoken error.',
 102                         'token' => 'A rollback token previously retrieved through prop=revisions',
 103                         'summary' => 'Custom edit summary. If not set, default summary will be used.',
 104                         'markbot' => 'Mark the reverted edits and the revert as bot edits'
 105                 );
 106         }
 107
 108         public function getDescription() {
 109                 return array(
 110                                 'Undo the last edit to the page. If the last user who edited the page made multiple edits in a row,',
 111                                 'they will all be rolled back.'
 112                         );
 113         }
 114
 115         public function getPossibleErrors() {
 116                 return array_merge( parent::getPossibleErrors(), array(
 117                         array( 'missingparam', 'title' ),
 118                         array( 'missingparam', 'user' ),
 119                         array( 'invalidtitle', 'title' ),
 120                         array( 'notanarticle' ),
 121                         array( 'invaliduser', 'user' ),
 122                 ) );
 123         }
 124
 125         protected function getExamples() {
 126                 return array (
 127                         'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',
 128                         'api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1'
 129                 );
 130         }
 131
 132         public function getVersion() {
 133                 return __CLASS__ . ': $Id: ApiRollback.php 65371 2010-04-21 10:41:25Z tstarling $';
 134         }
 135 }