1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
<?php
/**
* @file
* @ingroup FileBackend
*/
/**
* Class representing a non-directory file on the file system
*
* @ingroup FileBackend
*/
class FSFile {
protected $path; // path to file
/**
* Sets up the file object
*
* @param String $path Path to temporary file on local disk
*/
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|false
*/
public function getSize() {
return filesize( $this->path );
}
/**
* Get the file's last-modified timestamp
*
* @return string|false 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();
$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
*
* @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.
*
* @return false|string False on failure
*/
public function getSha1Base36() {
wfProfileIn( __METHOD__ );
wfSuppressWarnings();
$hash = sha1_file( $this->path );
wfRestoreWarnings();
if ( $hash !== false ) {
$hash = wfBaseConvert( $hash, 16, 36, 31 );
}
wfProfileOut( __METHOD__ );
return $hash;
}
/**
* 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 $path String: 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
*
* @return false|string False on failure
*/
public static function getSha1Base36FromPath( $path ) {
$fsFile = new self( $path );
return $fsFile->getSha1Base36();
}
}
|
