Get rid of own merge fields logic in PdfPageFormCopier logic and use the one from form fields

DEVSIX-7389

Autoported commit.
Original commit hash: [37b2549fa]

Author: vitali-pr

itext.tests/itext.forms.tests/itext/forms/FormFieldFlatteningTest.cs

@@ -203,7 +203,7 @@ private static void FillTextFieldsThenFlattenThenCompare(String testName) {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 5)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 4)]
         public virtual void FlattenReadOnly() {
             //Logging is expected since there are duplicate field names
             PdfWriter writer = new PdfWriter(new MemoryStream());

itext.tests/itext.forms.tests/itext/forms/FormFieldsTaggingTest.cs

@@ -151,6 +151,33 @@ public virtual void FormFieldTaggingTest07() {
             CompareOutput(outFileName, cmpFileName);
         }
 
+        [NUnit.Framework.Test]
+        public virtual void MergeFieldTaggingTest08() {
+            String outFileName = destinationFolder + "mergeFieldTaggingTest08.pdf";
+            String cmpFileName = sourceFolder + "cmp_mergeFieldTaggingTest08.pdf";
+            String srcFileName = sourceFolder + "mergeFieldTaggingTest08.pdf";
+            using (PdfDocument pdfDoc = new PdfDocument(new PdfReader(srcFileName), new PdfWriter(outFileName))) {
+                pdfDoc.SetTagged();
+                PdfAcroForm form = PdfAcroForm.GetAcroForm(pdfDoc, true);
+                AddFormFieldsToDocument(pdfDoc, form);
+            }
+            CompareOutput(outFileName, cmpFileName);
+        }
+
+        [NUnit.Framework.Test]
+        public virtual void MergeFieldTaggingTest09() {
+            String outFileName = destinationFolder + "mergeFieldTaggingTest09.pdf";
+            String cmpFileName = sourceFolder + "cmp_mergeFieldTaggingTest09.pdf";
+            using (PdfDocument pdfDoc = new PdfDocument(new PdfWriter(outFileName))) {
+                pdfDoc.SetTagged();
+                PdfAcroForm form = PdfAcroForm.GetAcroForm(pdfDoc, true);
+                AddFormFieldsToDocument(pdfDoc, form);
+                AddFormFieldsToDocument(pdfDoc, form);
+            }
+            CompareOutput(outFileName, cmpFileName);
+            CompareOutput(outFileName, sourceFolder + "cmp_mergeFieldTaggingTest08.pdf");
+        }
+
         private void AddFormFieldsToDocument(PdfDocument pdfDoc, PdfAcroForm acroForm) {
             Rectangle rect = new Rectangle(36, 700, 20, 20);
             Rectangle rect1 = new Rectangle(36, 680, 20, 20);

itext.tests/itext.forms.tests/itext/forms/PdfAcroFormTest.cs

@@ -262,6 +262,7 @@ public virtual void FieldKidsWithTheSameNamesTest() {
         }
 
         [NUnit.Framework.Test]
+        [LogMessage(FormsLogMessageConstants.FORM_FIELD_MUST_HAVE_A_NAME)]
         public virtual void NamelessFieldTest() {
             using (PdfDocument outputDoc = CreateDocument()) {
                 outputDoc.AddNewPage();
@@ -275,6 +276,7 @@ public virtual void NamelessFieldTest() {
                 PdfPage page = outputDoc.GetLastPage();
                 e = NUnit.Framework.Assert.Catch(typeof(PdfException), () => acroForm.AddField(field, page));
                 NUnit.Framework.Assert.AreEqual(FormsExceptionMessageConstant.FORM_FIELD_MUST_HAVE_A_NAME, e.Message);
+                acroForm.AddField(field, page, false);
                 NUnit.Framework.Assert.AreEqual(0, acroForm.GetDirectFormFields().Count);
             }
         }

itext.tests/itext.forms.tests/itext/forms/PdfFormCopyTest.cs

@@ -42,7 +42,7 @@ public static void BeforeClass() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 32)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 14)]
         public virtual void CopyFieldsTest01() {
             String srcFilename1 = sourceFolder + "appearances1.pdf";
             String srcFilename2 = sourceFolder + "fieldsOn2-sPage.pdf";
@@ -132,7 +132,7 @@ public virtual void CopyFieldsTest05() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 12)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 9)]
         public virtual void CopyMultipleSubfieldsTest01() {
             String srcFilename = sourceFolder + "copyMultipleSubfieldsTest01.pdf";
             String destFilename = destinationFolder + "copyMultipleSubfieldsTest01.pdf";
@@ -195,7 +195,7 @@ public virtual void CopyMultipleSubfieldsTest03() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 12)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 9)]
         public virtual void CopyMultipleSubfieldsSmartModeTest01() {
             String srcFilename = sourceFolder + "copyMultipleSubfieldsSmartModeTest01.pdf";
             String destFilename = destinationFolder + "copyMultipleSubfieldsSmartModeTest01.pdf";
@@ -218,7 +218,7 @@ public virtual void CopyMultipleSubfieldsSmartModeTest01() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 13)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 14)]
         public virtual void CopyFieldsTest06() {
             String srcFilename = sourceFolder + "datasheet.pdf";
             String destFilename = destinationFolder + "copyFields06.pdf";
@@ -236,7 +236,7 @@ public virtual void CopyFieldsTest06() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 13)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 14)]
         public virtual void CopyFieldsTest07() {
             String srcFilename = sourceFolder + "datasheet.pdf";
             String destFilename = destinationFolder + "copyFields07.pdf";
@@ -254,7 +254,7 @@ public virtual void CopyFieldsTest07() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 32)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 14)]
         public virtual void CopyFieldsTest08() {
             String srcFilename1 = sourceFolder + "appearances1.pdf";
             String srcFilename2 = sourceFolder + "fieldsOn2-sPage.pdf";
@@ -349,7 +349,6 @@ public virtual void CopyFieldsTest12() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD)]
         public virtual void CopyFieldsTest13() {
             String srcFilename = sourceFolder + "copyFields13.pdf";
             String destFilename = destinationFolder + "copyFields13.pdf";
@@ -393,7 +392,7 @@ public virtual void UnnamedFieldsHierarchyTest() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 51)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 45)]
         public virtual void CopyAndEditTextFields() {
             String srcFileName = sourceFolder + "checkPdfFormCopy_Source.pdf";
             String destFilename = destinationFolder + "copyAndEditTextFields.pdf";
@@ -417,7 +416,7 @@ public virtual void CopyAndEditTextFields() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 51)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 45)]
         public virtual void CopyAndEditCheckboxes() {
             String srcFileName = sourceFolder + "checkPdfFormCopy_Source.pdf";
             String destFilename = destinationFolder + "copyAndEditCheckboxes.pdf";
@@ -439,7 +438,7 @@ public virtual void CopyAndEditCheckboxes() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 51)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 45)]
         public virtual void CopyAndEditRadioButtons() {
             String srcFileName = sourceFolder + "checkPdfFormCopy_Source.pdf";
             String destFilename = destinationFolder + "copyAndEditRadioButtons.pdf";
@@ -481,7 +480,7 @@ public virtual void MergeMergedFieldAndMergedFieldTest() {
         }
 
         [NUnit.Framework.Test]
-        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 2)]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 1)]
         public virtual void MergeMergedFieldAndTwoWidgetsTest() {
             String srcFileName1 = sourceFolder + "fieldMergedWithWidget.pdf";
             String srcFileName2 = sourceFolder + "fieldTwoWidgets.pdf";
@@ -535,6 +534,7 @@ public virtual void MergeTwoWidgetsAndMergedFieldTest() {
         }
 
         [NUnit.Framework.Test]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD)]
         public virtual void MergeTwoWidgetsAndTwoWidgetsTest() {
             String srcFileName2 = sourceFolder + "fieldTwoWidgets.pdf";
             String destFilename = destinationFolder + "mergeTwoWidgetsAndTwoWidgetsTest.pdf";
@@ -555,6 +555,23 @@ public virtual void MergeTwoWidgetsAndTwoWidgetsTest() {
                 , "diff_"));
         }
 
+        [NUnit.Framework.Test]
+        [LogMessage(iText.IO.Logs.IoLogMessageConstant.DOCUMENT_ALREADY_HAS_FIELD, Count = 2)]
+        public virtual void ComplexFieldsHierarchyTest() {
+            String srcFileName = sourceFolder + "complexFieldsHierarchyTest.pdf";
+            String destFilename = destinationFolder + "complexFieldsHierarchyTest.pdf";
+            String cmpFileName = sourceFolder + "cmp_complexFieldsHierarchyTest.pdf";
+            using (PdfDocument pdfDocMerged = new PdfDocument(new PdfReader(srcFileName), new PdfWriter(destFilename))
+                ) {
+                using (PdfDocument pdfDoc = new PdfDocument(new PdfReader(srcFileName))) {
+                    pdfDoc.CopyPagesTo(1, pdfDoc.GetNumberOfPages(), pdfDocMerged, new PdfPageFormCopier());
+                    pdfDoc.CopyPagesTo(1, pdfDoc.GetNumberOfPages(), pdfDocMerged, new PdfPageFormCopier());
+                }
+            }
+            NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(destFilename, cmpFileName, destinationFolder
+                , "diff_"));
+        }
+
         [NUnit.Framework.Test]
         public virtual void WidgetContainsNoTEntryTest() {
             String sourceFileName = sourceFolder + "fieldThreeWidgets.pdf";

itext.tests/itext.forms.tests/resources/itext/forms/FormFieldsTaggingTest/cmp_mergeFieldTaggingTest08.pdf

@@ -225,22 +225,38 @@ public virtual void AddField(PdfFormField field) {
         /// <see cref="iText.Kernel.Pdf.PdfPage"/>
         /// on which to add the field
         /// </param>
-        /// <param name="replaceExisted">
-        /// if true then the existed form field will be replaced by a new one
-        /// in case they have the same names
+        public virtual void AddField(PdfFormField field, PdfPage page) {
+            AddField(field, page, true);
+        }
+
+        /// <summary>This method adds the field to a specific page.</summary>
+        /// <param name="field">
+        /// the
+        /// <see cref="iText.Forms.Fields.PdfFormField"/>
+        /// to be added to the form
         /// </param>
-        public virtual void AddField(PdfFormField field, PdfPage page, bool replaceExisted) {
+        /// <param name="page">
+        /// the
+        /// <see cref="iText.Kernel.Pdf.PdfPage"/>
+        /// on which to add the field
+        /// </param>
+        /// <param name="throwExceptionOnError">true if the exception is expected to be thrown in case of error.</param>
+        public virtual void AddField(PdfFormField field, PdfPage page, bool throwExceptionOnError) {
             if (!field.GetPdfObject().ContainsKey(PdfName.T)) {
-                throw new PdfException(FormsExceptionMessageConstant.FORM_FIELD_MUST_HAVE_A_NAME);
-            }
-            if (!replaceExisted) {
-                PdfFormFieldMergeUtil.MergeKidsWithSameNames(field, true);
+                if (throwExceptionOnError) {
+                    throw new PdfException(FormsExceptionMessageConstant.FORM_FIELD_MUST_HAVE_A_NAME);
+                }
+                else {
+                    LOGGER.LogWarning(FormsLogMessageConstants.FORM_FIELD_MUST_HAVE_A_NAME);
+                    return;
+                }
             }
+            PdfFormFieldMergeUtil.MergeKidsWithSameNames(field, throwExceptionOnError);
             PdfDictionary fieldDict = field.GetPdfObject();
             // PdfPageFormCopier expects that we replace existed field by a new one in case they have the same names.
             String fieldName = field.GetFieldName().ToUnicodeString();
-            if (replaceExisted || !fields.ContainsKey(fieldName) || !PdfFormFieldMergeUtil.MergeTwoFieldsWithTheSameNames
-                (fields.Get(fieldName), field, true)) {
+            if (!fields.ContainsKey(fieldName) || !PdfFormFieldMergeUtil.MergeTwoFieldsWithTheSameNames(fields.Get(fieldName
+                ), field, throwExceptionOnError)) {
                 PdfArray fieldsArray = GetFields();
                 fieldsArray.Add(fieldDict);
                 fieldsArray.SetModified();
@@ -253,21 +269,6 @@ public virtual void AddField(PdfFormField field, PdfPage page, bool replaceExist
             SetModified();
         }
 
-        /// <summary>This method adds the field to a specific page.</summary>
-        /// <param name="field">
-        /// the
-        /// <see cref="iText.Forms.Fields.PdfFormField"/>
-        /// to be added to the form
-        /// </param>
-        /// <param name="page">
-        /// the
-        /// <see cref="iText.Kernel.Pdf.PdfPage"/>
-        /// on which to add the field
-        /// </param>
-        public virtual void AddField(PdfFormField field, PdfPage page) {
-            AddField(field, page, false);
-        }
-
         /// <summary>
         /// This method merges field with its annotation and places it on the given
         /// page.