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