SpecialFileDuplicateSearch.php

Go to the documentation of this file.

<?php
 
use MediaWiki\MediaWikiServices;
 
class SpecialFileDuplicateSearch extends QueryPage {
    protected $hash = '', $filename = '';
 
    protected $file = null;
 
    public function __construct( $name = 'FileDuplicateSearch' ) {
        parent::__construct( $name );
    }
 
    public function isSyndicated() {
        return false;
    }
 
    public function isCacheable() {
        return false;
    }
 
    public function isCached() {
        return false;
    }
 
    protected function linkParameters() {
        return [ 'filename' => $this->filename ];
    }
 
    private function getDupes() {
        return MediaWikiServices::getInstance()->getRepoGroup()->findBySha1( $this->hash );
    }
 
    private function showList( $dupes ) {
        $html = [];
        $html[] = $this->openList( 0 );
 
        foreach ( $dupes as $dupe ) {
            $line = $this->formatResult( null, $dupe );
            $html[] = "<li>" . $line . "</li>";
        }
        $html[] = $this->closeList();
 
        $this->getOutput()->addHTML( implode( "\n", $html ) );
    }
 
    public function getQueryInfo() {
        $imgQuery = LocalFile::getQueryInfo();
        return [
            'tables' => $imgQuery['tables'],
            'fields' => [
                'title' => 'img_name',
                'value' => 'img_sha1',
                'img_user_text' => $imgQuery['fields']['img_user_text'],
                'img_timestamp'
            ],
            'conds' => [ 'img_sha1' => $this->hash ],
            'join_conds' => $imgQuery['joins'],
        ];
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
 
        $this->filename = $par ?? $this->getRequest()->getText( 'filename' );
        $this->file = null;
        $this->hash = '';
        $title = Title::newFromText( $this->filename, NS_FILE );
        if ( $title && $title->getText() != '' ) {
            $this->file = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title );
        }
 
        $out = $this->getOutput();
 
        # Create the input form
        $formFields = [
            'filename' => [
                'type' => 'text',
                'name' => 'filename',
                'label-message' => 'fileduplicatesearch-filename',
                'id' => 'filename',
                'size' => 50,
                'default' => $this->filename,
            ],
        ];
        $hiddenFields = [
            'title' => $this->getPageTitle()->getPrefixedDBkey(),
        ];
        $htmlForm = HTMLForm::factory( 'ooui', $formFields, $this->getContext() );
        $htmlForm->addHiddenFields( $hiddenFields );
        $htmlForm->setAction( wfScript() );
        $htmlForm->setMethod( 'get' );
        $htmlForm->setSubmitTextMsg( $this->msg( 'fileduplicatesearch-submit' ) );
 
        // The form should be visible always, even if it was submitted (e.g. to perform another action).
        // To bypass the callback validation of HTMLForm, use prepareForm() and displayForm().
        $htmlForm->prepareForm()->displayForm( false );
 
        if ( $this->file ) {
            $this->hash = $this->file->getSha1();
        } elseif ( $this->filename !== '' ) {
            $out->wrapWikiMsg(
                "<p class='mw-fileduplicatesearch-noresults'>\n$1\n</p>",
                [ 'fileduplicatesearch-noresults', wfEscapeWikiText( $this->filename ) ]
            );
        }
 
        if ( $this->hash != '' ) {
            # Show a thumbnail of the file
            $img = $this->file;
            if ( $img ) {
                $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
                if ( $thumb ) {
                    $out->addModuleStyles( 'mediawiki.special' );
                    $out->addHTML( '<div id="mw-fileduplicatesearch-icon">' .
                        $thumb->toHtml( [ 'desc-link' => false ] ) . '<br />' .
                        $this->msg( 'fileduplicatesearch-info' )->numParams(
                            $img->getWidth(), $img->getHeight() )->params(
                                $this->getLanguage()->formatSize( $img->getSize() ),
                                $img->getMimeType() )->parseAsBlock() .
                        '</div>' );
                }
            }
 
            $dupes = $this->getDupes();
            $numRows = count( $dupes );
 
            # Show a short summary
            if ( $numRows == 1 ) {
                $out->wrapWikiMsg(
                    "<p class='mw-fileduplicatesearch-result-1'>\n$1\n</p>",
                    [ 'fileduplicatesearch-result-1', wfEscapeWikiText( $this->filename ) ]
                );
            } elseif ( $numRows ) {
                $out->wrapWikiMsg(
                    "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
                    [ 'fileduplicatesearch-result-n', wfEscapeWikiText( $this->filename ),
                        $this->getLanguage()->formatNum( $numRows - 1 ) ]
                );
            }
 
            $this->doBatchLookups( $dupes );
            $this->showList( $dupes );
        }
    }
 
    private function doBatchLookups( $list ) {
        $batch = new LinkBatch();
        foreach ( $list as $file ) {
            $batch->addObj( $file->getTitle() );
            if ( $file->isLocal() ) {
                $userName = $file->getUser( 'text' );
                $batch->add( NS_USER, $userName );
                $batch->add( NS_USER_TALK, $userName );
            }
        }
 
        $batch->execute();
    }
 
    public function formatResult( $skin, $result ) {
        $linkRenderer = $this->getLinkRenderer();
        $nt = $result->getTitle();
        $text = MediaWikiServices::getInstance()->getContentLanguage()->convert(
            htmlspecialchars( $nt->getText() )
        );
        $plink = $linkRenderer->makeLink(
            $nt,
            new HtmlArmor( $text )
        );
 
        $userText = $result->getUser( 'text' );
        if ( $result->isLocal() ) {
            $userId = $result->getUser( 'id' );
            $user = Linker::userLink( $userId, $userText );
            $user .= '<span style="white-space: nowrap;">';
            $user .= Linker::userToolLinks( $userId, $userText );
            $user .= '</span>';
        } else {
            $user = htmlspecialchars( $userText );
        }
 
        $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
            $result->getTimestamp(), $this->getUser() ) );
 
        return "$plink . . $user . . $time";
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $title = Title::newFromText( $search, NS_FILE );
        if ( !$title || $title->getNamespace() !== NS_FILE ) {
            // No prefix suggestion outside of file namespace
            return [];
        }
        $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
        $searchEngine->setLimitOffset( $limit, $offset );
        // Autocomplete subpage the same as a normal search, but just for files
        $searchEngine->setNamespaces( [ NS_FILE ] );
        $result = $searchEngine->defaultPrefixSearch( $search );
 
        return array_map( function ( Title $t ) {
            // Remove namespace in search suggestion
            return $t->getText();
        }, $result );
    }
 
    protected function getGroupName() {
        return 'media';
    }
}