MediaWiki  master
SvgHandler Class Reference

Handler for SVG images. More...

Inheritance diagram for SvgHandler:
Collaboration diagram for SvgHandler:

Public Member Functions

 canAnimateThumbnail ( $file)
 We do not support making animated svg thumbnails. More...
 
 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 
 formatMetadata ( $file, $context=false)
 
 getAvailableLanguages (File $file)
 Which languages (systemLanguage attribute) is supported. More...
 
 getCommonMetaArray (File $file)
 Get an array of standard (FormatMetadata type) metadata values. More...
 
 getDefaultRenderLanguage (File $file)
 What language to render file in if none selected. More...
 
 getImageSize ( $file, $path, $metadata=false)
 
 getLongDesc ( $file)
 Subtitle for the image. More...
 
 getMatchedLanguage ( $userPreferredLanguage, array $svgLanguages)
 SVG's systemLanguage matching rules state: 'The systemLanguage attribute ... More...
 
 getMetadata ( $file, $filename)
 
 getMetadataType ( $image)
 Get a string describing the type of metadata, for display purposes. More...
 
 getParamMap ()
 Get an associative array mapping magic word IDs to parameter names. More...
 
 getThumbType ( $ext, $mime, $params=null)
 Get the thumbnail extension and MIME type for a given source MIME type. More...
 
 isAnimatedImage ( $file)
 
 isEnabled ()
 False if the handler is disabled for all files. More...
 
 isMetadataValid ( $image, $metadata)
 Check if the metadata string is valid for this handler. More...
 
 isVectorized ( $file)
 The material is vectorized and thus scaling is lossless. More...
 
 makeParamString ( $params)
 
 mustRender ( $file)
 True if handled types cannot be displayed directly in a browser but can be rendered. More...
 
 normaliseParams ( $image, &$params)
 
 parseParamString ( $str)
 Parse a param string made with makeParamString back into an array. More...
 
 rasterize ( $srcPath, $dstPath, $width, $height, $lang=false)
 Transform an SVG file to PNG This function can be called outside of thumbnail contexts. More...
 
 unpackMetadata ( $metadata)
 
 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)
 Get an image size array like that returned by getimagesize(), or false if it can't be determined. More...
 
 getScriptedTransform ( $image, $script, $params)
 
 getShortDesc ( $file)
 
 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
 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...
 
 formatMetadataHelper ( $metadataArray, $context=false)
 sorts the visible/invisible field. More...
 
 getContentHeaders ( $metadata)
 Get useful response headers for GET/HEAD requests for a file with the given metadata. 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...
 
 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...
 
 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...
 
 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. More...
 
 verifyUpload ( $fileName)
 File validation hook called on upload. More...
 

Static Public Member Functions

static rasterizeImagickExt ( $srcPath, $dstPath, $width, $height)
 
- 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...
 

Public Attributes

const SVG_METADATA_VERSION = 2
 
- 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

 getLanguageFromParams (array $params)
 Determines render language from image parameters. More...
 
 getScriptParams ( $params)
 
 normaliseParamsInternal ( $image, $params)
 Code taken out of normaliseParams() for testability. More...
 
 visibleMetadataFields ()
 Get a list of metadata items which should be displayed when the metadata table is collapsed. More...
 
- Protected Member Functions inherited from MediaHandler
 logErrorForExternalProcess ( $retval, $err, $cmd)
 Log an error that occurred in an external process. More...
 

Static Private Attributes

static array $metaConversion
 A list of metadata tags that can be converted to the commonly used exif tags. More...
 

Additional Inherited Members

- 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 SVG images.

Definition at line 33 of file SvgHandler.php.

Member Function Documentation

◆ canAnimateThumbnail()

SvgHandler::canAnimateThumbnail (   $file)

We do not support making animated svg thumbnails.

Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 167 of file SvgHandler.php.

◆ doTransform()

SvgHandler::doTransform (   $image,
  $dstPath,
  $dstUrl,
  $params,
  $flags = 0 
)
Parameters
File$image
string$dstPath
string$dstUrl
array$params
int$flags
Returns
bool|MediaTransformError|ThumbnailImage|TransformParameterError

Reimplemented from MediaHandler.

Definition at line 228 of file SvgHandler.php.

References $lang, getLanguageFromParams(), normaliseParams(), rasterize(), unpackMetadata(), wfDebugLog(), wfHostname(), wfMessage(), wfMkdirParents(), wfRandomString(), and wfTempDir().

◆ formatMetadata()

SvgHandler::formatMetadata (   $file,
  $context = false 
)
Parameters
File$file
bool | IContextSource$contextContext to use (optional)
Returns
array|bool

Reimplemented from MediaHandler.

Definition at line 497 of file SvgHandler.php.

References $file, MediaHandler\addMeta(), unpackMetadata(), and visibleMetadataFields().

◆ getAvailableLanguages()

SvgHandler::getAvailableLanguages ( File  $file)

Which languages (systemLanguage attribute) is supported.

Note
This list is not guaranteed to be exhaustive. To avoid OOM errors, we only look at first bit of a file. Thus all languages on this list are present in the file, but its possible for the file to have a language not on this list.
Parameters
File$file
Returns
array Array of language codes, or empty if no language switching supported.

Reimplemented from MediaHandler.

Definition at line 95 of file SvgHandler.php.

References $file, $lang, SVGReader\LANG_FULL_MATCH, and unpackMetadata().

◆ getCommonMetaArray()

SvgHandler::getCommonMetaArray ( File  $file)

Get an array of standard (FormatMetadata type) metadata values.

The returned data is largely the same as that from getMetadata(), but formatted in a standard, stable, handler-independent way. The idea being that some values like ImageDescription or Artist are universal and should be retrievable in a handler generic way.

The specific properties are the type of properties that can be handled by the FormatMetadata class. These values are exposed to the user via the filemetadata parser function.

Details of the response format of this function can be found at https://www.mediawiki.org/wiki/Manual:File_metadata_handling tl/dr: the response is an associative array of properties keyed by name, but the value can be complex. You probably want to call one of the FormatMetadata::flatten* functions on the property values before using them, or call FormatMetadata::getFormattedData() on the full response array, which transforms all values into prettified, human-readable text.

Subclasses overriding this function must return a value which is a valid API response fragment (all associative array keys are valid XML tagnames).

Note, if the file simply has no metadata, but the handler supports this interface, it should return an empty array, not false.

Parameters
File$file
Returns
array|bool False if interface not supported
Since
1.23

Reimplemented from MediaHandler.

Definition at line 610 of file SvgHandler.php.

References $file, and unpackMetadata().

◆ getDefaultRenderLanguage()

SvgHandler::getDefaultRenderLanguage ( File  $file)

What language to render file in if none selected.

Parameters
File$fileLanguage code
Returns
string

Reimplemented from MediaHandler.

Definition at line 158 of file SvgHandler.php.

◆ getImageSize()

SvgHandler::getImageSize (   $file,
  $path,
  $metadata = false 
)
Parameters
File | FSFile$file
string$pathUnused
bool | array$metadata
Returns
array|false

Definition at line 387 of file SvgHandler.php.

References $file, and unpackMetadata().

◆ getLanguageFromParams()

SvgHandler::getLanguageFromParams ( array  $params)
protected

Determines render language from image parameters.

Parameters
array$params
Returns
string

Definition at line 148 of file SvgHandler.php.

Referenced by doTransform(), and makeParamString().

◆ getLongDesc()

SvgHandler::getLongDesc (   $file)

Subtitle for the image.

Different from the base class so it can be denoted that SVG's have a "nominal" resolution, and not a fixed one, as well as so animation can be denoted.

Parameters
File$file
Returns
string

Reimplemented from ImageHandler.

Definition at line 414 of file SvgHandler.php.

References $file, $wgLang, isAnimatedImage(), unpackMetadata(), and wfMessage().

◆ getMatchedLanguage()

SvgHandler::getMatchedLanguage (   $userPreferredLanguage,
array  $svgLanguages 
)

SVG's systemLanguage matching rules state: 'The systemLanguage attribute ...

[e]valuates to "true" if one of the languages indicated by user preferences exactly equals one of the languages given in the value of this parameter, or if one of the languages indicated by user preferences exactly equals a prefix of one of the languages given in the value of this parameter such that the first tag character following the prefix is "-".'

Return the first element of $svgLanguages that matches $userPreferredLanguage

See also
https://www.w3.org/TR/SVG/struct.html#SystemLanguageAttribute
Parameters
string$userPreferredLanguage
array$svgLanguages
Returns
string|null

Reimplemented from MediaHandler.

Definition at line 126 of file SvgHandler.php.

◆ getMetadata()

SvgHandler::getMetadata (   $file,
  $filename 
)
Parameters
File | FSFile$file
string$filename
Returns
string Serialised metadata

Reimplemented from MediaHandler.

Definition at line 440 of file SvgHandler.php.

References serialize(), SVG_METADATA_VERSION, and wfDebug().

◆ getMetadataType()

SvgHandler::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 469 of file SvgHandler.php.

◆ getParamMap()

SvgHandler::getParamMap ( )

Get an associative array mapping magic word IDs to parameter names.

Will be used by the parser to identify parameters.

Reimplemented from ImageHandler.

Definition at line 593 of file SvgHandler.php.

◆ getScriptParams()

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

Reimplemented from ImageHandler.

Definition at line 601 of file SvgHandler.php.

◆ getThumbType()

SvgHandler::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 | null$paramsHandler specific rendering parameters
Returns
array Thumbnail extension and MIME type

Reimplemented from MediaHandler.

Definition at line 401 of file SvgHandler.php.

◆ isAnimatedImage()

SvgHandler::isAnimatedImage (   $file)
Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 70 of file SvgHandler.php.

References $file, and unpackMetadata().

Referenced by getLongDesc().

◆ isEnabled()

SvgHandler::isEnabled ( )

False if the handler is disabled for all files.

Returns
bool

Reimplemented from MediaHandler.

Definition at line 47 of file SvgHandler.php.

References $wgSVGConverter, $wgSVGConverters, and wfDebug().

◆ isMetadataValid()

SvgHandler::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|int

Reimplemented from MediaHandler.

Definition at line 473 of file SvgHandler.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, and unpackMetadata().

◆ isVectorized()

SvgHandler::isVectorized (   $file)

The material is vectorized and thus scaling is lossless.

Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 62 of file SvgHandler.php.

◆ makeParamString()

SvgHandler::makeParamString (   $params)
Parameters
array$paramsName=>value pairs of parameters
Returns
string Filename to use

Reimplemented from ImageHandler.

Definition at line 569 of file SvgHandler.php.

References $lang, and getLanguageFromParams().

◆ mustRender()

SvgHandler::mustRender (   $file)

True if handled types cannot be displayed directly in a browser but can be rendered.

Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 58 of file SvgHandler.php.

◆ normaliseParams()

SvgHandler::normaliseParams (   $image,
$params 
)
Parameters
File$image
array&$params
Returns
bool

Reimplemented from ImageHandler.

Definition at line 176 of file SvgHandler.php.

References normaliseParamsInternal().

Referenced by doTransform().

◆ normaliseParamsInternal()

SvgHandler::normaliseParamsInternal (   $image,
  $params 
)
protected

Code taken out of normaliseParams() for testability.

Since
1.33
Parameters
File$image
array$params
Returns
array Modified $params

Definition at line 194 of file SvgHandler.php.

References $wgSVGMaxSize, and File\scaleHeight().

Referenced by normaliseParams().

◆ parseParamString()

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

Reimplemented from ImageHandler.

Definition at line 582 of file SvgHandler.php.

◆ rasterize()

SvgHandler::rasterize (   $srcPath,
  $dstPath,
  $width,
  $height,
  $lang = false 
)

Transform an SVG file to PNG This function can be called outside of thumbnail contexts.

Parameters
string$srcPath
string$dstPath
string$width
string$height
bool | string$langLanguage code of the language to render the SVG in
Exceptions
MWException
Returns
bool|MediaTransformError

Definition at line 318 of file SvgHandler.php.

References $lang, $wgSVGConverter, $wgSVGConverterPath, $wgSVGConverters, MediaHandler\logErrorForExternalProcess(), MediaHandler\removeBadFile(), wfDebug(), and wfShellExecWithStderr().

Referenced by doTransform().

◆ rasterizeImagickExt()

static SvgHandler::rasterizeImagickExt (   $srcPath,
  $dstPath,
  $width,
  $height 
)
static

Definition at line 367 of file SvgHandler.php.

◆ unpackMetadata()

SvgHandler::unpackMetadata (   $metadata)

◆ validateParam()

SvgHandler::validateParam (   $name,
  $value 
)
Parameters
string$nameParameter name
mixed$valueParameter value
Returns
bool Validity

Reimplemented from ImageHandler.

Definition at line 545 of file SvgHandler.php.

◆ visibleMetadataFields()

SvgHandler::visibleMetadataFields ( )
protected

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

Returns
array Array of strings

Reimplemented from MediaHandler.

Definition at line 486 of file SvgHandler.php.

Referenced by formatMetadata().

Member Data Documentation

◆ $metaConversion

array SvgHandler::$metaConversion
staticprivate
Initial value:
= [
'originalwidth' => 'ImageWidth',
'originalheight' => 'ImageLength',
'description' => 'ImageDescription',
'title' => 'ObjectName',
]

A list of metadata tags that can be converted to the commonly used exif tags.

This allows messages to be reused, and consistent tag names for {{#formatmetadata:..}}

Definition at line 40 of file SvgHandler.php.

◆ SVG_METADATA_VERSION

const SvgHandler::SVG_METADATA_VERSION = 2

Definition at line 34 of file SvgHandler.php.

Referenced by getMetadata().


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