includes/specials/SpecialProtectedpages.php

   1 <?php
   2 /**
   3  * Implements Special:Protectedpages
   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 protected pages
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialProtectedpages extends SpecialPage {
  30         protected $IdLevel = 'level';
  31         protected $IdType = 'type';
  32
  33         public function __construct() {
  34                 parent::__construct( 'Protectedpages' );
  35         }
  36
  37         public function execute( $par ) {
  38                 $this->setHeaders();
  39                 $this->outputHeader();
  40                 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
  41
  42                 $request = $this->getRequest();
  43                 $type = $request->getVal( $this->IdType );
  44                 $level = $request->getVal( $this->IdLevel );
  45                 $sizetype = $request->getVal( 'size-mode' );
  46                 $size = $request->getIntOrNull( 'size' );
  47                 $ns = $request->getIntOrNull( 'namespace' );
  48                 $indefOnly = $request->getBool( 'indefonly' ) ? 1 : 0;
  49                 $cascadeOnly = $request->getBool( 'cascadeonly' ) ? 1 : 0;
  50                 $noRedirect = $request->getBool( 'noredirect' ) ? 1 : 0;
  51
  52                 $pager = new ProtectedPagesPager(
  53                         $this,
  54                         [],
  55                         $type,
  56                         $level,
  57                         $ns,
  58                         $sizetype,
  59                         $size,
  60                         $indefOnly,
  61                         $cascadeOnly,
  62                         $noRedirect,
  63                         $this->getLinkRenderer()
  64                 );
  65
  66                 $this->getOutput()->addHTML( $this->showOptions(
  67                         $ns,
  68                         $type,
  69                         $level,
  70                         $sizetype,
  71                         $size,
  72                         $indefOnly,
  73                         $cascadeOnly,
  74                         $noRedirect
  75                 ) );
  76
  77                 if ( $pager->getNumRows() ) {
  78                         $this->getOutput()->addParserOutputContent( $pager->getFullOutput() );
  79                 } else {
  80                         $this->getOutput()->addWikiMsg( 'protectedpagesempty' );
  81                 }
  82         }
  83
  84         /**
  85          * @param int $namespace
  86          * @param string $type Restriction type
  87          * @param string $level Restriction level
  88          * @param string $sizetype "min" or "max"
  89          * @param int $size
  90          * @param bool $indefOnly Only indefinite protection
  91          * @param bool $cascadeOnly Only cascading protection
  92          * @param bool $noRedirect Don't show redirects
  93          * @return string Input form
  94          */
  95         protected function showOptions( $namespace, $type = 'edit', $level, $sizetype,
  96                 $size, $indefOnly, $cascadeOnly, $noRedirect
  97         ) {
  98                 $formDescriptor = [
  99                         'namespace' => [
 100                                 'class' => HTMLSelectNamespace::class,
 101                                 'name' => 'namespace',
 102                                 'id' => 'namespace',
 103                                 'cssclass' => 'namespaceselector',
 104                                 'all' => '',
 105                                 'label' => $this->msg( 'namespace' )->text(),
 106                         ],
 107                         'typemenu' => $this->getTypeMenu( $type ),
 108                         'levelmenu' => $this->getLevelMenu( $level ),
 109                         'expirycheck' => [
 110                                 'type' => 'check',
 111                                 'label' => $this->msg( 'protectedpages-indef' )->text(),
 112                                 'name' => 'indefonly',
 113                                 'id' => 'indefonly',
 114                         ],
 115                         'cascadecheck' => [
 116                                 'type' => 'check',
 117                                 'label' => $this->msg( 'protectedpages-cascade' )->text(),
 118                                 'name' => 'cascadeonly',
 119                                 'id' => 'cascadeonly',
 120                         ],
 121                         'redirectcheck' => [
 122                                 'type' => 'check',
 123                                 'label' => $this->msg( 'protectedpages-noredirect' )->text(),
 124                                 'name' => 'noredirect',
 125                                 'id' => 'noredirect',
 126                         ],
 127                         'sizelimit' => [
 128                                 'class' => HTMLSizeFilterField::class,
 129                                 'name' => 'size',
 130                         ]
 131                 ];
 132                 $htmlForm = new HTMLForm( $formDescriptor, $this->getContext() );
 133                 $htmlForm
 134                         ->setMethod( 'get' )
 135                         ->setWrapperLegendMsg( 'protectedpages' )
 136                         ->setSubmitText( $this->msg( 'protectedpages-submit' )->text() );
 137
 138                 return $htmlForm->prepareForm()->getHTML( false );
 139         }
 140
 141         /**
 142          * Creates the input label of the restriction type
 143          * @param string $pr_type Protection type
 144          * @return array
 145          */
 146         protected function getTypeMenu( $pr_type ) {
 147                 $m = []; // Temporary array
 148                 $options = [];
 149
 150                 // First pass to load the log names
 151                 foreach ( Title::getFilteredRestrictionTypes( true ) as $type ) {
 152                         // Messages: restriction-edit, restriction-move, restriction-create, restriction-upload
 153                         $text = $this->msg( "restriction-$type" )->text();
 154                         $m[$text] = $type;
 155                 }
 156
 157                 // Third pass generates sorted XHTML content
 158                 foreach ( $m as $text => $type ) {
 159                         $options[$text] = $type;
 160                 }
 161
 162                 return [
 163                         'type' => 'select',
 164                         'options' => $options,
 165                         'label' => $this->msg( 'restriction-type' )->text(),
 166                         'name' => $this->IdType,
 167                         'id' => $this->IdType,
 168                 ];
 169         }
 170
 171         /**
 172          * Creates the input label of the restriction level
 173          * @param string $pr_level Protection level
 174          * @return array
 175          */
 176         protected function getLevelMenu( $pr_level ) {
 177                 // Temporary array
 178                 $m = [ $this->msg( 'restriction-level-all' )->text() => 0 ];
 179                 $options = [];
 180
 181                 // First pass to load the log names
 182                 foreach ( $this->getConfig()->get( 'RestrictionLevels' ) as $type ) {
 183                         // Messages used can be 'restriction-level-sysop' and 'restriction-level-autoconfirmed'
 184                         if ( $type != '' && $type != '*' ) {
 185                                 $text = $this->msg( "restriction-level-$type" )->text();
 186                                 $m[$text] = $type;
 187                         }
 188                 }
 189
 190                 // Third pass generates sorted XHTML content
 191                 foreach ( $m as $text => $type ) {
 192                         $options[$text] = $type;
 193                 }
 194
 195                 return [
 196                         'type' => 'select',
 197                         'options' => $options,
 198                         'label' => $this->msg( 'restriction-level' )->text(),
 199                         'name' => $this->IdLevel,
 200                         'id' => $this->IdLevel
 201                 ];
 202         }
 203
 204         protected function getGroupName() {
 205                 return 'maintenance';
 206         }
 207 }