Break long lines in media related classes

[lhc/web/wiklou.git] / includes / media / SVG.php

diff --git a/includes/media/SVG.php b/includes/media/SVG.php
index 28083a7..d06acd8 100644 (file)
--- a/includes/media/SVG.php
+++ b/includes/media/SVG.php
@@ -29,10 +29,23 @@
 class SvgHandler extends ImageHandler {
        const SVG_METADATA_VERSION = 2;
 
+       /**
+        * 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:..}}
+        */
+       private static $metaConversion = array(
+               'originalwidth' => 'ImageWidth',
+               'originalheight' => 'ImageLength',
+               'description' => 'ImageDescription',
+               'title' => 'ObjectName',
+       );
+
        function isEnabled() {
                global $wgSVGConverters, $wgSVGConverter;
                if ( !isset( $wgSVGConverters[$wgSVGConverter] ) ) {
                        wfDebug( "\$wgSVGConverter is invalid, disabling SVG rendering.\n" );
+
                        return false;
                } else {
                        return true;
@@ -60,6 +73,7 @@ class SvgHandler extends ImageHandler {
                                return $metadata['animated'];
                        }
                }
+
                return false;
        }
 
@@ -96,6 +110,7 @@ class SvgHandler extends ImageHandler {
                                $params['physicalHeight'] = $wgSVGMaxSize;
                        }
                }
+
                return true;
        }
 
@@ -124,6 +139,7 @@ class SvgHandler extends ImageHandler {
                $metadata = $this->unpackMetadata( $image->getMetadata() );
                if ( isset( $metadata['error'] ) ) { // sanity check
                        $err = wfMessage( 'svg-long-error', $metadata['error']['message'] )->text();
+
                        return new MediaTransformError( 'thumbnail_error', $clientWidth, $clientHeight, $err );
                }
 
@@ -177,7 +193,7 @@ class SvgHandler extends ImageHandler {
                                                wfEscapeShellArg( $srcPath ),
                                                wfEscapeShellArg( $dstPath ) ),
                                        $wgSVGConverters[$wgSVGConverter]
-                               ) . " 2>&1";
+                               );
 
                                $env = array();
                                if ( $lang !== false ) {
@@ -186,16 +202,18 @@ class SvgHandler extends ImageHandler {
 
                                wfProfileIn( 'rsvg' );
                                wfDebug( __METHOD__ . ": $cmd\n" );
-                               $err = wfShellExec( $cmd, $retval, $env );
+                               $err = wfShellExecWithStderr( $cmd, $retval, $env );
                                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 ) );
+                               wfHostname(), $retval, trim( $err ), $cmd ) );
+
                        return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
                }
+
                return true;
        }
 
@@ -227,7 +245,7 @@ class SvgHandler extends ImageHandler {
 
                if ( isset( $metadata['width'] ) && isset( $metadata['height'] ) ) {
                        return array( $metadata['width'], $metadata['height'], 'SVG',
-                                       "width=\"{$metadata['width']}\" height=\"{$metadata['height']}\"" );
+                               "width=\"{$metadata['width']}\" height=\"{$metadata['height']}\"" );
                } else { // error
                        return array( 0, 0, 'SVG', "width=\"0\" height=\"0\"" );
                }
@@ -279,6 +297,7 @@ class SvgHandler extends ImageHandler {
                        );
                        wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
                }
+
                return serialize( $metadata );
        }
 
@@ -306,11 +325,13 @@ class SvgHandler extends ImageHandler {
                        // Old but compatible
                        return self::METADATA_COMPATIBLE;
                }
+
                return self::METADATA_GOOD;
        }
 
        function visibleMetadataFields() {
                $fields = array( 'objectname', 'imagedescription' );
+
                return $fields;
        }
 
@@ -340,22 +361,16 @@ class SvgHandler extends ImageHandler {
                // Sort fields into visible and collapsed
                $visibleFields = $this->visibleMetadataFields();
 
-               // Rename fields to be compatible with exif, so that
-               // the labels for these fields work and reuse existing messages.
-               $conversion = array(
-                       'originalwidth' => 'imagewidth',
-                       'originalheight' => 'imagelength',
-                       'description' => 'imagedescription',
-                       'title' => 'objectname',
-               );
+               $showMeta = false;
                foreach ( $metadata as $name => $value ) {
                        $tag = strtolower( $name );
-                       if ( isset( $conversion[$tag] ) ) {
-                               $tag = $conversion[$tag];
+                       if ( isset( self::$metaConversion[$tag] ) ) {
+                               $tag = strtolower( self::$metaConversion[$tag] );
                        } else {
                                // Do not output other metadata not in list
                                continue;
                        }
+                       $showMeta = true;
                        self::addMeta( $result,
                                in_array( $tag, $visibleFields ) ? 'visible' : 'collapsed',
                                'exif',
@@ -363,9 +378,9 @@ class SvgHandler extends ImageHandler {
                                $value
                        );
                }
-               return $result;
-       }
 
+               return $showMeta ? $result : false;
+       }
 
        /**
         * @param string $name Parameter name
@@ -380,10 +395,13 @@ class SvgHandler extends ImageHandler {
                        // Validate $code
                        if ( !Language::isValidBuiltinCode( $value ) ) {
                                wfDebug( "Invalid user language code\n" );
+
                                return false;
                        }
+
                        return true;
                }
+
                // Only lang, width and height are acceptable keys
                return false;
        }
@@ -401,6 +419,7 @@ class SvgHandler extends ImageHandler {
                if ( !isset( $params['width'] ) ) {
                        return false;
                }
+
                return "$lang{$params['width']}px";
        }
 
@@ -429,4 +448,30 @@ class SvgHandler extends ImageHandler {
                        'lang' => $params['lang'],
                );
        }
+
+       public function getCommonMetaArray( File $file ) {
+               $metadata = $file->getMetadata();
+               if ( !$metadata ) {
+                       return array();
+               }
+               $metadata = $this->unpackMetadata( $metadata );
+               if ( !$metadata || isset( $metadata['error'] ) ) {
+                       return array();
+               }
+               $stdMetadata = array();
+               foreach ( $metadata as $name => $value ) {
+                       $tag = strtolower( $name );
+                       if ( $tag === 'originalwidth' || $tag === 'originalheight' ) {
+                               // Skip these. In the exif metadata stuff, it is assumed these
+                               // are measured in px, which is not the case here.
+                               continue;
+                       }
+                       if ( isset( self::$metaConversion[$tag] ) ) {
+                               $tag = self::$metaConversion[$tag];
+                               $stdMetadata[$tag] = $value;
+                       }
+               }
+
+               return $stdMetadata;
+       }
 }