API deletion module: trim trailing spaces, tweak coding style, change copyright symbo...
authorJack Phoenix <ashley@users.mediawiki.org>
Fri, 19 Feb 2010 12:54:09 +0000 (12:54 +0000)
committerJack Phoenix <ashley@users.mediawiki.org>
Fri, 19 Feb 2010 12:54:09 +0000 (12:54 +0000)
includes/api/ApiDelete.php

index dfff301..90e9aa1 100644 (file)
@@ -1,10 +1,10 @@
 <?php
 
-/*
+/**
  * Created on Jun 30, 2007
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
  *
  * 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
@@ -24,7 +24,7 @@
 
 if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ( "ApiBase.php" );
+       require_once( "ApiBase.php" );
 }
 
 /**
@@ -36,7 +36,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiDelete extends ApiBase {
 
        public function __construct( $main, $action ) {
-               parent :: __construct( $main, $action );
+               parent::__construct( $main, $action );
        }
 
        /**
@@ -47,43 +47,46 @@ class ApiDelete extends ApiBase {
         * result object.
         */
        public function execute() {
-       global $wgUser;
-       
+               global $wgUser;
+
                $params = $this->extractRequestParams();
 
                $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
 
-               if ( isset( $params['title'] ) )
-               {
+               if ( isset( $params['title'] ) ) {
                        $titleObj = Title::newFromText( $params['title'] );
-                       if ( !$titleObj )
+                       if ( !$titleObj ) {
                                $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
-               }
-               else if ( isset( $params['pageid'] ) )
-               {
+                       }
+               } elseif ( isset( $params['pageid'] ) ) {
                        $titleObj = Title::newFromID( $params['pageid'] );
-                       if ( !$titleObj )
+                       if ( !$titleObj ) {
                                $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
+                       }
                }
-               if ( !$titleObj->exists() )
+               if ( !$titleObj->exists() ) {
                        $this->dieUsageMsg( array( 'notanarticle' ) );
+               }
 
                $reason = ( isset( $params['reason'] ) ? $params['reason'] : null );
                if ( $titleObj->getNamespace() == NS_FILE ) {
                        $retval = self::deleteFile( $params['token'], $titleObj, $params['oldimage'], $reason, false );
-                       if ( count( $retval ) )
+                       if ( count( $retval ) ) {
                                $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
+                       }
                } else {
                        $articleObj = new Article( $titleObj );
                        $retval = self::delete( $articleObj, $params['token'], $reason );
-                       
-                       if ( count( $retval ) )
+
+                       if ( count( $retval ) ) {
                                $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
+                       }
 
-                       if ( $params['watch'] || $wgUser->getOption( 'watchdeletion' ) )
+                       if ( $params['watch'] || $wgUser->getOption( 'watchdeletion' ) ) {
                                $articleObj->doWatch();
-                       else if ( $params['unwatch'] )
+                       } elseif ( $params['unwatch'] ) {
                                $articleObj->doUnwatch();
+                       }
                }
 
                $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
@@ -92,10 +95,12 @@ class ApiDelete extends ApiBase {
 
        private static function getPermissionsError( &$title, $token ) {
                global $wgUser;
-               
+
                // Check permissions
                $errors = $title->getUserPermissionsErrors( 'delete', $wgUser );
-               if ( count( $errors ) > 0 ) return $errors;
+               if ( count( $errors ) > 0 ) {
+                       return $errors;
+               }
 
                return array();
        }
@@ -108,8 +113,7 @@ class ApiDelete extends ApiBase {
         * @param string $reason - Reason for the deletion. Autogenerated if NULL
         * @return Title::getUserPermissionsErrors()-like array
         */
-       public static function delete( &$article, $token, &$reason = null )
-       {
+       public static function delete( &$article, $token, &$reason = null ) {
                global $wgUser;
                if ( $article->isBigDeletion() && !$wgUser->isAllowed( 'bigdelete' ) ) {
                        global $wgDeleteRevisionsLimit;
@@ -117,22 +121,25 @@ class ApiDelete extends ApiBase {
                }
                $title = $article->getTitle();
                $errors = self::getPermissionsError( $title, $token );
-               if ( count( $errors ) ) return $errors;
+               if ( count( $errors ) ) {
+                       return $errors;
+               }
 
                // Auto-generate a summary, if necessary
-               if ( is_null( $reason ) )
-               {
+               if ( is_null( $reason ) ) {
                        // Need to pass a throwaway variable because generateReason expects
                        // a reference
                        $hasHistory = false;
                        $reason = $article->generateReason( $hasHistory );
-                       if ( $reason === false )
+                       if ( $reason === false ) {
                                return array( array( 'cannotdelete' ) );
+                       }
                }
 
                $error = '';
-               if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, $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 ) ) {
@@ -142,32 +149,38 @@ class ApiDelete extends ApiBase {
                return array( array( 'cannotdelete', $article->mTitle->getPrefixedText() ) );
        }
 
-       public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false )
-       {
+       public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
                $errors = self::getPermissionsError( $title, $token );
-               if ( count( $errors ) ) return $errors;
+               if ( count( $errors ) ) {
+                       return $errors;
+               }
 
-               if ( $oldimage && !FileDeleteForm::isValidOldSpec( $oldimage ) )
+               if ( $oldimage && !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
                        return array( array( 'invalidoldimage' ) );
+               }
 
                $file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
                $oldfile = false;
-               
-               if ( $oldimage )
+
+               if ( $oldimage ) {
                        $oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
-                       
-               if ( !FileDeleteForm::haveDeletableFile( $file, $oldfile, $oldimage ) )
+               }
+
+               if ( !FileDeleteForm::haveDeletableFile( $file, $oldfile, $oldimage ) ) {
                        return self::delete( new Article( $title ), $token, $reason );
-               if ( is_null( $reason ) ) // Log and RC don't like null reasons
+               }
+               if ( is_null( $reason ) ) { // Log and RC don't like null reasons
                        $reason = '';
+               }
                $status = FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress );
-                               
-               if ( !$status->isGood() )
+
+               if ( !$status->isGood() ) {
                        return array( array( 'cannotdelete', $title->getPrefixedText() ) );
-                       
+               }
+
                return array();
        }
-       
+
        public function mustBePosted() {
                return true;
        }
@@ -177,7 +190,7 @@ class ApiDelete extends ApiBase {
        }
 
        public function getAllowedParams() {
-               return array (
+               return array(
                        'title' => null,
                        'pageid' => array(
                                ApiBase::PARAM_TYPE => 'integer'
@@ -191,7 +204,7 @@ class ApiDelete extends ApiBase {
        }
 
        public function getParamDescription() {
-               return array (
+               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',
                        'token' => 'A delete token previously retrieved through prop=info',
@@ -207,7 +220,7 @@ class ApiDelete extends ApiBase {
                        'Delete a page.'
                );
        }
-       
+
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'invalidtitle', 'title' ),
@@ -216,13 +229,13 @@ class ApiDelete extends ApiBase {
                        array( 'hookaborted', 'error' ),
                ) );
        }
-       
+
        public function getTokenSalt() {
                return '';
        }
 
        protected function getExamples() {
-               return array (
+               return array(
                        'api.php?action=delete&title=Main%20Page&token=123ABC',
                        'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
                );