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
|
<?php
/**
*
*
* Created on Jun 30, 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
*/
/**
* API module that facilitates deleting pages. The API equivalent of action=delete.
* Requires API write mode to be enabled.
*
* @ingroup API
*/
class ApiDelete extends ApiBase {
/**
* Extracts the title, token, and reason from the request parameters and invokes
* the local delete() function with these as arguments. It does not make use of
* the delete function specified by Article.php. If the deletion succeeds, the
* details of the article deleted and the reason for deletion are added to the
* result object.
*/
public function execute() {
$params = $this->extractRequestParams();
$pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
if ( !$pageObj->exists() ) {
$this->dieUsageMsg( 'notanarticle' );
}
$titleObj = $pageObj->getTitle();
$reason = $params['reason'];
$user = $this->getUser();
if ( $titleObj->getNamespace() == NS_FILE ) {
$status = self::deleteFile(
$pageObj,
$user,
$params['token'],
$params['oldimage'],
$reason,
false
);
} else {
$status = self::delete( $pageObj, $user, $params['token'], $reason );
}
if ( is_array( $status ) ) {
$this->dieUsageMsg( $status[0] );
}
if ( !$status->isGood() ) {
$this->dieStatus( $status );
}
// Deprecated parameters
if ( $params['watch'] ) {
$this->logFeatureUsage( 'action=delete&watch' );
$watch = 'watch';
} elseif ( $params['unwatch'] ) {
$this->logFeatureUsage( 'action=delete&unwatch' );
$watch = 'unwatch';
} else {
$watch = $params['watchlist'];
}
$this->setWatch( $watch, $titleObj, 'watchdeletion' );
$r = array(
'title' => $titleObj->getPrefixedText(),
'reason' => $reason,
'logid' => $status->value
);
$this->getResult()->addValue( null, $this->getModuleName(), $r );
}
/**
* @param Title $title
* @param User $user User doing the action
* @param string $token
* @return array
*/
private static function getPermissionsError( $title, $user, $token ) {
// Check permissions
return $title->getUserPermissionsErrors( 'delete', $user );
}
/**
* We have our own delete() function, since Article.php's implementation is split in two phases
*
* @param Page|WikiPage $page Page or WikiPage object to work on
* @param User $user User doing the action
* @param string $token Delete token (same as edit token)
* @param string|null $reason Reason for the deletion. Autogenerated if null
* @return Status|array
*/
public static function delete( Page $page, User $user, $token, &$reason = null ) {
$title = $page->getTitle();
$errors = self::getPermissionsError( $title, $user, $token );
if ( count( $errors ) ) {
return $errors;
}
// Auto-generate a summary, if necessary
if ( is_null( $reason ) ) {
// Need to pass a throwaway variable because generateReason expects
// a reference
$hasHistory = false;
$reason = $page->getAutoDeleteReason( $hasHistory );
if ( $reason === false ) {
return array( array( 'cannotdelete', $title->getPrefixedText() ) );
}
}
$error = '';
// Luckily, Article.php provides a reusable delete function that does the hard work for us
return $page->doDeleteArticleReal( $reason, false, 0, true, $error );
}
/**
* @param Page $page Object to work on
* @param User $user User doing the action
* @param string $token Delete token (same as edit token)
* @param string $oldimage Archive name
* @param string $reason Reason for the deletion. Autogenerated if null.
* @param bool $suppress Whether to mark all deleted versions as restricted
* @return Status|array
*/
public static function deleteFile( Page $page, User $user, $token, $oldimage,
&$reason = null, $suppress = false
) {
$title = $page->getTitle();
$errors = self::getPermissionsError( $title, $user, $token );
if ( count( $errors ) ) {
return $errors;
}
$file = $page->getFile();
if ( !$file->exists() || !$file->isLocal() || $file->getRedirected() ) {
return self::delete( $page, $user, $token, $reason );
}
if ( $oldimage ) {
if ( !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
return array( array( 'invalidoldimage' ) );
}
$oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
if ( !$oldfile->exists() || !$oldfile->isLocal() || $oldfile->getRedirected() ) {
return array( array( 'nodeleteablefile' ) );
}
}
if ( is_null( $reason ) ) { // Log and RC don't like null reasons
$reason = '';
}
return FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress, $user );
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return array(
'title' => null,
'pageid' => array(
ApiBase::PARAM_TYPE => 'integer'
),
'reason' => null,
'watch' => array(
ApiBase::PARAM_DFLT => false,
ApiBase::PARAM_DEPRECATED => true,
),
'watchlist' => array(
ApiBase::PARAM_DFLT => 'preferences',
ApiBase::PARAM_TYPE => array(
'watch',
'unwatch',
'preferences',
'nochange'
),
),
'unwatch' => array(
ApiBase::PARAM_DFLT => false,
ApiBase::PARAM_DEPRECATED => true,
),
'oldimage' => null,
);
}
public function needsToken() {
return 'csrf';
}
protected function getExamplesMessages() {
return array(
'action=delete&title=Main%20Page&token=123ABC'
=> 'apihelp-delete-example-simple',
'action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
=> 'apihelp-delete-example-reason',
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Delete';
}
}
|
