SpecialWantedCategories.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Deferred\LinksUpdate\CategoryLinksTable;
use MediaWiki\Language\ILanguageConverter;
use MediaWiki\Language\LanguageConverterFactory;
use MediaWiki\Linker\LinksMigration;
use MediaWiki\Page\LinkBatchFactory;
use MediaWiki\Skin\Skin;
use MediaWiki\SpecialPage\WantedQueryPage;
use MediaWiki\Title\Title;
use stdClass;
use Wikimedia\HtmlArmor\HtmlArmor;
use Wikimedia\Rdbms\IConnectionProvider;
 
class SpecialWantedCategories extends WantedQueryPage {
    private $currentCategoryCounts;
 
    private readonly ILanguageConverter $languageConverter;
 
    public function __construct(
        IConnectionProvider $dbProvider,
        LinkBatchFactory $linkBatchFactory,
        LanguageConverterFactory $languageConverterFactory,
        private readonly LinksMigration $linksMigration
    ) {
        parent::__construct( 'Wantedcategories' );
        $this->setDatabaseProvider( $dbProvider );
        $this->setLinkBatchFactory( $linkBatchFactory );
        $this->languageConverter = $languageConverterFactory->getLanguageConverter( $this->getContentLanguage() );
    }
 
    public function getQueryInfo() {
        $queryInfo = $this->linksMigration->getQueryInfo( 'categorylinks' );
        $titleField = $this->linksMigration->getTitleFields( 'categorylinks' )[1];
 
        return [
            'tables' => array_merge( $queryInfo['tables'], [ 'page' ] ),
            'fields' => [
                'namespace' => NS_CATEGORY,
                'title' => $titleField,
                'value' => 'COUNT(*)'
            ],
            'conds' => [ 'page_title' => null ],
            'options' => [ 'GROUP BY' => $titleField ],
            'join_conds' => array_merge( $queryInfo['joins'],
                [ 'page' => [ 'LEFT JOIN',
                    [ 'page_title = ' . $titleField,
                        'page_namespace' => NS_CATEGORY ] ] ] )
        ];
    }
 
    protected function getRecacheDB() {
        return $this->getDatabaseProvider()->getReplicaDatabase(
            CategoryLinksTable::VIRTUAL_DOMAIN,
            'vslow'
        );
    }
 
    public function preprocessResults( $db, $res ) {
        parent::preprocessResults( $db, $res );
 
        $this->currentCategoryCounts = [];
 
        if ( !$res->numRows() || !$this->isCached() ) {
            return;
        }
 
        // Fetch (hopefully) up-to-date numbers of pages in each category.
        // This should be fast enough as we limit the list to a reasonable length.
 
        $allCategories = [];
        foreach ( $res as $row ) {
            $allCategories[] = $row->title;
        }
 
        $categoryRes = $db->newSelectQueryBuilder()
            ->select( [ 'cat_title', 'cat_pages' ] )
            ->from( 'category' )
            ->where( [ 'cat_title' => $allCategories ] )
            ->caller( __METHOD__ )->fetchResultSet();
        foreach ( $categoryRes as $row ) {
            $this->currentCategoryCounts[$row->cat_title] = intval( $row->cat_pages );
        }
 
        // Back to start for display
        $res->seek( 0 );
    }
 
    public function formatResult( $skin, $result ) {
        $nt = Title::makeTitle( $result->namespace, $result->title );
 
        $text = new HtmlArmor( $this->languageConverter->convertHtml( $nt->getText() ) );
 
        if ( !$this->isCached() ) {
            // We can assume the freshest data
            $plink = $this->getLinkRenderer()->makeBrokenLink(
                $nt,
                $text
            );
            $nlinks = $this->msg( 'nmembers' )->numParams( $result->value )->escaped();
        } else {
            $plink = $this->getLinkRenderer()->makeLink( $nt, $text );
 
            $currentValue = $this->currentCategoryCounts[$result->title] ?? 0;
            $cachedValue = intval( $result->value ); // T76910
 
            // If the category has been created or emptied since the list was refreshed, strike it
            if ( $nt->isKnown() || $currentValue === 0 ) {
                $plink = "<del>$plink</del>";
            }
 
            // Show the current number of category entries if it changed
            if ( $currentValue !== $cachedValue ) {
                $nlinks = $this->msg( 'nmemberschanged' )
                    ->numParams( $cachedValue, $currentValue )->escaped();
            } else {
                $nlinks = $this->msg( 'nmembers' )->numParams( $cachedValue )->escaped();
            }
        }
 
        return $this->getLanguage()->specialList( $plink, $nlinks );
    }
 
    protected function getGroupName() {
        return 'maintenance';
    }
}
 
class_alias( SpecialWantedCategories::class, 'SpecialWantedCategories' );