* WTF was I thinking...
[mediawiki.git] / includes / MimeMagic.php
blobec4505ab28ce9cf9dc601214c541665498c0e0e6
1 <?php
2 /** Module defining helper functions for detecting and dealing with mime types.
4 */
6 /** Defines a set of well known mime types
7 * This is used as a fallback to mime.types files.
8 * An extensive list of well known mime types is provided by
9 * the file mime.types in the includes directory.
11 define('MM_WELL_KNOWN_MIME_TYPES',<<<END_STRING
12 application/ogg ogg ogm ogv
13 application/pdf pdf
14 application/x-javascript js
15 application/x-shockwave-flash swf
16 audio/midi mid midi kar
17 audio/mpeg mpga mpa mp2 mp3
18 audio/x-aiff aif aiff aifc
19 audio/x-wav wav
20 audio/ogg ogg
21 image/x-bmp bmp
22 image/gif gif
23 image/jpeg jpeg jpg jpe
24 image/png png
25 image/svg+xml image/svg svg
26 image/tiff tiff tif
27 image/vnd.djvu image/x.djvu image/x-djvu djvu
28 image/x-portable-pixmap ppm
29 image/x-xcf xcf
30 text/plain txt
31 text/html html htm
32 video/ogg ogm ogg ogv
33 video/mpeg mpg mpeg
34 END_STRING
37 /** Defines a set of well known mime info entries
38 * This is used as a fallback to mime.info files.
39 * An extensive list of well known mime types is provided by
40 * the file mime.info in the includes directory.
42 define('MM_WELL_KNOWN_MIME_INFO', <<<END_STRING
43 application/pdf [OFFICE]
44 text/javascript application/x-javascript [EXECUTABLE]
45 application/x-shockwave-flash [MULTIMEDIA]
46 audio/midi [AUDIO]
47 audio/x-aiff [AUDIO]
48 audio/x-wav [AUDIO]
49 audio/mp3 audio/mpeg [AUDIO]
50 application/ogg audio/ogg video/ogg [MULTIMEDIA]
51 image/x-bmp image/bmp [BITMAP]
52 image/gif [BITMAP]
53 image/jpeg [BITMAP]
54 image/png [BITMAP]
55 image/svg+xml [DRAWING]
56 image/tiff [BITMAP]
57 image/vnd.djvu [BITMAP]
58 image/x-xcf [BITMAP]
59 image/x-portable-pixmap [BITMAP]
60 text/plain [TEXT]
61 text/html [TEXT]
62 video/ogg [VIDEO]
63 video/mpeg [VIDEO]
64 unknown/unknown application/octet-stream application/x-empty [UNKNOWN]
65 END_STRING
68 #note: because this file is possibly included by a function,
69 #we need to access the global scope explicitely!
70 global $wgLoadFileinfoExtension;
72 if ($wgLoadFileinfoExtension) {
73 if(!extension_loaded('fileinfo')) dl('fileinfo.' . PHP_SHLIB_SUFFIX);
76 /**
77 * Implements functions related to mime types such as detection and mapping to
78 * file extension.
80 * Instances of this class are stateles, there only needs to be one global instance
81 * of MimeMagic. Please use MimeMagic::singleton() to get that instance.
83 class MimeMagic {
85 /**
86 * Mapping of media types to arrays of mime types.
87 * This is used by findMediaType and getMediaType, respectively
89 var $mMediaTypes= NULL;
91 /** Map of mime type aliases
93 var $mMimeTypeAliases= NULL;
95 /** map of mime types to file extensions (as a space seprarated list)
97 var $mMimeToExt= NULL;
99 /** map of file extensions types to mime types (as a space seprarated list)
101 var $mExtToMime= NULL;
103 /** The singleton instance
105 private static $instance;
107 /** Initializes the MimeMagic object. This is called by MimeMagic::singleton().
109 * This constructor parses the mime.types and mime.info files and build internal mappings.
111 function __construct() {
113 * --- load mime.types ---
116 global $wgMimeTypeFile, $IP;
118 $types = MM_WELL_KNOWN_MIME_TYPES;
120 if ( $wgMimeTypeFile == 'includes/mime.types' ) {
121 $wgMimeTypeFile = "$IP/$wgMimeTypeFile";
124 if ( $wgMimeTypeFile ) {
125 if ( is_file( $wgMimeTypeFile ) and is_readable( $wgMimeTypeFile ) ) {
126 wfDebug( __METHOD__.": loading mime types from $wgMimeTypeFile\n" );
127 $types .= "\n";
128 $types .= file_get_contents( $wgMimeTypeFile );
129 } else {
130 wfDebug( __METHOD__.": can't load mime types from $wgMimeTypeFile\n" );
132 } else {
133 wfDebug( __METHOD__.": no mime types file defined, using build-ins only.\n" );
136 $types = str_replace( array( "\r\n", "\n\r", "\n\n", "\r\r", "\r" ), "\n", $types );
137 $types = str_replace( "\t", " ", $types );
139 $this->mMimeToExt = array();
140 $this->mToMime = array();
142 $lines = explode( "\n",$types );
143 foreach ( $lines as $s ) {
144 $s = trim( $s );
145 if ( empty( $s ) ) continue;
146 if ( strpos( $s, '#' ) === 0 ) continue;
148 $s = strtolower( $s );
149 $i = strpos( $s, ' ' );
151 if ( $i === false ) continue;
153 #print "processing MIME line $s<br>";
155 $mime = substr( $s, 0, $i );
156 $ext = trim( substr($s, $i+1 ) );
158 if ( empty( $ext ) ) continue;
160 if ( !empty( $this->mMimeToExt[$mime] ) ) {
161 $this->mMimeToExt[$mime] .= ' ' . $ext;
162 } else {
163 $this->mMimeToExt[$mime] = $ext;
166 $extensions = explode( ' ', $ext );
168 foreach ( $extensions as $e ) {
169 $e = trim( $e );
170 if ( empty( $e ) ) continue;
172 if ( !empty( $this->mExtToMime[$e] ) ) {
173 $this->mExtToMime[$e] .= ' ' . $mime;
174 } else {
175 $this->mExtToMime[$e] = $mime;
181 * --- load mime.info ---
184 global $wgMimeInfoFile;
185 if ( $wgMimeInfoFile == 'includes/mime.info' ) {
186 $wgMimeInfoFile = "$IP/$wgMimeInfoFile";
189 $info = MM_WELL_KNOWN_MIME_INFO;
191 if ( $wgMimeInfoFile ) {
192 if ( is_file( $wgMimeInfoFile ) and is_readable( $wgMimeInfoFile ) ) {
193 wfDebug( __METHOD__.": loading mime info from $wgMimeInfoFile\n" );
194 $info .= "\n";
195 $info .= file_get_contents( $wgMimeInfoFile );
196 } else {
197 wfDebug(__METHOD__.": can't load mime info from $wgMimeInfoFile\n");
199 } else {
200 wfDebug(__METHOD__.": no mime info file defined, using build-ins only.\n");
203 $info = str_replace( array( "\r\n", "\n\r", "\n\n", "\r\r", "\r" ), "\n", $info);
204 $info = str_replace( "\t", " ", $info );
206 $this->mMimeTypeAliases = array();
207 $this->mMediaTypes = array();
209 $lines = explode( "\n", $info );
210 foreach ( $lines as $s ) {
211 $s = trim( $s );
212 if ( empty( $s ) ) continue;
213 if ( strpos( $s, '#' ) === 0 ) continue;
215 $s = strtolower( $s );
216 $i = strpos( $s, ' ' );
218 if ( $i === false ) continue;
220 #print "processing MIME INFO line $s<br>";
222 $match = array();
223 if ( preg_match( '!\[\s*(\w+)\s*\]!', $s, $match ) ) {
224 $s = preg_replace( '!\[\s*(\w+)\s*\]!', '', $s );
225 $mtype = trim( strtoupper( $match[1] ) );
226 } else {
227 $mtype = MEDIATYPE_UNKNOWN;
230 $m = explode( ' ', $s );
232 if ( !isset( $this->mMediaTypes[$mtype] ) ) {
233 $this->mMediaTypes[$mtype] = array();
236 foreach ( $m as $mime ) {
237 $mime = trim( $mime );
238 if ( empty( $mime ) ) continue;
240 $this->mMediaTypes[$mtype][] = $mime;
243 if ( sizeof( $m ) > 1 ) {
244 $main = $m[0];
245 for ( $i=1; $i<sizeof($m); $i += 1 ) {
246 $mime = $m[$i];
247 $this->mMimeTypeAliases[$mime] = $main;
255 * Get an instance of this class
257 static function &singleton() {
258 if ( !isset( self::$instance ) ) {
259 self::$instance = new MimeMagic;
261 return self::$instance;
264 /** returns a list of file extensions for a given mime type
265 * as a space separated string.
267 function getExtensionsForType( $mime ) {
268 $mime = strtolower( $mime );
270 $r = @$this->mMimeToExt[$mime];
272 if ( @!$r and isset( $this->mMimeTypeAliases[$mime] ) ) {
273 $mime = $this->mMimeTypeAliases[$mime];
274 $r = @$this->mMimeToExt[$mime];
277 return $r;
280 /** returns a list of mime types for a given file extension
281 * as a space separated string.
283 function getTypesForExtension( $ext ) {
284 $ext = strtolower( $ext );
286 $r = isset( $this->mExtToMime[$ext] ) ? $this->mExtToMime[$ext] : null;
287 return $r;
290 /** returns a single mime type for a given file extension.
291 * This is always the first type from the list returned by getTypesForExtension($ext).
293 function guessTypesForExtension( $ext ) {
294 $m = $this->getTypesForExtension( $ext );
295 if ( is_null( $m ) ) return NULL;
297 $m = trim( $m );
298 $m = preg_replace( '/\s.*$/', '', $m );
300 return $m;
304 /** tests if the extension matches the given mime type.
305 * returns true if a match was found, NULL if the mime type is unknown,
306 * and false if the mime type is known but no matches where found.
308 function isMatchingExtension( $extension, $mime ) {
309 $ext = $this->getExtensionsForType( $mime );
311 if ( !$ext ) {
312 return NULL; //unknown
315 $ext = explode( ' ', $ext );
317 $extension = strtolower( $extension );
318 if ( in_array( $extension, $ext ) ) {
319 return true;
322 return false;
325 /** returns true if the mime type is known to represent
326 * an image format supported by the PHP GD library.
328 function isPHPImageType( $mime ) {
329 #as defined by imagegetsize and image_type_to_mime
330 static $types = array(
331 'image/gif', 'image/jpeg', 'image/png',
332 'image/x-bmp', 'image/xbm', 'image/tiff',
333 'image/jp2', 'image/jpeg2000', 'image/iff',
334 'image/xbm', 'image/x-xbitmap',
335 'image/vnd.wap.wbmp', 'image/vnd.xiff',
336 'image/x-photoshop',
337 'application/x-shockwave-flash',
340 return in_array( $mime, $types );
344 * Returns true if the extension represents a type which can
345 * be reliably detected from its content. Use this to determine
346 * whether strict content checks should be applied to reject
347 * invalid uploads; if we can't identify the type we won't
348 * be able to say if it's invalid.
350 * @todo Be more accurate when using fancy mime detector plugins;
351 * right now this is the bare minimum getimagesize() list.
352 * @return bool
354 function isRecognizableExtension( $extension ) {
355 static $types = array(
356 // Types recognized by getimagesize()
357 'gif', 'jpeg', 'jpg', 'png', 'swf', 'psd',
358 'bmp', 'tiff', 'tif', 'jpc', 'jp2',
359 'jpx', 'jb2', 'swc', 'iff', 'wbmp',
360 'xbm',
362 // Formats we recognize magic numbers for
363 'djvu', 'ogg', 'ogv', 'mid', 'pdf', 'wmf', 'xcf',
365 // XML formats we sure hope we recognize reliably
366 'svg',
368 return in_array( strtolower( $extension ), $types );
372 /** mime type detection. This uses detectMimeType to detect the mime type of the file,
373 * but applies additional checks to determine some well known file formats that may be missed
374 * or misinterpreter by the default mime detection (namely xml based formats like XHTML or SVG).
376 * @param string $file The file to check
377 * @param mixed $ext The file extension, or true to extract it from the filename.
378 * Set it to false to ignore the extension.
380 * @return string the mime type of $file
382 function guessMimeType( $file, $ext = true ) {
383 $mime = $this->doGuessMimeType( $file, $ext );
385 if( !$mime ) {
386 wfDebug( __METHOD__.": internal type detection failed for $file (.$ext)...\n" );
387 $mime = $this->detectMimeType( $file, $ext );
390 if ( isset( $this->mMimeTypeAliases[$mime] ) ) {
391 $mime = $this->mMimeTypeAliases[$mime];
394 wfDebug(__METHOD__.": final mime type of $file: $mime\n");
395 return $mime;
398 function doGuessMimeType( $file, $ext = true ) {
399 // Read a chunk of the file
400 wfSuppressWarnings();
401 $f = fopen( $file, "rt" );
402 wfRestoreWarnings();
403 if( !$f ) return "unknown/unknown";
404 $head = fread( $f, 1024 );
405 fclose( $f );
407 // Hardcode a few magic number checks...
408 $headers = array(
409 // Multimedia...
410 'MThd' => 'audio/midi',
411 'OggS' => 'application/ogg',
413 // Image formats...
414 // Note that WMF may have a bare header, no magic number.
415 "\x01\x00\x09\x00" => 'application/x-msmetafile', // Possibly prone to false positives?
416 "\xd7\xcd\xc6\x9a" => 'application/x-msmetafile',
417 '%PDF' => 'application/pdf',
418 'gimp xcf' => 'image/x-xcf',
420 // Some forbidden fruit...
421 'MZ' => 'application/octet-stream', // DOS/Windows executable
422 "\xca\xfe\xba\xbe" => 'application/octet-stream', // Mach-O binary
423 "\x7fELF" => 'application/octet-stream', // ELF binary
426 foreach( $headers as $magic => $candidate ) {
427 if( strncmp( $head, $magic, strlen( $magic ) ) == 0 ) {
428 wfDebug( __METHOD__ . ": magic header in $file recognized as $candidate\n" );
429 return $candidate;
434 * look for PHP
435 * Check for this before HTML/XML...
436 * Warning: this is a heuristic, and won't match a file with a lot of non-PHP before.
437 * It will also match text files which could be PHP. :)
439 if( ( strpos( $head, '<?php' ) !== false ) ||
440 ( strpos( $head, '<? ' ) !== false ) ||
441 ( strpos( $head, "<?\n" ) !== false ) ||
442 ( strpos( $head, "<?\t" ) !== false ) ||
443 ( strpos( $head, "<?=" ) !== false ) ||
445 ( strpos( $head, "<\x00?\x00p\x00h\x00p" ) !== false ) ||
446 ( strpos( $head, "<\x00?\x00 " ) !== false ) ||
447 ( strpos( $head, "<\x00?\x00\n" ) !== false ) ||
448 ( strpos( $head, "<\x00?\x00\t" ) !== false ) ||
449 ( strpos( $head, "<\x00?\x00=" ) !== false ) ) {
451 wfDebug( __METHOD__ . ": recognized $file as application/x-php\n" );
452 return "application/x-php";
456 * look for XML formats (XHTML and SVG)
458 $xml = new XmlTypeCheck( $file );
459 if( $xml->wellFormed ) {
460 global $wgXMLMimeTypes;
461 if( isset( $wgXMLMimeTypes[$xml->rootElement] ) ) {
462 return $wgXMLMimeTypes[$xml->rootElement];
463 } else {
464 return 'application/xml';
469 * look for shell scripts
471 $script_type = NULL;
473 # detect by shebang
474 if ( substr( $head, 0, 2) == "#!" ) {
475 $script_type = "ASCII";
476 } elseif ( substr( $head, 0, 5) == "\xef\xbb\xbf#!" ) {
477 $script_type = "UTF-8";
478 } elseif ( substr( $head, 0, 7) == "\xfe\xff\x00#\x00!" ) {
479 $script_type = "UTF-16BE";
480 } elseif ( substr( $head, 0, 7 ) == "\xff\xfe#\x00!" ) {
481 $script_type= "UTF-16LE";
484 if ( $script_type ) {
485 if ( $script_type !== "UTF-8" && $script_type !== "ASCII") {
486 // Quick and dirty fold down to ASCII!
487 $pack = array( 'UTF-16BE' => 'n*', 'UTF-16LE' => 'v*' );
488 $chars = unpack( $pack[$script_type], substr( $head, 2 ) );
489 $head = '';
490 foreach( $chars as $codepoint ) {
491 if( $codepoint < 128 ) {
492 $head .= chr( $codepoint );
493 } else {
494 $head .= '?';
499 $match = array();
501 if ( preg_match( '%/?([^\s]+/)(\w+)%', $head, $match ) ) {
502 $mime = "application/x-{$match[2]}";
503 wfDebug( __METHOD__.": shell script recognized as $mime\n" );
504 return $mime;
508 wfSuppressWarnings();
509 $gis = getimagesize( $file );
510 wfRestoreWarnings();
512 if( $gis && isset( $gis['mime'] ) ) {
513 $mime = $gis['mime'];
514 wfDebug( __METHOD__.": getimagesize detected $file as $mime\n" );
515 return $mime;
516 } else {
517 return false;
520 // Also test DjVu
521 $deja = new DjVuImage( $file );
522 if( $deja->isValid() ) {
523 wfDebug( __METHOD__.": detected $file as image/vnd.djvu\n" );
524 return 'image/vnd.djvu';
528 /** Internal mime type detection, please use guessMimeType() for application code instead.
529 * Detection is done using an external program, if $wgMimeDetectorCommand is set.
530 * Otherwise, the fileinfo extension and mime_content_type are tried (in this order), if they are available.
531 * If the dections fails and $ext is not false, the mime type is guessed from the file extension, using
532 * guessTypesForExtension.
533 * If the mime type is still unknown, getimagesize is used to detect the mime type if the file is an image.
534 * If no mime type can be determined, this function returns "unknown/unknown".
536 * @param string $file The file to check
537 * @param mixed $ext The file extension, or true to extract it from the filename.
538 * Set it to false to ignore the extension.
540 * @return string the mime type of $file
541 * @access private
543 function detectMimeType( $file, $ext = true ) {
544 global $wgMimeDetectorCommand;
546 $m = NULL;
547 if ( $wgMimeDetectorCommand ) {
548 $fn = wfEscapeShellArg( $file );
549 $m = `$wgMimeDetectorCommand $fn`;
550 } elseif ( function_exists( "finfo_open" ) && function_exists( "finfo_file" ) ) {
552 # This required the fileinfo extension by PECL,
553 # see http://pecl.php.net/package/fileinfo
554 # This must be compiled into PHP
556 # finfo is the official replacement for the deprecated
557 # mime_content_type function, see below.
559 # If you may need to load the fileinfo extension at runtime, set
560 # $wgLoadFileinfoExtension in LocalSettings.php
562 $mime_magic_resource = finfo_open(FILEINFO_MIME); /* return mime type ala mimetype extension */
564 if ($mime_magic_resource) {
565 $m = finfo_file( $mime_magic_resource, $file );
566 finfo_close( $mime_magic_resource );
567 } else {
568 wfDebug( __METHOD__.": finfo_open failed on ".FILEINFO_MIME."!\n" );
570 } elseif ( function_exists( "mime_content_type" ) ) {
572 # NOTE: this function is available since PHP 4.3.0, but only if
573 # PHP was compiled with --with-mime-magic or, before 4.3.2, with --enable-mime-magic.
575 # On Windows, you must set mime_magic.magicfile in php.ini to point to the mime.magic file bundeled with PHP;
576 # sometimes, this may even be needed under linus/unix.
578 # Also note that this has been DEPRECATED in favor of the fileinfo extension by PECL, see above.
579 # see http://www.php.net/manual/en/ref.mime-magic.php for details.
581 $m = mime_content_type($file);
582 } else {
583 wfDebug( __METHOD__.": no magic mime detector found!\n" );
586 if ( $m ) {
587 # normalize
588 $m = preg_replace( '![;, ].*$!', '', $m ); #strip charset, etc
589 $m = trim( $m );
590 $m = strtolower( $m );
592 if ( strpos( $m, 'unknown' ) !== false ) {
593 $m = NULL;
594 } else {
595 wfDebug( __METHOD__.": magic mime type of $file: $m\n" );
596 return $m;
600 # if desired, look at extension as a fallback.
601 if ( $ext === true ) {
602 $i = strrpos( $file, '.' );
603 $ext = strtolower( $i ? substr( $file, $i + 1 ) : '' );
605 if ( $ext ) {
606 if( $this->isRecognizableExtension( $ext ) ) {
607 wfDebug( __METHOD__. ": refusing to guess mime type for .$ext file, we should have recognized it\n" );
608 } else {
609 $m = $this->guessTypesForExtension( $ext );
610 if ( $m ) {
611 wfDebug( __METHOD__.": extension mime type of $file: $m\n" );
612 return $m;
617 #unknown type
618 wfDebug( __METHOD__.": failed to guess mime type for $file!\n" );
619 return "unknown/unknown";
623 * Determine the media type code for a file, using its mime type, name and possibly
624 * its contents.
626 * This function relies on the findMediaType(), mapping extensions and mime
627 * types to media types.
629 * @todo analyse file if need be
630 * @todo look at multiple extension, separately and together.
632 * @param string $path full path to the image file, in case we have to look at the contents
633 * (if null, only the mime type is used to determine the media type code).
634 * @param string $mime mime type. If null it will be guessed using guessMimeType.
636 * @return (int?string?) a value to be used with the MEDIATYPE_xxx constants.
638 function getMediaType( $path = NULL, $mime = NULL ) {
639 if( !$mime && !$path ) return MEDIATYPE_UNKNOWN;
641 # If mime type is unknown, guess it
642 if( !$mime ) $mime = $this->guessMimeType( $path, false );
644 # Special code for ogg - detect if it's video (theora),
645 # else label it as sound.
646 if( $mime == "application/ogg" && file_exists( $path ) ) {
648 // Read a chunk of the file
649 $f = fopen( $path, "rt" );
650 if ( !$f ) return MEDIATYPE_UNKNOWN;
651 $head = fread( $f, 256 );
652 fclose( $f );
654 $head = strtolower( $head );
656 # This is an UGLY HACK, file should be parsed correctly
657 if ( strpos( $head, 'theora' ) !== false ) return MEDIATYPE_VIDEO;
658 elseif ( strpos( $head, 'vorbis' ) !== false ) return MEDIATYPE_AUDIO;
659 elseif ( strpos( $head, 'flac' ) !== false ) return MEDIATYPE_AUDIO;
660 elseif ( strpos( $head, 'speex' ) !== false ) return MEDIATYPE_AUDIO;
661 else return MEDIATYPE_MULTIMEDIA;
664 # check for entry for full mime type
665 if( $mime ) {
666 $type = $this->findMediaType( $mime );
667 if( $type !== MEDIATYPE_UNKNOWN ) return $type;
670 # Check for entry for file extension
671 $e = NULL;
672 if ( $path ) {
673 $i = strrpos( $path, '.' );
674 $e = strtolower( $i ? substr( $path, $i + 1 ) : '' );
676 # TODO: look at multi-extension if this fails, parse from full path
678 $type = $this->findMediaType( '.' . $e );
679 if ( $type !== MEDIATYPE_UNKNOWN ) return $type;
682 # Check major mime type
683 if( $mime ) {
684 $i = strpos( $mime, '/' );
685 if( $i !== false ) {
686 $major = substr( $mime, 0, $i );
687 $type = $this->findMediaType( $major );
688 if( $type !== MEDIATYPE_UNKNOWN ) return $type;
692 if( !$type ) $type = MEDIATYPE_UNKNOWN;
694 return $type;
697 /** returns a media code matching the given mime type or file extension.
698 * File extensions are represented by a string starting with a dot (.) to
699 * distinguish them from mime types.
701 * This funktion relies on the mapping defined by $this->mMediaTypes
702 * @access private
704 function findMediaType( $extMime ) {
705 if ( strpos( $extMime, '.' ) === 0 ) { #if it's an extension, look up the mime types
706 $m = $this->getTypesForExtension( substr( $extMime, 1 ) );
707 if ( !$m ) return MEDIATYPE_UNKNOWN;
709 $m = explode( ' ', $m );
710 } else {
711 # Normalize mime type
712 if ( isset( $this->mMimeTypeAliases[$extMime] ) ) {
713 $extMime = $this->mMimeTypeAliases[$extMime];
716 $m = array($extMime);
719 foreach ( $m as $mime ) {
720 foreach ( $this->mMediaTypes as $type => $codes ) {
721 if ( in_array($mime, $codes, true ) ) {
722 return $type;
727 return MEDIATYPE_UNKNOWN;