Base media handler class. More...

Inheritance diagram for MediaHandler:

[legend]

Public Member Functions
	canAnimateThumbnail ( $file)
	If the material is animated, we can animate the thumbnail.

	canRender ( $file)
	True if the handled types can be transformed.

	canRotate ()
	True if the handler can rotate the media.

	convertMetadataVersion ( $metadata, $version=1)
	Convert metadata version.

	doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
	Get a MediaTransformOutput object representing the transformed output.

	filterThumbnailPurgeList (&$files, $options)
	Remove files from the purge list.

	formatMetadata ( $image, $context=false)
	Get an array structure that looks like this:

	getAvailableLanguages (File $file)
	Get list of languages file can be viewed in.

	getCommonMetaArray (File $file)
	Get an array of standard (FormatMetadata type) metadata values.

	getContentHeaders ( $metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata Stable to override.

	getDefaultRenderLanguage (File $file)
	On file types that support renderings in multiple languages, which language is used by default if unspecified.

	getDimensionsString ( $file)
	Shown in file history box on image description page.

	getEntireText (File $file)
	Get the text of the entire document.

	getImageSize ( $image, $path)
	Get an image size array like that returned by getimagesize(), or false if it can't be determined.

	getLength ( $file)
	If its an audio file, return the length of the file.

	getLongDesc ( $file)
	Long description.

	getMatchedLanguage ( $userPreferredLanguage, array $availableLanguages)
	When overridden in a descendant class, returns a language code most suiting.

	getMetadata ( $image, $path)
	Get handler-specific metadata which will be saved in the img_metadata field.

	getMetadataType ( $image)
	Get a string describing the type of metadata, for display purposes.

	getPageDimensions (File $image, $page)
	Get an associative array of page dimensions Currently "width" and "height" are understood, but this might be expanded in the future.

	getPageText (File $image, $page)
	Generic getter for text layer.

	getParamMap ()
	Get an associative array mapping magic word IDs to parameter names.

	getRotation ( $file)
	On supporting image formats, try to read out the low-level orientation of the file and return the angle that the file needs to be rotated to be viewed.

	getScriptedTransform ( $image, $script, $params)
	Get a MediaTransformOutput object representing an alternate of the transformed output which will call an intermediary thumbnail assist script.

	getShortDesc ( $file)
	Short description.

	getThumbType ( $ext, $mime, $params=null)
	Get the thumbnail extension and MIME type for a given source MIME type.

	getTransform ( $image, $dstPath, $dstUrl, $params)
	Get a MediaTransformOutput object representing the transformed output.

	getWarningConfig ( $file)
	Gets configuration for the file warning message.

	isAnimatedImage ( $file)
	The material is an image, and is animated.

	isEnabled ()
	False if the handler is disabled for all files Stable to override.

	isExpensiveToThumbnail ( $file)
	True if creating thumbnails from the file is large or otherwise resource-intensive.

	isMetadataValid ( $image, $metadata)
	Check if the metadata string is valid for this handler.

	isMultiPage ( $file)
	True if the type has multi-page capabilities.

	isVectorized ( $file)
	The material is vectorized and thus scaling is lossless.

	makeParamString ( $params)
	Merge a parameter array into a string appropriate for inclusion in filenames.

	mustRender ( $file)
	True if handled types cannot be displayed directly in a browser but can be rendered.

	normaliseParams ( $image, &$params)
	Changes the parameter array as necessary, ready for transformation.

	pageCount (File $file)
	Page count for a multi-page document, false if unsupported or unknown.

	parseParamString ( $str)
	Parse a param string made with makeParamString back into an array.

	parserTransformHook ( $parser, $file)
	Modify the parser object post-transform.

	removeBadFile ( $dstPath, $retval=0)
	Check for zero-sized thumbnails.

	sanitizeParamsForBucketing ( $params)
	Returns a normalised params array for which parameters have been cleaned up for bucketing purposes Stable to override.

	supportsBucketing ()
	Returns whether or not this handler supports the chained generation of thumbnails according to buckets Stable to override.

	validateParam ( $name, $value)
	Validate a thumbnail parameter at parse time.

	verifyUpload ( $fileName)
	File validation hook called on upload.

Static Public Member Functions
static	fitBoxWidth ( $boxWidth, $boxHeight, $maxHeight)
	Calculate the largest thumbnail width for a given original file size such that the thumbnail's height is at most $maxHeight.

static	getGeneralLongDesc ( $file)
	Used instead of getLongDesc if there is no handler registered for file.

static	getGeneralShortDesc ( $file)
	Used instead of getShortDesc if there is no handler registered for file.

static	getHandler ( $type)
	Get a MediaHandler for a given MIME type from the instance cache.

static	getMetadataVersion ()
	Get metadata version.

static	getPageRangesByDimensions ( $pagesByDimensions)
	Converts a dimensions array about a potentially multipage document from an exhaustive list of ordered page numbers to a list of page ranges.

Public Attributes
const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

Protected Member Functions
	formatMetadataHelper ( $metadataArray, $context=false)
	sorts the visible/invisible field.

	logErrorForExternalProcess ( $retval, $err, $cmd)
	Log an error that occurred in an external process.

	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed.

Static Protected Member Functions
static	addMeta (&$array, $visibility, $type, $id, $value, $param=false)
	This is used to generate an array element for each metadata value That array is then used to generate the table of metadata values on the image page.

Private Attributes
const	MAX_ERR_LOG_SIZE = 65535
	Max length of error logged by logErrorForExternalProcess()

Detailed Description

Base media handler class.

Stable to extend

Definition at line 37 of file MediaHandler.php.

Member Function Documentation

◆ addMeta()

static MediaHandler::addMeta	(	&	$array,
			$visibility,
			$type,
			$id,
			$value,
			$param = false )

staticprotected

This is used to generate an array element for each metadata value That array is then used to generate the table of metadata values on the image page.

Parameters

array	&$array	An array containing elements for each type of visibility and each of those elements being an array of metadata items. This function adds a value to that array.
string	$visibility	('visible' or 'collapsed') if this value is hidden by default.
string	$type	Type of metadata tag (currently always 'exif')
string	$id	The name of the metadata tag (like 'artist' for example). its name in the table displayed is the message "$type-$id" (Ex exif-artist ).
string	$value	Thingy goes into a wikitext table; it used to be escaped but that was incompatible with previous practise of customized display with wikitext formatting via messages such as 'exif-model-value'. So the escaping is taken back out, but generally this seems a confusing interface.
bool \| string	$param	Value to pass to the message for the name of the field as $1. Currently this parameter doesn't seem to ever be used.

Note, everything here is passed through the parser later on (!)

Definition at line 600 of file MediaHandler.php.

References wfDebug(), wfEscapeWikiText(), and wfMessage().

Referenced by SvgHandler\formatMetadata(), and formatMetadataHelper().

◆ canAnimateThumbnail()

MediaHandler::canAnimateThumbnail ( $file )

If the material is animated, we can animate the thumbnail.

Since: 1.20

Stable to override

Parameters

File $file

Returns: bool If material is not animated, handler may return any value.

Reimplemented in GIFHandler, SvgHandler, WebPHandler, and PNGHandler.

Definition at line 415 of file MediaHandler.php.

Referenced by File\canAnimateThumbIfAppropriate().

◆ canRender()

MediaHandler::canRender ( $file )

True if the handled types can be transformed.

Stable to override

Parameters

File $file

Returns: bool

Reimplemented in ImageHandler, TiffHandler, WebPHandler, and XCFHandler.

Definition at line 339 of file MediaHandler.php.

◆ canRotate()

MediaHandler::canRotate ( )

True if the handler can rotate the media.

Since: 1.24 non-static. From 1.21-1.23 was static Stable to override

Returns: bool

Reimplemented in BitmapHandler, and TransformationalImageHandler.

Definition at line 786 of file MediaHandler.php.

◆ convertMetadataVersion()

MediaHandler::convertMetadataVersion	(		$metadata,
			$version = 1 )

Convert metadata version.

By default just returns $metadata, but can be used to allow media handlers to convert between metadata versions. Stable to override

Parameters

string \| array	$metadata	Metadata array (serialized if string)
int	$version	Target version

Returns: array Serialized metadata in specified version, or $metadata on fail.

Reimplemented in ExifBitmapHandler.

Definition at line 169 of file MediaHandler.php.

References unserialize().

Referenced by File\convertMetadataVersion().

◆ doTransform()

MediaHandler::doTransform	(	$image,
		$dstPath,
		$dstUrl,
		$params,
		$flags = 0 )

abstract

Get a MediaTransformOutput object representing the transformed output.

Does the transform unless $flags contains self::TRANSFORM_LATER.

Stable to override

Parameters

File	$image
string	$dstPath	Filesystem destination path
string	$dstUrl	Destination URL to use in output HTML
array	$params	Arbitrary set of parameters validated by $this->validateParam() Note: These parameters have not gone through $this->normaliseParams()
int	$flags	A bitfield, may contain self::TRANSFORM_LATER

Returns: MediaTransformOutput

Reimplemented in BitmapHandler_ClientOnly, DjVuHandler, SvgHandler, and TransformationalImageHandler.

Referenced by File\generateAndSaveThumb(), and getTransform().

◆ filterThumbnailPurgeList()

MediaHandler::filterThumbnailPurgeList	(	&	$files,
			$options )

Remove files from the purge list.

This is used by some video handlers to prevent ?action=purge from removing a transcoded video, which is expensive to regenerate.

See also: LocalFile::purgeThumbnails Stable to override

Parameters

array	&$files
array	$options	Purge options. Currently will always be an array with a single key 'forThumbRefresh' set to true.

Definition at line 775 of file MediaHandler.php.

Referenced by ForeignAPIFile\purgeThumbnails(), and LocalFile\purgeThumbnails().

◆ fitBoxWidth()

static MediaHandler::fitBoxWidth	(	$boxWidth,
		$boxHeight,
		$maxHeight )

static

Calculate the largest thumbnail width for a given original file size such that the thumbnail's height is at most $maxHeight.

Parameters

int	$boxWidth	Width of the thumbnail box.
int	$boxHeight	Height of the thumbnail box.
int	$maxHeight	Maximum height expected for the thumbnail.

Returns: int

Definition at line 675 of file MediaHandler.php.

Referenced by ImageHandler\normaliseParams().

◆ formatMetadata()

MediaHandler::formatMetadata	(		$image,
			$context = false )

Get an array structure that looks like this:

[ 'visible' => [ 'Human-readable name' => 'Human readable value', ... ], 'collapsed' => [ 'Human-readable name' => 'Human readable value', ... ] ] The UI will format this into a table where the visible fields are always visible, and the collapsed fields are optionally visible.

The function should return false if there is no metadata to display.

Todo: FIXME: This interface is not very flexible. The media handler should generate HTML instead. It can do all the formatting according to some standard. That makes it possible to do things like visual indication of grouped and chained streams in ogg container files. Stable to override

Parameters

File	$image
bool \| IContextSource	$context	Context to use (optional)

Returns: array|bool

Reimplemented in SvgHandler, ExifBitmapHandler, GIFHandler, and PNGHandler.

Definition at line 527 of file MediaHandler.php.

◆ formatMetadataHelper()

MediaHandler::formatMetadataHelper	(		$metadataArray,
			$context = false )

protected

sorts the visible/invisible field.

Split off from ImageHandler::formatMetadata, as used by more than one type of handler.

This is used by the media handlers that use the FormatMetadata class

Stable to override

Parameters

array	$metadataArray
bool \| IContextSource	$context	Context to use (optional)

Returns: array Array for use displaying metadata.

Definition at line 543 of file MediaHandler.php.

References addMeta(), FormatMetadata\getFormattedData(), and visibleMetadataFields().

Referenced by ExifBitmapHandler\formatMetadata(), GIFHandler\formatMetadata(), and PNGHandler\formatMetadata().

◆ getAvailableLanguages()

MediaHandler::getAvailableLanguages ( File $file )

Get list of languages file can be viewed in.

Stable to override

Parameters

File $file

Returns: string[] Array of language codes, or empty array if unsupported.

Since: 1.23

Reimplemented in SvgHandler.

Definition at line 839 of file MediaHandler.php.

Referenced by File\getAvailableLanguages(), and File\getMatchedLanguage().

◆ getCommonMetaArray()

MediaHandler::getCommonMetaArray ( File $file )

Get an array of standard (FormatMetadata type) metadata values.

The returned data is largely the same as that from getMetadata(), but formatted in a standard, stable, handler-independent way. The idea being that some values like ImageDescription or Artist are universal and should be retrievable in a handler generic way.

The specific properties are the type of properties that can be handled by the FormatMetadata class. These values are exposed to the user via the filemetadata parser function.

Details of the response format of this function can be found at https://www.mediawiki.org/wiki/Manual:File_metadata_handling tl/dr: the response is an associative array of properties keyed by name, but the value can be complex. You probably want to call one of the FormatMetadata::flatten* functions on the property values before using them, or call FormatMetadata::getFormattedData() on the full response array, which transforms all values into prettified, human-readable text.

Subclasses overriding this function must return a value which is a valid API response fragment (all associative array keys are valid XML tagnames).

Note, if the file simply has no metadata, but the handler supports this interface, it should return an empty array, not false.

Stable to override

Parameters

File $file

Returns: array|bool False if interface not supported

Since: 1.23

Reimplemented in ExifBitmapHandler, SvgHandler, GIFHandler, and PNGHandler.

Definition at line 250 of file MediaHandler.php.

Referenced by File\getCommonMetaArray().

◆ getContentHeaders()

MediaHandler::getContentHeaders ( $metadata )

Get useful response headers for GET/HEAD requests for a file with the given metadata Stable to override.

Parameters

array $metadata Contains this handler's unserialized getMetadata() for a file

Returns: array

Since: 1.30

Definition at line 1011 of file MediaHandler.php.

Referenced by File\getContentHeaders(), and LocalFile\upload().

◆ getDefaultRenderLanguage()

MediaHandler::getDefaultRenderLanguage ( File $file )

On file types that support renderings in multiple languages, which language is used by default if unspecified.

If getAvailableLanguages returns a non-empty array, this must return a valid language code. Otherwise can return null if files of this type do not support alternative language renderings.

Stable to override

Parameters

File $file

Returns: string|null Language code or null if multi-language not supported for filetype.

Since: 1.23

Reimplemented in SvgHandler.

Definition at line 872 of file MediaHandler.php.

Referenced by File\getDefaultRenderLanguage().

◆ getDimensionsString()

MediaHandler::getDimensionsString ( $file )

Shown in file history box on image description page.

Stable to override

Parameters

File $file

Returns: string Dimensions

Reimplemented in ImageHandler.

Definition at line 693 of file MediaHandler.php.

Referenced by File\getDimensionsString().

◆ getEntireText()

MediaHandler::getEntireText ( File $file )

Get the text of the entire document.

Parameters

File $file

Returns: bool|string The text of the document or false if unsupported.

Definition at line 478 of file MediaHandler.php.

References $file, and getPageText().

◆ getGeneralLongDesc()

static MediaHandler::getGeneralLongDesc ( $file )

static

Used instead of getLongDesc if there is no handler registered for file.

Parameters

File $file

Returns: string

Definition at line 662 of file MediaHandler.php.

References $file, and wfMessage().

Referenced by getLongDesc(), and File\getLongDesc().

◆ getGeneralShortDesc()

static MediaHandler::getGeneralShortDesc ( $file )

static

Used instead of getShortDesc if there is no handler registered for file.

Parameters

File $file

Returns: string

Definition at line 650 of file MediaHandler.php.

References $file, and $wgLang.

Referenced by getShortDesc(), and File\getShortDesc().

◆ getHandler()

static MediaHandler::getHandler ( $type )

static

Get a MediaHandler for a given MIME type from the instance cache.

Parameters

string $type

Returns: MediaHandler|bool

Definition at line 53 of file MediaHandler.php.

References $type.

Referenced by ImportImages\execute(), ArchivedFile\getHandler(), File\getHandler(), MWFileProps\getPropsFromPath(), LocalFile\upload(), and UploadBase\verifyFile().

◆ getImageSize()

MediaHandler::getImageSize	(		$image,
			$path )

abstract

Get an image size array like that returned by getimagesize(), or false if it can't be determined.

This function is used for determining the width, height and bitdepth directly from an image. The results are stored in the database in the img_width, img_height, img_bits fields.

Note: If this is a multipage file, return the width and height of the first page.

Parameters

File \| FSFile	$image	The image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an FSFile instead of File (!)
string	$path	The filename

Returns: array|false Follow the format of PHP getimagesize() internal function. See https://www.php.net/getimagesize. MediaWiki will only ever use the first two array keys (the width and height), and the 'bits' associative key. All other array keys are ignored. Returning a 'bits' key is optional as not all formats have a notion of "bitdepth". Returns false on failure.

Reimplemented in BmpHandler, XCFHandler, DjVuHandler, ExifBitmapHandler, and ImageHandler.

Referenced by getPageDimensions().

◆ getLength()

MediaHandler::getLength ( $file )

If its an audio file, return the length of the file.

Otherwise 0.

File::getLength() existed for a long time, but was calling a method that only existed in some subclasses of this class (The TMH ones).

Stable to override

Parameters

File $file

Returns: float Length in seconds

Since: 1.23

Reimplemented in GIFHandler, and PNGHandler.

Definition at line 888 of file MediaHandler.php.

Referenced by File\getLength().

◆ getLongDesc()

MediaHandler::getLongDesc ( $file )

Long description.

Shown under image on image description page surounded by ().

Stable to override

Parameters

File $file

Returns: string

Reimplemented in ImageHandler, SvgHandler, GIFHandler, and PNGHandler.

Definition at line 640 of file MediaHandler.php.

References $file, and getGeneralLongDesc().

Referenced by File\getLongDesc().

◆ getMatchedLanguage()

MediaHandler::getMatchedLanguage	(		$userPreferredLanguage,
		array	$availableLanguages )

When overridden in a descendant class, returns a language code most suiting.

Stable to override

Since: 1.32

Parameters

string	$userPreferredLanguage	Language code requesed
string[]	$availableLanguages	Languages present in the file

Returns: string|null Language code picked or null if not supported/available

Reimplemented in SvgHandler.

Definition at line 854 of file MediaHandler.php.

Referenced by File\getMatchedLanguage().

◆ getMetadata()

MediaHandler::getMetadata	(		$image,
			$path )

Get handler-specific metadata which will be saved in the img_metadata field.

Stable to override

Parameters

File \| FSFile	$image	The image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an FSFile instead of File (!)
string	$path	The filename

Returns: string A string of metadata in php serialized form (Run through serialize())

Reimplemented in SvgHandler, XCFHandler, GIFHandler, JpegHandler, PNGHandler, TiffHandler, WebPHandler, and DjVuHandler.

Definition at line 130 of file MediaHandler.php.

Referenced by ExifBitmapHandler\getImageSize().

◆ getMetadataType()

MediaHandler::getMetadataType ( $image )

Get a string describing the type of metadata, for display purposes.

Stable to override

Note: This method is currently unused.

Parameters

File $image

Returns: string

Reimplemented in DjVuHandler, ExifBitmapHandler, GIFHandler, PNGHandler, SvgHandler, and WebPHandler.

Definition at line 190 of file MediaHandler.php.

◆ getMetadataVersion()

static MediaHandler::getMetadataVersion ( )

static

Get metadata version.

This is not used for validating metadata, this is used for the api when returning metadata, since api content formats should stay the same over time, and so things using ForeignApiRepo can keep backwards compatibility

All core media handlers share a common version number, and extensions can use the GetMetadataVersion hook to append to the array (they should append a unique string so not to get confusing). If there was a media handler named 'foo' with metadata version 3 it might add to the end of the array the element 'foo=3'. if the core metadata version is 2, the end version string would look like '2;foo=3'.

Stable to override

Returns: string Version string

Definition at line 151 of file MediaHandler.php.

Referenced by ForeignAPIFile\newFromTitle().

◆ getPageDimensions()

MediaHandler::getPageDimensions	(	File	$image,
			$page )

Get an associative array of page dimensions Currently "width" and "height" are understood, but this might be expanded in the future.

Returns false if unknown.

It is expected that handlers for paged media (e.g. DjVuHandler) will override this method so that it gives the correct results for each specific page of the file, using the $page argument.

Note: For non-paged media, use getImageSize.

Stable to override

Parameters

File	$image
int	$page	What page to get dimensions of

Returns: array|bool

Reimplemented in DjVuHandler.

Definition at line 447 of file MediaHandler.php.

References getImageSize(), and File\getLocalRefPath().

Referenced by LocalFile\getHeight(), and LocalFile\getWidth().

◆ getPageRangesByDimensions()

static MediaHandler::getPageRangesByDimensions ( $pagesByDimensions )

static

Converts a dimensions array about a potentially multipage document from an exhaustive list of ordered page numbers to a list of page ranges.

Parameters

array[] $pagesByDimensions

Returns: string

Since: 1.30

Definition at line 964 of file MediaHandler.php.

◆ getPageText()

MediaHandler::getPageText	(	File	$image,
			$page )

Generic getter for text layer.

Currently overloaded by PDF and DjVu handlers Stable to override

Parameters

File	$image
int	$page	Page number to get information for

Returns: bool|string Page text or false when no text found or if unsupported.

Reimplemented in DjVuHandler.

Definition at line 469 of file MediaHandler.php.

Referenced by getEntireText().

◆ getParamMap()

MediaHandler::getParamMap ( )

abstract

Get an associative array mapping magic word IDs to parameter names.

Will be used by the parser to identify parameters.

Reimplemented in DjVuHandler, ImageHandler, and SvgHandler.

◆ getRotation()

MediaHandler::getRotation ( $file )

On supporting image formats, try to read out the low-level orientation of the file and return the angle that the file needs to be rotated to be viewed.

This information is only useful when manipulating the original file; the width and height we normally work with is logical, and will match any produced output views.

For files we don't know, we return 0.

Stable to override

Parameters

File $file

Returns: int 0, 90, 180 or 270

Reimplemented in ExifBitmapHandler.

Definition at line 806 of file MediaHandler.php.

Referenced by TransformationalImageHandler\mustRender(), BitmapHandler\rotate(), BitmapHandler\transformGd(), BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

◆ getScriptedTransform()

MediaHandler::getScriptedTransform	(	$image,
		$script,
		$params )

Get a MediaTransformOutput object representing an alternate of the transformed output which will call an intermediary thumbnail assist script.

Used when the repository has a thumbnailScriptUrl option configured.

Return false to fall back to the regular getTransform().

Stable to override

Parameters

File	$image
string	$script
array	$params

Returns: bool|ThumbnailImage

Reimplemented in ImageHandler.

Definition at line 269 of file MediaHandler.php.

Referenced by File\transform().

◆ getShortDesc()

MediaHandler::getShortDesc ( $file )

Short description.

Shown on Special:Search results.

Stable to override

Parameters

File $file

Returns: string

Reimplemented in ImageHandler.

Definition at line 628 of file MediaHandler.php.

References $file, and getGeneralShortDesc().

Referenced by File\getShortDesc().

◆ getThumbType()

MediaHandler::getThumbType	(	$ext,
		$mime,
		$params = null )

Get the thumbnail extension and MIME type for a given source MIME type.

Stable to override

Parameters

string	$ext	Extension of original file
string	$mime	MIME type of original file
array \| null	$params	Handler specific rendering parameters

Returns: array Thumbnail extension and MIME type

Reimplemented in BmpHandler, DjVuHandler, SvgHandler, TiffHandler, WebPHandler, and XCFHandler.

Definition at line 315 of file MediaHandler.php.

References $ext, and $mime.

◆ getTransform()

MediaHandler::getTransform	(	$image,
		$dstPath,
		$dstUrl,
		$params )

final

Get a MediaTransformOutput object representing the transformed output.

Does not actually do the transform.

Stable to override

Parameters

File	$image
string	$dstPath	Filesystem destination path
string	$dstUrl	Destination URL to use in output HTML
array	$params	Arbitrary set of parameters validated by $this->validateParam()

Returns: MediaTransformOutput

Definition at line 285 of file MediaHandler.php.

References doTransform().

Referenced by File\generateAndSaveThumb(), File\transform(), and File\transformErrorOutput().

◆ getWarningConfig()

MediaHandler::getWarningConfig ( $file )

Gets configuration for the file warning message.

Return value of the following structure: [ // Required, module with messages loaded for the client 'module' => 'example.filewarning.messages', // Required, array of names of messages 'messages' => [ // Required, main warning message 'main' => 'example-filewarning-main', // Optional, header for warning dialog 'header' => 'example-filewarning-header', // Optional, footer for warning dialog 'footer' => 'example-filewarning-footer', // Optional, text for more-information link (see below) 'info' => 'example-filewarning-info', ], // Optional, link for more information 'link' => 'http://example.com', ]

Returns null if no warning is necessary. Stable to override

Parameters

File $file

Returns: array|null

Definition at line 953 of file MediaHandler.php.

◆ isAnimatedImage()

MediaHandler::isAnimatedImage ( $file )

The material is an image, and is animated.

In particular, video material need not return true.

Note: Before 1.20, this was a method of ImageHandler only

Stable to override

Parameters

File $file

Returns: bool

Reimplemented in SvgHandler, GIFHandler, PNGHandler, and WebPHandler.

Definition at line 402 of file MediaHandler.php.

Referenced by File\canAnimateThumbIfAppropriate(), BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

◆ isEnabled()

MediaHandler::isEnabled ( )

False if the handler is disabled for all files Stable to override.

Returns: bool

Reimplemented in DjVuHandler, and SvgHandler.

Definition at line 425 of file MediaHandler.php.

◆ isExpensiveToThumbnail()

MediaHandler::isExpensiveToThumbnail ( $file )

True if creating thumbnails from the file is large or otherwise resource-intensive.

Stable to override

Parameters

File $file

Returns: bool

Reimplemented in DjVuHandler, and TiffHandler.

Definition at line 899 of file MediaHandler.php.

Referenced by File\isExpensiveToThumbnail().

◆ isMetadataValid()

MediaHandler::isMetadataValid	(		$image,
			$metadata )

Check if the metadata string is valid for this handler.

If it returns MediaHandler::METADATA_BAD (or false), Image will reload the metadata from the file and update the database. MediaHandler::METADATA_GOOD for if the metadata is a-ok, MediaHandler::METADATA_COMPATIBLE if metadata is old but backwards compatible (which may or may not trigger a metadata reload).

Note: Returning self::METADATA_BAD will trigger a metadata reload from file on page view. Always returning this from a broken file, or suddenly triggering as bad metadata for a large number of files can cause performance problems.

Stable to override

Parameters

File	$image
string	$metadata	The metadata in serialized form

Returns: bool|int

Reimplemented in XCFHandler, DjVuHandler, ExifBitmapHandler, GIFHandler, PNGHandler, SvgHandler, and WebPHandler.

Definition at line 212 of file MediaHandler.php.

References METADATA_GOOD.

Referenced by LocalFile\maybeUpgradeRow().

◆ isMultiPage()

MediaHandler::isMultiPage ( $file )

True if the type has multi-page capabilities.

Stable to override

Parameters

File $file

Returns: bool

Reimplemented in DjVuHandler.

Definition at line 364 of file MediaHandler.php.

◆ isVectorized()

MediaHandler::isVectorized ( $file )

The material is vectorized and thus scaling is lossless.

Stable to override

Parameters

File $file

Returns: bool

Reimplemented in SvgHandler.

Definition at line 388 of file MediaHandler.php.

Referenced by File\isVectorized().

◆ logErrorForExternalProcess()

MediaHandler::logErrorForExternalProcess	(	$retval,
		$err,
		$cmd )

protected

Log an error that occurred in an external process.

Moved from BitmapHandler to MediaHandler with MediaWiki 1.23

Since: 1.23

Parameters

int	$retval
string	$err	Error reported by command. Anything longer than MediaHandler::MAX_ERR_LOG_SIZE is stripped off.
string	$cmd

Definition at line 821 of file MediaHandler.php.

References wfDebugLog(), and wfHostname().

Referenced by DjVuHandler\doTransform(), SvgHandler\rasterize(), BitmapHandler\rotate(), JpegHandler\rotate(), JpegHandler\swapICCProfile(), BitmapHandler\transformCustom(), and BitmapHandler\transformImageMagick().

◆ makeParamString()

MediaHandler::makeParamString ( $params )

abstract

Merge a parameter array into a string appropriate for inclusion in filenames.

Parameters

array $params Array of parameters that have been through normaliseParams.

Returns: string

Reimplemented in BitmapHandler, DjVuHandler, ImageHandler, JpegHandler, and SvgHandler.

◆ mustRender()

MediaHandler::mustRender ( $file )

True if handled types cannot be displayed directly in a browser but can be rendered.

Stable to override

Parameters

File $file

Returns: bool

Reimplemented in BmpHandler, DjVuHandler, SvgHandler, TiffHandler, TransformationalImageHandler, WebPHandler, and XCFHandler.

Definition at line 352 of file MediaHandler.php.

◆ normaliseParams()

MediaHandler::normaliseParams	(		$image,
		&	$params )

abstract

Changes the parameter array as necessary, ready for transformation.

Should be idempotent. Returns false if the parameters are unacceptable and the transform should fail

Parameters

File	$image
array	&$params

Reimplemented in BitmapHandler, BitmapHandler_ClientOnly, ImageHandler, JpegHandler, SvgHandler, and TransformationalImageHandler.

Referenced by File\generateAndSaveThumb(), and File\transform().

◆ pageCount()

MediaHandler::pageCount ( File $file )

Page count for a multi-page document, false if unsupported or unknown.

Stable to override

Parameters

File $file

Returns: int|false

Reimplemented in DjVuHandler.

Definition at line 376 of file MediaHandler.php.

◆ parseParamString()

MediaHandler::parseParamString ( $str )

abstract

Parse a param string made with makeParamString back into an array.

Parameters

string $str The parameter string without file name (e.g. 122px)

Returns: array|bool Array of parameters or false on failure.

Reimplemented in BitmapHandler, DjVuHandler, ImageHandler, JpegHandler, and SvgHandler.

◆ parserTransformHook()

MediaHandler::parserTransformHook	(		$parser,
			$file )

Modify the parser object post-transform.

This is often used to do $parser->addOutputHook(), in order to add some javascript to render a viewer. See TimedMediaHandler or OggHandler for an example.

Stable to override

Parameters

Parser	$parser
File	$file

Definition at line 709 of file MediaHandler.php.

◆ removeBadFile()

MediaHandler::removeBadFile	(		$dstPath,
			$retval = 0 )

Check for zero-sized thumbnails.

These can be generated when no disk space is available or some other error occurs

Stable to override

Parameters

string	$dstPath	The location of the suspect file
int	$retval	Return value of some shell process, file will be deleted if this is non-zero

Returns: bool True if removed, false otherwise

Definition at line 738 of file MediaHandler.php.

References wfDebugLog().

Referenced by DjVuHandler\doTransform(), TransformationalImageHandler\doTransform(), and SvgHandler\rasterize().

◆ sanitizeParamsForBucketing()

MediaHandler::sanitizeParamsForBucketing ( $params )

Returns a normalised params array for which parameters have been cleaned up for bucketing purposes Stable to override.

Parameters

array $params

Returns: array

Reimplemented in ImageHandler, and JpegHandler.

Definition at line 923 of file MediaHandler.php.

◆ supportsBucketing()

MediaHandler::supportsBucketing ( )

Returns whether or not this handler supports the chained generation of thumbnails according to buckets Stable to override.

Returns: bool

Since: 1.24

Reimplemented in JpegHandler, and PNGHandler.

Definition at line 911 of file MediaHandler.php.

Referenced by File\generateAndSaveThumb().

◆ validateParam()

MediaHandler::validateParam	(		$name,
			$value )

abstract

Validate a thumbnail parameter at parse time.

Return true to accept the parameter, and false to reject it. If you return false, the parser will do something quiet and forgiving.

Parameters

string	$name
mixed	$value

Reimplemented in BitmapHandler, DjVuHandler, ImageHandler, JpegHandler, and SvgHandler.

◆ verifyUpload()

MediaHandler::verifyUpload ( $fileName )

File validation hook called on upload.

If the file at the given local path is not valid, or its MIME type does not match the handler class, a Status object should be returned containing relevant errors.

Stable to override

Parameters

string $fileName The local path to the file.

Returns: Status

Definition at line 724 of file MediaHandler.php.

◆ visibleMetadataFields()

MediaHandler::visibleMetadataFields ( )

protected

Get a list of metadata items which should be displayed when the metadata table is collapsed.

Stable to override

Returns: array Array of strings

Reimplemented in SvgHandler.

Definition at line 573 of file MediaHandler.php.

References FormatMetadata\getVisibleFields().

Referenced by formatMetadataHelper().

Member Data Documentation

◆ MAX_ERR_LOG_SIZE

const MediaHandler::MAX_ERR_LOG_SIZE = 65535

private

Max length of error logged by logErrorForExternalProcess()

Definition at line 45 of file MediaHandler.php.

◆ METADATA_BAD

const MediaHandler::METADATA_BAD = false

Definition at line 40 of file MediaHandler.php.

Referenced by XCFHandler\isMetadataValid(), ExifBitmapHandler\isMetadataValid(), GIFHandler\isMetadataValid(), PNGHandler\isMetadataValid(), SvgHandler\isMetadataValid(), WebPHandler\isMetadataValid(), and LocalFile\maybeUpgradeRow().

◆ METADATA_COMPATIBLE

const MediaHandler::METADATA_COMPATIBLE = 2

Definition at line 41 of file MediaHandler.php.

Referenced by ExifBitmapHandler\isMetadataValid(), GIFHandler\isMetadataValid(), PNGHandler\isMetadataValid(), SvgHandler\isMetadataValid(), WebPHandler\isMetadataValid(), and LocalFile\maybeUpgradeRow().

◆ METADATA_GOOD

const MediaHandler::METADATA_GOOD = true

Definition at line 39 of file MediaHandler.php.

Referenced by XCFHandler\isMetadataValid(), ExifBitmapHandler\isMetadataValid(), GIFHandler\isMetadataValid(), isMetadataValid(), PNGHandler\isMetadataValid(), SvgHandler\isMetadataValid(), and WebPHandler\isMetadataValid().

◆ TRANSFORM_LATER

const MediaHandler::TRANSFORM_LATER = 1

Definition at line 38 of file MediaHandler.php.

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

includes/media/MediaHandler.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addMeta()

◆ canAnimateThumbnail()

◆ canRender()

◆ canRotate()

◆ convertMetadataVersion()

◆ doTransform()

◆ filterThumbnailPurgeList()

◆ fitBoxWidth()

◆ formatMetadata()

◆ formatMetadataHelper()

◆ getAvailableLanguages()

◆ getCommonMetaArray()

◆ getContentHeaders()

◆ getDefaultRenderLanguage()

◆ getDimensionsString()

◆ getEntireText()

◆ getGeneralLongDesc()

◆ getGeneralShortDesc()

◆ getHandler()

◆ getImageSize()

◆ getLength()

◆ getLongDesc()

◆ getMatchedLanguage()

◆ getMetadata()

◆ getMetadataType()

◆ getMetadataVersion()

◆ getPageDimensions()

◆ getPageRangesByDimensions()

◆ getPageText()

◆ getParamMap()

◆ getRotation()

◆ getScriptedTransform()

◆ getShortDesc()

◆ getThumbType()

◆ getTransform()

◆ getWarningConfig()

◆ isAnimatedImage()

◆ isEnabled()

◆ isExpensiveToThumbnail()

◆ isMetadataValid()

◆ isMultiPage()

◆ isVectorized()

◆ logErrorForExternalProcess()

◆ makeParamString()

◆ mustRender()

◆ normaliseParams()

◆ pageCount()

◆ parseParamString()

◆ parserTransformHook()

◆ removeBadFile()

◆ sanitizeParamsForBucketing()

◆ supportsBucketing()

◆ validateParam()

◆ verifyUpload()

◆ visibleMetadataFields()

Member Data Documentation

◆ MAX_ERR_LOG_SIZE

◆ METADATA_BAD

◆ METADATA_COMPATIBLE

◆ METADATA_GOOD

◆ TRANSFORM_LATER