5 * Created on Jun 30, 2007
7 * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * API module that facilitates deleting pages. The API equivalent of action=delete.
29 * Requires API write mode to be enabled.
33 class ApiDelete
extends ApiBase
{
35 public function __construct( $main, $action ) {
36 parent
::__construct( $main, $action );
40 * Extracts the title, token, and reason from the request parameters and invokes
41 * the local delete() function with these as arguments. It does not make use of
42 * the delete function specified by Article.php. If the deletion succeeds, the
43 * details of the article deleted and the reason for deletion are added to the
46 public function execute() {
47 $params = $this->extractRequestParams();
49 $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
51 if ( isset( $params['title'] ) ) {
52 $titleObj = Title
::newFromText( $params['title'] );
54 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
56 } elseif ( isset( $params['pageid'] ) ) {
57 $titleObj = Title
::newFromID( $params['pageid'] );
59 $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
62 if ( !$titleObj->exists() ) {
63 $this->dieUsageMsg( 'notanarticle' );
66 $reason = ( isset( $params['reason'] ) ?
$params['reason'] : null );
67 if ( $titleObj->getNamespace() == NS_FILE
) {
68 $retval = self
::deleteFile( $params['token'], $titleObj, $params['oldimage'], $reason, false );
69 if ( count( $retval ) ) {
70 $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
73 $articleObj = new Article( $titleObj );
74 $retval = self
::delete( $articleObj, $params['token'], $reason );
76 if ( count( $retval ) ) {
77 $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
80 // Deprecated parameters
81 if ( $params['watch'] ) {
83 } elseif ( $params['unwatch'] ) {
86 $watch = $params['watchlist'];
88 $this->setWatch( $watch, $titleObj, 'watchdeletion' );
91 $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
92 $this->getResult()->addValue( null, $this->getModuleName(), $r );
97 * @param $token String
100 private static function getPermissionsError( &$title, $token ) {
104 return $title->getUserPermissionsErrors( 'delete', $wgUser );
108 * We have our own delete() function, since Article.php's implementation is split in two phases
110 * @param $article Article object to work on
111 * @param $token String: delete token (same as edit token)
112 * @param $reason String: reason for the deletion. Autogenerated if NULL
113 * @return Title::getUserPermissionsErrors()-like array
115 public static function delete( &$article, $token, &$reason = null ) {
117 if ( $article->isBigDeletion() && !$wgUser->isAllowed( 'bigdelete' ) ) {
118 global $wgDeleteRevisionsLimit;
119 return array( array( 'delete-toobig', $wgDeleteRevisionsLimit ) );
121 $title = $article->getTitle();
122 $errors = self
::getPermissionsError( $title, $token );
123 if ( count( $errors ) ) {
127 // Auto-generate a summary, if necessary
128 if ( is_null( $reason ) ) {
129 // Need to pass a throwaway variable because generateReason expects
132 $reason = $article->generateReason( $hasHistory );
133 if ( $reason === false ) {
134 return array( array( 'cannotdelete' ) );
139 // Luckily, Article.php provides a reusable delete function that does the hard work for us
140 if ( $article->doDeleteArticle( $reason, false, 0, true, $error ) ) {
143 return array( array( 'cannotdelete', $article->getTitle()->getPrefixedText() ) );
149 * @param $title Title
152 * @param $suppress bool
153 * @return \type|array|Title
155 public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
156 $errors = self
::getPermissionsError( $title, $token );
157 if ( count( $errors ) ) {
161 if ( $oldimage && !FileDeleteForm
::isValidOldSpec( $oldimage ) ) {
162 return array( array( 'invalidoldimage' ) );
165 $file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
169 $oldfile = RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
172 if ( !FileDeleteForm
::haveDeletableFile( $file, $oldfile, $oldimage ) ) {
173 return self
::delete( new Article( $title ), $token, $reason );
175 if ( is_null( $reason ) ) { // Log and RC don't like null reasons
178 $status = FileDeleteForm
::doDelete( $title, $file, $oldimage, $reason, $suppress );
180 if ( !$status->isGood() ) {
181 return array( array( 'cannotdelete', $title->getPrefixedText() ) );
187 public function mustBePosted() {
191 public function isWriteMode() {
195 public function getAllowedParams() {
199 ApiBase
::PARAM_TYPE
=> 'integer'
204 ApiBase
::PARAM_DFLT
=> false,
205 ApiBase
::PARAM_DEPRECATED
=> true,
207 'watchlist' => array(
208 ApiBase
::PARAM_DFLT
=> 'preferences',
209 ApiBase
::PARAM_TYPE
=> array(
217 ApiBase
::PARAM_DFLT
=> false,
218 ApiBase
::PARAM_DEPRECATED
=> true,
224 public function getParamDescription() {
225 $p = $this->getModulePrefix();
227 'title' => "Title of the page you want to delete. Cannot be used together with {$p}pageid",
228 'pageid' => "Page ID of the page you want to delete. Cannot be used together with {$p}title",
229 'token' => 'A delete token previously retrieved through prop=info',
230 'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used',
231 'watch' => 'Add the page to your watchlist',
232 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
233 'unwatch' => 'Remove the page from your watchlist',
234 'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
238 public function getDescription() {
239 return 'Delete a page';
242 public function getPossibleErrors() {
243 return array_merge( parent
::getPossibleErrors(),
244 $this->getRequireOnlyOneParameterErrorMessages( array( 'title', 'pageid' ) ),
246 array( 'invalidtitle', 'title' ),
247 array( 'nosuchpageid', 'pageid' ),
248 array( 'notanarticle' ),
249 array( 'hookaborted', 'error' ),
254 public function needsToken() {
258 public function getTokenSalt() {
262 public function getExamples() {
264 'api.php?action=delete&title=Main%20Page&token=123ABC',
265 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
269 public function getHelpUrls() {
270 return 'http://www.mediawiki.org/wiki/API:Delete';
273 public function getVersion() {
274 return __CLASS__
. ': $Id$';