MediaWiki REL1_32
|
Handler for DjVu images. More...
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. | |
getImageSize ( $image, $path) | |
Get an image size array like that returned by getimagesize(), or false if it can't be determined. | |
getMetadata ( $image, $path) | |
Get handler-specific metadata which will be saved in the img_metadata field. | |
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 () | |
getScriptParams ( $params) | |
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. | |
isMetadataValid ( $image, $metadata) | |
Check if the metadata string 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) | |
getDimensionsString ( $file) | |
getImageArea ( $image) | |
Function that returns the number of pixels to be thumbnailed. | |
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. | |
validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType) | |
Validate thumbnail parameters and fill in the correct height. | |
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: | |
formatMetadataHelper ( $metadataArray, $context=false) | |
sorts the visible/invisible field. | |
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. | |
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. | |
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. | |
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. | |
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() | |
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. | |
getDimensionInfo (File $file) | |
getDimensionInfoFromMetaTree ( $metatree) | |
Given an XML metadata tree, returns dimension information about the document. | |
Protected Member Functions inherited from MediaHandler | |
logErrorForExternalProcess ( $retval, $err, $cmd) | |
Log an error that occurred in an external process. | |
visibleMetadataFields () | |
Get a list of metadata items which should be displayed when the metadata table is collapsed. | |
Private Member Functions | |
getUnserializedMetadata (File $file) | |
Get metadata, unserializing it if necessary. | |
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. | |
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. | |
Handler for DjVu images.
Definition at line 29 of file DjVuHandler.php.
DjVuHandler::doTransform | ( | $image, | |
$dstPath, | |||
$dstUrl, | |||
$params, | |||
$flags = 0 ) |
File | $image | |
string | $dstPath | |
string | $dstUrl | |
array | $params | |
int | $flags |
Reimplemented from MediaHandler.
Reimplemented in MockDjVuHandler.
Definition at line 148 of file DjVuHandler.php.
References $image, $params, $retval, $wgDjvuPostProcessor, $wgDjvuRenderer, PoolCounterWork\execute(), function, MediaHandler\logErrorForExternalProcess(), ImageHandler\normaliseParams(), MediaHandler\removeBadFile(), wfDebug(), wfDebugLog(), wfEscapeShellArg(), wfHostname(), wfMessage(), wfMkdirParents(), and wfShellExec().
|
protected |
Extracts metadata and text trees from metadata XML in string form.
string | $metadata | XML metadata as a string |
Definition at line 323 of file DjVuHandler.php.
Referenced by getMetaTree().
|
protected |
Definition at line 404 of file DjVuHandler.php.
References $cache, function, getDimensionInfoFromMetaTree(), and getMetaTree().
Referenced by getPageDimensions(), and pageCount().
|
protected |
Given an XML metadata tree, returns dimension information about the document.
bool | SimpleXMLElement | $metatree | The file's XML metadata tree |
Definition at line 422 of file DjVuHandler.php.
Referenced by getDimensionInfo().
DjVuHandler::getDjVuImage | ( | $image, | |
$path ) |
Cache an instance of DjVuImage in an Image object, return that instance.
Definition at line 242 of file DjVuHandler.php.
References $image.
Referenced by getImageSize(), and getMetadata().
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.
File | FSFile | $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 |
Reimplemented from ImageHandler.
Definition at line 352 of file DjVuHandler.php.
References $image, and getDjVuImage().
DjVuHandler::getMetadata | ( | $image, | |
$path ) |
Get handler-specific metadata which will be saved in the img_metadata field.
File | FSFile | $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 |
Reimplemented from MediaHandler.
Definition at line 367 of file DjVuHandler.php.
References $image, getDjVuImage(), serialize(), and wfDebug().
DjVuHandler::getMetadataType | ( | $image | ) |
Get a string describing the type of metadata, for display purposes.
File | $image |
Reimplemented from MediaHandler.
Definition at line 379 of file DjVuHandler.php.
DjVuHandler::getMetaTree | ( | $image, | |
$gettext = false ) |
Cache a document tree for the DjVu XML metadata.
File | $image | |
bool | $gettext | DOCUMENT (Default: false) |
Definition at line 292 of file DjVuHandler.php.
References $image, extractTreesFromMetadata(), getUnserializedMetadata(), isMetadataValid(), and wfDebug().
Referenced by getDimensionInfo(), and getPageText().
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.
File | $image | |
int | $page | What page to get dimensions of |
Reimplemented from MediaHandler.
Definition at line 393 of file DjVuHandler.php.
References getDimensionInfo().
DjVuHandler::getPageText | ( | File | $image, |
$page ) |
Reimplemented from MediaHandler.
Definition at line 449 of file DjVuHandler.php.
References getMetaTree().
DjVuHandler::getParamMap | ( | ) |
DjVuHandler::getScriptParams | ( | $params | ) |
array | $params |
Reimplemented from ImageHandler.
Definition at line 133 of file DjVuHandler.php.
References $params.
DjVuHandler::getThumbType | ( | $ext, | |
$mime, | |||
$params = null ) |
Get the thumbnail extension and MIME type for a given source MIME type.
string | $ext | Extension of original file |
string | $mime | MIME type of original file |
array | null | $params | Handler specific rendering parameters |
Reimplemented from MediaHandler.
Definition at line 356 of file DjVuHandler.php.
References $mime, and $wgDjvuOutputExtension.
|
private |
Get metadata, unserializing it if necessary.
File | $file | The DjVu file in question |
MWException |
Definition at line 261 of file DjVuHandler.php.
References unserialize().
Referenced by getMetaTree().
DjVuHandler::isEnabled | ( | ) |
Reimplemented from MediaHandler.
Reimplemented in MockDjVuHandler.
Definition at line 35 of file DjVuHandler.php.
References $wgDjvuDump, $wgDjvuRenderer, $wgDjvuToXML, and wfDebug().
DjVuHandler::isExpensiveToThumbnail | ( | $file | ) |
True if creating thumbnails from the file is large or otherwise resource-intensive.
File | $file |
Reimplemented from MediaHandler.
Definition at line 59 of file DjVuHandler.php.
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).
File | $image | |
string | $metadata | The metadata in serialized form |
Reimplemented from MediaHandler.
Definition at line 383 of file DjVuHandler.php.
References serialize().
Referenced by getMetaTree().
DjVuHandler::isMultiPage | ( | $file | ) |
File | $file |
Reimplemented from MediaHandler.
Definition at line 67 of file DjVuHandler.php.
DjVuHandler::makeParamString | ( | $params | ) |
array | $params |
Reimplemented from ImageHandler.
Definition at line 107 of file DjVuHandler.php.
References $params.
DjVuHandler::mustRender | ( | $file | ) |
File | $file |
Reimplemented from MediaHandler.
Definition at line 50 of file DjVuHandler.php.
DjVuHandler::pageCount | ( | File | $file | ) |
Page count for a multi-page document, false if unsupported or unknown.
File | $file |
Reimplemented from MediaHandler.
Definition at line 387 of file DjVuHandler.php.
References getDimensionInfo().
Referenced by MockDjVuHandler\doTransform().
DjVuHandler::parseParamString | ( | $str | ) |
string | $str |
Reimplemented from ImageHandler.
Definition at line 120 of file DjVuHandler.php.
DjVuHandler::validateParam | ( | $name, | |
$value ) |
string | $name | |
mixed | $value |
Reimplemented from ImageHandler.
Definition at line 86 of file DjVuHandler.php.
References $value.
const DjVuHandler::EXPENSIVE_SIZE_LIMIT = 10485760 |
Definition at line 30 of file DjVuHandler.php.