SpecialUnblock.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use LogEventsList;
use MediaWiki\Block\Block;
use MediaWiki\Block\BlockUtils;
use MediaWiki\Block\DatabaseBlockStore;
use MediaWiki\Block\UnblockUserFactory;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Request\WebRequest;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserNamePrefixSearch;
use MediaWiki\User\UserNameUtils;
use MediaWiki\Watchlist\WatchlistManager;
use Wikimedia\IPUtils;
 
class SpecialUnblock extends SpecialPage {
 
    protected $target;
 
    protected $type;
 
    protected $block;
 
    private UnblockUserFactory $unblockUserFactory;
    private BlockUtils $blockUtils;
    private DatabaseBlockStore $blockStore;
    private UserNameUtils $userNameUtils;
    private UserNamePrefixSearch $userNamePrefixSearch;
    private WatchlistManager $watchlistManager;
 
    public function __construct(
        UnblockUserFactory $unblockUserFactory,
        BlockUtils $blockUtils,
        DatabaseBlockStore $blockStore,
        UserNameUtils $userNameUtils,
        UserNamePrefixSearch $userNamePrefixSearch,
        WatchlistManager $watchlistManager
    ) {
        parent::__construct( 'Unblock', 'block' );
        $this->unblockUserFactory = $unblockUserFactory;
        $this->blockUtils = $blockUtils;
        $this->blockStore = $blockStore;
        $this->userNameUtils = $userNameUtils;
        $this->userNamePrefixSearch = $userNamePrefixSearch;
        $this->watchlistManager = $watchlistManager;
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function execute( $par ) {
        $this->checkPermissions();
        $this->checkReadOnly();
 
        [ $this->target, $this->type ] = $this->getTargetAndType( $par, $this->getRequest() );
        $this->block = $this->blockStore->newFromTarget( $this->target );
        if ( $this->target instanceof UserIdentity ) {
            // 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->setPageTitleMsg( $this->msg( 'unblockip' ) );
        $out->addModules( [ 'mediawiki.userSuggest', 'mediawiki.special.block' ] );
 
        $form = HTMLForm::factory( 'ooui', $this->getFields(), $this->getContext() )
            ->setWrapperLegendMsg( 'unblockip' )
            ->setSubmitCallback( function ( array $data, HTMLForm $form ) {
                if ( $this->type != Block::TYPE_RANGE
                    && $this->type != Block::TYPE_AUTO
                    && $data['Watch']
                ) {
                    $this->watchlistManager->addWatchIgnoringRights(
                        $form->getUser(),
                        Title::makeTitle( NS_USER, $this->target )
                    );
                }
                return $this->unblockUserFactory->newUnblockUser(
                    $data['Target'],
                    $form->getContext()->getAuthority(),
                    $data['Reason'],
                    $data['Tags'] ?? []
                )->unblock();
            } )
            ->setSubmitTextMsg( 'ipusubmit' )
            ->addPreHtml( $this->msg( 'unblockiptext' )->parseAsBlock() );
 
        $userPage = $this->getTargetUserTitle( $this->target );
        if ( $userPage ) {
            // Get relevant extracts from the block and suppression logs, if possible
            $logExtract = '';
            LogEventsList::showLogExtract(
                $logExtract,
                'block',
                $userPage,
                '',
                [
                    'lim' => 10,
                    'msgKey' => [
                        'unblocklog-showlog',
                        $userPage->getText(),
                    ],
                    'showIfEmpty' => false
                ]
            );
            if ( $logExtract !== '' ) {
                $form->addPostHtml( $logExtract );
            }
 
            // Add suppression block entries if allowed
            if ( $this->getAuthority()->isAllowed( 'suppressionlog' ) ) {
                $logExtract = '';
                LogEventsList::showLogExtract(
                    $logExtract,
                    'suppress',
                    $userPage,
                    '',
                    [
                        'lim' => 10,
                        'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
                        'msgKey' => [
                            'unblocklog-showsuppresslog',
                            $userPage->getText(),
                        ],
                        'showIfEmpty' => false
                    ]
                );
                if ( $logExtract !== '' ) {
                    $form->addPostHtml( $logExtract );
                }
            }
        }
 
        if ( $form->show() ) {
            switch ( $this->type ) {
                case Block::TYPE_IP:
                    $out->addWikiMsg( 'unblocked-ip', wfEscapeWikiText( $this->target ) );
                    break;
                case Block::TYPE_USER:
                    $out->addWikiMsg( 'unblocked', wfEscapeWikiText( $this->target ) );
                    break;
                case Block::TYPE_RANGE:
                    $out->addWikiMsg( 'unblocked-range', wfEscapeWikiText( $this->target ) );
                    break;
                case Block::TYPE_ID:
                case Block::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;
    }
 
    private function getTargetUserTitle( $target ): ?Title {
        if ( $target instanceof UserIdentity ) {
            return Title::makeTitle( NS_USER, $target->getName() );
        }
 
        if ( is_string( $target ) && IPUtils::isIPAddress( $target ) ) {
            return Title::makeTitle( NS_USER, $target );
        }
 
        return null;
    }
 
    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 Block ) {
            $type = $this->block->getType();
            $targetName = $this->block->getTargetName();
 
            // 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 == Block::TYPE_AUTO && $this->type == Block::TYPE_IP ) {
                $fields['Target']['default'] = $this->target;
                unset( $fields['Name'] );
            } else {
                $fields['Target']['default'] = $targetName;
                $fields['Target']['type'] = 'hidden';
                switch ( $type ) {
                    case Block::TYPE_IP:
                        $fields['Name']['default'] = $this->getLinkRenderer()->makeKnownLink(
                            $this->getSpecialPageFactory()->getTitleForAlias( 'Contributions/' . $targetName ),
                            $targetName
                        );
                        $fields['Name']['raw'] = true;
                        break;
                    case Block::TYPE_USER:
                        $fields['Name']['default'] = $this->getLinkRenderer()->makeLink(
                            new TitleValue( NS_USER, $targetName ),
                            $targetName
                        );
                        $fields['Name']['raw'] = true;
                        break;
 
                    case Block::TYPE_RANGE:
                        $fields['Name']['default'] = $targetName;
                        break;
 
                    case Block::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'] );
        }
        // Watchlist their user page? (Only if user is logged in)
        if ( $this->getUser()->isRegistered() ) {
            $fields['Watch'] = [
                'type' => 'check',
                'label-message' => 'ipbwatchuser',
            ];
        }
 
        return $fields;
    }
 
    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';
    }
}
 
class_alias( SpecialUnblock::class, 'SpecialUnblock' );