SpecialUnblock.php

Go to the documentation of this file.

<?php
use MediaWiki\Block\BlockUtils;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Block\UnblockUserFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserNamePrefixSearch;
use MediaWiki\User\UserNameUtils;
 
class SpecialUnblock extends SpecialPage {
 
    protected $target;
    protected $type;
    protected $block;
 
    private $unblockUserFactory;
 
    private $blockUtils;
 
    private $userNameUtils;
 
    private $userNamePrefixSearch;
 
    public function __construct(
        UnblockUserFactory $unblockUserFactory,
        BlockUtils $blockUtils,
        UserNameUtils $userNameUtils,
        UserNamePrefixSearch $userNamePrefixSearch
    ) {
        parent::__construct( 'Unblock', 'block' );
        $this->unblockUserFactory = $unblockUserFactory;
        $this->blockUtils = $blockUtils;
        $this->userNameUtils = $userNameUtils;
        $this->userNamePrefixSearch = $userNamePrefixSearch;
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function execute( $par ) {
        $this->checkPermissions();
        $this->checkReadOnly();
 
        list( $this->target, $this->type ) = $this->getTargetAndType( $par, $this->getRequest() );
        $this->block = DatabaseBlock::newFromTarget( $this->target );
        if ( $this->target instanceof User ) {
            # Set the 'relevant user' in the skin, so it displays links like Contributions,
            # User logs, UserRights, etc.
            $this->getSkin()->setRelevantUser( $this->target );
        }
 
        $this->setHeaders();
        $this->outputHeader();
        $this->addHelpLink( 'Help:Blocking users' );
 
        $out = $this->getOutput();
        $out->setPageTitle( $this->msg( 'unblockip' ) );
        $out->addModules( [ 'mediawiki.userSuggest' ] );
 
        $form = HTMLForm::factory( 'ooui', $this->getFields(), $this->getContext() )
            ->setWrapperLegendMsg( 'unblockip' )
            ->setSubmitCallback( function ( array $data, HTMLForm $form ) {
                return $this->unblockUserFactory->newUnblockUser(
                    $data['Target'],
                    $form->getContext()->getUser(),
                    $data['Reason'],
                    $data['Tags'] ?? []
                )->unblock();
            } )
            ->setSubmitTextMsg( 'ipusubmit' )
            ->addPreText( $this->msg( 'unblockiptext' )->parseAsBlock() );
 
        if ( $form->show() ) {
            switch ( $this->type ) {
                case DatabaseBlock::TYPE_IP:
                    $out->addWikiMsg( 'unblocked-ip', wfEscapeWikiText( $this->target ) );
                    break;
                case DatabaseBlock::TYPE_USER:
                    $out->addWikiMsg( 'unblocked', wfEscapeWikiText( $this->target ) );
                    break;
                case DatabaseBlock::TYPE_RANGE:
                    $out->addWikiMsg( 'unblocked-range', wfEscapeWikiText( $this->target ) );
                    break;
                case DatabaseBlock::TYPE_ID:
                case DatabaseBlock::TYPE_AUTO:
                    $out->addWikiMsg( 'unblocked-id', wfEscapeWikiText( $this->target ) );
                    break;
            }
        }
    }
 
    private function getTargetAndType( ?string $par, WebRequest $request ) {
        $possibleTargets = [
            $request->getVal( 'wpTarget', null ),
            $par,
            $request->getVal( 'ip', null ),
            // B/C @since 1.18
            $request->getVal( 'wpBlockAddress', null ),
        ];
        foreach ( $possibleTargets as $possibleTarget ) {
            $targetAndType = $this->blockUtils->parseBlockTarget( $possibleTarget );
            // If type is not null then target is valid
            if ( $targetAndType[ 1 ] !== null ) {
                break;
            }
        }
        return $targetAndType;
    }
 
    protected function getFields() {
        $fields = [
            'Target' => [
                'type' => 'text',
                'label-message' => 'ipaddressorusername',
                'autofocus' => true,
                'size' => '45',
                'required' => true,
                'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
            ],
            'Name' => [
                'type' => 'info',
                'label-message' => 'ipaddressorusername',
            ],
            'Reason' => [
                'type' => 'text',
                'label-message' => 'ipbreason',
            ]
        ];
 
        if ( $this->block instanceof DatabaseBlock ) {
            list( $target, $type ) = $this->block->getTargetAndType();
 
            # Autoblocks are logged as "autoblock #123 because the IP was recently used by
            # User:Foo, and we've just got any block, auto or not, that applies to a target
            # the user has specified.  Someone could be fishing to connect IPs to autoblocks,
            # so don't show any distinction between unblocked IPs and autoblocked IPs
            if ( $type == DatabaseBlock::TYPE_AUTO && $this->type == DatabaseBlock::TYPE_IP ) {
                $fields['Target']['default'] = $this->target;
                unset( $fields['Name'] );
            } else {
                $fields['Target']['default'] = $target;
                $fields['Target']['type'] = 'hidden';
                switch ( $type ) {
                    case DatabaseBlock::TYPE_IP:
                        $fields['Name']['default'] = $this->getLinkRenderer()->makeKnownLink(
                            $this->getSpecialPageFactory()->getTitleForAlias( 'Contributions/' . $target->getName() ),
                            $target->getName()
                        );
                        $fields['Name']['raw'] = true;
                        break;
                    case DatabaseBlock::TYPE_USER:
                        $fields['Name']['default'] = $this->getLinkRenderer()->makeLink(
                            $target->getUserPage(),
                            $target->getName()
                        );
                        $fields['Name']['raw'] = true;
                        break;
 
                    case DatabaseBlock::TYPE_RANGE:
                        $fields['Name']['default'] = $target;
                        break;
 
                    case DatabaseBlock::TYPE_AUTO:
                        $fields['Name']['default'] = $this->block->getRedactedName();
                        $fields['Name']['raw'] = true;
                        # Don't expose the real target of the autoblock
                        $fields['Target']['default'] = "#{$this->target}";
                        break;
                }
                // target is hidden, so the reason is the first element
                $fields['Target']['autofocus'] = false;
                $fields['Reason']['autofocus'] = true;
            }
        } else {
            $fields['Target']['default'] = $this->target;
            unset( $fields['Name'] );
        }
 
        return $fields;
    }
 
    public static function processUnblock( array $data, IContextSource $context ) {
        wfDeprecated( __METHOD__, '1.36' );
 
        if ( !isset( $data['Tags'] ) ) {
            $data['Tags'] = [];
        }
 
        $unblockUser = MediaWikiServices::getInstance()->getUnblockUserFactory()->newUnblockUser(
            $data['Target'],
            $context->getUser(),
            $data['Reason'],
            $data['Tags']
        );
 
        $status = $unblockUser->unblock();
        if ( !$status->isOK() ) {
            return $status->getErrorsArray();
        }
 
        return true;
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $search = $this->userNameUtils->getCanonical( $search );
        if ( !$search ) {
            // No prefix suggestion for invalid user
            return [];
        }
        // Autocomplete subpage as user list - public to allow caching
        return $this->userNamePrefixSearch
            ->search( UserNamePrefixSearch::AUDIENCE_PUBLIC, $search, $limit, $offset );
    }
 
    protected function getGroupName() {
        return 'users';
    }
}