SpecialWantedFiles.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\FileRepo\RepoGroup;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\LinkBatchFactory;
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\SpecialPage\WantedQueryPage;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\IConnectionProvider;
 
class SpecialWantedFiles extends WantedQueryPage {
    private readonly int $fileMigrationStage;
 
    public function __construct(
        private readonly RepoGroup $repoGroup,
        IConnectionProvider $dbProvider,
        LinkBatchFactory $linkBatchFactory,
    ) {
        parent::__construct( 'Wantedfiles' );
        $this->setDatabaseProvider( $dbProvider );
        $this->setLinkBatchFactory( $linkBatchFactory );
        $this->fileMigrationStage = $this->getConfig()->get( MainConfigNames::FileSchemaMigrationStage );
    }
 
    protected function getPageHeader() {
        # Specifically setting to use "Wanted Files" (NS_MAIN) as title, so as to get what
        # category would be used on main namespace pages, for those tricky wikipedia
        # admins who like to do {{#ifeq:{{NAMESPACE}}|foo|bar|....}}.
        $catMessage = $this->msg( 'broken-file-category' )
            ->page( PageReferenceValue::localReference( NS_MAIN, "Wanted Files" ) )
            ->inContentLanguage();
 
        if ( !$catMessage->isDisabled() ) {
            $category = Title::makeTitleSafe( NS_CATEGORY, $catMessage->text() );
        } else {
            $category = false;
        }
 
        $noForeign = '';
        if ( !$this->likelyToHaveFalsePositives() ) {
            // Additional messages for grep:
            // wantedfiletext-cat-noforeign, wantedfiletext-nocat-noforeign
            $noForeign = '-noforeign';
        }
 
        if ( $category ) {
            return $this
                ->msg( 'wantedfiletext-cat' . $noForeign, $category->getFullText() )
                ->parseAsBlock();
        } else {
            return $this
                ->msg( 'wantedfiletext-nocat' . $noForeign )
                ->parseAsBlock();
        }
    }
 
    protected function likelyToHaveFalsePositives() {
        return $this->repoGroup->hasForeignRepos();
    }
 
    protected function forceExistenceCheck() {
        return true;
    }
 
    protected function existenceCheck( Title $title ) {
        return (bool)$this->repoGroup->findFile( $title );
    }
 
    public function getQueryInfo() {
        if ( $this->fileMigrationStage & SCHEMA_COMPAT_READ_OLD ) {
            $fileTable = 'image';
            $nameField = 'img_name';
            $extraConds1 = [];
            $extraConds2 = [];
        } else {
            $fileTable = 'file';
            $nameField = 'file_name';
            $extraConds1 = [ 'img1.file_deleted' => 0 ];
            $extraConds2 = [ 'img2.file_deleted' => 0 ];
        }
 
        return [
            'tables' => [
                'imagelinks',
                'linktarget',
                'page',
                'redirect',
                'img1' => $fileTable,
                'img2' => $fileTable,
            ],
            'fields' => [
                'namespace' => NS_FILE,
                'title' => 'lt_title',
                'value' => 'COUNT(*)'
            ],
            'conds' => [
                'img1.' . $nameField => null,
                // We also need to exclude file redirects
                'img2.' . $nameField => null,
            ],
            'options' => [ 'GROUP BY' => 'lt_title' ],
            'join_conds' => [
                'linktarget' => [ 'JOIN', [ 'il_target_id = lt_id' ] ],
                'img1' => [ 'LEFT JOIN',
                    array_merge( [ 'lt_title = img1.' . $nameField, 'lt_namespace' => NS_FILE ], $extraConds1 ),
                ],
                'page' => [ 'LEFT JOIN', [
                    'lt_title = page_title',
                    'page_namespace' => NS_FILE,
                ] ],
                'redirect' => [ 'LEFT JOIN', [
                    'page_id = rd_from',
                    'rd_namespace' => NS_FILE,
                    'rd_interwiki' => ''
                ] ],
                'img2' => [ 'LEFT JOIN',
                    array_merge( [ 'rd_title = img2.' . $nameField ], $extraConds2 ),
                ]
            ]
        ];
    }
 
    protected function getGroupName() {
        return 'maintenance';
    }
}
 
class_alias( SpecialWantedFiles::class, 'WantedFilesPage' );