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  * @addtogroup 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                 global $wgUser;
  41                 $this->getMain()->requestWriteMode();
  42                 $params = $this->extractRequestParams();
  43
  44                 $titleObj = NULL;
  45                 if(!isset($params['title']))
  46                         $this->dieUsage('The title parameter must be set', 'notitle');
  47                 if(!isset($params['user']))
  48                         $this->dieUsage('The user parameter must be set', 'nouser');
  49                 if(!isset($params['token']))
  50                         $this->dieUsage('The token parameter must be set', 'notoken');
  51
  52                 if(wfReadOnly())
  53                         $this->dieUsage('The wiki is in read-only mode', 'readonly');
  54
  55                 $titleObj = Title::newFromText($params['title']);
  56
  57                 $username = User::getCanonicalName($params['user']);
  58                 if(!$username)
  59                         $this->dieUsage("Invalid username ``{$params['user']}''", 'invaliduser');
  60
  61                 $articleObj = new Article($titleObj);
  62                 $summary = (isset($params['summary']) ? $params['summary'] : "");
  63                 $details = null;
  64                 $dbw = wfGetDb(DB_MASTER);
  65                 $dbw->begin();
  66                 $retval = $articleObj->doRollback($username, $summary, $params['token'], $params['markbot'], &$details);
  67
  68                 if(!empty($retval))
  69                         // We don't care about multiple errors, just report the first one
  70                         $this->dieUsageMsg(current($retval));
  71
  72                 $dbw->commit();
  73                 $current = $target = $summary = NULL;
  74                 extract($details);
  75
  76                 $info = array(
  77                         'title' => $titleObj->getPrefixedText(),
  78                         'pageid' => $current->getPage(),
  79                         'summary' => $summary,
  80                         'revid' => $titleObj->getLatestRevID(),
  81                         'old_revid' => $current->getID(),
  82                         'last_revid' => $target->getID()
  83                 );
  84
  85                 $this->getResult()->addValue(null, $this->getModuleName(), $info);
  86         }
  87
  88         protected function getAllowedParams() {
  89                 return array (
  90                         'title' => null,
  91                         'user' => null,
  92                         'token' => null,
  93                         'summary' => null,
  94                         'markbot' => false
  95                 );
  96         }
  97
  98         protected 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=info',
 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         protected function getDescription() {
 109                 return array(
 110                                 'Undoes 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. You need to be logged in as a sysop to use this function, see also action=login.'
 112                         );
 113         }
 114
 115         protected function getExamples() {
 116                 return array (
 117                         'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',
 118                         'api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1'
 119                 );
 120         }
 121
 122         public function getVersion() {
 123                 return __CLASS__ . ': $Id$';
 124         }
 125 }