Handler for DjVu images. More...

Inheritance diagram for DjVuHandler:

[legend]

Collaboration diagram for 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.

getMetaTree ( $image, $gettext=false)

Cache a document tree for the DjVu XML 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.

getPageText (File $image, $page)

getParamMap ()

getSizeAndMetadata ( $state, $path)

Get image size information and metadata array.

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

Get the thumbnail extension and MIME type for a given source 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.

isMultiPage ( $file)

makeParamString ( $params)

mustRender ( $file)

pageCount (File $image)

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

parseParamString ( $str)

validateParam ( $name, $value)

Public Member Functions inherited from 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

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.

getLongDesc ( $file)

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

Stability: stable: to override

Parameters

File $file

Returns: string

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: bool|ThumbnailImage

getShortDesc ( $file)

Short description.Shown on Special:Search results.

Stability: stable: to override

Parameters

File $file

Returns: string

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

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

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.

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.

supportsBucketing ()

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

useSplitMetadata ()

If this returns true, LocalFile may split metadata up and store its constituent items separately.

verifyUpload ( $fileName)

File validation hook called on upload.

Protected Member Functions
	extractTreesFromXML ( $xml)
	Extracts metadata and text trees from metadata XML in string form.

	getDimensionInfo (File $file)

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

	getScriptParams ( $params)

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

Private Member Functions
	getDjVuImage ( $state, $path)
	Cache an instance of DjVuImage in a MediaHandlerState object, return that instance.

	getXMLMetadata (File $file)
	Get metadata, unserializing it if necessary.

Private Attributes
const	EXPENSIVE_SIZE_LIMIT = 10485760

const	STATE_DJVU_IMAGE = 'djvuImage'

const	STATE_META_TREE = 'djvuMetaTree'

const	STATE_TEXT_TREE = 'djvuTextTree'

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 DjVu images.

Definition at line 31 of file DjVuHandler.php.

Member Function Documentation

◆ doTransform()

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 MediaHandler.

Definition at line 147 of file DjVuHandler.php.

References $wgDjvuPostProcessor, $wgDjvuRenderer, PoolCounterWork\execute(), MediaHandler\logErrorForExternalProcess(), ImageHandler\normaliseParams(), MediaHandler\removeBadFile(), wfDebug(), wfDebugLog(), wfHostname(), wfMessage(), wfMkdirParents(), and wfShellExec().

◆ extractTreesFromXML()

DjVuHandler::extractTreesFromXML ( $xml )

protected

Extracts metadata and text trees from metadata XML in string form.

Parameters

string $xml XML metadata as a string

Returns: array

Definition at line 312 of file DjVuHandler.php.

References wfDebug().

Referenced by getMetaTree().

◆ getDimensionInfo()

DjVuHandler::getDimensionInfo ( File $file )

protected

Definition at line 391 of file DjVuHandler.php.

References $cache, $file, getDimensionInfoFromMetaTree(), and getMetaTree().

Referenced by getPageDimensions(), and pageCount().

◆ getDimensionInfoFromMetaTree()

DjVuHandler::getDimensionInfoFromMetaTree ( $metatree )

protected

Given an XML metadata tree, returns dimension information about the document.

Parameters

bool | SimpleXMLElement $metatree The file's XML metadata tree

Returns: bool|array

Definition at line 409 of file DjVuHandler.php.

Referenced by getDimensionInfo().

◆ getDjVuImage()

DjVuHandler::getDjVuImage	(	$state,
		$path
	)

private

Cache an instance of DjVuImage in a MediaHandlerState object, return that instance.

Parameters

MediaHandlerState	$state
string	$path

Returns: DjVuImage

Definition at line 242 of file DjVuHandler.php.

References $path.

Referenced by getSizeAndMetadata().

◆ getMetadataType()

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

Reimplemented from MediaHandler.

Definition at line 366 of file DjVuHandler.php.

◆ getMetaTree()

DjVuHandler::getMetaTree	(	$image,
		$gettext = `false`
	)

Cache a document tree for the DjVu XML metadata.

Parameters

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

Returns: bool|SimpleXMLElement

Definition at line 281 of file DjVuHandler.php.

References extractTreesFromXML(), getXMLMetadata(), and wfDebug().

Referenced by getDimensionInfo(), and getPageText().

◆ getPageDimensions()

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|bool

Reimplemented from MediaHandler.

Definition at line 380 of file DjVuHandler.php.

References getDimensionInfo().

◆ getPageText()

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

Parameters

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

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

Reimplemented from MediaHandler.

Definition at line 436 of file DjVuHandler.php.

References getMetaTree().

◆ getParamMap()

DjVuHandler::getParamMap ( )

Returns: array

Reimplemented from ImageHandler.

Definition at line 81 of file DjVuHandler.php.

◆ getScriptParams()

DjVuHandler::getScriptParams ( $params )

protected

Parameters

array $params

Returns: array

Reimplemented from ImageHandler.

Definition at line 132 of file DjVuHandler.php.

◆ getSizeAndMetadata()

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 ImageHandler.

Definition at line 352 of file DjVuHandler.php.

References $path, getDjVuImage(), and wfDebug().

◆ getThumbType()

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 MediaHandler.

Definition at line 341 of file DjVuHandler.php.

References $mime, and $wgDjvuOutputExtension.

◆ getXMLMetadata()

DjVuHandler::getXMLMetadata ( File $file )

private

Get metadata, unserializing it if necessary.

Parameters

File $file The DjVu file in question

Returns: string XML metadata as a string.

Exceptions

MWException

Definition at line 258 of file DjVuHandler.php.

References $file.

Referenced by getMetaTree().

◆ isEnabled()

DjVuHandler::isEnabled ( )

Returns: bool

Reimplemented from MediaHandler.

Definition at line 42 of file DjVuHandler.php.

References $wgDjvuDump, $wgDjvuRenderer, and wfDebug().

◆ isExpensiveToThumbnail()

DjVuHandler::isExpensiveToThumbnail ( $file )

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

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Definition at line 66 of file DjVuHandler.php.

References $file.

◆ isFileMetadataValid()

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 MediaHandler.

Definition at line 370 of file DjVuHandler.php.

References MediaHandler\METADATA_BAD, and MediaHandler\METADATA_GOOD.

◆ isMultiPage()

DjVuHandler::isMultiPage ( $file )

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Definition at line 74 of file DjVuHandler.php.

◆ makeParamString()

DjVuHandler::makeParamString ( $params )

Parameters

array $params

Returns: bool|string

Reimplemented from ImageHandler.

Definition at line 106 of file DjVuHandler.php.

◆ mustRender()

DjVuHandler::mustRender ( $file )

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Definition at line 57 of file DjVuHandler.php.

◆ pageCount()

DjVuHandler::pageCount ( File $file )

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

Stability: stable: to override

Parameters

File $file

Returns: int|false

Reimplemented from MediaHandler.

Definition at line 374 of file DjVuHandler.php.

References getDimensionInfo().

◆ parseParamString()

DjVuHandler::parseParamString ( $str )

Parameters

string $str

Returns: array|bool

Reimplemented from ImageHandler.

Definition at line 119 of file DjVuHandler.php.

◆ validateParam()

DjVuHandler::validateParam	(	$name,
		$value
	)

Parameters

string	$name
mixed	$value

Returns: bool

Reimplemented from ImageHandler.

Definition at line 93 of file DjVuHandler.php.

Member Data Documentation

◆ EXPENSIVE_SIZE_LIMIT

const DjVuHandler::EXPENSIVE_SIZE_LIMIT = 10485760

private

Definition at line 32 of file DjVuHandler.php.

◆ STATE_DJVU_IMAGE

const DjVuHandler::STATE_DJVU_IMAGE = 'djvuImage'

private

Definition at line 35 of file DjVuHandler.php.

◆ STATE_META_TREE

const DjVuHandler::STATE_META_TREE = 'djvuMetaTree'

private

Definition at line 37 of file DjVuHandler.php.

◆ STATE_TEXT_TREE

const DjVuHandler::STATE_TEXT_TREE = 'djvuTextTree'

private

Definition at line 36 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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doTransform()

◆ extractTreesFromXML()

◆ getDimensionInfo()

◆ getDimensionInfoFromMetaTree()

◆ getDjVuImage()

◆ getMetadataType()

◆ getMetaTree()

◆ getPageDimensions()

◆ getPageText()

◆ getParamMap()

◆ getScriptParams()

◆ getSizeAndMetadata()

◆ getThumbType()

◆ getXMLMetadata()

◆ isEnabled()

◆ isExpensiveToThumbnail()

◆ isFileMetadataValid()

◆ isMultiPage()

◆ makeParamString()

◆ mustRender()

◆ pageCount()

◆ parseParamString()

◆ validateParam()

Member Data Documentation

◆ EXPENSIVE_SIZE_LIMIT

◆ STATE_DJVU_IMAGE

◆ STATE_META_TREE

◆ STATE_TEXT_TREE