3 * Module defining helper functions for detecting and dealing with MIME types.
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
22 use Psr\Log\LoggerAwareInterface
;
23 use Psr\Log\LoggerInterface
;
26 * Implements functions related to MIME types such as detection and mapping to file extension
30 class MimeAnalyzer
implements LoggerAwareInterface
{
38 protected $initCallback;
40 protected $detectCallback;
42 protected $guessCallback;
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;
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
55 /** @var IEContentAnalyzer */
56 protected $IEAnalyzer;
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 = '';
63 /** @var LoggerInterface */
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.
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.
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)
85 protected static $wellKnownTypes = <<<EOT
86 application/ogg ogx ogg ogm ogv oga spx opus
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
111 audio/ogg oga spx ogg opus
112 audio/opus opus ogg oga ogg spx
115 image/jpeg jpeg jpg jpe
123 image/x-portable-pixmap ppm
127 video/ogg ogv ogm ogg
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.
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]
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]
167 image/svg+xml [DRAWING]
169 image/vnd.djvu [BITMAP]
171 image/x-portable-pixmap [BITMAP]
176 unknown/unknown application/octet-stream application/x-empty [UNKNOWN]
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.
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']
201 $this->detectCallback
= isset( $params['detectCallback'] )
202 ?
$params['detectCallback']
204 $this->guessCallback
= isset( $params['guessCallback'] )
205 ?
$params['guessCallback']
207 $this->extCallback
= isset( $params['extCallback'] )
208 ?
$params['extCallback']
210 $this->logger
= isset( $params['logger'] )
212 : new \Psr\Log\
NullLogger();
217 protected function loadFiles() {
219 * --- load mime.types ---
222 # Allow media handling extensions adding MIME-types and MIME-info
223 if ( $this->initCallback
) {
224 call_user_func( $this->initCallback
, $this );
227 $types = self
::$wellKnownTypes;
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" );
234 $types .= file_get_contents( $mimeTypeFile );
236 $this->logger
->info( __METHOD__
. ": can't load mime types from $mimeTypeFile\n" );
239 $this->logger
->info( __METHOD__
.
240 ": no mime types file defined, using built-ins only.\n" );
243 $types .= "\n" . $this->extraTypes
;
245 $types = str_replace( [ "\r\n", "\n\r", "\n\n", "\r\r", "\r" ], "\n", $types );
246 $types = str_replace( "\t", " ", $types );
248 $this->mimetoExt
= [];
249 $this->mExtToMime
= [];
251 $lines = explode( "\n", $types );
252 foreach ( $lines as $s ) {
257 if ( strpos( $s, '#' ) === 0 ) {
261 $s = strtolower( $s );
262 $i = strpos( $s, ' ' );
264 if ( $i === false ) {
268 $mime = substr( $s, 0, $i );
269 $ext = trim( substr( $s, $i +
1 ) );
271 if ( empty( $ext ) ) {
275 if ( !empty( $this->mimetoExt
[$mime] ) ) {
276 $this->mimetoExt
[$mime] .= ' ' . $ext;
278 $this->mimetoExt
[$mime] = $ext;
281 $extensions = explode( ' ', $ext );
283 foreach ( $extensions as $e ) {
289 if ( !empty( $this->mExtToMime
[$e] ) ) {
290 $this->mExtToMime
[$e] .= ' ' . $mime;
292 $this->mExtToMime
[$e] = $mime;
298 * --- load mime.info ---
301 $mimeInfoFile = $this->infoFile
;
303 $info = self
::$wellKnownInfo;
305 if ( $mimeInfoFile ) {
306 if ( is_file( $mimeInfoFile ) && is_readable( $mimeInfoFile ) ) {
307 $this->logger
->info( __METHOD__
. ": loading mime info from $mimeInfoFile\n" );
309 $info .= file_get_contents( $mimeInfoFile );
311 $this->logger
->info( __METHOD__
. ": can't load mime info from $mimeInfoFile\n" );
314 $this->logger
->info( __METHOD__
.
315 ": no mime info file defined, using built-ins only.\n" );
318 $info .= "\n" . $this->extraInfo
;
320 $info = str_replace( [ "\r\n", "\n\r", "\n\n", "\r\r", "\r" ], "\n", $info );
321 $info = str_replace( "\t", " ", $info );
323 $this->mimeTypeAliases
= [];
324 $this->mediaTypes
= [];
326 $lines = explode( "\n", $info );
327 foreach ( $lines as $s ) {
332 if ( strpos( $s, '#' ) === 0 ) {
336 $s = strtolower( $s );
337 $i = strpos( $s, ' ' );
339 if ( $i === false ) {
343 # print "processing MIME INFO line $s<br>";
346 if ( preg_match( '!\[\s*(\w+)\s*\]!', $s, $match ) ) {
347 $s = preg_replace( '!\[\s*(\w+)\s*\]!', '', $s );
348 $mtype = trim( strtoupper( $match[1] ) );
350 $mtype = MEDIATYPE_UNKNOWN
;
353 $m = explode( ' ', $s );
355 if ( !isset( $this->mediaTypes
[$mtype] ) ) {
356 $this->mediaTypes
[$mtype] = [];
359 foreach ( $m as $mime ) {
360 $mime = trim( $mime );
361 if ( empty( $mime ) ) {
365 $this->mediaTypes
[$mtype][] = $mime;
368 if ( count( $m ) > 1 ) {
370 $mCount = count( $m );
371 for ( $i = 1; $i < $mCount; $i +
= 1 ) {
373 $this->mimeTypeAliases
[$mime] = $main;
379 public function setLogger( LoggerInterface
$logger ) {
380 $this->logger
= $logger;
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
389 public function addExtraTypes( $types ) {
390 $this->extraTypes
.= "\n" . $types;
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
399 public function addExtraInfo( $info ) {
400 $this->extraInfo
.= "\n" . $info;
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
408 * @param string $mime
409 * @return string|null
411 public function getExtensionsForType( $mime ) {
412 $mime = strtolower( $mime );
414 // Check the mime-to-ext map
415 if ( isset( $this->mimetoExt
[$mime] ) ) {
416 return $this->mimetoExt
[$mime];
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];
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.
435 * @return string|null
437 public function getTypesForExtension( $ext ) {
438 $ext = strtolower( $ext );
440 $r = isset( $this->mExtToMime
[$ext] ) ?
$this->mExtToMime
[$ext] : null;
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).
449 * @return string|null
451 public function guessTypesForExtension( $ext ) {
452 $m = $this->getTypesForExtension( $ext );
453 if ( is_null( $m ) ) {
457 // TODO: Check if this is needed; strtok( $m, ' ' ) should be sufficient
459 $m = preg_replace( '/\s.*$/', '', $m );
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.
469 * @param string $extension
470 * @param string $mime
473 public function isMatchingExtension( $extension, $mime ) {
474 $ext = $this->getExtensionsForType( $mime );
477 return null; // Unknown MIME type
480 $ext = explode( ' ', $ext );
482 $extension = strtolower( $extension );
483 return in_array( $extension, $ext );
487 * Returns true if the MIME type is known to represent an image format
488 * supported by the PHP GD library.
490 * @param string $mime
494 public function isPHPImageType( $mime ) {
495 // As defined by imagegetsize and image_type_to_mime
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',
503 'application/x-shockwave-flash',
506 return in_array( $mime, $types );
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.
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
521 function isRecognizableExtension( $extension ) {
523 // Types recognized by getimagesize()
524 'gif', 'jpeg', 'jpg', 'png', 'swf', 'psd',
525 'bmp', 'tiff', 'tif', 'jpc', 'jp2',
526 'jpx', 'jb2', 'swc', 'iff', 'wbmp',
529 // Formats we recognize magic numbers for
530 'djvu', 'ogx', 'ogg', 'ogv', 'oga', 'spx', 'opus',
531 'mid', 'pdf', 'wmf', 'xcf', 'webm', 'mkv', 'mka',
534 // XML formats we sure hope we recognize reliably
540 return in_array( strtolower( $extension ), $types );
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().
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
552 * @return string The MIME type
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" );
560 // Not something we can detect, so simply
561 // trust the file extension
562 $mime = $this->guessTypesForExtension( $ext );
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 );
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';
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 );
583 # Media handling extensions can improve the MIME detected
584 $callback = $this->extCallback
;
586 $callback( $this, $ext, $mime /* by reference */ );
589 if ( isset( $this->mimeTypeAliases
[$mime] ) ) {
590 $mime = $this->mimeTypeAliases
[$mime];
593 $this->logger
->info( __METHOD__
. ": improved mime type for .$ext: $mime\n" );
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).
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.
609 * @return string The MIME type of $file
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" );
618 $mime = $this->doGuessMimeType( $file, $ext );
621 $this->logger
->info( __METHOD__
.
622 ": internal type detection failed for $file (.$ext)...\n" );
623 $mime = $this->detectMimeType( $file, $ext );
626 if ( isset( $this->mimeTypeAliases
[$mime] ) ) {
627 $mime = $this->mimeTypeAliases
[$mime];
630 $this->logger
->info( __METHOD__
. ": guessed mime type of $file: $mime\n" );
635 * Guess the MIME type from the file contents.
637 * @todo Remove $ext param
639 * @param string $file
641 * @return bool|string
642 * @throws UnexpectedValueException
644 private function doGuessMimeType( $file, $ext ) {
645 // Read a chunk of the file
646 MediaWiki\
suppressWarnings();
647 $f = fopen( $file, 'rb' );
648 MediaWiki\restoreWarnings
();
651 return 'unknown/unknown';
654 $fsize = filesize( $file );
655 if ( $fsize === false ) {
656 return 'unknown/unknown';
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__
);
665 $tail = $tailLength ?
fread( $f, $tailLength ) : '';
668 $this->logger
->info( __METHOD__
.
669 ": analyzing head and tail of $file for magic numbers.\n" );
671 // Hardcode a few magic number checks...
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)
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',
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
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" );
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" );
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" );
716 // There is a video track, so this is a video file.
717 $this->logger
->info( __METHOD__
. ": recognized file as video/webm\n" );
721 $this->logger
->info( __METHOD__
. ": recognized file as audio/webm\n" );
725 $this->logger
->info( __METHOD__
. ": unknown EBML file\n" );
726 return "unknown/unknown";
730 if ( strncmp( $head, "RIFF", 4 ) == 0 &&
731 strncmp( substr( $head, 8, 7 ), "WEBPVP8", 7 ) == 0
733 $this->logger
->info( __METHOD__
. ": recognized file as image/webp\n" );
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. :)
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?
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 )
756 $this->logger
->info( __METHOD__
. ": recognized $file as application/x-php\n" );
757 return 'application/x-php';
761 * look for XML formats (XHTML and SVG)
763 $xml = new XmlTypeCheck( $file );
764 if ( $xml->wellFormed
) {
765 $xmlTypes = $this->xmlTypes
;
766 if ( isset( $xmlTypes[$xml->getRootElement()] ) ) {
767 return $xmlTypes[$xml->getRootElement()];
769 return 'application/xml';
774 * look for shell scripts
779 if ( substr( $head, 0, 2 ) == "#!" ) {
780 $script_type = "ASCII";
781 } elseif ( substr( $head, 0, 5 ) == "\xef\xbb\xbf#!" ) {
782 $script_type = "UTF-8";
783 } elseif ( substr( $head, 0, 7 ) == "\xfe\xff\x00#\x00!" ) {
784 $script_type = "UTF-16BE";
785 } elseif ( substr( $head, 0, 7 ) == "\xff\xfe#\x00!" ) {
786 $script_type = "UTF-16LE";
789 if ( $script_type ) {
790 if ( $script_type !== "UTF-8" && $script_type !== "ASCII" ) {
791 // Quick and dirty fold down to ASCII!
792 $pack = [ 'UTF-16BE' => 'n*', 'UTF-16LE' => 'v*' ];
793 $chars = unpack( $pack[$script_type], substr( $head, 2 ) );
795 foreach ( $chars as $codepoint ) {
796 if ( $codepoint < 128 ) {
797 $head .= chr( $codepoint );
806 if ( preg_match( '%/?([^\s]+/)(\w+)%', $head, $match ) ) {
807 $mime = "application/x-{$match[2]}";
808 $this->logger
->info( __METHOD__
. ": shell script recognized as $mime\n" );
813 // Check for ZIP variants (before getimagesize)
814 if ( strpos( $tail, "PK\x05\x06" ) !== false ) {
815 $this->logger
->info( __METHOD__
. ": ZIP header present in $file\n" );
816 return $this->detectZipType( $head, $tail, $ext );
819 // Check for STL (3D) files
820 // @see https://en.wikipedia.org/wiki/STL_(file_format)
822 stripos( $head, 'SOLID ' ) === 0 &&
823 preg_match( '/\RENDSOLID .*$/i', $tail ) ) {
825 return 'application/sla';
826 } elseif ( $fsize > 84 ) {
828 $triangles = substr( $head, 80, 4 );
829 $triangles = unpack( 'V', $triangles );
830 $triangles = reset( $triangles );
831 if ( $triangles !== false && $fsize === 84 +
( $triangles * 50 ) ) {
832 return 'application/sla';
836 MediaWiki\
suppressWarnings();
837 $gis = getimagesize( $file );
838 MediaWiki\restoreWarnings
();
840 if ( $gis && isset( $gis['mime'] ) ) {
841 $mime = $gis['mime'];
842 $this->logger
->info( __METHOD__
. ": getimagesize detected $file as $mime\n" );
846 # Media handling extensions can guess the MIME by content
847 # It's intentionally here so that if core is wrong about a type (false positive),
848 # people will hopefully nag and submit patches :)
850 # Some strings by reference for performance - assuming well-behaved hooks
851 $callback = $this->guessCallback
;
853 $callback( $this, $head, $tail, $file, $mime /* by reference */ );
860 * Detect application-specific file type of a given ZIP file from its
861 * header data. Currently works for OpenDocument and OpenXML types...
862 * If can't tell, returns 'application/zip'.
864 * @param string $header Some reasonably-sized chunk of file header
865 * @param string|null $tail The tail of the file
866 * @param string|bool $ext The file extension, or true to extract it from the filename.
867 * Set it to false (default) to ignore the extension. DEPRECATED! Set to false,
868 * use improveTypeFromExtension($mime, $ext) later to improve MIME type.
872 function detectZipType( $header, $tail = null, $ext = false ) {
873 if ( $ext ) { # TODO: remove $ext param
874 $this->logger
->info( __METHOD__
.
875 ": WARNING: use of the \$ext parameter is deprecated. " .
876 "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
879 $mime = 'application/zip';
889 'presentation-template',
891 'spreadsheet-template',
898 // https://lists.oasis-open.org/archives/office/200505/msg00006.html
899 $types = '(?:' . implode( '|', $opendocTypes ) . ')';
900 $opendocRegex = "/^mimetype(application\/vnd\.oasis\.opendocument\.$types)/";
902 $openxmlRegex = "/^\[Content_Types\].xml/";
904 if ( preg_match( $opendocRegex, substr( $header, 30 ), $matches ) ) {
906 $this->logger
->info( __METHOD__
. ": detected $mime from ZIP archive\n" );
907 } elseif ( preg_match( $openxmlRegex, substr( $header, 30 ) ) ) {
908 $mime = "application/x-opc+zip";
909 # TODO: remove the block below, as soon as improveTypeFromExtension is used everywhere
910 if ( $ext !== true && $ext !== false ) {
911 /** This is the mode used by getPropsFromPath
912 * These MIME's are stored in the database, where we don't really want
913 * x-opc+zip, because we use it only for internal purposes
915 if ( $this->isMatchingExtension( $ext, $mime ) ) {
916 /* A known file extension for an OPC file,
917 * find the proper mime type for that file extension
919 $mime = $this->guessTypesForExtension( $ext );
921 $mime = "application/zip";
924 $this->logger
->info( __METHOD__
.
925 ": detected an Open Packaging Conventions archive: $mime\n" );
926 } elseif ( substr( $header, 0, 8 ) == "\xd0\xcf\x11\xe0\xa1\xb1\x1a\xe1" &&
927 ( $headerpos = strpos( $tail, "PK\x03\x04" ) ) !== false &&
928 preg_match( $openxmlRegex, substr( $tail, $headerpos +
30 ) ) ) {
929 if ( substr( $header, 512, 4 ) == "\xEC\xA5\xC1\x00" ) {
930 $mime = "application/msword";
932 switch ( substr( $header, 512, 6 ) ) {
933 case "\xEC\xA5\xC1\x00\x0E\x00":
934 case "\xEC\xA5\xC1\x00\x1C\x00":
935 case "\xEC\xA5\xC1\x00\x43\x00":
936 $mime = "application/vnd.ms-powerpoint";
938 case "\xFD\xFF\xFF\xFF\x10\x00":
939 case "\xFD\xFF\xFF\xFF\x1F\x00":
940 case "\xFD\xFF\xFF\xFF\x22\x00":
941 case "\xFD\xFF\xFF\xFF\x23\x00":
942 case "\xFD\xFF\xFF\xFF\x28\x00":
943 case "\xFD\xFF\xFF\xFF\x29\x00":
944 case "\xFD\xFF\xFF\xFF\x10\x02":
945 case "\xFD\xFF\xFF\xFF\x1F\x02":
946 case "\xFD\xFF\xFF\xFF\x22\x02":
947 case "\xFD\xFF\xFF\xFF\x23\x02":
948 case "\xFD\xFF\xFF\xFF\x28\x02":
949 case "\xFD\xFF\xFF\xFF\x29\x02":
950 $mime = "application/vnd.msexcel";
954 $this->logger
->info( __METHOD__
.
955 ": detected a MS Office document with OPC trailer\n" );
957 $this->logger
->info( __METHOD__
. ": unable to identify type of ZIP archive\n" );
963 * Internal MIME type detection. Detection is done using the fileinfo
964 * extension if it is available. It can be overriden by callback, which could
965 * use an external program, for example. If detection fails and $ext is not false,
966 * the MIME type is guessed from the file extension, using guessTypesForExtension.
968 * If the MIME type is still unknown, getimagesize is used to detect the
969 * MIME type if the file is an image. If no MIME type can be determined,
970 * this function returns 'unknown/unknown'.
972 * @param string $file The file to check
973 * @param string|bool $ext The file extension, or true (default) to extract it from the filename.
974 * Set it to false to ignore the extension. DEPRECATED! Set to false, use
975 * improveTypeFromExtension($mime, $ext) later to improve MIME type.
977 * @return string The MIME type of $file
979 private function detectMimeType( $file, $ext = true ) {
980 /** @todo Make $ext default to false. Or better, remove it. */
982 $this->logger
->info( __METHOD__
.
983 ": WARNING: use of the \$ext parameter is deprecated. "
984 . "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
987 $callback = $this->detectCallback
;
990 $m = $callback( $file );
992 $m = mime_content_type( $file );
997 $m = preg_replace( '![;, ].*$!', '', $m ); # strip charset, etc
999 $m = strtolower( $m );
1001 if ( strpos( $m, 'unknown' ) !== false ) {
1004 $this->logger
->info( __METHOD__
. ": magic mime type of $file: $m\n" );
1009 // If desired, look at extension as a fallback.
1010 if ( $ext === true ) {
1011 $i = strrpos( $file, '.' );
1012 $ext = strtolower( $i ?
substr( $file, $i +
1 ) : '' );
1015 if ( $this->isRecognizableExtension( $ext ) ) {
1016 $this->logger
->info( __METHOD__
. ": refusing to guess mime type for .$ext file, "
1017 . "we should have recognized it\n" );
1019 $m = $this->guessTypesForExtension( $ext );
1021 $this->logger
->info( __METHOD__
. ": extension mime type of $file: $m\n" );
1028 $this->logger
->info( __METHOD__
. ": failed to guess mime type for $file!\n" );
1029 return 'unknown/unknown';
1033 * Determine the media type code for a file, using its MIME type, name and
1034 * possibly its contents.
1036 * This function relies on the findMediaType(), mapping extensions and MIME
1037 * types to media types.
1039 * @todo analyse file if need be
1040 * @todo look at multiple extension, separately and together.
1042 * @param string $path Full path to the image file, in case we have to look at the contents
1043 * (if null, only the MIME type is used to determine the media type code).
1044 * @param string $mime MIME type. If null it will be guessed using guessMimeType.
1046 * @return string A value to be used with the MEDIATYPE_xxx constants.
1048 function getMediaType( $path = null, $mime = null ) {
1049 if ( !$mime && !$path ) {
1050 return MEDIATYPE_UNKNOWN
;
1053 // If MIME type is unknown, guess it
1055 $mime = $this->guessMimeType( $path, false );
1058 // Special code for ogg - detect if it's video (theora),
1059 // else label it as sound.
1060 if ( $mime == 'application/ogg' && file_exists( $path ) ) {
1061 // Read a chunk of the file
1062 $f = fopen( $path, "rt" );
1064 return MEDIATYPE_UNKNOWN
;
1066 $head = fread( $f, 256 );
1069 $head = str_replace( 'ffmpeg2theora', '', strtolower( $head ) );
1071 // This is an UGLY HACK, file should be parsed correctly
1072 if ( strpos( $head, 'theora' ) !== false ) {
1073 return MEDIATYPE_VIDEO
;
1074 } elseif ( strpos( $head, 'vorbis' ) !== false ) {
1075 return MEDIATYPE_AUDIO
;
1076 } elseif ( strpos( $head, 'flac' ) !== false ) {
1077 return MEDIATYPE_AUDIO
;
1078 } elseif ( strpos( $head, 'speex' ) !== false ) {
1079 return MEDIATYPE_AUDIO
;
1080 } elseif ( strpos( $head, 'opus' ) !== false ) {
1081 return MEDIATYPE_AUDIO
;
1083 return MEDIATYPE_MULTIMEDIA
;
1088 // Check for entry for full MIME type
1090 $type = $this->findMediaType( $mime );
1091 if ( $type !== MEDIATYPE_UNKNOWN
) {
1096 // Check for entry for file extension
1098 $i = strrpos( $path, '.' );
1099 $e = strtolower( $i ?
substr( $path, $i +
1 ) : '' );
1101 // TODO: look at multi-extension if this fails, parse from full path
1102 $type = $this->findMediaType( '.' . $e );
1103 if ( $type !== MEDIATYPE_UNKNOWN
) {
1108 // Check major MIME type
1110 $i = strpos( $mime, '/' );
1111 if ( $i !== false ) {
1112 $major = substr( $mime, 0, $i );
1113 $type = $this->findMediaType( $major );
1114 if ( $type !== MEDIATYPE_UNKNOWN
) {
1121 $type = MEDIATYPE_UNKNOWN
;
1128 * Returns a media code matching the given MIME type or file extension.
1129 * File extensions are represented by a string starting with a dot (.) to
1130 * distinguish them from MIME types.
1132 * This function relies on the mapping defined by $this->mMediaTypes
1134 * @param string $extMime
1135 * @return int|string
1137 function findMediaType( $extMime ) {
1138 if ( strpos( $extMime, '.' ) === 0 ) {
1139 // If it's an extension, look up the MIME types
1140 $m = $this->getTypesForExtension( substr( $extMime, 1 ) );
1142 return MEDIATYPE_UNKNOWN
;
1145 $m = explode( ' ', $m );
1147 // Normalize MIME type
1148 if ( isset( $this->mimeTypeAliases
[$extMime] ) ) {
1149 $extMime = $this->mimeTypeAliases
[$extMime];
1155 foreach ( $m as $mime ) {
1156 foreach ( $this->mediaTypes
as $type => $codes ) {
1157 if ( in_array( $mime, $codes, true ) ) {
1163 return MEDIATYPE_UNKNOWN
;
1167 * Returns an array of media types (MEDIATYPE_xxx constants)
1171 public function getMediaTypes() {
1172 return array_keys( $this->mediaTypes
);
1176 * Get the MIME types that various versions of Internet Explorer would
1177 * detect from a chunk of the content.
1179 * @param string $fileName The file name (unused at present)
1180 * @param string $chunk The first 256 bytes of the file
1181 * @param string $proposed The MIME type proposed by the server
1184 public function getIEMimeTypes( $fileName, $chunk, $proposed ) {
1185 $ca = $this->getIEContentAnalyzer();
1186 return $ca->getRealMimesFromData( $fileName, $chunk, $proposed );
1190 * Get a cached instance of IEContentAnalyzer
1192 * @return IEContentAnalyzer
1194 protected function getIEContentAnalyzer() {
1195 if ( is_null( $this->IEAnalyzer
) ) {
1196 $this->IEAnalyzer
= new IEContentAnalyzer
;
1198 return $this->IEAnalyzer
;