-<?php\r
-\r
-/*\r
- * Created on Sep 4, 2007\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ("ApiBase.php");\r
-}\r
-\r
-/**\r
- * @addtogroup API\r
- */\r
-class ApiBlock extends ApiBase {\r
-\r
- public function __construct($main, $action) {\r
- parent :: __construct($main, $action);\r
- }\r
-\r
- public function execute() {\r
- global $wgUser;\r
- $this->requestWriteMode();\r
- $params = $this->extractRequestParams();\r
-\r
- if($params['gettoken'])\r
- {\r
- $res['blocktoken'] = $wgUser->editToken();\r
- $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
- return;\r
- }\r
-\r
- if(is_null($params['user']))\r
- $this->dieUsage('The user parameter must be set', 'nouser');\r
- if(is_null($params['token']))\r
- $this->dieUsage('The token parameter must be set', 'notoken');\r
- if(!$wgUser->matchEditToken($params['token']))\r
- $this->dieUsage('Invalid token', 'badtoken');\r
- if(!$wgUser->isAllowed('block'))\r
- $this->dieUsage('You don\'t have permission to block users', 'permissiondenied');\r
- if($params['hidename'] && !$wgUser->isAllowed('hideuser'))\r
- $this->dieUsage('You don\'t have permission to hide user names from the block log', 'nohide');\r
- if(wfReadOnly())\r
- $this->dieUsage('The wiki is in read-only mode', 'readonly');\r
-\r
- $form = new IPBlockForm('');\r
- $form->BlockAddress = $params['user'];\r
- $form->BlockReason = $params['reason'];\r
- $form->BlockReasonList = 'other';\r
- $form->BlockExpiry = ($params['expiry'] == 'never' ? 'infinite' : $params['expiry']);\r
- $form->BlockOther = '';\r
- $form->BlockAnonOnly = $params['anononly'];\r
- $form->BlockCreateAccount = $params['nocreate'];\r
- $form->BlockEnableAutoBlock = $params['autoblock'];\r
- $form->BlockEmail = $params['noemail'];\r
- $form->BlockHideName = $params['hidename'];\r
-\r
- $dbw = wfGetDb(DB_MASTER);\r
- $dbw->begin();\r
- $retval = $form->doBlock($userID, $expiry);\r
- switch($retval)\r
- {\r
- case IPBlockForm::BLOCK_SUCCESS:\r
- break; // We'll deal with that later\r
- case IPBlockForm::BLOCK_RANGE_INVALID:\r
- $this->dieUsage("Invalid IP range ``{$params['user']}''", 'invalidrange');\r
- case IPBlockForm::BLOCK_RANGE_DISABLED:\r
- $this->dieUsage('Blocking IP ranges has been disabled', 'rangedisabled');\r
- case IPBlockForm::BLOCK_NONEXISTENT_USER:\r
- $this->dieUsage("User ``{$params['user']}'' doesn't exist", 'nosuchuser');\r
- case IPBlockForm::BLOCK_IP_INVALID:\r
- $this->dieUsage("Invaild IP address ``{$params['user']}''", 'invalidip');\r
- case IPBlockForm::BLOCK_EXPIRY_INVALID:\r
- $this->dieUsage("Invalid expiry time ``{$params['expiry']}''", 'invalidexpiry');\r
- case IPBlockForm::BLOCK_ALREADY_BLOCKED:\r
- $this->dieUsage("User ``{$params['user']}'' is already blocked", 'alreadyblocked');\r
- default:\r
- $this->dieDebug(__METHOD__, "IPBlockForm::doBlock() returned an unknown error ($retval)");\r
- }\r
- $dbw->commit();\r
- \r
- $res['user'] = $params['user'];\r
- $res['userID'] = $userID;\r
- $res['expiry'] = ($expiry == Block::infinity() ? 'infinite' : $expiry);\r
- $res['reason'] = $params['reason'];\r
- if($params['anononly'])\r
- $res['anononly'] = '';\r
- if($params['nocreate'])\r
- $res['nocreate'] = '';\r
- if($params['autoblock'])\r
- $res['autoblock'] = '';\r
- if($params['noemail'])\r
- $res['noemail'] = '';\r
- if($params['hidename'])\r
- $res['hidename'] = '';\r
-\r
- $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
- }\r
-\r
- protected function getAllowedParams() {\r
- return array (\r
- 'user' => null,\r
- 'token' => null,\r
- 'gettoken' => false,\r
- 'expiry' => 'never',\r
- 'reason' => null,\r
- 'anononly' => false,\r
- 'nocreate' => false,\r
- 'autoblock' => false,\r
- 'noemail' => false,\r
- 'hidename' => false,\r
- );\r
- }\r
-\r
- protected function getParamDescription() {\r
- return array (\r
- 'user' => 'Username, IP address or IP range you want to block',\r
- 'token' => 'A block token previously obtained through the gettoken parameter',\r
- 'gettoken' => 'If set, a block token will be returned, and no other action will be taken',\r
- 'expiry' => 'Relative expiry time, e.g. \'5 months\' or \'2 weeks\'. If set to \'infinite\', \'indefinite\' or \'never\', the block will never expire.',\r
- 'reason' => 'Reason for block (optional)',\r
- 'anononly' => 'Block anonymous users only (i.e. disable anonymous edits for this IP)',\r
- 'nocreate' => 'Prevent account creation',\r
- 'autoblock' => 'Automatically block the last used IP address, and any subsequent IP addresses they try to login from',\r
- 'noemail' => 'Prevent user from sending e-mail through the wiki',\r
- 'hidename' => 'Hide the username from the block log.'\r
- );\r
- }\r
-\r
- protected function getDescription() {\r
- return array(\r
- 'Block a user.'\r
- );\r
- }\r
-\r
- protected function getExamples() {\r
- return array (\r
- 'api.php?action=block&user=123.5.5.12&expiry=3%20days&reason=First%20strike',\r
- 'api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate&autoblock&noemail'\r
- );\r
- }\r
-\r
- public function getVersion() {\r
- return __CLASS__ . ': $Id$';\r
- }\r
-}\r
+<?php
+/**
+ *
+ *
+ * Created on Sep 4, 2007
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+* API module that facilitates the blocking of users. Requires API write mode
+* to be enabled.
+*
+ * @ingroup API
+ */
+class ApiBlock extends ApiBase {
+
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
+ }
+
+ /**
+ * Blocks the user specified in the parameters for the given expiry, with the
+ * given reason, and with all other settings provided in the params. If the block
+ * succeeds, produces a result containing the details of the block and notice
+ * of success. If it fails, the result will specify the nature of the error.
+ */
+ public function execute() {
+ $user = $this->getUser();
+ $params = $this->extractRequestParams();
+
+ if ( $params['gettoken'] ) {
+ $res['blocktoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
+ return;
+ }
+
+ 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 );
+ }
+
+ list( $target, /*...*/ ) = SpecialBlock::getTargetAndType( $params['user'] );
+ $res['user'] = $params['user'];
+ $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'] ) {
+ $res['anononly'] = '';
+ }
+ if ( $params['nocreate'] ) {
+ $res['nocreate'] = '';
+ }
+ if ( $params['autoblock'] ) {
+ $res['autoblock'] = '';
+ }
+ if ( $params['noemail'] ) {
+ $res['noemail'] = '';
+ }
+ if ( $params['hidename'] ) {
+ $res['hidename'] = '';
+ }
+ if ( $params['allowusertalk'] ) {
+ $res['allowusertalk'] = '';
+ }
+ if ( $params['watchuser'] ) {
+ $res['watchuser'] = '';
+ }
+
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
+ }
+
+ 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',
+ 'reason' => null,
+ 'anononly' => false,
+ 'nocreate' => false,
+ 'autoblock' => false,
+ 'noemail' => false,
+ 'hidename' => false,
+ 'allowusertalk' => false,
+ 'reblock' => false,
+ 'watchuser' => false,
+ );
+ }
+
+ 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 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. (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',
+ );
+ }
+
+ 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;
+ }
+
+ 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='
+ );
+ }
+
+ 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