SpecialAutoblockList.php

Go to the documentation of this file.

<?php
use MediaWiki\Block\BlockActionInfo;
use MediaWiki\Block\BlockRestrictionStore;
use MediaWiki\Block\BlockUtils;
use MediaWiki\Cache\LinkBatchFactory;
use Wikimedia\Rdbms\ILoadBalancer;
 
class SpecialAutoblockList extends SpecialPage {
 
    private $linkBatchFactory;
 
    private $blockRestrictionStore;
 
    private $loadBalancer;
 
    private $commentStore;
 
    private $blockUtils;
 
    private $blockActionInfo;
 
    public function __construct(
        LinkBatchFactory $linkBatchFactory,
        BlockRestrictionStore $blockRestrictionStore,
        ILoadBalancer $loadBalancer,
        CommentStore $commentStore,
        BlockUtils $blockUtils,
        BlockActionInfo $blockActionInfo
    ) {
        parent::__construct( 'AutoblockList' );
 
        $this->linkBatchFactory = $linkBatchFactory;
        $this->blockRestrictionStore = $blockRestrictionStore;
        $this->loadBalancer = $loadBalancer;
        $this->commentStore = $commentStore;
        $this->blockUtils = $blockUtils;
        $this->blockActionInfo = $blockActionInfo;
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
        $out = $this->getOutput();
        $out->setPageTitle( $this->msg( 'autoblocklist' ) );
        $this->addHelpLink( 'Autoblock' );
        $out->addModuleStyles( [ 'mediawiki.special' ] );
 
        # setup BlockListPager here to get the actual default Limit
        $pager = $this->getBlockListPager();
 
        # Just show the block list
        $fields = [
            'Limit' => [
                'type' => 'limitselect',
                'label-message' => 'table_pager_limit_label',
                'options' => $pager->getLimitSelectList(),
                'name' => 'limit',
                'default' => $pager->getLimit(),
            ]
        ];
 
        $context = new DerivativeContext( $this->getContext() );
        $context->setTitle( $this->getPageTitle() ); // Remove subpage
        $form = HTMLForm::factory( 'ooui', $fields, $context );
        $form->setMethod( 'get' )
            ->setFormIdentifier( 'blocklist' )
            ->setWrapperLegendMsg( 'autoblocklist-legend' )
            ->setSubmitTextMsg( 'autoblocklist-submit' )
            ->prepareForm()
            ->displayForm( false );
 
        $this->showTotal( $pager );
        $this->showList( $pager );
    }
 
    protected function getBlockListPager() {
        $conds = [
            'ipb_parent_block_id IS NOT NULL'
        ];
        # Is the user allowed to see hidden blocks?
        if ( !$this->getAuthority()->isAllowed( 'hideuser' ) ) {
            $conds['ipb_deleted'] = 0;
        }
 
        return new BlockListPager(
            $this,
            $conds,
            $this->linkBatchFactory,
            $this->blockRestrictionStore,
            $this->loadBalancer,
            $this->getSpecialPageFactory(),
            $this->commentStore,
            $this->blockUtils,
            $this->blockActionInfo
        );
    }
 
    protected function showTotal( BlockListPager $pager ) {
        $out = $this->getOutput();
        $out->addHTML(
            Html::rawElement( 'div', [ 'style' => 'font-weight: bold;' ],
                $this->msg( 'autoblocklist-total-autoblocks', $pager->getTotalAutoblocks() )->parse() )
            . "\n"
        );
    }
 
    protected function showList( BlockListPager $pager ) {
        $out = $this->getOutput();
 
        # Check for other blocks, i.e. global/tor blocks
        $otherAutoblockLink = [];
        $this->getHookRunner()->onOtherAutoblockLogLink( $otherAutoblockLink );
 
        # Show additional header for the local block only when other blocks exists.
        # Not necessary in a standard installation without such extensions enabled
        if ( count( $otherAutoblockLink ) ) {
            $out->addHTML(
                Html::rawElement( 'h2', [], $this->msg( 'autoblocklist-localblocks',
                    $pager->getNumRows() )->parse() )
                . "\n"
            );
        }
 
        if ( $pager->getNumRows() ) {
            $out->addParserOutputContent( $pager->getFullOutput() );
        } else {
            $out->addWikiMsg( 'autoblocklist-empty' );
        }
 
        if ( count( $otherAutoblockLink ) ) {
            $out->addHTML(
                Html::rawElement(
                    'h2',
                    [],
                    $this->msg( 'autoblocklist-otherblocks', count( $otherAutoblockLink ) )->parse()
                ) . "\n"
            );
            $list = '';
            foreach ( $otherAutoblockLink as $link ) {
                $list .= Html::rawElement( 'li', [], $link ) . "\n";
            }
            $out->addHTML(
                Html::rawElement(
                    'ul',
                    [ 'class' => 'mw-autoblocklist-otherblocks' ],
                    $list
                ) . "\n"
            );
        }
    }
 
    protected function getGroupName() {
        return 'users';
    }
}