UnregisteredLocalFile.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
 
class UnregisteredLocalFile extends File {
    protected $title;
 
    protected $path;
 
    protected $mime;
 
    protected $pageDims;
 
    protected $sizeAndMetadata;
 
    public $handler;
 
    public static function newFromPath( $path, $mime ) {
        return new static( false, false, $path, $mime );
    }
 
    public static function newFromTitle( $title, $repo ) {
        return new static( $title, $repo, false, false );
    }
 
    public function __construct( $title = false, $repo = false, $path = false, $mime = false ) {
        if ( !( $title && $repo ) && !$path ) {
            throw new BadMethodCallException( __METHOD__ .
                ': not enough parameters, must specify title and repo, or a full path' );
        }
        if ( $title instanceof Title ) {
            $this->title = File::normalizeTitle( $title, 'exception' );
            $this->name = $repo->getNameFromTitle( $title );
        } else {
            $this->name = basename( $path );
            $this->title = File::normalizeTitle( $this->name, 'exception' );
        }
        $this->repo = $repo;
        if ( $path ) {
            $this->path = $path;
        } else {
            $this->assertRepoDefined();
            $this->path = $repo->getRootDirectory() . '/' .
                $repo->getHashPath( $this->name ) . $this->name;
        }
        if ( $mime ) {
            $this->mime = $mime;
        }
        $this->pageDims = [];
    }
 
    private function cachePageDimensions( $page = 1 ) {
        $page = (int)$page;
        if ( $page < 1 ) {
            $page = 1;
        }
 
        if ( !isset( $this->pageDims[$page] ) ) {
            if ( !$this->getHandler() ) {
                return false;
            }
            if ( $this->getHandler()->isMultiPage( $this ) ) {
                $this->pageDims[$page] = $this->handler->getPageDimensions( $this, $page );
            } else {
                $info = $this->getSizeAndMetadata();
                return [
                    'width' => $info['width'],
                    'height' => $info['height']
                ];
            }
        }
 
        return $this->pageDims[$page];
    }
 
    public function getWidth( $page = 1 ) {
        $dim = $this->cachePageDimensions( $page );
 
        return $dim['width'] ?? 0;
    }
 
    public function getHeight( $page = 1 ) {
        $dim = $this->cachePageDimensions( $page );
 
        return $dim['height'] ?? 0;
    }
 
    public function getMimeType() {
        if ( !isset( $this->mime ) ) {
            $refPath = $this->getLocalRefPath();
            if ( $refPath !== false ) {
                $magic = MediaWikiServices::getInstance()->getMimeAnalyzer();
                $this->mime = $magic->guessMimeType( $refPath );
            } else {
                $this->mime = false;
            }
        }
 
        return $this->mime;
    }
 
    public function getBitDepth() {
        $info = $this->getSizeAndMetadata();
        return $info['bits'] ?? 0;
    }
 
    public function getMetadata() {
        $info = $this->getSizeAndMetadata();
        return $info['metadata'] ? serialize( $info['metadata'] ) : false;
    }
 
    public function getMetadataArray(): array {
        $info = $this->getSizeAndMetadata();
        return $info['metadata'];
    }
 
    private function getSizeAndMetadata() {
        if ( $this->sizeAndMetadata === null ) {
            if ( !$this->getHandler() ) {
                $this->sizeAndMetadata = [ 'width' => 0, 'height' => 0, 'metadata' => [] ];
            } else {
                $this->sizeAndMetadata = $this->getHandler()->getSizeAndMetadataWithFallback(
                    $this, $this->getLocalRefPath() );
            }
        }
 
        return $this->sizeAndMetadata;
    }
 
    public function getURL() {
        if ( $this->repo ) {
            return $this->repo->getZoneUrl( 'public' ) . '/' .
                $this->repo->getHashPath( $this->name ) . rawurlencode( $this->name );
        } else {
            return false;
        }
    }
 
    public function getSize() {
        $this->assertRepoDefined();
 
        return $this->repo->getFileSize( $this->path );
    }
 
    public function setLocalReference( FSFile $fsFile ) {
        $this->fsFile = $fsFile;
    }
}