* The SVGMetadataExtractor now based on XmlReader
[lhc/web/wiklou.git] / includes / media / SVG.php
index 698e10e..6c2d980 100644 (file)
@@ -1,9 +1,19 @@
 <?php
+/**
+ * Handler for SVG images.
+ *
+ * @file
+ * @ingroup Media
+ */
 
 /**
- * @addtogroup 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] ) ) {
@@ -18,12 +28,27 @@ class SvgHandler extends ImageHandler {
                return true;
        }
 
+       function isVectorized( $file ) {
+               return true;
+       }
+
+       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;
+       }
+
        function normaliseParams( $image, &$params ) {
                global $wgSVGMaxSize;
                if ( !parent::normaliseParams( $image, $params ) ) {
                        return false;
                }
-
                # Don't make an image bigger than wgMaxSVGSize
                $params['physicalWidth'] = $params['width'];
                $params['physicalHeight'] = $params['height'];
@@ -37,8 +62,6 @@ class SvgHandler extends ImageHandler {
        }
 
        function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
-               global $wgSVGConverters, $wgSVGConverter, $wgSVGConverterPath;
-
                if ( !$this->normaliseParams( $image, $params ) ) {
                        return new TransformParameterError( $params );
                }
@@ -57,44 +80,142 @@ class SvgHandler extends ImageHandler {
                                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
+       * @returns TRUE/MediaTransformError
+       */
+       public function rasterize( $srcPath, $dstPath, $width, $height ) {
+               global $wgSVGConverters, $wgSVGConverter, $wgSVGConverterPath;
                $err = false;
-               if( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
+               $retval = '';
+               if ( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
                        $cmd = str_replace(
                                array( '$path/', '$width', '$height', '$input', '$output' ),
                                array( $wgSVGConverterPath ? wfEscapeShellArg( "$wgSVGConverterPath/" ) : "",
-                                          intval( $physicalWidth ),
-                                          intval( $physicalHeight ),
+                                          intval( $width ),
+                                          intval( $height ),
                                           wfEscapeShellArg( $srcPath ),
                                           wfEscapeShellArg( $dstPath ) ),
-                               $wgSVGConverters[$wgSVGConverter] ) . " 2>&1";
+                               $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"',
+                       wfDebugLog( 'thumbnail', sprintf( 'thumbnail failed on %s: error %d "%s" from "%s"',
                                        wfHostname(), $retval, trim($err), $cmd ) );
-                       return new MediaTransformError( 'thumbnail_error', $clientWidth, $clientHeight, $err );
-               } else {
-                       return new ThumbnailImage( $image, $dstUrl, $clientWidth, $clientHeight, $dstPath );
+                       return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
                }
+               return true;
        }
 
-       function getImageSize( $image, $path ) {
-               return wfGetSVGsize( $path );
+       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 ) {
+       function getThumbType( $ext, $mime, $params = null ) {
                return array( 'png', 'image/png' );
        }
 
        function getLongDesc( $file ) {
                global $wgLang;
-               return wfMsg( 'svg-long-desc', $file->getWidth(), $file->getHeight(),
+               return wfMsgExt( 'svg-long-desc', 'parseinline',
+                       $wgLang->formatNum( $file->getWidth() ),
+                       $wgLang->formatNum( $file->getHeight() ),
                        $wgLang->formatSize( $file->getSize() ) );
        }
+
+       function getMetadata( $file, $filename ) {
+               $metadata = array();
+               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 ) {
+               $unser = @unserialize( $metadata );
+               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;
+       }
+
+       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();
+               foreach ( $metadata as $name => $value ) {
+                       $tag = strtolower( $name );
+                       self::addMeta( $result,
+                               in_array( $tag, $visibleFields ) ? 'visible' : 'collapsed',
+                               'svg',
+                               $tag,
+                               $value
+                       );
+               }
+               return $result;
+       }
 }