4 * Created on Jun 20, 2007
5 * API for MediaWiki 1.8+
7 * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
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.
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.
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
25 if (!defined('MEDIAWIKI')) {
26 // Eclipse helper - will be ignored in production
27 require_once ("ApiBase.php");
33 class ApiRollback
extends ApiBase
{
35 public function __construct($main, $action) {
36 parent
:: __construct($main, $action);
39 public function execute() {
41 $this->getMain()->requestWriteMode();
42 $params = $this->extractRequestParams();
45 if(!isset($params['title']))
46 $this->dieUsageMsg(array('missingparam', 'title'));
47 if(!isset($params['user']))
48 $this->dieUsageMsg(array('missingparam', 'user'));
49 if(!isset($params['token']))
50 $this->dieUsageMsg(array('missingparam', 'token'));
52 $titleObj = Title
::newFromText($params['title']);
54 $this->dieUsageMsg(array('invalidtitle', $params['title']));
55 if(!$titleObj->exists())
56 $this->dieUsageMsg(array('notanarticle'));
58 $username = User
::getCanonicalName($params['user']);
60 $this->dieUsageMsg(array('invaliduser', $params['user']));
62 $articleObj = new Article($titleObj);
63 $summary = (isset($params['summary']) ?
$params['summary'] : "");
65 $retval = $articleObj->doRollback($username, $summary, $params['token'], $params['markbot'], $details);
68 // We don't care about multiple errors, just report one of them
69 $this->dieUsageMsg(current($retval));
71 $current = $target = $summary = NULL;
75 'title' => $titleObj->getPrefixedText(),
76 'pageid' => $current->getPage(),
77 'summary' => $summary,
78 'revid' => $titleObj->getLatestRevID(),
79 'old_revid' => $current->getID(),
80 'last_revid' => $target->getID()
83 $this->getResult()->addValue(null, $this->getModuleName(), $info);
86 public function mustBePosted() { return true; }
88 public function getAllowedParams() {
98 public function getParamDescription() {
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'
108 public function getDescription() {
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.'
115 protected function getExamples() {
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'
122 public function getVersion() {
123 return __CLASS__
. ': $Id$';