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
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( "ApiBase.php" );
33 * API module that facilitates deleting pages. The API equivalent of action=delete.
34 * Requires API write mode to be enabled.
38 class ApiDelete
extends ApiBase
{
40 public function __construct( $main, $action ) {
41 parent
::__construct( $main, $action );
45 * Extracts the title, token, and reason from the request parameters and invokes
46 * the local delete() function with these as arguments. It does not make use of
47 * the delete function specified by Article.php. If the deletion succeeds, the
48 * details of the article deleted and the reason for deletion are added to the
51 public function execute() {
52 $params = $this->extractRequestParams();
54 $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
56 if ( isset( $params['title'] ) ) {
57 $titleObj = Title
::newFromText( $params['title'] );
59 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
61 } elseif ( isset( $params['pageid'] ) ) {
62 $titleObj = Title
::newFromID( $params['pageid'] );
64 $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
67 if ( !$titleObj->exists() ) {
68 $this->dieUsageMsg( array( 'notanarticle' ) );
71 $reason = ( isset( $params['reason'] ) ?
$params['reason'] : null );
72 if ( $titleObj->getNamespace() == NS_FILE
) {
73 $retval = self
::deleteFile( $params['token'], $titleObj, $params['oldimage'], $reason, false );
74 if ( count( $retval ) ) {
75 $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
78 $articleObj = new Article( $titleObj );
79 $retval = self
::delete( $articleObj, $params['token'], $reason );
81 if ( count( $retval ) ) {
82 $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
85 // Deprecated parameters
86 if ( $params['watch'] ) {
88 } elseif ( $params['unwatch'] ) {
91 $watch = $params['watchlist'];
93 $this->setWatch( $watch, $titleObj, 'watchdeletion' );
96 $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
97 $this->getResult()->addValue( null, $this->getModuleName(), $r );
102 * @param &$title Title
103 * @param $token String
105 private static function getPermissionsError( &$title, $token ) {
109 $errors = $title->getUserPermissionsErrors( 'delete', $wgUser );
110 if ( count( $errors ) > 0 ) {
118 * We have our own delete() function, since Article.php's implementation is split in two phases
120 * @param $article Article object to work on
121 * @param $token String: delete token (same as edit token)
122 * @param $reason String: reason for the deletion. Autogenerated if NULL
123 * @return Title::getUserPermissionsErrors()-like array
125 public static function delete( &$article, $token, &$reason = null ) {
126 $title = $article->getTitle();
127 $errors = self
::getPermissionsError( $title, $token );
128 if ( count( $errors ) ) {
132 // Auto-generate a summary, if necessary
133 if ( is_null( $reason ) ) {
134 $reason = DeleteAction
::getAutoReason( $article );
135 if ( $reason === false ) {
136 return array( array( 'cannotdelete' ) );
140 $action = Action
::factory( 'delete', $article );
143 'Suppress' => false, // The thought of people doing this through the API is scary...
147 $action->execute( $data, false );
149 catch ( ErrorPageError
$e ){
150 if( $e->msg
== 'delete-toobig' ){
151 global $wgDeleteRevisionsLimit;
152 return array( array( 'delete-toobig', $wgDeleteRevisionsLimit ) );
154 array( array( 'cannotdelete', $article->mTitle
->getPrefixedText() ) );
162 * @param $title Title
165 * @param $suppress bool
166 * @return \type|array|Title
168 public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
169 $errors = self
::getPermissionsError( $title, $token );
170 if ( count( $errors ) ) {
174 if ( $oldimage && !FileDeleteForm
::isValidOldSpec( $oldimage ) ) {
175 return array( array( 'invalidoldimage' ) );
178 $file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
182 $oldfile = RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
185 if ( !FileDeleteForm
::haveDeletableFile( $file, $oldfile, $oldimage ) ) {
186 return self
::delete( new Article( $title ), $token, $reason );
188 if ( is_null( $reason ) ) { // Log and RC don't like null reasons
191 $status = FileDeleteForm
::doDelete( $title, $file, $oldimage, $reason, $suppress );
193 if ( !$status->isGood() ) {
194 return array( array( 'cannotdelete', $title->getPrefixedText() ) );
200 public function mustBePosted() {
204 public function isWriteMode() {
208 public function getAllowedParams() {
212 ApiBase
::PARAM_TYPE
=> 'integer'
217 ApiBase
::PARAM_DFLT
=> false,
218 ApiBase
::PARAM_DEPRECATED
=> true,
220 'watchlist' => array(
221 ApiBase
::PARAM_DFLT
=> 'preferences',
222 ApiBase
::PARAM_TYPE
=> array(
230 ApiBase
::PARAM_DFLT
=> false,
231 ApiBase
::PARAM_DEPRECATED
=> true,
237 public function getParamDescription() {
238 $p = $this->getModulePrefix();
240 'title' => "Title of the page you want to delete. Cannot be used together with {$p}pageid",
241 'pageid' => "Page ID of the page you want to delete. Cannot be used together with {$p}title",
242 'token' => 'A delete token previously retrieved through prop=info',
243 'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used',
244 'watch' => 'Add the page to your watchlist',
245 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
246 'unwatch' => 'Remove the page from your watchlist',
247 'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
251 public function getDescription() {
252 return 'Delete a page';
255 public function getPossibleErrors() {
256 return array_merge( parent
::getPossibleErrors(),
257 $this->getRequireOnlyOneParameterErrorMessages( array( 'title', 'pageid' ) ),
259 array( 'invalidtitle', 'title' ),
260 array( 'nosuchpageid', 'pageid' ),
261 array( 'notanarticle' ),
262 array( 'hookaborted', 'error' ),
267 public function needsToken() {
271 public function getTokenSalt() {
275 protected function getExamples() {
277 'api.php?action=delete&title=Main%20Page&token=123ABC',
278 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
282 public function getVersion() {
283 return __CLASS__
. ': $Id$';