DFR-3327-PDF-Documents-missing-signatures-Bulk-Print

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/service/DocumentConversionService.java

@@ -8,7 +8,12 @@
 import org.apache.pdfbox.Loader;
 import org.apache.pdfbox.io.IOUtils;
 import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDPageContentStream;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream;
 import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
+import org.apache.pdfbox.util.Matrix;
 import org.apache.tika.Tika;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.core.io.FileSystemResource;
@@ -26,6 +31,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.util.List;
 import java.util.Optional;
 
 @Service
@@ -73,6 +79,7 @@ public byte[] flattenPdfDocument(byte[] document) {
 
             if (acroForm.isPresent()) {
                 acroForm.get().flatten();
+                flattenAnnotations(doc);
                 doc.save(bos);
                 doc.close();
                 return bos.toByteArray();
@@ -85,6 +92,41 @@ public byte[] flattenPdfDocument(byte[] document) {
         return document;
     }
 
+    private void flattenAnnotations(PDDocument doc) throws IOException {
+        for (PDPage page : doc.getPages()) {
+            List<PDAnnotation> annotations = page.getAnnotations();
+            for (PDAnnotation annotation : annotations) {
+                PDAppearanceStream appearanceStream = annotation.getNormalAppearanceStream();
+                if (appearanceStream != null) {
+                    transformAnnotationsToContentStream(doc, page, annotation, appearanceStream);
+                }
+            }
+            annotations.clear();
+        }
+    }
+
+    private void transformAnnotationsToContentStream(PDDocument doc, PDPage page, PDAnnotation annotation,
+                                                     PDAppearanceStream appearanceStream) throws IOException {
+        float appearanceWidth = (float) appearanceStream.getBBox().getWidth();
+        float appearanceHeight = (float) appearanceStream.getBBox().getHeight();
+
+        if (appearanceWidth > 0 && appearanceHeight > 0) {
+            try (PDPageContentStream contentStream =
+                     new PDPageContentStream(doc, page, PDPageContentStream.AppendMode.APPEND,
+                         true, true)) {
+                contentStream.saveGraphicsState();
+                float x = (float) annotation.getRectangle().getLowerLeftX();
+                float y = (float) annotation.getRectangle().getLowerLeftY();
+                float width = (float) annotation.getRectangle().getWidth();
+                float height = (float) annotation.getRectangle().getHeight();
+                Matrix transformation = new Matrix(width / appearanceWidth, 0, 0, height / appearanceHeight, x, y);
+                contentStream.transform(transformation);
+                contentStream.drawForm(appearanceStream);
+                contentStream.restoreGraphicsState();
+            }
+        }
+    }
+
     private byte[] convert(Document sourceDocument, String auth) {
         try {
             String filename = getConvertedFilename(sourceDocument.getFileName());

src/test/java/uk/gov/hmcts/reform/finrem/caseorchestration/service/documentgenerator/DocumentConversionServiceTest.java

@@ -3,6 +3,8 @@
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.pdfbox.Loader;
 import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
 import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
 import org.junit.Before;
 import org.junit.Test;
@@ -24,6 +26,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.List;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
@@ -89,6 +92,39 @@ public void testFlattenPdfDocument() throws IOException {
         }
     }
 
+    @Test
+    public void testFlattenAnnotations() throws IOException {
+
+        byte[] editedPdfBytes = loadResource("/fixtures/D11Annotations.pdf");
+
+        // Ensure the original PDF has an AcroForm and at least one form field
+        try (PDDocument originalDoc = Loader.loadPDF(editedPdfBytes)) {
+            PDAcroForm originalAcroForm = originalDoc.getDocumentCatalog().getAcroForm();
+            assertNotNull("Document should have an AcroForm", originalAcroForm);
+            for (PDPage page : originalDoc.getPages()) {
+                List<PDAnnotation> annotations = page.getAnnotations();
+                assertFalse("Document should have Annotations", annotations.isEmpty());
+            }
+        }
+
+        // Flatten the PDF using the method under test
+        byte[] flattenedPdfBytes = documentConversionService.flattenPdfDocument(editedPdfBytes);
+
+        // Load the flattened PDF for validation
+        try (PDDocument document = Loader.loadPDF(flattenedPdfBytes)) {
+            for (PDPage page : document.getPages()) {
+                List<PDAnnotation> annotations = page.getAnnotations();
+                assertTrue("Annotations were not removed after flattening.", annotations.isEmpty());
+            }
+        }
+
+        // Load the flattened PDF and check that form fields have been removed/flattened
+        try (PDDocument flattenedDoc = Loader.loadPDF(flattenedPdfBytes)) {
+            PDAcroForm flattenedAcroForm = flattenedDoc.getDocumentCatalog().getAcroForm();
+            assertTrue("AcroForm should be flattened", ObjectUtils.isEmpty(flattenedAcroForm.getFields()));
+        }
+    }
+
     @Test
     public void doNotFlattenPdfDocumentWithNoFromLayer() throws IOException {