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
= $params['initCallback'] ??
null;
199 $this->detectCallback
= $params['detectCallback'] ??
null;
200 $this->guessCallback
= $params['guessCallback'] ??
null;
201 $this->extCallback
= $params['extCallback'] ??
null;
202 $this->logger
= $params['logger'] ??
new \Psr\Log\
NullLogger();
207 protected function loadFiles() {
209 * --- load mime.types ---
212 # Allow media handling extensions adding MIME-types and MIME-info
213 if ( $this->initCallback
) {
214 call_user_func( $this->initCallback
, $this );
217 $types = self
::$wellKnownTypes;
219 $mimeTypeFile = $this->typeFile
;
220 if ( $mimeTypeFile ) {
221 if ( is_file( $mimeTypeFile ) && is_readable( $mimeTypeFile ) ) {
222 $this->logger
->info( __METHOD__
. ": loading mime types from $mimeTypeFile\n" );
224 $types .= file_get_contents( $mimeTypeFile );
226 $this->logger
->info( __METHOD__
. ": can't load mime types from $mimeTypeFile\n" );
229 $this->logger
->info( __METHOD__
.
230 ": no mime types file defined, using built-ins only.\n" );
233 $types .= "\n" . $this->extraTypes
;
235 $types = str_replace( [ "\r\n", "\n\r", "\n\n", "\r\r", "\r" ], "\n", $types );
236 $types = str_replace( "\t", " ", $types );
238 $this->mimetoExt
= [];
239 $this->mExtToMime
= [];
241 $lines = explode( "\n", $types );
242 foreach ( $lines as $s ) {
247 if ( strpos( $s, '#' ) === 0 ) {
251 $s = strtolower( $s );
252 $i = strpos( $s, ' ' );
254 if ( $i === false ) {
258 $mime = substr( $s, 0, $i );
259 $ext = trim( substr( $s, $i +
1 ) );
261 if ( empty( $ext ) ) {
265 if ( !empty( $this->mimetoExt
[$mime] ) ) {
266 $this->mimetoExt
[$mime] .= ' ' . $ext;
268 $this->mimetoExt
[$mime] = $ext;
271 $extensions = explode( ' ', $ext );
273 foreach ( $extensions as $e ) {
279 if ( !empty( $this->mExtToMime
[$e] ) ) {
280 $this->mExtToMime
[$e] .= ' ' . $mime;
282 $this->mExtToMime
[$e] = $mime;
288 * --- load mime.info ---
291 $mimeInfoFile = $this->infoFile
;
293 $info = self
::$wellKnownInfo;
295 if ( $mimeInfoFile ) {
296 if ( is_file( $mimeInfoFile ) && is_readable( $mimeInfoFile ) ) {
297 $this->logger
->info( __METHOD__
. ": loading mime info from $mimeInfoFile\n" );
299 $info .= file_get_contents( $mimeInfoFile );
301 $this->logger
->info( __METHOD__
. ": can't load mime info from $mimeInfoFile\n" );
304 $this->logger
->info( __METHOD__
.
305 ": no mime info file defined, using built-ins only.\n" );
308 $info .= "\n" . $this->extraInfo
;
310 $info = str_replace( [ "\r\n", "\n\r", "\n\n", "\r\r", "\r" ], "\n", $info );
311 $info = str_replace( "\t", " ", $info );
313 $this->mimeTypeAliases
= [];
314 $this->mediaTypes
= [];
316 $lines = explode( "\n", $info );
317 foreach ( $lines as $s ) {
322 if ( strpos( $s, '#' ) === 0 ) {
326 $s = strtolower( $s );
327 $i = strpos( $s, ' ' );
329 if ( $i === false ) {
333 # print "processing MIME INFO line $s<br>";
336 if ( preg_match( '!\[\s*(\w+)\s*\]!', $s, $match ) ) {
337 $s = preg_replace( '!\[\s*(\w+)\s*\]!', '', $s );
338 $mtype = trim( strtoupper( $match[1] ) );
340 $mtype = MEDIATYPE_UNKNOWN
;
343 $m = explode( ' ', $s );
345 if ( !isset( $this->mediaTypes
[$mtype] ) ) {
346 $this->mediaTypes
[$mtype] = [];
349 foreach ( $m as $mime ) {
350 $mime = trim( $mime );
351 if ( empty( $mime ) ) {
355 $this->mediaTypes
[$mtype][] = $mime;
358 if ( count( $m ) > 1 ) {
360 $mCount = count( $m );
361 for ( $i = 1; $i < $mCount; $i +
= 1 ) {
363 $this->mimeTypeAliases
[$mime] = $main;
369 public function setLogger( LoggerInterface
$logger ) {
370 $this->logger
= $logger;
374 * Adds to the list mapping MIME to file extensions.
375 * As an extension author, you are encouraged to submit patches to
376 * MediaWiki's core to add new MIME types to mime.types.
377 * @param string $types
379 public function addExtraTypes( $types ) {
380 $this->extraTypes
.= "\n" . $types;
384 * Adds to the list mapping MIME to media type.
385 * As an extension author, you are encouraged to submit patches to
386 * MediaWiki's core to add new MIME info to mime.info.
387 * @param string $info
389 public function addExtraInfo( $info ) {
390 $this->extraInfo
.= "\n" . $info;
394 * Returns a list of file extensions for a given MIME type as a space
395 * separated string or null if the MIME type was unrecognized. Resolves
398 * @param string $mime
399 * @return string|null
401 public function getExtensionsForType( $mime ) {
402 $mime = strtolower( $mime );
404 // Check the mime-to-ext map
405 if ( isset( $this->mimetoExt
[$mime] ) ) {
406 return $this->mimetoExt
[$mime];
409 // Resolve the MIME type to the canonical type
410 if ( isset( $this->mimeTypeAliases
[$mime] ) ) {
411 $mime = $this->mimeTypeAliases
[$mime];
412 if ( isset( $this->mimetoExt
[$mime] ) ) {
413 return $this->mimetoExt
[$mime];
421 * Returns a list of MIME types for a given file extension as a space
422 * separated string or null if the extension was unrecognized.
425 * @return string|null
427 public function getTypesForExtension( $ext ) {
428 $ext = strtolower( $ext );
430 $r = $this->mExtToMime
[$ext] ??
null;
435 * Returns a single MIME type for a given file extension or null if unknown.
436 * This is always the first type from the list returned by getTypesForExtension($ext).
439 * @return string|null
441 public function guessTypesForExtension( $ext ) {
442 $m = $this->getTypesForExtension( $ext );
443 if ( is_null( $m ) ) {
447 // TODO: Check if this is needed; strtok( $m, ' ' ) should be sufficient
449 $m = preg_replace( '/\s.*$/', '', $m );
455 * Tests if the extension matches the given MIME type. Returns true if a
456 * match was found, null if the MIME type is unknown, and false if the
457 * MIME type is known but no matches where found.
459 * @param string $extension
460 * @param string $mime
463 public function isMatchingExtension( $extension, $mime ) {
464 $ext = $this->getExtensionsForType( $mime );
467 return null; // Unknown MIME type
470 $ext = explode( ' ', $ext );
472 $extension = strtolower( $extension );
473 return in_array( $extension, $ext );
477 * Returns true if the MIME type is known to represent an image format
478 * supported by the PHP GD library.
480 * @param string $mime
484 public function isPHPImageType( $mime ) {
485 // As defined by imagegetsize and image_type_to_mime
487 'image/gif', 'image/jpeg', 'image/png',
488 'image/x-bmp', 'image/xbm', 'image/tiff',
489 'image/jp2', 'image/jpeg2000', 'image/iff',
490 'image/xbm', 'image/x-xbitmap',
491 'image/vnd.wap.wbmp', 'image/vnd.xiff',
493 'application/x-shockwave-flash',
496 return in_array( $mime, $types );
500 * Returns true if the extension represents a type which can
501 * be reliably detected from its content. Use this to determine
502 * whether strict content checks should be applied to reject
503 * invalid uploads; if we can't identify the type we won't
504 * be able to say if it's invalid.
506 * @todo Be more accurate when using fancy MIME detector plugins;
507 * right now this is the bare minimum getimagesize() list.
508 * @param string $extension
511 function isRecognizableExtension( $extension ) {
513 // Types recognized by getimagesize()
514 'gif', 'jpeg', 'jpg', 'png', 'swf', 'psd',
515 'bmp', 'tiff', 'tif', 'jpc', 'jp2',
516 'jpx', 'jb2', 'swc', 'iff', 'wbmp',
519 // Formats we recognize magic numbers for
520 'djvu', 'ogx', 'ogg', 'ogv', 'oga', 'spx', 'opus',
521 'mid', 'pdf', 'wmf', 'xcf', 'webm', 'mkv', 'mka',
524 // XML formats we sure hope we recognize reliably
530 return in_array( strtolower( $extension ), $types );
534 * Improves a MIME type using the file extension. Some file formats are very generic,
535 * so their MIME type is not very meaningful. A more useful MIME type can be derived
536 * by looking at the file extension. Typically, this method would be called on the
537 * result of guessMimeType().
539 * @param string $mime The MIME type, typically guessed from a file's content.
540 * @param string $ext The file extension, as taken from the file name
542 * @return string The MIME type
544 public function improveTypeFromExtension( $mime, $ext ) {
545 if ( $mime === 'unknown/unknown' ) {
546 if ( $this->isRecognizableExtension( $ext ) ) {
547 $this->logger
->info( __METHOD__
. ': refusing to guess mime type for .' .
548 "$ext file, we should have recognized it\n" );
550 // Not something we can detect, so simply
551 // trust the file extension
552 $mime = $this->guessTypesForExtension( $ext );
554 } elseif ( $mime === 'application/x-opc+zip' ) {
555 if ( $this->isMatchingExtension( $ext, $mime ) ) {
556 // A known file extension for an OPC file,
557 // find the proper MIME type for that file extension
558 $mime = $this->guessTypesForExtension( $ext );
560 $this->logger
->info( __METHOD__
.
561 ": refusing to guess better type for $mime file, " .
562 ".$ext is not a known OPC extension.\n" );
563 $mime = 'application/zip';
565 } elseif ( $mime === 'text/plain' && $this->findMediaType( ".$ext" ) === MEDIATYPE_TEXT
) {
566 // Textual types are sometimes not recognized properly.
567 // If detected as text/plain, and has an extension which is textual
568 // improve to the extension's type. For example, csv and json are often
569 // misdetected as text/plain.
570 $mime = $this->guessTypesForExtension( $ext );
573 # Media handling extensions can improve the MIME detected
574 $callback = $this->extCallback
;
576 $callback( $this, $ext, $mime /* by reference */ );
579 if ( isset( $this->mimeTypeAliases
[$mime] ) ) {
580 $mime = $this->mimeTypeAliases
[$mime];
583 $this->logger
->info( __METHOD__
. ": improved mime type for .$ext: $mime\n" );
588 * MIME type detection. This uses detectMimeType to detect the MIME type
589 * of the file, but applies additional checks to determine some well known
590 * file formats that may be missed or misinterpreted by the default MIME
591 * detection (namely XML based formats like XHTML or SVG, as well as ZIP
592 * based formats like OPC/ODF files).
594 * @param string $file The file to check
595 * @param string|bool $ext The file extension, or true (default) to extract
596 * it from the filename. Set it to false to ignore the extension. DEPRECATED!
597 * Set to false, use improveTypeFromExtension($mime, $ext) later to improve MIME type.
599 * @return string The MIME type of $file
601 public function guessMimeType( $file, $ext = true ) {
602 if ( $ext ) { // TODO: make $ext default to false. Or better, remove it.
603 $this->logger
->info( __METHOD__
.
604 ": WARNING: use of the \$ext parameter is deprecated. " .
605 "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
608 $mime = $this->doGuessMimeType( $file, $ext );
611 $this->logger
->info( __METHOD__
.
612 ": internal type detection failed for $file (.$ext)...\n" );
613 $mime = $this->detectMimeType( $file, $ext );
616 if ( isset( $this->mimeTypeAliases
[$mime] ) ) {
617 $mime = $this->mimeTypeAliases
[$mime];
620 $this->logger
->info( __METHOD__
. ": guessed mime type of $file: $mime\n" );
625 * Guess the MIME type from the file contents.
627 * @todo Remove $ext param
629 * @param string $file
631 * @return bool|string
632 * @throws UnexpectedValueException
634 private function doGuessMimeType( $file, $ext ) {
635 // Read a chunk of the file
636 Wikimedia\
suppressWarnings();
637 $f = fopen( $file, 'rb' );
638 Wikimedia\restoreWarnings
();
641 return 'unknown/unknown';
644 $fsize = filesize( $file );
645 if ( $fsize === false ) {
646 return 'unknown/unknown';
649 $head = fread( $f, 1024 );
650 $tailLength = min( 65558, $fsize ); // 65558 = maximum size of a zip EOCDR
651 if ( fseek( $f, -1 * $tailLength, SEEK_END
) === -1 ) {
652 throw new UnexpectedValueException(
653 "Seeking $tailLength bytes from EOF failed in " . __METHOD__
);
655 $tail = $tailLength ?
fread( $f, $tailLength ) : '';
657 $this->logger
->info( __METHOD__
.
658 ": analyzing head and tail of $file for magic numbers.\n" );
660 // Hardcode a few magic number checks...
663 'MThd' => 'audio/midi',
664 'OggS' => 'application/ogg',
665 'ID3' => 'audio/mpeg',
666 "\xff\xfb" => 'audio/mpeg', // MPEG-1 layer 3
667 "\xff\xf3" => 'audio/mpeg', // MPEG-2 layer 3 (lower sample rates)
668 "\xff\xe3" => 'audio/mpeg', // MPEG-2.5 layer 3 (very low sample rates)
671 // Note that WMF may have a bare header, no magic number.
672 "\x01\x00\x09\x00" => 'application/x-msmetafile', // Possibly prone to false positives?
673 "\xd7\xcd\xc6\x9a" => 'application/x-msmetafile',
674 '%PDF' => 'application/pdf',
675 'gimp xcf' => 'image/x-xcf',
677 // Some forbidden fruit...
678 'MZ' => 'application/octet-stream', // DOS/Windows executable
679 "\xca\xfe\xba\xbe" => 'application/octet-stream', // Mach-O binary
680 "\x7fELF" => 'application/octet-stream', // ELF binary
683 foreach ( $headers as $magic => $candidate ) {
684 if ( strncmp( $head, $magic, strlen( $magic ) ) == 0 ) {
685 $this->logger
->info( __METHOD__
.
686 ": magic header in $file recognized as $candidate\n" );
691 /* Look for WebM and Matroska files */
692 if ( strncmp( $head, pack( "C4", 0x1a, 0x45, 0xdf, 0xa3 ), 4 ) == 0 ) {
693 $doctype = strpos( $head, "\x42\x82" );
695 // Next byte is datasize, then data (sizes larger than 1 byte are stupid muxers)
696 $data = substr( $head, $doctype +
3, 8 );
697 if ( strncmp( $data, "matroska", 8 ) == 0 ) {
698 $this->logger
->info( __METHOD__
. ": recognized file as video/x-matroska\n" );
699 return "video/x-matroska";
700 } elseif ( strncmp( $data, "webm", 4 ) == 0 ) {
701 // XXX HACK look for a video track, if we don't find it, this is an audio file
702 $videotrack = strpos( $head, "\x86\x85V_VP" );
705 // There is a video track, so this is a video file.
706 $this->logger
->info( __METHOD__
. ": recognized file as video/webm\n" );
710 $this->logger
->info( __METHOD__
. ": recognized file as audio/webm\n" );
714 $this->logger
->info( __METHOD__
. ": unknown EBML file\n" );
715 return "unknown/unknown";
719 if ( strncmp( $head, "RIFF", 4 ) == 0 &&
720 strncmp( substr( $head, 8, 7 ), "WEBPVP8", 7 ) == 0
722 $this->logger
->info( __METHOD__
. ": recognized file as image/webp\n" );
726 /* Look for MS Compound Binary (OLE) files */
727 if ( strncmp( $head, "\xd0\xcf\x11\xe0\xa1\xb1\x1a\xe1", 8 ) == 0 ) {
728 $this->logger
->info( __METHOD__
. ': recognized MS CFB (OLE) file' );
729 return $this->detectMicrosoftBinaryType( $f );
733 * Look for PHP. Check for this before HTML/XML... Warning: this is a
734 * heuristic, and won't match a file with a lot of non-PHP before. It
735 * will also match text files which could be PHP. :)
737 * @todo FIXME: For this reason, the check is probably useless -- an attacker
738 * could almost certainly just pad the file with a lot of nonsense to
739 * circumvent the check in any case where it would be a security
740 * problem. On the other hand, it causes harmful false positives (bug
741 * 16583). The heuristic has been cut down to exclude three-character
742 * strings like "<? ", but should it be axed completely?
744 if ( ( strpos( $head, '<?php' ) !== false ) ||
745 ( strpos( $head, "<\x00?\x00p\x00h\x00p" ) !== false ) ||
746 ( strpos( $head, "<\x00?\x00 " ) !== false ) ||
747 ( strpos( $head, "<\x00?\x00\n" ) !== false ) ||
748 ( strpos( $head, "<\x00?\x00\t" ) !== false ) ||
749 ( strpos( $head, "<\x00?\x00=" ) !== false )
751 $this->logger
->info( __METHOD__
. ": recognized $file as application/x-php\n" );
752 return 'application/x-php';
756 * look for XML formats (XHTML and SVG)
758 $xml = new XmlTypeCheck( $file );
759 if ( $xml->wellFormed
) {
760 $xmlTypes = $this->xmlTypes
;
761 return $xmlTypes[$xml->getRootElement()] ??
'application/xml';
765 * look for shell scripts
770 if ( substr( $head, 0, 2 ) == "#!" ) {
771 $script_type = "ASCII";
772 } elseif ( substr( $head, 0, 5 ) == "\xef\xbb\xbf#!" ) {
773 $script_type = "UTF-8";
774 } elseif ( substr( $head, 0, 7 ) == "\xfe\xff\x00#\x00!" ) {
775 $script_type = "UTF-16BE";
776 } elseif ( substr( $head, 0, 7 ) == "\xff\xfe#\x00!" ) {
777 $script_type = "UTF-16LE";
780 if ( $script_type ) {
781 if ( $script_type !== "UTF-8" && $script_type !== "ASCII" ) {
782 // Quick and dirty fold down to ASCII!
783 $pack = [ 'UTF-16BE' => 'n*', 'UTF-16LE' => 'v*' ];
784 $chars = unpack( $pack[$script_type], substr( $head, 2 ) );
786 foreach ( $chars as $codepoint ) {
787 if ( $codepoint < 128 ) {
788 $head .= chr( $codepoint );
797 if ( preg_match( '%/?([^\s]+/)(\w+)%', $head, $match ) ) {
798 $mime = "application/x-{$match[2]}";
799 $this->logger
->info( __METHOD__
. ": shell script recognized as $mime\n" );
804 // Check for ZIP variants (before getimagesize)
805 $eocdrPos = strpos( $tail, "PK\x05\x06" );
806 if ( $eocdrPos !== false ) {
807 $this->logger
->info( __METHOD__
. ": ZIP signature present in $file\n" );
808 // Check if it really is a ZIP file, make sure the EOCDR is at the end (T40432)
809 $commentLength = unpack( "n", substr( $tail, $eocdrPos +
20 ) )[0];
810 if ( $eocdrPos +
22 +
$commentLength !== strlen( $tail ) ) {
811 $this->logger
->info( __METHOD__
. ": ZIP EOCDR not at end. Not a ZIP file." );
813 return $this->detectZipType( $head, $tail, $ext );
817 // Check for STL (3D) files
818 // @see https://en.wikipedia.org/wiki/STL_(file_format)
820 stripos( $head, 'SOLID ' ) === 0 &&
821 preg_match( '/\RENDSOLID .*$/i', $tail ) ) {
823 return 'application/sla';
824 } elseif ( $fsize > 84 ) {
826 $triangles = substr( $head, 80, 4 );
827 $triangles = unpack( 'V', $triangles );
828 $triangles = reset( $triangles );
829 if ( $triangles !== false && $fsize === 84 +
( $triangles * 50 ) ) {
830 return 'application/sla';
834 Wikimedia\
suppressWarnings();
835 $gis = getimagesize( $file );
836 Wikimedia\restoreWarnings
();
838 if ( $gis && isset( $gis['mime'] ) ) {
839 $mime = $gis['mime'];
840 $this->logger
->info( __METHOD__
. ": getimagesize detected $file as $mime\n" );
844 # Media handling extensions can guess the MIME by content
845 # It's intentionally here so that if core is wrong about a type (false positive),
846 # people will hopefully nag and submit patches :)
848 # Some strings by reference for performance - assuming well-behaved hooks
849 $callback = $this->guessCallback
;
851 $callback( $this, $head, $tail, $file, $mime /* by reference */ );
858 * Detect application-specific file type of a given ZIP file from its
859 * header data. Currently works for OpenDocument and OpenXML types...
860 * If can't tell, returns 'application/zip'.
862 * @param string $header Some reasonably-sized chunk of file header
863 * @param string|null $tail The tail of the file
864 * @param string|bool $ext The file extension, or true to extract it from the filename.
865 * Set it to false (default) to ignore the extension. DEPRECATED! Set to false,
866 * use improveTypeFromExtension($mime, $ext) later to improve MIME type.
870 function detectZipType( $header, $tail = null, $ext = false ) {
871 if ( $ext ) { # TODO: remove $ext param
872 $this->logger
->info( __METHOD__
.
873 ": WARNING: use of the \$ext parameter is deprecated. " .
874 "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
877 $mime = 'application/zip';
887 'presentation-template',
889 'spreadsheet-template',
896 // https://lists.oasis-open.org/archives/office/200505/msg00006.html
897 $types = '(?:' . implode( '|', $opendocTypes ) . ')';
898 $opendocRegex = "/^mimetype(application\/vnd\.oasis\.opendocument\.$types)/";
900 $openxmlRegex = "/^\[Content_Types\].xml/";
902 if ( preg_match( $opendocRegex, substr( $header, 30 ), $matches ) ) {
904 $this->logger
->info( __METHOD__
. ": detected $mime from ZIP archive\n" );
905 } elseif ( preg_match( $openxmlRegex, substr( $header, 30 ) ) ) {
906 $mime = "application/x-opc+zip";
907 # TODO: remove the block below, as soon as improveTypeFromExtension is used everywhere
908 if ( $ext !== true && $ext !== false ) {
909 /** This is the mode used by getPropsFromPath
910 * These MIME's are stored in the database, where we don't really want
911 * x-opc+zip, because we use it only for internal purposes
913 if ( $this->isMatchingExtension( $ext, $mime ) ) {
914 /* A known file extension for an OPC file,
915 * find the proper mime type for that file extension
917 $mime = $this->guessTypesForExtension( $ext );
919 $mime = "application/zip";
922 $this->logger
->info( __METHOD__
.
923 ": detected an Open Packaging Conventions archive: $mime\n" );
924 } elseif ( substr( $header, 0, 8 ) == "\xd0\xcf\x11\xe0\xa1\xb1\x1a\xe1" &&
925 ( $headerpos = strpos( $tail, "PK\x03\x04" ) ) !== false &&
926 preg_match( $openxmlRegex, substr( $tail, $headerpos +
30 ) ) ) {
927 if ( substr( $header, 512, 4 ) == "\xEC\xA5\xC1\x00" ) {
928 $mime = "application/msword";
930 switch ( substr( $header, 512, 6 ) ) {
931 case "\xEC\xA5\xC1\x00\x0E\x00":
932 case "\xEC\xA5\xC1\x00\x1C\x00":
933 case "\xEC\xA5\xC1\x00\x43\x00":
934 $mime = "application/vnd.ms-powerpoint";
936 case "\xFD\xFF\xFF\xFF\x10\x00":
937 case "\xFD\xFF\xFF\xFF\x1F\x00":
938 case "\xFD\xFF\xFF\xFF\x22\x00":
939 case "\xFD\xFF\xFF\xFF\x23\x00":
940 case "\xFD\xFF\xFF\xFF\x28\x00":
941 case "\xFD\xFF\xFF\xFF\x29\x00":
942 case "\xFD\xFF\xFF\xFF\x10\x02":
943 case "\xFD\xFF\xFF\xFF\x1F\x02":
944 case "\xFD\xFF\xFF\xFF\x22\x02":
945 case "\xFD\xFF\xFF\xFF\x23\x02":
946 case "\xFD\xFF\xFF\xFF\x28\x02":
947 case "\xFD\xFF\xFF\xFF\x29\x02":
948 $mime = "application/vnd.msexcel";
952 $this->logger
->info( __METHOD__
.
953 ": detected a MS Office document with OPC trailer\n" );
955 $this->logger
->info( __METHOD__
. ": unable to identify type of ZIP archive\n" );
961 * Detect the type of a Microsoft Compound Binary a.k.a. OLE file.
962 * These are old style pre-ODF files such as .doc and .xls
964 * @param resource $handle An opened seekable file handle
965 * @return string The detected MIME type
967 function detectMicrosoftBinaryType( $handle ) {
968 $info = MSCompoundFileReader
::readHandle( $handle );
969 if ( !$info['valid'] ) {
970 $this->logger
->info( __METHOD__
. ': invalid file format' );
971 return 'unknown/unknown';
973 if ( !$info['mime'] ) {
974 $this->logger
->info( __METHOD__
. ": unrecognised document subtype" );
975 return 'unknown/unknown';
977 return $info['mime'];
981 * Internal MIME type detection. Detection is done using the fileinfo
982 * extension if it is available. It can be overriden by callback, which could
983 * use an external program, for example. If detection fails and $ext is not false,
984 * the MIME type is guessed from the file extension, using guessTypesForExtension.
986 * If the MIME type is still unknown, getimagesize is used to detect the
987 * MIME type if the file is an image. If no MIME type can be determined,
988 * this function returns 'unknown/unknown'.
990 * @param string $file The file to check
991 * @param string|bool $ext The file extension, or true (default) to extract it from the filename.
992 * Set it to false to ignore the extension. DEPRECATED! Set to false, use
993 * improveTypeFromExtension($mime, $ext) later to improve MIME type.
995 * @return string The MIME type of $file
997 private function detectMimeType( $file, $ext = true ) {
998 /** @todo Make $ext default to false. Or better, remove it. */
1000 $this->logger
->info( __METHOD__
.
1001 ": WARNING: use of the \$ext parameter is deprecated. "
1002 . "Use improveTypeFromExtension(\$mime, \$ext) instead.\n" );
1005 $callback = $this->detectCallback
;
1008 $m = $callback( $file );
1010 $m = mime_content_type( $file );
1015 $m = preg_replace( '![;, ].*$!', '', $m ); # strip charset, etc
1017 $m = strtolower( $m );
1019 if ( strpos( $m, 'unknown' ) !== false ) {
1022 $this->logger
->info( __METHOD__
. ": magic mime type of $file: $m\n" );
1027 // If desired, look at extension as a fallback.
1028 if ( $ext === true ) {
1029 $i = strrpos( $file, '.' );
1030 $ext = strtolower( $i ?
substr( $file, $i +
1 ) : '' );
1033 if ( $this->isRecognizableExtension( $ext ) ) {
1034 $this->logger
->info( __METHOD__
. ": refusing to guess mime type for .$ext file, "
1035 . "we should have recognized it\n" );
1037 $m = $this->guessTypesForExtension( $ext );
1039 $this->logger
->info( __METHOD__
. ": extension mime type of $file: $m\n" );
1046 $this->logger
->info( __METHOD__
. ": failed to guess mime type for $file!\n" );
1047 return 'unknown/unknown';
1051 * Determine the media type code for a file, using its MIME type, name and
1052 * possibly its contents.
1054 * This function relies on the findMediaType(), mapping extensions and MIME
1055 * types to media types.
1057 * @todo analyse file if need be
1058 * @todo look at multiple extension, separately and together.
1060 * @param string|null $path Full path to the image file, in case we have to look at the contents
1061 * (if null, only the MIME type is used to determine the media type code).
1062 * @param string|null $mime MIME type. If null it will be guessed using guessMimeType.
1064 * @return string A value to be used with the MEDIATYPE_xxx constants.
1066 function getMediaType( $path = null, $mime = null ) {
1067 if ( !$mime && !$path ) {
1068 return MEDIATYPE_UNKNOWN
;
1071 // If MIME type is unknown, guess it
1073 $mime = $this->guessMimeType( $path, false );
1076 // Special code for ogg - detect if it's video (theora),
1077 // else label it as sound.
1078 if ( $mime == 'application/ogg' && file_exists( $path ) ) {
1079 // Read a chunk of the file
1080 $f = fopen( $path, "rt" );
1082 return MEDIATYPE_UNKNOWN
;
1084 $head = fread( $f, 256 );
1087 $head = str_replace( 'ffmpeg2theora', '', strtolower( $head ) );
1089 // This is an UGLY HACK, file should be parsed correctly
1090 if ( strpos( $head, 'theora' ) !== false ) {
1091 return MEDIATYPE_VIDEO
;
1092 } elseif ( strpos( $head, 'vorbis' ) !== false ) {
1093 return MEDIATYPE_AUDIO
;
1094 } elseif ( strpos( $head, 'flac' ) !== false ) {
1095 return MEDIATYPE_AUDIO
;
1096 } elseif ( strpos( $head, 'speex' ) !== false ) {
1097 return MEDIATYPE_AUDIO
;
1098 } elseif ( strpos( $head, 'opus' ) !== false ) {
1099 return MEDIATYPE_AUDIO
;
1101 return MEDIATYPE_MULTIMEDIA
;
1106 // Check for entry for full MIME type
1108 $type = $this->findMediaType( $mime );
1109 if ( $type !== MEDIATYPE_UNKNOWN
) {
1114 // Check for entry for file extension
1116 $i = strrpos( $path, '.' );
1117 $e = strtolower( $i ?
substr( $path, $i +
1 ) : '' );
1119 // TODO: look at multi-extension if this fails, parse from full path
1120 $type = $this->findMediaType( '.' . $e );
1121 if ( $type !== MEDIATYPE_UNKNOWN
) {
1126 // Check major MIME type
1128 $i = strpos( $mime, '/' );
1129 if ( $i !== false ) {
1130 $major = substr( $mime, 0, $i );
1131 $type = $this->findMediaType( $major );
1132 if ( $type !== MEDIATYPE_UNKNOWN
) {
1139 $type = MEDIATYPE_UNKNOWN
;
1146 * Returns a media code matching the given MIME type or file extension.
1147 * File extensions are represented by a string starting with a dot (.) to
1148 * distinguish them from MIME types.
1150 * This function relies on the mapping defined by $this->mMediaTypes
1152 * @param string $extMime
1153 * @return int|string
1155 function findMediaType( $extMime ) {
1156 if ( strpos( $extMime, '.' ) === 0 ) {
1157 // If it's an extension, look up the MIME types
1158 $m = $this->getTypesForExtension( substr( $extMime, 1 ) );
1160 return MEDIATYPE_UNKNOWN
;
1163 $m = explode( ' ', $m );
1165 // Normalize MIME type
1166 if ( isset( $this->mimeTypeAliases
[$extMime] ) ) {
1167 $extMime = $this->mimeTypeAliases
[$extMime];
1173 foreach ( $m as $mime ) {
1174 foreach ( $this->mediaTypes
as $type => $codes ) {
1175 if ( in_array( $mime, $codes, true ) ) {
1181 return MEDIATYPE_UNKNOWN
;
1185 * Returns an array of media types (MEDIATYPE_xxx constants)
1189 public function getMediaTypes() {
1190 return array_keys( $this->mediaTypes
);
1194 * Get the MIME types that various versions of Internet Explorer would
1195 * detect from a chunk of the content.
1197 * @param string $fileName The file name (unused at present)
1198 * @param string $chunk The first 256 bytes of the file
1199 * @param string $proposed The MIME type proposed by the server
1202 public function getIEMimeTypes( $fileName, $chunk, $proposed ) {
1203 $ca = $this->getIEContentAnalyzer();
1204 return $ca->getRealMimesFromData( $fileName, $chunk, $proposed );
1208 * Get a cached instance of IEContentAnalyzer
1210 * @return IEContentAnalyzer
1212 protected function getIEContentAnalyzer() {
1213 if ( is_null( $this->IEAnalyzer
) ) {
1214 $this->IEAnalyzer
= new IEContentAnalyzer
;
1216 return $this->IEAnalyzer
;