includes/resourceloader/ResourceLoaderImage.php

   1 <?php
   2 /**
   3  * Class encapsulating an image used in a ResourceLoaderImageModule.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\Shell\Shell;
  24
  25 /**
  26  * Class encapsulating an image used in a ResourceLoaderImageModule.
  27  *
  28  * @since 1.25
  29  */
  30 class ResourceLoaderImage {
  31
  32         /**
  33          * Map of allowed file extensions to their MIME types.
  34          * @var array
  35          */
  36         protected static $fileTypes = [
  37                 'svg' => 'image/svg+xml',
  38                 'png' => 'image/png',
  39                 'gif' => 'image/gif',
  40                 'jpg' => 'image/jpg',
  41         ];
  42
  43         /** @var string */
  44         private $name;
  45         /** @var string */
  46         private $module;
  47         /** @var string|array */
  48         private $descriptor;
  49         /** @var string */
  50         private $basePath;
  51         /** @var array */
  52         private $variants;
  53         /** @var string|null */
  54         private $defaultColor;
  55         /** @var string */
  56         private $extension;
  57
  58         /**
  59          * @param string $name Image name
  60          * @param string $module Module name
  61          * @param string|array $descriptor Path to image file, or array structure containing paths
  62          * @param string $basePath Directory to which paths in descriptor refer
  63          * @param array $variants
  64          * @param string|null $defaultColor of the base variant
  65          * @throws InvalidArgumentException
  66          */
  67         public function __construct( $name, $module, $descriptor, $basePath, $variants,
  68                 $defaultColor = null
  69         ) {
  70                 $this->name = $name;
  71                 $this->module = $module;
  72                 $this->descriptor = $descriptor;
  73                 $this->basePath = $basePath;
  74                 $this->variants = $variants;
  75                 $this->defaultColor = $defaultColor;
  76
  77                 // Expand shorthands:
  78                 // [ "en,de,fr" => "foo.svg" ]
  79                 // → [ "en" => "foo.svg", "de" => "foo.svg", "fr" => "foo.svg" ]
  80                 if ( is_array( $this->descriptor ) && isset( $this->descriptor['lang'] ) ) {
  81                         foreach ( array_keys( $this->descriptor['lang'] ) as $langList ) {
  82                                 if ( strpos( $langList, ',' ) !== false ) {
  83                                         $this->descriptor['lang'] += array_fill_keys(
  84                                                 explode( ',', $langList ),
  85                                                 $this->descriptor['lang'][$langList]
  86                                         );
  87                                         unset( $this->descriptor['lang'][$langList] );
  88                                 }
  89                         }
  90                 }
  91                 // Remove 'deprecated' key
  92                 if ( is_array( $this->descriptor ) ) {
  93                         unset( $this->descriptor['deprecated'] );
  94                 }
  95
  96                 // Ensure that all files have common extension.
  97                 $extensions = [];
  98                 $descriptor = is_array( $this->descriptor ) ? $this->descriptor : [ $this->descriptor ];
  99                 array_walk_recursive( $descriptor, function ( $path ) use ( &$extensions ) {
 100                         $extensions[] = pathinfo( $this->getLocalPath( $path ), PATHINFO_EXTENSION );
 101                 } );
 102                 $extensions = array_unique( $extensions );
 103                 if ( count( $extensions ) !== 1 ) {
 104                         throw new InvalidArgumentException(
 105                                 "File type for different image files of '$name' not the same in module '$module'"
 106                         );
 107                 }
 108                 $ext = $extensions[0];
 109                 if ( !isset( self::$fileTypes[$ext] ) ) {
 110                         throw new InvalidArgumentException(
 111                                 "Invalid file type for image files of '$name' (valid: svg, png, gif, jpg) in module '$module'"
 112                         );
 113                 }
 114                 $this->extension = $ext;
 115         }
 116
 117         /**
 118          * Get name of this image.
 119          *
 120          * @return string
 121          */
 122         public function getName() {
 123                 return $this->name;
 124         }
 125
 126         /**
 127          * Get name of the module this image belongs to.
 128          *
 129          * @return string
 130          */
 131         public function getModule() {
 132                 return $this->module;
 133         }
 134
 135         /**
 136          * Get the list of variants this image can be converted to.
 137          *
 138          * @return string[]
 139          */
 140         public function getVariants() {
 141                 return array_keys( $this->variants );
 142         }
 143
 144         /**
 145          * Get the path to image file for given context.
 146          *
 147          * @param ResourceLoaderContext $context Any context
 148          * @return string
 149          * @throws MWException If no matching path is found
 150          */
 151         public function getPath( ResourceLoaderContext $context ) {
 152                 $desc = $this->descriptor;
 153                 if ( !is_array( $desc ) ) {
 154                         return $this->getLocalPath( $desc );
 155                 }
 156                 if ( isset( $desc['lang'] ) ) {
 157                         $contextLang = $context->getLanguage();
 158                         if ( isset( $desc['lang'][$contextLang] ) ) {
 159                                 return $this->getLocalPath( $desc['lang'][$contextLang] );
 160                         }
 161                         $fallbacks = Language::getFallbacksFor( $contextLang, Language::STRICT_FALLBACKS );
 162                         foreach ( $fallbacks as $lang ) {
 163                                 if ( isset( $desc['lang'][$lang] ) ) {
 164                                         return $this->getLocalPath( $desc['lang'][$lang] );
 165                                 }
 166                         }
 167                 }
 168                 if ( isset( $desc[$context->getDirection()] ) ) {
 169                         return $this->getLocalPath( $desc[$context->getDirection()] );
 170                 }
 171                 if ( isset( $desc['default'] ) ) {
 172                         return $this->getLocalPath( $desc['default'] );
 173                 } else {
 174                         throw new MWException( 'No matching path found' );
 175                 }
 176         }
 177
 178         /**
 179          * @param string|ResourceLoaderFilePath $path
 180          * @return string
 181          */
 182         protected function getLocalPath( $path ) {
 183                 if ( $path instanceof ResourceLoaderFilePath ) {
 184                         return $path->getLocalPath();
 185                 }
 186
 187                 return "{$this->basePath}/$path";
 188         }
 189
 190         /**
 191          * Get the extension of the image.
 192          *
 193          * @param string $format Format to get the extension for, 'original' or 'rasterized'
 194          * @return string Extension without leading dot, e.g. 'png'
 195          */
 196         public function getExtension( $format = 'original' ) {
 197                 if ( $format === 'rasterized' && $this->extension === 'svg' ) {
 198                         return 'png';
 199                 }
 200                 return $this->extension;
 201         }
 202
 203         /**
 204          * Get the MIME type of the image.
 205          *
 206          * @param string $format Format to get the MIME type for, 'original' or 'rasterized'
 207          * @return string
 208          */
 209         public function getMimeType( $format = 'original' ) {
 210                 $ext = $this->getExtension( $format );
 211                 return self::$fileTypes[$ext];
 212         }
 213
 214         /**
 215          * Get the load.php URL that will produce this image.
 216          *
 217          * @param ResourceLoaderContext $context Any context
 218          * @param string $script URL to load.php
 219          * @param string|null $variant Variant to get the URL for
 220          * @param string $format Format to get the URL for, 'original' or 'rasterized'
 221          * @return string
 222          */
 223         public function getUrl( ResourceLoaderContext $context, $script, $variant, $format ) {
 224                 $query = [
 225                         'modules' => $this->getModule(),
 226                         'image' => $this->getName(),
 227                         'variant' => $variant,
 228                         'format' => $format,
 229                 ];
 230                 if ( $this->varyOnLanguage() ) {
 231                         $query['lang'] = $context->getLanguage();
 232                 }
 233                 // The following parameters are at the end to keep the original order of the parameters.
 234                 $query['skin'] = $context->getSkin();
 235                 $query['version'] = $context->getVersion();
 236
 237                 return wfAppendQuery( $script, $query );
 238         }
 239
 240         /**
 241          * Get the data: URI that will produce this image.
 242          *
 243          * @param ResourceLoaderContext $context Any context
 244          * @param string|null $variant Variant to get the URI for
 245          * @param string $format Format to get the URI for, 'original' or 'rasterized'
 246          * @return string
 247          */
 248         public function getDataUri( ResourceLoaderContext $context, $variant, $format ) {
 249                 $type = $this->getMimeType( $format );
 250                 $contents = $this->getImageData( $context, $variant, $format );
 251                 return CSSMin::encodeStringAsDataURI( $contents, $type );
 252         }
 253
 254         /**
 255          * Get actual image data for this image. This can be saved to a file or sent to the browser to
 256          * produce the converted image.
 257          *
 258          * Call getExtension() or getMimeType() with the same $format argument to learn what file type the
 259          * returned data uses.
 260          *
 261          * @param ResourceLoaderContext $context Image context, or any context if $variant and $format
 262          *     given.
 263          * @param string|null $variant Variant to get the data for. Optional; if given, overrides the data
 264          *     from $context.
 265          * @param string $format Format to get the data for, 'original' or 'rasterized'. Optional; if
 266          *     given, overrides the data from $context.
 267          * @return string|false Possibly binary image data, or false on failure
 268          * @throws MWException If the image file doesn't exist
 269          */
 270         public function getImageData( ResourceLoaderContext $context, $variant = false, $format = false ) {
 271                 if ( $variant === false ) {
 272                         $variant = $context->getVariant();
 273                 }
 274                 if ( $format === false ) {
 275                         $format = $context->getFormat();
 276                 }
 277
 278                 $path = $this->getPath( $context );
 279                 if ( !file_exists( $path ) ) {
 280                         throw new MWException( "File '$path' does not exist" );
 281                 }
 282
 283                 if ( $this->getExtension() !== 'svg' ) {
 284                         return file_get_contents( $path );
 285                 }
 286
 287                 if ( $variant && isset( $this->variants[$variant] ) ) {
 288                         $data = $this->variantize( $this->variants[$variant], $context );
 289                 } else {
 290                         $defaultColor = $this->defaultColor;
 291                         $data = $defaultColor ?
 292                                 $this->variantize( [ 'color' => $defaultColor ], $context ) :
 293                                 file_get_contents( $path );
 294                 }
 295
 296                 if ( $format === 'rasterized' ) {
 297                         $data = $this->rasterize( $data );
 298                         if ( !$data ) {
 299                                 wfDebugLog( 'ResourceLoaderImage', __METHOD__ . " failed to rasterize for $path" );
 300                         }
 301                 }
 302
 303                 return $data;
 304         }
 305
 306         /**
 307          * Send response headers (using the header() function) that are necessary to correctly serve the
 308          * image data for this image, as returned by getImageData().
 309          *
 310          * Note that the headers are independent of the language or image variant.
 311          *
 312          * @param ResourceLoaderContext $context Image context
 313          */
 314         public function sendResponseHeaders( ResourceLoaderContext $context ) {
 315                 $format = $context->getFormat();
 316                 $mime = $this->getMimeType( $format );
 317                 $filename = $this->getName() . '.' . $this->getExtension( $format );
 318
 319                 header( 'Content-Type: ' . $mime );
 320                 header( 'Content-Disposition: ' .
 321                         FileBackend::makeContentDisposition( 'inline', $filename ) );
 322         }
 323
 324         /**
 325          * Convert this image, which is assumed to be SVG, to given variant.
 326          *
 327          * @param array $variantConf Array with a 'color' key, its value will be used as fill color
 328          * @param ResourceLoaderContext $context Image context
 329          * @return string New SVG file data
 330          */
 331         protected function variantize( $variantConf, ResourceLoaderContext $context ) {
 332                 $dom = new DOMDocument;
 333                 $dom->loadXML( file_get_contents( $this->getPath( $context ) ) );
 334                 $root = $dom->documentElement;
 335                 $titleNode = null;
 336                 $wrapper = $dom->createElementNS( 'http://www.w3.org/2000/svg', 'g' );
 337                 // Reattach all direct children of the `<svg>` root node to the `<g>` wrapper
 338                 while ( $root->firstChild ) {
 339                         $node = $root->firstChild;
 340                         if ( !$titleNode && $node->nodeType === XML_ELEMENT_NODE && $node->tagName === 'title' ) {
 341                                 // Remember the first encountered `<title>` node
 342                                 $titleNode = $node;
 343                         }
 344                         $wrapper->appendChild( $node );
 345                 }
 346                 if ( $titleNode ) {
 347                         // Reattach the `<title>` node to the `<svg>` root node rather than the `<g>` wrapper
 348                         $root->appendChild( $titleNode );
 349                 }
 350                 $root->appendChild( $wrapper );
 351                 $wrapper->setAttribute( 'fill', $variantConf['color'] );
 352                 return $dom->saveXML();
 353         }
 354
 355         /**
 356          * Massage the SVG image data for converters which don't understand some path data syntax.
 357          *
 358          * This is necessary for rsvg and ImageMagick when compiled with rsvg support.
 359          * Upstream bug is https://bugzilla.gnome.org/show_bug.cgi?id=620923, fixed 2014-11-10, so
 360          * this will be needed for a while. (T76852)
 361          *
 362          * @param string $svg SVG image data
 363          * @return string Massaged SVG image data
 364          */
 365         protected function massageSvgPathdata( $svg ) {
 366                 $dom = new DOMDocument;
 367                 $dom->loadXML( $svg );
 368                 foreach ( $dom->getElementsByTagName( 'path' ) as $node ) {
 369                         $pathData = $node->getAttribute( 'd' );
 370                         // Make sure there is at least one space between numbers, and that leading zero is not omitted.
 371                         // rsvg has issues with syntax like "M-1-2" and "M.445.483" and especially "M-.445-.483".
 372                         $pathData = preg_replace( '/(-?)(\d*\.\d+|\d+)/', ' ${1}0$2 ', $pathData );
 373                         // Strip unnecessary leading zeroes for prettiness, not strictly necessary
 374                         $pathData = preg_replace( '/([ -])0(\d)/', '$1$2', $pathData );
 375                         $node->setAttribute( 'd', $pathData );
 376                 }
 377                 return $dom->saveXML();
 378         }
 379
 380         /**
 381          * Convert passed image data, which is assumed to be SVG, to PNG.
 382          *
 383          * @param string $svg SVG image data
 384          * @return string|bool PNG image data, or false on failure
 385          */
 386         protected function rasterize( $svg ) {
 387                 /**
 388                  * This code should be factored out to a separate method on SvgHandler, or perhaps a separate
 389                  * class, with a separate set of configuration settings.
 390                  *
 391                  * This is a distinct use case from regular SVG rasterization:
 392                  * * We can skip many sanity and security checks (as the images come from a trusted source,
 393                  *   rather than from the user).
 394                  * * We need to provide extra options to some converters to achieve acceptable quality for very
 395                  *   small images, which might cause performance issues in the general case.
 396                  * * We want to directly pass image data to the converter, rather than a file path.
 397                  *
 398                  * See https://phabricator.wikimedia.org/T76473#801446 for examples of what happens with the
 399                  * default settings.
 400                  *
 401                  * For now, we special-case rsvg (used in WMF production) and do a messy workaround for other
 402                  * converters.
 403                  */
 404
 405                 global $wgSVGConverter, $wgSVGConverterPath;
 406
 407                 $svg = $this->massageSvgPathdata( $svg );
 408
 409                 // Sometimes this might be 'rsvg-secure'. Long as it's rsvg.
 410                 if ( strpos( $wgSVGConverter, 'rsvg' ) === 0 ) {
 411                         $command = 'rsvg-convert';
 412                         if ( $wgSVGConverterPath ) {
 413                                 $command = Shell::escape( "$wgSVGConverterPath/" ) . $command;
 414                         }
 415
 416                         $process = proc_open(
 417                                 $command,
 418                                 [ 0 => [ 'pipe', 'r' ], 1 => [ 'pipe', 'w' ] ],
 419                                 $pipes
 420                         );
 421
 422                         if ( is_resource( $process ) ) {
 423                                 fwrite( $pipes[0], $svg );
 424                                 fclose( $pipes[0] );
 425                                 $png = stream_get_contents( $pipes[1] );
 426                                 fclose( $pipes[1] );
 427                                 proc_close( $process );
 428
 429                                 return $png ?: false;
 430                         }
 431                         return false;
 432
 433                 } else {
 434                         // Write input to and read output from a temporary file
 435                         $tempFilenameSvg = tempnam( wfTempDir(), 'ResourceLoaderImage' );
 436                         $tempFilenamePng = tempnam( wfTempDir(), 'ResourceLoaderImage' );
 437
 438                         file_put_contents( $tempFilenameSvg, $svg );
 439
 440                         $metadata = SVGMetadataExtractor::getMetadata( $tempFilenameSvg );
 441                         if ( !isset( $metadata['width'] ) || !isset( $metadata['height'] ) ) {
 442                                 unlink( $tempFilenameSvg );
 443                                 return false;
 444                         }
 445
 446                         $handler = new SvgHandler;
 447                         $res = $handler->rasterize(
 448                                 $tempFilenameSvg,
 449                                 $tempFilenamePng,
 450                                 $metadata['width'],
 451                                 $metadata['height']
 452                         );
 453                         unlink( $tempFilenameSvg );
 454
 455                         $png = null;
 456                         if ( $res === true ) {
 457                                 $png = file_get_contents( $tempFilenamePng );
 458                                 unlink( $tempFilenamePng );
 459                         }
 460
 461                         return $png ?: false;
 462                 }
 463         }
 464
 465         /**
 466          * Check if the image depends on the language.
 467          *
 468          * @return bool
 469          */
 470         private function varyOnLanguage() {
 471                 return is_array( $this->descriptor ) && (
 472                         isset( $this->descriptor['ltr'] ) ||
 473                         isset( $this->descriptor['rtl'] ) ||
 474                         isset( $this->descriptor['lang'] ) );
 475         }
 476 }