ApiUnblock.php

Go to the documentation of this file.

<?php
class ApiUnblock extends ApiBase {

    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,
            'token' => null,
            'reason' => '',
        );
    }

    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 prop=info",
            'reason' => 'Reason for unblock',
        );
    }

    public function getResultProperties() {
        return array(
            '' => array(
                'id' => array(
                    ApiBase::PROP_TYPE => 'integer',
                    ApiBase::PROP_NULLABLE => true
                ),
                'user' => array(
                    ApiBase::PROP_TYPE => 'string',
                    ApiBase::PROP_NULLABLE => true
                ),
                'userid' => array(
                    ApiBase::PROP_TYPE => 'integer',
                    ApiBase::PROP_NULLABLE => true
                ),
                'reason' => array(
                    ApiBase::PROP_TYPE => 'string',
                    ApiBase::PROP_NULLABLE => true
                )
            )
        );
    }

    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';
    }
}