4 * Created on Sep 7, 2007
5 * API for MediaWiki 1.8+
7 * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
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.
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.
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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 * http://www.gnu.org/copyleft/gpl.html
25 if ( !defined( 'MEDIAWIKI' ) ) {
26 // Eclipse helper - will be ignored in production
27 require_once( "ApiBase.php" );
31 * API module that facilitates the unblocking of users. Requires API write mode
36 class ApiUnblock
extends ApiBase
{
38 public function __construct( $main, $action ) {
39 parent
::__construct( $main, $action );
43 * Unblocks the specified user or provides the reason the unblock failed.
45 public function execute() {
47 $params = $this->extractRequestParams();
49 if ( $params['gettoken'] ) {
50 $res['unblocktoken'] = $wgUser->editToken();
51 $this->getResult()->addValue( null, $this->getModuleName(), $res );
55 if ( is_null( $params['id'] ) && is_null( $params['user'] ) ) {
56 $this->dieUsageMsg( array( 'unblock-notarget' ) );
58 if ( !is_null( $params['id'] ) && !is_null( $params['user'] ) ) {
59 $this->dieUsageMsg( array( 'unblock-idanduser' ) );
62 if ( !$wgUser->isAllowed( 'block' ) ) {
63 $this->dieUsageMsg( array( 'cantunblock' ) );
65 # bug 15810: blocked admins should have limited access here
66 if( $wgUser->isBlocked() ){
67 $user = User
::newFromName( $params['user'] );
68 if( $user instanceof User
69 && $user->getId() == $wgUser->getId() )
71 # User is trying to unblock themselves
72 if( !$wgUser->isAllowed( 'unblockself' ) ){
73 $this->dieUsageMsg( array( 'ipbnounblockself' ) );
76 # User is trying to block/unblock someone else
77 $this->dieUsageMsg( array( 'ipbblocked' ) );
82 $user = $params['user'];
83 $reason = ( is_null( $params['reason'] ) ?
'' : $params['reason'] );
84 $retval = IPUnblockForm
::doUnblock( $id, $user, $reason, $range );
86 $this->dieUsageMsg( $retval );
89 $res['id'] = intval( $id );
91 $res['reason'] = $reason;
92 $this->getResult()->addValue( null, $this->getModuleName(), $res );
95 public function mustBePosted() {
99 public function isWriteMode() {
103 public function getAllowedParams() {
113 public function getParamDescription() {
115 'id' => 'ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with user',
116 'user' => 'Username, IP address or IP range you want to unblock. Cannot be used together with id',
117 'token' => 'An unblock token previously obtained through the gettoken parameter or prop=info',
118 'gettoken' => 'If set, an unblock token will be returned, and no other action will be taken',
119 'reason' => 'Reason for unblock (optional)',
123 public function getDescription() {
129 public function getPossibleErrors() {
130 return array_merge( parent
::getPossibleErrors(), array(
131 array( 'unblock-notarget' ),
132 array( 'unblock-idanduser' ),
133 array( 'cantunblock' ),
134 array( 'ipbblocked' ),
135 array( 'ipbnounblockself' ),
139 public function getTokenSalt() {
143 protected function getExamples() {
145 'api.php?action=unblock&id=105',
146 'api.php?action=unblock&user=Bob&reason=Sorry%20Bob'
150 public function getVersion() {
151 return __CLASS__
. ': $Id$';