MediaWiki  1.34.0
FileContentsHasher.php
Go to the documentation of this file.
1 <?php
23 
25  protected $cache;
26 
28  private static $instance;
29 
30  public function __construct() {
31  $this->cache = ObjectCache::getLocalServerInstance( 'hash' );
32  }
33 
39  public static function singleton() {
40  if ( !self::$instance ) {
41  self::$instance = new self;
42  }
43 
44  return self::$instance;
45  }
46 
56  public function getFileContentsHashInternal( $filePath, $algo = 'md4' ) {
57  $mtime = filemtime( $filePath );
58  if ( $mtime === false ) {
59  return false;
60  }
61 
62  $cacheKey = $this->cache->makeGlobalKey( __CLASS__, $filePath, $mtime, $algo );
63  $hash = $this->cache->get( $cacheKey );
64 
65  if ( $hash ) {
66  return $hash;
67  }
68 
69  $contents = file_get_contents( $filePath );
70  if ( $contents === false ) {
71  return false;
72  }
73 
74  $hash = hash( $algo, $contents );
75  $this->cache->set( $cacheKey, $hash, 60 * 60 * 24 ); // 24h
76 
77  return $hash;
78  }
79 
89  public static function getFileContentsHash( $filePaths, $algo = 'md4' ) {
91 
92  if ( !is_array( $filePaths ) ) {
93  $filePaths = (array)$filePaths;
94  }
95 
96  Wikimedia\suppressWarnings();
97 
98  if ( count( $filePaths ) === 1 ) {
99  $hash = $instance->getFileContentsHashInternal( $filePaths[0], $algo );
100  Wikimedia\restoreWarnings();
101  return $hash;
102  }
103 
104  sort( $filePaths );
105  $hashes = array_map( function ( $filePath ) use ( $instance, $algo ) {
106  return $instance->getFileContentsHashInternal( $filePath, $algo ) ?: '';
107  }, $filePaths );
108 
109  Wikimedia\restoreWarnings();
110 
111  $hashes = implode( '', $hashes );
112  return $hashes ? hash( $algo, $hashes ) : false;
113  }
114 }
FileContentsHasher
Definition: FileContentsHasher.php:22
FileContentsHasher\$cache
BagOStuff $cache
Definition: FileContentsHasher.php:25
BagOStuff
Class representing a cache/ephemeral data store.
Definition: BagOStuff.php:63
FileContentsHasher\getFileContentsHash
static getFileContentsHash( $filePaths, $algo='md4')
Get a hash of the combined contents of one or more files, either by retrieving a previously-computed ...
Definition: FileContentsHasher.php:89
FileContentsHasher\getFileContentsHashInternal
getFileContentsHashInternal( $filePath, $algo='md4')
Get a hash of a file's contents, either by retrieving a previously- computed hash from the cache,...
Definition: FileContentsHasher.php:56
FileContentsHasher\$instance
static FileContentsHasher $instance
Definition: FileContentsHasher.php:28
FileContentsHasher\__construct
__construct()
Definition: FileContentsHasher.php:30
$hashes
$hashes
Definition: testCompression.php:66
FileContentsHasher\singleton
static singleton()
Get the singleton instance of this class.
Definition: FileContentsHasher.php:39
ObjectCache\getLocalServerInstance
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
Definition: ObjectCache.php:268