includes/api/ApiUnblock.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 7, 2007
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  */
  24
  25 if (!defined('MEDIAWIKI')) {
  26         // Eclipse helper - will be ignored in production
  27         require_once ("ApiBase.php");
  28 }
  29
  30 /**
  31  * API module that facilitates the unblocking of users. Requires API write mode
  32  * to be enabled.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiUnblock extends ApiBase {
  37
  38         public function __construct($main, $action) {
  39                 parent :: __construct($main, $action);
  40         }
  41
  42         /**
  43          * Unblocks the specified user or provides the reason the unblock failed.
  44          */
  45         public function execute() {
  46                 global $wgUser;
  47                 $this->getMain()->requestWriteMode();
  48                 $params = $this->extractRequestParams();
  49
  50                 if($params['gettoken'])
  51                 {
  52                         $res['unblocktoken'] = $wgUser->editToken();
  53                         $this->getResult()->addValue(null, $this->getModuleName(), $res);
  54                         return;
  55                 }
  56
  57                 if(is_null($params['id']) && is_null($params['user']))
  58                         $this->dieUsage('Either the id or the user parameter must be set', 'notarget');
  59                 if(!is_null($params['id']) && !is_null($params['user']))
  60                         $this->dieUsage('The id and user parameters can\'t be used together', 'idanduser');
  61                 if(is_null($params['token']))
  62                         $this->dieUsage('The token parameter must be set', 'notoken');
  63                 if(!$wgUser->matchEditToken($params['token']))
  64                         $this->dieUsage('Invalid token', 'badtoken');
  65                 if(!$wgUser->isAllowed('block'))
  66                         $this->dieUsage('You don\'t have permission to unblock users', 'permissiondenied');
  67                 if(wfReadOnly())
  68                         $this->dieUsage('The wiki is in read-only mode', 'readonly');
  69
  70                 $id = $params['id'];
  71                 $user = $params['user'];
  72                 $reason = $params['reason'];
  73                 $dbw = wfGetDb(DB_MASTER);
  74                 $dbw->begin();
  75                 $retval = IPUnblockForm::doUnblock(&$id, &$user, &$reason, &$range);
  76
  77                 switch($retval)
  78                 {
  79                         case IPUnblockForm::UNBLOCK_SUCCESS:
  80                                 break; // We'll deal with that later
  81                         case IPUnblockForm::UNBLOCK_NO_SUCH_ID:
  82                                 $this->dieUsage("There is no block with ID ``$id''", 'nosuchid');
  83                         case IPUnblockForm::UNBLOCK_USER_NOT_BLOCKED:
  84                                 $this->dieUsage("User ``$user'' is not blocked", 'notblocked');
  85                         case IPUnblockForm::UNBLOCK_BLOCKED_AS_RANGE:
  86                                 $this->dieUsage("IP address ``$user'' was blocked as part of range ``$range''. You can't unblock the IP invidually, but you can unblock the range as a whole.", 'blockedasrange');
  87                         case IPUnblockForm::UNBLOCK_UNKNOWNERR:
  88                                 $this->dieUsage("Unknown error", 'unknownerr');
  89                         default:
  90                                 $this->dieDebug(__METHOD__, "IPBlockForm::doBlock() returned an unknown error ($retval)");
  91                 }
  92                 $dbw->commit();
  93
  94                 $res['id'] = $id;
  95                 $res['user'] = $user;
  96                 $res['reason'] = $reason;
  97                 $this->getResult()->addValue(null, $this->getModuleName(), $res);
  98         }
  99
 100         protected function getAllowedParams() {
 101                 return array (
 102                         'id' => null,
 103                         'user' => null,
 104                         'token' => null,
 105                         'gettoken' => false,
 106                         'reason' => null,
 107                 );
 108         }
 109
 110         protected function getParamDescription() {
 111                 return array (
 112                         'id' => 'ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with user',
 113                         'user' => 'Username, IP address or IP range you want to unblock. Cannot be used together with id',
 114                         'token' => 'An unblock token previously obtained through the gettoken parameter',
 115                         'gettoken' => 'If set, an unblock token will be returned, and no other action will be taken',
 116                         'reason' => 'Reason for unblock (optional)',
 117                 );
 118         }
 119
 120         protected function getDescription() {
 121                 return array(
 122                         'Unblock a user.'
 123                 );
 124         }
 125
 126         protected function getExamples() {
 127                 return array (
 128                         'api.php?action=unblock&id=105',
 129                         'api.php?action=unblock&user=Bob&reason=Sorry%20Bob'
 130                 );
 131         }
 132
 133         public function getVersion() {
 134                 return __CLASS__ . ': $Id$';
 135         }
 136 }