Merge pull request #338 from fugerit-org/337-enhancement-fj-doc-mod-fop-add-svg-support

fugerit79 · web-flow · commit 7fe8ce0aaacb · 2025-03-22T19:59:46.000+01:00
337 enhancement fj doc mod fop add svg support
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- [fj-doc-mod-fop] Support for SVG rendering <https://github.com/fugerit-org/fj-doc/issues/337>
+- [fj-doc-freemarker] FreeMarker function 'base64ToString' <https://github.com/fugerit-org/fj-doc/issues/337>
+- [fj-doc-base] 'svg' to accepted image types <https://github.com/fugerit-org/fj-doc/issues/337>
+
 ### Changed
 
 - [fj-doc-maven-plugin] spring-boot flavour version set to 3.4.4 <https://github.com/fugerit-org/fj-doc/issues/335>
diff --git a/fj-doc-base-kotlin/src/main/java/org/fugerit/java/doc/base/kotlin/dsl/HelperDSL.kt b/fj-doc-base-kotlin/src/main/java/org/fugerit/java/doc/base/kotlin/dsl/HelperDSL.kt
@@ -132,7 +132,7 @@ class HelperDSL {
 		private var checkFun12 : (v: String) -> Boolean =  { v -> setOf( "middle", "top", "bottom" ).contains( v ) }
 		private var checkFun13 : (v: String) -> Boolean =  { v -> setOf( "ul", "uld", "ulm", "ol", "oln", "oll" ).contains( v ) }
 		private var checkFun14 : (v: String) -> Boolean =  { v -> v.length in 0..2048 }
-		private var checkFun15 : (v: String) -> Boolean =  { v -> setOf( "png", "jpg", "gif" ).contains( v ) }
+		private var checkFun15 : (v: String) -> Boolean =  { v -> setOf( "png", "jpg", "gif", "svg" ).contains( v ) }
 		private var checkFun16 : (v: Int) -> Boolean =  { v -> v in 1..7 }
 		protected fun <T : Element> alignType( tag : T, name : String, v: String) : T = setAtt( tag, name, v, checkFun0 ) 
 		protected fun <T : Element> borderWidthType( tag : T, name : String, v: Int) : T = setAtt( tag, name, v, checkFun1 ) 
diff --git a/fj-doc-base/DocXsdChangelog.md b/fj-doc-base/DocXsdChangelog.md
@@ -1,9 +1,22 @@
+
+2.1.0.rc.3 (2025-03-22)
+------------------
+
+* Added 'svg' among accepted image types.
+
+2.1.0.rc.2 (2024-10-14)
+------------------
+
+* 'h' elemented accepted as child of 'para'.
+
 2.1.0.rc.1 (2023-08-18)
 ------------------
+
 * Added 'caption' attribute for 'table' element.
 
 2.0.0.rc.3 (2023-08-17)
 ------------------
+
 * Added documentation for table 'padding', 'spacing' attributes and info element values 
 
 2.0.0.rc.002 (2023-07-29)
diff --git a/fj-doc-base/src/main/docs/doc_xsd_config_ref.html b/fj-doc-base/src/main/docs/doc_xsd_config_ref.html
@@ -1888,7 +1888,7 @@ <h1  style="font-weight: bold;">Reference xsd documentation for Venus - Fugerit
 		<span >The type of the image</span>
 				</td>
 				<td id="cell_1_2"  style=" width: 40%; border-top: 1px solid black; border-bottom: 1px solid black; border-left: 1px solid black; border-right: 1px solid black; padding: 2px;">
-		<span >imageType , base : string , enumeration : [ png , jpg , gif ]</span>
+		<span >imageType , base : string , enumeration : [ png , jpg , gif , svg ]</span>
 				</td>
 		</tr>				
 		<tr>
diff --git a/fj-doc-base/src/main/java/org/fugerit/java/doc/base/model/DocImage.java b/fj-doc-base/src/main/java/org/fugerit/java/doc/base/model/DocImage.java
@@ -48,9 +48,11 @@ public class DocImage extends DocElement {
 	public static final String TYPE_JPG = "jpg";
 	
 	public static final String TYPE_GIF = "gif";
-	
+
+	public static final String TYPE_SVG = "svg";
+
 	public static Collection<String> getAcceptedImageTypes() {
-		return Arrays.asList( TYPE_PNG, TYPE_JPG, TYPE_GIF );
+		return Arrays.asList( TYPE_PNG, TYPE_JPG, TYPE_GIF, TYPE_SVG );
 	}
 	
 	public static final String TAG_NAME = "image";
@@ -85,5 +87,9 @@ public String getResolvedBase64() {
 	public String getResolvedType() {
 		return StringUtils.valueWithDefault( this.getType() , this.getUrl() );
 	}
-	
+
+	public boolean isSvg() {
+		return TYPE_SVG.equals( this.getResolvedType() );
+	}
+
 }
diff --git a/fj-doc-base/src/main/resources/META-INF/native-image/org.fugerit.java/fj-doc-base/reflect-config.json b/fj-doc-base/src/main/resources/META-INF/native-image/org.fugerit.java/fj-doc-base/reflect-config.json
@@ -1155,6 +1155,9 @@
   }, {
     "name" : "hashCode",
     "parameterTypes" : [ ]
+  }, {
+    "name" : "isSvg",
+    "parameterTypes" : [ ]
   }, {
     "name" : "notify",
     "parameterTypes" : [ ]
diff --git a/fj-doc-base/src/main/resources/config/doc-2-1.xsd b/fj-doc-base/src/main/resources/config/doc-2-1.xsd
@@ -6,7 +6,7 @@
 	 *
 	 * @project    : fj-doc-base
 	 * @creation   : 2023-08-18
-	 * @version    : 2.1.0-rc.2 (2024-10-14)
+	 * @version    : 2.1.0-rc.3 (2025-03-22)
 	 *
 	 * XSD for fugerit doc configuration
 	 */
@@ -543,6 +543,7 @@
 			<xsd:enumeration value="png"></xsd:enumeration>
 			<xsd:enumeration value="jpg"></xsd:enumeration>
 			<xsd:enumeration value="gif"></xsd:enumeration>
+			<xsd:enumeration value="svg"></xsd:enumeration>
 		</xsd:restriction>
 	</xsd:simpleType>
 
diff --git a/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/model/TestDocImage.java b/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/model/TestDocImage.java
@@ -16,6 +16,9 @@ void testElement1() {
 		Assertions.assertEquals( DocImage.TYPE_JPG, image.getResolvedType() );
 		image.setType( DocImage.TYPE_PNG );
 		Assertions.assertEquals( DocImage.TYPE_PNG, image.getResolvedType() );
+		Assertions.assertFalse( image.isSvg() );
+		image.setType( DocImage.TYPE_SVG );
+		Assertions.assertTrue( image.isSvg() );
 		log.info( "accepted types : {}", DocImage.getAcceptedImageTypes() );
 	}
 	
diff --git a/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/config/FreeMarkerConfigStep.java b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/config/FreeMarkerConfigStep.java
@@ -152,6 +152,7 @@ public int process(DocProcessContext context, DocProcessData data) throws Except
 			map.put(CleanXmlFun.DEFAULT_NAME, new CleanXmlFun());
 			map.put(CleanTextFun.DEFAULT_NAME, new CleanTextFun());
 			map.put(FormatLocalDateTimeFun.DEFAULT_NAME, new FormatLocalDateTimeFun());
+			map.put(Base64ToStringFun.DEFAULT_NAME, new Base64ToStringFun());
 		}
 		return res;
 	}
diff --git a/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/Base64ToStringFun.java b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/Base64ToStringFun.java
@@ -0,0 +1,22 @@
+package org.fugerit.java.doc.freemarker.fun;
+
+import freemarker.template.SimpleScalar;
+import freemarker.template.TemplateMethodModelEx;
+import freemarker.template.TemplateModelException;
+import freemarker.template.TemplateScalarModel;
+
+import java.util.Base64;
+import java.util.List;
+
+public class Base64ToStringFun implements TemplateMethodModelEx {
+
+	public static final String DEFAULT_NAME = "base64ToString";
+
+	@Override
+	public Object exec(@SuppressWarnings("rawtypes") List arguments) throws TemplateModelException {
+		FMFunHelper.checkParameterNumber( arguments, 1 );
+		String base64 = ((TemplateScalarModel)arguments.get( 0 )).getAsString();
+		return new SimpleScalar( new String( Base64.getDecoder().decode( base64 ) ) );
+	}
+	
+}
diff --git a/fj-doc-freemarker/src/main/resources/META-INF/native-image/org.fugerit.java/fj-doc-freemarker/reflect-config.json b/fj-doc-freemarker/src/main/resources/META-INF/native-image/org.fugerit.java/fj-doc-freemarker/reflect-config.json
@@ -1792,6 +1792,42 @@
     "name" : "wait",
     "parameterTypes" : [ "long", "int" ]
   } ]
+}, {
+  "name" : "org.fugerit.java.doc.freemarker.fun.Base64ToStringFun",
+  "methods" : [ {
+    "name" : "<init>",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "equals",
+    "parameterTypes" : [ "java.lang.Object" ]
+  }, {
+    "name" : "exec",
+    "parameterTypes" : [ "java.util.List" ]
+  }, {
+    "name" : "getClass",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "hashCode",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "notify",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "notifyAll",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "toString",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "wait",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "wait",
+    "parameterTypes" : [ "long" ]
+  }, {
+    "name" : "wait",
+    "parameterTypes" : [ "long", "int" ]
+  } ]
 }, {
   "name" : "org.fugerit.java.doc.freemarker.fun.CleanTextFun",
   "methods" : [ {
diff --git a/fj-doc-freemarker/src/test/resources/fj_doc_test/freemarker-doc-process_alt.xml b/fj-doc-freemarker/src/test/resources/fj_doc_test/freemarker-doc-process_alt.xml
@@ -25,6 +25,7 @@
 			<function name="imageBase64CLFun" value="org.fugerit.java.doc.freemarker.fun.ImageBase64CLFun"/>
 			<function name="messageFormat" value="org.fugerit.java.doc.freemarker.fun.SimpleMessageFun"/>
 			<function name="sumLong" value="org.fugerit.java.doc.freemarker.fun.SimpleSumLongFun"/>
+			<function name="base64ToString" value="org.fugerit.java.doc.freemarker.fun.Base64ToStringFun"/>
 		</chainStep>
 	</docChain>
 
diff --git a/fj-doc-freemarker/src/test/resources/fj_doc_test/template/test_01.ftl b/fj-doc-freemarker/src/test/resources/fj_doc_test/template/test_01.ftl
@@ -61,6 +61,8 @@
   
   		<para style="bold">italic ${sumLong(10, 20)}</para>
 
+		<para style="bold">base64ToString ${base64ToString('VEVTVA==')}</para>
+
 		<image url="png" base64="${imageBase64CLFun()}" scaling="25"/>
 
   		<para style="bold">italic ${messageFormat()}</para>
diff --git a/fj-doc-mod-fop/src/main/resources/fj_doc_mod_fop_config/fm-fop-process-config.xml b/fj-doc-mod-fop/src/main/resources/fj_doc_mod_fop_config/fm-fop-process-config.xml
@@ -24,6 +24,9 @@
 				wrap-unchecked-exceptions="true"
 			/>
 		</chainStep>
+		<chainStep stepType="function">
+			<function name="base64ToString" value="org.fugerit.java.doc.freemarker.fun.Base64ToStringFun"/>
+		</chainStep>
 		<chainStep stepType="map">
 			<map name="docBase" value="docBase"/>
 			<map name="docType" value="docType"/>
diff --git a/fj-doc-mod-fop/src/main/resources/fj_doc_mod_fop_config/template/macro/doc_element.ftl b/fj-doc-mod-fop/src/main/resources/fj_doc_mod_fop_config/template/macro/doc_element.ftl
@@ -54,14 +54,17 @@
 </#macro>
 
 <#macro handleImage docImage>
-	<#if (docImage.scaling)??>
-		<#assign imageScaling="height='${docImage.scaling}%' content-height='${docImage.scaling}%' content-width='scale-to-fit' scaling='uniform' width='${docImage.scaling}%'"/>
-	<#else>
-		<#assign imageScaling=""/>
-	</#if>
 	<fo:block <@handleAlign alignValue=docImage.align/>>
-		<fo:external-graphic <#if (docImage.alt)??> fox:alt-text="${docImage.alt}" </#if> ${imageScaling} xmlns:fo="http://www.w3.org/1999/XSL/Format"
-			src="data:image;base64,${docImage.resolvedBase64}"/>
+		<#if docImage.svg>
+			<fo:instream-foreign-object xmlns:svg="http://www.w3.org/2000/svg">${base64ToString(docImage.resolvedBase64)}</fo:instream-foreign-object>
+		<#else>
+			<#if (docImage.scaling)??>
+				<#assign imageScaling="height='${docImage.scaling}%' content-height='${docImage.scaling}%' content-width='scale-to-fit' scaling='uniform' width='${docImage.scaling}%'"/>
+			<#else>
+				<#assign imageScaling=""/>
+			</#if>
+			<fo:external-graphic <#if (docImage.alt)??> fox:alt-text="${docImage.alt}" </#if> ${imageScaling} xmlns:fo="http://www.w3.org/1999/XSL/Format" src="data:image;base64,${docImage.resolvedBase64}"/>
+		</#if>
 	</fo:block>
 </#macro>
 
diff --git a/fj-doc-mod-fop/src/test/resources/sample/doc_alt_01.xml b/fj-doc-mod-fop/src/test/resources/sample/doc_alt_01.xml
@@ -10,6 +10,9 @@
   </metadata>
   <body>
     <h head-level="1">Alternative sample doc</h>
+    <para><image type="svg" scaling="50" alt="Test SGV"
+                 base64="PHN2ZyBoZWlnaHQ9IjEwMHB4IiB3aWR0aD0iMTAwcHgiIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIAoJIHZpZXdCb3g9IjAgMCA1MTIuMDAxIDUxMi4wMDEiIHhtbDpzcGFjZT0icHJlc2VydmUiPgo8Zz4KCTxwYXRoIHN0eWxlPSJmaWxsOiNGRkM4NTU7IiBkPSJNMjU2Ljk1NSwwLjA1bC03MS41Niw0NTguOTQ1TDEyLjA2OSw0ODIuNjNjLTguNjMxLDEuMTc3LTE0LjkyNi03Ljk3MS0xMC43NDMtMTUuNjExTDI1Ni45NTUsMC4wNXoKCQkiLz4KCTxwYXRoIHN0eWxlPSJmaWxsOiNGRkM4NTU7IiBkPSJNMjU2Ljk1NSwwLjA1bDc4LjQ4LDQ1OC45NDVsMTY0LjQzLDIzLjQ5YzguNjM5LDEuMjM1LDE0Ljk5Mi03LjkwNiwxMC44MjUtMTUuNTczTDI1Ni45NTUsMC4wNXoiLz4KPC9nPgo8cG9seWdvbiBzdHlsZT0iZmlsbDojRkFBRjUwOyIgcG9pbnRzPSIyNTYuOTU1LDAuMDUgMjU2Ljk1NSw1MTEuOTUxIDMzNS40MzQsNDU4Ljk5NiAiLz4KPHBvbHlnb24gc3R5bGU9ImZpbGw6I0ZGRTE4MjsiIHBvaW50cz0iMjU2Ljk1NSwwLjA1IDE4NS4zOTQsNDU4Ljk5NiAyNTYuOTU1LDUxMS45NTEgIi8+Cjwvc3ZnPg=="/>
+    </para>
     <table space-before="30" columns="3" colwidths="30;30;40" id="excel-table" padding="2" width="100">
       <row>
         <cell align="center" back-color="#99aaee">

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@ void testElement1() {`
`16`	`16`	`Assertions.assertEquals( DocImage.TYPE_JPG, image.getResolvedType() );`
`17`	`17`	`image.setType( DocImage.TYPE_PNG );`
`18`	`18`	`Assertions.assertEquals( DocImage.TYPE_PNG, image.getResolvedType() );`
	`19`	`+ Assertions.assertFalse( image.isSvg() );`
	`20`	`+ image.setType( DocImage.TYPE_SVG );`
	`21`	`+ Assertions.assertTrue( image.isSvg() );`
`19`	`22`	`log.info( "accepted types : {}", DocImage.getAcceptedImageTypes() );`
`20`	`23`	`}`
`21`	`24`
Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,7 @@ public int process(DocProcessContext context, DocProcessData data) throws Except`
`152`	`152`	`map.put(CleanXmlFun.DEFAULT_NAME, new CleanXmlFun());`
`153`	`153`	`map.put(CleanTextFun.DEFAULT_NAME, new CleanTextFun());`
`154`	`154`	`map.put(FormatLocalDateTimeFun.DEFAULT_NAME, new FormatLocalDateTimeFun());`
	`155`	`+ map.put(Base64ToStringFun.DEFAULT_NAME, new Base64ToStringFun());`
`155`	`156`	`}`
`156`	`157`	`return res;`
`157`	`158`	`}`