FSFile.php

Go to the documentation of this file.

<?php
namespace Wikimedia\FileBackend\FSFile;
 
use Wikimedia\AtEase\AtEase;
use Wikimedia\Timestamp\ConvertibleTimestamp;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class FSFile {
    protected $path;
 
    protected $sha1Base36;
 
    public function __construct( $path ) {
        $this->path = $path;
    }
 
    public function getPath() {
        return $this->path;
    }
 
    public function exists() {
        return is_file( $this->path );
    }
 
    public function getSize() {
        AtEase::suppressWarnings();
        $size = filesize( $this->path );
        AtEase::restoreWarnings();
 
        return $size;
    }
 
    public function getTimestamp() {
        AtEase::suppressWarnings();
        $timestamp = filemtime( $this->path );
        AtEase::restoreWarnings();
        if ( $timestamp !== false ) {
            $timestamp = ConvertibleTimestamp::convert( TS::MW, $timestamp );
        }
 
        return $timestamp;
    }
 
    public function getProps( $ext = true ) {
        $info = self::placeholderProps();
        $info['fileExists'] = $this->exists();
 
        if ( $info['fileExists'] ) {
            $info['size'] = $this->getSize(); // bytes
            $info['sha1'] = $this->getSha1Base36();
 
            $mime = mime_content_type( $this->path );
            # MIME type according to file contents
            $info['file-mime'] = ( $mime === false ) ? 'unknown/unknown' : $mime;
            # logical MIME type
            $info['mime'] = $mime;
 
            if ( str_contains( $mime, '/' ) ) {
                [ $info['major_mime'], $info['minor_mime'] ] = explode( '/', $mime, 2 );
            } else {
                [ $info['major_mime'], $info['minor_mime'] ] = [ $mime, 'unknown' ];
            }
        }
 
        return $info;
    }
 
    public static function placeholderProps() {
        return [
            'fileExists' => false,
            'size' => 0,
            'file-mime' => null,
            'major_mime' => null,
            'minor_mime' => null,
            'mime' => null,
            'sha1' => '',
        ];
    }
 
    public function getSha1Base36( $recache = false ) {
        if ( $this->sha1Base36 !== null && !$recache ) {
            return $this->sha1Base36;
        }
 
        AtEase::suppressWarnings();
        $this->sha1Base36 = sha1_file( $this->path );
        AtEase::restoreWarnings();
 
        if ( $this->sha1Base36 !== false ) {
            $this->sha1Base36 = \Wikimedia\base_convert( $this->sha1Base36, 16, 36, 31 );
        }
 
        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();
    }
}
 
class_alias( FSFile::class, 'FSFile' );