3 * Class encapsulating an image used in a ResourceLoaderImageModule.
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.
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.
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
24 * Class encapsulating an image used in a ResourceLoaderImageModule.
28 class ResourceLoaderImage
{
31 * Map of allowed file extensions to their MIME types.
34 protected static $fileTypes = [
35 'svg' => 'image/svg+xml',
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 * @param string|null $defaultColor of the base variant
48 * @throws InvalidArgumentException
50 public function __construct( $name, $module, $descriptor, $basePath, $variants,
54 $this->module
= $module;
55 $this->descriptor
= $descriptor;
56 $this->basePath
= $basePath;
57 $this->variants
= $variants;
58 $this->defaultColor
= $defaultColor;
61 // [ "en,de,fr" => "foo.svg" ]
62 // → [ "en" => "foo.svg", "de" => "foo.svg", "fr" => "foo.svg" ]
63 if ( is_array( $this->descriptor
) && isset( $this->descriptor
['lang'] ) ) {
64 foreach ( array_keys( $this->descriptor
['lang'] ) as $langList ) {
65 if ( strpos( $langList, ',' ) !== false ) {
66 $this->descriptor
['lang'] +
= array_fill_keys(
67 explode( ',', $langList ),
68 $this->descriptor
['lang'][$langList]
70 unset( $this->descriptor
['lang'][$langList] );
74 // Remove 'deprecated' key
75 if ( is_array( $this->descriptor
) ) {
76 unset( $this->descriptor
['deprecated'] );
79 // Ensure that all files have common extension.
81 $descriptor = (array)$this->descriptor
;
82 array_walk_recursive( $descriptor, function ( $path ) use ( &$extensions ) {
83 $extensions[] = pathinfo( $path, PATHINFO_EXTENSION
);
85 $extensions = array_unique( $extensions );
86 if ( count( $extensions ) !== 1 ) {
87 throw new InvalidArgumentException(
88 "File type for different image files of '$name' not the same in module '$module'"
91 $ext = $extensions[0];
92 if ( !isset( self
::$fileTypes[$ext] ) ) {
93 throw new InvalidArgumentException(
94 "Invalid file type for image files of '$name' (valid: svg, png, gif, jpg) in module '$module'"
97 $this->extension
= $ext;
101 * Get name of this image.
105 public function getName() {
110 * Get name of the module this image belongs to.
114 public function getModule() {
115 return $this->module
;
119 * Get the list of variants this image can be converted to.
123 public function getVariants() {
124 return array_keys( $this->variants
);
128 * Get the path to image file for given context.
130 * @param ResourceLoaderContext $context Any context
133 public function getPath( ResourceLoaderContext
$context ) {
134 $desc = $this->descriptor
;
135 if ( is_string( $desc ) ) {
136 return $this->basePath
. '/' . $desc;
138 if ( isset( $desc['lang'] ) ) {
139 $contextLang = $context->getLanguage();
140 if ( isset( $desc['lang'][$contextLang] ) ) {
141 return $this->basePath
. '/' . $desc['lang'][$contextLang];
143 $fallbacks = Language
::getFallbacksFor( $contextLang, Language
::STRICT_FALLBACKS
);
144 foreach ( $fallbacks as $lang ) {
145 if ( isset( $desc['lang'][$lang] ) ) {
146 return $this->basePath
. '/' . $desc['lang'][$lang];
150 if ( isset( $desc[$context->getDirection()] ) ) {
151 return $this->basePath
. '/' . $desc[$context->getDirection()];
153 return $this->basePath
. '/' . $desc['default'];
157 * Get the extension of the image.
159 * @param string $format Format to get the extension for, 'original' or 'rasterized'
160 * @return string Extension without leading dot, e.g. 'png'
162 public function getExtension( $format = 'original' ) {
163 if ( $format === 'rasterized' && $this->extension
=== 'svg' ) {
166 return $this->extension
;
170 * Get the MIME type of the image.
172 * @param string $format Format to get the MIME type for, 'original' or 'rasterized'
175 public function getMimeType( $format = 'original' ) {
176 $ext = $this->getExtension( $format );
177 return self
::$fileTypes[$ext];
181 * Get the load.php URL that will produce this image.
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'
189 public function getUrl( ResourceLoaderContext
$context, $script, $variant, $format ) {
191 'modules' => $this->getModule(),
192 'image' => $this->getName(),
193 'variant' => $variant,
195 'lang' => $context->getLanguage(),
196 'skin' => $context->getSkin(),
197 'version' => $context->getVersion(),
200 return wfAppendQuery( $script, $query );
204 * Get the data: URI that will produce this image.
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'
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 );
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.
221 * Call getExtension() or getMimeType() with the same $format argument to learn what file type the
222 * returned data uses.
224 * @param ResourceLoaderContext $context Image context, or any context if $variant and $format
226 * @param string|null $variant Variant to get the data for. Optional; if given, overrides the data
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
233 public function getImageData( ResourceLoaderContext
$context, $variant = false, $format = false ) {
234 if ( $variant === false ) {
235 $variant = $context->getVariant();
237 if ( $format === false ) {
238 $format = $context->getFormat();
241 $path = $this->getPath( $context );
242 if ( !file_exists( $path ) ) {
243 throw new MWException( "File '$path' does not exist" );
246 if ( $this->getExtension() !== 'svg' ) {
247 return file_get_contents( $path );
250 if ( $variant && isset( $this->variants
[$variant] ) ) {
251 $data = $this->variantize( $this->variants
[$variant], $context );
253 $defaultColor = $this->defaultColor
;
254 $data = $defaultColor ?
255 $this->variantize( [ 'color' => $defaultColor ], $context ) :
256 file_get_contents( $path );
259 if ( $format === 'rasterized' ) {
260 $data = $this->rasterize( $data );
262 wfDebugLog( 'ResourceLoaderImage', __METHOD__
. " failed to rasterize for $path" );
270 * Send response headers (using the header() function) that are necessary to correctly serve the
271 * image data for this image, as returned by getImageData().
273 * Note that the headers are independent of the language or image variant.
275 * @param ResourceLoaderContext $context Image context
277 public function sendResponseHeaders( ResourceLoaderContext
$context ) {
278 $format = $context->getFormat();
279 $mime = $this->getMimeType( $format );
280 $filename = $this->getName() . '.' . $this->getExtension( $format );
282 header( 'Content-Type: ' . $mime );
283 header( 'Content-Disposition: ' .
284 FileBackend
::makeContentDisposition( 'inline', $filename ) );
288 * Convert this image, which is assumed to be SVG, to given variant.
290 * @param array $variantConf Array with a 'color' key, its value will be used as fill color
291 * @param ResourceLoaderContext $context Image context
292 * @return string New SVG file data
294 protected function variantize( $variantConf, ResourceLoaderContext
$context ) {
295 $dom = new DOMDocument
;
296 $dom->loadXML( file_get_contents( $this->getPath( $context ) ) );
297 $root = $dom->documentElement
;
299 $wrapper = $dom->createElementNS( 'http://www.w3.org/2000/svg', 'g' );
300 // Reattach all direct children of the `<svg>` root node to the `<g>` wrapper
301 while ( $root->firstChild
) {
302 $node = $root->firstChild
;
303 if ( !$titleNode && $node->nodeType
=== XML_ELEMENT_NODE
&& $node->tagName
=== 'title' ) {
304 // Remember the first encountered `<title>` node
307 $wrapper->appendChild( $node );
310 // Reattach the `<title>` node to the `<svg>` root node rather than the `<g>` wrapper
311 $root->appendChild( $titleNode );
313 $root->appendChild( $wrapper );
314 $wrapper->setAttribute( 'fill', $variantConf['color'] );
315 return $dom->saveXML();
319 * Massage the SVG image data for converters which don't understand some path data syntax.
321 * This is necessary for rsvg and ImageMagick when compiled with rsvg support.
322 * Upstream bug is https://bugzilla.gnome.org/show_bug.cgi?id=620923, fixed 2014-11-10, so
323 * this will be needed for a while. (T76852)
325 * @param string $svg SVG image data
326 * @return string Massaged SVG image data
328 protected function massageSvgPathdata( $svg ) {
329 $dom = new DOMDocument
;
330 $dom->loadXML( $svg );
331 foreach ( $dom->getElementsByTagName( 'path' ) as $node ) {
332 $pathData = $node->getAttribute( 'd' );
333 // Make sure there is at least one space between numbers, and that leading zero is not omitted.
334 // rsvg has issues with syntax like "M-1-2" and "M.445.483" and especially "M-.445-.483".
335 $pathData = preg_replace( '/(-?)(\d*\.\d+|\d+)/', ' ${1}0$2 ', $pathData );
336 // Strip unnecessary leading zeroes for prettiness, not strictly necessary
337 $pathData = preg_replace( '/([ -])0(\d)/', '$1$2', $pathData );
338 $node->setAttribute( 'd', $pathData );
340 return $dom->saveXML();
344 * Convert passed image data, which is assumed to be SVG, to PNG.
346 * @param string $svg SVG image data
347 * @return string|bool PNG image data, or false on failure
349 protected function rasterize( $svg ) {
351 * This code should be factored out to a separate method on SvgHandler, or perhaps a separate
352 * class, with a separate set of configuration settings.
354 * This is a distinct use case from regular SVG rasterization:
355 * * We can skip many sanity and security checks (as the images come from a trusted source,
356 * rather than from the user).
357 * * We need to provide extra options to some converters to achieve acceptable quality for very
358 * small images, which might cause performance issues in the general case.
359 * * We want to directly pass image data to the converter, rather than a file path.
361 * See https://phabricator.wikimedia.org/T76473#801446 for examples of what happens with the
364 * For now, we special-case rsvg (used in WMF production) and do a messy workaround for other
368 global $wgSVGConverter, $wgSVGConverterPath;
370 $svg = $this->massageSvgPathdata( $svg );
372 // Sometimes this might be 'rsvg-secure'. Long as it's rsvg.
373 if ( strpos( $wgSVGConverter, 'rsvg' ) === 0 ) {
374 $command = 'rsvg-convert';
375 if ( $wgSVGConverterPath ) {
376 $command = wfEscapeShellArg( "$wgSVGConverterPath/" ) . $command;
379 $process = proc_open(
381 [ 0 => [ 'pipe', 'r' ], 1 => [ 'pipe', 'w' ] ],
385 if ( is_resource( $process ) ) {
386 fwrite( $pipes[0], $svg );
388 $png = stream_get_contents( $pipes[1] );
390 proc_close( $process );
392 return $png ?
: false;
397 // Write input to and read output from a temporary file
398 $tempFilenameSvg = tempnam( wfTempDir(), 'ResourceLoaderImage' );
399 $tempFilenamePng = tempnam( wfTempDir(), 'ResourceLoaderImage' );
401 file_put_contents( $tempFilenameSvg, $svg );
403 $metadata = SVGMetadataExtractor
::getMetadata( $tempFilenameSvg );
404 if ( !isset( $metadata['width'] ) ||
!isset( $metadata['height'] ) ) {
405 unlink( $tempFilenameSvg );
409 $handler = new SvgHandler
;
410 $res = $handler->rasterize(
416 unlink( $tempFilenameSvg );
419 if ( $res === true ) {
420 $png = file_get_contents( $tempFilenamePng );
421 unlink( $tempFilenamePng );
424 return $png ?
: false;