Implements functions related to MIME types such as detection and mapping to file extension. More...

Inheritance diagram for MimeAnalyzer:

Collaboration diagram for MimeAnalyzer:

[legend]

Public Member Functions
	__construct (array $params)

	addExtraInfo (string $info)
	Adds to the list mapping MIME to media type. More...

	addExtraTypes (string $types)
	Adds to the list mapping MIME to file extensions. More...

	detectZipType (string $header, ?string $tail=null, $ext=false)
	Detect application-specific file type of a given ZIP file from its header data. More...

	getExtensionFromMimeTypeOrNull (string $mime)
	Returns a single file extension for a given MIME type or null if unknown. More...

	getExtensionsForType ( $mime)
	Returns a list of file extensions for a given MIME type as a space separated string or null if the MIME type was unrecognized. More...

	getExtensionsFromMimeType (string $mime)
	Returns an array of file extensions associated with a given MIME type. More...

	getIEMimeTypes (string $fileName, string $chunk, string $proposed)
	Get the MIME types that various versions of Internet Explorer would detect from a chunk of the content. More...

	getMediaType (string $path=null, string $mime=null)
	Determine the media type code for a file, using its MIME type, name and possibly its contents. More...

	getMediaTypes ()
	Returns an array of media types (MEDIATYPE_xxx constants) More...

	getMimeTypeFromExtensionOrNull (string $ext)
	Returns a single MIME type for a given file extension or null if unknown. More...

	getMimeTypesFromExtension (string $ext)
	Returns an array of MIME types associated with a given file extension. More...

	getTypesForExtension ( $ext)
	Returns a list of MIME types for a given file extension as a space separated string or null if the extension was unrecognized. More...

	guessMimeType (string $file, $ext=true)
	MIME type detection. More...

	guessTypesForExtension ( $ext)
	Returns a single file extension for a given MIME type or null if unknown. More...

	improveTypeFromExtension (string $mime, string $ext)
	Improves a MIME type using the file extension. More...

	isMatchingExtension (string $extension, string $mime)
	Tests if the extension matches the given MIME type. More...

	isPHPImageType (string $mime)
	Returns true if the MIME type is known to represent an image format supported by the PHP GD library. More...

	isRecognizableExtension (string $extension)
	Returns true if the extension represents a type which can be reliably detected from its content. More...

	setLogger (LoggerInterface $logger)

Public Attributes
array	$mExtToMime = []
	Map of file extensions types to MIME types (as a space separated list) More...

Protected Member Functions
	getIEContentAnalyzer ()
	Get a cached instance of IEContentAnalyzer. More...

	loadFiles ()

	parseMimeInfo (string $rawMimeInfo)

	parseMimeTypes (string $rawMimeTypes)

Protected Attributes
callable	$detectCallback

callable	$extCallback

array< string, string[]>	$extToMimes = []
	Map of file extensions to MIME types. More...

callable	$guessCallback

IEContentAnalyzer	$IEAnalyzer

string	$infoFile

callable	$initCallback

array	$mediaTypes = null
	Mapping of media types to arrays of MIME types. More...

array< string, string[]>	$mimeToExts = []
	Map of MIME types to file extensions. More...

array	$mimeTypeAliases = null
	Map of MIME type aliases. More...

string	$typeFile

string	$xmlTypes

Private Member Functions
	detectMicrosoftBinaryType ( $handle)
	Detect the type of a Microsoft Compound Binary a.k.a. More...

	detectMimeType (string $file, $ext=true)
	Internal MIME type detection. More...

	doGuessMimeType (string $file, $ext)
	Guess the MIME type from the file contents. More...

	findMediaType (string $extMime)
	Returns a media code matching the given MIME type or file extension. More...

Private Attributes
string	$extraInfo = ''
	Extra MIME info, set for example by media handling extensions. More...

string	$extraTypes = ''
	Extra MIME types, set for example by media handling extensions. More...

LoggerInterface	$logger

Detailed Description

Implements functions related to MIME types such as detection and mapping to file extension.

Since: 1.28

Definition at line 33 of file MimeAnalyzer.php.

Constructor & Destructor Documentation

◆ __construct()

MimeAnalyzer::__construct ( array $params )

Parameters

array

$params

Configuration map, includes:

typeFile: path to file with the list of known MIME types
infoFile: path to file with the MIME type info
xmlTypes: map of root element names to XML MIME types
initCallback: initialization callback that is passed this object [optional]
detectCallback: alternative to finfo that returns the mime type for a file. For example, the callback can return the output of "file -bi". [optional]
guessCallback: callback to improve the guessed MIME type using the file data. This is intended for fixing mistakes in fileinfo or "detectCallback". [optional]
extCallback: callback to improve the guessed MIME type using the extension. [optional]
logger: PSR-3 logger [optional]

Note: Constructing these instances is expensive due to file reads. A service or singleton pattern should be used to avoid creating instances again and again.

Definition at line 89 of file MimeAnalyzer.php.

References loadFiles().

Member Function Documentation

◆ addExtraInfo()

MimeAnalyzer::addExtraInfo ( string $info )

Adds to the list mapping MIME to media type.

As an extension author, you are encouraged to submit patches to MediaWiki's core to add new MIME info to MimeMap.php.

Parameters

string $info

Definition at line 269 of file MimeAnalyzer.php.

◆ addExtraTypes()

MimeAnalyzer::addExtraTypes ( string $types )

Adds to the list mapping MIME to file extensions.

As an extension author, you are encouraged to submit patches to MediaWiki's core to add new MIME types to MimeMap.php.

Parameters

string $types

Definition at line 257 of file MimeAnalyzer.php.

◆ detectMicrosoftBinaryType()

MimeAnalyzer::detectMicrosoftBinaryType ( $handle )

private

Detect the type of a Microsoft Compound Binary a.k.a.

OLE file. These are old style pre-ODF files such as .doc and .xls

Parameters

resource $handle An opened seekable file handle

Returns: string The detected MIME type

Definition at line 904 of file MimeAnalyzer.php.

References MSCompoundFileReader\readHandle().

Referenced by doGuessMimeType().

◆ detectMimeType()

MimeAnalyzer::detectMimeType	(	string	$file,
			$ext = `true`
	)

private

Internal MIME type detection.

Detection is done using the fileinfo extension if it is available. It can be overridden by callback, which could use an external program, for example. If detection fails and $ext is not false, the MIME type is guessed from the file extension, using getMimeTypeFromExtensionOrNull.

If the MIME type is still unknown, getimagesize is used to detect the MIME type if the file is an image. If no MIME type can be determined, this function returns 'unknown/unknown'.

Parameters

string	$file	The file to check
string \| bool	$ext	The file extension, or true (default) to extract it from the filename. Set it to false to ignore the extension. DEPRECATED! Set to false, use improveTypeFromExtension($mime, $ext) later to improve MIME type.

Returns: string The MIME type of $file

Definition at line 933 of file MimeAnalyzer.php.

References $detectCallback, $ext, $file, getMimeTypeFromExtensionOrNull(), and isRecognizableExtension().

Referenced by guessMimeType().

◆ detectZipType()

MimeAnalyzer::detectZipType	(	string	$header,
		?string	$tail = `null`,
			$ext = `false`
	)

Detect application-specific file type of a given ZIP file from its header data.

Currently works for OpenDocument and OpenXML types... If can't tell, returns 'application/zip'.

Parameters

string	$header	Some reasonably-sized chunk of file header
string \| null	$tail	The tail of the file
string \| bool	$ext	The file extension, or true to extract it from the filename. Set it to false (default) to ignore the extension. DEPRECATED! Set to false, use improveTypeFromExtension($mime, $ext) later to improve MIME type.

Returns: string

Definition at line 796 of file MimeAnalyzer.php.

References $ext, $header, $matches, $mime, getMimeTypeFromExtensionOrNull(), and isMatchingExtension().

Referenced by doGuessMimeType().

◆ doGuessMimeType()

MimeAnalyzer::doGuessMimeType	(	string	$file,
			$ext
	)

private

Guess the MIME type from the file contents.

Todo:: Remove $ext param

Parameters

string	$file
string \| bool	$ext

Returns: bool|string

Exceptions

UnexpectedValueException

Definition at line 546 of file MimeAnalyzer.php.

References $ext, $file, $guessCallback, $mime, $xmlTypes, detectMicrosoftBinaryType(), and detectZipType().

Referenced by guessMimeType().

◆ findMediaType()

MimeAnalyzer::findMediaType ( string $extMime )

private

Returns a media code matching the given MIME type or file extension.

File extensions are represented by a string starting with a dot (.) to distinguish them from MIME types.

Parameters

string $extMime

Returns: int|string

Definition at line 1089 of file MimeAnalyzer.php.

References $mime, $type, getMimeTypesFromExtension(), and MEDIATYPE_UNKNOWN.

Referenced by getMediaType(), and improveTypeFromExtension().

◆ getExtensionFromMimeTypeOrNull()

MimeAnalyzer::getExtensionFromMimeTypeOrNull ( string $mime )

Returns a single file extension for a given MIME type or null if unknown.

This is always the first type from the list returned by getExtensionsFromMimeType($mime).

Since: 1.35

Parameters

string $mime

Returns: string|null

Definition at line 364 of file MimeAnalyzer.php.

References getExtensionsFromMimeType().

◆ getExtensionsForType()

MimeAnalyzer::getExtensionsForType ( $mime )

Returns a list of file extensions for a given MIME type as a space separated string or null if the MIME type was unrecognized.

Resolves MIME type aliases.

Deprecated:: since 1.35 Use getExtensionsFromMimeType() instead.

Parameters

string $mime

Returns: string|null

Definition at line 282 of file MimeAnalyzer.php.

References $mime, and getExtensionsFromMimeType().

◆ getExtensionsFromMimeType()

MimeAnalyzer::getExtensionsFromMimeType ( string $mime )

Returns an array of file extensions associated with a given MIME type.

The returned array is empty if the MIME type was unrecognized. Resolves MIME type aliases.

Since: 1.35

Parameters

string $mime

Returns: string[]

Definition at line 296 of file MimeAnalyzer.php.

References $mime.

Referenced by getExtensionFromMimeTypeOrNull(), getExtensionsForType(), and isMatchingExtension().

◆ getIEContentAnalyzer()

MimeAnalyzer::getIEContentAnalyzer ( )

protected

Get a cached instance of IEContentAnalyzer.

Returns: IEContentAnalyzer

Definition at line 1144 of file MimeAnalyzer.php.

References $IEAnalyzer.

Referenced by getIEMimeTypes().

◆ getIEMimeTypes()

MimeAnalyzer::getIEMimeTypes	(	string	$fileName,
		string	$chunk,
		string	$proposed
	)

Get the MIME types that various versions of Internet Explorer would detect from a chunk of the content.

Parameters

string	$fileName	The file name (unused at present)
string	$chunk	The first 256 bytes of the file
string	$proposed	The MIME type proposed by the server

Returns: string[]

Definition at line 1134 of file MimeAnalyzer.php.

References getIEContentAnalyzer().

◆ getMediaType()

MimeAnalyzer::getMediaType	(	string	$path = `null`,
		string	$mime = `null`
	)

Determine the media type code for a file, using its MIME type, name and possibly its contents.

This function relies on the findMediaType(), mapping extensions and MIME types to media types.

Todo:: analyse file if need be

Todo:: look at multiple extension, separately and together.

Parameters

string \| null	$path	Full path to the image file, in case we have to look at the contents (if null, only the MIME type is used to determine the media type code).
string \| null	$mime	MIME type. If null it will be guessed using guessMimeType.

Returns: string A value to be used with the MEDIATYPE_xxx constants.

Definition at line 1001 of file MimeAnalyzer.php.

References $mime, $path, $type, findMediaType(), guessMimeType(), MEDIATYPE_AUDIO, MEDIATYPE_MULTIMEDIA, MEDIATYPE_UNKNOWN, and MEDIATYPE_VIDEO.

◆ getMediaTypes()

MimeAnalyzer::getMediaTypes ( )

Returns an array of media types (MEDIATYPE_xxx constants)

Returns: string[]

Definition at line 1121 of file MimeAnalyzer.php.

Referenced by SpecialNewFiles\__construct().

◆ getMimeTypeFromExtensionOrNull()

MimeAnalyzer::getMimeTypeFromExtensionOrNull ( string $ext )

Returns a single MIME type for a given file extension or null if unknown.

This is always the first type from the list returned by getMimeTypesFromExtension($ext).

Since: 1.35

Parameters

string $ext

Returns: string|null

Definition at line 326 of file MimeAnalyzer.php.

References getMimeTypesFromExtension().

Referenced by detectMimeType(), detectZipType(), guessTypesForExtension(), and improveTypeFromExtension().

◆ getMimeTypesFromExtension()

MimeAnalyzer::getMimeTypesFromExtension ( string $ext )

Returns an array of MIME types associated with a given file extension.

The returned array is empty if the file extension is not associated with any MIME types.

Since: 1.35

Parameters

string $ext

Returns: string[]

Definition at line 313 of file MimeAnalyzer.php.

References $ext.

Referenced by findMediaType(), getMimeTypeFromExtensionOrNull(), and getTypesForExtension().

◆ getTypesForExtension()

MimeAnalyzer::getTypesForExtension ( $ext )

Returns a list of MIME types for a given file extension as a space separated string or null if the extension was unrecognized.

Deprecated:: since 1.35 Use getMimeTypesFromExtension() instead.

Parameters

string $ext

Returns: string|null

Definition at line 351 of file MimeAnalyzer.php.

References $ext, and getMimeTypesFromExtension().

◆ guessMimeType()

MimeAnalyzer::guessMimeType	(	string	$file,
			$ext = `true`
	)

MIME type detection.

This uses detectMimeType to detect the MIME type of the file, but applies additional checks to determine some well known file formats that may be missed or misinterpreted by the default MIME detection (namely XML based formats like XHTML or SVG, as well as ZIP based formats like OPC/ODF files).

Parameters

string	$file	The file to check
string \| bool	$ext	The file extension, or true (default) to extract it from the filename. Set it to false to ignore the extension. DEPRECATED! Set to false, use improveTypeFromExtension($mime, $ext) later to improve MIME type.

Returns: string The MIME type of $file

Definition at line 513 of file MimeAnalyzer.php.

References $ext, $mime, detectMimeType(), and doGuessMimeType().

Referenced by getMediaType().

◆ guessTypesForExtension()

MimeAnalyzer::guessTypesForExtension ( $ext )

Returns a single file extension for a given MIME type or null if unknown.

This is always the first type from the list returned by getExtensionsFromMimeType($mime).

Deprecated:: since 1.35 Use getMimeTypeFromExtensionOrNull() instead.

Parameters

string $ext

Returns: string|null

Definition at line 339 of file MimeAnalyzer.php.

References $ext, and getMimeTypeFromExtensionOrNull().

◆ improveTypeFromExtension()

MimeAnalyzer::improveTypeFromExtension	(	string	$mime,
		string	$ext
	)

Improves a MIME type using the file extension.

Some file formats are very generic, so their MIME type is not very meaningful. A more useful MIME type can be derived by looking at the file extension. Typically, this method would be called on the result of guessMimeType().

XXX: Null-returning behavior is probably an accident and definitely confusing (T253483).

Parameters

string	$mime	The MIME type, typically guessed from a file's content.
string	$ext	The file extension, as taken from the file name

Returns: string|null The improved MIME type, or null if the MIME type is unknown/unknown and the extension is not recognized.

Definition at line 457 of file MimeAnalyzer.php.

References $ext, $extCallback, $mime, findMediaType(), getMimeTypeFromExtensionOrNull(), isMatchingExtension(), isRecognizableExtension(), and MEDIATYPE_TEXT.

◆ isMatchingExtension()

MimeAnalyzer::isMatchingExtension	(	string	$extension,
		string	$mime
	)

Tests if the extension matches the given MIME type.

Returns true if a match was found, null if the MIME type is unknown, and false if the MIME type is known but no matches where found.

Parameters

string	$extension
string	$mime

Returns: bool|null

Definition at line 378 of file MimeAnalyzer.php.

References getExtensionsFromMimeType().

Referenced by detectZipType(), and improveTypeFromExtension().

◆ isPHPImageType()

MimeAnalyzer::isPHPImageType ( string $mime )

Returns true if the MIME type is known to represent an image format supported by the PHP GD library.

Parameters

string $mime

Returns: bool

Definition at line 395 of file MimeAnalyzer.php.

References $mime.

◆ isRecognizableExtension()

MimeAnalyzer::isRecognizableExtension ( string $extension )

Returns true if the extension represents a type which can be reliably detected from its content.

Use this to determine whether strict content checks should be applied to reject invalid uploads; if we can't identify the type we won't be able to say if it's invalid.

Todo:: Be more accurate when using fancy MIME detector plugins; right now this is the bare minimum getimagesize() list.

Parameters

string $extension

Returns: bool

Definition at line 422 of file MimeAnalyzer.php.

Referenced by detectMimeType(), and improveTypeFromExtension().

◆ loadFiles()

MimeAnalyzer::loadFiles ( )

protected

Definition at line 102 of file MimeAnalyzer.php.

References $ext, $extraInfo, $extraTypes, $mime, parseMimeInfo(), and parseMimeTypes().

Referenced by __construct().

◆ parseMimeInfo()

MimeAnalyzer::parseMimeInfo ( string $rawMimeInfo )

protected

Definition at line 188 of file MimeAnalyzer.php.

References $lines, $mime, $s, and MEDIATYPE_UNKNOWN.

Referenced by loadFiles().

◆ parseMimeTypes()

MimeAnalyzer::parseMimeTypes ( string $rawMimeTypes )

protected

Definition at line 152 of file MimeAnalyzer.php.

References $ext, $lines, $mime, and $s.

Referenced by loadFiles().

◆ setLogger()

MimeAnalyzer::setLogger ( LoggerInterface $logger )

Definition at line 245 of file MimeAnalyzer.php.

References $logger.

Member Data Documentation

◆ $detectCallback

callable MimeAnalyzer::$detectCallback

protected

Definition at line 43 of file MimeAnalyzer.php.

Referenced by detectMimeType().

◆ $extCallback

callable MimeAnalyzer::$extCallback

protected

Definition at line 47 of file MimeAnalyzer.php.

Referenced by improveTypeFromExtension().

◆ $extraInfo

string MimeAnalyzer::$extraInfo = ''

private

Extra MIME info, set for example by media handling extensions.

Definition at line 66 of file MimeAnalyzer.php.

Referenced by loadFiles().

◆ $extraTypes

string MimeAnalyzer::$extraTypes = ''

private

Extra MIME types, set for example by media handling extensions.

Definition at line 64 of file MimeAnalyzer.php.

Referenced by loadFiles().

◆ $extToMimes

array<string,string[]> MimeAnalyzer::$extToMimes = []

protected

Map of file extensions to MIME types.

Definition at line 55 of file MimeAnalyzer.php.

◆ $guessCallback

callable MimeAnalyzer::$guessCallback

protected

Definition at line 45 of file MimeAnalyzer.php.

Referenced by doGuessMimeType().

◆ $IEAnalyzer

IEContentAnalyzer MimeAnalyzer::$IEAnalyzer

protected

Definition at line 61 of file MimeAnalyzer.php.

Referenced by getIEContentAnalyzer().

◆ $infoFile

string MimeAnalyzer::$infoFile

protected

Definition at line 37 of file MimeAnalyzer.php.

◆ $initCallback

callable MimeAnalyzer::$initCallback

protected

Definition at line 41 of file MimeAnalyzer.php.

◆ $logger

LoggerInterface MimeAnalyzer::$logger

private

Definition at line 69 of file MimeAnalyzer.php.

Referenced by setLogger().

◆ $mediaTypes

array MimeAnalyzer::$mediaTypes = null

protected

Mapping of media types to arrays of MIME types.

Definition at line 49 of file MimeAnalyzer.php.

◆ $mExtToMime

array MimeAnalyzer::$mExtToMime = []

Map of file extensions types to MIME types (as a space separated list)

Definition at line 58 of file MimeAnalyzer.php.

◆ $mimeToExts

array<string,string[]> MimeAnalyzer::$mimeToExts = []

protected

Map of MIME types to file extensions.

Definition at line 53 of file MimeAnalyzer.php.

◆ $mimeTypeAliases

array MimeAnalyzer::$mimeTypeAliases = null

protected

Map of MIME type aliases.

Definition at line 51 of file MimeAnalyzer.php.

◆ $typeFile

string MimeAnalyzer::$typeFile

protected

Definition at line 35 of file MimeAnalyzer.php.

◆ $xmlTypes

string MimeAnalyzer::$xmlTypes

protected

Definition at line 39 of file MimeAnalyzer.php.

Referenced by doGuessMimeType().

The documentation for this class was generated from the following file:

includes/libs/mime/MimeAnalyzer.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addExtraInfo()

◆ addExtraTypes()

◆ detectMicrosoftBinaryType()

◆ detectMimeType()

◆ detectZipType()

◆ doGuessMimeType()

◆ findMediaType()

◆ getExtensionFromMimeTypeOrNull()

◆ getExtensionsForType()

◆ getExtensionsFromMimeType()

◆ getIEContentAnalyzer()

◆ getIEMimeTypes()

◆ getMediaType()

◆ getMediaTypes()

◆ getMimeTypeFromExtensionOrNull()

◆ getMimeTypesFromExtension()

◆ getTypesForExtension()

◆ guessMimeType()

◆ guessTypesForExtension()

◆ improveTypeFromExtension()

◆ isMatchingExtension()

◆ isPHPImageType()

◆ isRecognizableExtension()

◆ loadFiles()

◆ parseMimeInfo()

◆ parseMimeTypes()

◆ setLogger()

Member Data Documentation

◆ $detectCallback

◆ $extCallback

◆ $extraInfo

◆ $extraTypes

◆ $extToMimes

◆ $guessCallback

◆ $IEAnalyzer

◆ $infoFile

◆ $initCallback

◆ $logger

◆ $mediaTypes

◆ $mExtToMime

◆ $mimeToExts

◆ $mimeTypeAliases

◆ $typeFile

◆ $xmlTypes