MediaWiki REL1_30
ResourceLoaderImage.php
Go to the documentation of this file.
1<?php
29
34 protected static $fileTypes = [
35 'svg' => 'image/svg+xml',
36 'png' => 'image/png',
37 'gif' => 'image/gif',
38 'jpg' => 'image/jpg',
39 ];
40
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
101 public function getName() {
102 return $this->name;
103 }
104
110 public function getModule() {
111 return $this->module;
112 }
113
119 public function getVariants() {
120 return array_keys( $this->variants );
121 }
122
130 $desc = $this->descriptor;
131 if ( is_string( $desc ) ) {
132 return $this->basePath . '/' . $desc;
133 } elseif ( isset( $desc['lang'][$context->getLanguage()] ) ) {
134 return $this->basePath . '/' . $desc['lang'][$context->getLanguage()];
135 } elseif ( isset( $desc[$context->getDirection()] ) ) {
136 return $this->basePath . '/' . $desc[$context->getDirection()];
137 } else {
138 return $this->basePath . '/' . $desc['default'];
139 }
140 }
141
148 public function getExtension( $format = 'original' ) {
149 if ( $format === 'rasterized' && $this->extension === 'svg' ) {
150 return 'png';
151 }
152 return $this->extension;
153 }
154
161 public function getMimeType( $format = 'original' ) {
162 $ext = $this->getExtension( $format );
163 return self::$fileTypes[$ext];
164 }
165
175 public function getUrl( ResourceLoaderContext $context, $script, $variant, $format ) {
176 $query = [
177 'modules' => $this->getModule(),
178 'image' => $this->getName(),
179 'variant' => $variant,
180 'format' => $format,
181 'lang' => $context->getLanguage(),
182 'skin' => $context->getSkin(),
183 'version' => $context->getVersion(),
184 ];
185
186 return wfAppendQuery( $script, $query );
187 }
188
197 public function getDataUri( ResourceLoaderContext $context, $variant, $format ) {
198 $type = $this->getMimeType( $format );
199 $contents = $this->getImageData( $context, $variant, $format );
200 return CSSMin::encodeStringAsDataURI( $contents, $type );
201 }
202
219 public function getImageData( ResourceLoaderContext $context, $variant = false, $format = false ) {
220 if ( $variant === false ) {
221 $variant = $context->getVariant();
222 }
223 if ( $format === false ) {
224 $format = $context->getFormat();
225 }
226
227 $path = $this->getPath( $context );
228 if ( !file_exists( $path ) ) {
229 throw new MWException( "File '$path' does not exist" );
230 }
231
232 if ( $this->getExtension() !== 'svg' ) {
233 return file_get_contents( $path );
234 }
235
236 if ( $variant && isset( $this->variants[$variant] ) ) {
237 $data = $this->variantize( $this->variants[$variant], $context );
238 } else {
239 $data = file_get_contents( $path );
240 }
241
242 if ( $format === 'rasterized' ) {
243 $data = $this->rasterize( $data );
244 if ( !$data ) {
245 wfDebugLog( 'ResourceLoaderImage', __METHOD__ . " failed to rasterize for $path" );
246 }
247 }
248
249 return $data;
250 }
251
261 $format = $context->getFormat();
262 $mime = $this->getMimeType( $format );
263 $filename = $this->getName() . '.' . $this->getExtension( $format );
264
265 header( 'Content-Type: ' . $mime );
266 header( 'Content-Disposition: ' .
267 FileBackend::makeContentDisposition( 'inline', $filename ) );
268 }
269
277 protected function variantize( $variantConf, ResourceLoaderContext $context ) {
278 $dom = new DomDocument;
279 $dom->loadXML( file_get_contents( $this->getPath( $context ) ) );
280 $root = $dom->documentElement;
281 $wrapper = $dom->createElement( 'g' );
282 while ( $root->firstChild ) {
283 $wrapper->appendChild( $root->firstChild );
284 }
285 $root->appendChild( $wrapper );
286 $wrapper->setAttribute( 'fill', $variantConf['color'] );
287 return $dom->saveXML();
288 }
289
300 protected function massageSvgPathdata( $svg ) {
301 $dom = new DomDocument;
302 $dom->loadXML( $svg );
303 foreach ( $dom->getElementsByTagName( 'path' ) as $node ) {
304 $pathData = $node->getAttribute( 'd' );
305 // Make sure there is at least one space between numbers, and that leading zero is not omitted.
306 // rsvg has issues with syntax like "M-1-2" and "M.445.483" and especially "M-.445-.483".
307 $pathData = preg_replace( '/(-?)(\d*\.\d+|\d+)/', ' ${1}0$2 ', $pathData );
308 // Strip unnecessary leading zeroes for prettiness, not strictly necessary
309 $pathData = preg_replace( '/([ -])0(\d)/', '$1$2', $pathData );
310 $node->setAttribute( 'd', $pathData );
311 }
312 return $dom->saveXML();
313 }
314
321 protected function rasterize( $svg ) {
341
342 $svg = $this->massageSvgPathdata( $svg );
343
344 // Sometimes this might be 'rsvg-secure'. Long as it's rsvg.
345 if ( strpos( $wgSVGConverter, 'rsvg' ) === 0 ) {
346 $command = 'rsvg-convert';
347 if ( $wgSVGConverterPath ) {
348 $command = wfEscapeShellArg( "$wgSVGConverterPath/" ) . $command;
349 }
350
351 $process = proc_open(
352 $command,
353 [ 0 => [ 'pipe', 'r' ], 1 => [ 'pipe', 'w' ] ],
354 $pipes
355 );
356
357 if ( is_resource( $process ) ) {
358 fwrite( $pipes[0], $svg );
359 fclose( $pipes[0] );
360 $png = stream_get_contents( $pipes[1] );
361 fclose( $pipes[1] );
362 proc_close( $process );
363
364 return $png ?: false;
365 }
366 return false;
367
368 } else {
369 // Write input to and read output from a temporary file
370 $tempFilenameSvg = tempnam( wfTempDir(), 'ResourceLoaderImage' );
371 $tempFilenamePng = tempnam( wfTempDir(), 'ResourceLoaderImage' );
372
373 file_put_contents( $tempFilenameSvg, $svg );
374
375 $metadata = SVGMetadataExtractor::getMetadata( $tempFilenameSvg );
376 if ( !isset( $metadata['width'] ) || !isset( $metadata['height'] ) ) {
377 unlink( $tempFilenameSvg );
378 return false;
379 }
380
381 $handler = new SvgHandler;
382 $res = $handler->rasterize(
383 $tempFilenameSvg,
384 $tempFilenamePng,
385 $metadata['width'],
386 $metadata['height']
387 );
388 unlink( $tempFilenameSvg );
389
390 $png = null;
391 if ( $res === true ) {
392 $png = file_get_contents( $tempFilenamePng );
393 unlink( $tempFilenamePng );
394 }
395
396 return $png ?: false;
397 }
398 }
399}
$wgSVGConverter
Pick a converter defined in $wgSVGConverters.
$wgSVGConverterPath
If not in the executable PATH, specify the SVG converter path.
wfTempDir()
Tries to get the system directory for temporary files.
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
$basePath
Definition addSite.php:5
$command
Definition cdb.php:64
static makeContentDisposition( $type, $filename='')
Build a Content-Disposition header value per RFC 6266.
MediaWiki exception.
Object passed around to modules which contains information about the state of a specific loader reque...
Class encapsulating an image used in a ResourceLoaderImageModule.
rasterize( $svg)
Convert passed image data, which is assumed to be SVG, to PNG.
variantize( $variantConf, ResourceLoaderContext $context)
Convert this image, which is assumed to be SVG, to given variant.
getUrl(ResourceLoaderContext $context, $script, $variant, $format)
Get the load.php URL that will produce this image.
getPath(ResourceLoaderContext $context)
Get the path to image file for given context.
massageSvgPathdata( $svg)
Massage the SVG image data for converters which don't understand some path data syntax.
getMimeType( $format='original')
Get the MIME type of the image.
getModule()
Get name of the module this image belongs to.
getExtension( $format='original')
Get the extension of the image.
__construct( $name, $module, $descriptor, $basePath, $variants)
getDataUri(ResourceLoaderContext $context, $variant, $format)
Get the data: URI that will produce this image.
sendResponseHeaders(ResourceLoaderContext $context)
Send response headers (using the header() function) that are necessary to correctly serve the image d...
getName()
Get name of this image.
getVariants()
Get the list of variants this image can be converted to.
static array $fileTypes
Map of allowed file extensions to their MIME types.
getImageData(ResourceLoaderContext $context, $variant=false, $format=false)
Get actual image data for this image.
static getMetadata( $filename)
Handler for SVG images.
Definition SVG.php:30
$res
Definition database.txt:21
the array() calling protocol came about after MediaWiki 1.4rc1.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2780
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition hooks.txt:901
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1610
if( $ext=='php'|| $ext=='php5') $mime
Definition router.php:59