includes/specials/SpecialSpecialpages.php

   1 <?php
   2 /**
   3  * Implements Special:Specialpages
   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 special pages
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialSpecialpages extends UnlistedSpecialPage {
  30
  31         function __construct() {
  32                 parent::__construct( 'Specialpages' );
  33         }
  34
  35         function execute( $par ) {
  36                 $out = $this->getOutput();
  37                 $this->setHeaders();
  38                 $this->outputHeader();
  39                 $out->allowClickjacking();
  40                 $out->addModuleStyles( 'mediawiki.special' );
  41
  42                 $groups = $this->getPageGroups();
  43
  44                 if ( $groups === false ) {
  45                         return;
  46                 }
  47
  48                 $this->addHelpLink( 'Help:Special pages' );
  49                 $this->outputPageList( $groups );
  50         }
  51
  52         private function getPageGroups() {
  53                 $pages = SpecialPageFactory::getUsablePages( $this->getUser() );
  54
  55                 if ( !count( $pages ) ) {
  56                         # Yeah, that was pointless. Thanks for coming.
  57                         return false;
  58                 }
  59
  60                 /** Put them into a sortable array */
  61                 $groups = [];
  62                 /** @var SpecialPage $page */
  63                 foreach ( $pages as $page ) {
  64                         if ( $page->isListed() ) {
  65                                 $group = $page->getFinalGroupName();
  66                                 if ( !isset( $groups[$group] ) ) {
  67                                         $groups[$group] = [];
  68                                 }
  69                                 $groups[$group][$page->getDescription()] = [
  70                                         $page->getPageTitle(),
  71                                         $page->isRestricted(),
  72                                         $page->isCached()
  73                                 ];
  74                         }
  75                 }
  76
  77                 /** Sort */
  78                 foreach ( $groups as $group => $sortedPages ) {
  79                         ksort( $groups[$group] );
  80                 }
  81
  82                 /** Always move "other" to end */
  83                 if ( array_key_exists( 'other', $groups ) ) {
  84                         $other = $groups['other'];
  85                         unset( $groups['other'] );
  86                         $groups['other'] = $other;
  87                 }
  88
  89                 return $groups;
  90         }
  91
  92         private function outputPageList( $groups ) {
  93                 $out = $this->getOutput();
  94
  95                 $includesRestrictedPages = false;
  96                 $includesCachedPages = false;
  97
  98                 foreach ( $groups as $group => $sortedPages ) {
  99                         $out->wrapWikiMsg(
 100                                 "<h2 class=\"mw-specialpagesgroup\" id=\"mw-specialpagesgroup-$group\">$1</h2>\n",
 101                                 "specialpages-group-$group"
 102                         );
 103                         $out->addHTML(
 104                                 Html::openElement( 'div', [ 'class' => 'mw-specialpages-list' ] )
 105                                 . '<ul>'
 106                         );
 107                         foreach ( $sortedPages as $desc => $specialpage ) {
 108                                 list( $title, $restricted, $cached ) = $specialpage;
 109
 110                                 $pageClasses = [];
 111                                 if ( $cached ) {
 112                                         $includesCachedPages = true;
 113                                         $pageClasses[] = 'mw-specialpagecached';
 114                                 }
 115                                 if ( $restricted ) {
 116                                         $includesRestrictedPages = true;
 117                                         $pageClasses[] = 'mw-specialpagerestricted';
 118                                 }
 119
 120                                 $link = $this->getLinkRenderer()->makeKnownLink( $title, $desc );
 121                                 $out->addHTML( Html::rawElement(
 122                                                 'li',
 123                                                 [ 'class' => implode( ' ', $pageClasses ) ],
 124                                                 $link
 125                                         ) . "\n" );
 126                         }
 127                         $out->addHTML(
 128                                 Html::closeElement( 'ul' ) .
 129                                 Html::closeElement( 'div' )
 130                         );
 131                 }
 132
 133                 // add legend
 134                 $notes = [];
 135                 if ( $includesRestrictedPages ) {
 136                         $restricedMsg = $this->msg( 'specialpages-note-restricted' );
 137                         if ( !$restricedMsg->isDisabled() ) {
 138                                 $notes[] = $restricedMsg->plain();
 139                         }
 140                 }
 141                 if ( $includesCachedPages ) {
 142                         $cachedMsg = $this->msg( 'specialpages-note-cached' );
 143                         if ( !$cachedMsg->isDisabled() ) {
 144                                 $notes[] = $cachedMsg->plain();
 145                         }
 146                 }
 147                 if ( $notes !== [] ) {
 148                         $out->wrapWikiMsg(
 149                                 "<h2 class=\"mw-specialpages-note-top\">$1</h2>", 'specialpages-note-top'
 150                         );
 151                         $out->addWikiText(
 152                                 "<div class=\"mw-specialpages-notes\">\n" .
 153                                 implode( "\n", $notes ) .
 154                                 "\n</div>"
 155                         );
 156                 }
 157         }
 158 }