3 * Non-directory file on the file system.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileBackend
25 * Class representing a non-directory file on the file system
27 * @ingroup FileBackend
30 /** @var string Path to file */
33 /** @var string File SHA-1 in base 36 */
34 protected $sha1Base36;
37 * Sets up the file object
39 * @param string $path Path to temporary file on local disk
41 public function __construct( $path ) {
46 * Returns the file system path
50 public function getPath() {
55 * Checks if the file exists
59 public function exists() {
60 return is_file( $this->path
);
64 * Get the file size in bytes
68 public function getSize() {
69 return filesize( $this->path
);
73 * Get the file's last-modified timestamp
75 * @return string|bool TS_MW timestamp or false on failure
77 public function getTimestamp() {
78 MediaWiki\
suppressWarnings();
79 $timestamp = filemtime( $this->path
);
80 MediaWiki\restoreWarnings
();
81 if ( $timestamp !== false ) {
82 $timestamp = wfTimestamp( TS_MW
, $timestamp );
89 * Get an associative array containing information about
90 * a file with the given storage path.
92 * Resulting array fields include:
94 * - size (filesize in bytes)
95 * - mime (as major/minor)
96 * - media_type (value to be used with the MEDIATYPE_xxx constants)
97 * - metadata (handler specific)
106 * @param string|bool $ext The file extension, or true to extract it from the filename.
107 * Set it to false to ignore the extension.
110 public function getProps( $ext = true ) {
111 $info = self
::placeholderProps();
112 $info['fileExists'] = $this->exists();
114 if ( $info['fileExists'] ) {
115 $info['size'] = $this->getSize(); // bytes
116 $info['sha1'] = $this->getSha1Base36();
117 // @TODO: replace the code below with bare FileInfo use so this can go in /libs
118 $magic = MimeMagic
::singleton();
120 # MIME type according to file contents
121 $info['file-mime'] = $magic->guessMimeType( $this->path
, false );
123 $ext = ( $ext === true ) ? FileBackend
::extensionFromPath( $this->path
) : $ext;
124 $info['mime'] = $magic->improveTypeFromExtension( $info['file-mime'], $ext );
126 list( $info['major_mime'], $info['minor_mime'] ) = File
::splitMime( $info['mime'] );
127 $info['media_type'] = $magic->getMediaType( $this->path
, $info['mime'] );
129 # Height, width and metadata
130 $handler = MediaHandler
::getHandler( $info['mime'] );
132 $info['metadata'] = $handler->getMetadata( $this, $this->path
);
133 /** @noinspection PhpMethodParametersCountMismatchInspection */
134 $gis = $handler->getImageSize( $this, $this->path
, $info['metadata'] );
135 if ( is_array( $gis ) ) {
136 $info = $this->extractImageSizeInfo( $gis ) +
$info;
145 * Placeholder file properties to use for files that don't exist
147 * Resulting array fields include:
150 * - file-mime (as major/minor)
151 * - mime (as major/minor)
154 * - media_type (value to be used with the MEDIATYPE_xxx constants)
155 * - metadata (handler specific)
156 * - sha1 (in base 36)
163 public static function placeholderProps() {
165 $info['fileExists'] = false;
167 $info['file-mime'] = null;
168 $info['major_mime'] = null;
169 $info['minor_mime'] = null;
170 $info['mime'] = null;
171 $info['media_type'] = MEDIATYPE_UNKNOWN
;
172 $info['metadata'] = '';
182 * Exract image size information
187 protected function extractImageSizeInfo( array $gis ) {
189 # NOTE: $gis[2] contains a code for the image type. This is no longer used.
190 $info['width'] = $gis[0];
191 $info['height'] = $gis[1];
192 if ( isset( $gis['bits'] ) ) {
193 $info['bits'] = $gis['bits'];
202 * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
203 * encoding, zero padded to 31 digits.
205 * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
208 * @param bool $recache
209 * @return bool|string False on failure
211 public function getSha1Base36( $recache = false ) {
212 if ( $this->sha1Base36
!== null && !$recache ) {
213 return $this->sha1Base36
;
216 MediaWiki\
suppressWarnings();
217 $this->sha1Base36
= sha1_file( $this->path
);
218 MediaWiki\restoreWarnings
();
220 if ( $this->sha1Base36
!== false ) {
221 $this->sha1Base36
= Wikimedia\base_convert
( $this->sha1Base36
, 16, 36, 31 );
224 return $this->sha1Base36
;
228 * Get the final file extension from a file system path
230 * @param string $path
233 public static function extensionFromPath( $path ) {
234 $i = strrpos( $path, '.' );
236 return strtolower( $i ?
substr( $path, $i +
1 ) : '' );
240 * Get an associative array containing information about a file in the local filesystem.
242 * @param string $path Absolute local filesystem path
243 * @param string|bool $ext The file extension, or true to extract it from the filename.
244 * Set it to false to ignore the extension.
247 public static function getPropsFromPath( $path, $ext = true ) {
248 $fsFile = new self( $path );
250 return $fsFile->getProps( $ext );
254 * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
255 * encoding, zero padded to 31 digits.
257 * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
260 * @param string $path
261 * @return bool|string False on failure
263 public static function getSha1Base36FromPath( $path ) {
264 $fsFile = new self( $path );
266 return $fsFile->getSha1Base36();