MediaWiki  REL1_31
DjVuHandler Class Reference

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)
 Get an image size array like that returned by getimagesize(), or false if it can't be determined. 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...
 
 getMetaTree ( $image, $gettext=false)
 Cache a document tree for the DjVu XML metadata. 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)
 
 getParamMap ()
 
 getScriptParams ( $params)
 
 getThumbType ( $ext, $mime, $params=null)
 Get the thumbnail extension and MIME type for a given source MIME type. More...
 
 isEnabled ()
 
 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)
 
 makeParamString ( $params)
 
 mustRender ( $file)
 
 pageCount (File $image)
 Page count for a multi-page document, false if unsupported or unknown. More...
 
 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...
 
 getLongDesc ( $file)
 
 getScriptedTransform ( $image, $script, $params)
 
 getShortDesc ( $file)
 
 normaliseParams ( $image, &$params)
 
 sanitizeParamsForBucketing ( $params)
 Returns a normalised params array for which parameters have been cleaned up for bucketing purposes. More...
 
 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...
 
 canRotate ()
 True if the handler can rotate the media. More...
 
 convertMetadataVersion ( $metadata, $version=1)
 Convert metadata version. 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...
 
 getContentHeaders ( $metadata)
 Get useful response headers for GET/HEAD requests for a file with the given metadata. More...
 
 getDefaultRenderLanguage (File $file)
 On file types that support renderings in multiple languages, which language is used by default if unspecified. More...
 
 getEntireText (File $file)
 Get the text of the entire document. More...
 
 getLength ( $file)
 If its an audio file, return the length of the file. 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...
 
 getStreamHeaders ( $metadata)
 
 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...
 
 isVectorized ( $file)
 The material is vectorized and thus scaling is lossless. More...
 
 parserTransformHook ( $parser, $file)
 Modify the parser object post-transform. More...
 
 removeBadFile ( $dstPath, $retval=0)
 Check for zero-sized thumbnails. More...
 
 supportsBucketing ()
 Returns whether or not this handler supports the chained generation of thumbnails according to buckets. 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

 extractTreesFromMetadata ( $metadata)
 Extracts metadata and text trees from metadata XML in string form. More...
 
 getDimensionInfo (File $file)
 
 getDimensionInfoFromMetaTree ( $metatree)
 Given an XML metadata tree, returns dimension information about the document. More...
 
- 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 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. 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...
 

Detailed Description

Handler for DjVu images.

Definition at line 29 of file DjVu.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.

Reimplemented in MockDjVuHandler.

Definition at line 148 of file DjVu.php.

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

◆ extractTreesFromMetadata()

DjVuHandler::extractTreesFromMetadata (   $metadata)
protected

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

Parameters
string$metadataXML metadata as a string
Returns
array

Definition at line 323 of file DjVu.php.

References $e, as, and wfDebug().

Referenced by getMetaTree().

◆ getDimensionInfo()

DjVuHandler::getDimensionInfo ( File  $file)
protected

◆ getDimensionInfoFromMetaTree()

DjVuHandler::getDimensionInfoFromMetaTree (   $metatree)
protected

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

Parameters
bool | SimpleXMLElement$metatreeThe file's XML metadata tree
Returns
bool|array

Definition at line 422 of file DjVu.php.

Referenced by getDimensionInfo().

◆ getDjVuImage()

DjVuHandler::getDjVuImage (   $image,
  $path 
)

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

Parameters
File | FSFile$image
string$path
Returns
DjVuImage

Definition at line 242 of file DjVu.php.

References $image, and $path.

Referenced by getImageSize(), and getMetadata().

◆ getImageSize()

DjVuHandler::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$imageThe image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an FSFile instead of File (!)
string$pathThe filename
Returns
array|bool Follow the format of PHP getimagesize() internal function. See https://secure.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.

Reimplemented from ImageHandler.

Definition at line 352 of file DjVu.php.

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

◆ getMetadata()

DjVuHandler::getMetadata (   $image,
  $path 
)

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

Parameters
File | FSFile$imageThe image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an FSFile instead of File (!)
string$pathThe filename
Returns
string A string of metadata in php serialized form (Run through serialize())

Reimplemented from MediaHandler.

Definition at line 367 of file DjVu.php.

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

◆ getMetadataType()

DjVuHandler::getMetadataType (   $image)

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

Note
This method is currently unused.
Parameters
File$image
Returns
string

Reimplemented from MediaHandler.

Definition at line 379 of file DjVu.php.

◆ getMetaTree()

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

Cache a document tree for the DjVu XML metadata.

Parameters
File$image
bool$gettextDOCUMENT (Default: false)
Returns
bool|SimpleXMLElement

Definition at line 292 of file DjVu.php.

References $image, extractTreesFromMetadata(), getUnserializedMetadata(), isMetadataValid(), 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.

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
File$image
int$pageWhat page to get dimensions of
Returns
array|bool

Reimplemented from MediaHandler.

Definition at line 393 of file DjVu.php.

References getDimensionInfo().

◆ getPageText()

DjVuHandler::getPageText ( File  $image,
  $page 
)
Parameters
File$image
int$pagePage number to get information for
Returns
bool|string Page text or false when no text found.

Reimplemented from MediaHandler.

Definition at line 449 of file DjVu.php.

References getMetaTree().

◆ getParamMap()

DjVuHandler::getParamMap ( )
Returns
array

Reimplemented from ImageHandler.

Definition at line 74 of file DjVu.php.

◆ getScriptParams()

DjVuHandler::getScriptParams (   $params)
Parameters
array$params
Returns
array

Reimplemented from ImageHandler.

Definition at line 133 of file DjVu.php.

References $params.

◆ getThumbType()

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

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

Parameters
string$extExtension of original file
string$mimeMIME type of original file
array$paramsHandler specific rendering parameters
Returns
array Thumbnail extension and MIME type

Reimplemented from MediaHandler.

Definition at line 356 of file DjVu.php.

References $mime, $wgDjvuOutputExtension, MediaWiki\MediaWikiServices\getInstance(), and global.

◆ getUnserializedMetadata()

DjVuHandler::getUnserializedMetadata ( File  $file)
private

Get metadata, unserializing it if neccessary.

Parameters
File$fileThe 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().

◆ isEnabled()

DjVuHandler::isEnabled ( )
Returns
bool

Reimplemented from MediaHandler.

Reimplemented in MockDjVuHandler.

Definition at line 35 of file DjVu.php.

References $wgDjvuDump, $wgDjvuRenderer, $wgDjvuToXML, global, 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 59 of file DjVu.php.

◆ isMetadataValid()

DjVuHandler::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, 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.
Parameters
File$image
string$metadataThe metadata in serialized form
Returns
bool

Reimplemented from MediaHandler.

Definition at line 383 of file DjVu.php.

References serialize().

Referenced by getMetaTree().

◆ isMultiPage()

DjVuHandler::isMultiPage (   $file)
Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 67 of file DjVu.php.

◆ makeParamString()

DjVuHandler::makeParamString (   $params)
Parameters
array$params
Returns
bool|string

Reimplemented from ImageHandler.

Definition at line 107 of file DjVu.php.

References $params.

◆ mustRender()

DjVuHandler::mustRender (   $file)
Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 50 of file DjVu.php.

◆ pageCount()

DjVuHandler::pageCount ( File  $file)

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

Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 387 of file DjVu.php.

References getDimensionInfo().

Referenced by MockDjVuHandler\doTransform().

◆ parseParamString()

DjVuHandler::parseParamString (   $str)
Parameters
string$str
Returns
array|bool

Reimplemented from ImageHandler.

Definition at line 120 of file DjVu.php.

◆ validateParam()

DjVuHandler::validateParam (   $name,
  $value 
)
Parameters
string$name
mixed$value
Returns
bool

Reimplemented from ImageHandler.

Definition at line 86 of file DjVu.php.

References $name, and $value.

Member Data Documentation

◆ EXPENSIVE_SIZE_LIMIT

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: