Handler for images that need to be transformed. More...

Inheritance diagram for TransformationalImageHandler:

[legend]

Collaboration diagram for TransformationalImageHandler:

[legend]

Public Member Functions

autoRotateEnabled ()

Should we automatically rotate an image based on exif.

canRotate ()

Returns whether the current scaler supports rotation.

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

Create a thumbnail.

extractPreRotationDimensions ( $params, $rotation)

Extracts the width/height if the image will be scaled before rotating.

getMediaTransformError ( $params, $errMsg)

Get a MediaTransformError with error 'thumbnail_error'.

isImageAreaOkForThumbnaling ( $file, &$params)

Check if the file is smaller than the maximum image area for thumbnailing.

mustRender ( $file)

Returns whether the file needs to be rendered.

normaliseParams ( $image, &$params)

Stable to override.

rotate ( $file, $params)

Rotate a thumbnail.

Public Member Functions inherited from ImageHandler

canRender ( $file)

True if the handled types can be transformed.Stable to override

Parameters

File $file

Returns: bool

Stable to override

getDimensionsString ( $file)

Shown in file history box on image description page.Stable to override

Parameters

File $file

Returns: string Dimensions

Stable to override

getImageArea ( $image)

Function that returns the number of pixels to be thumbnailed.

getImageSize ( $image, $path)

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.

Stable to override

getLongDesc ( $file)

Long description.Shown under image on image description page surounded by ().Stable to override

Parameters

File $file

Returns: string

Stable to override

getParamMap ()

Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters. Stable to override

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

Stable to override

getShortDesc ( $file)

Short description.Shown on Special:Search results.Stable to override

Parameters

File $file

Returns: string

Stable to override

makeParamString ( $params)

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

Stable to override

parseParamString ( $str)

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.

Stable to override

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

Stable to override

validateParam ( $name, $value)

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

Stable to override

Public Member Functions inherited from MediaHandler

canAnimateThumbnail ( $file)

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

convertMetadataVersion ( $metadata, $version=1)

Convert metadata version.

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.

getEntireText (File $file)

Get the text of the entire document.

getLength ( $file)

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

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.

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.

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.

pageCount (File $file)

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

parserTransformHook ( $parser, $file)

Modify the parser object post-transform.

removeBadFile ( $dstPath, $retval=0)

Check for zero-sized thumbnails.

supportsBucketing ()

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

verifyUpload ( $fileName)

File validation hook called on upload.

Protected Member Functions
	escapeMagickInput ( $path, $scene=false)
	Escape a string for ImageMagick's input filenames.

	escapeMagickOutput ( $path, $scene=false)
	Escape a string for ImageMagick's output filename.

	escapeMagickPath ( $path, $scene=false)
	Armour a string against ImageMagick's GetPathComponent().

	escapeMagickProperty ( $s)
	Escape a string for ImageMagick's property input (e.g.

	getClientScalingThumbnailImage ( $image, $scalerParams)
	Get a ThumbnailImage that respresents an image that will be scaled client side.

	getMagickVersion ()
	Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this value Value is cached for one hour.

	getScalerType ( $dstPath, $checkDstPath=true)
	Returns what sort of scaler type should be used.

	getThumbnailSource ( $file, $params)
	Get the source file for the transform.

	transformCustom ( $image, $params)
	Transform an image using a custom command.

	transformGd ( $image, $params)
	Transform an image using the built in GD library.

	transformImageMagick ( $image, $params)
	Transform an image using ImageMagick.

	transformImageMagickExt ( $image, $params)
	Transform an image using the Imagick PHP extension.

Protected Member Functions inherited from ImageHandler
	getScriptParams ( $params)
	Stable to override

Protected Member Functions inherited from MediaHandler
	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.

Additional Inherited Members
Static Public Member Functions inherited from MediaHandler
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 inherited from MediaHandler
const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

Static Protected Member Functions inherited from MediaHandler
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

Handler for images that need to be transformed.

Stable to extend

Since: 1.24

Definition at line 39 of file TransformationalImageHandler.php.

Member Function Documentation

◆ autoRotateEnabled()

TransformationalImageHandler::autoRotateEnabled ( )

Should we automatically rotate an image based on exif.

Since: 1.24 No longer static Stable to override

See also: $wgEnableAutoRotation

Returns: bool Whether auto rotation is enabled

Reimplemented in BitmapHandler.

Definition at line 565 of file TransformationalImageHandler.php.

◆ canRotate()

TransformationalImageHandler::canRotate ( )

Returns whether the current scaler supports rotation.

Since: 1.24 No longer static Stable to override

Returns: bool

Reimplemented from MediaHandler.

Reimplemented in BitmapHandler.

Definition at line 553 of file TransformationalImageHandler.php.

Referenced by mustRender().

◆ doTransform()

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

Create a thumbnail.

This sets up various parameters, and then calls a helper method based on $this->getScalerType in order to scale the image. Stable to override

Parameters

File	$image
string	$dstPath
string	$dstUrl
array	$params
int	$flags

Returns: MediaTransformError|ThumbnailImage|TransformParameterError

Reimplemented from MediaHandler.

Reimplemented in BitmapHandler_ClientOnly.

Definition at line 111 of file TransformationalImageHandler.php.

References $wgMaxImageArea, getClientScalingThumbnailImage(), getScalerType(), getThumbnailSource(), normaliseParams(), MediaHandler\removeBadFile(), transformCustom(), transformGd(), transformImageMagick(), transformImageMagickExt(), wfDebug(), wfDebugLog(), wfHostname(), wfMessage(), and wfMkdirParents().

◆ escapeMagickInput()

TransformationalImageHandler::escapeMagickInput	(	$path,
		$scene = `false`
	)

protected

Escape a string for ImageMagick's input filenames.

See ExpandFilenames() and GetPathComponent() in magick/utility.c.

This won't work with an initial ~ or @, so input files should be prefixed with the directory name.

Glob character unescaping is broken in ImageMagick before 6.6.1-5, but it's broken in a way that doesn't involve trying to convert every file in a directory, so we're better off escaping and waiting for the bugfix to filter down to users.

Parameters

string	$path	The file path
bool \| string	$scene	The scene specification, or false if there is none

Exceptions

MWException

Returns: string

Definition at line 454 of file TransformationalImageHandler.php.

References $path, and escapeMagickPath().

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

◆ escapeMagickOutput()

TransformationalImageHandler::escapeMagickOutput	(	$path,
		$scene = `false`
	)

protected

Escape a string for ImageMagick's output filename.

See InterpretImageFilename() in magick/image.c.

Parameters

string	$path	The file path
bool \| string	$scene	The scene specification, or false if there is none

Returns: string

Definition at line 474 of file TransformationalImageHandler.php.

References $path, and escapeMagickPath().

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

◆ escapeMagickPath()

TransformationalImageHandler::escapeMagickPath	(	$path,
		$scene = `false`
	)

protected

Armour a string against ImageMagick's GetPathComponent().

This is a helper function for escapeMagickInput() and escapeMagickOutput().

Parameters

string	$path	The file path
bool \| string	$scene	The scene specification, or false if there is none

Exceptions

MWException

Returns: string

Definition at line 489 of file TransformationalImageHandler.php.

References $path, and wfIsWindows().

Referenced by escapeMagickInput(), and escapeMagickOutput().

◆ escapeMagickProperty()

TransformationalImageHandler::escapeMagickProperty ( $s )

protected

Escape a string for ImageMagick's property input (e.g.

-set -comment) See InterpretImageProperties() in magick/property.c

Parameters

string $s

Returns: string

Definition at line 424 of file TransformationalImageHandler.php.

References $s.

Referenced by BitmapHandler\transformImageMagick().

◆ extractPreRotationDimensions()

TransformationalImageHandler::extractPreRotationDimensions	(	$params,
		$rotation
	)

Extracts the width/height if the image will be scaled before rotating.

This will match the physical size/aspect ratio of the original image prior to application of the rotation – so for a portrait image that's stored as raw landscape with 90-degress rotation, the resulting size will be wider than it is tall.

Parameters

array	$params	Parameters as returned by normaliseParams
int	$rotation	The rotation angle that will be applied

Returns: array ($width, $height) array

Definition at line 84 of file TransformationalImageHandler.php.

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

◆ getClientScalingThumbnailImage()

TransformationalImageHandler::getClientScalingThumbnailImage	(	$image,
		$scalerParams
	)

protected

Get a ThumbnailImage that respresents an image that will be scaled client side.

Stable to override

Parameters

File	$image	File associated with this thumbnail
array	$scalerParams	Array with scaler params

Returns: ThumbnailImage

Todo:: FIXME: No rotation support

Definition at line 338 of file TransformationalImageHandler.php.

Referenced by doTransform().

◆ getMagickVersion()

TransformationalImageHandler::getMagickVersion ( )

protected

Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this value Value is cached for one hour.

Returns: string|bool Representing the IM version; false on error

Definition at line 520 of file TransformationalImageHandler.php.

References $cache, $matches, $wgImageMagickConvertCommand, wfDebug(), and wfShellExecWithStderr().

◆ getMediaTransformError()

TransformationalImageHandler::getMediaTransformError	(	$params,
		$errMsg
	)

Get a MediaTransformError with error 'thumbnail_error'.

Parameters

array	$params	Parameter array as passed to the transform* functions
string	$errMsg	Error message

Returns: MediaTransformError

Definition at line 399 of file TransformationalImageHandler.php.

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

◆ getScalerType()

TransformationalImageHandler::getScalerType	(	$dstPath,
		$checkDstPath = `true`
	)

abstractprotected

Returns what sort of scaler type should be used.

Values can be one of client, im, custom, gd, imext, or an array of object, method-name to call that specific method.

If specifying a custom scaler command with [ Obj, method ], the method in question should take 2 parameters, a File object, and a $scalerParams array with various options (See doTransform for what is in $scalerParams). On error it should return a MediaTransformError object. On success it should return false, and simply make sure the thumbnail file is located at $scalerParams['dstPath'].

If there is a problem with the output path, it returns "client" to do client side scaling.

Parameters

string	$dstPath
bool	$checkDstPath	Check that $dstPath is valid

Returns: string|callable One of client, im, custom, gd, imext, or a Callable array.

Reimplemented in BitmapHandler, WebPHandler, and XCFHandler.

Referenced by doTransform().

◆ getThumbnailSource()

TransformationalImageHandler::getThumbnailSource	(	$file,
		$params
	)

protected

Get the source file for the transform.

Parameters

File	$file
array	$params

Returns: array Array with keys width, height and path.

Definition at line 300 of file TransformationalImageHandler.php.

References $file.

Referenced by doTransform().

◆ isImageAreaOkForThumbnaling()

TransformationalImageHandler::isImageAreaOkForThumbnaling	(		$file,
		&	$params
	)

Check if the file is smaller than the maximum image area for thumbnailing.

Runs the 'BitmapHandlerCheckImageArea' hook.

Stable to override

Parameters

File	$file
array	&$params

Returns: bool

Since: 1.25

Definition at line 609 of file TransformationalImageHandler.php.

References $file, and $wgMaxImageArea.

◆ mustRender()

TransformationalImageHandler::mustRender ( $file )

Returns whether the file needs to be rendered.

Returns true if the file requires rotation and we are able to rotate it.

Stable to override

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Reimplemented in BmpHandler, TiffHandler, WebPHandler, and XCFHandler.

Definition at line 594 of file TransformationalImageHandler.php.

References $file, canRotate(), and MediaHandler\getRotation().

◆ normaliseParams()

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

Stable to override.

Parameters

File	$image
array	&$params	Transform parameters. Entries with the keys 'width' and 'height' are the respective screen width and height, while the keys 'physicalWidth' and 'physicalHeight' indicate the thumbnail dimensions.