ApiUnblock.php

Go to the documentation of this file.

<?php
use MediaWiki\Block\Block;
use MediaWiki\Block\BlockPermissionCheckerFactory;
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\WatchlistManager;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\ExpiryDef;
 
class ApiUnblock extends ApiBase {
 
    use ApiBlockInfoTrait;
    use ApiWatchlistTrait;
 
    private BlockPermissionCheckerFactory $permissionCheckerFactory;
    private UnblockUserFactory $unblockUserFactory;
    private UserIdentityLookup $userIdentityLookup;
    private WatchedItemStoreInterface $watchedItemStore;
 
    public function __construct(
        ApiMain $main,
        $action,
        BlockPermissionCheckerFactory $permissionCheckerFactory,
        UnblockUserFactory $unblockUserFactory,
        UserIdentityLookup $userIdentityLookup,
        WatchedItemStoreInterface $watchedItemStore,
        WatchlistManager $watchlistManager,
        UserOptionsLookup $userOptionsLookup
    ) {
        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;
    }
 
    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->getName();
        }
 
        $target = $params['id'] === null ? $params['user'] : "#{$params['id']}";
 
        # T17810: blocked admins should have limited access here
        $status = $this->permissionCheckerFactory
            ->newBlockPermissionChecker(
                $target,
                $this->getAuthority()
            )->checkBlockPermissions();
        if ( $status !== true ) {
            $this->dieWithError(
                $status,
                null,
                // @phan-suppress-next-line PhanTypeMismatchArgumentNullable Block is checked and not null
                [ 'blockinfo' => $this->getBlockDetails( $performer->getBlock() ) ]
            );
        }
 
        $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;
 
        $watchlistExpiry = $this->getExpiryFromParams( $params );
        $watchuser = $params['watchuser'];
        $userPage = Title::makeTitle( NS_USER, $targetName );
        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 );
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        $params = [
            'id' => [
                ParamValidator::PARAM_TYPE => 'integer',
            ],
            'user' => [
                ParamValidator::PARAM_TYPE => 'user',
                UserDef::PARAM_ALLOWED_USER_TYPES => [ 'name', 'ip', 'temp', 'cidr', 'id' ],
            ],
            '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;
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    protected function getExamplesMessages() {
        return [
            '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/Special:MyLanguage/API:Block';
    }
}