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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
<?php
/**
*
*
* Created on Jun 20, 2007
*
* Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* @ingroup API
*/
class ApiRollback extends ApiBase {
/**
* @var Title
*/
private $mTitleObj = null;
/**
* @var User
*/
private $mUser = null;
public function execute() {
$user = $this->getUser();
$params = $this->extractRequestParams();
// WikiPage::doRollback needs a Web UI token, so get one of those if we
// validated based on an API rollback token.
$token = $params['token'];
if ( $user->matchEditToken( $token, 'rollback', $this->getRequest() ) ) {
$token = $this->getUser()->getEditToken(
$this->getWebUITokenSalt( $params ),
$this->getRequest()
);
}
$titleObj = $this->getRbTitle( $params );
$pageObj = WikiPage::factory( $titleObj );
$summary = $params['summary'];
$details = array();
$retval = $pageObj->doRollback(
$this->getRbUser( $params ),
$summary,
$token,
$params['markbot'],
$details,
$user
);
if ( $retval ) {
// We don't care about multiple errors, just report one of them
$this->dieUsageMsg( reset( $retval ) );
}
$watch = 'preferences';
if ( isset( $params['watchlist'] ) ) {
$watch = $params['watchlist'];
}
// Watch pages
$this->setWatch( $watch, $titleObj, 'watchrollback' );
$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,
'pageid' => array(
ApiBase::PARAM_TYPE => 'integer'
),
'user' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true
),
'summary' => '',
'markbot' => false,
'watchlist' => array(
ApiBase::PARAM_DFLT => 'preferences',
ApiBase::PARAM_TYPE => array(
'watch',
'unwatch',
'preferences',
'nochange'
),
),
);
}
public function getParamDescription() {
$p = $this->getModulePrefix();
return array(
'title' => "Title of the page you want to roll back. Cannot be used together with {$p}pageid",
'pageid' => "Page ID of the page you want to roll back. Cannot be used together with {$p}title",
'user' => 'Name of the user whose edits are to be rolled back.',
'token' => array(
/* Standard description automatically prepended */
'For compatibility, the token used in the web UI is also accepted.'
),
'summary' => 'Custom edit summary. If empty, default summary will be used',
'markbot' => 'Mark the reverted edits and the revert as bot edits',
'watchlist' => 'Unconditionally add or remove the page from your watchlist, ' .
'use preferences or do not change watch',
);
}
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 needsToken() {
return 'rollback';
}
protected function getWebUITokenSalt( array $params ) {
return array(
$this->getRbTitle( $params )->getPrefixedText(),
$this->getRbUser( $params )
);
}
/**
* @param array $params
*
* @return string
*/
private function getRbUser( array $params ) {
if ( $this->mUser !== null ) {
return $this->mUser;
}
// We need to be able to revert IPs, but getCanonicalName rejects them
$this->mUser = User::isIP( $params['user'] )
? $params['user']
: User::getCanonicalName( $params['user'] );
if ( !$this->mUser ) {
$this->dieUsageMsg( array( 'invaliduser', $params['user'] ) );
}
return $this->mUser;
}
/**
* @param array $params
*
* @return Title
*/
private function getRbTitle( array $params ) {
if ( $this->mTitleObj !== null ) {
return $this->mTitleObj;
}
$this->requireOnlyOneParameter( $params, 'title', 'pageid' );
if ( isset( $params['title'] ) ) {
$this->mTitleObj = Title::newFromText( $params['title'] );
if ( !$this->mTitleObj || $this->mTitleObj->isExternal() ) {
$this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
}
} elseif ( isset( $params['pageid'] ) ) {
$this->mTitleObj = Title::newFromID( $params['pageid'] );
if ( !$this->mTitleObj ) {
$this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
}
}
if ( !$this->mTitleObj->exists() ) {
$this->dieUsageMsg( 'notanarticle' );
}
return $this->mTitleObj;
}
public function getExamples() {
return array(
'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',
'api.php?action=rollback&pageid=122&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 getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Rollback';
}
}
|
