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