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
227
228
229
230
231
232
233
234
235
236
|
<?php
/**
* Created on Jun 25, 2013
*
* Copyright © 2013 Brad Jorsch <bjorsch@wikimedia.org>
*
* 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
* @since 1.23
*/
/**
* API interface to RevDel. The API equivalent of Special:RevisionDelete.
* Requires API write mode to be enabled.
*
* @ingroup API
*/
class ApiRevisionDelete extends ApiBase {
public function execute() {
$params = $this->extractRequestParams();
$user = $this->getUser();
if ( !$user->isAllowed( RevisionDeleter::getRestriction( $params['type'] ) ) ) {
$this->dieUsageMsg( 'badaccess-group0' );
}
if ( !$params['ids'] ) {
$this->dieUsage( "At least one value is required for 'ids'", 'badparams' );
}
$hide = $params['hide'] ?: array();
$show = $params['show'] ?: array();
if ( array_intersect( $hide, $show ) ) {
$this->dieUsage( "Mutually exclusive values for 'hide' and 'show'", 'badparams' );
} elseif ( !$hide && !$show ) {
$this->dieUsage( "At least one value is required for 'hide' or 'show'", 'badparams' );
}
$bits = array(
'content' => RevisionDeleter::getRevdelConstant( $params['type'] ),
'comment' => Revision::DELETED_COMMENT,
'user' => Revision::DELETED_USER,
);
$bitfield = array();
foreach ( $bits as $key => $bit ) {
if ( in_array( $key, $hide ) ) {
$bitfield[$bit] = 1;
} elseif ( in_array( $key, $show ) ) {
$bitfield[$bit] = 0;
} else {
$bitfield[$bit] = -1;
}
}
if ( $params['suppress'] === 'yes' ) {
if ( !$user->isAllowed( 'suppressrevision' ) ) {
$this->dieUsageMsg( 'badaccess-group0' );
}
$bitfield[Revision::DELETED_RESTRICTED] = 1;
} elseif ( $params['suppress'] === 'no' ) {
$bitfield[Revision::DELETED_RESTRICTED] = 0;
} else {
$bitfield[Revision::DELETED_RESTRICTED] = -1;
}
$targetObj = null;
if ( $params['target'] ) {
$targetObj = Title::newFromText( $params['target'] );
}
$targetObj = RevisionDeleter::suggestTarget( $params['type'], $targetObj, $params['ids'] );
if ( $targetObj === null ) {
$this->dieUsage( 'A target title is required for this RevDel type', 'needtarget' );
}
$list = RevisionDeleter::createList(
$params['type'], $this->getContext(), $targetObj, $params['ids']
);
$status = $list->setVisibility(
array( 'value' => $bitfield, 'comment' => $params['reason'], 'perItemStatus' => true )
);
$result = $this->getResult();
$data = $this->extractStatusInfo( $status );
$data['target'] = $targetObj->getFullText();
$data['items'] = array();
foreach ( $status->itemStatuses as $id => $s ) {
$data['items'][$id] = $this->extractStatusInfo( $s );
$data['items'][$id]['id'] = $id;
}
$list->reloadFromMaster();
// @codingStandardsIgnoreStart Avoid function calls in a FOR loop test part
for ( $item = $list->reset(); $list->current(); $item = $list->next() ) {
$data['items'][$item->getId()] += $item->getApiData( $this->getResult() );
}
// @codingStandardsIgnoreEnd
$data['items'] = array_values( $data['items'] );
$result->setIndexedTagName( $data['items'], 'i' );
$result->addValue( null, $this->getModuleName(), $data );
}
private function extractStatusInfo( $status ) {
$ret = array(
'status' => $status->isOK() ? 'Success' : 'Fail',
);
$errors = $this->formatStatusMessages( $status->getErrorsByType( 'error' ) );
if ( $errors ) {
$this->getResult()->setIndexedTagName( $errors, 'e' );
$ret['errors'] = $errors;
}
$warnings = $this->formatStatusMessages( $status->getErrorsByType( 'warning' ) );
if ( $warnings ) {
$this->getResult()->setIndexedTagName( $warnings, 'w' );
$ret['warnings'] = $warnings;
}
return $ret;
}
private function formatStatusMessages( $messages ) {
if ( !$messages ) {
return array();
}
$result = $this->getResult();
$ret = array();
foreach ( $messages as $m ) {
$message = array();
if ( $m['message'] instanceof Message ) {
$msg = $m['message'];
$message = array( 'message' => $msg->getKey() );
if ( $msg->getParams() ) {
$message['params'] = $msg->getParams();
$result->setIndexedTagName( $message['params'], 'p' );
}
} else {
$message = array( 'message' => $m['message'] );
$msg = wfMessage( $m['message'] );
if ( isset( $m['params'] ) ) {
$message['params'] = $m['params'];
$result->setIndexedTagName( $message['params'], 'p' );
$msg->params( $m['params'] );
}
}
$message['rendered'] = $msg->useDatabase( false )->inLanguage( 'en' )->plain();
$ret[] = $message;
}
return $ret;
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return array(
'type' => array(
ApiBase::PARAM_TYPE => RevisionDeleter::getTypes(),
ApiBase::PARAM_REQUIRED => true
),
'target' => null,
'ids' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_REQUIRED => true
),
'hide' => array(
ApiBase::PARAM_TYPE => array( 'content', 'comment', 'user' ),
ApiBase::PARAM_ISMULTI => true,
),
'show' => array(
ApiBase::PARAM_TYPE => array( 'content', 'comment', 'user' ),
ApiBase::PARAM_ISMULTI => true,
),
'suppress' => array(
ApiBase::PARAM_TYPE => array( 'yes', 'no', 'nochange' ),
ApiBase::PARAM_DFLT => 'nochange',
),
'reason' => null,
);
}
public function getParamDescription() {
return array(
'type' => 'Type of revision deletion being performed',
'target' => 'Page title for the revision deletion, if required for the type',
'ids' => 'Identifiers for the revisions to be deleted',
'hide' => 'What to hide for each revision',
'show' => 'What to unhide for each revision',
'suppress' => 'Whether to suppress data from administrators as well as others',
'reason' => 'Reason for the deletion/undeletion',
);
}
public function getDescription() {
return 'Delete/undelete revisions.';
}
public function needsToken() {
return 'csrf';
}
public function getExamples() {
return array(
'api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&' .
'hide=content&token=123ABC'
=> 'Hide content for revision 12345 on the Main Page',
'api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&' .
'reason=BLP%20violation&token=123ABC'
=> 'Hide all data on log entry 67890 with the reason "BLP violation"',
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Revisiondelete';
}
}
|
