SpecialMIMESearch.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use File;
use HtmlArmor;
use HTMLForm;
use ILanguageConverter;
use LocalFile;
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\Languages\LanguageConverterFactory;
use MediaWiki\Linker\Linker;
use MediaWiki\Title\Title;
use QueryPage;
use Skin;
use stdClass;
use Wikimedia\Rdbms\IConnectionProvider;
 
class SpecialMIMESearch extends QueryPage {
    protected $major, $minor, $mime;
 
    private $languageConverter;
 
    public function __construct(
        IConnectionProvider $dbProvider,
        LinkBatchFactory $linkBatchFactory,
        LanguageConverterFactory $languageConverterFactory
    ) {
        parent::__construct( 'MIMEsearch' );
        $this->setDatabaseProvider( $dbProvider );
        $this->setLinkBatchFactory( $linkBatchFactory );
        $this->languageConverter = $languageConverterFactory->getLanguageConverter( $this->getContentLanguage() );
    }
 
    public function isExpensive() {
        return false;
    }
 
    public function isSyndicated() {
        return false;
    }
 
    public function isCacheable() {
        return false;
    }
 
    protected function linkParameters() {
        return [ 'mime' => "{$this->major}/{$this->minor}" ];
    }
 
    public function getQueryInfo() {
        $minorType = [];
        if ( $this->minor !== '*' ) {
            // Allow wildcard searching
            $minorType['img_minor_mime'] = $this->minor;
        }
        $imgQuery = LocalFile::getQueryInfo();
        $qi = [
            'tables' => $imgQuery['tables'],
            'fields' => [
                'namespace' => NS_FILE,
                'title' => 'img_name',
                // Still have a value field just in case,
                // but it isn't actually used for sorting.
                'value' => 'img_name',
                'img_size',
                'img_width',
                'img_height',
                'img_user_text' => $imgQuery['fields']['img_user_text'],
                'img_timestamp'
            ],
            'conds' => [
                'img_major_mime' => $this->major,
                // This is in order to trigger using
                // the img_media_mime index in "range" mode.
                // @todo how is order defined? use MimeAnalyzer::getMediaTypes?
                'img_media_type' => [
                    MEDIATYPE_BITMAP,
                    MEDIATYPE_DRAWING,
                    MEDIATYPE_AUDIO,
                    MEDIATYPE_VIDEO,
                    MEDIATYPE_MULTIMEDIA,
                    MEDIATYPE_UNKNOWN,
                    MEDIATYPE_OFFICE,
                    MEDIATYPE_TEXT,
                    MEDIATYPE_EXECUTABLE,
                    MEDIATYPE_ARCHIVE,
                    MEDIATYPE_3D,
                ],
            ] + $minorType,
            'join_conds' => $imgQuery['joins'],
        ];
 
        return $qi;
    }
 
    protected function getOrderFields() {
        return [];
    }
 
    protected function getPageHeader() {
        $formDescriptor = [
            'mime' => [
                'type' => 'combobox',
                'options' => $this->getSuggestionsForTypes(),
                'name' => 'mime',
                'label-message' => 'mimetype',
                'required' => true,
                'default' => $this->mime,
            ],
        ];
 
        HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
            ->setSubmitTextMsg( 'ilsubmit' )
            ->setTitle( $this->getPageTitle() )
            ->setMethod( 'get' )
            ->prepareForm()
            ->displayForm( false );
        return '';
    }
 
    protected function getSuggestionsForTypes() {
        $dbr = $this->getDatabaseProvider()->getReplicaDatabase();
        $lastMajor = null;
        $suggestions = [];
        $result = $dbr->select(
            [ 'image' ],
            // We ignore img_media_type, but using it in the query is needed for MySQL to choose a
            // sensible execution plan
            [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ],
            [],
            __METHOD__,
            [ 'GROUP BY' => [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ] ]
        );
        foreach ( $result as $row ) {
            $major = $row->img_major_mime;
            $minor = $row->img_minor_mime;
            $suggestions[ "$major/$minor" ] = "$major/$minor";
            if ( $lastMajor === $major ) {
                // If there are at least two with the same major mime type, also include the wildcard
                $suggestions[ "$major/*" ] = "$major/*";
            }
            $lastMajor = $major;
        }
        ksort( $suggestions );
        return $suggestions;
    }
 
    public function execute( $par ) {
        $this->addHelpLink( 'Help:Managing_files' );
        $this->mime = $par ?: $this->getRequest()->getText( 'mime' );
        $this->mime = trim( $this->mime );
        [ $this->major, $this->minor ] = File::splitMime( $this->mime );
 
        if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
            !self::isValidType( $this->major )
        ) {
            $this->setHeaders();
            $this->outputHeader();
            $this->getPageHeader();
            return;
        }
 
        parent::execute( $par );
    }
 
    public function formatResult( $skin, $result ) {
        $linkRenderer = $this->getLinkRenderer();
        $nt = Title::makeTitle( $result->namespace, $result->title );
 
        $text = $this->languageConverter->convertHtml( $nt->getText() );
        $plink = $linkRenderer->makeLink(
            Title::newFromText( $nt->getPrefixedText() ),
            new HtmlArmor( $text )
        );
 
        $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
        $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
        $lang = $this->getLanguage();
        $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
        $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
            $result->img_height )->escaped();
        $user = $linkRenderer->makeLink(
            Title::makeTitle( NS_USER, $result->img_user_text ),
            $result->img_user_text
        );
 
        $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
        $time = htmlspecialchars( $time );
 
        return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
    }
 
    protected static function isValidType( $type ) {
        // From maintenance/tables.sql => img_major_mime
        $types = [
            'unknown',
            'application',
            'audio',
            'image',
            'text',
            'video',
            'message',
            'model',
            'multipart',
            'chemical'
        ];
 
        return in_array( $type, $types );
    }
 
    public function preprocessResults( $db, $res ) {
        $this->executeLBFromResultWrapper( $res );
    }
 
    protected function getGroupName() {
        return 'media';
    }
}
 
class_alias( SpecialMIMESearch::class, 'SpecialMIMESearch' );