4 * Created on Jun 30, 2007
5 * API for MediaWiki 1.8+
7 * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 * http://www.gnu.org/copyleft/gpl.html
25 if ( !defined( 'MEDIAWIKI' ) ) {
26 // Eclipse helper - will be ignored in production
27 require_once( "ApiBase.php" );
31 * API module that facilitates deleting pages. The API eqivalent of action=delete.
32 * Requires API write mode to be enabled.
36 class ApiDelete
extends ApiBase
{
38 public function __construct( $main, $action ) {
39 parent
::__construct( $main, $action );
43 * Extracts the title, token, and reason from the request parameters and invokes
44 * the local delete() function with these as arguments. It does not make use of
45 * the delete function specified by Article.php. If the deletion succeeds, the
46 * details of the article deleted and the reason for deletion are added to the
49 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 $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj ) ||
$wgUser->getOption( 'watchdeletion' );
87 // Deprecated parameters
88 if ( $params['watch'] ) {
90 } elseif ( $params['unwatch'] ) {
94 if ( $watch !== null ) {
96 $articleObj->doWatch();
98 $articleObj->doUnwatch();
103 $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
104 $this->getResult()->addValue( null, $this->getModuleName(), $r );
107 private static function getPermissionsError( &$title, $token ) {
111 $errors = $title->getUserPermissionsErrors( 'delete', $wgUser );
112 if ( count( $errors ) > 0 ) {
120 * We have our own delete() function, since Article.php's implementation is split in two phases
122 * @param $article Article object to work on
123 * @param $token String: delete token (same as edit token)
124 * @param $reason String: reason for the deletion. Autogenerated if NULL
125 * @return Title::getUserPermissionsErrors()-like array
127 public static function delete( &$article, $token, &$reason = null ) {
129 if ( $article->isBigDeletion() && !$wgUser->isAllowed( 'bigdelete' ) ) {
130 global $wgDeleteRevisionsLimit;
131 return array( array( 'delete-toobig', $wgDeleteRevisionsLimit ) );
133 $title = $article->getTitle();
134 $errors = self
::getPermissionsError( $title, $token );
135 if ( count( $errors ) ) {
139 // Auto-generate a summary, if necessary
140 if ( is_null( $reason ) ) {
141 // Need to pass a throwaway variable because generateReason expects
144 $reason = $article->generateReason( $hasHistory );
145 if ( $reason === false ) {
146 return array( array( 'cannotdelete' ) );
151 if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, $error ) ) ) {
152 $this->dieUsageMsg( array( 'hookaborted', $error ) );
155 // Luckily, Article.php provides a reusable delete function that does the hard work for us
156 if ( $article->doDeleteArticle( $reason ) ) {
157 wfRunHooks( 'ArticleDeleteComplete', array( &$article, &$wgUser, $reason, $article->getId() ) );
160 return array( array( 'cannotdelete', $article->mTitle
->getPrefixedText() ) );
163 public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
164 $errors = self
::getPermissionsError( $title, $token );
165 if ( count( $errors ) ) {
169 if ( $oldimage && !FileDeleteForm
::isValidOldSpec( $oldimage ) ) {
170 return array( array( 'invalidoldimage' ) );
173 $file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
177 $oldfile = RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
180 if ( !FileDeleteForm
::haveDeletableFile( $file, $oldfile, $oldimage ) ) {
181 return self
::delete( new Article( $title ), $token, $reason );
183 if ( is_null( $reason ) ) { // Log and RC don't like null reasons
186 $status = FileDeleteForm
::doDelete( $title, $file, $oldimage, $reason, $suppress );
188 if ( !$status->isGood() ) {
189 return array( array( 'cannotdelete', $title->getPrefixedText() ) );
195 public function mustBePosted() {
199 public function isWriteMode() {
203 public function getAllowedParams() {
207 ApiBase
::PARAM_TYPE
=> 'integer'
212 ApiBase
::PARAM_DFLT
=> false,
213 ApiBase
::PARAM_DEPRECATED
=> true,
215 'watchlist' => array(
216 ApiBase
::PARAM_DFLT
=> 'preferences',
217 ApiBase
::PARAM_TYPE
=> array(
229 public function getParamDescription() {
231 'title' => 'Title of the page you want to delete. Cannot be used together with pageid',
232 'pageid' => 'Page ID of the page you want to delete. Cannot be used together with title',
233 'token' => 'A delete token previously retrieved through prop=info',
234 'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used.',
235 'watch' => 'Add the page to your watchlist',
236 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
237 'unwatch' => 'Remove the page from your watchlist',
238 'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
242 public function getDescription() {
248 public function getPossibleErrors() {
249 return array_merge( parent
::getPossibleErrors(), array(
250 array( 'invalidtitle', 'title' ),
251 array( 'nosuchpageid', 'pageid' ),
252 array( 'notanarticle' ),
253 array( 'hookaborted', 'error' ),
257 public function getTokenSalt() {
261 protected function getExamples() {
263 'api.php?action=delete&title=Main%20Page&token=123ABC',
264 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
268 public function getVersion() {
269 return __CLASS__
. ': $Id$';