ResourceLoaderImage module definitions can define a defaultColor

[lhc/web/wiklou.git] / includes / resourceloader / ResourceLoaderImage.php

diff --git a/includes/resourceloader/ResourceLoaderImage.php b/includes/resourceloader/ResourceLoaderImage.php
index 87e5fd7..0adbd0c 100644 (file)
--- a/includes/resourceloader/ResourceLoaderImage.php
+++ b/includes/resourceloader/ResourceLoaderImage.php
@@ -44,18 +44,22 @@ class ResourceLoaderImage {
         * @param string|array $descriptor Path to image file, or array structure containing paths
         * @param string $basePath Directory to which paths in descriptor refer
         * @param array $variants
+        * @param string|null $defaultColor of the base variant
         * @throws InvalidArgumentException
         */
-       public function __construct( $name, $module, $descriptor, $basePath, $variants ) {
+       public function __construct( $name, $module, $descriptor, $basePath, $variants,
+               $defaultColor = null
+       ) {
                $this->name = $name;
                $this->module = $module;
                $this->descriptor = $descriptor;
                $this->basePath = $basePath;
                $this->variants = $variants;
+               $this->defaultColor = $defaultColor;
 
                // Expand shorthands:
-               // array( "en,de,fr" => "foo.svg" )
-               // → array( "en" => "foo.svg", "de" => "foo.svg", "fr" => "foo.svg" )
+               // [ "en,de,fr" => "foo.svg" ]
+               // → [ "en" => "foo.svg", "de" => "foo.svg", "fr" => "foo.svg" ]
                if ( is_array( $this->descriptor ) && isset( $this->descriptor['lang'] ) ) {
                        foreach ( array_keys( $this->descriptor['lang'] ) as $langList ) {
                                if ( strpos( $langList, ',' ) !== false ) {
@@ -67,23 +71,27 @@ class ResourceLoaderImage {
                                }
                        }
                }
+               // Remove 'deprecated' key
+               if ( is_array( $this->descriptor ) ) {
+                       unset( $this->descriptor[ 'deprecated' ] );
+               }
 
                // Ensure that all files have common extension.
                $extensions = [];
-               $descriptor = (array)$descriptor;
+               $descriptor = (array)$this->descriptor;
                array_walk_recursive( $descriptor, function ( $path ) use ( &$extensions ) {
                        $extensions[] = pathinfo( $path, PATHINFO_EXTENSION );
                } );
                $extensions = array_unique( $extensions );
                if ( count( $extensions ) !== 1 ) {
                        throw new InvalidArgumentException(
-                               "File type for different image files of '$name' not the same"
+                               "File type for different image files of '$name' not the same in module '$module'"
                        );
                }
                $ext = $extensions[0];
                if ( !isset( self::$fileTypes[$ext] ) ) {
                        throw new InvalidArgumentException(
-                               "Invalid file type for image files of '$name' (valid: svg, png, gif, jpg)"
+                               "Invalid file type for image files of '$name' (valid: svg, png, gif, jpg) in module '$module'"
                        );
                }
                $this->extension = $ext;
@@ -126,13 +134,27 @@ class ResourceLoaderImage {
                $desc = $this->descriptor;
                if ( is_string( $desc ) ) {
                        return $this->basePath . '/' . $desc;
-               } elseif ( isset( $desc['lang'][$context->getLanguage()] ) ) {
-                       return $this->basePath . '/' . $desc['lang'][$context->getLanguage()];
-               } elseif ( isset( $desc[$context->getDirection()] ) ) {
+               }
+               if ( isset( $desc['lang'] ) ) {
+                       $contextLang = $context->getLanguage();
+                       if ( isset( $desc['lang'][$contextLang] ) ) {
+                               return $this->basePath . '/' . $desc['lang'][$contextLang];
+                       }
+                       $fallbacks = Language::getFallbacksFor( $contextLang );
+                       foreach ( $fallbacks as $lang ) {
+                               // Images will fallback to 'default' instead of 'en', except for 'en-*' variants
+                               if (
+                                       ( $lang !== 'en' || substr( $contextLang, 0, 3 ) === 'en-' ) &&
+                                       isset( $desc['lang'][$lang] )
+                               ) {
+                                       return $this->basePath . '/' . $desc['lang'][$lang];
+                               }
+                       }
+               }
+               if ( isset( $desc[$context->getDirection()] ) ) {
                        return $this->basePath . '/' . $desc[$context->getDirection()];
-               } else {
-                       return $this->basePath . '/' . $desc['default'];
                }
+               return $this->basePath . '/' . $desc['default'];
        }
 
        /**
@@ -144,9 +166,8 @@ class ResourceLoaderImage {
        public function getExtension( $format = 'original' ) {
                if ( $format === 'rasterized' && $this->extension === 'svg' ) {
                        return 'png';
-               } else {
-                       return $this->extension;
                }
+               return $this->extension;
        }
 
        /**
@@ -176,6 +197,7 @@ class ResourceLoaderImage {
                        'variant' => $variant,
                        'format' => $format,
                        'lang' => $context->getLanguage(),
+                       'skin' => $context->getSkin(),
                        'version' => $context->getVersion(),
                ];
 
@@ -232,7 +254,10 @@ class ResourceLoaderImage {
                if ( $variant && isset( $this->variants[$variant] ) ) {
                        $data = $this->variantize( $this->variants[$variant], $context );
                } else {
-                       $data = file_get_contents( $path );
+                       $defaultColor = $this->defaultColor;
+                       $data = $defaultColor ?
+                               $this->variantize( [ 'color' => $defaultColor ], $context ) :
+                               file_get_contents( $path );
                }
 
                if ( $format === 'rasterized' ) {