includes/specials/SpecialAutoblockList.php

   1 <?php
   2 /**
   3  * Implements Special:AutoblockList
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * A special page that lists autoblocks
  26  *
  27  * @since 1.29
  28  * @ingroup SpecialPage
  29  */
  30 class SpecialAutoblockList extends SpecialPage {
  31
  32         function __construct() {
  33                 parent::__construct( 'AutoblockList' );
  34         }
  35
  36         /**
  37          * Main execution point
  38          *
  39          * @param string $par Title fragment
  40          */
  41         public function execute( $par ) {
  42                 $this->setHeaders();
  43                 $this->outputHeader();
  44                 $out = $this->getOutput();
  45                 $lang = $this->getLanguage();
  46                 $out->setPageTitle( $this->msg( 'autoblocklist' ) );
  47                 $this->addHelpLink( 'Autoblock' );
  48                 $out->addModuleStyles( [ 'mediawiki.special' ] );
  49
  50                 # setup BlockListPager here to get the actual default Limit
  51                 $pager = $this->getBlockListPager();
  52
  53                 # Just show the block list
  54                 $fields = [
  55                         'Limit' => [
  56                                 'type' => 'limitselect',
  57                                 'label-message' => 'table_pager_limit_label',
  58                                 'options' => [
  59                                         $lang->formatNum( 20 ) => 20,
  60                                         $lang->formatNum( 50 ) => 50,
  61                                         $lang->formatNum( 100 ) => 100,
  62                                         $lang->formatNum( 250 ) => 250,
  63                                         $lang->formatNum( 500 ) => 500,
  64                                 ],
  65                                 'name' => 'limit',
  66                                 'default' => $pager->getLimit(),
  67                         ]
  68                 ];
  69
  70                 $context = new DerivativeContext( $this->getContext() );
  71                 $context->setTitle( $this->getPageTitle() ); // Remove subpage
  72                 $form = HTMLForm::factory( 'ooui', $fields, $context );
  73                 $form->setMethod( 'get' )
  74                         ->setFormIdentifier( 'blocklist' )
  75                         ->setWrapperLegendMsg( 'autoblocklist-legend' )
  76                         ->setSubmitTextMsg( 'autoblocklist-submit' )
  77                         ->setSubmitProgressive()
  78                         ->prepareForm()
  79                         ->displayForm( false );
  80
  81                 $this->showTotal( $pager );
  82                 $this->showList( $pager );
  83         }
  84
  85         /**
  86          * Setup a new BlockListPager instance.
  87          * @return BlockListPager
  88          */
  89         protected function getBlockListPager() {
  90                 $conds = [
  91                         'ipb_parent_block_id IS NOT NULL'
  92                 ];
  93                 # Is the user allowed to see hidden blocks?
  94                 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
  95                         $conds['ipb_deleted'] = 0;
  96                 }
  97
  98                 return new BlockListPager( $this, $conds );
  99         }
 100
 101         /**
 102          * Show total number of autoblocks on top of the table
 103          *
 104          * @param BlockListPager $pager The BlockListPager instance for this page
 105          */
 106         protected function showTotal( BlockListPager $pager ) {
 107                 $out = $this->getOutput();
 108                 $out->addHTML(
 109                         Html::element( 'div', [ 'style' => 'font-weight: bold;' ],
 110                                 $this->msg( 'autoblocklist-total-autoblocks', $pager->getTotalAutoblocks() )->parse() )
 111                         . "\n"
 112                 );
 113         }
 114
 115         /**
 116          * Show the list of blocked accounts matching the actual filter.
 117          * @param BlockListPager $pager The BlockListPager instance for this page
 118          */
 119         protected function showList( BlockListPager $pager ) {
 120                 $out = $this->getOutput();
 121
 122                 # Check for other blocks, i.e. global/tor blocks
 123                 $otherAutoblockLink = [];
 124                 Hooks::run( 'OtherAutoblockLogLink', [ &$otherAutoblockLink ] );
 125
 126                 # Show additional header for the local block only when other blocks exists.
 127                 # Not necessary in a standard installation without such extensions enabled
 128                 if ( count( $otherAutoblockLink ) ) {
 129                         $out->addHTML(
 130                                 Html::element( 'h2', [], $this->msg( 'autoblocklist-localblocks',
 131                                         $pager->getNumRows() )->parse() )
 132                                 . "\n"
 133                         );
 134                 }
 135
 136                 if ( $pager->getNumRows() ) {
 137                         $out->addParserOutputContent( $pager->getFullOutput() );
 138                 } else {
 139                         $out->addWikiMsg( 'autoblocklist-empty' );
 140                 }
 141
 142                 if ( count( $otherAutoblockLink ) ) {
 143                         $out->addHTML(
 144                                 Html::rawElement(
 145                                         'h2',
 146                                         [],
 147                                         $this->msg( 'autoblocklist-otherblocks', count( $otherAutoblockLink ) )->parse()
 148                                 ) . "\n"
 149                         );
 150                         $list = '';
 151                         foreach ( $otherAutoblockLink as $link ) {
 152                                 $list .= Html::rawElement( 'li', [], $link ) . "\n";
 153                         }
 154                         $out->addHTML(
 155                                 Html::rawElement(
 156                                         'ul',
 157                                         [ 'class' => 'mw-autoblocklist-otherblocks' ],
 158                                         $list
 159                                 ) . "\n"
 160                         );
 161                 }
 162         }
 163
 164         protected function getGroupName() {
 165                 return 'users';
 166         }
 167 }