SpecialAllPages.php

Go to the documentation of this file.

<?php
use MediaWiki\Html\Html;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageStore;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\ILoadBalancer;
 
class SpecialAllPages extends IncludableSpecialPage {
 
    protected $maxPerPage = 345;
 
    protected $nsfromMsg = 'allpagesfrom';
 
    private $loadBalancer;
 
    private $searchEngineFactory;
 
    private $pageStore;
 
    public function __construct(
        ILoadBalancer $loadBalancer = null,
        SearchEngineFactory $searchEngineFactory = null,
        PageStore $pageStore = null
    ) {
        parent::__construct( 'Allpages' );
        // This class is extended and therefore falls back to global state - T265309
        $services = MediaWikiServices::getInstance();
        $this->loadBalancer = $loadBalancer ?? $services->getDBLoadBalancer();
        $this->searchEngineFactory = $searchEngineFactory ?? $services->getSearchEngineFactory();
        $this->pageStore = $pageStore ?? $services->getPageStore();
    }
 
    public function execute( $par ) {
        $request = $this->getRequest();
        $out = $this->getOutput();
 
        $this->setHeaders();
        $this->outputHeader();
        $out->setPreventClickjacking( false );
 
        # GET values
        $from = $request->getVal( 'from', null );
        $to = $request->getVal( 'to', null );
        $namespace = $request->getInt( 'namespace' );
 
        $miserMode = (bool)$this->getConfig()->get( MainConfigNames::MiserMode );
 
        // Redirects filter is disabled in MiserMode
        $hideredirects = $request->getBool( 'hideredirects', false ) && !$miserMode;
 
        $namespaces = $this->getLanguage()->getNamespaces();
 
        $out->setPageTitle(
            ( $namespace > 0 && array_key_exists( $namespace, $namespaces ) ) ?
                $this->msg( 'allinnamespace', str_replace( '_', ' ', $namespaces[$namespace] ) ) :
                $this->msg( 'allarticles' )
        );
        $out->addModuleStyles( 'mediawiki.special' );
 
        if ( $par !== null ) {
            $this->showChunk( $namespace, $par, $to, $hideredirects );
        } elseif ( $from !== null && $to === null ) {
            $this->showChunk( $namespace, $from, $to, $hideredirects );
        } else {
            $this->showToplevel( $namespace, $from, $to, $hideredirects );
        }
    }
 
    protected function outputHTMLForm( $namespace = NS_MAIN,
        $from = '', $to = '', $hideRedirects = false
    ) {
        $miserMode = (bool)$this->getConfig()->get( MainConfigNames::MiserMode );
        $formDescriptor = [
            'from' => [
                'type' => 'text',
                'name' => 'from',
                'id' => 'nsfrom',
                'size' => 30,
                'label-message' => 'allpagesfrom',
                'default' => str_replace( '_', ' ', $from ),
            ],
            'to' => [
                'type' => 'text',
                'name' => 'to',
                'id' => 'nsto',
                'size' => 30,
                'label-message' => 'allpagesto',
                'default' => str_replace( '_', ' ', $to ),
            ],
            'namespace' => [
                'type' => 'namespaceselect',
                'name' => 'namespace',
                'id' => 'namespace',
                'label-message' => 'namespace',
                'all' => null,
                'default' => $namespace,
            ],
            'hideredirects' => [
                'type' => 'check',
                'name' => 'hideredirects',
                'id' => 'hidredirects',
                'label-message' => 'allpages-hide-redirects',
                'value' => $hideRedirects,
            ],
        ];
 
        if ( $miserMode ) {
            unset( $formDescriptor['hideredirects'] );
        }
 
        $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
        $htmlForm
            ->setMethod( 'get' )
            ->setTitle( $this->getPageTitle() ) // Remove subpage
            ->setWrapperLegendMsg( 'allpages' )
            ->setSubmitTextMsg( 'allpagessubmit' )
            ->prepareForm()
            ->displayForm( false );
    }
 
    private function showToplevel(
        $namespace = NS_MAIN, $from = null, $to = null, $hideredirects = false
    ) {
        $from = $from ? Title::makeTitleSafe( $namespace, $from ) : null;
        $to = $to ? Title::makeTitleSafe( $namespace, $to ) : null;
        $from = ( $from && $from->isLocal() ) ? $from->getDBkey() : null;
        $to = ( $to && $to->isLocal() ) ? $to->getDBkey() : null;
 
        $this->showChunk( $namespace, $from, $to, $hideredirects );
    }
 
    private function showChunk(
        $namespace = NS_MAIN, $from = null, $to = null, $hideredirects = false
    ) {
        $output = $this->getOutput();
 
        $fromList = $this->getNamespaceKeyAndText( $namespace, $from );
        $toList = $this->getNamespaceKeyAndText( $namespace, $to );
        $namespaces = $this->getContext()->getLanguage()->getNamespaces();
        $n = 0;
        $prevTitle = null;
 
        if ( !$fromList || !$toList ) {
            $out = $this->msg( 'allpagesbadtitle' )->parseAsBlock();
        } elseif ( !array_key_exists( $namespace, $namespaces ) ) {
            // Show errormessage and reset to NS_MAIN
            $out = $this->msg( 'allpages-bad-ns', $namespace )->parse();
            $namespace = NS_MAIN;
        } else {
            [ $namespace, $fromKey, $from ] = $fromList;
            [ , $toKey, $to ] = $toList;
 
            $dbr = $this->loadBalancer->getConnection( ILoadBalancer::DB_REPLICA );
            $filterConds = [ 'page_namespace' => $namespace ];
            if ( $hideredirects ) {
                $filterConds['page_is_redirect'] = 0;
            }
 
            $conds = $filterConds;
            $conds[] = 'page_title >= ' . $dbr->addQuotes( $fromKey );
            if ( $toKey !== "" ) {
                $conds[] = 'page_title <= ' . $dbr->addQuotes( $toKey );
            }
 
            $res = $this->pageStore->newSelectQueryBuilder()
                ->where( $conds )
                ->caller( __METHOD__ )
                ->orderBy( 'page_title' )
                ->limit( $this->maxPerPage + 1 )
                ->useIndex( 'page_name_title' )
                ->fetchPageRecords();
 
            // Eagerly fetch the set of pages to be displayed and warm up LinkCache (T328174).
            // Note that we can't use fetchPageRecordArray() here as that returns an array keyed
            // by page IDs; we need a simple sequence.
            $pages = iterator_to_array( $res );
 
            $linkRenderer = $this->getLinkRenderer();
            if ( count( $pages ) > 0 ) {
                $out = Html::openElement( 'ul', [ 'class' => 'mw-allpages-chunk' ] );
 
                while ( $n < $this->maxPerPage && $n < count( $pages ) ) {
                    $page = $pages[$n];
                    $attributes = $page->isRedirect() ? [ 'class' => 'allpagesredirect' ] : [];
 
                    $out .= Html::rawElement( 'li', $attributes, $linkRenderer->makeKnownLink( $page ) ) . "\n";
                    $n++;
                }
                $out .= Html::closeElement( 'ul' );
 
                if ( count( $pages ) > 2 ) {
                    // Only apply CSS column styles if there's more than 2 entries.
                    // Otherwise, rendering is broken as "mw-allpages-body"'s CSS column count is 3.
                    $out = Html::rawElement( 'div', [ 'class' => 'mw-allpages-body' ], $out );
                }
            } else {
                $out = '';
            }
 
            if ( $fromKey !== '' && !$this->including() ) {
                # Get the first title from previous chunk
                $prevConds = $filterConds;
                $prevConds[] = 'page_title < ' . $dbr->addQuotes( $fromKey );
                $prevKey = $dbr->selectField(
                    'page',
                    'page_title',
                    $prevConds,
                    __METHOD__,
                    [ 'ORDER BY' => 'page_title DESC', 'OFFSET' => $this->maxPerPage - 1 ]
                );
 
                if ( $prevKey === false ) {
                    # The previous chunk is not complete, need to link to the very first title
                    # available in the database
                    $prevKey = $dbr->selectField(
                        'page',
                        'page_title',
                        $prevConds,
                        __METHOD__,
                        [ 'ORDER BY' => 'page_title' ]
                    );
                }
 
                if ( $prevKey !== false ) {
                    $prevTitle = Title::makeTitle( $namespace, $prevKey );
                }
            }
        }
 
        if ( $this->including() ) {
            $output->addHTML( $out );
            return;
        }
 
        $navLinks = [];
        $self = $this->getPageTitle();
 
        $linkRenderer = $this->getLinkRenderer();
        // Generate a "previous page" link if needed
        if ( $prevTitle ) {
            $query = [ 'from' => $prevTitle->getText() ];
 
            if ( $namespace ) {
                $query['namespace'] = $namespace;
            }
 
            if ( $hideredirects ) {
                $query['hideredirects'] = $hideredirects;
            }
 
            $navLinks[] = $linkRenderer->makeKnownLink(
                $self,
                $this->msg( 'prevpage', $prevTitle->getText() )->text(),
                [],
                $query
            );
 
        }
 
        // Generate a "next page" link if needed
        if ( $n === $this->maxPerPage && isset( $pages[$n] ) ) {
            # $t is the first link of the next chunk
            $t = TitleValue::newFromPage( $pages[$n] );
            $query = [ 'from' => $t->getText() ];
 
            if ( $namespace ) {
                $query['namespace'] = $namespace;
            }
 
            if ( $hideredirects ) {
                $query['hideredirects'] = $hideredirects;
            }
 
            $navLinks[] = $linkRenderer->makeKnownLink(
                $self,
                $this->msg( 'nextpage', $t->getText() )->text(),
                [],
                $query
            );
        }
 
        $this->outputHTMLForm( $namespace, $from, $to, $hideredirects );
 
        if ( count( $navLinks ) ) {
            // Add pagination links
            $pagination = Html::rawElement( 'div',
                [ 'class' => 'mw-allpages-nav' ],
                $this->getLanguage()->pipeList( $navLinks )
            );
 
            $output->addHTML( $pagination );
            $out .= Html::element( 'hr' ) . $pagination; // Footer
        }
 
        $output->addHTML( $out );
    }
 
    protected function getNamespaceKeyAndText( $ns, $text ) {
        if ( $text == '' ) {
            # shortcut for common case
            return [ $ns, '', '' ];
        }
 
        $t = Title::makeTitleSafe( $ns, $text );
        if ( $t && $t->isLocal() ) {
            return [ $t->getNamespace(), $t->getDBkey(), $t->getText() ];
        } elseif ( $t ) {
            return null;
        }
 
        # try again, in case the problem was an empty pagename
        $text = preg_replace( '/(#|$)/', 'X$1', $text );
        $t = Title::makeTitleSafe( $ns, $text );
        if ( $t && $t->isLocal() ) {
            return [ $t->getNamespace(), '', '' ];
        } else {
            return null;
        }
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        return $this->prefixSearchString( $search, $limit, $offset, $this->searchEngineFactory );
    }
 
    protected function getGroupName() {
        return 'pages';
    }
}