31003d22ea
Also made file/class documentation more consistent. Change-Id: I26a320bcddd4122ce423f536609d5794446d743e
313 lines
8.8 KiB
PHP
313 lines
8.8 KiB
PHP
<?php
|
|
/**
|
|
* Handler for SVG images.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Media
|
|
*/
|
|
|
|
/**
|
|
* Handler for SVG images.
|
|
*
|
|
* @ingroup Media
|
|
*/
|
|
class SvgHandler extends ImageHandler {
|
|
const SVG_METADATA_VERSION = 2;
|
|
|
|
function isEnabled() {
|
|
global $wgSVGConverters, $wgSVGConverter;
|
|
if ( !isset( $wgSVGConverters[$wgSVGConverter] ) ) {
|
|
wfDebug( "\$wgSVGConverter is invalid, disabling SVG rendering.\n" );
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
function mustRender( $file ) {
|
|
return true;
|
|
}
|
|
|
|
function isVectorized( $file ) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param $file File
|
|
* @return bool
|
|
*/
|
|
function isAnimatedImage( $file ) {
|
|
# TODO: detect animated SVGs
|
|
$metadata = $file->getMetadata();
|
|
if ( $metadata ) {
|
|
$metadata = $this->unpackMetadata( $metadata );
|
|
if( isset( $metadata['animated'] ) ) {
|
|
return $metadata['animated'];
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param $image File
|
|
* @param $params
|
|
* @return bool
|
|
*/
|
|
function normaliseParams( $image, &$params ) {
|
|
global $wgSVGMaxSize;
|
|
if ( !parent::normaliseParams( $image, $params ) ) {
|
|
return false;
|
|
}
|
|
# Don't make an image bigger than wgMaxSVGSize on the smaller side
|
|
if ( $params['physicalWidth'] <= $params['physicalHeight'] ) {
|
|
if ( $params['physicalWidth'] > $wgSVGMaxSize ) {
|
|
$srcWidth = $image->getWidth( $params['page'] );
|
|
$srcHeight = $image->getHeight( $params['page'] );
|
|
$params['physicalWidth'] = $wgSVGMaxSize;
|
|
$params['physicalHeight'] = File::scaleHeight( $srcWidth, $srcHeight, $wgSVGMaxSize );
|
|
}
|
|
} else {
|
|
if ( $params['physicalHeight'] > $wgSVGMaxSize ) {
|
|
$srcWidth = $image->getWidth( $params['page'] );
|
|
$srcHeight = $image->getHeight( $params['page'] );
|
|
$params['physicalWidth'] = File::scaleHeight( $srcHeight, $srcWidth, $wgSVGMaxSize );
|
|
$params['physicalHeight'] = $wgSVGMaxSize;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param $image File
|
|
* @param $dstPath
|
|
* @param $dstUrl
|
|
* @param $params
|
|
* @param int $flags
|
|
* @return bool|MediaTransformError|ThumbnailImage|TransformParameterError
|
|
*/
|
|
function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
|
|
if ( !$this->normaliseParams( $image, $params ) ) {
|
|
return new TransformParameterError( $params );
|
|
}
|
|
$clientWidth = $params['width'];
|
|
$clientHeight = $params['height'];
|
|
$physicalWidth = $params['physicalWidth'];
|
|
$physicalHeight = $params['physicalHeight'];
|
|
$srcPath = $image->getLocalRefPath();
|
|
|
|
if ( $flags & self::TRANSFORM_LATER ) {
|
|
return new ThumbnailImage( $image, $dstUrl, $clientWidth, $clientHeight, $dstPath );
|
|
}
|
|
|
|
if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__ ) ) {
|
|
return new MediaTransformError( 'thumbnail_error', $clientWidth, $clientHeight,
|
|
wfMsg( 'thumbnail_dest_directory' ) );
|
|
}
|
|
|
|
$status = $this->rasterize( $srcPath, $dstPath, $physicalWidth, $physicalHeight );
|
|
if( $status === true ) {
|
|
return new ThumbnailImage( $image, $dstUrl, $clientWidth, $clientHeight, $dstPath );
|
|
} else {
|
|
return $status; // MediaTransformError
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Transform an SVG file to PNG
|
|
* This function can be called outside of thumbnail contexts
|
|
* @param string $srcPath
|
|
* @param string $dstPath
|
|
* @param string $width
|
|
* @param string $height
|
|
* @return bool|MediaTransformError
|
|
*/
|
|
public function rasterize( $srcPath, $dstPath, $width, $height ) {
|
|
global $wgSVGConverters, $wgSVGConverter, $wgSVGConverterPath;
|
|
$err = false;
|
|
$retval = '';
|
|
if ( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
|
|
if ( is_array( $wgSVGConverters[$wgSVGConverter] ) ) {
|
|
// This is a PHP callable
|
|
$func = $wgSVGConverters[$wgSVGConverter][0];
|
|
$args = array_merge( array( $srcPath, $dstPath, $width, $height ),
|
|
array_slice( $wgSVGConverters[$wgSVGConverter], 1 ) );
|
|
if ( !is_callable( $func ) ) {
|
|
throw new MWException( "$func is not callable" );
|
|
}
|
|
$err = call_user_func_array( $func, $args );
|
|
$retval = (bool)$err;
|
|
} else {
|
|
// External command
|
|
$cmd = str_replace(
|
|
array( '$path/', '$width', '$height', '$input', '$output' ),
|
|
array( $wgSVGConverterPath ? wfEscapeShellArg( "$wgSVGConverterPath/" ) : "",
|
|
intval( $width ),
|
|
intval( $height ),
|
|
wfEscapeShellArg( $srcPath ),
|
|
wfEscapeShellArg( $dstPath ) ),
|
|
$wgSVGConverters[$wgSVGConverter]
|
|
) . " 2>&1";
|
|
wfProfileIn( 'rsvg' );
|
|
wfDebug( __METHOD__.": $cmd\n" );
|
|
$err = wfShellExec( $cmd, $retval );
|
|
wfProfileOut( 'rsvg' );
|
|
}
|
|
}
|
|
$removed = $this->removeBadFile( $dstPath, $retval );
|
|
if ( $retval != 0 || $removed ) {
|
|
wfDebugLog( 'thumbnail', sprintf( 'thumbnail failed on %s: error %d "%s" from "%s"',
|
|
wfHostname(), $retval, trim($err), $cmd ) );
|
|
return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public static function rasterizeImagickExt( $srcPath, $dstPath, $width, $height ) {
|
|
$im = new Imagick( $srcPath );
|
|
$im->setImageFormat( 'png' );
|
|
$im->setBackgroundColor( 'transparent' );
|
|
$im->setImageDepth( 8 );
|
|
|
|
if ( !$im->thumbnailImage( intval( $width ), intval( $height ), /* fit */ false ) ) {
|
|
return 'Could not resize image';
|
|
}
|
|
if ( !$im->writeImage( $dstPath ) ) {
|
|
return "Could not write to $dstPath";
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param $file File
|
|
* @param $path
|
|
* @param bool $metadata
|
|
* @return array
|
|
*/
|
|
function getImageSize( $file, $path, $metadata = false ) {
|
|
if ( $metadata === false ) {
|
|
$metadata = $file->getMetaData();
|
|
}
|
|
$metadata = $this->unpackMetaData( $metadata );
|
|
|
|
if ( isset( $metadata['width'] ) && isset( $metadata['height'] ) ) {
|
|
return array( $metadata['width'], $metadata['height'], 'SVG',
|
|
"width=\"{$metadata['width']}\" height=\"{$metadata['height']}\"" );
|
|
}
|
|
}
|
|
|
|
function getThumbType( $ext, $mime, $params = null ) {
|
|
return array( 'png', 'image/png' );
|
|
}
|
|
|
|
/**
|
|
* @param $file File
|
|
* @return string
|
|
*/
|
|
function getLongDesc( $file ) {
|
|
global $wgLang;
|
|
return wfMsgExt( 'svg-long-desc', 'parseinline',
|
|
$wgLang->formatNum( $file->getWidth() ),
|
|
$wgLang->formatNum( $file->getHeight() ),
|
|
$wgLang->formatSize( $file->getSize() ) );
|
|
}
|
|
|
|
function getMetadata( $file, $filename ) {
|
|
try {
|
|
$metadata = SVGMetadataExtractor::getMetadata( $filename );
|
|
} catch( Exception $e ) {
|
|
// Broken file?
|
|
wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
|
|
return '0';
|
|
}
|
|
$metadata['version'] = self::SVG_METADATA_VERSION;
|
|
return serialize( $metadata );
|
|
}
|
|
|
|
function unpackMetadata( $metadata ) {
|
|
wfSuppressWarnings();
|
|
$unser = unserialize( $metadata );
|
|
wfRestoreWarnings();
|
|
if ( isset( $unser['version'] ) && $unser['version'] == self::SVG_METADATA_VERSION ) {
|
|
return $unser;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
function getMetadataType( $image ) {
|
|
return 'parsed-svg';
|
|
}
|
|
|
|
function isMetadataValid( $image, $metadata ) {
|
|
return $this->unpackMetadata( $metadata ) !== false;
|
|
}
|
|
|
|
function visibleMetadataFields() {
|
|
$fields = array( 'title', 'description', 'animated' );
|
|
return $fields;
|
|
}
|
|
|
|
/**
|
|
* @param $file File
|
|
* @return array|bool
|
|
*/
|
|
function formatMetadata( $file ) {
|
|
$result = array(
|
|
'visible' => array(),
|
|
'collapsed' => array()
|
|
);
|
|
$metadata = $file->getMetadata();
|
|
if ( !$metadata ) {
|
|
return false;
|
|
}
|
|
$metadata = $this->unpackMetadata( $metadata );
|
|
if ( !$metadata ) {
|
|
return false;
|
|
}
|
|
unset( $metadata['version'] );
|
|
unset( $metadata['metadata'] ); /* non-formatted XML */
|
|
|
|
/* TODO: add a formatter
|
|
$format = new FormatSVG( $metadata );
|
|
$formatted = $format->getFormattedData();
|
|
*/
|
|
|
|
// Sort fields into visible and collapsed
|
|
$visibleFields = $this->visibleMetadataFields();
|
|
|
|
// Rename fields to be compatible with exif, so that
|
|
// the labels for these fields work.
|
|
$conversion = array( 'width' => 'imagewidth',
|
|
'height' => 'imagelength',
|
|
'description' => 'imagedescription',
|
|
'title' => 'objectname',
|
|
);
|
|
foreach ( $metadata as $name => $value ) {
|
|
$tag = strtolower( $name );
|
|
if ( isset( $conversion[$tag] ) ) {
|
|
$tag = $conversion[$tag];
|
|
}
|
|
self::addMeta( $result,
|
|
in_array( $tag, $visibleFields ) ? 'visible' : 'collapsed',
|
|
'exif',
|
|
$tag,
|
|
$value
|
|
);
|
|
}
|
|
return $result;
|
|
}
|
|
}
|