4 * Created on Jun 30, 2007
5 * API for MediaWiki 1.8+
7 * Copyright (C) 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");
32 * API module that facilitates deleting pages. The API eqivalent of action=delete.
33 * Requires API write mode to be enabled.
37 class ApiDelete
extends ApiBase
{
39 public function __construct($main, $action) {
40 parent
:: __construct($main, $action);
44 * Extracts the title, token, and reason from the request parameters and invokes
45 * the local delete() function with these as arguments. It does not make use of
46 * the delete function specified by Article.php. If the deletion succeeds, the
47 * details of the article deleted and the reason for deletion are added to the
50 public function execute() {
52 $this->getMain()->requestWriteMode();
53 $params = $this->extractRequestParams();
56 if(!isset($params['title']))
57 $this->dieUsageMsg(array('missingparam', 'title'));
58 if(!isset($params['token']))
59 $this->dieUsageMsg(array('missingparam', 'token'));
61 $titleObj = Title
::newFromText($params['title']);
63 $this->dieUsageMsg(array('invalidtitle', $params['title']));
64 if(!$titleObj->exists())
65 $this->dieUsageMsg(array('notanarticle'));
67 $reason = (isset($params['reason']) ?
$params['reason'] : NULL);
68 if ($titleObj->getNamespace() == NS_IMAGE
) {
69 $retval = self
::deletefile($params['token'], $titleObj, $params['oldimage'], $reason, false);
71 // We don't care about multiple errors, just report one of them
72 $this->dieUsageMsg(current($retval));
74 $articleObj = new Article($titleObj);
75 $retval = self
::delete($articleObj, $params['token'], $reason);
78 // We don't care about multiple errors, just report one of them
79 $this->dieUsageMsg(current($retval));
81 if($params['watch'] ||
$wgUser->getOption('watchdeletion'))
82 $articleObj->doWatch();
83 else if($params['unwatch'])
84 $articleObj->doUnwatch();
87 $r = array('title' => $titleObj->getPrefixedText(), 'reason' => $reason);
88 $this->getResult()->addValue(null, $this->getModuleName(), $r);
91 private static function getPermissionsError(&$title, $token) {
93 // Check wiki readonly
94 if (wfReadOnly()) return array(array('readonlytext'));
97 $errors = $title->getUserPermissionsErrors('delete', $wgUser);
98 if (count($errors) > 0) return $errors;
101 if(!$wgUser->matchEditToken($token))
102 return array(array('sessionfailure'));
107 * We have our own delete() function, since Article.php's implementation is split in two phases
109 * @param Article $article - Article object to work on
110 * @param string $token - Delete token (same as edit token)
111 * @param string $reason - Reason for the deletion. Autogenerated if NULL
112 * @return Title::getUserPermissionsErrors()-like array
114 public static function delete(&$article, $token, &$reason = NULL)
116 $errors = self
::getPermissionsError($article->getTitle(), $token);
117 if (count($errors)) return $errors;
119 // Auto-generate a summary, if necessary
122 // $hasHistory = false;
123 $reason = $article->generateReason(false);
124 if($reason === false)
125 return array(array('cannotdelete'));
128 // Luckily, Article.php provides a reusable delete function that does the hard work for us
129 if($article->doDeleteArticle($reason))
131 return array(array('cannotdelete', $article->mTitle
->getPrefixedText()));
134 public static function deleteFile($token, &$title, $oldimage, &$reason = NULL, $suppress = false)
136 $errors = self
::getPermissionsError($title, $token);
137 if (count($errors)) return $errors;
139 if( $oldimage && !FileDeleteForm
::isValidOldSpec($oldimage) )
140 return array(array('invalidoldimage'));
142 $file = wfFindFile($title);
146 $oldfile = RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
148 if( !FileDeleteForm
::haveDeletableFile($file, $oldfile, $oldimage) )
149 return array(array('nofile'));
151 $status = FileDeleteForm
::doDelete( $title, $file, $oldimage, $reason, $suppress );
153 if( !$status->isGood() )
154 return array(array('cannotdelete', $title->getPrefixedText()));
159 public function mustBePosted() { return true; }
161 public function getAllowedParams() {
172 public function getParamDescription() {
174 'title' => 'Title of the page you want to delete.',
175 'token' => 'A delete token previously retrieved through prop=info',
176 'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used.',
177 'watch' => 'Add the page to your watchlist',
178 'unwatch' => 'Remove the page from your watchlist',
179 'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
183 public function getDescription() {
185 'Deletes a page. You need to be logged in as a sysop to use this function, see also action=login.'
189 protected function getExamples() {
191 'api.php?action=delete&title=Main%20Page&token=123ABC',
192 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
196 public function getVersion() {
197 return __CLASS__
. ': $Id$';