includes/api/ApiDelete.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Jun 30, 2007
   6  *
   7  * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
   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  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * API module that facilitates deleting pages. The API equivalent of action=delete.
  29  * Requires API write mode to be enabled.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiDelete extends ApiBase {
  34
  35         public function __construct( $main, $action ) {
  36                 parent::__construct( $main, $action );
  37         }
  38
  39         /**
  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
  44          * result object.
  45          */
  46         public function execute() {
  47                 $params = $this->extractRequestParams();
  48
  49                 $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
  50                 if ( !$pageObj->exists() ) {
  51                         $this->dieUsageMsg( 'notanarticle' );
  52                 }
  53
  54                 $titleObj = $pageObj->getTitle();
  55                 $reason = ( isset( $params['reason'] ) ? $params['reason'] : null );
  56                 $user = $this->getUser();
  57
  58                 if ( $titleObj->getNamespace() == NS_FILE ) {
  59                         $retval = self::deleteFile( $pageObj, $user, $params['token'], $params['oldimage'], $reason, false );
  60                 } else {
  61                         $retval = self::delete( $pageObj, $user, $params['token'], $reason );
  62                 }
  63
  64                 if ( count( $retval ) ) {
  65                         $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
  66                 }
  67
  68                 // Deprecated parameters
  69                 if ( $params['watch'] ) {
  70                         $watch = 'watch';
  71                 } elseif ( $params['unwatch'] ) {
  72                         $watch = 'unwatch';
  73                 } else {
  74                         $watch = $params['watchlist'];
  75                 }
  76                 $this->setWatch( $watch, $titleObj, 'watchdeletion' );
  77
  78                 $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
  79                 $this->getResult()->addValue( null, $this->getModuleName(), $r );
  80         }
  81
  82         /**
  83          * @param $title Title
  84          * @param $user User doing the action
  85          * @param $token String
  86          * @return array
  87          */
  88         private static function getPermissionsError( $title, $user, $token ) {
  89                 // Check permissions
  90                 return $title->getUserPermissionsErrors( 'delete', $user );
  91         }
  92
  93         /**
  94          * We have our own delete() function, since Article.php's implementation is split in two phases
  95          *
  96          * @param $page WikiPage object to work on
  97          * @param $user User doing the action
  98          * @param $token String: delete token (same as edit token)
  99          * @param $reason String: reason for the deletion. Autogenerated if NULL
 100          * @return Title::getUserPermissionsErrors()-like array
 101          */
 102         public static function delete( Page $page, User $user, $token, &$reason = null ) {
 103                 $title = $page->getTitle();
 104                 $errors = self::getPermissionsError( $title, $user, $token );
 105                 if ( count( $errors ) ) {
 106                         return $errors;
 107                 }
 108
 109                 // Auto-generate a summary, if necessary
 110                 if ( is_null( $reason ) ) {
 111                         // Need to pass a throwaway variable because generateReason expects
 112                         // a reference
 113                         $hasHistory = false;
 114                         $reason = $page->getAutoDeleteReason( $hasHistory ); #FIXME: use ContentHandler::getAutoDeleteReason()
 115                         if ( $reason === false ) {
 116                                 return array( array( 'cannotdelete', $title->getPrefixedText() ) );
 117                         }
 118                 }
 119
 120                 $error = '';
 121                 // Luckily, Article.php provides a reusable delete function that does the hard work for us
 122                 if ( $page->doDeleteArticle( $reason, false, 0, true, $error ) ) {
 123                         return array();
 124                 } else {
 125                         return array( array( 'cannotdelete', $title->getPrefixedText() ) );
 126                 }
 127         }
 128
 129         /**
 130          * @param $page WikiPage object to work on
 131          * @param $user User doing the action
 132          * @param $token
 133          * @param $oldimage
 134          * @param $reason
 135          * @param $suppress bool
 136          * @return array|Title
 137          */
 138         public static function deleteFile( Page $page, User $user, $token, $oldimage, &$reason = null, $suppress = false ) {
 139                 $title = $page->getTitle();
 140                 $errors = self::getPermissionsError( $title, $user, $token );
 141                 if ( count( $errors ) ) {
 142                         return $errors;
 143                 }
 144
 145                 $file = $page->getFile();
 146                 if ( !$file->exists() || !$file->isLocal() || $file->getRedirected() ) {
 147                         return self::delete( $page, $user, $token, $reason );
 148                 }
 149
 150                 if ( $oldimage ) {
 151                         if ( !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
 152                                 return array( array( 'invalidoldimage' ) );
 153                         }
 154                         $oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
 155                         if ( !$oldfile->exists() || !$oldfile->isLocal() || $oldfile->getRedirected() ) {
 156                                 return array( array( 'nodeleteablefile' ) );
 157                         }
 158                 } else {
 159                         $oldfile = false;
 160                 }
 161
 162                 if ( is_null( $reason ) ) { // Log and RC don't like null reasons
 163                         $reason = '';
 164                 }
 165                 $status = FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress );
 166                 if ( !$status->isGood() ) {
 167                         return array( array( 'cannotdelete', $title->getPrefixedText() ) );
 168                 }
 169
 170                 return array();
 171         }
 172
 173         public function mustBePosted() {
 174                 return true;
 175         }
 176
 177         public function isWriteMode() {
 178                 return true;
 179         }
 180
 181         public function getAllowedParams() {
 182                 return array(
 183                         'title' => null,
 184                         'pageid' => array(
 185                                 ApiBase::PARAM_TYPE => 'integer'
 186                         ),
 187                         'token' => null,
 188                         'reason' => null,
 189                         'watch' => array(
 190                                 ApiBase::PARAM_DFLT => false,
 191                                 ApiBase::PARAM_DEPRECATED => true,
 192                         ),
 193                         'watchlist' => array(
 194                                 ApiBase::PARAM_DFLT => 'preferences',
 195                                 ApiBase::PARAM_TYPE => array(
 196                                         'watch',
 197                                         'unwatch',
 198                                         'preferences',
 199                                         'nochange'
 200                                 ),
 201                         ),
 202                         'unwatch' => array(
 203                                 ApiBase::PARAM_DFLT => false,
 204                                 ApiBase::PARAM_DEPRECATED => true,
 205                         ),
 206                         'oldimage' => null,
 207                 );
 208         }
 209
 210         public function getParamDescription() {
 211                 $p = $this->getModulePrefix();
 212                 return array(
 213                         'title' => "Title of the page you want to delete. Cannot be used together with {$p}pageid",
 214                         'pageid' => "Page ID of the page you want to delete. Cannot be used together with {$p}title",
 215                         'token' => 'A delete token previously retrieved through prop=info',
 216                         'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used',
 217                         'watch' => 'Add the page to your watchlist',
 218                         'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
 219                         'unwatch' => 'Remove the page from your watchlist',
 220                         'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
 221                 );
 222         }
 223
 224         public function getDescription() {
 225                 return 'Delete a page';
 226         }
 227
 228         public function getPossibleErrors() {
 229                 return array_merge( parent::getPossibleErrors(),
 230                         $this->getTitleOrPageIdErrorMessage(),
 231                         array(
 232                                 array( 'notanarticle' ),
 233                                 array( 'hookaborted', 'error' ),
 234                                 array( 'delete-toobig', 'limit' ),
 235                                 array( 'cannotdelete', 'title' ),
 236                                 array( 'invalidoldimage' ),
 237                                 array( 'nodeleteablefile' ),
 238                         )
 239                 );
 240         }
 241
 242         public function needsToken() {
 243                 return true;
 244         }
 245
 246         public function getTokenSalt() {
 247                 return '';
 248         }
 249
 250         public function getExamples() {
 251                 return array(
 252                         'api.php?action=delete&title=Main%20Page&token=123ABC' => 'Delete the Main Page',
 253                         'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move' => 'Delete the Main Page with the reason "Preparing for move"',
 254                 );
 255         }
 256
 257         public function getHelpUrls() {
 258                 return 'https://www.mediawiki.org/wiki/API:Delete';
 259         }
 260
 261         public function getVersion() {
 262                 return __CLASS__ . ': $Id$';
 263         }
 264 }