Merge pull request #3857 from mapfish/ghci/backport/3856-to-3.33

[Backport 3.33] Add WebP support

Author: sbrunner

core/build.gradle

@@ -185,6 +185,8 @@ dependencies {
             'net.logstash.logback:logstash-logback-encoder:8.0',
             // For PDF/A
             'com.adobe.xmp:xmpcore:6.1.11',
+            // For WebP images
+            'com.twelvemonkeys.imageio:imageio-webp:3.12.0',
     )
 
     implementation(

core/src/main/java/org/mapfish/print/ImageInit.java

@@ -0,0 +1,31 @@
+package org.mapfish.print;
+
+import com.twelvemonkeys.imageio.plugins.webp.WebPImageReaderSpi;
+import javax.annotation.PostConstruct;
+import javax.imageio.ImageIO;
+import javax.imageio.spi.IIORegistry;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Initializes image plugins (initially for WebP support) at application startup.
+ *
+ * <p>This class registers the WebP image reader plugin with the Java ImageIO framework, enabling
+ * support for WebP images. Typically used in a servlet context.
+ */
+public class ImageInit {
+  private static final Logger LOGGER = LoggerFactory.getLogger(ImageInit.class);
+
+  /**
+   * Initializes image plugins if the {@code mapfish.image.plugins} system property is set to {@code
+   * true}. Registers additional image readers such as WebP.
+   */
+  @PostConstruct
+  public final void init() {
+    if (System.getProperty("mapfish.image.plugins", "false").equals("true")) {
+      LOGGER.info("Scanning for image plugins");
+      ImageIO.scanForPlugins();
+      IIORegistry.getDefaultInstance().registerServiceProvider(new WebPImageReaderSpi());
+    }
+  }
+}

core/src/main/webapp/WEB-INF/mapfish-print-servlet.xml

@@ -16,4 +16,5 @@
     </bean>
 
     <bean id="versionInfo" class="org.mapfish.print.VersionInfo" lazy-init="false"/>
+    <bean id="imageInit" class="org.mapfish.print.ImageInit" lazy-init="false"/>
 </beans>

docker-compose.yaml

@@ -16,6 +16,7 @@ services:
       PRINT_YAML_MAX_ALIASES: '200'
       LOG_LEVEL: DEBUG
       JASPER_LOG_LEVEL: DEBUG
+      JAVA_OPTS: '-Dmapfish.image.plugins=true'
 
   tests:
     image: mapfish_print_builder

docs/src/main/resources/pages.json

@@ -10,6 +10,7 @@
   },
   "pages": {
     "index": "Overview",
+    "properties": "Properties",
     "jasperreports": "Jasper Reports",
     "api": "Web Protocol",
     "tableimages": "Configuration of tables with HTML images",

docs/src/main/resources/templates/_main.html

@@ -41,9 +41,8 @@
                 <a class="reference internal {{current_api}}" href="api.html">Web API</a>
               </li>
 
-              <li class="toctree-l1 {{current_attributes}}">
-                <a class="reference internal {{current_attributes}}" href="attributes.html">Attributes</a>
-                {{sub_nav_attributes}}
+              <li class="toctree-l1 {{current_properties}}">
+                <a class="reference internal {{current_properties}}" href="properties.html">Properties</a>
               </li>
 
               <li class="toctree-l1 {{current_configuration}}">
@@ -53,6 +52,11 @@
                 {{sub_nav_configuration}}
               </li>
 
+              <li class="toctree-l1 {{current_attributes}}">
+                <a class="reference internal {{current_attributes}}" href="attributes.html">Attributes</a>
+                {{sub_nav_attributes}}
+              </li>
+
               <li class="toctree-l1 {{current_layers}}">
                 <a class="reference internal {{current_layers}}" href="layers.html">Map Layers</a>
                 {{sub_nav_layers}}

docs/src/main/resources/templates/properties.html

@@ -0,0 +1,27 @@
+<p>List the Java properties that can be set to configure Mapfish Print 3.</p>
+<p>
+  The properties can be set using the <code>-D</code> option when starting the Java Virtual Machine. For
+  example: by setting the <code>JAVA_OPTS</code> environment variable.
+</p>
+<ul>
+  <li>
+    <code>db.*</code> see the <a href="scaling.html#database_configuration">Database Configuration</a> section
+    for details.
+  </li>
+
+  <li>
+    <code>mapfish.file.encoding</code>: the default character encoding used, the default is <code>UTF-8</code>
+  </li>
+  <li>
+    <code>mapfish.maxContentLength</code>: the maximum size in bytes of HTTP request body specifications. The
+    default is <code>10485760</code> (10 MB).
+  </li>
+  <li>
+    <code>mapfish.image.plugins</code>: set to <code>true</code> to enable scanning for image plugins at
+    startup (see
+    <a
+      href="https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/imageio/ImageIO.html#scanForPlugins()"
+      >scanForPlugins</a
+    >), used to enable WebP image format support. Default is <code>false</code>.
+  </li>
+</ul>