FSFile.php

Go to the documentation of this file.

<?php
class FSFile {
    protected $path; // path to file
    protected $sha1Base36; // file SHA-1 in base 36

    public function __construct( $path ) {
        if ( FileBackend::isStoragePath( $path ) ) {
            throw new MWException( __METHOD__ . " given storage path `$path`." );
        }
        $this->path = $path;
    }

    public function getPath() {
        return $this->path;
    }

    public function exists() {
        return is_file( $this->path );
    }

    public function getSize() {
        return filesize( $this->path );
    }

    public function getTimestamp() {
        wfSuppressWarnings();
        $timestamp = filemtime( $this->path );
        wfRestoreWarnings();
        if ( $timestamp !== false ) {
            $timestamp = wfTimestamp( TS_MW, $timestamp );
        }
        return $timestamp;
    }

    public function getMimeType() {
        return MimeMagic::singleton()->guessMimeType( $this->path, false );
    }

    public function getProps( $ext = true ) {
        wfProfileIn( __METHOD__ );
        wfDebug( __METHOD__ . ": Getting file info for $this->path\n" );

        $info = self::placeholderProps();
        $info['fileExists'] = $this->exists();

        if ( $info['fileExists'] ) {
            $magic = MimeMagic::singleton();

            # get the file extension
            if ( $ext === true ) {
                $ext = self::extensionFromPath( $this->path );
            }

            # mime type according to file contents
            $info['file-mime'] = $this->getMimeType();
            # logical mime type
            $info['mime'] = $magic->improveTypeFromExtension( $info['file-mime'], $ext );

            list( $info['major_mime'], $info['minor_mime'] ) = File::splitMime( $info['mime'] );
            $info['media_type'] = $magic->getMediaType( $this->path, $info['mime'] );

            # Get size in bytes
            $info['size'] = $this->getSize();

            # Height, width and metadata
            $handler = MediaHandler::getHandler( $info['mime'] );
            if ( $handler ) {
                $tempImage = (object)array(); // XXX (hack for File object)
                $info['metadata'] = $handler->getMetadata( $tempImage, $this->path );
                $gis = $handler->getImageSize( $tempImage, $this->path, $info['metadata'] );
                if ( is_array( $gis ) ) {
                    $info = $this->extractImageSizeInfo( $gis ) + $info;
                }
            }
            $info['sha1'] = $this->getSha1Base36();

            wfDebug( __METHOD__ . ": $this->path loaded, {$info['size']} bytes, {$info['mime']}.\n" );
        } else {
            wfDebug( __METHOD__ . ": $this->path NOT FOUND!\n" );
        }

        wfProfileOut( __METHOD__ );
        return $info;
    }

    public static function placeholderProps() {
        $info = array();
        $info['fileExists'] = false;
        $info['mime'] = null;
        $info['media_type'] = MEDIATYPE_UNKNOWN;
        $info['metadata'] = '';
        $info['sha1'] = '';
        $info['width'] = 0;
        $info['height'] = 0;
        $info['bits'] = 0;
        return $info;
    }

    protected function extractImageSizeInfo( array $gis ) {
        $info = array();
        # NOTE: $gis[2] contains a code for the image type. This is no longer used.
        $info['width'] = $gis[0];
        $info['height'] = $gis[1];
        if ( isset( $gis['bits'] ) ) {
            $info['bits'] = $gis['bits'];
        } else {
            $info['bits'] = 0;
        }
        return $info;
    }

    public function getSha1Base36( $recache = false ) {
        wfProfileIn( __METHOD__ );

        if ( $this->sha1Base36 !== null && !$recache ) {
            wfProfileOut( __METHOD__ );
            return $this->sha1Base36;
        }

        wfSuppressWarnings();
        $this->sha1Base36 = sha1_file( $this->path );
        wfRestoreWarnings();

        if ( $this->sha1Base36 !== false ) {
            $this->sha1Base36 = wfBaseConvert( $this->sha1Base36, 16, 36, 31 );
        }

        wfProfileOut( __METHOD__ );
        return $this->sha1Base36;
    }

    public static function extensionFromPath( $path ) {
        $i = strrpos( $path, '.' );
        return strtolower( $i ? substr( $path, $i + 1 ) : '' );
    }

    public static function getPropsFromPath( $path, $ext = true ) {
        $fsFile = new self( $path );
        return $fsFile->getProps( $ext );
    }

    public static function getSha1Base36FromPath( $path ) {
        $fsFile = new self( $path );
        return $fsFile->getSha1Base36();
    }
}