Merge pull request #524 from fugerit-org/523-chore-handling-producer-for-pdf-handlers

fugerit79 · web-flow · commit b246cf32aa49 · 2025-10-02T23:40:41.000+02:00
feat: handling producer #523
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- info 'doc-producer' <https://github.com/fugerit-org/fj-doc/issues/523>
+
 ## [8.16.6] - 2025-10-02
 
 ### Added
diff --git a/docs/html/doc_meta_info.html b/docs/html/doc_meta_info.html
diff --git a/fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/VenusVersion.java b/fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/VenusVersion.java
@@ -0,0 +1,36 @@
+package org.fugerit.java.doc.base.config;
+
+import org.fugerit.java.core.util.mvn.FJCoreMaven;
+import org.fugerit.java.core.util.mvn.MavenProps;
+
+import java.util.Optional;
+
+public class VenusVersion {
+
+    private VenusVersion() {}
+
+    public static final String FJ_DOC_BASE_ARTIFACT_ID = "fj-doc-base";
+
+    public static final String NOT_AVAILABLE = "NA";
+
+    public static final String VENUS_CREATOR = String.format( "%s (https://github.com/fugerit-org/fj-doc)", DocConfig.FUGERIT_VENUS_DOC );
+
+    public static final String VENUS_PRODUCER_FORMAT = "%s (%s) over %s (%s)";
+
+    public static Optional<String> getFjDocCoreVersion() {
+        return getFjDocModuleVersion( FJ_DOC_BASE_ARTIFACT_ID );
+    }
+
+    public static String getFjDocCoreVersionS() {
+        return getFjDocCoreVersion().orElse( NOT_AVAILABLE );
+    }
+
+    public static Optional<String> getFjDocModuleVersion( String artifactId ) {
+        return MavenProps.getPropertyOptional(FJCoreMaven.FJ_CORE_GROUP_ID, artifactId, MavenProps.VERSION );
+    }
+
+    public static String getFjDocModuleVersionS( String artifactId ) {
+        return getFjDocModuleVersion( artifactId ).orElse( NOT_AVAILABLE );
+    }
+
+}
diff --git a/fj-doc-base/src/main/java/org/fugerit/java/doc/base/model/DocBase.java b/fj-doc-base/src/main/java/org/fugerit/java/doc/base/model/DocBase.java
@@ -163,6 +163,10 @@ public String getInfoDocCreator() {
 		return this.getStableInfo().getProperty( DocInfo.INFO_DOC_CREATOR );
 	}
 
+    public String getInfoDocProducer() {
+        return this.getStableInfo().getProperty( DocInfo.INFO_DOC_PRODUCER );
+    }
+
 	public String getInfoDocLanguage() {
 		return this.getStableInfo().getProperty( DocInfo.INFO_DOC_LANGUAGE );
 	}
diff --git a/fj-doc-base/src/main/java/org/fugerit/java/doc/base/model/DocInfo.java b/fj-doc-base/src/main/java/org/fugerit/java/doc/base/model/DocInfo.java
@@ -61,6 +61,11 @@ public DocInfo() {
 	 * See {@link GenericConsts#INFO_KEY_DOC_CREATOR}.
 	 */
 	public static final String INFO_DOC_CREATOR = GenericConsts.INFO_KEY_DOC_CREATOR;
+
+    /**
+     * See {@link GenericConsts#INFO_KEY_DOC_PRODUCER}.
+     */
+    public static final String INFO_DOC_PRODUCER = GenericConsts.INFO_KEY_DOC_PRODUCER;
 	
 	/**
 	 * See {@link GenericConsts#INFO_KEY_DOC_LANGUAGE}.
diff --git a/fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehelper/generic/GenericConsts.java b/fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehelper/generic/GenericConsts.java
@@ -50,6 +50,13 @@ private GenericConsts() {}
 	 * @since 1.0
 	 */
 	public static final String INFO_KEY_DOC_CREATOR = "doc-creator";
+
+    /**
+     * <a href="https://venusdocs.fugerit.org/docs/html/doc_meta_info.html#doc-producer">See 'doc-producer' documentation</a>
+     *
+     * @since 1.0
+     */
+    public static final String INFO_KEY_DOC_PRODUCER = "doc-producer";
 	
 	/**
 	 * <a href="https://venusdocs.fugerit.org/docs/html/doc_meta_info.html#doc-language">See 'doc-language' documentation</a>
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
@@ -162,6 +162,9 @@
   }, {
     "name" : "getInfoDocLanguage",
     "parameterTypes" : [ ]
+  }, {
+    "name" : "getInfoDocProducer",
+    "parameterTypes" : [ ]
   }, {
     "name" : "getInfoDocSubject",
     "parameterTypes" : [ ]
@@ -3070,6 +3073,51 @@
     "name" : "wait",
     "parameterTypes" : [ "long", "int" ]
   } ]
+}, {
+  "condition" : {
+    "typeReachable" : "org.fugerit.java.doc.base.facade.DocFacadeSource"
+  },
+  "name" : "org.fugerit.java.doc.base.config.VenusVersion",
+  "methods" : [ {
+    "name" : "equals",
+    "parameterTypes" : [ "java.lang.Object" ]
+  }, {
+    "name" : "getClass",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "getFjDocCoreVersion",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "getFjDocCoreVersionS",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "getFjDocModuleVersion",
+    "parameterTypes" : [ "java.lang.String" ]
+  }, {
+    "name" : "getFjDocModuleVersionS",
+    "parameterTypes" : [ "java.lang.String" ]
+  }, {
+    "name" : "hashCode",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "notify",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "notifyAll",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "toString",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "wait",
+    "parameterTypes" : [ ]
+  }, {
+    "name" : "wait",
+    "parameterTypes" : [ "long" ]
+  }, {
+    "name" : "wait",
+    "parameterTypes" : [ "long", "int" ]
+  } ]
 }, {
   "condition" : {
     "typeReachable" : "org.fugerit.java.doc.base.facade.DocFacadeSource"
diff --git a/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/config/TestVenusVersion.java b/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/config/TestVenusVersion.java
@@ -0,0 +1,15 @@
+package test.org.fugerit.java.doc.base.config;
+
+import org.fugerit.java.doc.base.config.VenusVersion;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+class TestVenusVersion {
+
+    @Test
+    void testVersion() {
+        Assertions.assertNotNull( VenusVersion.getFjDocCoreVersionS() );
+        Assertions.assertNotNull( VenusVersion.getFjDocModuleVersionS( "fj-doc-base" ) );
+    }
+
+}
diff --git a/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/model/TestDocBase.java b/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/model/TestDocBase.java
@@ -38,6 +38,7 @@ void test1() {
 		log.info( "info 8 : {}", docBase.isUseFooter() );
 		log.info( "info 9 : {}", docBase.isUseHeader() );
 		log.info( "info 10 : {}", docBase.getInfoDocCreator() );
+        log.info( "info 11 : {}", docBase.getInfoDocProducer() );
 		docBase.setDocHeader( new DocHeader() );
 		docBase.setDocFooter( new DocFooter() );
 		log.info( "info 8 : {}", docBase.isUseFooter() );
diff --git a/fj-doc-guide/src/main/docs/asciidoc/chapters/03_4_doc_format_info.adoc b/fj-doc-guide/src/main/docs/asciidoc/chapters/03_4_doc_format_info.adoc
@@ -11,6 +11,8 @@ For instance in this document we set following _info_ elements :
 * doc-title
 * doc-author
 * doc-language
+* doc-creator
+* doc-producer
 
 Some DocHandler will ignore some info elements.
 
diff --git a/fj-doc-lib-autodoc/src/test/resources/docs/meta_xml/adm_standard_meta_info.xml b/fj-doc-lib-autodoc/src/test/resources/docs/meta_xml/adm_standard_meta_info.xml
@@ -72,7 +72,18 @@
       <admeta:supportedType>pdf</admeta:supportedType>
       <admeta:supportedHandler>fj-doc-freemarker(html)</admeta:supportedHandler>
       <admeta:supportedHandler>fj-doc-mod-fop(pdf)</admeta:supportedHandler>
-    </admeta:admMetaInfo>
+        <admeta:supportedHandler>fj-doc-mod-openpdf-ext(pdf)</admeta:supportedHandler>
+    </admeta:admMetaInfo>
+      <admeta:admMetaInfo>
+          <admeta:name>doc-producer</admeta:name>
+          <admeta:description>Set the document producer tool (es. Venus Doc), should be usually supported in document formats like html or pdf</admeta:description>
+          <admeta:since>8.16.7</admeta:since>
+          <admeta:supportedType>html</admeta:supportedType>
+          <admeta:supportedType>pdf</admeta:supportedType>
+          <admeta:supportedHandler>fj-doc-freemarker(html)</admeta:supportedHandler>
+          <admeta:supportedHandler>fj-doc-mod-fop(pdf)</admeta:supportedHandler>
+          <admeta:supportedHandler>fj-doc-mod-openpdf-ext(pdf)</admeta:supportedHandler>
+      </admeta:admMetaInfo>
     <admeta:admMetaInfo>
       <admeta:name>doc-language</admeta:name>
       <admeta:description>Set the document language, should be usually supported in document formats like html or pdf</admeta:description>
diff --git a/fj-doc-mod-fop/src/main/java/org/fugerit/java/doc/mod/fop/PdfFopTypeHandler.java b/fj-doc-mod-fop/src/main/java/org/fugerit/java/doc/mod/fop/PdfFopTypeHandler.java
@@ -22,13 +22,10 @@
 import org.fugerit.java.core.lang.helpers.BooleanUtils;
 import org.fugerit.java.core.lang.helpers.ClassHelper;
 import org.fugerit.java.core.lang.helpers.StringUtils;
+import org.fugerit.java.core.util.mvn.MavenProps;
 import org.fugerit.java.core.xml.dom.DOMIO;
 import org.fugerit.java.core.xml.dom.DOMUtils;
-import org.fugerit.java.doc.base.config.DocCharsetProvider;
-import org.fugerit.java.doc.base.config.DocConfig;
-import org.fugerit.java.doc.base.config.DocInput;
-import org.fugerit.java.doc.base.config.DocOutput;
-import org.fugerit.java.doc.base.config.DocTypeHandler;
+import org.fugerit.java.doc.base.config.*;
 import org.fugerit.java.doc.mod.fop.config.FopConfigClassLoaderWrapper;
 import org.w3c.dom.Element;
 import org.w3c.dom.NodeList;
@@ -121,6 +118,16 @@ public void setFopConfig(FopConfig fopConfig) {
 
 	private transient UnsafeConsumer<FopConfigWrap, ConfigException> fopWrapConsumer;
 
+	private static String getModuleVersion() {
+		return VenusVersion.getFjDocModuleVersionS( "fj-doc-mod-fop");
+	}
+
+	private static String getApacheFOPVersion() {
+		return MavenProps.getProperty( "org.apache.xmlgraphics", "fop", MavenProps.VERSION );
+	}
+
+	private static final String PRODUCER_DEFAULT = String.format( VenusVersion.VENUS_PRODUCER_FORMAT, DocConfig.FUGERIT_VENUS_DOC , getModuleVersion() , "Apache FOP", getApacheFOPVersion() );
+
 	public PdfFopTypeHandler( Charset charset, FopConfig fopConfig, boolean accessibility, boolean keepEmptyTags ) {
 		super( DocConfig.TYPE_PDF, charset );
 		this.fopConfig = fopConfig;
@@ -172,6 +179,8 @@ private FopConfigWrap newFopWrap() throws ConfigException {
 		}
 		foUserAgent.setAccessibility( this.isAccessibility() );
 		foUserAgent.setKeepEmptyTags( this.isKeepEmptyTags() );
+		foUserAgent.setProducer( PRODUCER_DEFAULT );
+		foUserAgent.setCreator( VenusVersion.VENUS_CREATOR );
 		return new FopConfigWrap( fopFactory, foUserAgent );
 	}
 
diff --git a/fj-doc-mod-fop/src/test/java/test/org/fugerit/java/doc/mod/fop/TestProducer.java b/fj-doc-mod-fop/src/test/java/test/org/fugerit/java/doc/mod/fop/TestProducer.java
@@ -0,0 +1,37 @@
+package test.org.fugerit.java.doc.mod.fop;
+
+import lombok.extern.slf4j.Slf4j;
+import org.fugerit.java.core.function.SafeFunction;
+import org.fugerit.java.core.lang.helpers.ClassHelper;
+import org.fugerit.java.doc.base.config.DocInput;
+import org.fugerit.java.doc.base.config.DocOutput;
+import org.fugerit.java.doc.base.config.DocTypeHandler;
+import org.fugerit.java.doc.mod.fop.FreeMarkerFopTypeHandlerUTF8;
+import org.fugerit.java.doc.mod.fop.InitFopHandler;
+import org.fugerit.java.doc.mod.fop.PdfFopTypeHandler;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import test.org.fugerit.java.BasicTest;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.InputStreamReader;
+
+@Slf4j
+class TestProducer extends BasicTest {
+
+	@Test
+	void testProducer() throws Exception {
+		DocTypeHandler handler = PdfFopTypeHandler.HANDLER;
+		String fileName = "doc_producer";
+		File outputFile = new File( String.format( "target/%s.%s", fileName, handler.getType() ) );
+		try ( InputStreamReader reader = new InputStreamReader( ClassHelper.loadFromDefaultClassLoader(  String.format( "sample/%s.xml", fileName ) ) );
+			  FileOutputStream fos = new FileOutputStream( outputFile ) ) {
+			handler.handle( DocInput.newInput( handler.getType(), reader ) , DocOutput.newOutput( fos ) );
+			log.info( "file {}", outputFile.getCanonicalFile() );
+			Assertions.assertTrue( outputFile.exists() );
+		}
+	}
+	
+}
diff --git a/fj-doc-mod-fop/src/test/resources/sample/doc_producer.xml b/fj-doc-mod-fop/src/test/resources/sample/doc_producer.xml
@@ -0,0 +1,19 @@
+<doc xmlns="http://javacoredoc.fugerit.org" 
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+	xsi:schemaLocation="http://javacoredoc.fugerit.org https://www.fugerit.org/data/java/doc/xsd/doc-2-1.xsd">
+  <metadata>
+    <info name="margins">10;10;10;30</info>
+    <info name="table-border-collapse">collapse</info>
+    <info name="doc-title">Apache FOP doc-producer</info>
+    <info name="doc-subject">Integration test for doc-producer info attribure</info>
+    <info name="doc-author">fugerit79</info>
+    <info name="doc-creator">My Creator</info>
+    <footer-ext>
+      <para align="center">Page ${currentPage}</para>
+    </footer-ext>
+  </metadata>
+  <body>
+    <h head-level="1">Producer doc sample</h>
+    <para>Test producer for FOP Module</para>
+  </body>
+</doc>
diff --git a/fj-doc-mod-openpdf-ext/src/main/java/org/fugerit/java/doc/mod/openpdf/ext/helpers/DocumentMetaHelper.java b/fj-doc-mod-openpdf-ext/src/main/java/org/fugerit/java/doc/mod/openpdf/ext/helpers/DocumentMetaHelper.java
@@ -3,17 +3,25 @@
 import com.lowagie.text.Document;
 import org.fugerit.java.core.function.SafeFunction;
 import org.fugerit.java.core.function.UnsafeConsumer;
+import org.fugerit.java.core.util.mvn.MavenProps;
 import org.fugerit.java.doc.base.config.DocConfig;
+import org.fugerit.java.doc.base.config.VenusVersion;
 import org.fugerit.java.doc.base.model.DocBase;
 import org.fugerit.java.doc.base.typehelper.generic.GenericConsts;
 
 public class DocumentMetaHelper {
 
     private DocumentMetaHelper() {}
 
-    public static final String CREATOR_DEFAULT = String.format( "%s (https://github.com/fugerit-org/fj-doc)", DocConfig.FUGERIT_VENUS_DOC );
+    private static String getModuleVersion() {
+        return VenusVersion.getFjDocModuleVersionS( "fj-doc-mod-openpdf-ext");
+    }
+
+    private static String getOpenPDFVersion() {
+        return MavenProps.getProperty( "com.github.librepdf", "openpdf", MavenProps.VERSION );
+    }
 
-    public static final String PRODUCER_DEFAULT = String.format( "%s over %s", DocConfig.FUGERIT_VENUS_DOC , Document.getProduct() );
+    private static final String PRODUCER_DEFAULT = String.format( VenusVersion.VENUS_PRODUCER_FORMAT, DocConfig.FUGERIT_VENUS_DOC , getModuleVersion() , Document.getProduct(), getOpenPDFVersion() );
 
     private static void metaWorker(String property, UnsafeConsumer<String, Exception> fun ) {
         SafeFunction.applyIfNotNull( property, () -> fun.accept( property ) );
@@ -34,9 +42,11 @@ public static void handleDocMeta(Document document, DocBase docBase) {
                 docBase.getStableInfo().getProperty(GenericConsts.INFO_KEY_DOC_LANGUAGE),
                 document::setDocumentLanguage );
         metaWorker(
-                docBase.getStableInfo().getProperty(GenericConsts.INFO_KEY_DOC_CREATOR, CREATOR_DEFAULT),
+                docBase.getStableInfo().getProperty(GenericConsts.INFO_KEY_DOC_CREATOR, VenusVersion.VENUS_CREATOR),
                 document::addCreator );
-        document.addProducer( PRODUCER_DEFAULT );
+        metaWorker(
+                docBase.getStableInfo().getProperty(GenericConsts.INFO_KEY_DOC_PRODUCER, PRODUCER_DEFAULT),
+                document::addProducer );
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -163,6 +163,10 @@ public String getInfoDocCreator() {`
`163`	`163`	`return this.getStableInfo().getProperty( DocInfo.INFO_DOC_CREATOR );`
`164`	`164`	`}`
`165`	`165`
	`166`	`+ public String getInfoDocProducer() {`
	`167`	`+ return this.getStableInfo().getProperty( DocInfo.INFO_DOC_PRODUCER );`
	`168`	`+ }`
	`169`	`+`
`166`	`170`	`public String getInfoDocLanguage() {`
`167`	`171`	`return this.getStableInfo().getProperty( DocInfo.INFO_DOC_LANGUAGE );`
`168`	`172`	`}`