Fix the last assignment in conditional, bit of code duplication, as the next isn...

[lhc/web/wiklou.git] / includes / api / ApiDelete.php

diff --git a/includes/api/ApiDelete.php b/includes/api/ApiDelete.php
index df16682..0eba219 100644 (file)
--- a/includes/api/ApiDelete.php
+++ b/includes/api/ApiDelete.php
@@ -1,10 +1,10 @@
 <?php
-
 /**
+ *
+ *
  * Created on Jun 30, 2007
- * API for MediaWiki 1.8+
  *
- * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,8 +18,10 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -28,7 +30,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 }
 
 /**
- * API module that facilitates deleting pages. The API eqivalent of action=delete.
+ * API module that facilitates deleting pages. The API equivalent of action=delete.
  * Requires API write mode to be enabled.
  *
  * @ingroup API
@@ -47,8 +49,6 @@ class ApiDelete extends ApiBase {
         * result object.
         */
        public function execute() {
-               global $wgUser;
-
                $params = $this->extractRequestParams();
 
                $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
@@ -81,29 +81,27 @@ class ApiDelete extends ApiBase {
                        if ( count( $retval ) ) {
                                $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
                        }
-                       
-                       $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj ) || $wgUser->getOption( 'watchdeletion' );
 
                        // Deprecated parameters
                        if ( $params['watch'] ) {
-                               $watch = true;
+                               $watch = 'watch';
                        } elseif ( $params['unwatch'] ) {
-                               $watch = false;
-                       }
-                       
-                       if ( $watch !== null ) {
-                               if ( $watch ) {
-                                       $articleObj->doWatch();
-                               } else {
-                                       $articleObj->doUnwatch();
-                               }
+                               $watch = 'unwatch';
+                       } else {
+                               $watch = $params['watchlist'];
                        }
+                       $this->setWatch( $watch, $titleObj, 'watchdeletion' );
                }
 
                $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
                $this->getResult()->addValue( null, $this->getModuleName(), $r );
        }
 
+       /**
+        *
+        * @param &$title Title
+        * @param $token String
+        */
        private static function getPermissionsError( &$title, $token ) {
                global $wgUser;
 
@@ -148,18 +146,23 @@ class ApiDelete extends ApiBase {
                }
 
                $error = '';
-               if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, $error ) ) ) {
-                       $this->dieUsageMsg( array( 'hookaborted', $error ) );
-               }
-
                // Luckily, Article.php provides a reusable delete function that does the hard work for us
-               if ( $article->doDeleteArticle( $reason ) ) {
-                       wfRunHooks( 'ArticleDeleteComplete', array( &$article, &$wgUser, $reason, $article->getId() ) );
+               if ( $article->doDeleteArticle( $reason, false, 0, true, $error ) ) {
                        return array();
+               } else {
+                       return array( array( 'cannotdelete', $article->mTitle->getPrefixedText() ) );
                }
-               return array( array( 'cannotdelete', $article->mTitle->getPrefixedText() ) );
        }
 
+       /**
+        * @static
+        * @param $token
+        * @param $title Title
+        * @param $oldimage
+        * @param $reason
+        * @param $suppress bool
+        * @return \type|array|Title
+        */
        public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
                $errors = self::getPermissionsError( $title, $token );
                if ( count( $errors ) ) {
@@ -221,17 +224,21 @@ class ApiDelete extends ApiBase {
                                        'nochange'
                                ),
                        ),
-                       'unwatch' => false,
-                       'oldimage' => null
+                       'unwatch' => array(
+                               ApiBase::PARAM_DFLT => false,
+                               ApiBase::PARAM_DEPRECATED => true,
+                       ),
+                       'oldimage' => null,
                );
        }
 
        public function getParamDescription() {
+               $p = $this->getModulePrefix();
                return array(
-                       'title' => 'Title of the page you want to delete. Cannot be used together with pageid',
-                       'pageid' => 'Page ID of the page you want to delete. Cannot be used together with title',
+                       'title' => "Title of the page you want to delete. Cannot be used together with {$p}pageid",
+                       'pageid' => "Page ID of the page you want to delete. Cannot be used together with {$p}title",
                        'token' => 'A delete token previously retrieved through prop=info',
-                       'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used.',
+                       'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used',
                        'watch' => 'Add the page to your watchlist',
                        'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
                        'unwatch' => 'Remove the page from your watchlist',
@@ -240,18 +247,23 @@ class ApiDelete extends ApiBase {
        }
 
        public function getDescription() {
-               return array(
-                       'Delete a page.'
-               );
+               return 'Delete a page';
        }
 
        public function getPossibleErrors() {
-               return array_merge( parent::getPossibleErrors(), array(
-                       array( 'invalidtitle', 'title' ),
-                       array( 'nosuchpageid', 'pageid' ),
-                       array( 'notanarticle' ),
-                       array( 'hookaborted', 'error' ),
-               ) );
+               return array_merge( parent::getPossibleErrors(),
+                       $this->getRequireOnlyOneParameterErrorMessages( array( 'title', 'pageid' ) ),
+                       array(
+                               array( 'invalidtitle', 'title' ),
+                               array( 'nosuchpageid', 'pageid' ),
+                               array( 'notanarticle' ),
+                               array( 'hookaborted', 'error' ),
+                       )
+               );
+       }
+
+       public function needsToken() {
+               return true;
        }
 
        public function getTokenSalt() {
@@ -268,4 +280,4 @@ class ApiDelete extends ApiBase {
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
\ No newline at end of file
+}