MediaWiki 1.42.0
DjVuHandler Class Reference

Handler for DjVu images. More...

Inherits ImageHandler.

Collaboration diagram for DjVuHandler:

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 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)
 
 useSplitMetadata ()
 If this returns true, LocalFile may split metadata up and store its constituent items separately.
 
 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 surrounded 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
ThumbnailImage|false

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

 
 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 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.
 
 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.
 
 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 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 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 34 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 150 of file DjVuHandler.php.

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

◆ getDimensionInfo()

DjVuHandler::getDimensionInfo ( File $file)
protected

Definition at line 352 of file DjVuHandler.php.

References getDimensionInfoFromMetaTree(), getMetaTree(), and File\getSha1().

Referenced by getPageDimensions(), and pageCount().

◆ getDimensionInfoFromMetaTree()

DjVuHandler::getDimensionInfoFromMetaTree ( $metatree)
protected

Given the metadata, returns dimension information about the document.

Parameters
false | array$metatreeThe file's metadata tree
Returns
array|false

Definition at line 370 of file DjVuHandler.php.

Referenced by getDimensionInfo().

◆ 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|false

Reimplemented from MediaHandler.

Definition at line 326 of file DjVuHandler.php.

◆ getMetaTree()

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

Cache a document tree for the DjVu metadata.

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

Definition at line 283 of file DjVuHandler.php.

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$pageWhat page to get dimensions of
Returns
array|false

Reimplemented from MediaHandler.

Definition at line 341 of file DjVuHandler.php.

References getDimensionInfo().

◆ getPageText()

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

Reimplemented from MediaHandler.

Definition at line 400 of file DjVuHandler.php.

References getMetaTree().

◆ getParamMap()

DjVuHandler::getParamMap ( )
Returns
array

Reimplemented from ImageHandler.

Definition at line 85 of file DjVuHandler.php.

◆ getScriptParams()

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

Reimplemented from ImageHandler.

Definition at line 135 of file DjVuHandler.php.

References $params.

◆ 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$stateAn 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$pathThe 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 314 of file DjVuHandler.php.

References $path, 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$extExtension of original file
string$mimeMIME type of original file
array | null$paramsHandler specific rendering parameters
Returns
array Thumbnail extension and MIME type

Reimplemented from MediaHandler.

Definition at line 302 of file DjVuHandler.php.

◆ isEnabled()

DjVuHandler::isEnabled ( )
Returns
bool

Reimplemented from MediaHandler.

Definition at line 46 of file DjVuHandler.php.

References 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 70 of file DjVuHandler.php.

◆ 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 331 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 78 of file DjVuHandler.php.

◆ makeParamString()

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

Reimplemented from ImageHandler.

Definition at line 110 of file DjVuHandler.php.

References $params.

◆ mustRender()

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

Reimplemented from MediaHandler.

Definition at line 61 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 335 of file DjVuHandler.php.

References getDimensionInfo().

◆ parseParamString()

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

Reimplemented from ImageHandler.

Definition at line 123 of file DjVuHandler.php.

◆ useSplitMetadata()

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

Definition at line 411 of file DjVuHandler.php.

◆ validateParam()

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

Reimplemented from ImageHandler.

Definition at line 97 of file DjVuHandler.php.


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