Support for base64 images (added in itext and fop renderer)

Author: fugerit79

fj-doc-base/src/main/java/org/fugerit/java/doc/base/helper/SourceResolverHelper.java

@@ -5,21 +5,40 @@
 import org.apache.commons.codec.binary.Base64;
 import org.fugerit.java.core.io.StreamIO;
 import org.fugerit.java.core.io.helper.StreamHelper;
+import org.fugerit.java.core.lang.helpers.StringUtils;
+import org.fugerit.java.doc.base.model.DocImage;
 
 public class SourceResolverHelper {
 
 	public static final String MODE_CLASSLOADER = StreamHelper.PATH_CLASSLOADER;
 
-	public static final String MODE_BASE64 = "base64://";
+	public static String resolveImageToBase64( DocImage img ) throws Exception {
+		String path = img.getUrl();
+		String base64 = img.getBase64();
+		if ( StringUtils.isEmpty( base64 ) && path != null ) {
+			byte[] data = null;
+			if ( path.startsWith( StreamHelper.PATH_CLASSLOADER ) ) {
+				data = StreamIO.readBytes( StreamHelper.resolveStream( path ) );
+			} else {
+				URL url = new URL( path );
+				data = StreamIO.readBytes( url.openConnection().getInputStream() );
+			}
+			base64 = Base64.encodeBase64String( data );
+		} else {
+			throw new Exception( "Null path and base64 provided!" );
+		}
+		return base64;
+	}
 
-	public static byte[] resolveByte( String path ) throws Exception {
+	public static byte[] resolveImage( DocImage img ) throws Exception {
 		byte[] data = null;
-		if ( path != null ) {
+		String path = img.getUrl();
+		String base64 = img.getBase64();
+		if ( StringUtils.isNotEmpty( base64 ) ) {
+			data = Base64.decodeBase64( base64 );
+		} else if ( path != null ) {
 			if ( path.startsWith( StreamHelper.PATH_CLASSLOADER ) ) {
 				data = StreamIO.readBytes( StreamHelper.resolveStream( path ) );
-			} else if ( path.startsWith( MODE_BASE64 ) ) {
-				String base64 = path.substring( MODE_BASE64.length() );
-				data = Base64.decodeBase64( base64 );
 			} else {
 				URL url = new URL( path );
 				data = StreamIO.readBytes( url.openConnection().getInputStream() );

fj-doc-base/src/main/java/org/fugerit/java/doc/base/model/DocImage.java

@@ -25,6 +25,9 @@ The Apache Software Foundation (http://www.apache.org/).
  */
 package org.fugerit.java.doc.base.model;
 
+import org.fugerit.java.core.lang.helpers.StringUtils;
+import org.fugerit.java.doc.base.helper.SourceResolverHelper;
+
 /**
  * 
  *
@@ -36,6 +39,8 @@ public class DocImage extends DocElement {
 	private Integer scaling;
 
 	private String url;
+	
+	private String base64;
 
 	/**
 	 * @return the url
@@ -64,5 +69,21 @@ public Integer getScaling() {
 	public void setScaling(Integer scaling) {
 		this.scaling = scaling;
 	}
+
+	public String getBase64() {
+		return base64;
+	}
+
+	public void setBase64(String base64) {
+		this.base64 = base64;
+	}
+	
+	public String getResolvedBase64() throws Exception {
+		String res = this.getBase64();
+		if ( StringUtils.isEmpty( res ) ) {
+			res = SourceResolverHelper.resolveImageToBase64( this );
+		}
+		return res;
+	}
 
 }

fj-doc-base/src/main/java/org/fugerit/java/doc/base/xml/DocContentHandler.java

@@ -31,6 +31,7 @@ The Apache Software Foundation (http://www.apache.org/).
 import java.util.LinkedList;
 import java.util.Properties;
 
+import org.fugerit.java.core.lang.helpers.StringUtils;
 import org.fugerit.java.doc.base.model.DocBarcode;
 import org.fugerit.java.doc.base.model.DocBase;
 import org.fugerit.java.doc.base.model.DocBorders;
@@ -286,6 +287,10 @@ public void startElement(String uri, String localName, String qName, Attributes
 			} else {
 				docImage.setScaling( null );
 			}
+			String base64 = props.getProperty( "base64" );
+			if ( StringUtils.isNotEmpty( base64 ) ) {
+				docImage.setBase64( base64 );
+			}
 			this.currentElement = docImage;			
 		} else if ( "para".equalsIgnoreCase( qName ) ) {
 			DocPara docPara = new DocPara();

fj-doc-base/src/main/resources/config/doc-1-0.xsd

@@ -6,7 +6,7 @@
 	 *
 	 * @project    : org.fugerit.java.doc.base
 	 * @creation   : 2019-11-06
-	 * @version    : 1.0.3 (2019-11-27)
+	 * @version    : 1.0.4 (2019-11-29)
 	 *
 	 * XSD for fugerit doc configuration
 	 */
@@ -140,10 +140,12 @@
 						cl://pathinjar (Path inside the class loader, safest way to load the image)
 						http://imageurl (but generating machine should be able to access the url)
 						file://imagepath (Path should be absolute, but you can use, for instance, free marker templating to make it more generic.)
+						In case of base64 just provide the tyoe (png,jpg etc.)
 					</xsd:documentation>
 				</xsd:annotation>
 			</xsd:attribute>
 			<xsd:attribute name='scaling' type='xsd:int' use='optional' />
+			<xsd:attribute name='base64' type="xsd:string" use='optional' />
 		</xsd:complexType>
 	</xsd:element>
 

fj-doc-mod-fop/src/main/resources/fm_fop/template/macro/doc_element.xml

@@ -8,12 +8,24 @@
 	<#elseif elementType = 'DocPara'>
 		<fo:block <@handleStyle styleValue=current.style/> font-size="${defaultFontSize}pt">${current.text}</fo:block>
 	<#elseif elementType = 'DocTable'>
-		<@handleTable docTable=current/>			
+		<@handleTable docTable=current/>
+	<#elseif elementType = 'DocImage'>
+		<@handleImage docImage=current/>					
 	<#else>
 		<fo:block space-after="5mm" font-weight="bold" font-size="${defaultFontSize}pt">Element type non implemented yet : ${elementType}</fo:block>
 	</#if>
 </#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:external-graphic xmlns:fo="http://www.w3.org/1999/XSL/Format" 
+		src="data:image;base64,${docImage.resolvedBase64}" ${imageScaling}/>
+</#macro>
+
 <#macro handleTable docTable>
 	<fo:block font-size="10pt">
 		<fo:table border-collapse="separate" width="${docTable.width}%" table-layout="fixed">

fj-doc-mod-itext/src/main/java/org/fugerit/java/doc/mod/itext/ITextDocHandler.java

@@ -189,7 +189,7 @@ protected static Image createImage( DocImage docImage ) throws Exception {
 		Image image = null;
 		String url = docImage.getUrl();
 		try {
-			byte[] data = SourceResolverHelper.resolveByte( url );
+			byte[] data = SourceResolverHelper.resolveImage( docImage );
 			image = Image.getInstance( data );
 			if ( docImage.getScaling() != null ) {
 				image.scalePercent( docImage.getScaling().floatValue() );

fj-doc-sample/src/main/resources/free_marker/test_01.xml

@@ -29,9 +29,11 @@
 
   		<phrase>Test template page apache free marker</phrase>
 
-  		<image url="cl://test/img_test.png" scaling="100"/>
+  		<image url="cl://test/img_test_green.png" scaling="100"/>
 
-  		<image url="base64://${testBase64Img}" scaling="25"/>	
+  		<image url="cl://test/img_test_red.png" scaling="50"/>
+  
+  		<image url="png" base64="${testBase64Img}" scaling="25"/>	
 
     	<table columns="3" colwidths="30;30;40"  width="100" id="excel-table" padding="2">
     		<row>