Enable interactivity for form fields with identical names across multiple pages

DEVSIX-7738

Author: guustysebie

src/main/java/com/itextpdf/html2pdf/ConverterProperties.java

@@ -22,10 +22,10 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.html2pdf;
 
+import com.itextpdf.commons.actions.contexts.IMetaInfo;
 import com.itextpdf.html2pdf.attach.ITagWorkerFactory;
 import com.itextpdf.html2pdf.attach.impl.OutlineHandler;
 import com.itextpdf.html2pdf.css.apply.ICssApplierFactory;
-import com.itextpdf.commons.actions.contexts.IMetaInfo;
 import com.itextpdf.layout.font.FontProvider;
 import com.itextpdf.styledxmlparser.css.media.MediaDeviceDescription;
 import com.itextpdf.styledxmlparser.resolver.resource.IResourceRetriever;
@@ -326,8 +326,11 @@ public boolean isCreateAcroForm() {
      * If createAcroForm is set, then when the form is encountered in HTML, AcroForm will be created, otherwise
      * a visually identical, but not functional element will be created. Please bare in mind that the created
      * Acroform may visually differ a bit from the HTML one.
+     * <p>
+     * When enabling this acroform creation, it will disable the immediateFlushing property.
      *
      * @param createAcroForm true if an AcroForm needs to be created
+     *
      * @return the {@link ConverterProperties} instance
      */
     public ConverterProperties setCreateAcroForm(boolean createAcroForm) {

src/main/java/com/itextpdf/html2pdf/attach/impl/tags/HtmlTagWorker.java

@@ -31,6 +31,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.html2pdf.attach.util.WaitingInlineElementsHelper;
 import com.itextpdf.html2pdf.css.CssConstants;
 import com.itextpdf.html2pdf.html.AttributeConstants;
+import com.itextpdf.html2pdf.logs.Html2PdfLogMessageConstant;
 import com.itextpdf.io.font.PdfEncodings;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfString;
@@ -45,15 +46,24 @@ This file is part of the iText (R) project.
 import com.itextpdf.styledxmlparser.node.IElementNode;
 import com.itextpdf.styledxmlparser.node.INode;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * TagWorker class for the {@code html} element.
  */
 public class HtmlTagWorker implements ITagWorker {
 
-    /** The iText document instance. */
+    private static final Logger LOGGER = LoggerFactory.getLogger(HtmlTagWorker.class);
+
+    /**
+     * The iText document instance.
+     */
     private Document document;
 
-    /** Helper class for waiting inline elements. */
+    /**
+     * Helper class for waiting inline elements.
+     */
     private WaitingInlineElementsHelper inlineHelper;
 
     /**
@@ -65,14 +75,19 @@ public class HtmlTagWorker implements ITagWorker {
     public HtmlTagWorker(IElementNode element, ProcessorContext context) {
         // TODO DEVSIX-4261 more precise check if a counter was actually added to the document
         boolean immediateFlush =
-                context.isImmediateFlush() && !context.getCssContext().isPagesCounterPresent();
+                context.isImmediateFlush() && !context.getCssContext().isPagesCounterPresent()
+                        && !context.isCreateAcroForm();
+        if (context.isImmediateFlush() && context.isCreateAcroForm()) {
+            LOGGER.info(Html2PdfLogMessageConstant.IMMEDIATE_FLUSH_DISABLED);
+        }
         PdfDocument pdfDocument = context.getPdfDocument();
         document = new HtmlDocument(pdfDocument, pdfDocument.getDefaultPageSize(), immediateFlush);
         document.setRenderer(new HtmlDocumentRenderer(document, immediateFlush));
 
         DefaultHtmlProcessor.setConvertedRootElementProperties(element.getStyles(), context, document);
 
-        inlineHelper = new WaitingInlineElementsHelper(element.getStyles().get(CssConstants.WHITE_SPACE), element.getStyles().get(CssConstants.TEXT_TRANSFORM));
+        inlineHelper = new WaitingInlineElementsHelper(element.getStyles().get(CssConstants.WHITE_SPACE),
+                element.getStyles().get(CssConstants.TEXT_TRANSFORM));
 
         String lang = element.getAttribute(AttributeConstants.LANG);
         if (lang != null) {

src/main/java/com/itextpdf/html2pdf/logs/Html2PdfLogMessageConstant.java

@@ -172,6 +172,7 @@ public final class Html2PdfLogMessageConstant {
     public static final String ELEMENT_DOES_NOT_FIT_CURRENT_AREA = "Element does not fit current area";
     public static final String OPTGROUP_NOT_SUPPORTED_IN_INTERACTIVE_SELECT = "Option groups are not supported in "
             + "interactive mode";
+    public static final String IMMEDIATE_FLUSH_DISABLED = "Setting createAcroForm disables immediateFlush property";
 
     private Html2PdfLogMessageConstant() {
         //Private constructor will prevent the instantiation of this class directly

src/test/java/com/itextpdf/html2pdf/element/FormTest.java

@@ -27,19 +27,23 @@ This file is part of the iText (R) project.
 import com.itextpdf.forms.logs.FormsLogMessageConstants;
 import com.itextpdf.html2pdf.ConverterProperties;
 import com.itextpdf.html2pdf.HtmlConverter;
+import com.itextpdf.html2pdf.logs.Html2PdfLogMessageConstant;
 import com.itextpdf.io.logs.IoLogMessageConstant;
+import com.itextpdf.io.source.ByteArrayOutputStream;
 import com.itextpdf.io.util.UrlUtil;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfReader;
 import com.itextpdf.kernel.pdf.PdfWriter;
 import com.itextpdf.kernel.utils.CompareTool;
 import com.itextpdf.layout.logs.LayoutLogMessageConstant;
 import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.LogLevelConstants;
 import com.itextpdf.test.annotations.LogMessage;
 import com.itextpdf.test.annotations.LogMessages;
 import com.itextpdf.test.annotations.type.IntegrationTest;
 
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
 import org.junit.Assert;
 import org.junit.BeforeClass;
@@ -67,6 +71,41 @@ public void textFieldWithPlaceholderTest() throws IOException, InterruptedExcept
         runTest("textFieldWithPlaceholder");
     }
 
+    @Test
+    public void textFieldHeadersFootersTest() throws IOException, InterruptedException {
+        runTest("textFieldHeadersFooters");
+    }
+
+    @Test
+    public void textFieldHeadersFootersWithValueTest() throws IOException, InterruptedException {
+        runTest("textFieldHeadersFootersWithValue");
+    }
+
+    @Test
+    public void textAreaHeadersFootersWithValueTest() throws IOException, InterruptedException {
+        runTest("textAreaHeadersFooters");
+    }
+
+
+    @Test
+    public void checkBoxHeadersFootersWithValueTest() throws IOException, InterruptedException {
+        //TODO DEVSIX-7760 Adding formfield elements to header generates strange results
+        runTest("checkBoxHeadersFooters");
+    }
+
+    @Test
+    public void radioHeadersFootersWithValueTest() throws IOException, InterruptedException {
+        //TODO DEVSIX-7760 Adding formfield elements to header generates strange results
+        runTest("radioHeadersFooters");
+    }
+
+
+    @Test
+    public void dropDownHeadersFootersWithValueTest() throws IOException, InterruptedException {
+        runTest("dropDownHeadersFooters");
+    }
+
+
     @Test
     public void splitTextFieldTest() throws IOException, InterruptedException {
         runTest("splitTextField");
@@ -185,6 +224,7 @@ public void radiobox1Test() throws IOException, InterruptedException {
     public void radiobox2Test() throws IOException, InterruptedException {
         runTest("radiobox2");
     }
+
     @Test
     @LogMessages(messages = {
             @LogMessage(messageTemplate = IoLogMessageConstant.MULTIPLE_VALUES_ON_A_NON_MULTISELECT_FIELD)})
@@ -238,6 +278,57 @@ public void radioButtonNoPageCounterTest() throws IOException, InterruptedExcept
                 pdf, sourceFolder + "cmp_radioButtonNoPageCounter.pdf", destinationFolder));
     }
 
+    @Test
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.IMMEDIATE_FLUSH_DISABLED, logLevel =
+                    LogLevelConstants.INFO)})
+    public void checkLogInfo() throws IOException {
+        String html = sourceFolder + "radiobox1.html";
+        try (FileInputStream fileInputStream = new FileInputStream(html);
+                ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
+            HtmlConverter.convertToPdf(fileInputStream, baos,
+                    new ConverterProperties().setCreateAcroForm(true));
+        }
+    }
+
+    @Test
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.IMMEDIATE_FLUSH_DISABLED, logLevel =
+                    LogLevelConstants.INFO, count = 0)})
+    public void checkLogInfoNoAcroForm() throws IOException {
+        String html = sourceFolder + "radiobox1.html";
+        try (FileInputStream fileInputStream = new FileInputStream(html);
+                ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
+            HtmlConverter.convertToPdf(fileInputStream, baos,
+                    new ConverterProperties().setCreateAcroForm(false));
+        }
+    }
+
+    @Test
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.IMMEDIATE_FLUSH_DISABLED, logLevel =
+                    LogLevelConstants.INFO, count = 0)})
+    public void checkLogInfoAcroFormFlushDisabled() throws IOException {
+        String html = sourceFolder + "radiobox1.html";
+        try (FileInputStream fileInputStream = new FileInputStream(html);
+                ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
+            HtmlConverter.convertToPdf(fileInputStream, baos,
+                    new ConverterProperties().setCreateAcroForm(true).setImmediateFlush(false));
+        }
+    }
+
+    @Test
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.IMMEDIATE_FLUSH_DISABLED, logLevel =
+                    LogLevelConstants.INFO, count = 0)})
+    public void checkLogInfoDefault() throws IOException {
+        String html = sourceFolder + "radiobox1.html";
+        try (FileInputStream fileInputStream = new FileInputStream(html);
+                ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
+            HtmlConverter.convertToPdf(fileInputStream, baos);
+        }
+    }
+
     private void runTest(String name) throws IOException, InterruptedException {
         runTest(name, true);
     }
@@ -253,7 +344,8 @@ private void runTest(String name, boolean flattenPdfAcroFormFields) throws IOExc
         String diff = "diff_" + name + "_";
 
         HtmlConverter.convertToPdf(new File(htmlPath), new File(outPdfPath));
-        HtmlConverter.convertToPdf(new File(htmlPath), new File(outAcroPdfPath), new ConverterProperties().setCreateAcroForm(true));
+        HtmlConverter.convertToPdf(new File(htmlPath), new File(outAcroPdfPath),
+                new ConverterProperties().setCreateAcroForm(true));
         if (flattenPdfAcroFormFields) {
             PdfDocument document = new PdfDocument(new PdfReader(outAcroPdfPath), new PdfWriter(outAcroFlattenPdfPath));
             PdfAcroForm acroForm = PdfFormCreator.getAcroForm(document, false);
@@ -264,7 +356,9 @@ private void runTest(String name, boolean flattenPdfAcroFormFields) throws IOExc
         Assert.assertNull(new CompareTool().compareByContent(outPdfPath, cmpPdfPath, destinationFolder, diff));
         Assert.assertNull(new CompareTool().compareByContent(outAcroPdfPath, cmpAcroPdfPath, destinationFolder, diff));
         if (flattenPdfAcroFormFields) {
-            Assert.assertNull(new CompareTool().compareByContent(outAcroFlattenPdfPath, cmpAcroFlattenPdfPath, destinationFolder, diff));
+            Assert.assertNull(
+                    new CompareTool().compareByContent(outAcroFlattenPdfPath, cmpAcroFlattenPdfPath, destinationFolder,
+                            diff));
         }
     }
 }

src/test/java/com/itextpdf/html2pdf/element/TaggedPdfFormTest.java

@@ -126,8 +126,7 @@ public void fieldSetFormTagged()
     }
 
     @Test
-    // TODO DEVSIX-4601
-    // exception is thrown on "convert tagged PDF with acroform" stage
+    @Ignore("DEVSIX-4601 exception is thrown on \"convert tagged PDF with acroform\" stage")
     public void inputFormPrematureFlush()
             throws IOException, InterruptedException, ParserConfigurationException, SAXException {
         junitExpectedException.expect(PdfException.class);

src/test/java/com/itextpdf/html2pdf/element/TagsInsideButtonTest.java

@@ -23,18 +23,17 @@ This file is part of the iText (R) project.
 package com.itextpdf.html2pdf.element;
 
 import com.itextpdf.html2pdf.ExtendedHtmlConversionITextTest;
-import com.itextpdf.kernel.exceptions.PdfException;
 import com.itextpdf.test.annotations.type.IntegrationTest;
+
+import java.io.IOException;
+import javax.xml.parsers.ParserConfigurationException;
 import org.junit.BeforeClass;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 import org.junit.rules.ExpectedException;
 import org.xml.sax.SAXException;
 
-import javax.xml.parsers.ParserConfigurationException;
-import java.io.IOException;
-
 @Category(IntegrationTest.class)
 public class TagsInsideButtonTest extends ExtendedHtmlConversionITextTest {
 
@@ -87,7 +86,6 @@ public void buttonWithPInsideTagged()
     @Test
     public void buttonInsideMoreThanTwoAreas()
             throws IOException, InterruptedException, ParserConfigurationException, SAXException {
-        junitExpectedException.expect(PdfException.class);
         convertToPdfAcroformFlattenAndCompare("buttonInsideMoreThanTwoAreas", sourceFolder,
                 destinationFolder, true);
     }