-<?php\r
-\r
-/*\r
- * Created on Sep 7, 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 ApiUnblock 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->getMain()->extractRequestParams();\r
-\r
- if($params['gettoken'])\r
- {\r
- $res['unblocktoken'] = $wgUser->editToken();\r
- $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
- return;\r
- }\r
-\r
- if(is_null($params['id']) && is_null($params['user']))\r
- $this->dieUsage('Either the id or the user parameter must be set', 'notarget');\r
- if(!is_null($params['id']) && !is_null($params['user']))\r
- $this->dieUsage('The id and user parameters can\'t be used together', 'idanduser');\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 unblock users', 'permissiondenied');\r
- if(wfReadOnly())\r
- $this->dieUsage('The wiki is in read-only mode', 'readonly');\r
-\r
- $id = $params['id'];\r
- $user = $params['user'];\r
- $reason = $params['reason'];\r
- $dbw = wfGetDb(DB_MASTER);\r
- $dbw->begin();\r
- $retval = IPUnblockForm::doUnblock(&$id, &$user, &$reason, &$range);\r
-\r
- switch($retval)\r
- {\r
- case IPUnblockForm::UNBLOCK_SUCCESS:\r
- break; // We'll deal with that later\r
- case IPUnblockForm::UNBLOCK_NO_SUCH_ID:\r
- $this->dieUsage("There is no block with ID ``$id''", 'nosuchid');\r
- case IPUnblockForm::UNBLOCK_USER_NOT_BLOCKED:\r
- $this->dieUsage("User ``$user'' is not blocked", 'notblocked');\r
- case IPUnblockForm::UNBLOCK_BLOCKED_AS_RANGE:\r
- $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');\r
- case IPUnblockForm::UNBLOCK_UNKNOWNERR:\r
- $this->dieUsage("Unknown error", 'unknownerr');\r
- default:\r
- $this->dieDebug(__METHOD__, "IPBlockForm::doBlock() returned an unknown error ($retval)");\r
- }\r
- $dbw->commit();\r
- \r
- $res['id'] = $id;\r
- $res['user'] = $user;\r
- $res['reason'] = $reason;\r
- $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
- }\r
-\r
- protected function getAllowedParams() {\r
- return array (\r
- 'id' => null,\r
- 'user' => null,\r
- 'token' => null,\r
- 'gettoken' => false,\r
- 'reason' => null,\r
- );\r
- }\r
-\r
- protected function getParamDescription() {\r
- return array (\r
- 'id' => 'ID of the block you want to unblock (obtained through list=blocks). Cannot be user together with user',\r
- 'user' => 'Username, IP address or IP range you want to unblock. Cannot be used together with id',\r
- 'token' => 'An unblock token previously obtained through the gettoken parameter',\r
- 'gettoken' => 'If set, an unblock token will be returned, and no other action will be taken',\r
- 'reason' => 'Reason for unblock (optional)',\r
- );\r
- }\r
-\r
- protected function getDescription() {\r
- return array(\r
- 'Unblock a user.'\r
- );\r
- }\r
-\r
- protected function getExamples() {\r
- return array (\r
- 'api.php?action=unblock&id=105',\r
- 'api.php?action=unblock&user=Bob&reason=Sorry%20Bob'\r
- );\r
- }\r
-\r
- public function getVersion() {\r
- return __CLASS__ . ': $Id$';\r
- }\r
-}\r
+<?php
+/**
+ *
+ *
+ * Created on Sep 7, 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 unblocking of users. Requires API write mode
+ * to be enabled.
+ *
+ * @ingroup API
+ */
+class ApiUnblock extends ApiBase {
+
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
+ }
+
+ /**
+ * Unblocks the specified user or provides the reason the unblock failed.
+ */
+ public function execute() {
+ $user = $this->getUser();
+ $params = $this->extractRequestParams();
+
+ if ( $params['gettoken'] ) {
+ $res['unblocktoken'] = $user->getEditToken();
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
+ return;
+ }
+
+ if ( is_null( $params['id'] ) && is_null( $params['user'] ) ) {
+ $this->dieUsageMsg( 'unblock-notarget' );
+ }
+ if ( !is_null( $params['id'] ) && !is_null( $params['user'] ) ) {
+ $this->dieUsageMsg( 'unblock-idanduser' );
+ }
+
+ if ( !$user->isAllowed( 'block' ) ) {
+ $this->dieUsageMsg( 'cantunblock' );
+ }
+ # bug 15810: blocked admins should have limited access here
+ if ( $user->isBlocked() ) {
+ $status = SpecialBlock::checkUnblockSelf( $params['user'], $user );
+ if ( $status !== true ) {
+ $this->dieUsageMsg( $status );
+ }
+ }
+
+ $data = array(
+ 'Target' => is_null( $params['id'] ) ? $params['user'] : "#{$params['id']}",
+ 'Reason' => is_null( $params['reason'] ) ? '' : $params['reason']
+ );
+ $block = Block::newFromTarget( $data['Target'] );
+ $retval = SpecialUnblock::processUnblock( $data, $this->getContext() );
+ if ( $retval !== true ) {
+ $this->dieUsageMsg( $retval[0] );
+ }
+
+ $res['id'] = $block->getId();
+ $res['user'] = $block->getType() == Block::TYPE_AUTO ? '' : $block->getTarget();
+ $res['reason'] = $params['reason'];
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
+ }
+
+ public function mustBePosted() {
+ return true;
+ }
+
+ public function isWriteMode() {
+ return true;
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'id' => array(
+ ApiBase::PARAM_TYPE => 'integer',
+ ),
+ 'user' => null,
+ 'token' => null,
+ 'gettoken' => false,
+ 'reason' => null,
+ );
+ }
+
+ public function getParamDescription() {
+ $p = $this->getModulePrefix();
+ return array(
+ 'id' => "ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with {$p}user",
+ 'user' => "Username, IP address or IP range you want to unblock. Cannot be used together with {$p}id",
+ 'token' => "An unblock token previously obtained through the gettoken parameter or {$p}prop=info",
+ 'gettoken' => 'If set, an unblock token will be returned, and no other action will be taken',
+ 'reason' => 'Reason for unblock (optional)',
+ );
+ }
+
+ public function getDescription() {
+ return 'Unblock a user';
+ }
+
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'unblock-notarget' ),
+ array( 'unblock-idanduser' ),
+ array( 'cantunblock' ),
+ array( 'ipbblocked' ),
+ array( 'ipbnounblockself' ),
+ ) );
+ }
+
+ public function needsToken() {
+ return true;
+ }
+
+ public function getTokenSalt() {
+ return '';
+ }
+
+ public function getExamples() {
+ return array(
+ 'api.php?action=unblock&id=105',
+ 'api.php?action=unblock&user=Bob&reason=Sorry%20Bob'
+ );
+ }
+
+ 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