MWFileProps.php

Go to the documentation of this file.

<?php
use MediaWiki\FileRepo\File\File;
use Wikimedia\FileBackend\FileBackend;
use Wikimedia\FileBackend\FSFile\FSFile;
use Wikimedia\Mime\MimeAnalyzer;
 
class MWFileProps {
    private $magic;
 
    public function __construct( MimeAnalyzer $magic ) {
        $this->magic = $magic;
    }
 
    public function getPropsFromPath( $path, $ext ) {
        $fsFile = new FSFile( $path );
 
        $info = $this->newPlaceholderProps();
        $info['fileExists'] = $fsFile->exists();
        if ( $info['fileExists'] ) {
            $info['size'] = $fsFile->getSize(); // bytes
            $info['sha1'] = $fsFile->getSha1Base36();
 
            # MIME type according to file contents
            $info['file-mime'] = $this->magic->guessMimeType( $path, false );
            # Logical MIME type
            $ext = ( $ext === true ) ? FileBackend::extensionFromPath( $path ) : (string)$ext;
 
            # XXX: MimeAnalyzer::improveTypeFromExtension() may return null (T253483).
            # Unclear if callers of this method expect that.
            $info['mime'] = $this->magic->improveTypeFromExtension( $info['file-mime'], $ext );
 
            [ $info['major_mime'], $info['minor_mime'] ] = File::splitMime( $info['mime'] );
            $info['media_type'] = $this->magic->getMediaType( $path, $info['mime'] );
 
            # Height, width and metadata
            // @phan-suppress-next-line PhanTypeMismatchArgumentNullable See XXX above
            $handler = MediaHandler::getHandler( $info['mime'] );
            if ( $handler ) {
                $sizeAndMetadata = $handler->getSizeAndMetadataWithFallback( $fsFile, $path );
                if ( $sizeAndMetadata ) {
                    $info = $sizeAndMetadata + $info;
                }
            }
        }
 
        return $info;
    }
 
    public function newPlaceholderProps() {
        return FSFile::placeholderProps() + [
            'metadata' => [],
            'width' => 0,
            'height' => 0,
            'bits' => 0,
            'media_type' => MEDIATYPE_UNKNOWN
        ];
    }
}