Move all logic from PdfA/UaDocuments to pluggalbe mechanisms into PdfDocument

DEVSIX-8623

Author: introfog

kernel/src/main/java/com/itextpdf/kernel/pdf/DefaultFontStrategy.java

@@ -0,0 +1,71 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2024 Apryse Group NV
+    Authors: Apryse Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.kernel.pdf;
+
+import com.itextpdf.io.logs.IoLogMessageConstant;
+import com.itextpdf.kernel.font.PdfFont;
+import com.itextpdf.kernel.font.PdfFontFactory;
+
+import java.io.IOException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * The class defines a default font strategy for {@link PdfDocument}
+ * which is used in the scope of {@link PdfDocument#getDefaultFont()}.
+ */
+public class DefaultFontStrategy {
+    private final PdfDocument pdfDocument;
+    private PdfFont defaultFont = null;
+
+    /**
+     * Instantiates a new instance of {@link DefaultFontStrategy} which
+     * will be used for passed {@link PdfDocument} instance.
+     *
+     * @param pdfDocument the pdf document for which the strategy will be used to
+     */
+    public DefaultFontStrategy(PdfDocument pdfDocument) {
+        this.pdfDocument = pdfDocument;
+    }
+
+    /**
+     * Gets default font.
+     *
+     * @return the {@link PdfFont} instance
+     */
+    public PdfFont getFont() {
+        if (defaultFont == null) {
+            try {
+                defaultFont = PdfFontFactory.createFont();
+                if (pdfDocument.getWriter() != null) {
+                    defaultFont.makeIndirect(pdfDocument);
+                }
+            } catch (IOException e) {
+                Logger logger = LoggerFactory.getLogger(DefaultFontStrategy.class);
+                logger.error(IoLogMessageConstant.EXCEPTION_WHILE_CREATING_DEFAULT_FONT, e);
+                defaultFont = null;
+            }
+        }
+        return defaultFont;
+    }
+}

kernel/src/main/java/com/itextpdf/kernel/pdf/DocumentInfoHelper.java

@@ -0,0 +1,47 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2024 Apryse Group NV
+    Authors: Apryse Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.kernel.pdf;
+
+/**
+ * The class is helper which used inside {@link PdfDocument} to properly configure PDF document's info dictionary.
+ */
+public class DocumentInfoHelper {
+    /**
+     * If document info dictionary should be added to the trailer.
+     *
+     * @return {@code true} if should be added, otherwise {@code false}
+     */
+    public boolean shouldAddDocumentInfoToTrailer() {
+        return true;
+    }
+
+    /**
+     * Adjusts document info before it's flushing and adding to the trailer
+     * if required, see {@link #shouldAddDocumentInfoToTrailer()}.
+     *
+     * @param documentInfo the {@link PdfDocumentInfo} instance to adjust
+     */
+    public void adjustDocumentInfo(PdfDocumentInfo documentInfo) {
+        // do nothing
+    }
+}

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfConformance.java

@@ -25,6 +25,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.xmp.XMPConst;
 import com.itextpdf.kernel.xmp.XMPException;
 import com.itextpdf.kernel.xmp.XMPMeta;
+import com.itextpdf.kernel.xmp.XMPMetaFactory;
+import com.itextpdf.kernel.xmp.XMPUtils;
+import com.itextpdf.kernel.xmp.options.PropertyOptions;
 import com.itextpdf.kernel.xmp.properties.XMPProperty;
 
 /**
@@ -192,6 +195,46 @@ public static PdfConformance getConformance(XMPMeta meta) {
         return new PdfConformance(aLevel, uaLevel);
     }
 
+    /**
+     * Sets required fields into XMP metadata according to passed PDF conformance.
+     *
+     * @param xmpMeta the xmp metadata to which required PDF conformance fields will be set
+     * @param conformance the PDF conformance according to which XMP will be updated
+     *
+     * @throws XMPException if the file is not well-formed XML or if the parsing fails
+     */
+    public static void setConformanceToXmp(XMPMeta xmpMeta, PdfConformance conformance) throws XMPException {
+        if (conformance == null) {
+            return;
+        }
+        // Don't set any property if property value was set, so if
+        // smth was invalid in source document, it will be left as is.
+        // But if e.g. for PDF/A-4 revision wasn't specified, we will fix it.
+        if (conformance.isPdfUA()) {
+            if (xmpMeta.getProperty(XMPConst.NS_PDFUA_ID, XMPConst.PART) == null) {
+                xmpMeta.setPropertyInteger(XMPConst.NS_PDFUA_ID, XMPConst.PART, 1,
+                        new PropertyOptions(PropertyOptions.SEPARATE_NODE));
+            }
+        }
+        if (conformance.isPdfA()) {
+            final PdfAConformance aLevel = conformance.getAConformance();
+            if (xmpMeta.getProperty(XMPConst.NS_PDFA_ID, XMPConst.PART) == null) {
+                xmpMeta.setProperty(XMPConst.NS_PDFA_ID, XMPConst.PART, aLevel.getPart());
+            }
+            if (aLevel.getLevel() != null && xmpMeta.getProperty(XMPConst.NS_PDFA_ID, XMPConst.CONFORMANCE) == null) {
+                xmpMeta.setProperty(XMPConst.NS_PDFA_ID, XMPConst.CONFORMANCE, aLevel.getLevel());
+            }
+            if ("4".equals(aLevel.getPart()) && xmpMeta.getProperty(XMPConst.NS_PDFA_ID, XMPConst.REV) == null) {
+                xmpMeta.setProperty(XMPConst.NS_PDFA_ID, XMPConst.REV, PdfConformance.PDF_A_4_REVISION);
+            }
+
+            if (xmpMeta.getPropertyInteger(XMPConst.NS_PDFUA_ID, XMPConst.PART) != null) {
+                XMPMeta taggedExtensionMeta = XMPMetaFactory.parseFromString(PDF_UA_EXTENSION);
+                XMPUtils.appendProperties(taggedExtensionMeta, xmpMeta, true, false);
+            }
+        }
+    }
+
     /**
      * Gets an instance of {@link PdfAConformance} based on passed part and level.
      *
@@ -257,4 +300,44 @@ private static PdfUAConformance getUAConformance(String part) {
         }
         return null;
     }
+
+    private static final String PDF_UA_EXTENSION =
+            "    <x:xmpmeta xmlns:x=\"adobe:ns:meta/\">\n" +
+                    "      <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\">\n" +
+                    "        <rdf:Description rdf:about=\"\" xmlns:pdfaExtension=\"http://www.aiim.org/pdfa/ns/extension/\" xmlns:pdfaSchema=\"http://www.aiim.org/pdfa/ns/schema#\" xmlns:pdfaProperty=\"http://www.aiim.org/pdfa/ns/property#\">\n" +
+                    "          <pdfaExtension:schemas>\n" +
+                    "            <rdf:Bag>\n" +
+                    "              <rdf:li rdf:parseType=\"Resource\">\n" +
+                    "                <pdfaSchema:namespaceURI rdf:resource=\"http://www.aiim.org/pdfua/ns/id/\"/>\n" +
+                    "                <pdfaSchema:prefix>pdfuaid</pdfaSchema:prefix>\n" +
+                    "                <pdfaSchema:schema>PDF/UA identification schema</pdfaSchema:schema>\n" +
+                    "                <pdfaSchema:property>\n" +
+                    "                  <rdf:Seq>\n" +
+                    "                    <rdf:li rdf:parseType=\"Resource\">\n" +
+                    "                      <pdfaProperty:category>internal</pdfaProperty:category>\n" +
+                    "                      <pdfaProperty:description>PDF/UA version identifier</pdfaProperty:description>\n" +
+                    "                      <pdfaProperty:name>part</pdfaProperty:name>\n" +
+                    "                      <pdfaProperty:valueType>Integer</pdfaProperty:valueType>\n" +
+                    "                    </rdf:li>\n" +
+                    "                    <rdf:li rdf:parseType=\"Resource\">\n" +
+                    "                      <pdfaProperty:category>internal</pdfaProperty:category>\n" +
+                    "                      <pdfaProperty:description>PDF/UA amendment identifier</pdfaProperty:description>\n" +
+                    "                      <pdfaProperty:name>amd</pdfaProperty:name>\n" +
+                    "                      <pdfaProperty:valueType>Text</pdfaProperty:valueType>\n" +
+                    "                    </rdf:li>\n" +
+                    "                    <rdf:li rdf:parseType=\"Resource\">\n" +
+                    "                      <pdfaProperty:category>internal</pdfaProperty:category>\n" +
+                    "                      <pdfaProperty:description>PDF/UA corrigenda identifier</pdfaProperty:description>\n" +
+                    "                      <pdfaProperty:name>corr</pdfaProperty:name>\n" +
+                    "                      <pdfaProperty:valueType>Text</pdfaProperty:valueType>\n" +
+                    "                    </rdf:li>\n" +
+                    "                  </rdf:Seq>\n" +
+                    "                </pdfaSchema:property>\n" +
+                    "              </rdf:li>\n" +
+                    "            </rdf:Bag>\n" +
+                    "          </pdfaExtension:schemas>\n" +
+                    "        </rdf:Description>\n" +
+                    "      </rdf:RDF>\n" +
+                    "    </x:xmpmeta>";
+
 }