MediaWiki  REL1_31
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  }
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 
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  $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 
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 
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 
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 
335  protected function rasterize( $svg ) {
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 }
Language\getFallbacksFor
static getFallbacksFor( $code)
Get the ordered list of fallback languages.
Definition: Language.php:4547
ResourceLoaderContext
Object passed around to modules which contains information about the state of a specific loader reque...
Definition: ResourceLoaderContext.php:32
$handler
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:903
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
CSSMin\encodeStringAsDataURI
static encodeStringAsDataURI( $contents, $type, $ie8Compat=true)
Encode file contents as a data URI with chosen MIME type.
Definition: CSSMin.php:133
ResourceLoaderImage\variantize
variantize( $variantConf, ResourceLoaderContext $context)
Convert this image, which is assumed to be SVG, to given variant.
Definition: ResourceLoaderImage.php:291
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
SVGMetadataExtractor\getMetadata
static getMetadata( $filename)
Definition: SVGMetadataExtractor.php:32
$res
$res
Definition: database.txt:21
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1087
ResourceLoaderImage\getVariants
getVariants()
Get the list of variants this image can be converted to.
Definition: ResourceLoaderImage.php:119
php
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
ResourceLoaderImage\getMimeType
getMimeType( $format='original')
Get the MIME type of the image.
Definition: ResourceLoaderImage.php:175
wfAppendQuery
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:469
ResourceLoaderImage\$fileTypes
static array $fileTypes
Map of allowed file extensions to their MIME types.
Definition: ResourceLoaderImage.php:34
$wgSVGConverterPath
$wgSVGConverterPath
If not in the executable PATH, specify the SVG converter path.
Definition: DefaultSettings.php:1151
MWException
MediaWiki exception.
Definition: MWException.php:26
SvgHandler
Handler for SVG images.
Definition: SVG.php:30
ResourceLoaderImage\rasterize
rasterize( $svg)
Convert passed image data, which is assumed to be SVG, to PNG.
Definition: ResourceLoaderImage.php:335
ResourceLoaderImage\getModule
getModule()
Get name of the module this image belongs to.
Definition: ResourceLoaderImage.php:110
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
ResourceLoaderImage
Class encapsulating an image used in a ResourceLoaderImageModule.
Definition: ResourceLoaderImage.php:28
$mime
if( $ext=='php'|| $ext=='php5') $mime
Definition: router.php:59
$command
$command
Definition: cdb.php:65
ResourceLoaderImage\__construct
__construct( $name, $module, $descriptor, $basePath, $variants)
Definition: ResourceLoaderImage.php:49
wfEscapeShellArg
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
Definition: GlobalFunctions.php:2209
ResourceLoaderImage\getPath
getPath(ResourceLoaderContext $context)
Get the path to image file for given context.
Definition: ResourceLoaderImage.php:129
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
wfTempDir
wfTempDir()
Tries to get the system directory for temporary files.
Definition: GlobalFunctions.php:2057
ResourceLoaderImage\massageSvgPathdata
massageSvgPathdata( $svg)
Massage the SVG image data for converters which don't understand some path data syntax.
Definition: ResourceLoaderImage.php:314
ResourceLoaderImage\getExtension
getExtension( $format='original')
Get the extension of the image.
Definition: ResourceLoaderImage.php:162
$path
$path
Definition: NoLocalSettings.php:25
as
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
Definition: distributors.txt:22
$basePath
$basePath
Definition: addSite.php:5
ResourceLoaderImage\getDataUri
getDataUri(ResourceLoaderContext $context, $variant, $format)
Get the data: URI that will produce this image.
Definition: ResourceLoaderImage.php:211
name
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
ResourceLoaderImage\getImageData
getImageData(ResourceLoaderContext $context, $variant=false, $format=false)
Get actual image data for this image.
Definition: ResourceLoaderImage.php:233
$query
null for the 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:1620
ResourceLoaderImage\getName
getName()
Get name of this image.
Definition: ResourceLoaderImage.php:101
ResourceLoaderImage\getUrl
getUrl(ResourceLoaderContext $context, $script, $variant, $format)
Get the load.php URL that will produce this image.
Definition: ResourceLoaderImage.php:189
$ext
$ext
Definition: router.php:55
$wgSVGConverter
$wgSVGConverter
Pick a converter defined in $wgSVGConverters.
Definition: DefaultSettings.php:1146
$context
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:2811
ResourceLoaderImage\sendResponseHeaders
sendResponseHeaders(ResourceLoaderContext $context)
Send response headers (using the header() function) that are necessary to correctly serve the image d...
Definition: ResourceLoaderImage.php:274
$type
$type
Definition: testCompression.php:48
FileBackend\makeContentDisposition
static makeContentDisposition( $type, $filename='')
Build a Content-Disposition header value per RFC 6266.
Definition: FileBackend.php:1539