includes/api/ApiDelete.php

   1 <?php
   2
   3 /*
   4  * Created on Jun 30, 2007
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  */
  24
  25 if (!defined('MEDIAWIKI')) {
  26         // Eclipse helper - will be ignored in production
  27         require_once ("ApiBase.php");
  28 }
  29
  30
  31 /**
  32  * API module that facilitates deleting pages. The API eqivalent of action=delete.
  33  * Requires API write mode to be enabled.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiDelete extends ApiBase {
  38
  39         public function __construct($main, $action) {
  40                 parent :: __construct($main, $action);
  41         }
  42
  43         /**
  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
  48          * result object.
  49          */
  50         public function execute() {
  51                 global $wgUser;
  52                 $this->getMain()->requestWriteMode();
  53                 $params = $this->extractRequestParams();
  54
  55                 $titleObj = NULL;
  56                 if(!isset($params['title']))
  57                         $this->dieUsageMsg(array('missingparam', 'title'));
  58                 if(!isset($params['token']))
  59                         $this->dieUsageMsg(array('missingparam', 'token'));
  60
  61                 $titleObj = Title::newFromText($params['title']);
  62                 if(!$titleObj)
  63                         $this->dieUsageMsg(array('invalidtitle', $params['title']));
  64                 if(!$titleObj->exists())
  65                         $this->dieUsageMsg(array('notanarticle'));
  66
  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);
  70                         if(!empty($retval))
  71                                 // We don't care about multiple errors, just report one of them
  72                                 $this->dieUsageMsg(current($retval));
  73                 } else {
  74                         $articleObj = new Article($titleObj);
  75                         $retval = self::delete($articleObj, $params['token'], $reason);
  76
  77                         if(!empty($retval))
  78                                 // We don't care about multiple errors, just report one of them
  79                                 $this->dieUsageMsg(current($retval));
  80
  81                         if($params['watch'] || $wgUser->getOption('watchdeletion'))
  82                                 $articleObj->doWatch();
  83                         else if($params['unwatch'])
  84                                 $articleObj->doUnwatch();
  85                 }
  86
  87                 $r = array('title' => $titleObj->getPrefixedText(), 'reason' => $reason);
  88                 $this->getResult()->addValue(null, $this->getModuleName(), $r);
  89         }
  90
  91         private static function getPermissionsError(&$title, $token) {
  92                 global $wgUser;
  93                 // Check wiki readonly
  94                 if (wfReadOnly()) return array(array('readonlytext'));
  95
  96                 // Check permissions
  97                 $errors = $title->getUserPermissionsErrors('delete', $wgUser);
  98                 if (count($errors) > 0) return $errors;
  99
 100                 // Check token
 101                 if(!$wgUser->matchEditToken($token))
 102                         return array(array('sessionfailure'));
 103                 return array();
 104         }
 105
 106         /**
 107          * We have our own delete() function, since Article.php's implementation is split in two phases
 108          *
 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
 113          */
 114         public static function delete(&$article, $token, &$reason = NULL)
 115         {
 116                 global $wgUser;
 117
 118                 $errors = self::getPermissionsError($article->getTitle(), $token);
 119                 if (count($errors)) return $errors;
 120
 121                 // Auto-generate a summary, if necessary
 122                 if(is_null($reason))
 123                 {
 124                         # Need to pass a throwaway variable because generateReason expects
 125                         # a reference
 126                         $hasHistory = false;
 127                         $reason = $article->generateReason($hasHistory);
 128                         if($reason === false)
 129                                 return array(array('cannotdelete'));
 130                 }
 131
 132                 if (!wfRunHooks('ArticleDelete', array(&$article, &$wgUser, &$reason)))
 133                         $this->dieUsageMsg(array('hookaborted'));
 134
 135                 // Luckily, Article.php provides a reusable delete function that does the hard work for us
 136                 if($article->doDeleteArticle($reason)) {
 137                         wfRunHooks('ArticleDeleteComplete', array(&$article, &$wgUser, $reason, $article->getId()));
 138                         return array();
 139                 }
 140                 return array(array('cannotdelete', $article->mTitle->getPrefixedText()));
 141         }
 142
 143         public static function deleteFile($token, &$title, $oldimage, &$reason = NULL, $suppress = false)
 144         {
 145                 $errors = self::getPermissionsError($title, $token);
 146                 if (count($errors)) return $errors;
 147
 148                 if( $oldimage && !FileDeleteForm::isValidOldSpec($oldimage) )
 149                         return array(array('invalidoldimage'));
 150
 151                 $file = wfFindFile($title, false, FileRepo::FIND_IGNORE_REDIRECT);
 152                 $oldfile = false;
 153
 154                 if( $oldimage )
 155                         $oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
 156
 157                 if( !FileDeleteForm::haveDeletableFile($file, $oldfile, $oldimage) )
 158                         return array(array('nofile'));
 159
 160                 $status = FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress );
 161
 162                 if( !$status->isGood() )
 163                         return array(array('cannotdelete', $title->getPrefixedText()));
 164
 165                 return array();
 166         }
 167
 168         public function mustBePosted() { return true; }
 169
 170         public function getAllowedParams() {
 171                 return array (
 172                         'title' => null,
 173                         'token' => null,
 174                         'reason' => null,
 175                         'watch' => false,
 176                         'unwatch' => false,
 177                         'oldimage' => null
 178                 );
 179         }
 180
 181         public function getParamDescription() {
 182                 return array (
 183                         'title' => 'Title of the page you want to delete.',
 184                         'token' => 'A delete token previously retrieved through prop=info',
 185                         'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used.',
 186                         'watch' => 'Add the page to your watchlist',
 187                         'unwatch' => 'Remove the page from your watchlist',
 188                         'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
 189                 );
 190         }
 191
 192         public function getDescription() {
 193                 return array(
 194                         'Deletes a page. You need to be logged in as a sysop to use this function, see also action=login.'
 195                 );
 196         }
 197
 198         protected function getExamples() {
 199                 return array (
 200                         'api.php?action=delete&title=Main%20Page&token=123ABC',
 201                         'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
 202                 );
 203         }
 204
 205         public function getVersion() {
 206                 return __CLASS__ . ': $Id$';
 207         }
 208 }