Syncronize DA and DR. Retrieve FormField's font.

The key idea is that DA and appearance stream may have different names in resources.
Simplify resource merging with regenerating default appearance and default resources during coping.
Initialize FormFields's PdfFont and fontsize in constructor.
PdfPageFormCopier won't keep existing DA and will regenerate it based on given properties.
Replace getPdfObject().put() with just put(), it will set modified state.
Remove redundant private methods in PdfAcroForm and PdfFormField.
Set autosize for checkbox, keep DA for push buttons and choice fields.

DEVSIX-2875
DEVSIX-2016

Author: pavel-alay

barcodes/pom.xml

@@ -1,14 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
+
   <parent>
     <groupId>com.itextpdf</groupId>
     <artifactId>root</artifactId>
     <version>7.1.7-SNAPSHOT</version>
   </parent>
+
   <artifactId>barcodes</artifactId>
+
   <name>iText 7 - barcodes</name>
   <url>https://itextpdf.com/</url>
+
   <dependencies>
     <dependency>
       <groupId>com.itextpdf</groupId>
@@ -22,6 +26,7 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
+
   <build>
     <plugins>
       <plugin>

font-asian/pom.xml

@@ -1,12 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
+
   <parent>
     <groupId>com.itextpdf</groupId>
     <artifactId>root</artifactId>
     <version>7.1.7-SNAPSHOT</version>
   </parent>
+
   <artifactId>font-asian</artifactId>
+
   <name>iText 7 - Asian fonts</name>
   <description>iText Asian fonts for use in conjunction with iText 7, a free Java-PDF library</description>
   <url>https://itextpdf.com/</url>
@@ -15,6 +18,7 @@
       <name>Various licenses (see individual files)</name>
     </license>
   </licenses>
+
   <build>
     <plugins>
       <plugin>

forms/pom.xml

@@ -1,14 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
+
   <parent>
     <groupId>com.itextpdf</groupId>
     <artifactId>root</artifactId>
     <version>7.1.7-SNAPSHOT</version>
   </parent>
+
   <artifactId>forms</artifactId>
+
   <name>iText 7 - forms</name>
   <url>https://itextpdf.com/</url>
+
   <dependencies>
     <dependency>
       <groupId>com.itextpdf</groupId>
@@ -20,6 +24,12 @@
       <artifactId>layout</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>com.itextpdf</groupId>
+      <artifactId>font-asian</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>com.itextpdf</groupId>
       <artifactId>pdftest</artifactId>
@@ -41,6 +51,7 @@
       <optional>true</optional>
     </dependency>
   </dependencies>
+
   <build>
     <plugins>
       <plugin>

forms/src/main/java/com/itextpdf/forms/PdfAcroForm.java

@@ -69,19 +69,16 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.tagutils.TagReference;
 import com.itextpdf.kernel.pdf.tagutils.TagTreePointer;
 import com.itextpdf.kernel.pdf.xobject.PdfFormXObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
-import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
-import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * This class represents the static form technology AcroForm on a PDF file.
  */
@@ -134,10 +131,10 @@ public class PdfAcroForm extends PdfObjectWrapper<PdfDictionary> {
      */
     protected PdfDocument document;
 
-    private static PdfName[] resourceNames = {PdfName.Font, PdfName.XObject, PdfName.ColorSpace, PdfName.Pattern};
     private PdfDictionary defaultResources;
     private Set<PdfFormField> fieldsForFlattening = new LinkedHashSet<>();
     private XfaForm xfaForm;
+    private static Logger logger = LoggerFactory.getLogger(PdfAcroForm.class);
 
     /**
      * Creates a PdfAcroForm as a wrapper of a dictionary.
@@ -235,17 +232,6 @@ public void addField(PdfFormField field, PdfPage page) {
             iterateFields(field.getKids(), fields);
         }
 
-        //There's an issue described in DEVSIX-573. When you create multiple fields with different fonts those font may
-        // have same names (F1, F2, etc). So only first of them will be save in default resources.
-        if (field.getFormType() != null && (field.getFormType().equals(PdfName.Tx) || field.getFormType().equals(PdfName.Ch))) {
-            List<PdfDictionary> resources = getResources(field.getPdfObject());
-            for (PdfDictionary resDict : resources) {
-                mergeResources(defaultResources, resDict);
-            }
-            if (!defaultResources.isEmpty()) {
-                put(PdfName.DR, defaultResources);
-            }
-        }
         if (fieldDic.containsKey(PdfName.Subtype) && page != null) {
             PdfAnnotation annot = PdfAnnotation.makeAnnotation(fieldDic);
             addWidgetAnnotationToPage(page, annot);
@@ -285,7 +271,6 @@ public void addFieldAppearanceToPage(PdfFormField field, PdfPage page) {
     public Map<String, PdfFormField> getFormFields() {
         if (fields.size() == 0) {
             fields = iterateFields(getFields());
-
         }
         return fields;
     }
@@ -647,7 +632,7 @@ public void flattenFields() {
             initialPageResourceClones.put(i, resources == null ? null : resources.clone());
         }
 
-        Set<PdfPage> wrappedPages = new LinkedHashSet<PdfPage>();
+        Set<PdfPage> wrappedPages = new LinkedHashSet<>();
         PdfPage page;
         for (PdfFormField field : fields) {
             PdfDictionary fieldObject = field.getPdfObject();
@@ -676,58 +661,54 @@ public void flattenFields() {
                     appDic = fieldObject.getAsDictionary(PdfName.AP);
                 }
             }
-            if (null != appDic) {
-                PdfObject normal = appDic.get(PdfName.N);
-                if (null == normal) {
-                    Logger logger = LoggerFactory.getLogger(PdfAcroForm.class);
-                    logger.error(LogMessageConstant.N_ENTRY_IS_REQUIRED_FOR_APPEARANCE_DICTIONARY);
-                } else {
-                    PdfFormXObject xObject = null;
-                    if (normal.isStream()) {
-                        xObject = new PdfFormXObject((PdfStream) normal);
-                    } else if (normal.isDictionary()) {
-                        PdfName as = fieldObject.getAsName(PdfName.AS);
-                        if (((PdfDictionary) normal).getAsStream(as) != null) {
-                            xObject = new PdfFormXObject(((PdfDictionary) normal).getAsStream(as));
-                            xObject.makeIndirect(document);
-                        }
+            PdfObject normal = appDic != null ? appDic.get(PdfName.N) : null;
+            if (null != normal) {
+                PdfFormXObject xObject = null;
+                if (normal.isStream()) {
+                    xObject = new PdfFormXObject((PdfStream) normal);
+                } else if (normal.isDictionary()) {
+                    PdfName as = fieldObject.getAsName(PdfName.AS);
+                    if (((PdfDictionary) normal).getAsStream(as) != null) {
+                        xObject = new PdfFormXObject(((PdfDictionary) normal).getAsStream(as));
+                        xObject.makeIndirect(document);
                     }
+                }
+
+                if (xObject != null) {
+                    //subtype is required field for FormXObject, but can be omitted in normal appearance.
+                    xObject.put(PdfName.Subtype, PdfName.Form);
+                    Rectangle annotBBox = fieldObject.getAsRectangle(PdfName.Rect);
+                    if (page.isFlushed()) {
+                        throw new PdfException(PdfException.PageAlreadyFlushedUseAddFieldAppearanceToPageMethodBeforePageFlushing);
+                    }
+                    PdfCanvas canvas = new PdfCanvas(page, !wrappedPages.contains(page));
+                    wrappedPages.add(page);
+
+                    // Here we avoid circular reference which might occur when page resources and the appearance xObject's
+                    // resources are the same object
+                    PdfObject xObjectResources = xObject.getPdfObject().get(PdfName.Resources);
+                    PdfObject pageResources = page.getResources().getPdfObject();
+                    if (xObjectResources != null && xObjectResources == pageResources) {
+                        xObject.getPdfObject().put(PdfName.Resources, initialPageResourceClones.get(document.getPageNumber(page)));
+                    }
+
+                    if (tagPointer != null) {
+                        tagPointer.setPageForTagging(page);
+                        TagReference tagRef = tagPointer.getTagReference();
+                        canvas.openTag(tagRef);
+                    }
+
+                    AffineTransform at = calcFieldAppTransformToAnnotRect(xObject, annotBBox);
+                    float[] m = new float[6];
+                    at.getMatrix(m);
+                    canvas.addXObject(xObject, m[0], m[1], m[2], m[3], m[4], m[5]);
 
-                    if (xObject != null) {
-                        //subtype is required field for FormXObject, but can be omitted in normal appearance.
-                        xObject.put(PdfName.Subtype, PdfName.Form);
-                        Rectangle annotBBox = fieldObject.getAsRectangle(PdfName.Rect);
-                        if (page.isFlushed()) {
-                            throw new PdfException(PdfException.PageAlreadyFlushedUseAddFieldAppearanceToPageMethodBeforePageFlushing);
-                        }
-                        PdfCanvas canvas = new PdfCanvas(page, !wrappedPages.contains(page));
-                        wrappedPages.add(page);
-
-                        // Here we avoid circular reference which might occur when page resources and the appearance xObject's
-                        // resources are the same object
-                        PdfObject xObjectResources = xObject.getPdfObject().get(PdfName.Resources);
-                        PdfObject pageResources = page.getResources().getPdfObject();
-                        if (xObjectResources != null && pageResources != null &&
-                                xObjectResources == pageResources) {
-                            xObject.getPdfObject().put(PdfName.Resources, initialPageResourceClones.get(document.getPageNumber(page)));
-                        }
-
-                        if (tagPointer != null) {
-                            tagPointer.setPageForTagging(page);
-                            TagReference tagRef = tagPointer.getTagReference();
-                            canvas.openTag(tagRef);
-                        }
-
-                        AffineTransform at = calcFieldAppTransformToAnnotRect(xObject, annotBBox);
-                        float[] m = new float[6];
-                        at.getMatrix(m);
-                        canvas.addXObject(xObject, m[0], m[1], m[2], m[3], m[4], m[5]);
-
-                        if (tagPointer != null) {
-                            canvas.closeTag();
-                        }
+                    if (tagPointer != null) {
+                        canvas.closeTag();
                     }
                 }
+            } else {
+                logger.error(LogMessageConstant.N_ENTRY_IS_REQUIRED_FOR_APPEARANCE_DICTIONARY);
             }
 
             PdfArray fFields = getFields();
@@ -839,10 +820,8 @@ public void renameField(String oldName, String newName) {
     public PdfFormField copyField(String name) {
         PdfFormField oldField = getField(name);
         if (oldField != null) {
-            PdfFormField field = new PdfFormField((PdfDictionary) oldField.getPdfObject().clone().makeIndirect(document));
-            return field;
+            return new PdfFormField((PdfDictionary) oldField.getPdfObject().clone().makeIndirect(document));
         }
-
         return null;
     }
 
@@ -866,7 +845,6 @@ public void replaceField(String name, PdfFormField field) {
     protected PdfArray getFields() {
         PdfArray fields = getPdfObject().getAsArray(PdfName.Fields);
         if (fields == null) {
-            Logger logger = LoggerFactory.getLogger(PdfAcroForm.class);
             logger.warn(LogMessageConstant.NO_FIELDS_IN_ACROFORM);
             fields = new PdfArray();
             getPdfObject().put(PdfName.Fields, fields);
@@ -883,7 +861,6 @@ private Map<String, PdfFormField> iterateFields(PdfArray array, Map<String, PdfF
         int index = 1;
         for (PdfObject field : array) {
             if (field.isFlushed()) {
-                Logger logger = LoggerFactory.getLogger(PdfAcroForm.class);
                 logger.warn(LogMessageConstant.FORM_FIELD_WAS_FLUSHED);
                 continue;
             }
@@ -987,62 +964,6 @@ private void addWidgetAnnotationToPage(PdfPage page, PdfAnnotation annot) {
         }
     }
 
-    private List<PdfDictionary> getResources(PdfDictionary field) {
-        List<PdfDictionary> resources = new ArrayList<>();
-
-        PdfDictionary ap = field.getAsDictionary(PdfName.AP);
-        if (ap != null && !ap.isFlushed()) {
-            PdfObject normal = ap.get(PdfName.N);
-            if (normal != null && !normal.isFlushed()) {
-                if (normal.isDictionary()) {
-                    for (PdfName key : ((PdfDictionary) normal).keySet()) {
-                        PdfStream appearance = ((PdfDictionary) normal).getAsStream(key);
-                        PdfDictionary resDict = appearance.getAsDictionary(PdfName.Resources);
-                        if (resDict != null) {
-                            resources.add(resDict);
-                            break;
-                        }
-                    }
-                } else if (normal.isStream()) {
-                    PdfDictionary resDict = ((PdfStream) normal).getAsDictionary(PdfName.Resources);
-                    if (resDict != null) {
-                        resources.add(resDict);
-                    }
-                }
-            }
-        }
-
-        PdfArray kids = field.getAsArray(PdfName.Kids);
-        if (kids != null) {
-            for (PdfObject kid : kids) {
-                resources.addAll(getResources((PdfDictionary) kid));
-            }
-        }
-
-        return resources;
-    }
-
-    /**
-     * Merges two dictionaries. When both dictionaries contain the same key,
-     * the value from the first dictionary is kept.
-     *
-     * @param result the {@link PdfDictionary} which may get extra entries from source
-     * @param source the {@link PdfDictionary} whose entries may be merged into result
-     */
-    private void mergeResources(PdfDictionary result, PdfDictionary source) {
-        for (PdfName name : resourceNames) {
-            PdfDictionary dic = source.isFlushed() ? null : source.getAsDictionary(name);
-            PdfDictionary res = result.getAsDictionary(name);
-            if (res == null) {
-                res = new PdfDictionary();
-            }
-            if (dic != null) {
-                res.mergeDifferent(dic);
-                result.put(name, res);
-            }
-        }
-    }
-
     /**
      * Determines whether the AcroForm contains XFA data.
      *