4 * Created on Sep 4, 2007
5 * API for MediaWiki 1.8+
7 * Copyright (C) 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 blocking of users. Requires API write mode
36 class ApiBlock
extends ApiBase
{
41 public function __construct($main, $action) {
42 parent
:: __construct($main, $action);
46 * Blocks the user specified in the parameters for the given expiry, with the
47 * given reason, and with all other settings provided in the params. If the block
48 * succeeds, produces a result containing the details of the block and notice
49 * of success. If it fails, the result will specify the nature of the error.
51 public function execute() {
52 global $wgUser, $wgBlockAllowsUTEdit;
53 $this->getMain()->requestWriteMode();
54 $params = $this->extractRequestParams();
56 if($params['gettoken'])
58 $res['blocktoken'] = $wgUser->editToken();
59 $this->getResult()->addValue(null, $this->getModuleName(), $res);
63 if(is_null($params['user']))
64 $this->dieUsageMsg(array('missingparam', 'user'));
65 if(is_null($params['token']))
66 $this->dieUsageMsg(array('missingparam', 'token'));
67 if(!$wgUser->matchEditToken($params['token']))
68 $this->dieUsageMsg(array('sessionfailure'));
69 if(!$wgUser->isAllowed('block'))
70 $this->dieUsageMsg(array('cantblock'));
71 if($params['hidename'] && !$wgUser->isAllowed('hideuser'))
72 $this->dieUsageMsg(array('canthide'));
73 if($params['noemail'] && !$wgUser->isAllowed('blockemail'))
74 $this->dieUsageMsg(array('cantblock-email'));
76 $form = new IPBlockForm('');
77 $form->BlockAddress
= $params['user'];
78 $form->BlockReason
= (is_null($params['reason']) ?
'' : $params['reason']);
79 $form->BlockReasonList
= 'other';
80 $form->BlockExpiry
= ($params['expiry'] == 'never' ?
'infinite' : $params['expiry']);
81 $form->BlockOther
= '';
82 $form->BlockAnonOnly
= $params['anononly'];
83 $form->BlockCreateAccount
= $params['nocreate'];
84 $form->BlockEnableAutoblock
= $params['autoblock'];
85 $form->BlockEmail
= $params['noemail'];
86 $form->BlockHideName
= $params['hidename'];
87 $form->BlockAllowUsertalk
= $params['allowusertalk'] && $wgBlockAllowsUTEdit;
88 $form->BlockReblock
= $params['reblock'];
90 $userID = $expiry = null;
91 $retval = $form->doBlock($userID, $expiry);
93 // We don't care about multiple errors, just report one of them
94 $this->dieUsageMsg($retval);
96 $res['user'] = $params['user'];
97 $res['userID'] = $userID;
98 $res['expiry'] = ($expiry == Block
::infinity() ?
'infinite' : wfTimestamp(TS_ISO_8601
, $expiry));
99 $res['reason'] = $params['reason'];
100 if($params['anononly'])
101 $res['anononly'] = '';
102 if($params['nocreate'])
103 $res['nocreate'] = '';
104 if($params['autoblock'])
105 $res['autoblock'] = '';
106 if($params['noemail'])
107 $res['noemail'] = '';
108 if($params['hidename'])
109 $res['hidename'] = '';
110 if($params['allowusertalk'])
111 $res['allowusertalk'] = '';
113 $this->getResult()->addValue(null, $this->getModuleName(), $res);
116 public function mustBePosted() { return true; }
118 public function getAllowedParams() {
127 'autoblock' => false,
130 'allowusertalk' => false,
135 public function getParamDescription() {
137 'user' => 'Username, IP address or IP range you want to block',
138 'token' => 'A block token previously obtained through the gettoken parameter or prop=info',
139 'gettoken' => 'If set, a block token will be returned, and no other action will be taken',
140 'expiry' => 'Relative expiry time, e.g. \'5 months\' or \'2 weeks\'. If set to \'infinite\', \'indefinite\' or \'never\', the block will never expire.',
141 'reason' => 'Reason for block (optional)',
142 'anononly' => 'Block anonymous users only (i.e. disable anonymous edits for this IP)',
143 'nocreate' => 'Prevent account creation',
144 'autoblock' => 'Automatically block the last used IP address, and any subsequent IP addresses they try to login from',
145 'noemail' => 'Prevent user from sending e-mail through the wiki. (Requires the "blockemail" right.)',
146 'hidename' => 'Hide the username from the block log. (Requires the "hideuser" right.)',
147 'allowusertalk' => 'Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit)',
148 'reblock' => 'If the user is already blocked, overwrite the existing block',
152 public function getDescription() {
158 protected function getExamples() {
160 'api.php?action=block&user=123.5.5.12&expiry=3%20days&reason=First%20strike',
161 'api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate&autoblock&noemail'
165 public function getVersion() {
166 return __CLASS__
. ': $Id$';