when getting file (img) properties, suppress whines that it's not xml
[lhc/web/wiklou.git] / includes / libs / mime / MimeAnalyzer.php
1 <?php
2 /**
3 * Module defining helper functions for detecting and dealing with MIME types.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 */
22 use Psr\Log\LoggerAwareInterface;
23 use Psr\Log\LoggerInterface;
24
25 /**
26 * Implements functions related to MIME types such as detection and mapping to file extension
27 *
28 * @since 1.28
29 */
30 class MimeAnalyzer implements LoggerAwareInterface {
31 /** @var string */
32 protected $typeFile;
33 /** @var string */
34 protected $infoFile;
35 /** @var string */
36 protected $xmlTypes;
37 /** @var callable */
38 protected $initCallback;
39 /** @var callable */
40 protected $detectCallback;
41 /** @var callable */
42 protected $guessCallback;
43 /** @var callable */
44 protected $extCallback;
45 /** @var array Mapping of media types to arrays of MIME types */
46 protected $mediaTypes = null;
47 /** @var array Map of MIME type aliases */
48 protected $mimeTypeAliases = null;
49 /** @var array Map of MIME types to file extensions (as a space separated list) */
50 protected $mimetoExt = null;
51
52 /** @var array Map of file extensions types to MIME types (as a space separated list) */
53 public $mExtToMime = null; // legacy name; field accessed by hooks
54
55 /** @var IEContentAnalyzer */
56 protected $IEAnalyzer;
57
58 /** @var string Extra MIME types, set for example by media handling extensions */
59 private $extraTypes = '';
60 /** @var string Extra MIME info, set for example by media handling extensions */
61 private $extraInfo = '';
62
63 /** @var LoggerInterface */
64 private $logger;
65
66 /**
67 * Defines a set of well known MIME types
68 * This is used as a fallback to mime.types files.
69 * An extensive list of well known MIME types is provided by
70 * the file mime.types in the includes directory.
71 *
72 * This list concatenated with mime.types is used to create a MIME <-> ext
73 * map. Each line contains a MIME type followed by a space separated list of
74 * extensions. If multiple extensions for a single MIME type exist or if
75 * multiple MIME types exist for a single extension then in most cases
76 * MediaWiki assumes that the first extension following the MIME type is the
77 * canonical extension, and the first time a MIME type appears for a certain
78 * extension is considered the canonical MIME type.
79 *
80 * (Note that appending the type file list to the end of self::$wellKnownTypes
81 * sucks because you can't redefine canonical types. This could be fixed by
82 * appending self::$wellKnownTypes behind type file list, but who knows
83 * what will break? In practice this probably isn't a problem anyway -- Bryan)
84 */
85 protected static $wellKnownTypes = <<<EOT
86 application/ogg ogx ogg ogm ogv oga spx opus
87 application/pdf pdf
88 application/vnd.oasis.opendocument.chart odc
89 application/vnd.oasis.opendocument.chart-template otc
90 application/vnd.oasis.opendocument.database odb
91 application/vnd.oasis.opendocument.formula odf
92 application/vnd.oasis.opendocument.formula-template otf
93 application/vnd.oasis.opendocument.graphics odg
94 application/vnd.oasis.opendocument.graphics-template otg
95 application/vnd.oasis.opendocument.image odi
96 application/vnd.oasis.opendocument.image-template oti
97 application/vnd.oasis.opendocument.presentation odp
98 application/vnd.oasis.opendocument.presentation-template otp
99 application/vnd.oasis.opendocument.spreadsheet ods
100 application/vnd.oasis.opendocument.spreadsheet-template ots
101 application/vnd.oasis.opendocument.text odt
102 application/vnd.oasis.opendocument.text-master otm
103 application/vnd.oasis.opendocument.text-template ott
104 application/vnd.oasis.opendocument.text-web oth
105 application/javascript js
106 application/x-shockwave-flash swf
107 audio/midi mid midi kar
108 audio/mpeg mpga mpa mp2 mp3
109 audio/x-aiff aif aiff aifc
110 audio/x-wav wav
111 audio/ogg oga spx ogg opus
112 audio/opus opus ogg oga ogg spx
113 image/x-bmp bmp
114 image/gif gif
115 image/jpeg jpeg jpg jpe
116 image/png png
117 image/svg+xml svg
118 image/svg svg
119 image/tiff tiff tif
120 image/vnd.djvu djvu
121 image/x.djvu djvu
122 image/x-djvu djvu
123 image/x-portable-pixmap ppm
124 image/x-xcf xcf
125 text/plain txt
126 text/html html htm
127 video/ogg ogv ogm ogg
128 video/mpeg mpg mpeg
129 EOT;
130
131 /**
132 * Defines a set of well known MIME info entries
133 * This is used as a fallback to mime.info files.
134 * An extensive list of well known MIME types is provided by
135 * the file mime.info in the includes directory.
136 */
137 protected static $wellKnownInfo = <<<EOT
138 application/pdf [OFFICE]
139 application/vnd.oasis.opendocument.chart [OFFICE]
140 application/vnd.oasis.opendocument.chart-template [OFFICE]
141 application/vnd.oasis.opendocument.database [OFFICE]
142 application/vnd.oasis.opendocument.formula [OFFICE]
143 application/vnd.oasis.opendocument.formula-template [OFFICE]
144 application/vnd.oasis.opendocument.graphics [OFFICE]
145 application/vnd.oasis.opendocument.graphics-template [OFFICE]
146 application/vnd.oasis.opendocument.image [OFFICE]
147 application/vnd.oasis.opendocument.image-template [OFFICE]
148 application/vnd.oasis.opendocument.presentation [OFFICE]
149 application/vnd.oasis.opendocument.presentation-template [OFFICE]
150 application/vnd.oasis.opendocument.spreadsheet [OFFICE]
151 application/vnd.oasis.opendocument.spreadsheet-template [OFFICE]
152 application/vnd.oasis.opendocument.text [OFFICE]
153 application/vnd.oasis.opendocument.text-template [OFFICE]
154 application/vnd.oasis.opendocument.text-master [OFFICE]
155 application/vnd.oasis.opendocument.text-web [OFFICE]
156 application/javascript text/javascript application/x-javascript [EXECUTABLE]
157 application/x-shockwave-flash [MULTIMEDIA]
158 audio/midi [AUDIO]
159 audio/x-aiff [AUDIO]
160 audio/x-wav [AUDIO]
161 audio/mp3 audio/mpeg [AUDIO]
162 application/ogg audio/ogg video/ogg [MULTIMEDIA]
163 image/x-bmp image/x-ms-bmp image/bmp [BITMAP]
164 image/gif [BITMAP]
165 image/jpeg [BITMAP]
166 image/png [BITMAP]
167 image/svg+xml [DRAWING]
168 image/tiff [BITMAP]
169 image/vnd.djvu [BITMAP]
170 image/x-xcf [BITMAP]
171 image/x-portable-pixmap [BITMAP]
172 text/plain [TEXT]
173 text/html [TEXT]
174 video/ogg [VIDEO]
175 video/mpeg [VIDEO]
176 unknown/unknown application/octet-stream application/x-empty [UNKNOWN]
177 EOT;
178
179 /**
180 * @param array $params Configuration map, includes:
181 * - typeFile: path to file with the list of known MIME types
182 * - infoFile: path to file with the MIME type info
183 * - xmlTypes: map of root element names to XML MIME types
184 * - initCallback: initialization callback that is passed this object [optional]
185 * - detectCallback: alternative to finfo that returns the mime type for a file.
186 * For example, the callback can return the output of "file -bi". [optional]
187 * - guessCallback: callback to improve the guessed MIME type using the file data.
188 * This is intended for fixing mistakes in fileinfo or "detectCallback". [optional]
189 * - extCallback: callback to improve the guessed MIME type using the extension. [optional]
190 * - logger: PSR-3 logger [optional]
191 * @note Constructing these instances is expensive due to file reads.
192 * A service or singleton pattern should be used to avoid creating instances again and again.
193 */
194 public function __construct( array $params ) {
195 $this->typeFile = $params['typeFile'];
196 $this->infoFile = $params['infoFile'];
197 $this->xmlTypes = $params['xmlTypes'];
198 $this->initCallback = isset( $params['initCallback'] )
199 ? $params['initCallback']
200 : null;
201 $this->detectCallback = isset( $params['detectCallback'] )
202 ? $params['detectCallback']
203 : null;
204 $this->guessCallback = isset( $params['guessCallback'] )
205 ? $params['guessCallback']
206 : null;
207 $this->extCallback = isset( $params['extCallback'] )
208 ? $params['extCallback']
209 : null;
210 $this->logger = isset( $params['logger'] )
211 ? $params['logger']
212 : new \Psr\Log\NullLogger();
213
214 $this->loadFiles();
215 }
216
217 protected function loadFiles() {
218 /**
219 * --- load mime.types ---
220 */
221
222 # Allow media handling extensions adding MIME-types and MIME-info
223 if ( $this->initCallback ) {
224 call_user_func( $this->initCallback, $this );
225 }
226
227 $types = self::$wellKnownTypes;
228
229 $mimeTypeFile = $this->typeFile;
230 if ( $mimeTypeFile ) {
231 if ( is_file( $mimeTypeFile ) && is_readable( $mimeTypeFile ) ) {
232 $this->logger->info( __METHOD__ . ": loading mime types from $mimeTypeFile\n" );
233 $types .= "\n";
234 $types .= file_get_contents( $mimeTypeFile );
235 } else {
236 $this->logger->info( __METHOD__ . ": can't load mime types from $mimeTypeFile\n" );
237 }
238 } else {
239 $this->logger->info( __METHOD__ .
240 ": no mime types file defined, using built-ins only.\n" );
241 }
242
243 $types .= "\n" . $this->extraTypes;
244
245 $types = str_replace( [ "\r\n", "\n\r", "\n\n", "\r\r", "\r" ], "\n", $types );
246 $types = str_replace( "\t", " ", $types );
247
248 $this->mimetoExt = [];
249 $this->mExtToMime = [];
250
251 $lines = explode( "\n", $types );
252 foreach ( $lines as $s ) {
253 $s = trim( $s );
254 if ( empty( $s ) ) {
255 continue;
256 }
257 if ( strpos( $s, '#' ) === 0 ) {
258 continue;
259 }
260
261 $s = strtolower( $s );
262 $i = strpos( $s, ' ' );
263
264 if ( $i === false ) {
265 continue;
266 }
267
268 $mime = substr( $s, 0, $i );
269 $ext = trim( substr( $s, $i + 1 ) );
270
271 if ( empty( $ext ) ) {
272 continue;
273 }
274
275 if ( !empty( $this->mimetoExt[$mime] ) ) {
276 $this->mimetoExt[$mime] .= ' ' . $ext;
277 } else {
278 $this->mimetoExt[$mime] = $ext;
279 }
280
281 $extensions = explode( ' ', $ext );
282
283 foreach ( $extensions as $e ) {
284 $e = trim( $e );
285 if ( empty( $e ) ) {
286 continue;
287 }
288
289 if ( !empty( $this->mExtToMime[$e] ) ) {
290 $this->mExtToMime[$e] .= ' ' . $mime;
291 } else {
292 $this->mExtToMime[$e] = $mime;
293 }
294 }
295 }
296
297 /**
298 * --- load mime.info ---
299 */
300
301 $mimeInfoFile = $this->infoFile;
302
303 $info = self::$wellKnownInfo;
304
305 if ( $mimeInfoFile ) {
306 if ( is_file( $mimeInfoFile ) && is_readable( $mimeInfoFile ) ) {
307 $this->logger->info( __METHOD__ . ": loading mime info from $mimeInfoFile\n" );
308 $info .= "\n";
309 $info .= file_get_contents( $mimeInfoFile );
310 } else {
311 $this->logger->info( __METHOD__ . ": can't load mime info from $mimeInfoFile\n" );
312 }
313 } else {
314 $this->logger->info( __METHOD__ .
315 ": no mime info file defined, using built-ins only.\n" );
316 }
317
318 $info .= "\n" . $this->extraInfo;
319
320 $info = str_replace( [ "\r\n", "\n\r", "\n\n", "\r\r", "\r" ], "\n", $info );
321 $info = str_replace( "\t", " ", $info );
322
323 $this->mimeTypeAliases = [];
324 $this->mediaTypes = [];
325
326 $lines = explode( "\n", $info );
327 foreach ( $lines as $s ) {
328 $s = trim( $s );
329 if ( empty( $s ) ) {
330 continue;
331 }
332 if ( strpos( $s, '#' ) === 0 ) {
333 continue;
334 }
335
336 $s = strtolower( $s );
337 $i = strpos( $s, ' ' );
338
339 if ( $i === false ) {
340 continue;
341 }
342
343 # print "processing MIME INFO line $s<br>";
344
345 $match = [];
346 if ( preg_match( '!\[\s*(\w+)\s*\]!', $s, $match ) ) {
347 $s = preg_replace( '!\[\s*(\w+)\s*\]!', '', $s );
348 $mtype = trim( strtoupper( $match[1] ) );
349 } else {
350 $mtype = MEDIATYPE_UNKNOWN;
351 }
352
353 $m = explode( ' ', $s );
354
355 if ( !isset( $this->mediaTypes[$mtype] ) ) {
356 $this->mediaTypes[$mtype] = [];
357 }
358
359 foreach ( $m as $mime ) {
360 $mime = trim( $mime );
361 if ( empty( $mime ) ) {
362 continue;
363 }
364
365 $this->mediaTypes[$mtype][] = $mime;
366 }
367
368 if ( count( $m ) > 1 ) {
369 $main = $m[0];
370 $mCount = count( $m );
371 for ( $i = 1; $i < $mCount; $i += 1 ) {
372 $mime = $m[$i];
373 $this->mimeTypeAliases[$mime] = $main;
374 }
375 }
376 }
377 }
378
379 public function setLogger( LoggerInterface $logger ) {
380 $this->logger = $logger;
381 }
382
383 /**
384 * Adds to the list mapping MIME to file extensions.
385 * As an extension author, you are encouraged to submit patches to
386 * MediaWiki's core to add new MIME types to mime.types.
387 * @param string $types
388 */
389 public function addExtraTypes( $types ) {
390 $this->extraTypes .= "\n" . $types;
391 }
392
393 /**
394 * Adds to the list mapping MIME to media type.
395 * As an extension author, you are encouraged to submit patches to
396 * MediaWiki's core to add new MIME info to mime.info.
397 * @param string $info
398 */
399 public function addExtraInfo( $info ) {
400 $this->extraInfo .= "\n" . $info;
401 }
402
403 /**
404 * Returns a list of file extensions for a given MIME type as a space
405 * separated string or null if the MIME type was unrecognized. Resolves
406 * MIME type aliases.
407 *
408 * @param string $mime
409 * @return string|null
410 */
411 public function getExtensionsForType( $mime ) {
412 $mime = strtolower( $mime );
413
414 // Check the mime-to-ext map
415 if ( isset( $this->mimetoExt[$mime] ) ) {
416 return $this->mimetoExt[$mime];
417 }
418
419 // Resolve the MIME type to the canonical type
420 if ( isset( $this->mimeTypeAliases[$mime] ) ) {
421 $mime = $this->mimeTypeAliases[$mime];
422 if ( isset( $this->mimetoExt[$mime] ) ) {
423 return $this->mimetoExt[$mime];
424 }
425 }
426
427 return null;
428 }
429
430 /**
431 * Returns a list of MIME types for a given file extension as a space
432 * separated string or null if the extension was unrecognized.
433 *
434 * @param string $ext
435 * @return string|null
436 */
437 public function getTypesForExtension( $ext ) {
438 $ext = strtolower( $ext );
439
440 $r = isset( $this->mExtToMime[$ext] ) ? $this->mExtToMime[$ext] : null;
441 return $r;
442 }
443
444 /**
445 * Returns a single MIME type for a given file extension or null if unknown.
446 * This is always the first type from the list returned by getTypesForExtension($ext).
447 *
448 * @param string $ext
449 * @return string|null
450 */
451 public function guessTypesForExtension( $ext ) {
452 $m = $this->getTypesForExtension( $ext );
453 if ( is_null( $m ) ) {
454 return null;
455 }
456
457 // TODO: Check if this is needed; strtok( $m, ' ' ) should be sufficient
458 $m = trim( $m );
459 $m = preg_replace( '/\s.*$/', '', $m );
460
461 return $m;
462 }
463
464 /**
465 * Tests if the extension matches the given MIME type. Returns true if a
466 * match was found, null if the MIME type is unknown, and false if the
467 * MIME type is known but no matches where found.
468 *
469 * @param string $extension
470 * @param string $mime
471 * @return bool|null
472 */
473 public function isMatchingExtension( $extension, $mime ) {
474 $ext = $this->getExtensionsForType( $mime );
475
476 if ( !$ext ) {
477 return null; // Unknown MIME type
478 }
479
480 $ext = explode( ' ', $ext );
481
482 $extension = strtolower( $extension );
483 return in_array( $extension, $ext );
484 }
485
486 /**
487 * Returns true if the MIME type is known to represent an image format
488 * supported by the PHP GD library.
489 *
490 * @param string $mime
491 *
492 * @return bool
493 */
494 public function isPHPImageType( $mime ) {
495 // As defined by imagegetsize and image_type_to_mime
496 static $types = [
497 'image/gif', 'image/jpeg', 'image/png',
498 'image/x-bmp', 'image/xbm', 'image/tiff',
499 'image/jp2', 'image/jpeg2000', 'image/iff',
500 'image/xbm', 'image/x-xbitmap',
501 'image/vnd.wap.wbmp', 'image/vnd.xiff',
502 'image/x-photoshop',
503 'application/x-shockwave-flash',
504 ];
505
506 return in_array( $mime, $types );
507 }
508
509 /**
510 * Returns true if the extension represents a type which can
511 * be reliably detected from its content. Use this to determine
512 * whether strict content checks should be applied to reject
513 * invalid uploads; if we can't identify the type we won't
514 * be able to say if it's invalid.
515 *
516 * @todo Be more accurate when using fancy MIME detector plugins;
517 * right now this is the bare minimum getimagesize() list.
518 * @param string $extension
519 * @return bool
520 */
521 function isRecognizableExtension( $extension ) {
522 static $types = [
523 // Types recognized by getimagesize()
524 'gif', 'jpeg', 'jpg', 'png', 'swf', 'psd',
525 'bmp', 'tiff', 'tif', 'jpc', 'jp2',
526 'jpx', 'jb2', 'swc', 'iff', 'wbmp',
527 'xbm',
528
529 // Formats we recognize magic numbers for
530 'djvu', 'ogx', 'ogg', 'ogv', 'oga', 'spx', 'opus',
531 'mid', 'pdf', 'wmf', 'xcf', 'webm', 'mkv', 'mka',
532 'webp', 'mp3',
533
534 // XML formats we sure hope we recognize reliably
535 'svg',
536
537 // 3D formats
538 'stl',
539 ];
540 return in_array( strtolower( $extension ), $types );
541 }
542
543 /**
544 * Improves a MIME type using the file extension. Some file formats are very generic,
545 * so their MIME type is not very meaningful. A more useful MIME type can be derived
546 * by looking at the file extension. Typically, this method would be called on the
547 * result of guessMimeType().
548 *
549 * @param string $mime The MIME type, typically guessed from a file's content.
550 * @param string $ext The file extension, as taken from the file name
551 *
552 * @return string The MIME type
553 */
554 public function improveTypeFromExtension( $mime, $ext ) {
555 if ( $mime === 'unknown/unknown' ) {
556 if ( $this->isRecognizableExtension( $ext ) ) {
557 $this->logger->info( __METHOD__ . ': refusing to guess mime type for .' .
558 "$ext file, we should have recognized it\n" );
559 } else {
560 // Not something we can detect, so simply
561 // trust the file extension
562 $mime = $this->guessTypesForExtension( $ext );
563 }
564 } elseif ( $mime === 'application/x-opc+zip' ) {
565 if ( $this->isMatchingExtension( $ext, $mime ) ) {
566 // A known file extension for an OPC file,
567 // find the proper MIME type for that file extension
568 $mime = $this->guessTypesForExtension( $ext );
569 } else {
570 $this->logger->info( __METHOD__ .
571 ": refusing to guess better type for $mime file, " .
572 ".$ext is not a known OPC extension.\n" );
573 $mime = 'application/zip';
574 }
575 } elseif ( $mime === 'text/plain' && $this->findMediaType( ".$ext" ) === MEDIATYPE_TEXT ) {
576 // Textual types are sometimes not recognized properly.
577 // If detected as text/plain, and has an extension which is textual
578 // improve to the extension's type. For example, csv and json are often
579 // misdetected as text/plain.
580 $mime = $this->guessTypesForExtension( $ext );
581 }
582
583 # Media handling extensions can improve the MIME detected
584 $callback = $this->extCallback;
585 if ( $callback ) {
586 $callback( $this, $ext, $mime /* by reference */ );
587 }
588
589 if ( isset( $this->mimeTypeAliases[$mime] ) ) {
590 $mime = $this->mimeTypeAliases[$mime];
591 }
592
593 $this->logger->info( __METHOD__ . ": improved mime type for .$ext: $mime\n" );
594 return $mime;
595 }
596
597 /**
598 * MIME type detection. This uses detectMimeType to detect the MIME type
599 * of the file, but applies additional checks to determine some well known
600 * file formats that may be missed or misinterpreted by the default MIME
601 * detection (namely XML based formats like XHTML or SVG, as well as ZIP
602 * based formats like OPC/ODF files).
603 *
604 * @param string $file The file to check
605 * @param string|bool $ext The file extension, or true (default) to extract
606 * it from the filename. Set it to false to ignore the extension. DEPRECATED!
607 * Set to false, use improveTypeFromExtension($mime, $ext) later to improve MIME type.
608 *
609 * @return string The MIME type of $file
610 */
611 public function guessMimeType( $file, $ext = true ) {
612 if ( $ext ) { // TODO: make $ext default to false. Or better, remove it.
613 $this->logger->info( __METHOD__ .
614 ": WARNING: use of the \$ext parameter is deprecated. " .
615 "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
616 }
617
618 $mime = $this->doGuessMimeType( $file, $ext );
619
620 if ( !$mime ) {
621 $this->logger->info( __METHOD__ .
622 ": internal type detection failed for $file (.$ext)...\n" );
623 $mime = $this->detectMimeType( $file, $ext );
624 }
625
626 if ( isset( $this->mimeTypeAliases[$mime] ) ) {
627 $mime = $this->mimeTypeAliases[$mime];
628 }
629
630 $this->logger->info( __METHOD__ . ": guessed mime type of $file: $mime\n" );
631 return $mime;
632 }
633
634 /**
635 * Guess the MIME type from the file contents.
636 *
637 * @todo Remove $ext param
638 *
639 * @param string $file
640 * @param mixed $ext
641 * @return bool|string
642 * @throws UnexpectedValueException
643 */
644 private function doGuessMimeType( $file, $ext ) {
645 // Read a chunk of the file
646 Wikimedia\suppressWarnings();
647 $f = fopen( $file, 'rb' );
648 Wikimedia\restoreWarnings();
649
650 if ( !$f ) {
651 return 'unknown/unknown';
652 }
653
654 $fsize = filesize( $file );
655 if ( $fsize === false ) {
656 return 'unknown/unknown';
657 }
658
659 $head = fread( $f, 1024 );
660 $tailLength = min( 65558, $fsize ); // 65558 = maximum size of a zip EOCDR
661 if ( fseek( $f, -1 * $tailLength, SEEK_END ) === -1 ) {
662 throw new UnexpectedValueException(
663 "Seeking $tailLength bytes from EOF failed in " . __METHOD__ );
664 }
665 $tail = $tailLength ? fread( $f, $tailLength ) : '';
666 fclose( $f );
667
668 $this->logger->info( __METHOD__ .
669 ": analyzing head and tail of $file for magic numbers.\n" );
670
671 // Hardcode a few magic number checks...
672 $headers = [
673 // Multimedia...
674 'MThd' => 'audio/midi',
675 'OggS' => 'application/ogg',
676 'ID3' => 'audio/mpeg',
677 "\xff\xfb" => 'audio/mpeg', // MPEG-1 layer 3
678 "\xff\xf3" => 'audio/mpeg', // MPEG-2 layer 3 (lower sample rates)
679 "\xff\xe3" => 'audio/mpeg', // MPEG-2.5 layer 3 (very low sample rates)
680
681 // Image formats...
682 // Note that WMF may have a bare header, no magic number.
683 "\x01\x00\x09\x00" => 'application/x-msmetafile', // Possibly prone to false positives?
684 "\xd7\xcd\xc6\x9a" => 'application/x-msmetafile',
685 '%PDF' => 'application/pdf',
686 'gimp xcf' => 'image/x-xcf',
687
688 // Some forbidden fruit...
689 'MZ' => 'application/octet-stream', // DOS/Windows executable
690 "\xca\xfe\xba\xbe" => 'application/octet-stream', // Mach-O binary
691 "\x7fELF" => 'application/octet-stream', // ELF binary
692 ];
693
694 foreach ( $headers as $magic => $candidate ) {
695 if ( strncmp( $head, $magic, strlen( $magic ) ) == 0 ) {
696 $this->logger->info( __METHOD__ .
697 ": magic header in $file recognized as $candidate\n" );
698 return $candidate;
699 }
700 }
701
702 /* Look for WebM and Matroska files */
703 if ( strncmp( $head, pack( "C4", 0x1a, 0x45, 0xdf, 0xa3 ), 4 ) == 0 ) {
704 $doctype = strpos( $head, "\x42\x82" );
705 if ( $doctype ) {
706 // Next byte is datasize, then data (sizes larger than 1 byte are stupid muxers)
707 $data = substr( $head, $doctype + 3, 8 );
708 if ( strncmp( $data, "matroska", 8 ) == 0 ) {
709 $this->logger->info( __METHOD__ . ": recognized file as video/x-matroska\n" );
710 return "video/x-matroska";
711 } elseif ( strncmp( $data, "webm", 4 ) == 0 ) {
712 // XXX HACK look for a video track, if we don't find it, this is an audio file
713 $videotrack = strpos( $head, "\x86\x85V_VP" );
714
715 if ( $videotrack ) {
716 // There is a video track, so this is a video file.
717 $this->logger->info( __METHOD__ . ": recognized file as video/webm\n" );
718 return "video/webm";
719 }
720
721 $this->logger->info( __METHOD__ . ": recognized file as audio/webm\n" );
722 return "audio/webm";
723 }
724 }
725 $this->logger->info( __METHOD__ . ": unknown EBML file\n" );
726 return "unknown/unknown";
727 }
728
729 /* Look for WebP */
730 if ( strncmp( $head, "RIFF", 4 ) == 0 &&
731 strncmp( substr( $head, 8, 7 ), "WEBPVP8", 7 ) == 0
732 ) {
733 $this->logger->info( __METHOD__ . ": recognized file as image/webp\n" );
734 return "image/webp";
735 }
736
737 /**
738 * Look for PHP. Check for this before HTML/XML... Warning: this is a
739 * heuristic, and won't match a file with a lot of non-PHP before. It
740 * will also match text files which could be PHP. :)
741 *
742 * @todo FIXME: For this reason, the check is probably useless -- an attacker
743 * could almost certainly just pad the file with a lot of nonsense to
744 * circumvent the check in any case where it would be a security
745 * problem. On the other hand, it causes harmful false positives (bug
746 * 16583). The heuristic has been cut down to exclude three-character
747 * strings like "<? ", but should it be axed completely?
748 */
749 if ( ( strpos( $head, '<?php' ) !== false ) ||
750 ( strpos( $head, "<\x00?\x00p\x00h\x00p" ) !== false ) ||
751 ( strpos( $head, "<\x00?\x00 " ) !== false ) ||
752 ( strpos( $head, "<\x00?\x00\n" ) !== false ) ||
753 ( strpos( $head, "<\x00?\x00\t" ) !== false ) ||
754 ( strpos( $head, "<\x00?\x00=" ) !== false )
755 ) {
756 $this->logger->info( __METHOD__ . ": recognized $file as application/x-php\n" );
757 return 'application/x-php';
758 }
759
760 /**
761 * look for XML formats (XHTML and SVG)
762 */
763 Wikimedia\suppressWarnings();
764 $xml = new XmlTypeCheck( $file );
765 Wikimedia\restoreWarnings();
766 if ( $xml->wellFormed ) {
767 $xmlTypes = $this->xmlTypes;
768 if ( isset( $xmlTypes[$xml->getRootElement()] ) ) {
769 return $xmlTypes[$xml->getRootElement()];
770 } else {
771 return 'application/xml';
772 }
773 }
774
775 /**
776 * look for shell scripts
777 */
778 $script_type = null;
779
780 # detect by shebang
781 if ( substr( $head, 0, 2 ) == "#!" ) {
782 $script_type = "ASCII";
783 } elseif ( substr( $head, 0, 5 ) == "\xef\xbb\xbf#!" ) {
784 $script_type = "UTF-8";
785 } elseif ( substr( $head, 0, 7 ) == "\xfe\xff\x00#\x00!" ) {
786 $script_type = "UTF-16BE";
787 } elseif ( substr( $head, 0, 7 ) == "\xff\xfe#\x00!" ) {
788 $script_type = "UTF-16LE";
789 }
790
791 if ( $script_type ) {
792 if ( $script_type !== "UTF-8" && $script_type !== "ASCII" ) {
793 // Quick and dirty fold down to ASCII!
794 $pack = [ 'UTF-16BE' => 'n*', 'UTF-16LE' => 'v*' ];
795 $chars = unpack( $pack[$script_type], substr( $head, 2 ) );
796 $head = '';
797 foreach ( $chars as $codepoint ) {
798 if ( $codepoint < 128 ) {
799 $head .= chr( $codepoint );
800 } else {
801 $head .= '?';
802 }
803 }
804 }
805
806 $match = [];
807
808 if ( preg_match( '%/?([^\s]+/)(\w+)%', $head, $match ) ) {
809 $mime = "application/x-{$match[2]}";
810 $this->logger->info( __METHOD__ . ": shell script recognized as $mime\n" );
811 return $mime;
812 }
813 }
814
815 // Check for ZIP variants (before getimagesize)
816 if ( strpos( $tail, "PK\x05\x06" ) !== false ) {
817 $this->logger->info( __METHOD__ . ": ZIP header present in $file\n" );
818 return $this->detectZipType( $head, $tail, $ext );
819 }
820
821 // Check for STL (3D) files
822 // @see https://en.wikipedia.org/wiki/STL_(file_format)
823 if ( $fsize >= 15 &&
824 stripos( $head, 'SOLID ' ) === 0 &&
825 preg_match( '/\RENDSOLID .*$/i', $tail ) ) {
826 // ASCII STL file
827 return 'application/sla';
828 } elseif ( $fsize > 84 ) {
829 // binary STL file
830 $triangles = substr( $head, 80, 4 );
831 $triangles = unpack( 'V', $triangles );
832 $triangles = reset( $triangles );
833 if ( $triangles !== false && $fsize === 84 + ( $triangles * 50 ) ) {
834 return 'application/sla';
835 }
836 }
837
838 Wikimedia\suppressWarnings();
839 $gis = getimagesize( $file );
840 Wikimedia\restoreWarnings();
841
842 if ( $gis && isset( $gis['mime'] ) ) {
843 $mime = $gis['mime'];
844 $this->logger->info( __METHOD__ . ": getimagesize detected $file as $mime\n" );
845 return $mime;
846 }
847
848 # Media handling extensions can guess the MIME by content
849 # It's intentionally here so that if core is wrong about a type (false positive),
850 # people will hopefully nag and submit patches :)
851 $mime = false;
852 # Some strings by reference for performance - assuming well-behaved hooks
853 $callback = $this->guessCallback;
854 if ( $callback ) {
855 $callback( $this, $head, $tail, $file, $mime /* by reference */ );
856 };
857
858 return $mime;
859 }
860
861 /**
862 * Detect application-specific file type of a given ZIP file from its
863 * header data. Currently works for OpenDocument and OpenXML types...
864 * If can't tell, returns 'application/zip'.
865 *
866 * @param string $header Some reasonably-sized chunk of file header
867 * @param string|null $tail The tail of the file
868 * @param string|bool $ext The file extension, or true to extract it from the filename.
869 * Set it to false (default) to ignore the extension. DEPRECATED! Set to false,
870 * use improveTypeFromExtension($mime, $ext) later to improve MIME type.
871 *
872 * @return string
873 */
874 function detectZipType( $header, $tail = null, $ext = false ) {
875 if ( $ext ) { # TODO: remove $ext param
876 $this->logger->info( __METHOD__ .
877 ": WARNING: use of the \$ext parameter is deprecated. " .
878 "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
879 }
880
881 $mime = 'application/zip';
882 $opendocTypes = [
883 'chart-template',
884 'chart',
885 'formula-template',
886 'formula',
887 'graphics-template',
888 'graphics',
889 'image-template',
890 'image',
891 'presentation-template',
892 'presentation',
893 'spreadsheet-template',
894 'spreadsheet',
895 'text-template',
896 'text-master',
897 'text-web',
898 'text' ];
899
900 // https://lists.oasis-open.org/archives/office/200505/msg00006.html
901 $types = '(?:' . implode( '|', $opendocTypes ) . ')';
902 $opendocRegex = "/^mimetype(application\/vnd\.oasis\.opendocument\.$types)/";
903
904 $openxmlRegex = "/^\[Content_Types\].xml/";
905
906 if ( preg_match( $opendocRegex, substr( $header, 30 ), $matches ) ) {
907 $mime = $matches[1];
908 $this->logger->info( __METHOD__ . ": detected $mime from ZIP archive\n" );
909 } elseif ( preg_match( $openxmlRegex, substr( $header, 30 ) ) ) {
910 $mime = "application/x-opc+zip";
911 # TODO: remove the block below, as soon as improveTypeFromExtension is used everywhere
912 if ( $ext !== true && $ext !== false ) {
913 /** This is the mode used by getPropsFromPath
914 * These MIME's are stored in the database, where we don't really want
915 * x-opc+zip, because we use it only for internal purposes
916 */
917 if ( $this->isMatchingExtension( $ext, $mime ) ) {
918 /* A known file extension for an OPC file,
919 * find the proper mime type for that file extension
920 */
921 $mime = $this->guessTypesForExtension( $ext );
922 } else {
923 $mime = "application/zip";
924 }
925 }
926 $this->logger->info( __METHOD__ .
927 ": detected an Open Packaging Conventions archive: $mime\n" );
928 } elseif ( substr( $header, 0, 8 ) == "\xd0\xcf\x11\xe0\xa1\xb1\x1a\xe1" &&
929 ( $headerpos = strpos( $tail, "PK\x03\x04" ) ) !== false &&
930 preg_match( $openxmlRegex, substr( $tail, $headerpos + 30 ) ) ) {
931 if ( substr( $header, 512, 4 ) == "\xEC\xA5\xC1\x00" ) {
932 $mime = "application/msword";
933 }
934 switch ( substr( $header, 512, 6 ) ) {
935 case "\xEC\xA5\xC1\x00\x0E\x00":
936 case "\xEC\xA5\xC1\x00\x1C\x00":
937 case "\xEC\xA5\xC1\x00\x43\x00":
938 $mime = "application/vnd.ms-powerpoint";
939 break;
940 case "\xFD\xFF\xFF\xFF\x10\x00":
941 case "\xFD\xFF\xFF\xFF\x1F\x00":
942 case "\xFD\xFF\xFF\xFF\x22\x00":
943 case "\xFD\xFF\xFF\xFF\x23\x00":
944 case "\xFD\xFF\xFF\xFF\x28\x00":
945 case "\xFD\xFF\xFF\xFF\x29\x00":
946 case "\xFD\xFF\xFF\xFF\x10\x02":
947 case "\xFD\xFF\xFF\xFF\x1F\x02":
948 case "\xFD\xFF\xFF\xFF\x22\x02":
949 case "\xFD\xFF\xFF\xFF\x23\x02":
950 case "\xFD\xFF\xFF\xFF\x28\x02":
951 case "\xFD\xFF\xFF\xFF\x29\x02":
952 $mime = "application/vnd.msexcel";
953 break;
954 }
955
956 $this->logger->info( __METHOD__ .
957 ": detected a MS Office document with OPC trailer\n" );
958 } else {
959 $this->logger->info( __METHOD__ . ": unable to identify type of ZIP archive\n" );
960 }
961 return $mime;
962 }
963
964 /**
965 * Internal MIME type detection. Detection is done using the fileinfo
966 * extension if it is available. It can be overriden by callback, which could
967 * use an external program, for example. If detection fails and $ext is not false,
968 * the MIME type is guessed from the file extension, using guessTypesForExtension.
969 *
970 * If the MIME type is still unknown, getimagesize is used to detect the
971 * MIME type if the file is an image. If no MIME type can be determined,
972 * this function returns 'unknown/unknown'.
973 *
974 * @param string $file The file to check
975 * @param string|bool $ext The file extension, or true (default) to extract it from the filename.
976 * Set it to false to ignore the extension. DEPRECATED! Set to false, use
977 * improveTypeFromExtension($mime, $ext) later to improve MIME type.
978 *
979 * @return string The MIME type of $file
980 */
981 private function detectMimeType( $file, $ext = true ) {
982 /** @todo Make $ext default to false. Or better, remove it. */
983 if ( $ext ) {
984 $this->logger->info( __METHOD__ .
985 ": WARNING: use of the \$ext parameter is deprecated. "
986 . "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
987 }
988
989 $callback = $this->detectCallback;
990 $m = null;
991 if ( $callback ) {
992 $m = $callback( $file );
993 } else {
994 $m = mime_content_type( $file );
995 }
996
997 if ( $m ) {
998 # normalize
999 $m = preg_replace( '![;, ].*$!', '', $m ); # strip charset, etc
1000 $m = trim( $m );
1001 $m = strtolower( $m );
1002
1003 if ( strpos( $m, 'unknown' ) !== false ) {
1004 $m = null;
1005 } else {
1006 $this->logger->info( __METHOD__ . ": magic mime type of $file: $m\n" );
1007 return $m;
1008 }
1009 }
1010
1011 // If desired, look at extension as a fallback.
1012 if ( $ext === true ) {
1013 $i = strrpos( $file, '.' );
1014 $ext = strtolower( $i ? substr( $file, $i + 1 ) : '' );
1015 }
1016 if ( $ext ) {
1017 if ( $this->isRecognizableExtension( $ext ) ) {
1018 $this->logger->info( __METHOD__ . ": refusing to guess mime type for .$ext file, "
1019 . "we should have recognized it\n" );
1020 } else {
1021 $m = $this->guessTypesForExtension( $ext );
1022 if ( $m ) {
1023 $this->logger->info( __METHOD__ . ": extension mime type of $file: $m\n" );
1024 return $m;
1025 }
1026 }
1027 }
1028
1029 // Unknown type
1030 $this->logger->info( __METHOD__ . ": failed to guess mime type for $file!\n" );
1031 return 'unknown/unknown';
1032 }
1033
1034 /**
1035 * Determine the media type code for a file, using its MIME type, name and
1036 * possibly its contents.
1037 *
1038 * This function relies on the findMediaType(), mapping extensions and MIME
1039 * types to media types.
1040 *
1041 * @todo analyse file if need be
1042 * @todo look at multiple extension, separately and together.
1043 *
1044 * @param string $path Full path to the image file, in case we have to look at the contents
1045 * (if null, only the MIME type is used to determine the media type code).
1046 * @param string $mime MIME type. If null it will be guessed using guessMimeType.
1047 *
1048 * @return string A value to be used with the MEDIATYPE_xxx constants.
1049 */
1050 function getMediaType( $path = null, $mime = null ) {
1051 if ( !$mime && !$path ) {
1052 return MEDIATYPE_UNKNOWN;
1053 }
1054
1055 // If MIME type is unknown, guess it
1056 if ( !$mime ) {
1057 $mime = $this->guessMimeType( $path, false );
1058 }
1059
1060 // Special code for ogg - detect if it's video (theora),
1061 // else label it as sound.
1062 if ( $mime == 'application/ogg' && file_exists( $path ) ) {
1063 // Read a chunk of the file
1064 $f = fopen( $path, "rt" );
1065 if ( !$f ) {
1066 return MEDIATYPE_UNKNOWN;
1067 }
1068 $head = fread( $f, 256 );
1069 fclose( $f );
1070
1071 $head = str_replace( 'ffmpeg2theora', '', strtolower( $head ) );
1072
1073 // This is an UGLY HACK, file should be parsed correctly
1074 if ( strpos( $head, 'theora' ) !== false ) {
1075 return MEDIATYPE_VIDEO;
1076 } elseif ( strpos( $head, 'vorbis' ) !== false ) {
1077 return MEDIATYPE_AUDIO;
1078 } elseif ( strpos( $head, 'flac' ) !== false ) {
1079 return MEDIATYPE_AUDIO;
1080 } elseif ( strpos( $head, 'speex' ) !== false ) {
1081 return MEDIATYPE_AUDIO;
1082 } elseif ( strpos( $head, 'opus' ) !== false ) {
1083 return MEDIATYPE_AUDIO;
1084 } else {
1085 return MEDIATYPE_MULTIMEDIA;
1086 }
1087 }
1088
1089 $type = null;
1090 // Check for entry for full MIME type
1091 if ( $mime ) {
1092 $type = $this->findMediaType( $mime );
1093 if ( $type !== MEDIATYPE_UNKNOWN ) {
1094 return $type;
1095 }
1096 }
1097
1098 // Check for entry for file extension
1099 if ( $path ) {
1100 $i = strrpos( $path, '.' );
1101 $e = strtolower( $i ? substr( $path, $i + 1 ) : '' );
1102
1103 // TODO: look at multi-extension if this fails, parse from full path
1104 $type = $this->findMediaType( '.' . $e );
1105 if ( $type !== MEDIATYPE_UNKNOWN ) {
1106 return $type;
1107 }
1108 }
1109
1110 // Check major MIME type
1111 if ( $mime ) {
1112 $i = strpos( $mime, '/' );
1113 if ( $i !== false ) {
1114 $major = substr( $mime, 0, $i );
1115 $type = $this->findMediaType( $major );
1116 if ( $type !== MEDIATYPE_UNKNOWN ) {
1117 return $type;
1118 }
1119 }
1120 }
1121
1122 if ( !$type ) {
1123 $type = MEDIATYPE_UNKNOWN;
1124 }
1125
1126 return $type;
1127 }
1128
1129 /**
1130 * Returns a media code matching the given MIME type or file extension.
1131 * File extensions are represented by a string starting with a dot (.) to
1132 * distinguish them from MIME types.
1133 *
1134 * This function relies on the mapping defined by $this->mMediaTypes
1135 * @access private
1136 * @param string $extMime
1137 * @return int|string
1138 */
1139 function findMediaType( $extMime ) {
1140 if ( strpos( $extMime, '.' ) === 0 ) {
1141 // If it's an extension, look up the MIME types
1142 $m = $this->getTypesForExtension( substr( $extMime, 1 ) );
1143 if ( !$m ) {
1144 return MEDIATYPE_UNKNOWN;
1145 }
1146
1147 $m = explode( ' ', $m );
1148 } else {
1149 // Normalize MIME type
1150 if ( isset( $this->mimeTypeAliases[$extMime] ) ) {
1151 $extMime = $this->mimeTypeAliases[$extMime];
1152 }
1153
1154 $m = [ $extMime ];
1155 }
1156
1157 foreach ( $m as $mime ) {
1158 foreach ( $this->mediaTypes as $type => $codes ) {
1159 if ( in_array( $mime, $codes, true ) ) {
1160 return $type;
1161 }
1162 }
1163 }
1164
1165 return MEDIATYPE_UNKNOWN;
1166 }
1167
1168 /**
1169 * Returns an array of media types (MEDIATYPE_xxx constants)
1170 *
1171 * @return array
1172 */
1173 public function getMediaTypes() {
1174 return array_keys( $this->mediaTypes );
1175 }
1176
1177 /**
1178 * Get the MIME types that various versions of Internet Explorer would
1179 * detect from a chunk of the content.
1180 *
1181 * @param string $fileName The file name (unused at present)
1182 * @param string $chunk The first 256 bytes of the file
1183 * @param string $proposed The MIME type proposed by the server
1184 * @return array
1185 */
1186 public function getIEMimeTypes( $fileName, $chunk, $proposed ) {
1187 $ca = $this->getIEContentAnalyzer();
1188 return $ca->getRealMimesFromData( $fileName, $chunk, $proposed );
1189 }
1190
1191 /**
1192 * Get a cached instance of IEContentAnalyzer
1193 *
1194 * @return IEContentAnalyzer
1195 */
1196 protected function getIEContentAnalyzer() {
1197 if ( is_null( $this->IEAnalyzer ) ) {
1198 $this->IEAnalyzer = new IEContentAnalyzer;
1199 }
1200 return $this->IEAnalyzer;
1201 }
1202 }