ApiUnblock.php

Go to the documentation of this file.

<?php
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\ParamValidator\TypeDef\UserDef;
 
class ApiUnblock extends ApiBase {
 
    use ApiBlockInfoTrait;
 
    public function execute() {
        $user = $this->getUser();
        $params = $this->extractRequestParams();
 
        $this->requireOnlyOneParameter( $params, 'id', 'user', 'userid' );
 
        if ( !$this->getPermissionManager()->userHasRight( $user, 'block' ) ) {
            $this->dieWithError( 'apierror-permissiondenied-unblock', 'permissiondenied' );
        }
        # T17810: blocked admins should have limited access here
        $block = $user->getBlock();
        if ( $block ) {
            $status = SpecialBlock::checkUnblockSelf( $params['user'], $user );
            if ( $status !== true ) {
                $this->dieWithError(
                    $status,
                    null,
                    [ 'blockinfo' => $this->getBlockDetails( $block ) ]
                );
            }
        }
 
        // Check if user can add tags
        if ( $params['tags'] !== null ) {
            $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
            if ( !$ableToTag->isOK() ) {
                $this->dieStatus( $ableToTag );
            }
        }
 
        if ( $params['userid'] !== null ) {
            $username = User::whoIs( $params['userid'] );
 
            if ( $username === false ) {
                $this->dieWithError( [ 'apierror-nosuchuserid', $params['userid'] ], 'nosuchuserid' );
            } else {
                $params['user'] = $username;
            }
        }
 
        $data = [
            'Target' => $params['id'] === null ? $params['user'] : "#{$params['id']}",
            'Reason' => $params['reason'],
            'Tags' => $params['tags']
        ];
        $block = DatabaseBlock::newFromTarget( $data['Target'] );
        $retval = SpecialUnblock::processUnblock( $data, $this->getContext() );
        if ( $retval !== true ) {
            $this->dieStatus( $this->errorArrayToStatus( $retval ) );
        }
 
        $target = $block->getType() == DatabaseBlock::TYPE_AUTO ? '' : $block->getTarget();
        $res = [
            'id' => $block->getId(),
            'user' => $target instanceof User ? $target->getName() : $target,
            'userid' => $target instanceof User ? $target->getId() : 0,
            'reason' => $params['reason']
        ];
        $this->getResult()->addValue( null, $this->getModuleName(), $res );
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'id' => [
                ApiBase::PARAM_TYPE => 'integer',
            ],
            'user' => [
                ApiBase::PARAM_TYPE => 'user',
                UserDef::PARAM_ALLOWED_USER_TYPES => [ 'name', 'ip', 'cidr', 'id' ],
            ],
            'userid' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_DEPRECATED => true,
            ],
            'reason' => '',
            'tags' => [
                ApiBase::PARAM_TYPE => 'tags',
                ApiBase::PARAM_ISMULTI => true,
            ],
        ];
    }
 
    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';
    }
}