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                 $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
  50
  51                 if ( isset( $params['title'] ) ) {
  52                         $titleObj = Title::newFromText( $params['title'] );
  53                         if ( !$titleObj ) {
  54                                 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
  55                         }
  56                 } elseif ( isset( $params['pageid'] ) ) {
  57                         $titleObj = Title::newFromID( $params['pageid'] );
  58                         if ( !$titleObj ) {
  59                                 $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
  60                         }
  61                 }
  62                 if ( !$titleObj->exists() ) {
  63                         $this->dieUsageMsg( 'notanarticle' );
  64                 }
  65
  66                 $reason = ( isset( $params['reason'] ) ? $params['reason'] : null );
  67                 if ( $titleObj->getNamespace() == NS_FILE ) {
  68                         $retval = self::deleteFile( $params['token'], $titleObj, $params['oldimage'], $reason, false );
  69                         if ( count( $retval ) ) {
  70                                 $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
  71                         }
  72                 } else {
  73                         $articleObj = new Article( $titleObj );
  74                         $retval = self::delete( $articleObj, $params['token'], $reason );
  75
  76                         if ( count( $retval ) ) {
  77                                 $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
  78                         }
  79
  80                         // Deprecated parameters
  81                         if ( $params['watch'] ) {
  82                                 $watch = 'watch';
  83                         } elseif ( $params['unwatch'] ) {
  84                                 $watch = 'unwatch';
  85                         } else {
  86                                 $watch = $params['watchlist'];
  87                         }
  88                         $this->setWatch( $watch, $titleObj, 'watchdeletion' );
  89                 }
  90
  91                 $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
  92                 $this->getResult()->addValue( null, $this->getModuleName(), $r );
  93         }
  94
  95         /**
  96          * @param $title Title
  97          * @param $token String
  98          * @return array
  99          */
 100         private static function getPermissionsError( &$title, $token ) {
 101                 global $wgUser;
 102
 103                 // Check permissions
 104                 return $title->getUserPermissionsErrors( 'delete', $wgUser );
 105         }
 106
 107         /**
 108          * We have our own delete() function, since Article.php's implementation is split in two phases
 109          *
 110          * @param $article Article object to work on
 111          * @param $token String: delete token (same as edit token)
 112          * @param $reason String: reason for the deletion. Autogenerated if NULL
 113          * @return Title::getUserPermissionsErrors()-like array
 114          */
 115         public static function delete( &$article, $token, &$reason = null ) {
 116                 global $wgUser;
 117                 if ( $article->isBigDeletion() && !$wgUser->isAllowed( 'bigdelete' ) ) {
 118                         global $wgDeleteRevisionsLimit;
 119                         return array( array( 'delete-toobig', $wgDeleteRevisionsLimit ) );
 120                 }
 121                 $title = $article->getTitle();
 122                 $errors = self::getPermissionsError( $title, $token );
 123                 if ( count( $errors ) ) {
 124                         return $errors;
 125                 }
 126
 127                 // Auto-generate a summary, if necessary
 128                 if ( is_null( $reason ) ) {
 129                         // Need to pass a throwaway variable because generateReason expects
 130                         // a reference
 131                         $hasHistory = false;
 132                         $reason = $article->generateReason( $hasHistory );
 133                         if ( $reason === false ) {
 134                                 return array( array( 'cannotdelete' ) );
 135                         }
 136                 }
 137
 138                 $error = '';
 139                 // Luckily, Article.php provides a reusable delete function that does the hard work for us
 140                 if ( $article->doDeleteArticle( $reason, false, 0, true, $error ) ) {
 141                         return array();
 142                 } else {
 143                         return array( array( 'cannotdelete', $article->getTitle()->getPrefixedText() ) );
 144                 }
 145         }
 146
 147         /**
 148          * @param $token
 149          * @param $title Title
 150          * @param $oldimage
 151          * @param $reason
 152          * @param $suppress bool
 153          * @return \type|array|Title
 154          */
 155         public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
 156                 $errors = self::getPermissionsError( $title, $token );
 157                 if ( count( $errors ) ) {
 158                         return $errors;
 159                 }
 160
 161                 if ( $oldimage && !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
 162                         return array( array( 'invalidoldimage' ) );
 163                 }
 164
 165                 $file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
 166                 $oldfile = false;
 167
 168                 if ( $oldimage ) {
 169                         $oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
 170                 }
 171
 172                 if ( !FileDeleteForm::haveDeletableFile( $file, $oldfile, $oldimage ) ) {
 173                         return self::delete( new Article( $title ), $token, $reason );
 174                 }
 175                 if ( is_null( $reason ) ) { // Log and RC don't like null reasons
 176                         $reason = '';
 177                 }
 178                 $status = FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress );
 179
 180                 if ( !$status->isGood() ) {
 181                         return array( array( 'cannotdelete', $title->getPrefixedText() ) );
 182                 }
 183
 184                 return array();
 185         }
 186
 187         public function mustBePosted() {
 188                 return true;
 189         }
 190
 191         public function isWriteMode() {
 192                 return true;
 193         }
 194
 195         public function getAllowedParams() {
 196                 return array(
 197                         'title' => null,
 198                         'pageid' => array(
 199                                 ApiBase::PARAM_TYPE => 'integer'
 200                         ),
 201                         'token' => null,
 202                         'reason' => null,
 203                         'watch' => array(
 204                                 ApiBase::PARAM_DFLT => false,
 205                                 ApiBase::PARAM_DEPRECATED => true,
 206                         ),
 207                         'watchlist' => array(
 208                                 ApiBase::PARAM_DFLT => 'preferences',
 209                                 ApiBase::PARAM_TYPE => array(
 210                                         'watch',
 211                                         'unwatch',
 212                                         'preferences',
 213                                         'nochange'
 214                                 ),
 215                         ),
 216                         'unwatch' => array(
 217                                 ApiBase::PARAM_DFLT => false,
 218                                 ApiBase::PARAM_DEPRECATED => true,
 219                         ),
 220                         'oldimage' => null,
 221                 );
 222         }
 223
 224         public function getParamDescription() {
 225                 $p = $this->getModulePrefix();
 226                 return array(
 227                         'title' => "Title of the page you want to delete. Cannot be used together with {$p}pageid",
 228                         'pageid' => "Page ID of the page you want to delete. Cannot be used together with {$p}title",
 229                         'token' => 'A delete token previously retrieved through prop=info',
 230                         'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used',
 231                         'watch' => 'Add the page to your watchlist',
 232                         'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
 233                         'unwatch' => 'Remove the page from your watchlist',
 234                         'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
 235                 );
 236         }
 237
 238         public function getDescription() {
 239                 return 'Delete a page';
 240         }
 241
 242         public function getPossibleErrors() {
 243                 return array_merge( parent::getPossibleErrors(),
 244                         $this->getRequireOnlyOneParameterErrorMessages( array( 'title', 'pageid' ) ),
 245                         array(
 246                                 array( 'invalidtitle', 'title' ),
 247                                 array( 'nosuchpageid', 'pageid' ),
 248                                 array( 'notanarticle' ),
 249                                 array( 'hookaborted', 'error' ),
 250                         )
 251                 );
 252         }
 253
 254         public function needsToken() {
 255                 return true;
 256         }
 257
 258         public function getTokenSalt() {
 259                 return '';
 260         }
 261
 262         public function getExamples() {
 263                 return array(
 264                         'api.php?action=delete&title=Main%20Page&token=123ABC',
 265                         'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
 266                 );
 267         }
 268
 269         public function getHelpUrls() {
 270                 return 'http://www.mediawiki.org/wiki/API:Delete';
 271         }
 272
 273         public function getVersion() {
 274                 return __CLASS__ . ': $Id$';
 275         }
 276 }