MediaWiki  master
WebPHandler Class Reference

Handler for Google's WebP format https://developers.google.com/speed/webp/ More...

Inheritance diagram for WebPHandler:
Collaboration diagram for WebPHandler:

Public Member Functions

 canAnimateThumbnail ( $file)
 If the material is animated, we can animate the thumbnail. More...
 
 canRender ( $file)
 
 getImageSize ( $file, $path, $metadata=false)
 
 getMetadata ( $image, $filename)
 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...
 
 getThumbType ( $ext, $mime, $params=null)
 Render files as PNG. More...
 
 isAnimatedImage ( $image)
 
 isMetadataValid ( $image, $metadata)
 Check if the metadata string is valid for this handler. More...
 
 mustRender ( $file)
 
- Public Member Functions inherited from BitmapHandler
 autoRotateEnabled ()
 
 canRotate ()
 Returns whether the current scaler supports rotation (im and gd do) More...
 
 makeParamString ( $params)
 Merge a parameter array into a string appropriate for inclusion in filenames.
Parameters
array$paramsArray of parameters that have been through normaliseParams.
Returns
string
Stable for overriding Stable for overriding More...
 
 normaliseParams ( $image, &$params)
 
 parseParamString ( $str)
 Parse a param string made with makeParamString back into an array.
Parameters
string$strThe parameter string without file name (e.g. 122px)
Returns
array|bool Array of parameters or false on failure.
Stable for overriding Stable for overriding More...
 
 rotate ( $file, $params)
 
 validateParam ( $name, $value)
 Validate a thumbnail parameter at parse time.Return true to accept the parameter, and false to reject it. If you return false, the parser will do something quiet and forgiving.
Parameters
string$name
mixed$value
Stable for overriding Stable for overriding More...
 
- Public Member Functions inherited from TransformationalImageHandler
 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 Create a thumbnail. More...
 
 extractPreRotationDimensions ( $params, $rotation)
 Extracts the width/height if the image will be scaled before rotating. More...
 
 getMediaTransformError ( $params, $errMsg)
 Get a MediaTransformError with error 'thumbnail_error'. More...
 
 isImageAreaOkForThumbnaling ( $file, &$params)
 Check if the file is smaller than the maximum image area for thumbnailing. More...
 
- Public Member Functions inherited from ImageHandler
 getDimensionsString ( $file)
 Shown in file history box on image description page.Stable for overriding
Parameters
File$file
Returns
string Dimensions
Stable for overriding More...
 
 getImageArea ( $image)
 Function that returns the number of pixels to be thumbnailed. More...
 
 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|false Follow the format of PHP getimagesize() internal function. See https://www.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.
Stable for overriding More...
 
 getLongDesc ( $file)
 Long description.Shown under image on image description page surounded by ().Stable for overriding
Parameters
File$file
Returns
string
Stable for overriding More...
 
 getParamMap ()
 Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters. Stable for overriding More...
 
 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().Stable for overriding
Parameters
File$image
string$script
array$params
Returns
bool|ThumbnailImage
Stable for overriding More...
 
 getShortDesc ( $file)
 Short description.Shown on Special:Search results.Stable for overriding
Parameters
File$file
Returns
string
Stable for overriding More...
 
 sanitizeParamsForBucketing ( $params)
 Returns a normalised params array for which parameters have been cleaned up for bucketing purposes Stable for overriding.
Parameters
array$params
Returns
array
Stable for overriding More...
 
- Public Member Functions inherited from MediaHandler
 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...
 
 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 Stable for overriding. 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...
 
 getMatchedLanguage ( $userPreferredLanguage, array $availableLanguages)
 When overridden in a descendant class, returns a language code most suiting. 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...
 
 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...
 
 getTransform ( $image, $dstPath, $dstUrl, $params)
 Get a MediaTransformOutput object representing the transformed output. More...
 
 getWarningConfig ( $file)
 Gets configuration for the file warning message. More...
 
 isEnabled ()
 False if the handler is disabled for all files Stable for overriding. More...
 
 isExpensiveToThumbnail ( $file)
 True if creating thumbnails from the file is large or otherwise resource-intensive. More...
 
 isMultiPage ( $file)
 True if the type has multi-page capabilities. More...
 
 isVectorized ( $file)
 The material is vectorized and thus scaling is lossless. More...
 
 pageCount (File $file)
 Page count for a multi-page document, false if unsupported or unknown. 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 Stable for overriding. More...
 
 verifyUpload ( $fileName)
 File validation hook called on upload. More...
 

Static Public Member Functions

static decodeExtendedChunkHeader ( $header)
 Decodes an extended chunk header. More...
 
static decodeLosslessChunkHeader ( $header)
 Decodes a lossless chunk header. More...
 
static extractMetadata ( $filename)
 Extracts the image size and WebP type from a file. More...
 
static extractMetadataFromChunks ( $chunks, $filename)
 Extracts the image size and WebP type from a file based on the chunk list. More...
 
- Static Public Member Functions inherited from BitmapHandler
static imageJpegWrapper ( $dst_image, $thumbPath, $quality=null)
 Callback for transformGd when transforming jpeg images. More...
 
- 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...
 

Protected Member Functions

 getScalerType ( $dstPath, $checkDstPath=true)
 Must use "im" for XCF. More...
 
- Protected Member Functions inherited from BitmapHandler
 imageMagickSubsampling ( $pixelFormat)
 Get ImageMagick subsampling factors for the target JPEG pixel format. More...
 
 transformCustom ( $image, $params)
 Transform an image using a custom command. More...
 
 transformGd ( $image, $params)
 Transform an image using the built in GD library. More...
 
 transformImageMagick ( $image, $params)
 Transform an image using ImageMagick. More...
 
 transformImageMagickExt ( $image, $params)
 Transform an image using the Imagick PHP extension. More...
 
- Protected Member Functions inherited from TransformationalImageHandler
 escapeMagickInput ( $path, $scene=false)
 Escape a string for ImageMagick's input filenames. More...
 
 escapeMagickOutput ( $path, $scene=false)
 Escape a string for ImageMagick's output filename. More...
 
 escapeMagickPath ( $path, $scene=false)
 Armour a string against ImageMagick's GetPathComponent(). More...
 
 escapeMagickProperty ( $s)
 Escape a string for ImageMagick's property input (e.g. More...
 
 getClientScalingThumbnailImage ( $image, $scalerParams)
 Get a ThumbnailImage that respresents an image that will be scaled client side. More...
 
 getMagickVersion ()
 Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this value Value is cached for one hour. More...
 
 getThumbnailSource ( $file, $params)
 Get the source file for the transform. More...
 
- Protected Member Functions inherited from ImageHandler
 getScriptParams ( $params)
 Stable for overriding More...
 
- Protected Member Functions inherited from MediaHandler
 formatMetadataHelper ( $metadataArray, $context=false)
 sorts the visible/invisible field. More...
 
 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...
 

Static Protected Member Functions

static decodeLossyChunkHeader ( $header)
 Decodes a lossy chunk header. 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...
 

Private Attributes

const _MW_WEBP_VERSION = 1
 Version of the metadata stored in db records. More...
 
const BROKEN_FILE = '0'
 Value to store in img_metadata if there was an error extracting metadata. More...
 
const MINIMUM_CHUNK_HEADER_LENGTH = 18
 Minimum chunk header size to be able to read all header types. More...
 
const VP8X_ALPHA = 16
 
const VP8X_ANIM = 2
 
const VP8X_EXIF = 8
 
const VP8X_ICC = 32
 
const VP8X_XMP = 4
 

Additional Inherited Members

- Public Attributes inherited from MediaHandler
const METADATA_BAD = false
 
const METADATA_COMPATIBLE = 2
 
const METADATA_GOOD = true
 
const TRANSFORM_LATER = 1
 

Detailed Description

Handler for Google's WebP format https://developers.google.com/speed/webp/

Definition at line 29 of file WebPHandler.php.

Member Function Documentation

◆ canAnimateThumbnail()

WebPHandler::canAnimateThumbnail (   $file)

If the material is animated, we can animate the thumbnail.

Since
1.20

Stable for overriding

Parameters
File$file
Returns
bool If material is not animated, handler may return any value.

Reimplemented from MediaHandler.

Definition at line 287 of file WebPHandler.php.

◆ canRender()

WebPHandler::canRender (   $file)
Parameters
File$file
Returns
bool False if we are unable to render this image

Reimplemented from ImageHandler.

Definition at line 264 of file WebPHandler.php.

References $file.

◆ decodeExtendedChunkHeader()

static WebPHandler::decodeExtendedChunkHeader (   $header)
static

Decodes an extended chunk header.

Parameters
string$headerFirst few bytes of the header, expected to be at least 18 bytes long
Returns
bool|array See WebPHandler::decodeHeader

Definition at line 215 of file WebPHandler.php.

References $header, VP8X_ALPHA, and VP8X_ANIM.

◆ decodeLosslessChunkHeader()

static WebPHandler::decodeLosslessChunkHeader (   $header)
static

Decodes a lossless chunk header.

Parameters
string$headerFirst few bytes of the header, expected to be at least 13 bytes long
Returns
bool|array See WebPHandler::decodeHeader PhanTypeInvalidLeftOperandOfIntegerOp

Definition at line 190 of file WebPHandler.php.

References $header, and wfDebugLog().

◆ decodeLossyChunkHeader()

static WebPHandler::decodeLossyChunkHeader (   $header)
staticprotected

Decodes a lossy chunk header.

Parameters
string$headerFirst few bytes of the header, expected to be at least 18 bytes long
Returns
bool|array See WebPHandler::decodeHeader

Definition at line 163 of file WebPHandler.php.

References $header, and wfDebugLog().

◆ extractMetadata()

static WebPHandler::extractMetadata (   $filename)
static

Extracts the image size and WebP type from a file.

Parameters
string$filename
Returns
array|bool Header data array with entries 'compression', 'width' and 'height', where 'compression' can be 'lossy', 'lossless', 'animated' or 'unknown'. False if file is not a valid WebP file.

Definition at line 97 of file WebPHandler.php.

References extractMetadataFromChunks(), RiffExtractor\findChunksFromFile(), and wfDebugLog().

Referenced by getMetadata().

◆ extractMetadataFromChunks()

static WebPHandler::extractMetadataFromChunks (   $chunks,
  $filename 
)
static

Extracts the image size and WebP type from a file based on the chunk list.

Parameters
array[]$chunksChunks as extracted by RiffExtractor
string$filename
Returns
array Header data array with entries 'compression', 'width' and 'height', where 'compression' can be 'lossy', 'lossless', 'animated' or 'unknown'

Definition at line 128 of file WebPHandler.php.

References wfDebugLog().

Referenced by extractMetadata().

◆ getImageSize()

WebPHandler::getImageSize (   $file,
  $path,
  $metadata = false 
)

Definition at line 234 of file WebPHandler.php.

References $file, $path, getMetadata(), and unserialize().

◆ getMetadata()

WebPHandler::getMetadata (   $image,
  $path 
)

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

Stable for overriding

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 49 of file WebPHandler.php.

References _MW_WEBP_VERSION, BROKEN_FILE, extractMetadata(), and serialize().

Referenced by getImageSize().

◆ getMetadataType()

WebPHandler::getMetadataType (   $image)

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

Stable for overriding

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

Reimplemented from MediaHandler.

Definition at line 59 of file WebPHandler.php.

◆ getScalerType()

WebPHandler::getScalerType (   $dstPath,
  $checkDstPath = true 
)
protected

Must use "im" for XCF.

Parameters
string$dstPath
bool$checkDstPath
Returns
string

Reimplemented from BitmapHandler.

Definition at line 310 of file WebPHandler.php.

◆ getThumbType()

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

Render files as PNG.

Parameters
string$ext
string$mime
array | null$params
Returns
array

Reimplemented from MediaHandler.

Definition at line 299 of file WebPHandler.php.

◆ isAnimatedImage()

WebPHandler::isAnimatedImage (   $image)
Parameters
File$image
Returns
bool

Reimplemented from MediaHandler.

Definition at line 275 of file WebPHandler.php.

References unserialize().

◆ isMetadataValid()

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

Stable for overriding

Parameters
File$image
string$metadataThe metadata in serialized form
Returns
bool|int

Reimplemented from MediaHandler.

Definition at line 63 of file WebPHandler.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, unserialize(), and wfDebug().

◆ mustRender()

WebPHandler::mustRender (   $file)
Parameters
File$file
Returns
bool True, not all browsers support WebP

Reimplemented from TransformationalImageHandler.

Definition at line 256 of file WebPHandler.php.

Member Data Documentation

◆ _MW_WEBP_VERSION

const WebPHandler::_MW_WEBP_VERSION = 1
private

Version of the metadata stored in db records.

Definition at line 41 of file WebPHandler.php.

Referenced by getMetadata().

◆ BROKEN_FILE

const WebPHandler::BROKEN_FILE = '0'
private

Value to store in img_metadata if there was an error extracting metadata.

Definition at line 33 of file WebPHandler.php.

Referenced by getMetadata().

◆ MINIMUM_CHUNK_HEADER_LENGTH

const WebPHandler::MINIMUM_CHUNK_HEADER_LENGTH = 18
private

Minimum chunk header size to be able to read all header types.

Definition at line 37 of file WebPHandler.php.

◆ VP8X_ALPHA

const WebPHandler::VP8X_ALPHA = 16
private

Definition at line 44 of file WebPHandler.php.

Referenced by decodeExtendedChunkHeader().

◆ VP8X_ANIM

const WebPHandler::VP8X_ANIM = 2
private

Definition at line 47 of file WebPHandler.php.

Referenced by decodeExtendedChunkHeader().

◆ VP8X_EXIF

const WebPHandler::VP8X_EXIF = 8
private

Definition at line 45 of file WebPHandler.php.

◆ VP8X_ICC

const WebPHandler::VP8X_ICC = 32
private

Definition at line 43 of file WebPHandler.php.

◆ VP8X_XMP

const WebPHandler::VP8X_XMP = 4
private

Definition at line 46 of file WebPHandler.php.


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