SpecialListRedirects.php

Go to the documentation of this file.

<?php
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\Page\WikiPageFactory;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\ILoadBalancer;
use Wikimedia\Rdbms\IResultWrapper;
 
class SpecialListRedirects extends QueryPage {
 
    private $linkBatchFactory;
 
    private $wikiPageFactory;
 
    public function __construct(
        LinkBatchFactory $linkBatchFactory,
        ILoadBalancer $loadBalancer,
        WikiPageFactory $wikiPageFactory
    ) {
        parent::__construct( 'Listredirects' );
        $this->linkBatchFactory = $linkBatchFactory;
        $this->setDBLoadBalancer( $loadBalancer );
        $this->wikiPageFactory = $wikiPageFactory;
    }
 
    public function isExpensive() {
        return true;
    }
 
    public function isSyndicated() {
        return false;
    }
 
    protected function sortDescending() {
        return false;
    }
 
    public function getQueryInfo() {
        return [
            'tables' => [ 'p1' => 'page', 'redirect', 'p2' => 'page' ],
            'fields' => [ 'namespace' => 'p1.page_namespace',
                'title' => 'p1.page_title',
                'rd_namespace',
                'rd_title',
                'rd_fragment',
                'rd_interwiki',
                'redirid' => 'p2.page_id' ],
            'conds' => [ 'p1.page_is_redirect' => 1 ],
            'join_conds' => [ 'redirect' => [
                'LEFT JOIN', 'rd_from=p1.page_id' ],
                'p2' => [ 'LEFT JOIN', [
                    'p2.page_namespace=rd_namespace',
                    'p2.page_title=rd_title' ] ] ]
        ];
    }
 
    protected function getOrderFields() {
        return [ 'p1.page_namespace', 'p1.page_title' ];
    }
 
    public function preprocessResults( $db, $res ) {
        if ( !$res->numRows() ) {
            return;
        }
 
        $batch = $this->linkBatchFactory->newLinkBatch();
        foreach ( $res as $row ) {
            $batch->add( $row->namespace, $row->title );
            $redirTarget = $this->getRedirectTarget( $row );
            if ( $redirTarget ) {
                $batch->addObj( $redirTarget );
            }
        }
        $batch->execute();
 
        // Back to start for display
        $res->seek( 0 );
    }
 
    protected function getRedirectTarget( $row ) {
        if ( isset( $row->rd_title ) ) {
            return Title::makeTitle(
                $row->rd_namespace,
                $row->rd_title,
                $row->rd_fragment ?? '',
                $row->rd_interwiki ?? ''
            );
        } else {
            $title = Title::makeTitle( $row->namespace, $row->title );
            if ( !$title->canExist() ) {
                return null;
            }
            $page = $this->wikiPageFactory->newFromTitle( $title );
 
            return $page->getRedirectTarget();
        }
    }
 
    public function formatResult( $skin, $result ) {
        $linkRenderer = $this->getLinkRenderer();
        # Make a link to the redirect itself
        $rd_title = Title::makeTitle( $result->namespace, $result->title );
        $rd_link = $linkRenderer->makeLink(
            $rd_title,
            null,
            [],
            [ 'redirect' => 'no' ]
        );
 
        # Find out where the redirect leads
        $target = $this->getRedirectTarget( $result );
        if ( $target ) {
            # Make a link to the destination page
            $lang = $this->getLanguage();
            $arr = $lang->getArrow() . $lang->getDirMark();
            $targetLink = $linkRenderer->makeLink( $target, $target->getFullText() );
 
            return "$rd_link $arr $targetLink";
        } else {
            return "<del>$rd_link</del>";
        }
    }
 
    public function execute( $par ) {
        $this->addHelpLink( 'Help:Redirects' );
        parent::execute( $par );
    }
 
    protected function getGroupName() {
        return 'pages';
    }
}