SpecialListDuplicatedFiles.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\LinkBatchFactory;
use MediaWiki\Skin\Skin;
use MediaWiki\SpecialPage\QueryPage;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use stdClass;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\IResultWrapper;
 
class SpecialListDuplicatedFiles extends QueryPage {
    private readonly int $migrationStage;
 
    public function __construct(
        IConnectionProvider $dbProvider,
        LinkBatchFactory $linkBatchFactory
    ) {
        parent::__construct( 'ListDuplicatedFiles' );
        $this->setDatabaseProvider( $dbProvider );
        $this->setLinkBatchFactory( $linkBatchFactory );
        $this->migrationStage = MediaWikiServices::getInstance()->getMainConfig()->get(
            MainConfigNames::FileSchemaMigrationStage
        );
    }
 
    public function isExpensive() {
        return true;
    }
 
    public function isSyndicated() {
        return false;
    }
 
    public function getQueryInfo() {
        if ( $this->migrationStage & SCHEMA_COMPAT_READ_OLD ) {
            $tables = [ 'image' ];
            $nameField = 'img_name';
            $hashField = 'img_sha1';
            $conds = [];
            $joins = [];
        } else {
            $tables = [ 'file', 'filerevision' ];
            $nameField = 'file_name';
            $hashField = 'fr_sha1';
            $conds = [ 'file_deleted' => 0 ];
            $joins = [ 'filerevision' => [ 'JOIN', 'file_latest = fr_id' ] ];
        }
        return [
            'tables' => $tables,
            'fields' => [
                'namespace' => NS_FILE,
                'title' => "MIN($nameField)",
                'value' => 'count(*)'
            ],
            'conds' => $conds,
            'join_conds' => $joins,
            'options' => [
                'GROUP BY' => $hashField,
                'HAVING' => 'count(*) > 1',
            ],
        ];
    }
 
    public function preprocessResults( $db, $res ) {
        $this->executeLBFromResultWrapper( $res );
    }
 
    public function formatResult( $skin, $result ) {
        // Future version might include a list of the first 5 duplicates
        // perhaps separated by an "↔".
        $image1 = Title::makeTitle( $result->namespace, $result->title );
        $dupeSearch = SpecialPage::getTitleFor( 'FileDuplicateSearch', $image1->getDBkey() );
 
        $msg = $this->msg( 'listduplicatedfiles-entry' )
            ->params( $image1->getText() )
            ->numParams( $result->value - 1 )
            ->params( $dupeSearch->getPrefixedDBkey() );
 
        return $msg->parse();
    }
 
    public function execute( $par ) {
        $this->addHelpLink( 'Help:Managing_files' );
        parent::execute( $par );
    }
 
    protected function getGroupName() {
        return 'media';
    }
}
 
class_alias( SpecialListDuplicatedFiles::class, 'SpecialListDuplicatedFiles' );