MediaWiki  master
ResourceLoaderImage.php
Go to the documentation of this file.
1 <?php
24 
31 
36  protected static $fileTypes = [
37  'svg' => 'image/svg+xml',
38  'png' => 'image/png',
39  'gif' => 'image/gif',
40  'jpg' => 'image/jpg',
41  ];
42 
44  private $name;
46  private $module;
48  private $descriptor;
50  private $basePath;
52  private $variants;
54  private $defaultColor;
56  private $extension;
57 
69  ) {
70  $this->name = $name;
71  $this->module = $module;
72  $this->descriptor = $descriptor;
73  $this->basePath = $basePath;
74  $this->variants = $variants;
75  $this->defaultColor = $defaultColor;
76 
77  // Expand shorthands:
78  // [ "en,de,fr" => "foo.svg" ]
79  // → [ "en" => "foo.svg", "de" => "foo.svg", "fr" => "foo.svg" ]
80  if ( is_array( $this->descriptor ) && isset( $this->descriptor['lang'] ) ) {
81  foreach ( array_keys( $this->descriptor['lang'] ) as $langList ) {
82  if ( strpos( $langList, ',' ) !== false ) {
83  $this->descriptor['lang'] += array_fill_keys(
84  explode( ',', $langList ),
85  $this->descriptor['lang'][$langList]
86  );
87  unset( $this->descriptor['lang'][$langList] );
88  }
89  }
90  }
91  // Remove 'deprecated' key
92  if ( is_array( $this->descriptor ) ) {
93  unset( $this->descriptor['deprecated'] );
94  }
95 
96  // Ensure that all files have common extension.
97  $extensions = [];
98  $descriptor = (array)$this->descriptor;
99  array_walk_recursive( $descriptor, function ( $path ) use ( &$extensions ) {
100  $extensions[] = pathinfo( $path, PATHINFO_EXTENSION );
101  } );
102  $extensions = array_unique( $extensions );
103  if ( count( $extensions ) !== 1 ) {
104  throw new InvalidArgumentException(
105  "File type for different image files of '$name' not the same in module '$module'"
106  );
107  }
108  $ext = $extensions[0];
109  if ( !isset( self::$fileTypes[$ext] ) ) {
110  throw new InvalidArgumentException(
111  "Invalid file type for image files of '$name' (valid: svg, png, gif, jpg) in module '$module'"
112  );
113  }
114  $this->extension = $ext;
115  }
116 
122  public function getName() {
123  return $this->name;
124  }
125 
131  public function getModule() {
132  return $this->module;
133  }
134 
140  public function getVariants() {
141  return array_keys( $this->variants );
142  }
143 
151  $desc = $this->descriptor;
152  if ( is_string( $desc ) ) {
153  return $this->basePath . '/' . $desc;
154  }
155  if ( isset( $desc['lang'] ) ) {
156  $contextLang = $context->getLanguage();
157  if ( isset( $desc['lang'][$contextLang] ) ) {
158  return $this->basePath . '/' . $desc['lang'][$contextLang];
159  }
160  $fallbacks = Language::getFallbacksFor( $contextLang, Language::STRICT_FALLBACKS );
161  foreach ( $fallbacks as $lang ) {
162  if ( isset( $desc['lang'][$lang] ) ) {
163  return $this->basePath . '/' . $desc['lang'][$lang];
164  }
165  }
166  }
167  if ( isset( $desc[$context->getDirection()] ) ) {
168  return $this->basePath . '/' . $desc[$context->getDirection()];
169  }
170  return $this->basePath . '/' . $desc['default'];
171  }
172 
179  public function getExtension( $format = 'original' ) {
180  if ( $format === 'rasterized' && $this->extension === 'svg' ) {
181  return 'png';
182  }
183  return $this->extension;
184  }
185 
192  public function getMimeType( $format = 'original' ) {
193  $ext = $this->getExtension( $format );
194  return self::$fileTypes[$ext];
195  }
196 
206  public function getUrl( ResourceLoaderContext $context, $script, $variant, $format ) {
207  $query = [
208  'modules' => $this->getModule(),
209  'image' => $this->getName(),
210  'variant' => $variant,
211  'format' => $format,
212  'lang' => $context->getLanguage(),
213  'skin' => $context->getSkin(),
214  'version' => $context->getVersion(),
215  ];
216 
217  return wfAppendQuery( $script, $query );
218  }
219 
228  public function getDataUri( ResourceLoaderContext $context, $variant, $format ) {
229  $type = $this->getMimeType( $format );
230  $contents = $this->getImageData( $context, $variant, $format );
231  return CSSMin::encodeStringAsDataURI( $contents, $type );
232  }
233 
250  public function getImageData( ResourceLoaderContext $context, $variant = false, $format = false ) {
251  if ( $variant === false ) {
252  $variant = $context->getVariant();
253  }
254  if ( $format === false ) {
255  $format = $context->getFormat();
256  }
257 
258  $path = $this->getPath( $context );
259  if ( !file_exists( $path ) ) {
260  throw new MWException( "File '$path' does not exist" );
261  }
262 
263  if ( $this->getExtension() !== 'svg' ) {
264  return file_get_contents( $path );
265  }
266 
267  if ( $variant && isset( $this->variants[$variant] ) ) {
268  $data = $this->variantize( $this->variants[$variant], $context );
269  } else {
271  $data = $defaultColor ?
272  $this->variantize( [ 'color' => $defaultColor ], $context ) :
273  file_get_contents( $path );
274  }
275 
276  if ( $format === 'rasterized' ) {
277  $data = $this->rasterize( $data );
278  if ( !$data ) {
279  wfDebugLog( 'ResourceLoaderImage', __METHOD__ . " failed to rasterize for $path" );
280  }
281  }
282 
283  return $data;
284  }
285 
295  $format = $context->getFormat();
296  $mime = $this->getMimeType( $format );
297  $filename = $this->getName() . '.' . $this->getExtension( $format );
298 
299  header( 'Content-Type: ' . $mime );
300  header( 'Content-Disposition: ' .
301  FileBackend::makeContentDisposition( 'inline', $filename ) );
302  }
303 
311  protected function variantize( $variantConf, ResourceLoaderContext $context ) {
312  $dom = new DOMDocument;
313  $dom->loadXML( file_get_contents( $this->getPath( $context ) ) );
314  $root = $dom->documentElement;
315  $titleNode = null;
316  $wrapper = $dom->createElementNS( 'http://www.w3.org/2000/svg', 'g' );
317  // Reattach all direct children of the `<svg>` root node to the `<g>` wrapper
318  while ( $root->firstChild ) {
319  $node = $root->firstChild;
320  if ( !$titleNode && $node->nodeType === XML_ELEMENT_NODE && $node->tagName === 'title' ) {
321  // Remember the first encountered `<title>` node
322  $titleNode = $node;
323  }
324  $wrapper->appendChild( $node );
325  }
326  if ( $titleNode ) {
327  // Reattach the `<title>` node to the `<svg>` root node rather than the `<g>` wrapper
328  $root->appendChild( $titleNode );
329  }
330  $root->appendChild( $wrapper );
331  $wrapper->setAttribute( 'fill', $variantConf['color'] );
332  return $dom->saveXML();
333  }
334 
345  protected function massageSvgPathdata( $svg ) {
346  $dom = new DOMDocument;
347  $dom->loadXML( $svg );
348  foreach ( $dom->getElementsByTagName( 'path' ) as $node ) {
349  $pathData = $node->getAttribute( 'd' );
350  // Make sure there is at least one space between numbers, and that leading zero is not omitted.
351  // rsvg has issues with syntax like "M-1-2" and "M.445.483" and especially "M-.445-.483".
352  $pathData = preg_replace( '/(-?)(\d*\.\d+|\d+)/', ' ${1}0$2 ', $pathData );
353  // Strip unnecessary leading zeroes for prettiness, not strictly necessary
354  $pathData = preg_replace( '/([ -])0(\d)/', '$1$2', $pathData );
355  $node->setAttribute( 'd', $pathData );
356  }
357  return $dom->saveXML();
358  }
359 
366  protected function rasterize( $svg ) {
386 
387  $svg = $this->massageSvgPathdata( $svg );
388 
389  // Sometimes this might be 'rsvg-secure'. Long as it's rsvg.
390  if ( strpos( $wgSVGConverter, 'rsvg' ) === 0 ) {
391  $command = 'rsvg-convert';
392  if ( $wgSVGConverterPath ) {
393  $command = Shell::escape( "$wgSVGConverterPath/" ) . $command;
394  }
395 
396  $process = proc_open(
397  $command,
398  [ 0 => [ 'pipe', 'r' ], 1 => [ 'pipe', 'w' ] ],
399  $pipes
400  );
401 
402  if ( is_resource( $process ) ) {
403  fwrite( $pipes[0], $svg );
404  fclose( $pipes[0] );
405  $png = stream_get_contents( $pipes[1] );
406  fclose( $pipes[1] );
407  proc_close( $process );
408 
409  return $png ?: false;
410  }
411  return false;
412 
413  } else {
414  // Write input to and read output from a temporary file
415  $tempFilenameSvg = tempnam( wfTempDir(), 'ResourceLoaderImage' );
416  $tempFilenamePng = tempnam( wfTempDir(), 'ResourceLoaderImage' );
417 
418  file_put_contents( $tempFilenameSvg, $svg );
419 
420  $metadata = SVGMetadataExtractor::getMetadata( $tempFilenameSvg );
421  if ( !isset( $metadata['width'] ) || !isset( $metadata['height'] ) ) {
422  unlink( $tempFilenameSvg );
423  return false;
424  }
425 
426  $handler = new SvgHandler;
427  $res = $handler->rasterize(
428  $tempFilenameSvg,
429  $tempFilenamePng,
430  $metadata['width'],
431  $metadata['height']
432  );
433  unlink( $tempFilenameSvg );
434 
435  $png = null;
436  if ( $res === true ) {
437  $png = file_get_contents( $tempFilenamePng );
438  unlink( $tempFilenamePng );
439  }
440 
441  return $png ?: false;
442  }
443  }
444 }
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))
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:1585
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Class encapsulating an image used in a ResourceLoaderImageModule.
static getMetadata( $filename)
massageSvgPathdata( $svg)
Massage the SVG image data for converters which don&#39;t understand some path data syntax.
getImageData(ResourceLoaderContext $context, $variant=false, $format=false)
Get actual image data for this image.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$command
Definition: cdb.php:65
if(!isset( $args[0])) $lang
static array string $name
__construct( $name, $module, $descriptor, $basePath, $variants, $defaultColor=null)
rasterize( $svg)
Convert passed image data, which is assumed to be SVG, to PNG.
getUrl(ResourceLoaderContext $context, $script, $variant, $format)
Get the load.php URL that will produce this image.
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfTempDir()
Tries to get the system directory for temporary files.
$wgSVGConverterPath
If not in the executable PATH, specify the SVG converter path.
getDataUri(ResourceLoaderContext $context, $variant, $format)
Get the data: URI that will produce this image.
const STRICT_FALLBACKS
Return a strict fallback chain in getFallbacksFor.
Definition: Language.php:94
$res
Definition: database.txt:21
static encodeStringAsDataURI( $contents, $type, $ie8Compat=true)
Encode file contents as a data URI with chosen MIME type.
Definition: CSSMin.php:142
getVariants()
Get the list of variants this image can be converted to.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
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:9
static array $fileTypes
Map of allowed file extensions to their MIME types.
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:35
getName()
Get name of this image.
getMimeType( $format='original')
Get the MIME type of the image.
sendResponseHeaders(ResourceLoaderContext $context)
Send response headers (using the header() function) that are necessary to correctly serve the image d...
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
variantize( $variantConf, ResourceLoaderContext $context)
Convert this image, which is assumed to be SVG, to given variant.
static getFallbacksFor( $code, $mode=self::MESSAGES_FALLBACKS)
Get the ordered list of fallback languages.
Definition: Language.php:4538
if(!is_readable( $file)) $ext
Definition: router.php:48
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:2633
getModule()
Get name of the module this image belongs to.
getPath(ResourceLoaderContext $context)
Get the path to image file for given context.
$wgSVGConverter
Pick a converter defined in $wgSVGConverters.
Handler for SVG images.
Definition: SvgHandler.php:32
static makeContentDisposition( $type, $filename='')
Build a Content-Disposition header value per RFC 6266.
Object passed around to modules which contains information about the state of a specific loader reque...
getExtension( $format='original')
Get the extension of the image.