MediaWiki REL1_32
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
50 public function __construct( $name, $module, $descriptor, $basePath, $variants,
51 $defaultColor = null
52 ) {
53 $this->name = $name;
54 $this->module = $module;
55 $this->descriptor = $descriptor;
56 $this->basePath = $basePath;
57 $this->variants = $variants;
58 $this->defaultColor = $defaultColor;
59
60 // Expand shorthands:
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]
69 );
70 unset( $this->descriptor['lang'][$langList] );
71 }
72 }
73 }
74 // Remove 'deprecated' key
75 if ( is_array( $this->descriptor ) ) {
76 unset( $this->descriptor[ 'deprecated' ] );
77 }
78
79 // Ensure that all files have common extension.
80 $extensions = [];
81 $descriptor = (array)$this->descriptor;
82 array_walk_recursive( $descriptor, function ( $path ) use ( &$extensions ) {
83 $extensions[] = pathinfo( $path, PATHINFO_EXTENSION );
84 } );
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'"
89 );
90 }
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'"
95 );
96 }
97 $this->extension = $ext;
98 }
99
105 public function getName() {
106 return $this->name;
107 }
108
114 public function getModule() {
115 return $this->module;
116 }
117
123 public function getVariants() {
124 return array_keys( $this->variants );
125 }
126
134 $desc = $this->descriptor;
135 if ( is_string( $desc ) ) {
136 return $this->basePath . '/' . $desc;
137 }
138 if ( isset( $desc['lang'] ) ) {
139 $contextLang = $context->getLanguage();
140 if ( isset( $desc['lang'][$contextLang] ) ) {
141 return $this->basePath . '/' . $desc['lang'][$contextLang];
142 }
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];
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
162 public function getExtension( $format = 'original' ) {
163 if ( $format === 'rasterized' && $this->extension === 'svg' ) {
164 return 'png';
165 }
166 return $this->extension;
167 }
168
175 public function getMimeType( $format = 'original' ) {
176 $ext = $this->getExtension( $format );
177 return self::$fileTypes[$ext];
178 }
179
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
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
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 $defaultColor = $this->defaultColor;
254 $data = $defaultColor ?
255 $this->variantize( [ 'color' => $defaultColor ], $context ) :
256 file_get_contents( $path );
257 }
258
259 if ( $format === 'rasterized' ) {
260 $data = $this->rasterize( $data );
261 if ( !$data ) {
262 wfDebugLog( 'ResourceLoaderImage', __METHOD__ . " failed to rasterize for $path" );
263 }
264 }
265
266 return $data;
267 }
268
278 $format = $context->getFormat();
279 $mime = $this->getMimeType( $format );
280 $filename = $this->getName() . '.' . $this->getExtension( $format );
281
282 header( 'Content-Type: ' . $mime );
283 header( 'Content-Disposition: ' .
284 FileBackend::makeContentDisposition( 'inline', $filename ) );
285 }
286
294 protected function variantize( $variantConf, ResourceLoaderContext $context ) {
295 $dom = new DomDocument;
296 $dom->loadXML( file_get_contents( $this->getPath( $context ) ) );
297 $root = $dom->documentElement;
298 $wrapper = $dom->createElement( 'g' );
299 while ( $root->firstChild ) {
300 $wrapper->appendChild( $root->firstChild );
301 }
302 $root->appendChild( $wrapper );
303 $wrapper->setAttribute( 'fill', $variantConf['color'] );
304 return $dom->saveXML();
305 }
306
317 protected function massageSvgPathdata( $svg ) {
318 $dom = new DomDocument;
319 $dom->loadXML( $svg );
320 foreach ( $dom->getElementsByTagName( 'path' ) as $node ) {
321 $pathData = $node->getAttribute( 'd' );
322 // Make sure there is at least one space between numbers, and that leading zero is not omitted.
323 // rsvg has issues with syntax like "M-1-2" and "M.445.483" and especially "M-.445-.483".
324 $pathData = preg_replace( '/(-?)(\d*\.\d+|\d+)/', ' ${1}0$2 ', $pathData );
325 // Strip unnecessary leading zeroes for prettiness, not strictly necessary
326 $pathData = preg_replace( '/([ -])0(\d)/', '$1$2', $pathData );
327 $node->setAttribute( 'd', $pathData );
328 }
329 return $dom->saveXML();
330 }
331
338 protected function rasterize( $svg ) {
358
359 $svg = $this->massageSvgPathdata( $svg );
360
361 // Sometimes this might be 'rsvg-secure'. Long as it's rsvg.
362 if ( strpos( $wgSVGConverter, 'rsvg' ) === 0 ) {
363 $command = 'rsvg-convert';
364 if ( $wgSVGConverterPath ) {
365 $command = wfEscapeShellArg( "$wgSVGConverterPath/" ) . $command;
366 }
367
368 $process = proc_open(
369 $command,
370 [ 0 => [ 'pipe', 'r' ], 1 => [ 'pipe', 'w' ] ],
371 $pipes
372 );
373
374 if ( is_resource( $process ) ) {
375 fwrite( $pipes[0], $svg );
376 fclose( $pipes[0] );
377 $png = stream_get_contents( $pipes[1] );
378 fclose( $pipes[1] );
379 proc_close( $process );
380
381 return $png ?: false;
382 }
383 return false;
384
385 } else {
386 // Write input to and read output from a temporary file
387 $tempFilenameSvg = tempnam( wfTempDir(), 'ResourceLoaderImage' );
388 $tempFilenamePng = tempnam( wfTempDir(), 'ResourceLoaderImage' );
389
390 file_put_contents( $tempFilenameSvg, $svg );
391
392 $metadata = SVGMetadataExtractor::getMetadata( $tempFilenameSvg );
393 if ( !isset( $metadata['width'] ) || !isset( $metadata['height'] ) ) {
394 unlink( $tempFilenameSvg );
395 return false;
396 }
397
398 $handler = new SvgHandler;
400 $tempFilenameSvg,
401 $tempFilenamePng,
402 $metadata['width'],
403 $metadata['height']
404 );
405 unlink( $tempFilenameSvg );
406
407 $png = null;
408 if ( $res === true ) {
409 $png = file_get_contents( $tempFilenamePng );
410 unlink( $tempFilenamePng );
411 }
412
413 return $png ?: false;
414 }
415 }
416}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$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(... $args)
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:65
static encodeStringAsDataURI( $contents, $type, $ie8Compat=true)
Encode file contents as a data URI with chosen MIME type.
Definition CSSMin.php:142
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, $defaultColor=null)
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.
rasterize( $srcPath, $dstPath, $width, $height, $lang=false)
Transform an SVG file to PNG This function can be called outside of thumbnail contexts.
$res
Definition database.txt:21
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
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:2885
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
and how to run hooks for an and one after Each event has a name
Definition hooks.txt:12
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:933
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:1656
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
if( $ext=='php'|| $ext=='php5') $mime
Definition router.php:59
if(!is_readable( $file)) $ext
Definition router.php:55
if(!isset( $args[0])) $lang