Base media handler class. More...

Inheritance diagram for MediaHandler:

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.
	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)
	Get an array structure that looks like this:
	formatMetadataHelper ($metadataArray)
	sorts the visible/invisible field.
	getDimensionsString ($file)
	Shown in file history box on image description page.
	getImageSize ($image, $path)
	Get an image size array like that returned by getimagesize(), or false if it can't be determined.
	getLongDesc ($file)
	Short description.
	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 ($image, $page)
	Get an associative array of page dimensions Currently "width" and "height" are understood, but this might be expanded in the future.
	getPageText ($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)
	Used instead of getLongDesc if there is no handler registered for file.
	getStreamHeaders ($metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata.
	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.
	isAnimatedImage ($file)
	The material is an image, and is animated.
	isEnabled ()
	False if the handler is disabled for all files.
	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)
	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.
	validateParam ($name, $value)
	Validate a thumbnail parameter at parse time.
	verifyUpload ($fileName)
	File validation hook called on upload.
	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed.
Static Public Member Functions
static	canRotate ()
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 getShortDesc if there is no handler registered for file.
static	getGeneralShortDesc ($file)
	Long description.
static	getHandler ($type)
	Get a MediaHandler for a given MIME type from the instance cache.
static	getMetadataVersion ()
	Get metadata version.
Public Attributes
const	METADATA_BAD = false
const	METADATA_COMPATIBLE = 2
const	METADATA_GOOD = true
const	TRANSFORM_LATER = 1
Static Public Attributes
static	$handlers = array()
	Instance cache.
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.

Detailed Description

Base media handler class.

Definition at line 29 of file MediaHandler.php.

Member Function Documentation

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

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.
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 474 of file MediaHandler.php.

References $name, $value, array(), wfDebug(), wfEscapeWikiText(), and wfMessage().

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

MediaHandler::canAnimateThumbnail ( $ file )

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

Since:: 1.20

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

Reimplemented in GIFHandler, and PNGHandler.

Definition at line 321 of file MediaHandler.php.

MediaHandler::canRender ( $ file )

True if the handled types can be transformed.

Returns:: bool

Reimplemented in TiffHandler, and ImageHandler.

Definition at line 269 of file MediaHandler.php.

static MediaHandler::canRotate ( ) [static]

Reimplemented in BitmapHandler.

Definition at line 645 of file MediaHandler.php.

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.

Parameters:

$metadata	Mixed String or Array metadata array (serialized if string)
$version	Integer target version

Returns:: Array serialized metadata in specified version, or $metadata on fail.

Reimplemented in ExifBitmapHandler.

Definition at line 156 of file MediaHandler.php.

References $ret, wfRestoreWarnings(), and wfSuppressWarnings().

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.

Parameters:

	$image	File: the image object
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()
	$flags	Integer: a bitfield, may contain self::TRANSFORM_LATER

Returns:: MediaTransformOutput

Reimplemented in DjVuHandler, BitmapHandler, SvgHandler, BitmapHandler_ClientOnly, MockSvgHandler, and MockBitmapHandler.

Referenced by getTransform().

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

Parameters:

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

Definition at line 636 of file MediaHandler.php.

Referenced by ForeignAPIFile\purgeThumbnails().

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:

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

Returns:: Integer.

Definition at line 548 of file MediaHandler.php.

Referenced by ImageHandler\normaliseParams(), and MediaHandlerTest\testFitBoxWidth().

MediaHandler::formatMetadata ( $ image )

Get an array structure that looks like this:

array( 'visible' => array( 'Human-readable name' => 'Human readable value', ... ), 'collapsed' => array( '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: I don't really like this interface, it's not very flexible I think 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.

Returns:: bool

Reimplemented in SvgHandler, ExifBitmapHandler, PNGHandler, and GIFHandler.

Definition at line 397 of file MediaHandler.php.

MediaHandler::formatMetadataHelper ( $ metadataArray )

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

Parameters:

array $metadataArray metadata array

Returns:: array for use displaying metadata.

Definition at line 410 of file MediaHandler.php.

References $name, $result, $value, addMeta(), array(), as, FormatMetadata\getFormattedData(), and visibleMetadataFields().

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

MediaHandler::getDimensionsString ( $ file )

Shown in file history box on image description page.

Parameters:

File $file

Returns:: String Dimensions

Reimplemented in ImageHandler.

Definition at line 564 of file MediaHandler.php.

static MediaHandler::getGeneralLongDesc ( $ file ) [static]

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

Parameters:

$file File

Returns:: string

Definition at line 534 of file MediaHandler.php.

References $file, $wgLang, global, and wfMessage().

static MediaHandler::getGeneralShortDesc ( $ file ) [static]

Long description.

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

Parameters:

$file File

Returns:: string

Definition at line 523 of file MediaHandler.php.

References $file, $wgLang, and global.

static MediaHandler::getHandler ( $ type ) [static]

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

Parameters:

$type string

Returns:: MediaHandler

Definition at line 46 of file MediaHandler.php.

References global, isEnabled(), and wfDebug().

Referenced by FSFile\getProps(), and UploadBase\verifyFile().

MediaHandler::getImageSize	(	$	image,
		$	path
	)		`[abstract]`

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

Parameters:

	$image	File: the image object, or false if there isn't one
string	$path	the filename

Returns:: Array Follow the format of PHP getimagesize() internal function. See http://www.php.net/getimagesize

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

Referenced by getPageDimensions().

MediaHandler::getLongDesc ( $ file )

Short description.

Shown on Special:Search results.

Parameters:

$file File

Returns:: string

Reimplemented in SvgHandler, ImageHandler, GIFHandler, and PNGHandler.

Definition at line 511 of file MediaHandler.php.

References $file, $wgLang, global, and wfMessage().

MediaHandler::getMetadata	(	$	image,
		$	path
	)

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

Parameters:

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

Returns:: String

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

Definition at line 121 of file MediaHandler.php.

Referenced by ExifBitmapHandler\getImageSize().

MediaHandler::getMetadataType ( $ image )

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

Returns:: string

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

Definition at line 173 of file MediaHandler.php.

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 ForiegnApiRepo 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'.

Returns:: string version string

Definition at line 140 of file MediaHandler.php.

References wfRunHooks().

Referenced by ForeignAPIFile\newFromTitle().

MediaHandler::getPageDimensions	(	$	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.

Parameters:

$image	File
$page	What page to get dimensions of

Returns:: array|bool

Reimplemented in DjVuHandler.

Definition at line 349 of file MediaHandler.php.

References array(), and getImageSize().

MediaHandler::getPageText	(	$	image,
		$	page
	)

Generic getter for text layer.

Currently overloaded by PDF and DjVu handlers

Returns:: bool

Reimplemented in DjVuHandler.

Definition at line 366 of file MediaHandler.php.

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 SvgHandler, DjVuHandler, and ImageHandler.

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.

Parameters:

$file File

Returns:: int 0, 90, 180 or 270

Reimplemented in ExifBitmapHandler.

Definition at line 663 of file MediaHandler.php.

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

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().

Returns:: bool

Reimplemented in ImageHandler.

Definition at line 199 of file MediaHandler.php.

MediaHandler::getShortDesc ( $ file )

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

Parameters:

$file File

Returns:: string

Reimplemented in ImageHandler.

Definition at line 500 of file MediaHandler.php.

References $file, $wgLang, and global.

MediaHandler::getStreamHeaders ( $ metadata )

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

Parameters:

$metadata mixed Result of the getMetadata() function of this handler for a file

Returns:: Array

Definition at line 261 of file MediaHandler.php.

References array().

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

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

Parameters:

String	$ext	Extension of original file
String	$mime	Mime type of original file
Array	$params	Handler specific rendering parameters

Returns:: array thumbnail extension and MIME type

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

Definition at line 240 of file MediaHandler.php.

References $ext, $extensions, $mime, array(), false, and MimeMagic\singleton().

MediaHandler::getTransform	(	$	image,
		$	dstPath,
		$	dstUrl,
		$	params
	)		`[final]`

Get a MediaTransformOutput object representing the transformed output.

Does not actually do the transform.

Parameters:

	$image	File: the image object
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 213 of file MediaHandler.php.

References $params, and doTransform().

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

Returns:: bool

Reimplemented in GIFHandler, PNGHandler, and SvgHandler.

Definition at line 312 of file MediaHandler.php.

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

MediaHandler::isEnabled ( )

False if the handler is disabled for all files.

Returns:: bool

Reimplemented in DjVuHandler, and SvgHandler.

Definition at line 329 of file MediaHandler.php.

Referenced by getHandler().

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, MediaHanlder::METADATA_COMPATIBLE if metadata is old but backwards compatible (which may or may not trigger a metadata reload).

Returns:: bool

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

Definition at line 186 of file MediaHandler.php.

References METADATA_GOOD.

MediaHandler::isMultiPage ( $ file )

True if the type has multi-page capabilities.

Returns:: bool

Reimplemented in DjVuHandler.

Definition at line 286 of file MediaHandler.php.

MediaHandler::isVectorized ( $ file )

The material is vectorized and thus scaling is lossless.

Returns:: bool

Reimplemented in SvgHandler.

Definition at line 302 of file MediaHandler.php.

MediaHandler::makeParamString ( $ params ) [abstract]

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

Parameters:

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

Returns:: String

Reimplemented in SvgHandler, DjVuHandler, and ImageHandler.

MediaHandler::mustRender ( $ file )

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

Returns:: bool

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

Definition at line 278 of file MediaHandler.php.

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:

$image
$params

Reimplemented in ImageHandler, SvgHandler, BitmapHandler_ClientOnly, and BitmapHandler.

MediaHandler::pageCount ( $ file )

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

Returns:: bool

Reimplemented in DjVuHandler.

Definition at line 294 of file MediaHandler.php.

MediaHandler::parseParamString ( $ str ) [abstract]

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

Parameters:

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

Returns:: Array|Boolean Array of parameters or false on failure.

Reimplemented in SvgHandler, DjVuHandler, and ImageHandler.

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.

Parameters:

Parser	$parser
File	$file

Definition at line 578 of file MediaHandler.php.

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

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 602 of file MediaHandler.php.

References $result, $retval, and wfDebugLog().

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

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:

$name
$value

Reimplemented in SvgHandler, DjVuHandler, and ImageHandler.

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.

Parameters:

string $fileName The local path to the file.