[LazyImage] Abstract image content fetching

Author: Kocal

src/LazyImage/doc/index.rst

@@ -99,10 +99,39 @@ blurred, data-uri thumbnail of the image:
 
 The ``data_uri_thumbnail`` function receives 3 arguments:
 
--  the server path to the image to generate the data-uri thumbnail for ;
+-  the path to the image to generate the data-uri thumbnail for ;
 -  the width of the BlurHash to generate
 -  the height of the BlurHash to generate
 
+Customizing images fetching
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, images fetched in ``data_uri_thumbnail`` are fetched using the function
+`file_get_contents`_. It works well for local files, but you may want to customize it
+to fetch images from a remote server, from `Flysystem`_, etc...
+
+To do so you can create a invokable class, the first argument is the filename to fetch:
+
+.. ::
+
+    namespace App\BlurHash;
+
+    class FetchImageContent
+    {
+        public function __invoke(string $filename): string
+        {
+            // Your custom implementation here to fetch the image content
+        }
+    }
+
+Then you must configure the service in your Symfony configuration:
+
+.. code-block:: yaml
+
+    # config/packages/lazy_image.yaml
+    lazy_image:
+        fetch_image_content: 'App\BlurHash\FetchImageContent'
+
 Performance considerations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -190,3 +219,5 @@ https://symfony.com/doc/current/contributing/code/bc.html
 .. _`BlurHash implementation`: https://blurha.sh
 .. _`StimulusBundle`: https://symfony.com/bundles/StimulusBundle/current/index.html
 .. _StimulusBundle configured in your app: https://symfony.com/bundles/StimulusBundle/current/index.html
+.. _`file_get_contents`: https://www.php.net/manual/en/function.file-get-contents.php
+.. _`Flysystem`: https://flysystem.thephpleague.com

src/LazyImage/src/BlurHash/BlurHash.php

@@ -25,7 +25,11 @@
  */
 class BlurHash implements BlurHashInterface
 {
+    /**
+     * @param \Closure(string): string $fetchImageContent
+     */
     public function __construct(
+        private \Closure $fetchImageContent,
         private ?ImageManager $imageManager = null,
         private ?CacheInterface $cache = null,
     ) {
@@ -74,8 +78,10 @@ private function doEncode(string $filename, int $encodingWidth = 75, int $encodi
 
     private function generatePixels(string $filename, int $encodingWidth, int $encodingHeight): array
     {
+        $imageContent = ($this->fetchImageContent)($filename);
+
         if (self::intervention3()) {
-            $image = $this->imageManager->read($filename)->scale($encodingWidth, $encodingHeight);
+            $image = $this->imageManager->read($imageContent)->scale($encodingWidth, $encodingHeight);
             $width = $image->width();
             $height = $image->height();
             $pixels = [];
@@ -93,7 +99,7 @@ private function generatePixels(string $filename, int $encodingWidth, int $encod
         }
 
         // Resize image to increase encoding performance
-        $image = $this->imageManager->make(file_get_contents($filename));
+        $image = $this->imageManager->make($imageContent);
         $image->resize($encodingWidth, $encodingHeight, static function ($constraint) {
             $constraint->aspectRatio();
             $constraint->upsize();

src/LazyImage/src/BlurHash/FetchImageContent.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LazyImage\BlurHash;
+
+/**
+ * @author Hugo Alliaume <hugo@alliau.me>
+ */
+final class FetchImageContent
+{
+    public function __invoke(string $filename): string
+    {
+        return file_get_contents($filename);
+    }
+}

src/LazyImage/src/DependencyInjection/Configuration.php

@@ -27,6 +27,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $rootNode = $treeBuilder->getRootNode();
         $rootNode
             ->children()
+                ->scalarNode('fetch_image_content')->defaultValue('lazy_image.fetch_image_content')->end()
                 ->scalarNode('cache')->end()
             ->end()
         ;

src/LazyImage/src/DependencyInjection/LazyImageExtension.php

@@ -22,6 +22,7 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\UX\LazyImage\BlurHash\BlurHash;
 use Symfony\UX\LazyImage\BlurHash\BlurHashInterface;
+use Symfony\UX\LazyImage\BlurHash\FetchImageContent;
 use Symfony\UX\LazyImage\Twig\BlurHashExtension;
 use Symfony\UX\LazyImage\Twig\BlurHashRuntime;
 
@@ -44,15 +45,21 @@ public function load(array $configs, ContainerBuilder $container)
             ;
         }
 
+        $container
+            ->setDefinition('lazy_image.fetch_image_content', new Definition(FetchImageContent::class));
+
         $container
             ->setDefinition('lazy_image.blur_hash', new Definition(BlurHash::class))
-            ->setArgument(0, new Reference('lazy_image.image_manager', ContainerInterface::NULL_ON_INVALID_REFERENCE))
+            ->setArgument(0, (new Definition('Closure'))
+                ->setFactory(['Closure', 'fromCallable'])
+                ->addArgument(new Reference($config['fetch_image_content'])))
+            ->setArgument(1, new Reference('lazy_image.image_manager', ContainerInterface::NULL_ON_INVALID_REFERENCE))
         ;
 
         if (isset($config['cache'])) {
             $container
                 ->getDefinition('lazy_image.blur_hash')
-                ->setArgument(1, new Reference($config['cache']))
+                ->setArgument(2, new Reference($config['cache']))
             ;
         }
 

src/LazyImage/tests/BlurHash/BlurHashTest.php

@@ -15,9 +15,11 @@
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\UX\LazyImage\BlurHash\BlurHash;
 use Symfony\UX\LazyImage\BlurHash\BlurHashInterface;
+use Symfony\UX\LazyImage\Tests\Fixtures\BlurHash\LoggedFetchImageContent;
 use Symfony\UX\LazyImage\Tests\Kernel\TwigAppKernel;
 
 /**
@@ -42,6 +44,45 @@ public function testEncode()
         );
     }
 
+    public function testWithCustomGetImageContent(): void
+    {
+        $kernel = new class('test', true) extends TwigAppKernel {
+            public function registerContainerConfiguration(LoaderInterface $loader)
+            {
+                parent::registerContainerConfiguration($loader);
+
+                $loader->load(static function (ContainerBuilder $container) {
+                    $container->loadFromExtension('lazy_image', [
+                        'fetch_image_content' => 'logged_get_image_content',
+                    ]);
+
+                    $container
+                        ->setDefinition('logged_get_image_content', new Definition(LoggedFetchImageContent::class))
+                        ->setPublic('true')
+                    ;
+                });
+            }
+        };
+
+        $kernel->boot();
+        $container = $kernel->getContainer()->get('test.service_container');
+
+        /** @var BlurHashInterface $blurHash */
+        $blurHash = $container->get('test.lazy_image.blur_hash');
+
+        $loggedGetImageContent = $container->get('logged_get_image_content');
+        $this->assertInstanceOf(LoggedFetchImageContent::class, $loggedGetImageContent);
+        $this->assertEmpty($loggedGetImageContent->logs);
+
+        $this->assertSame(
+            BlurHash::intervention3() ? 'LnMtaO9FD%IU%MRjayRj~qIUM{of' : 'L54ec*~q_3?bofoffQWB9F9FD%IU',
+            $blurHash->encode(__DIR__.'/../Fixtures/logo.png')
+        );
+
+        $this->assertCount(1, $loggedGetImageContent->logs);
+        $this->assertSame(__DIR__.'/../Fixtures/logo.png', $loggedGetImageContent->logs[0]);
+    }
+
     public function testEnsureCacheIsNotUsedWhenNotConfigured()
     {
         $kernel = new TwigAppKernel('test', true);

src/LazyImage/tests/Fixtures/BlurHash/LoggedFetchImageContent.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Symfony\UX\LazyImage\Tests\Fixtures\BlurHash;
+
+final class LoggedFetchImageContent
+{
+    public array $logs = [];
+
+    public function __invoke(string $filename): string
+    {
+        $this->logs[] = $filename;
+
+        return file_get_contents($filename);
+    }
+}