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