SpecialShortPages.php

Go to the documentation of this file.

<?php
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\Html\Html;
use MediaWiki\Linker\Linker;
use MediaWiki\MainConfigNames;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\Platform\ISQLPlatform;
 
class SpecialShortPages extends QueryPage {
 
    private $namespaceInfo;
 
    public function __construct(
        NamespaceInfo $namespaceInfo,
        IConnectionProvider $dbProvider,
        LinkBatchFactory $linkBatchFactory
    ) {
        parent::__construct( 'Shortpages' );
        $this->namespaceInfo = $namespaceInfo;
        $this->setDatabaseProvider( $dbProvider );
        $this->setLinkBatchFactory( $linkBatchFactory );
    }
 
    public function isSyndicated() {
        return false;
    }
 
    public function getQueryInfo() {
        $config = $this->getConfig();
        $tables = [ 'page' ];
        $conds = [
            'page_namespace' => array_diff(
                $this->namespaceInfo->getContentNamespaces(),
                $config->get( MainConfigNames::ShortPagesNamespaceExclusions )
            ),
            'page_is_redirect' => 0
        ];
        $joinConds = [];
        $options = [ 'USE INDEX' => [ 'page' => 'page_redirect_namespace_len' ] ];
 
        // Allow extensions to modify the query
        $this->getHookRunner()->onShortPagesQuery( $tables, $conds, $joinConds, $options );
 
        return [
            'tables' => $tables,
            'fields' => [
                'namespace' => 'page_namespace',
                'title' => 'page_title',
                'value' => 'page_len'
            ],
            'conds' => $conds,
            'join_conds' => $joinConds,
            'options' => $options
        ];
    }
 
    public function reallyDoQuery( $limit, $offset = false ) {
        $fname = static::class . '::reallyDoQuery';
        $dbr = $this->getRecacheDB();
        $query = $this->getQueryInfo();
        $order = $this->getOrderFields();
 
        if ( $this->sortDescending() ) {
            foreach ( $order as &$field ) {
                $field .= ' DESC';
            }
        }
 
        $tables = isset( $query['tables'] ) ? (array)$query['tables'] : [];
        $fields = isset( $query['fields'] ) ? (array)$query['fields'] : [];
        $conds = isset( $query['conds'] ) ? (array)$query['conds'] : [];
        $options = isset( $query['options'] ) ? (array)$query['options'] : [];
        $join_conds = isset( $query['join_conds'] ) ? (array)$query['join_conds'] : [];
 
        if ( $limit !== false ) {
            $options['LIMIT'] = intval( $limit );
        }
 
        if ( $offset !== false ) {
            $options['OFFSET'] = intval( $offset );
        }
 
        $namespaces = $conds['page_namespace'];
        if ( count( $namespaces ) === 1 ) {
            $options['ORDER BY'] = $order;
            $res = $dbr->select( $tables, $fields, $conds, $fname,
                $options, $join_conds
            );
        } else {
            unset( $conds['page_namespace'] );
            $options['INNER ORDER BY'] = $order;
            $options['ORDER BY'] = [ 'value' . ( $this->sortDescending() ? ' DESC' : '' ) ];
            $sql = $dbr->unionConditionPermutations(
                $tables,
                $fields,
                [ 'page_namespace' => $namespaces ],
                $conds,
                $fname,
                $options,
                $join_conds
            );
            // phpcs:ignore MediaWiki.Usage.DbrQueryUsage.DbrQueryFound
            $res = $dbr->query( $sql, $fname, ISQLPlatform::QUERY_CHANGE_NONE );
        }
 
        return $res;
    }
 
    protected function getOrderFields() {
        return [ 'page_len' ];
    }
 
    public function preprocessResults( $db, $res ) {
        $this->executeLBFromResultWrapper( $res );
    }
 
    protected function sortDescending() {
        return false;
    }
 
    public function formatResult( $skin, $result ) {
        $dm = $this->getLanguage()->getDirMark();
 
        $title = Title::makeTitleSafe( $result->namespace, $result->title );
        if ( !$title ) {
            return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ],
                Linker::getInvalidTitleDescription( $this->getContext(), $result->namespace, $result->title ) );
        }
 
        $linkRenderer = $this->getLinkRenderer();
        $hlink = $linkRenderer->makeKnownLink(
            $title,
            $this->msg( 'hist' )->text(),
            [],
            [ 'action' => 'history' ]
        );
        $hlinkInParentheses = $this->msg( 'parentheses' )->rawParams( $hlink )->escaped();
 
        if ( $this->isCached() ) {
            $plink = $linkRenderer->makeLink( $title );
            $exists = $title->exists();
        } else {
            $plink = $linkRenderer->makeKnownLink( $title );
            $exists = true;
        }
 
        $size = $this->msg( 'nbytes' )->numParams( $result->value )->escaped();
 
        return $exists
            ? "{$hlinkInParentheses} {$dm}{$plink} {$dm}[{$size}]"
            : "<del>{$hlinkInParentheses} {$dm}{$plink} {$dm}[{$size}]</del>";
    }
 
    protected function getGroupName() {
        return 'maintenance';
    }
}