Merge "[FileRepo] Locking and transaction fixes."

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

diff --git a/includes/api/ApiUnblock.php b/includes/api/ApiUnblock.php
index 9fe7ac9..e599e32 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
+ * 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,15 +18,12 @@
  *
  * 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' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once ( "ApiBase.php" );
-}
-
 /**
  * API module that facilitates the unblocking of users. Requires API write mode
  * to be enabled.
@@ -36,41 +33,53 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiUnblock extends ApiBase {
 
        public function __construct( $main, $action ) {
-               parent :: __construct( $main, $action );
+               parent::__construct( $main, $action );
        }
 
        /**
         * Unblocks the specified user or provides the reason the unblock failed.
         */
        public function execute() {
-               global $wgUser;
+               $user = $this->getUser();
                $params = $this->extractRequestParams();
 
-               if ( $params['gettoken'] )
-               {
-                       $res['unblocktoken'] = $wgUser->editToken();
+               if ( $params['gettoken'] ) {
+                       $res['unblocktoken'] = $user->getEditToken();
                        $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['id'] ) && is_null( $params['user'] ) ) {
+                       $this->dieUsageMsg( 'unblock-notarget' );
+               }
+               if ( !is_null( $params['id'] ) && !is_null( $params['user'] ) ) {
+                       $this->dieUsageMsg( 'unblock-idanduser' );
+               }
 
-               if ( !$wgUser->isAllowed( 'block' ) )
-                       $this->dieUsageMsg( array( 'cantunblock' ) );
+               if ( !$user->isAllowed( 'block' ) ) {
+                       $this->dieUsageMsg( 'cantunblock' );
+               }
+               # bug 15810: blocked admins should have limited access here
+               if ( $user->isBlocked() ) {
+                       $status = SpecialBlock::checkUnblockSelf( $params['user'], $user );
+                       if ( $status !== true ) {
+                               $this->dieUsageMsg( $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 );
+               $data = array(
+                       'Target' => is_null( $params['id'] ) ? $params['user'] : "#{$params['id']}",
+                       'Reason' => is_null( $params['reason'] ) ? '' : $params['reason']
+               );
+               $block = Block::newFromTarget( $data['Target'] );
+               $retval = SpecialUnblock::processUnblock( $data, $this->getContext() );
+               if ( $retval !== true ) {
+                       $this->dieUsageMsg( $retval[0] );
+               }
 
-               $res['id'] = intval( $id );
-               $res['user'] = $user;
-               $res['reason'] = $reason;
+               $res['id'] = $block->getId();
+               $res['user'] = $block->getType() == Block::TYPE_AUTO ? '' : $block->getTarget();
+               $res['reason'] = $params['reason'];
                $this->getResult()->addValue( null, $this->getModuleName(), $res );
        }
 
@@ -83,8 +92,10 @@ class ApiUnblock extends ApiBase {
        }
 
        public function getAllowedParams() {
-               return array (
-                       'id' => null,
+               return array(
+                       'id' => array(
+                               ApiBase::PARAM_TYPE => 'integer',
+                       ),
                        'user' => null,
                        'token' => null,
                        'gettoken' => false,
@@ -93,40 +104,49 @@ 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() {
+
+       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 null;
+               return '';
        }
 
-       protected function getExamples() {
-               return array (
+       public function getExamples() {
+               return array(
                        'api.php?action=unblock&id=105',
                        'api.php?action=unblock&user=Bob&reason=Sorry%20Bob'
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Block';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }