Progressive images support #10642

enonic · Aug 15, 2024 · 83e51f0 · 83e51f0
1 parent dcefb15
commit 83e51f0
Show file tree

Hide file tree

Showing 12 changed files with 160 additions and 4 deletions.
diff --git a/modules/core/core-api/src/main/java/com/enonic/xp/image/ImageHelper.java b/modules/core/core-api/src/main/java/com/enonic/xp/image/ImageHelper.java
@@ -105,12 +105,23 @@ public static byte[] writeImage( final BufferedImage image, final String format,
 
     public static void writeImage( OutputStream out, final BufferedImage image, final String format, final int quality )
         throws IOException
+    {
+        writeImage( out, image, format, quality, false );
+    }
+
+    public static void writeImage( OutputStream out, final BufferedImage image, final String format, final int quality,
+                                   boolean progressive )
+        throws IOException
     {
         final ImageWriter writer = getWriterByFormat( format );
         try (ImageOutputStream output = new MemoryCacheImageOutputStream( out ))
         {
             writer.setOutput( output );
             final ImageWriteParam params = writer.getDefaultWriteParam();
+            if ( progressive )
+            {
+                params.setProgressiveMode( ImageWriteParam.MODE_DEFAULT );
+            }
             setCompressionQuality( params, quality );
             writer.write( null, new IIOImage( image, null, null ), params );
         }

diff --git a/modules/core/core-image/build.gradle b/modules/core/core-image/build.gradle
@@ -1,5 +1,6 @@
 dependencies {
     implementation project( ':core:core-api' )
+    implementation project( ':core:core-internal' )
     implementation libs.jhlabs.filters
 }
 

diff --git a/modules/core/core-image/src/main/java/com/enonic/xp/core/impl/image/ImageConfig.java b/modules/core/core-image/src/main/java/com/enonic/xp/core/impl/image/ImageConfig.java
@@ -7,4 +7,6 @@
     int filters_maxTotal() default 25;
 
     String memoryLimit() default "10%";
+
+    String progressive() default "jpeg";
 }
diff --git a/modules/core/core-image/src/main/java/com/enonic/xp/core/impl/image/ImageServiceImpl.java b/modules/core/core-image/src/main/java/com/enonic/xp/core/impl/image/ImageServiceImpl.java
@@ -11,6 +11,10 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.util.Iterator;
+import java.util.Locale;
+import java.util.Set;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
 
 import javax.imageio.ImageIO;
 import javax.imageio.ImageReader;
@@ -30,6 +34,7 @@
 
 import com.enonic.xp.content.ContentService;
 import com.enonic.xp.core.impl.image.effect.ImageScaleFunction;
+import com.enonic.xp.core.internal.SimpleCsvParser;
 import com.enonic.xp.home.HomeDir;
 import com.enonic.xp.image.Cropping;
 import com.enonic.xp.image.ImageHelper;
@@ -54,6 +59,8 @@ public class ImageServiceImpl
 
     private final MemoryCircuitBreaker circuitBreaker;
 
+    private final Set<String> progressiveOnFormats;
+
     @Activate
     public ImageServiceImpl( @Reference final ContentService contentService,
                              @Reference final ImageScaleFunctionBuilder imageScaleFunctionBuilder,
@@ -65,6 +72,13 @@ public ImageServiceImpl( @Reference final ContentService contentService,
 
         this.circuitBreaker = new MemoryCircuitBreaker(
             toMegaBytes( new MemoryLimitParser( Runtime.getRuntime()::maxMemory ).parse( config.memoryLimit() ) ) );
+
+        this.progressiveOnFormats = SimpleCsvParser.parseLine( config.progressive() )
+            .stream()
+            .map( String::trim )
+            .filter( Predicate.not( String::isEmpty ) )
+            .map( s -> s.toLowerCase( Locale.ROOT ) )
+            .collect( Collectors.toUnmodifiableSet() );
     }
 
     @Override
@@ -239,9 +253,13 @@ private boolean createImage( final ByteSource blob, final NormalizedImageParams
                             // but 0 quality in image service need to be retrofitted to "system default", otherwise JPEG with 0 quality
                             // is over-compressed and looks way different from system default compressed image.
                             final int writeImageQuality = readImageParams.getQuality() == 0 ? -1 : readImageParams.getQuality();
+
+                            final boolean progressive =
+                                progressiveOnFormats.stream().anyMatch( format -> format.equalsIgnoreCase( readImageParams.getFormat() ) );
+
                             try (OutputStream outputStream = sink.openBufferedStream())
                             {
-                                ImageHelper.writeImage( outputStream, bufferedImage, readImageParams.getFormat(), writeImageQuality );
+                                ImageHelper.writeImage( outputStream, bufferedImage, readImageParams.getFormat(), writeImageQuality, progressive );
                             }
                             LOG.debug( "Finish writing" );
                             return true;

diff --git a/...es/core/core-image/src/main/java/com/enonic/xp/core/impl/image/NormalizedImageParams.java b/...es/core/core-image/src/main/java/com/enonic/xp/core/impl/image/NormalizedImageParams.java
@@ -106,7 +106,7 @@ private static Cropping normalizeCropping( final Cropping cropping )
 
     private static String normalizeFormat( final ReadImageParams readImageParams )
     {
-        // Existing should not set format parameter, but if it does all bets are off.
+        // Existing code should not set format parameter, but if it does all bets are off.
         if ( readImageParams.getFormat() != null )
         {
             return readImageParams.getFormat();

diff --git a/...les/core/core-image/src/test/java/com/enonic/xp/core/impl/image/ImageServiceImplTest.java b/...les/core/core-image/src/test/java/com/enonic/xp/core/impl/image/ImageServiceImplTest.java
@@ -5,7 +5,9 @@
 import java.nio.file.Path;
 
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
 import org.junit.jupiter.api.io.TempDir;
 
 import com.google.common.io.ByteSource;
@@ -40,16 +42,23 @@ class ImageServiceImplTest
 
     private byte[] imageDataOriginal;
 
+    ImageConfig imageConfig;
+
     @BeforeEach
-    void setUp()
+    void setUp( final TestInfo info )
     {
         System.setProperty( "xp.home", temporaryFolder.toFile().getPath() );
 
         contentId = ContentId.from( "contentId" );
         binaryReference = BinaryReference.from( "binaryRef" );
         contentService = mock( ContentService.class );
 
-        final ImageConfig imageConfig = mock( ImageConfig.class, invocation -> invocation.getMethod().getDefaultValue() );
+        imageConfig = mock( ImageConfig.class, invocation -> invocation.getMethod().getDefaultValue() );
+
+        if ( info.getTags().contains( "progressive_disabled" ) )
+        {
+            when( imageConfig.progressive() ).thenReturn( "" );
+        }
 
         ImageFilterBuilderImpl imageFilterBuilder = new ImageFilterBuilderImpl();
         imageFilterBuilder.activate( imageConfig );
@@ -107,6 +116,39 @@ void readImage_with_format()
         assertArrayEquals( imageDataOriginal, imageData.read() );
     }
 
+    @Test
+    public void readImage_jpeg_progressive_default()
+        throws IOException
+    {
+        mockOriginalImage( "original.png" );
+
+        final ReadImageParams readImageParams = ReadImageParams.newImageParams()
+            .contentId( contentId )
+            .binaryReference( binaryReference )
+            .mimeType( "image/jpeg" )
+            .build();
+
+        ByteSource imageData = imageService.readImage( readImageParams );
+        assertArrayEquals( readImage( "progressive.jpg" ), imageData.read() );
+    }
+
+    @Test
+    @Tag("progressive_disabled")
+    public void readImage_progressive_disabled()
+        throws IOException
+    {
+        mockOriginalImage( "original.png" );
+
+        final ReadImageParams readImageParams = ReadImageParams.newImageParams()
+            .contentId( contentId )
+            .binaryReference( binaryReference )
+            .mimeType( "image/jpeg" )
+            .build();
+
+        ByteSource imageData = imageService.readImage( readImageParams );
+        assertArrayEquals( readImage( "not_progressive.jpg" ), imageData.read() );
+    }
+
     @Test
     public void readImage_with_cache()
         throws IOException

diff --git a/...core-image/src/test/resources/com/enonic/xp/core/impl/image/not_progressive.jpg b/...core-image/src/test/resources/com/enonic/xp/core/impl/image/not_progressive.jpg
diff --git a/.../core/core-image/src/test/resources/com/enonic/xp/core/impl/image/processed.jpg b/.../core/core-image/src/test/resources/com/enonic/xp/core/impl/image/processed.jpg
diff --git a/...ore/core-image/src/test/resources/com/enonic/xp/core/impl/image/progressive.jpg b/...ore/core-image/src/test/resources/com/enonic/xp/core/impl/image/progressive.jpg
diff --git a/modules/core/core-internal/src/main/java/com/enonic/xp/core/internal/SimpleCsvParser.java b/modules/core/core-internal/src/main/java/com/enonic/xp/core/internal/SimpleCsvParser.java
@@ -0,0 +1,63 @@
+package com.enonic.xp.core.internal;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public final class SimpleCsvParser
+{
+    private SimpleCsvParser()
+    {
+    }
+
+    public static List<String> parseLine( final String line )
+    {
+        final List<String> fields = new ArrayList<>();
+        final StringBuilder field = new StringBuilder();
+        boolean inQuotes = false;
+
+        for ( int i = 0; i < line.length(); i++ )
+        {
+            char c = line.charAt( i );
+
+            if ( inQuotes )
+            {
+                if ( c == '\"' )
+                {
+                    if ( i + 1 < line.length() && line.charAt( i + 1 ) == '\"' )
+                    {
+                        field.append( c );
+                        i++;
+                    }
+                    else
+                    {
+                        inQuotes = false;
+                    }
+                }
+                else
+                {
+                    field.append( c );
+                }
+            }
+            else
+            {
+                if ( c == '\"' )
+                {
+                    inQuotes = true;
+                }
+                else if ( c == ',' )
+                {
+                    fields.add( field.toString() );
+                    field.setLength( 0 );
+                }
+                else
+                {
+                    field.append( c );
+                }
+            }
+        }
+
+        fields.add( field.toString() );
+
+        return fields;
+    }
+}
diff --git a/...les/core/core-internal/src/test/java/com/enonic/xp/core/internal/SimpleCsvParserTest.java b/...les/core/core-internal/src/test/java/com/enonic/xp/core/internal/SimpleCsvParserTest.java
@@ -0,0 +1,18 @@
+package com.enonic.xp.core.internal;
+
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class SimpleCsvParserTest
+{
+    @Test
+    void parseLine()
+    {
+        assertEquals( List.of( "a", "b", "c" ), SimpleCsvParser.parseLine( "a,b,c" ) );
+        assertEquals( List.of( "Cache-Control: no-store, private", " X-Instance: \"jupiter\"" ),
+                      SimpleCsvParser.parseLine( "\"Cache-Control: no-store, private\", \"X-Instance: \"\"jupiter\"\"\"" ) );
+    }
+}
diff --git a/modules/runtime/src/home/config/com.enonic.xp.image.cfg b/modules/runtime/src/home/config/com.enonic.xp.image.cfg
@@ -1,3 +1,4 @@
 #scale.maxDimension = 8000
 #filters.maxTotal = 25
 #memoryLimit = 10%
+#progressive = jpeg