Fixed spacing in actions/cache/filebackend/filerepo/job folder

[mediawiki.git] / includes / filebackend / FSFile.php

<?php
/**
 * Non-directory file on the file system.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup FileBackend
 */

/**
 * Class representing a non-directory file on the file system
 *
 * @ingroup FileBackend
 */
class FSFile {
        protected $path; // path to file
        private $sha1Base36 = null; // File Sha1Base36

        /**
         * Sets up the file object
         *
         * @param string $path Path to temporary file on local disk
         * @throws MWException
         */
        public function __construct( $path ) {
                if ( FileBackend::isStoragePath( $path ) ) {
                        throw new MWException( __METHOD__ . " given storage path `$path`." );
                }
                $this->path = $path;
        }

        /**
         * Returns the file system path
         *
         * @return String
         */
        public function getPath() {
                return $this->path;
        }

        /**
         * Checks if the file exists
         *
         * @return bool
         */
        public function exists() {
                return is_file( $this->path );
        }

        /**
         * Get the file size in bytes
         *
         * @return int|bool
         */
        public function getSize() {
                return filesize( $this->path );
        }

        /**
         * Get the file's last-modified timestamp
         *
         * @return string|bool TS_MW timestamp or false on failure
         */
        public function getTimestamp() {
                wfSuppressWarnings();
                $timestamp = filemtime( $this->path );
                wfRestoreWarnings();
                if ( $timestamp !== false ) {
                        $timestamp = wfTimestamp( TS_MW, $timestamp );
                }
                return $timestamp;
        }

        /**
         * Guess the MIME type from the file contents alone
         *
         * @return string
         */
        public function getMimeType() {
                return MimeMagic::singleton()->guessMimeType( $this->path, false );
        }

        /**
         * Get an associative array containing information about
         * a file with the given storage path.
         *
         * @param $ext Mixed: the file extension, or true to extract it from the filename.
         *             Set it to false to ignore the extension.
         *
         * @return array
         */
        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;
        }

        /**
         * Placeholder file properties to use for files that don't exist
         *
         * @return Array
         */
        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;
        }

        /**
         * Exract image size information
         *
         * @param $gis array
         * @return Array
         */
        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;
        }

        /**
         * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
         * encoding, zero padded to 31 digits.
         *
         * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
         * fairly neatly.
         *
         * @param $recache bool
         * @return bool|string False on failure
         */
        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;
        }

        /**
         * Get the final file extension from a file system path
         *
         * @param $path string
         * @return string
         */
        public static function extensionFromPath( $path ) {
                $i = strrpos( $path, '.' );
                return strtolower( $i ? substr( $path, $i + 1 ) : '' );
        }

        /**
         * Get an associative array containing information about a file in the local filesystem.
         *
         * @param string $path absolute local filesystem path
         * @param $ext Mixed: the file extension, or true to extract it from the filename.
         *             Set it to false to ignore the extension.
         *
         * @return array
         */
        public static function getPropsFromPath( $path, $ext = true ) {
                $fsFile = new self( $path );
                return $fsFile->getProps( $ext );
        }

        /**
         * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
         * encoding, zero padded to 31 digits.
         *
         * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
         * fairly neatly.
         *
         * @param $path string
         * @param $recache bool
         *
         * @return bool|string False on failure
         */
        public static function getSha1Base36FromPath( $path, $recache = false ) {
                static $sha1Base36 = array();

                if ( !isset( $sha1Base36[$path] ) || $recache ) {
                        $fsFile = new self( $path );
                        $sha1Base36[$path] = $fsFile->getSha1Base36();
                }

                return $sha1Base36[$path];
        }
}