Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
25.00% covered (danger)
25.00%
1 / 4
CRAP
78.79% covered (warning)
78.79%
26 / 33
FileContentsHasher
0.00% covered (danger)
0.00%
0 / 1
25.00% covered (danger)
25.00%
1 / 4
14.61
78.79% covered (warning)
78.79%
26 / 33
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
 singleton
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 3
 getFileContentsHashInternal
0.00% covered (danger)
0.00%
0 / 1
4.06
84.62% covered (warning)
84.62%
11 / 13
 getFileContentsHash
100.00% covered (success)
100.00%
1 / 1
6
100.00% covered (success)
100.00%
15 / 15
<?php
/**
 * Generate hash digests of file contents to help with cache invalidation.
 *
 * 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
 */
class FileContentsHasher {
    /** @var BagOStuff */
    protected $cache;
    /** @var FileContentsHasher */
    private static $instance;
    public function __construct() {
        $this->cache = ObjectCache::getLocalServerInstance( 'hash' );
    }
    /**
     * Get the singleton instance of this class.
     *
     * @return FileContentsHasher
     */
    public static function singleton() {
        if ( !self::$instance ) {
            self::$instance = new self;
        }
        return self::$instance;
    }
    /**
     * Get a hash of a file's contents, either by retrieving a previously-
     * computed hash from the cache, or by computing a hash from the file.
     *
     * @param string $filePath Full path to the file.
     * @param string $algo Name of selected hashing algorithm.
     * @return string|bool Hash of file contents, or false if the file could not be read.
     */
    private function getFileContentsHashInternal( $filePath, $algo = 'md4' ) {
        $mtime = filemtime( $filePath );
        if ( $mtime === false ) {
            return false;
        }
        $cacheKey = $this->cache->makeGlobalKey( __CLASS__, $filePath, $mtime, $algo );
        $hash = $this->cache->get( $cacheKey );
        if ( $hash ) {
            return $hash;
        }
        $contents = file_get_contents( $filePath );
        if ( $contents === false ) {
            return false;
        }
        $hash = hash( $algo, $contents );
        $this->cache->set( $cacheKey, $hash, 60 * 60 * 24 );  // 24h
        return $hash;
    }
    /**
     * Get a hash of the combined contents of one or more files, either by
     * retrieving a previously-computed hash from the cache, or by computing
     * a hash from the files.
     *
     * @param string|string[] $filePaths One or more file paths.
     * @param string $algo Name of selected hashing algorithm.
     * @return string|bool Hash of files' contents, or false if no file could not be read.
     */
    public static function getFileContentsHash( $filePaths, $algo = 'md4' ) {
        $instance = self::singleton();
        if ( !is_array( $filePaths ) ) {
            $filePaths = (array)$filePaths;
        }
        Wikimedia\suppressWarnings();
        if ( count( $filePaths ) === 1 ) {
            $hash = $instance->getFileContentsHashInternal( $filePaths[0], $algo );
            Wikimedia\restoreWarnings();
            return $hash;
        }
        sort( $filePaths );
        $hashes = [];
        foreach ( $filePaths as $filePath ) {
            $hashes[] = $instance->getFileContentsHashInternal( $filePath, $algo ) ?: '';
        }
        Wikimedia\restoreWarnings();
        $hashes = implode( '', $hashes );
        return $hashes ? hash( $algo, $hashes ) : false;
    }
}