<?php
-
-/*
+/**
+ *
+ *
* Created on Sep 4, 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
*
* 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 blocking of users. Requires API write mode
* to be enabled.
*
- * @addtogroup API
+ * @ingroup API
*/
class ApiBlock extends ApiBase {
- /**
- * Std ctor.
- */
- public function __construct($main, $action) {
- parent :: __construct($main, $action);
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
}
/**
* of success. If it fails, the result will specify the nature of the error.
*/
public function execute() {
- global $wgUser;
- $this->getMain()->requestWriteMode();
+ $user = $this->getUser();
$params = $this->extractRequestParams();
- if($params['gettoken'])
- {
- $res['blocktoken'] = $wgUser->editToken();
- $this->getResult()->addValue(null, $this->getModuleName(), $res);
+ if ( $params['gettoken'] ) {
+ $res['blocktoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
return;
}
- if(is_null($params['user']))
- $this->dieUsage('The user parameter must be set', 'nouser');
- if(is_null($params['token']))
- $this->dieUsage('The token parameter must be set', 'notoken');
- if(!$wgUser->matchEditToken($params['token']))
- $this->dieUsage('Invalid token', 'badtoken');
- if(!$wgUser->isAllowed('block'))
- $this->dieUsage('You don\'t have permission to block users', 'permissiondenied');
- if($params['hidename'] && !$wgUser->isAllowed('hideuser'))
- $this->dieUsage('You don\'t have permission to hide user names from the block log', 'nohide');
- if(wfReadOnly())
- $this->dieUsage('The wiki is in read-only mode', 'readonly');
-
- $form = new IPBlockForm('');
- $form->BlockAddress = $params['user'];
- $form->BlockReason = $params['reason'];
- $form->BlockReasonList = 'other';
- $form->BlockExpiry = ($params['expiry'] == 'never' ? 'infinite' : $params['expiry']);
- $form->BlockOther = '';
- $form->BlockAnonOnly = $params['anononly'];
- $form->BlockCreateAccount = $params['nocreate'];
- $form->BlockEnableAutoBlock = $params['autoblock'];
- $form->BlockEmail = $params['noemail'];
- $form->BlockHideName = $params['hidename'];
-
- $dbw = wfGetDb(DB_MASTER);
- $dbw->begin();
- $retval = $form->doBlock($userID, $expiry);
- switch($retval)
- {
- case IPBlockForm::BLOCK_SUCCESS:
- break; // We'll deal with that later
- case IPBlockForm::BLOCK_RANGE_INVALID:
- $this->dieUsage("Invalid IP range ``{$params['user']}''", 'invalidrange');
- case IPBlockForm::BLOCK_RANGE_DISABLED:
- $this->dieUsage('Blocking IP ranges has been disabled', 'rangedisabled');
- case IPBlockForm::BLOCK_NONEXISTENT_USER:
- $this->dieUsage("User ``{$params['user']}'' doesn't exist", 'nosuchuser');
- case IPBlockForm::BLOCK_IP_INVALID:
- $this->dieUsage("Invaild IP address ``{$params['user']}''", 'invalidip');
- case IPBlockForm::BLOCK_EXPIRY_INVALID:
- $this->dieUsage("Invalid expiry time ``{$params['expiry']}''", 'invalidexpiry');
- case IPBlockForm::BLOCK_ALREADY_BLOCKED:
- $this->dieUsage("User ``{$params['user']}'' is already blocked", 'alreadyblocked');
- default:
- $this->dieDebug(__METHOD__, "IPBlockForm::doBlock() returned an unknown error ($retval)");
+ if ( !$user->isAllowed( 'block' ) ) {
+ $this->dieUsageMsg( 'cantblock' );
+ }
+ # bug 15810: blocked admins should have limited access here
+ if ( $user->isBlocked() ) {
+ $status = SpecialBlock::checkUnblockSelf( $params['user'], $user );
+ if ( $status !== true ) {
+ $this->dieUsageMsg( array( $status ) );
+ }
+ }
+ if ( $params['hidename'] && !$user->isAllowed( 'hideuser' ) ) {
+ $this->dieUsageMsg( 'canthide' );
+ }
+ if ( $params['noemail'] && !SpecialBlock::canBlockEmail( $user ) ) {
+ $this->dieUsageMsg( 'cantblock-email' );
+ }
+
+ $data = array(
+ 'Target' => $params['user'],
+ 'Reason' => array(
+ is_null( $params['reason'] ) ? '' : $params['reason'],
+ 'other',
+ is_null( $params['reason'] ) ? '' : $params['reason']
+ ),
+ 'Expiry' => $params['expiry'] == 'never' ? 'infinite' : $params['expiry'],
+ 'HardBlock' => !$params['anononly'],
+ 'CreateAccount' => $params['nocreate'],
+ 'AutoBlock' => $params['autoblock'],
+ 'DisableEmail' => $params['noemail'],
+ 'HideUser' => $params['hidename'],
+ 'DisableUTEdit' => !$params['allowusertalk'],
+ 'AlreadyBlocked' => $params['reblock'],
+ 'Watch' => $params['watchuser'],
+ 'Confirm' => true,
+ );
+
+ $retval = SpecialBlock::processForm( $data, $this->getContext() );
+ if ( $retval !== true ) {
+ // We don't care about multiple errors, just report one of them
+ $this->dieUsageMsg( $retval );
}
- $dbw->commit();
-
+
+ list( $target, /*...*/ ) = SpecialBlock::getTargetAndType( $params['user'] );
$res['user'] = $params['user'];
- $res['userID'] = $userID;
- $res['expiry'] = ($expiry == Block::infinity() ? 'infinite' : $expiry);
+ $res['userID'] = $target instanceof User ? $target->getId() : 0;
+
+ $block = Block::newFromTarget( $target );
+ if( $block instanceof Block ){
+ $res['expiry'] = $block->mExpiry == wfGetDB( DB_SLAVE )->getInfinity()
+ ? 'infinite'
+ : wfTimestamp( TS_ISO_8601, $block->mExpiry );
+ } else {
+ # should be unreachable
+ $res['expiry'] = '';
+ }
+
$res['reason'] = $params['reason'];
- if($params['anononly'])
+ if ( $params['anononly'] ) {
$res['anononly'] = '';
- if($params['nocreate'])
+ }
+ if ( $params['nocreate'] ) {
$res['nocreate'] = '';
- if($params['autoblock'])
+ }
+ if ( $params['autoblock'] ) {
$res['autoblock'] = '';
- if($params['noemail'])
+ }
+ if ( $params['noemail'] ) {
$res['noemail'] = '';
- if($params['hidename'])
+ }
+ if ( $params['hidename'] ) {
$res['hidename'] = '';
+ }
+ if ( $params['allowusertalk'] ) {
+ $res['allowusertalk'] = '';
+ }
+ if ( $params['watchuser'] ) {
+ $res['watchuser'] = '';
+ }
- $this->getResult()->addValue(null, $this->getModuleName(), $res);
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
}
- protected function getAllowedParams() {
- return array (
- 'user' => null,
+ public function mustBePosted() {
+ return true;
+ }
+
+ public function isWriteMode() {
+ return true;
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'user' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true
+ ),
'token' => null,
'gettoken' => false,
'expiry' => 'never',
'autoblock' => false,
'noemail' => false,
'hidename' => false,
+ 'allowusertalk' => false,
+ 'reblock' => false,
+ 'watchuser' => false,
);
}
- protected function getParamDescription() {
- return array (
+ public function getParamDescription() {
+ return array(
'user' => 'Username, IP address or IP range you want to block',
- 'token' => 'A block token previously obtained through the gettoken parameter',
+ 'token' => 'A block token previously obtained through the gettoken parameter or prop=info',
'gettoken' => 'If set, a block token will be returned, and no other action will be taken',
'expiry' => 'Relative expiry time, e.g. \'5 months\' or \'2 weeks\'. If set to \'infinite\', \'indefinite\' or \'never\', the block will never expire.',
'reason' => 'Reason for block (optional)',
'anononly' => 'Block anonymous users only (i.e. disable anonymous edits for this IP)',
'nocreate' => 'Prevent account creation',
'autoblock' => 'Automatically block the last used IP address, and any subsequent IP addresses they try to login from',
- 'noemail' => 'Prevent user from sending e-mail through the wiki',
- 'hidename' => 'Hide the username from the block log. (Requires the "hideuser" right.)'
+ 'noemail' => 'Prevent user from sending e-mail through the wiki. (Requires the "blockemail" right.)',
+ 'hidename' => 'Hide the username from the block log. (Requires the "hideuser" right.)',
+ 'allowusertalk' => 'Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit)',
+ 'reblock' => 'If the user is already blocked, overwrite the existing block',
+ 'watchuser' => 'Watch the user/IP\'s user and talk pages',
);
}
- protected function getDescription() {
- return array(
- 'Block a user.'
- );
+ public function getDescription() {
+ return 'Block a user';
+ }
+
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'cantblock' ),
+ array( 'canthide' ),
+ array( 'cantblock-email' ),
+ array( 'ipbblocked' ),
+ array( 'ipbnounblockself' ),
+ ) );
+ }
+
+ public function needsToken() {
+ return true;
}
- protected function getExamples() {
- return array (
+ public function getTokenSalt() {
+ return '';
+ }
+
+ public function getExamples() {
+ return array(
'api.php?action=block&user=123.5.5.12&expiry=3%20days&reason=First%20strike',
- 'api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate&autoblock&noemail'
+ 'api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail='
);
}
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/API:Block';
+ }
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}
dépôts / lhc / web / wiklou.git / blobdiff