Handler for DjVu images. More...

Inheritance diagram for DjVuHandler:

Collaboration diagram for DjVuHandler:

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

	getDjVuImage ($image, $path)
	Cache an instance of DjVuImage in an Image object, return that instance. More...

	getImageSize ($image, $path)

	getMetadata ($image, $path)

	getMetadataType ($image)

	getMetaTree ($image, $gettext=false)
	Cache a document tree for the DjVu XML metadata. More...

	getPageDimensions (File $image, $page)

	getPageText (File $image, $page)

	getParamMap ()

	getScriptParams ($params)

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

	isEnabled ()

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

	isMetadataValid ($image, $metadata)

	isMultiPage ($file)

	makeParamString ($params)

	mustRender ($file)

	pageCount (File $image)

	parseParamString ($str)

	validateParam ($name, $value)

Public Member Functions inherited from ImageHandler
	canRender ($file)

	getDimensionsString ($file)

	getImageArea ($image)
	Function that returns the number of pixels to be thumbnailed. More...

	getImageSize ($image, $path)

	getLongDesc ($file)

	getParamMap ()

	getScriptedTransform ($image, $script, $params)

	getScriptParams ($params)

	getShortDesc ($file)

	makeParamString ($params)

	normaliseParams ($image, &$params)

	parseParamString ($str)

	sanitizeParamsForBucketing ($params)

	validateParam ($name, $value)

	validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType)
	Validate thumbnail parameters and fill in the correct height. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	getLongDesc ($file)
	Long description. More...

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

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

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

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

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

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

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

	getShortDesc ($file)
	Short description. More...

	getStreamHeaders ($metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata. More...

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

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

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

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

	isEnabled ()
	False if the handler is disabled for all files. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Attributes
const	EXPENSIVE_SIZE_LIMIT = 10485760

Public Attributes inherited from MediaHandler
const	MAX_ERR_LOG_SIZE = 65535
	Max length of error logged by logErrorForExternalProcess() More...

const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

Protected Member Functions
	getDimensionInfo (File $file)

Protected Member Functions inherited from MediaHandler
	logErrorForExternalProcess ($retval, $err, $cmd)
	Log an error that occurred in an external process. More...

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

Private Member Functions
	getUnserializedMetadata (File $file)
	Get metadata, unserializing it if neccessary. More...

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

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

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

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

static	getMetadataVersion ()
	Get metadata version. More...

static	resetCache ()
	Resets all static caches. More...

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

Static Protected Attributes inherited from MediaHandler
static MediaHandler[]	$handlers = []
	Instance cache with array of MediaHandler. More...

Detailed Description

Handler for DjVu images.

Definition at line 29 of file DjVu.php.

Member Function Documentation

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

Parameters

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

Returns: MediaTransformError|ThumbnailImage|TransformParameterError

Definition at line 148 of file DjVu.php.

References $flags, $image, $page, $params, $retval, $wgDjvuPostProcessor, $wgDjvuRenderer, PoolCounterWork\execute(), global, MediaHandler\logErrorForExternalProcess(), ImageHandler\normaliseParams(), MediaHandler\removeBadFile(), text, use, wfDebug(), wfDebugLog(), wfEscapeShellArg(), wfHostname(), wfMessage(), wfMkdirParents(), and wfShellExec().

DjVuHandler::getDimensionInfo ( File $file )

protected

Definition at line 395 of file DjVu.php.

References $cache, $count, ObjectCache\getMainWANInstance(), getMetaTree(), File\getSha1(), and use.

Referenced by getPageDimensions(), and pageCount().

DjVuHandler::getDjVuImage	(	$image,
		$path
	)

Cache an instance of DjVuImage in an Image object, return that instance.

Parameters

File	$image
string	$path

Returns: DjVuImage

Definition at line 242 of file DjVu.php.

References $image, and $path.

Referenced by getImageSize(), and getMetadata().

DjVuHandler::getImageSize	(	$image,
		$path
	)

Parameters

File	$image
string	$path

Returns: bool|array False on failure

Definition at line 343 of file DjVu.php.

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

DjVuHandler::getMetadata	(	$image,
		$path
	)

Definition at line 358 of file DjVu.php.

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

DjVuHandler::getMetadataType ( $image )

Definition at line 370 of file DjVu.php.

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 292 of file DjVu.php.

References $e, $image, as, getUnserializedMetadata(), isMetadataValid(), and wfDebug().

Referenced by getDimensionInfo(), and getPageText().

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

Definition at line 384 of file DjVu.php.

References $page, and getDimensionInfo().

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.

Definition at line 431 of file DjVu.php.

References $page, and getMetaTree().

DjVuHandler::getParamMap ( )

Returns: array

Definition at line 74 of file DjVu.php.

DjVuHandler::getScriptParams ( $params )

Parameters

array $params

Returns: array

Definition at line 133 of file DjVu.php.

References $params.

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

Definition at line 347 of file DjVu.php.

References $mime, $wgDjvuOutputExtension, global, and MimeMagic\singleton().

DjVuHandler::getUnserializedMetadata ( File $file )

private

Get metadata, unserializing it if neccessary.

Parameters

File $file The DjVu file in question

Returns: string XML metadata as a string.

Exceptions

MWException

Definition at line 261 of file DjVu.php.

References File\getMetadata(), and unserialize().

Referenced by getMetaTree().

DjVuHandler::isEnabled ( )

Returns: bool

Definition at line 35 of file DjVu.php.

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

DjVuHandler::isExpensiveToThumbnail ( $file )

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

Parameters

File $file

Returns: bool

Definition at line 59 of file DjVu.php.

DjVuHandler::isMetadataValid	(	$image,
		$metadata
	)

Definition at line 374 of file DjVu.php.

References serialize().

Referenced by getMetaTree().

DjVuHandler::isMultiPage ( $file )

Parameters

File $file

Returns: bool

Definition at line 67 of file DjVu.php.

DjVuHandler::makeParamString ( $params )

Parameters

array $params

Returns: bool|string

Definition at line 107 of file DjVu.php.

References $page, and $params.

DjVuHandler::mustRender ( $file )

Parameters

File $file

Returns: bool

Definition at line 50 of file DjVu.php.

DjVuHandler::pageCount ( File $image )

Definition at line 378 of file DjVu.php.

References getDimensionInfo().

Referenced by MockDjVuHandler\doTransform().

DjVuHandler::parseParamString ( $str )

Parameters

string $str

Returns: array|bool

Definition at line 120 of file DjVu.php.

DjVuHandler::validateParam	(	$name,
		$value
	)

Parameters

string	$name
mixed	$value

Returns: bool

Definition at line 86 of file DjVu.php.

References $name, and $value.

Member Data Documentation

const DjVuHandler::EXPENSIVE_SIZE_LIMIT = 10485760

Definition at line 30 of file DjVu.php.

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

includes/media/DjVu.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation