SpecialSpecialPages.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Html\Html;
use MediaWiki\Html\TocGeneratorTrait;
use MediaWiki\SpecialPage\UnlistedSpecialPage;
use OOUI\FieldLayout;
use OOUI\SearchInputWidget;
 
class SpecialSpecialPages extends UnlistedSpecialPage {
    use TocGeneratorTrait;
 
    public function __construct() {
        parent::__construct( 'Specialpages' );
    }
 
    public function execute( $par ) {
        $out = $this->getOutput();
        $this->setHeaders();
        $this->outputHeader();
        $out->getMetadata()->setPreventClickjacking( false );
        $out->addModuleStyles( 'mediawiki.special' );
 
        $groups = $this->getPageGroups();
 
        if ( $groups === false ) {
            return;
        }
 
        $this->addHelpLink( 'Help:Special pages' );
        $this->outputPageList( $groups );
    }
 
    private function getPageGroups() {
        $pages = $this->getSpecialPageFactory()->getUsablePages( $this->getUser(), $this->getContext() );
 
        if ( $pages === [] ) {
            // Yeah, that was pointless. Thanks for coming.
            return false;
        }
 
        // Put them into a sortable array
        $groups = [];
        foreach ( $pages as $page ) {
            $group = $page->getFinalGroupName();
            $desc = $page->getDescription();
            // (T360723) Only show an entry if the message isn't blanked, to allow on-wiki unlisting
            if ( !$desc->isDisabled() ) {
                $groups[$group][$desc->text()] = [
                    $page->getPageTitle(),
                    $page->isRestricted(),
                    $page->isCached()
                ];
            }
        }
 
        // Sort
        foreach ( $groups as $group => $sortedPages ) {
            ksort( $groups[$group] );
        }
 
        // Always move "other" to end
        if ( array_key_exists( 'other', $groups ) ) {
            $other = $groups['other'];
            unset( $groups['other'] );
            $groups['other'] = $other;
        }
 
        return $groups;
    }
 
    private function outputPageList( array $groups ) {
        $out = $this->getOutput();
        $out->addModules( 'mediawiki.special.specialpages' );
        $out->enableOOUI();
 
        // Legend
        $includesRestrictedPages = false;
        $includesCachedPages = false;
        foreach ( $groups as $group => $sortedPages ) {
            foreach ( $sortedPages as $desc => [ $title, $restricted, $cached ] ) {
                if ( $cached ) {
                    $includesCachedPages = true;
                }
                if ( $restricted ) {
                    $includesRestrictedPages = true;
                }
            }
        }
 
        $notes = [];
        if ( $includesRestrictedPages ) {
            $restrictedMsg = $this->msg( 'specialpages-note-restricted' );
            if ( !$restrictedMsg->isDisabled() ) {
                $notes[] = $restrictedMsg->parse();
            }
        }
        if ( $includesCachedPages ) {
            $cachedMsg = $this->msg( 'specialpages-note-cached' );
            if ( !$cachedMsg->isDisabled() ) {
                $notes[] = $cachedMsg->parse();
            }
        }
        if ( $notes !== [] ) {
            $legendHeading = $this->msg( 'specialpages-note-top' )->parse();
 
            $legend = Html::rawElement(
                'div',
                [ 'class' => [ 'mw-changeslist-legend', 'mw-specialpages-notes' ] ],
                $legendHeading . implode( "\n", $notes )
            );
 
            $out->addHTML( $legend );
            $out->addModuleStyles( 'mediawiki.special.changeslist.legend' );
        }
 
        $out->addHTML( ( new FieldLayout(
            new SearchInputWidget( [
                'placeholder' => $this->msg( 'specialpages-header-search' )->text(),
            ] ),
            [
                'classes' => [ 'mw-special-pages-search' ],
                'label' => $this->msg( 'specialpages-header-search' )->text(),
                'invisibleLabel' => true,
                'infusable' => true,
            ]
        ) )->toString() );
 
        // Format table of contents
        foreach ( $groups as $group => $sortedPages ) {
            if ( !str_contains( $group, '/' ) ) {
                $this->addTocSection(
                    id: "mw-specialpagesgroup-$group",
                    msg: "specialpages-group-$group"
                );
            }
        }
        $out->addTOCPlaceholder( $this->getTocData() );
 
        // Format contents
        $aliases = $this->getContentLanguage()->getSpecialPageAliases();
        $language = $this->getLanguage();
        foreach ( $groups as $group => $sortedPages ) {
            if ( str_contains( $group, '/' ) ) {
                [ $group, $subGroup ] = explode( '/', $group, 2 );
                $out->addHTML( Html::element(
                    'h3',
                    [ 'class' => "mw-specialpagessubgroup" ],
                    $this->msg( "specialpages-group-$group-$subGroup" )->text()
                ) . "\n" );
            } else {
                $out->addHTML( Html::element(
                    'h2',
                    [ 'class' => "mw-specialpagesgroup", 'id' => "mw-specialpagesgroup-$group" ],
                    $this->msg( "specialpages-group-$group" )->text()
                ) . "\n" );
            }
            $out->addHTML(
                Html::openElement( 'div', [ 'class' => 'mw-specialpages-list' ] )
                . '<ul>'
            );
            foreach ( $sortedPages as $desc => [ $title, $restricted, $cached ] ) {
                [ $canonicalName ] = $this->getSpecialPageFactory()->resolveAlias( $title->getDBkey() );
                $indexAttr = [];
                if ( $canonicalName !== null ) {
                    $c = 0;
                    foreach ( $aliases[ $canonicalName ] ?? [] as $alias ) {
                        $indexAttr[ 'data-search-index-' . $c ] = str_replace( '_', ' ', $language->lc( $alias ) );
                        ++$c;
                    }
                }
                $pageClasses = [];
                if ( $cached ) {
                    $pageClasses[] = 'mw-specialpagecached';
                }
                if ( $restricted ) {
                    $pageClasses[] = 'mw-specialpagerestricted';
                }
 
                $link = $this->getLinkRenderer()->makeKnownLink( $title, $desc );
                $out->addHTML( Html::rawElement(
                        'li',
                        $indexAttr + [ 'class' => $pageClasses ],
                        $link
                    ) . "\n" );
            }
            $out->addHTML(
                Html::closeElement( 'ul' ) .
                Html::closeElement( 'div' )
            );
        }
    }
}
 
// @codeCoverageIgnoreStart
class_alias( SpecialSpecialPages::class, 'SpecialSpecialpages' );
// @codeCoverageIgnoreEnd