MediaWiki 1.17.4

[autoinstallsdev/mediawiki.git] / includes / api / ApiUnblock.php

diff --git a/includes/api/ApiUnblock.php b/includes/api/ApiUnblock.php
index 9216317ab7690526b0b9af31ee142e82f6967e85..45d951e66c3fab38bd2cbaa077b29107ba0f52c0 100644 (file)
--- a/includes/api/ApiUnblock.php
+++ b/includes/api/ApiUnblock.php
@@ -1,10 +1,10 @@
 <?php
-
-/*
- * Created on Sep 7, 2007
+/**
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Created on Sep 7, 2007
+ *
+ * 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
@@ -18,13 +18,15 @@
  *
  * 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')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ("ApiBase.php");
+       require_once( "ApiBase.php" );
 }
 
 /**
@@ -35,8 +37,8 @@ if (!defined('MEDIAWIKI')) {
  */
 class ApiUnblock extends ApiBase {
 
-       public function __construct($main, $action) {
-               parent :: __construct($main, $action);
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
        }
 
        /**
@@ -46,45 +48,54 @@ class ApiUnblock extends ApiBase {
                global $wgUser;
                $params = $this->extractRequestParams();
 
-               if($params['gettoken'])
-               {
+               if ( $params['gettoken'] ) {
                        $res['unblocktoken'] = $wgUser->editToken();
-                       $this->getResult()->addValue(null, $this->getModuleName(), $res);
+                       $this->getResult()->addValue( null, $this->getModuleName(), $res );
                        return;
                }
 
-               if(is_null($params['id']) && is_null($params['user']))
-                       $this->dieUsageMsg(array('unblock-notarget'));
-               if(!is_null($params['id']) && !is_null($params['user']))
-                       $this->dieUsageMsg(array('unblock-idanduser'));
-               if(is_null($params['token']))
-                       $this->dieUsageMsg(array('missingparam', 'token'));
-               if(!$wgUser->matchEditToken($params['token']))
-                       $this->dieUsageMsg(array('sessionfailure'));
-               if(!$wgUser->isAllowed('block'))
-                       $this->dieUsageMsg(array('cantunblock'));
+               if ( is_null( $params['id'] ) && is_null( $params['user'] ) ) {
+                       $this->dieUsageMsg( array( 'unblock-notarget' ) );
+               }
+               if ( !is_null( $params['id'] ) && !is_null( $params['user'] ) ) {
+                       $this->dieUsageMsg( array( 'unblock-idanduser' ) );
+               }
+
+               if ( !$wgUser->isAllowed( 'block' ) ) {
+                       $this->dieUsageMsg( array( 'cantunblock' ) );
+               }
+               # bug 15810: blocked admins should have limited access here
+               if ( $wgUser->isBlocked() ) {
+                       $status = IPBlockForm::checkUnblockSelf( $params['user'] );
+                       if ( $status !== true ) {
+                               $this->dieUsageMsg( array( $status ) );
+                       }
+               }
 
                $id = $params['id'];
                $user = $params['user'];
-               $reason = (is_null($params['reason']) ? '' : $params['reason']);
-               $retval = IPUnblockForm::doUnblock($id, $user, $reason, $range);
-               if($retval)
-                       $this->dieUsageMsg($retval);
+               $reason = ( is_null( $params['reason'] ) ? '' : $params['reason'] );
+               $retval = IPUnblockForm::doUnblock( $id, $user, $reason, $range );
+               if ( $retval ) {
+                       $this->dieUsageMsg( $retval );
+               }
 
-               $res['id'] = intval($id);
+               $res['id'] = intval( $id );
                $res['user'] = $user;
                $res['reason'] = $reason;
-               $this->getResult()->addValue(null, $this->getModuleName(), $res);
+               $this->getResult()->addValue( null, $this->getModuleName(), $res );
        }
 
-       public function mustBePosted() { return true; }
+       public function mustBePosted() {
+               return true;
+       }
 
        public function isWriteMode() {
                return true;
        }
 
        public function getAllowedParams() {
-               return array (
+               return array(
                        'id' => null,
                        'user' => null,
                        'token' => null,
@@ -94,29 +105,46 @@ class ApiUnblock extends ApiBase {
        }
 
        public function getParamDescription() {
-               return array (
-                       'id' => 'ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with user',
-                       'user' => 'Username, IP address or IP range you want to unblock. Cannot be used together with id',
-                       'token' => 'An unblock token previously obtained through the gettoken parameter or prop=info',
+               $p = $this->getModulePrefix();
+               return array(
+                       'id' => "ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with {$p}user",
+                       'user' => "Username, IP address or IP range you want to unblock. Cannot be used together with {$p}id",
+                       'token' => "An unblock token previously obtained through the gettoken parameter or {$p}prop=info",
                        'gettoken' => 'If set, an unblock token will be returned, and no other action will be taken',
                        'reason' => 'Reason for unblock (optional)',
                );
        }
 
        public function getDescription() {
-               return array(
-                       'Unblock a user.'
-               );
+               return 'Unblock a user';
+       }
+
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'unblock-notarget' ),
+                       array( 'unblock-idanduser' ),
+                       array( 'cantunblock' ),
+                       array( 'ipbblocked' ),
+                       array( 'ipbnounblockself' ),
+               ) );
+       }
+
+       public function needsToken() {
+               return true;
+       }
+
+       public function getTokenSalt() {
+               return '';
        }
 
        protected function getExamples() {
-               return array (
+               return array(
                        'api.php?action=unblock&id=105',
                        'api.php?action=unblock&user=Bob&reason=Sorry%20Bob'
                );
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiUnblock.php 48091 2009-03-06 13:49:44Z catrope $';
+               return __CLASS__ . ': $Id$';
        }
 }