Page MenuHomeWickedGov Phorge
Files F4152972

ApiUnblock.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

ApiUnblock.php
View Options

<?php
/**
* Copyright © 2007 Roan Kattouw <roan.kattouw@gmail.com>
*
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\Block\Block;
use MediaWiki\Block\BlockPermissionCheckerFactory;
use MediaWiki\Block\BlockTargetFactory;
use MediaWiki\Block\DatabaseBlockStore;
use MediaWiki\Block\UnblockUserFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\ParamValidator\TypeDef\UserDef;
use MediaWiki\Title\Title;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\User\UserIdentityLookup;
use MediaWiki\Watchlist\WatchedItemStoreInterface;
use MediaWiki\Watchlist\WatchlistManager;
use RuntimeException;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\ExpiryDef;
/**
* API module that facilitates the unblocking of users. Requires API write mode
* to be enabled.
*
* @ingroup API
*/
class ApiUnblock extends ApiBase {
use ApiBlockInfoTrait;
use ApiWatchlistTrait;
private BlockPermissionCheckerFactory $permissionCheckerFactory;
private UnblockUserFactory $unblockUserFactory;
private UserIdentityLookup $userIdentityLookup;
private WatchedItemStoreInterface $watchedItemStore;
private DatabaseBlockStore $blockStore;
private BlockTargetFactory $blockTargetFactory;
public function __construct(
ApiMain $main,
string $action,
BlockPermissionCheckerFactory $permissionCheckerFactory,
UnblockUserFactory $unblockUserFactory,
UserIdentityLookup $userIdentityLookup,
WatchedItemStoreInterface $watchedItemStore,
WatchlistManager $watchlistManager,
UserOptionsLookup $userOptionsLookup,
DatabaseBlockStore $blockStore,
BlockTargetFactory $blockTargetFactory
) {
parent::__construct( $main, $action );
$this->permissionCheckerFactory = $permissionCheckerFactory;
$this->unblockUserFactory = $unblockUserFactory;
$this->userIdentityLookup = $userIdentityLookup;
$this->watchedItemStore = $watchedItemStore;
// Variables needed in ApiWatchlistTrait trait
$this->watchlistExpiryEnabled = $this->getConfig()->get( MainConfigNames::WatchlistExpiry );
$this->watchlistMaxDuration =
$this->getConfig()->get( MainConfigNames::WatchlistExpiryMaxDuration );
$this->watchlistManager = $watchlistManager;
$this->userOptionsLookup = $userOptionsLookup;
$this->blockStore = $blockStore;
$this->blockTargetFactory = $blockTargetFactory;
}
/**
* Unblocks the specified user or provides the reason the unblock failed.
*/
public function execute() {
$performer = $this->getUser();
$params = $this->extractRequestParams();
$this->requireOnlyOneParameter( $params, 'id', 'user', 'userid' );
if ( !$this->getAuthority()->isAllowed( 'block' ) ) {
$this->dieWithError( 'apierror-permissiondenied-unblock', 'permissiondenied' );
}
if ( $params['userid'] !== null ) {
$identity = $this->userIdentityLookup->getUserIdentityByUserId( $params['userid'] );
if ( !$identity ) {
$this->dieWithError( [ 'apierror-nosuchuserid', $params['userid'] ], 'nosuchuserid' );
}
$params['user'] = $identity;
}
$blockToRemove = null;
if ( $params['id'] !== null ) {
$blockToRemove = $this->blockStore->newFromID( $params['id'], true );
if ( !$blockToRemove ) {
$this->dieWithError(
[ 'apierror-nosuchblockid', $params['id'] ],
'nosuchblockid' );
}
$target = $blockToRemove->getRedactedTarget();
if ( !$target ) {
throw new RuntimeException( 'Block has no target' );
}
} else {
$target = $this->blockTargetFactory->newFromUser( $params['user'] );
}
# T17810: blocked admins should have limited access here
$status = $this->permissionCheckerFactory
->newChecker(
$this->getAuthority()
)->checkBlockPermissions( $target );
if ( $status !== true ) {
$this->dieWithError(
$status,
null,
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable Block is checked and not null
[ 'blockinfo' => $this->getBlockDetails( $performer->getBlock() ) ]
);
}
if ( $blockToRemove !== null ) {
$status = $this->unblockUserFactory->newRemoveBlock(
$blockToRemove,
$this->getAuthority(),
$params['reason'],
$params['tags'] ?? []
)->unblock();
} else {
$status = $this->unblockUserFactory->newUnblockUser(
$target,
$this->getAuthority(),
$params['reason'],
$params['tags'] ?? []
)->unblock();
}
if ( !$status->isOK() ) {
$this->dieStatus( $status );
}
$block = $status->getValue();
$targetType = $block->getType();
$targetName = $targetType === Block::TYPE_AUTO ? '' : $block->getTargetName();
$targetUserId = $block->getTargetUserIdentity() ? $block->getTargetUserIdentity()->getId() : 0;
$userPage = Title::makeTitle( NS_USER, $targetName );
$watchlistExpiry = $this->getExpiryFromParams( $params, $userPage, $this->getUser() );
$watchuser = $params['watchuser'];
if ( $watchuser && $targetType !== Block::TYPE_RANGE && $targetType !== Block::TYPE_AUTO ) {
$this->setWatch( 'watch', $userPage, $this->getUser(), null, $watchlistExpiry );
} else {
$watchuser = false;
$watchlistExpiry = null;
}
$res = [
'id' => $block->getId(),
'user' => $targetName,
'userid' => $targetUserId,
'reason' => $params['reason'],
'watchuser' => $watchuser,
];
if ( $watchlistExpiry !== null ) {
$res['watchlistexpiry'] = $this->getWatchlistExpiry(
$this->watchedItemStore,
$userPage,
$this->getUser()
);
}
$this->getResult()->addValue( null, $this->getModuleName(), $res );
}
/** @inheritDoc */
public function mustBePosted() {
return true;
}
/** @inheritDoc */
public function isWriteMode() {
return true;
}
/** @inheritDoc */
public function getAllowedParams() {
$params = [
'id' => [
ParamValidator::PARAM_TYPE => 'integer',
],
'user' => [
ParamValidator::PARAM_TYPE => 'user',
UserDef::PARAM_ALLOWED_USER_TYPES => [ 'name', 'ip', 'temp', 'cidr', 'id' ],
UserDef::PARAM_RETURN_OBJECT => true,
],
'userid' => [
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_DEPRECATED => true,
],
'reason' => '',
'tags' => [
ParamValidator::PARAM_TYPE => 'tags',
ParamValidator::PARAM_ISMULTI => true,
],
'watchuser' => false,
];
// Params appear in the docs in the order they are defined,
// which is why this is here and not at the bottom.
// @todo Find better way to support insertion at arbitrary position
if ( $this->watchlistExpiryEnabled ) {
$params += [
'watchlistexpiry' => [
ParamValidator::PARAM_TYPE => 'expiry',
ExpiryDef::PARAM_MAX => $this->watchlistMaxDuration,
ExpiryDef::PARAM_USE_MAX => true,
]
];
}
return $params;
}
/** @inheritDoc */
public function needsToken() {
return 'csrf';
}
/** @inheritDoc */
protected function getExamplesMessages() {
return [
'action=unblock&id=105'
=> 'apihelp-unblock-example-id',
'action=unblock&user=Bob&reason=Sorry%20Bob'
=> 'apihelp-unblock-example-user',
];
}
/** @inheritDoc */
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Block';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiUnblock::class, 'ApiUnblock' );

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 20:34 (7 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
80/dd/a31a64ae2388cf77e96517c51bd5
Default Alt Text
ApiUnblock.php (7 KB)

Event Timeline