f62bc7536e
ApiBase declares it protected, but for some reason I had made it public in all subclasses. Change-Id: I8a50d4f47e66c7f09137968d3941dc5cdc1d28e4
112 lines
3 KiB
PHP
112 lines
3 KiB
PHP
<?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 {
|
|
|
|
/**
|
|
* Unblocks the specified user or provides the reason the unblock failed.
|
|
*/
|
|
public function execute() {
|
|
$user = $this->getUser();
|
|
$params = $this->extractRequestParams();
|
|
|
|
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' => $params['reason']
|
|
);
|
|
$block = Block::newFromTarget( $data['Target'] );
|
|
$retval = SpecialUnblock::processUnblock( $data, $this->getContext() );
|
|
if ( $retval !== true ) {
|
|
$this->dieUsageMsg( $retval[0] );
|
|
}
|
|
|
|
$res['id'] = $block->getId();
|
|
$target = $block->getType() == Block::TYPE_AUTO ? '' : $block->getTarget();
|
|
$res['user'] = $target instanceof User ? $target->getName() : $target;
|
|
$res['userid'] = $target instanceof User ? $target->getId() : 0;
|
|
$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,
|
|
'reason' => '',
|
|
);
|
|
}
|
|
|
|
public function needsToken() {
|
|
return 'csrf';
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return array(
|
|
'action=unblock&id=105'
|
|
=> 'apihelp-unblock-example-id',
|
|
'action=unblock&user=Bob&reason=Sorry%20Bob'
|
|
=> 'apihelp-unblock-example-user',
|
|
);
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/API:Block';
|
|
}
|
|
}
|