includes/api/ApiBlock.php

   1 <?php
   2
   3 /**
   4  * Created on Sep 4, 2007
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright © 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 blocking of users. Requires API write mode
  32 * to be enabled.
  33 *
  34  * @ingroup API
  35  */
  36 class ApiBlock extends ApiBase {
  37
  38         /**
  39          * Std ctor.
  40          */
  41         public function __construct( $main, $action ) {
  42                 parent::__construct( $main, $action );
  43         }
  44
  45         /**
  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.
  50          */
  51         public function execute() {
  52                 global $wgUser, $wgBlockAllowsUTEdit;
  53                 $params = $this->extractRequestParams();
  54
  55                 if ( $params['gettoken'] ) {
  56                         $res['blocktoken'] = $wgUser->editToken();
  57                         $this->getResult()->addValue( null, $this->getModuleName(), $res );
  58                         return;
  59                 }
  60
  61                 if ( is_null( $params['user'] ) ) {
  62                         $this->dieUsageMsg( array( 'missingparam', 'user' ) );
  63                 }
  64                 if ( !$wgUser->isAllowed( 'block' ) ) {
  65                         $this->dieUsageMsg( array( 'cantblock' ) );
  66                 }
  67                 if ( $params['hidename'] && !$wgUser->isAllowed( 'hideuser' ) ) {
  68                         $this->dieUsageMsg( array( 'canthide' ) );
  69                 }
  70                 if ( $params['noemail'] && !IPBlockForm::canBlockEmail( $wgUser ) ) {
  71                         $this->dieUsageMsg( array( 'cantblock-email' ) );
  72                 }
  73
  74                 $form = new IPBlockForm( '' );
  75                 $form->BlockAddress = $params['user'];
  76                 $form->BlockReason = ( is_null( $params['reason'] ) ? '' : $params['reason'] );
  77                 $form->BlockReasonList = 'other';
  78                 $form->BlockExpiry = ( $params['expiry'] == 'never' ? 'infinite' : $params['expiry'] );
  79                 $form->BlockOther = '';
  80                 $form->BlockAnonOnly = $params['anononly'];
  81                 $form->BlockCreateAccount = $params['nocreate'];
  82                 $form->BlockEnableAutoblock = $params['autoblock'];
  83                 $form->BlockEmail = $params['noemail'];
  84                 $form->BlockHideName = $params['hidename'];
  85                 $form->BlockAllowUsertalk = $params['allowusertalk'] && $wgBlockAllowsUTEdit;
  86                 $form->BlockReblock = $params['reblock'];
  87
  88                 $userID = $expiry = null;
  89                 $retval = $form->doBlock( $userID, $expiry );
  90                 if ( count( $retval ) ) {
  91                         // We don't care about multiple errors, just report one of them
  92                         $this->dieUsageMsg( $retval );
  93                 }
  94
  95                 $res['user'] = $params['user'];
  96                 $res['userID'] = intval( $userID );
  97                 $res['expiry'] = ( $expiry == Block::infinity() ? 'infinite' : wfTimestamp( TS_ISO_8601, $expiry ) );
  98                 $res['reason'] = $params['reason'];
  99                 if ( $params['anononly'] ) {
 100                         $res['anononly'] = '';
 101                 }
 102                 if ( $params['nocreate'] ) {
 103                         $res['nocreate'] = '';
 104                 }
 105                 if ( $params['autoblock'] ) {
 106                         $res['autoblock'] = '';
 107                 }
 108                 if ( $params['noemail'] ) {
 109                         $res['noemail'] = '';
 110                 }
 111                 if ( $params['hidename'] ) {
 112                         $res['hidename'] = '';
 113                 }
 114                 if ( $params['allowusertalk'] ) {
 115                         $res['allowusertalk'] = '';
 116                 }
 117
 118                 $this->getResult()->addValue( null, $this->getModuleName(), $res );
 119         }
 120
 121         public function mustBePosted() {
 122                 return true;
 123         }
 124
 125         public function isWriteMode() {
 126                 return true;
 127         }
 128
 129         public function getAllowedParams() {
 130                 return array(
 131                         'user' => null,
 132                         'token' => null,
 133                         'gettoken' => false,
 134                         'expiry' => 'never',
 135                         'reason' => null,
 136                         'anononly' => false,
 137                         'nocreate' => false,
 138                         'autoblock' => false,
 139                         'noemail' => false,
 140                         'hidename' => false,
 141                         'allowusertalk' => false,
 142                         'reblock' => false,
 143                 );
 144         }
 145
 146         public function getParamDescription() {
 147                 return array(
 148                         'user' => 'Username, IP address or IP range you want to block',
 149                         'token' => 'A block token previously obtained through the gettoken parameter or prop=info',
 150                         'gettoken' => 'If set, a block token will be returned, and no other action will be taken',
 151                         'expiry' => 'Relative expiry time, e.g. \'5 months\' or \'2 weeks\'. If set to \'infinite\', \'indefinite\' or \'never\', the block will never expire.',
 152                         'reason' => 'Reason for block (optional)',
 153                         'anononly' => 'Block anonymous users only (i.e. disable anonymous edits for this IP)',
 154                         'nocreate' => 'Prevent account creation',
 155                         'autoblock' => 'Automatically block the last used IP address, and any subsequent IP addresses they try to login from',
 156                         'noemail' => 'Prevent user from sending e-mail through the wiki. (Requires the "blockemail" right.)',
 157                         'hidename' => 'Hide the username from the block log. (Requires the "hideuser" right.)',
 158                         'allowusertalk' => 'Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit)',
 159                         'reblock' => 'If the user is already blocked, overwrite the existing block',
 160                 );
 161         }
 162
 163         public function getDescription() {
 164                 return array(
 165                         'Block a user.'
 166                 );
 167         }
 168
 169         public function getPossibleErrors() {
 170                 return array_merge( parent::getPossibleErrors(), array(
 171                         array( 'missingparam', 'user' ),
 172                         array( 'cantblock' ),
 173                         array( 'canthide' ),
 174                         array( 'cantblock-email' ),
 175                 ) );
 176         }
 177
 178         public function getTokenSalt() {
 179                 return '';
 180         }
 181
 182         protected function getExamples() {
 183                 return array(
 184                         'api.php?action=block&user=123.5.5.12&expiry=3%20days&reason=First%20strike',
 185                         'api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate&autoblock&noemail'
 186                 );
 187         }
 188
 189         public function getVersion() {
 190                 return __CLASS__ . ': $Id$';
 191         }
 192 }