Handler for DjVu images. More...

Inherits MediaWiki\Media\ImageHandler.

Collaboration diagram for MediaWiki\Media\DjVuHandler:

[legend]

Public Member Functions

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

getMetadataType ( $image)

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

Stability: stable: to override

Note: This method is currently unused.

Parameters

File $image

Returns: string|false

getMetaTree ( $image, $gettext=false)

Cache a document tree for the DjVu metadata.

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.For a single page document format (!isMultipage()), this should return false.

Note: For non-paged media, use getImageSize.

Stability: stable: to override

Parameters

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

Returns: array{width: int, height: int}|false

getPageText (File $image, $page)

getParamMap ()

getSizeAndMetadata ( $state, $path)

Get image size information and metadata array.If this returns null, the caller will fall back to getImageSize() and getMetadata().If getImageSize() or getMetadata() are implemented in the most derived class, they will be used instead of this function. To override this behaviour, override useLegacyMetadata().

Stability: stable: to override

Since: 1.37

Parameters

MediaHandlerState	$state	An object for saving process-local state. This is normally a File object which will be passed back to other MediaHandler methods like pageCount(), if they are called in the same request. The handler can use this object to save its state.
string	$path	The filename

Returns

array|null Null to fall back to getImageSize(), or an array with the following keys. All keys are optional.

width: The width. If multipage, return the first page width. (optional)
height: The height. If multipage, return the first page height. (optional)
bits: The number of bits for each color (optional)
metadata: A JSON-serializable array of metadata (optional)

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

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

Stability: 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

isEnabled ()

isExpensiveToThumbnail ( $file)

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

isFileMetadataValid ( $image)

Check if the metadata 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.

This was introduced in 1.37 to replace isMetadataValid(), which took a serialized string as a parameter. Handlers overriding this method are expected to use accessors to get the metadata out of the File. The reasons for the change were to get rid of serialization, and to allow handlers to partially load metadata with getMetadataItem(). For example a handler could just validate a version number.

Stability: stable: to override

Since: 1.37

Parameters

File $image

Returns: bool|int

isMultiPage ( $file)

makeParamString ( $params)

mustRender ( $file)

normaliseParams ( $image, &$params)

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

Returns: bool

Stability: stable: to override

Parameters

File	$image
array	&$params

Returns: bool

pageCount (File $image)

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

Stability: stable: to override

Parameters

File $file

Returns: int|false

parseParamString ( $str)

useSplitMetadata ()

If this returns true, LocalFile may split metadata up and store its constituent items separately.This only makes sense if the handler calls File::getMetadataItem() or File::getMetadataItems() instead of requesting the whole array at once.

Returns: bool

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

Returns: bool

Stability: stable: to override

Public Member Functions inherited from MediaWiki\Media\ImageHandler

canRender ( $file)

True if the handled types can be transformed.

Stability: stable: to override

Parameters

File $file

Returns: bool

getDimensionsString ( $file)

Shown in file history box on image description page.

Stability: stable: to override

Parameters

File $file

Returns: string Dimensions (plain text)

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.

Deprecated: since 1.37, override getSizeAndMetadata instead

Parameters

File \| FSFile \| false	$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.

getLongDesc ( $file)

Long description.Shown under image on image description page surrounded by ().Until MediaWiki 1.45, the return value was poorly documented, and some subclasses returned HTML while others returned plain text. When overriding this method, you should return safe HTML, e.g. using Message::escaped(). When calling this method, you should treat it as returning unsafe HTML, and call Sanitizer::removeSomeTags() on the result.

Stability: stable: to override

Parameters

File $file

Returns: string HTML (possibly unsafe, call Sanitizer::removeSomeTags() on the result)

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

Stability: stable: to override

Parameters

File	$image
string	$script
array	$params

Returns: ThumbnailImage|false

getShortDesc ( $file)

Short description.Shown on Special:Search results.Until MediaWiki 1.45, the return value was poorly documented, and some subclasses returned HTML while others returned plain text. When overriding this method, you should return safe HTML, e.g. using Message::escaped(). When calling this method, you should treat it as returning unsafe HTML, and call Sanitizer::removeSomeTags() on the result.

Stability: stable: to override

Parameters

File $file

Returns: string HTML (possibly unsafe, call Sanitizer::removeSomeTags() on the result)

sanitizeParamsForBucketing ( $params)

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

Stability: stable: to override

Parameters

array $params

Returns: array

Public Member Functions inherited from MediaWiki\Media\MediaHandler

canAnimateThumbnail ( $file)

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

canRotate ()

True if the handler can rotate the media.

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.

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.

getLanguage ()

Get the language to be used by this media handler for text formatting.

getLength ( $file)

If it's 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.

getMirrored ( $file)

On supporting image formats, determine if the image is mirrored.

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.

getSizeAndMetadataWithFallback ( $file, $path)

Get the metadata array and the image size, with b/c fallback.

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.

isMetadataValid ( $image, $metadata)

Check if the metadata string is valid for this handler.

isVectorized ( $file)

The material is vectorized and thus scaling is lossless.

parserTransformHook ( $parser, $file)

Modify the parser object post-transform.

removeBadFile ( $dstPath, $retval=0)

Check for zero-sized thumbnails.

setLanguage (Language $lang)

Set the language to be used by this media handler for text formatting.

supportsBucketing ()

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

verifyUpload ( $fileName)

File validation hook called on upload.

Protected Member Functions
	getDimensionInfo (File $file)

	getDimensionInfoFromMetaTree ( $metatree)
	Given the metadata, returns dimension information about the document.

	getScriptParams ( $params)

Protected Member Functions inherited from MediaWiki\Media\ImageHandler
	getSteppedThumbWidth (File $image, int $requestWidth, int $srcWidth, int $srcHeight)
	Adjust the thumbnail size to fit the width steps defined in config via $wgThumbnailSteps.

Protected Member Functions inherited from MediaWiki\Media\MediaHandler
	formatMetadataHelper ( $metadataArray, $context=false)
	sorts the visible/invisible field.

	formatTag (string $key, $vals, $context=false)
	Override default formatting for the given metadata field.

	hasMostDerivedMethod ( $name)
	Check whether a method is implemented in the most derived class.

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

	useLegacyMetadata ()
	If this returns true, the new method getSizeAndMetadata() will not be called.

	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 MediaWiki\Media\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, Language $lang)
	Used instead of getLongDesc if there is no handler registered for file.

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

static	getHandler ( $type, ?Language $lang=null)
	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 MediaWiki\Media\MediaHandler
const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

Static Protected Member Functions inherited from MediaWiki\Media\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 DjVu images.

Definition at line 23 of file DjVuHandler.php.

Member Function Documentation

◆ doTransform()

MediaWiki\Media\DjVuHandler::doTransform	(	$image,
		$dstPath,
		$dstUrl,
		$params,
		$flags = 0 )

Parameters

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

Returns: MediaTransformError|ThumbnailImage|TransformParameterError

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 158 of file DjVuHandler.php.

References MediaWiki\MainConfigNames\DjvuPostProcessor, MediaWiki\MainConfigNames\DjvuRenderer, MediaWiki\PoolCounter\PoolCounterWork\execute(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Media\MediaHandler\logErrorForExternalProcess(), MediaWiki\Media\DjVuHandler\normaliseParams(), MediaWiki\Media\MediaHandler\removeBadFile(), wfDebug(), wfDebugLog(), wfHostname(), wfMessage(), and wfMkdirParents().

◆ getDimensionInfo()

MediaWiki\Media\DjVuHandler::getDimensionInfo ( File $file )

protected

Definition at line 371 of file DjVuHandler.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\FileRepo\File\File\getSha1().

◆ getDimensionInfoFromMetaTree()

MediaWiki\Media\DjVuHandler::getDimensionInfoFromMetaTree ( $metatree )

protected

Given the metadata, returns dimension information about the document.

Parameters

false | array $metatree The file's metadata tree

Returns: array|false

Definition at line 389 of file DjVuHandler.php.

◆ getMetadataType()

MediaWiki\Media\DjVuHandler::getMetadataType ( $image )

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

Stability: stable: to override

Note: This method is currently unused.

Parameters

File $image

Returns: string|false

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 341 of file DjVuHandler.php.

◆ getMetaTree()

MediaWiki\Media\DjVuHandler::getMetaTree	(		$image,
			$gettext = false )

Cache a document tree for the DjVu metadata.

Parameters

File	$image
bool	$gettext	DOCUMENT (Default: false)

Returns: false|array

Definition at line 295 of file DjVuHandler.php.

◆ getPageDimensions()

MediaWiki\Media\DjVuHandler::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.For a single page document format (!isMultipage()), this should return false.

Note: For non-paged media, use getImageSize.

Stability: stable: to override

Parameters

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

Returns: array{width: int, height: int}|false

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 359 of file DjVuHandler.php.

◆ getPageText()

MediaWiki\Media\DjVuHandler::getPageText	(	File	$image,
			$page )

Parameters

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

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

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 419 of file DjVuHandler.php.

◆ getParamMap()

MediaWiki\Media\DjVuHandler::getParamMap ( )

Returns: array

Reimplemented from MediaWiki\Media\ImageHandler.

Definition at line 76 of file DjVuHandler.php.

◆ getScriptParams()

MediaWiki\Media\DjVuHandler::getScriptParams ( $params )

protected

Parameters

array $params

Returns: array

Reimplemented from MediaWiki\Media\ImageHandler.

Definition at line 143 of file DjVuHandler.php.

◆ getSizeAndMetadata()

MediaWiki\Media\DjVuHandler::getSizeAndMetadata	(		$state,
			$path )

Get image size information and metadata array.If this returns null, the caller will fall back to getImageSize() and getMetadata().If getImageSize() or getMetadata() are implemented in the most derived class, they will be used instead of this function. To override this behaviour, override useLegacyMetadata().

Stability: stable: to override

Since: 1.37

Parameters

MediaHandlerState	$state	An object for saving process-local state. This is normally a File object which will be passed back to other MediaHandler methods like pageCount(), if they are called in the same request. The handler can use this object to save its state.
string	$path	The filename

Returns

array|null Null to fall back to getImageSize(), or an array with the following keys. All keys are optional.

width: The width. If multipage, return the first page width. (optional)
height: The height. If multipage, return the first page height. (optional)
bits: The number of bits for each color (optional)
metadata: A JSON-serializable array of metadata (optional)

Reimplemented from MediaWiki\Media\ImageHandler.

Definition at line 328 of file DjVuHandler.php.

References $path, and wfDebug().

◆ getThumbType()

MediaWiki\Media\DjVuHandler::getThumbType	(	$ext,
		$mime,
		$params = null )

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

Stability: 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 from MediaWiki\Media\MediaHandler.

Definition at line 315 of file DjVuHandler.php.

References MediaWiki\MainConfigNames\DjvuOutputExtension, and MediaWiki\MediaWikiServices\getInstance().

◆ isEnabled()

MediaWiki\Media\DjVuHandler::isEnabled ( )

Returns: bool

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 35 of file DjVuHandler.php.

References MediaWiki\MainConfigNames\DjvuDump, MediaWiki\MainConfigNames\DjvuRenderer, MediaWiki\MediaWikiServices\getInstance(), and wfDebug().

◆ isExpensiveToThumbnail()

MediaWiki\Media\DjVuHandler::isExpensiveToThumbnail ( $file )

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

Parameters

File $file

Returns: bool

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 61 of file DjVuHandler.php.

◆ isFileMetadataValid()

MediaWiki\Media\DjVuHandler::isFileMetadataValid ( $image )

Check if the metadata 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.

This was introduced in 1.37 to replace isMetadataValid(), which took a serialized string as a parameter. Handlers overriding this method are expected to use accessors to get the metadata out of the File. The reasons for the change were to get rid of serialization, and to allow handlers to partially load metadata with getMetadataItem(). For example a handler could just validate a version number.

Stability: stable: to override

Since: 1.37

Parameters

File $image

Returns: bool|int

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 347 of file DjVuHandler.php.

◆ isMultiPage()

MediaWiki\Media\DjVuHandler::isMultiPage ( $file )

Parameters

File $file

Returns: bool

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 69 of file DjVuHandler.php.

◆ makeParamString()

MediaWiki\Media\DjVuHandler::makeParamString ( $params )

Parameters

array $params

Returns: string|false

Reimplemented from MediaWiki\Media\ImageHandler.

Definition at line 99 of file DjVuHandler.php.

◆ mustRender()

MediaWiki\Media\DjVuHandler::mustRender ( $file )

Parameters

File $file

Returns: bool

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 52 of file DjVuHandler.php.

◆ normaliseParams()

MediaWiki\Media\DjVuHandler::normaliseParams	(		$image,
		&	$params )

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

Returns: bool

Stability: stable: to override

Parameters

File	$image
array	&$params

Returns: bool

Reimplemented from MediaWiki\Media\ImageHandler.

Definition at line 124 of file DjVuHandler.php.

References MediaWiki\Media\ImageHandler\getSteppedThumbWidth().

Referenced by MediaWiki\Media\DjVuHandler\doTransform().

◆ pageCount()

MediaWiki\Media\DjVuHandler::pageCount ( File $image )

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

Stability: stable: to override

Parameters

File $file

Returns: int|false

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 352 of file DjVuHandler.php.

◆ parseParamString()

MediaWiki\Media\DjVuHandler::parseParamString ( $str )

Parameters

string $str

Returns: array|false

Reimplemented from MediaWiki\Media\ImageHandler.

Definition at line 113 of file DjVuHandler.php.

◆ useSplitMetadata()

MediaWiki\Media\DjVuHandler::useSplitMetadata ( )

If this returns true, LocalFile may split metadata up and store its constituent items separately.This only makes sense if the handler calls File::getMetadataItem() or File::getMetadataItems() instead of requesting the whole array at once.

Returns: bool

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 431 of file DjVuHandler.php.

◆ validateParam()

MediaWiki\Media\DjVuHandler::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

Returns: bool

Stability: stable: to override

Reimplemented from MediaWiki\Media\ImageHandler.

Definition at line 84 of file DjVuHandler.php.

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

includes/Media/DjVuHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doTransform()

◆ getDimensionInfo()

◆ getDimensionInfoFromMetaTree()

◆ getMetadataType()

◆ getMetaTree()

◆ getPageDimensions()

◆ getPageText()

◆ getParamMap()

◆ getScriptParams()

◆ getSizeAndMetadata()

◆ getThumbType()

◆ isEnabled()

◆ isExpensiveToThumbnail()

◆ isFileMetadataValid()

◆ isMultiPage()

◆ makeParamString()

◆ mustRender()

◆ normaliseParams()

◆ pageCount()

◆ parseParamString()

◆ useSplitMetadata()

◆ validateParam()