You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2024/05/01 14:54:15 UTC
svn commit: r1917455 - in /pdfbox/branches/2.0/pdfbox/src: main/java/org/apache/pdfbox/multipdf/Splitter.java test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java
Author: tilman
Date: Wed May 1 14:54:14 2024
New Revision: 1917455
URL: http://svn.apache.org/viewvc?rev=1917455&view=rev
Log:
PDFBOX-5809: fix references for popup annotations and their parent, clone if needed
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Splitter.java
pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Splitter.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Splitter.java?rev=1917455&r1=1917454&r2=1917455&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Splitter.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Splitter.java Wed May 1 14:54:14 2024
@@ -53,6 +53,8 @@ import org.apache.pdfbox.pdmodel.interac
import org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination;
@@ -718,6 +720,13 @@ public class Splitter
pageDictMap.put(page.getCOSObject(), imported.getCOSObject());
}
+ /**
+ * Clone all annotations because of changes possibly made, and because the structure tree is
+ * cloned.
+ *
+ * @param imported
+ * @throws IOException
+ */
private void processAnnotations(PDPage imported) throws IOException
{
List<PDAnnotation> annotations = imported.getAnnotations();
@@ -790,6 +799,60 @@ public class Splitter
annotationClone.setPage(imported);
}
}
+ // Second loop for markup and popup annotations, which reference annotations themselves
+ for (PDAnnotation annotation : clonedAnnotations)
+ {
+ if (annotation instanceof PDAnnotationMarkup)
+ {
+ PDAnnotationPopup annotationPopup = ((PDAnnotationMarkup) annotation).getPopup();
+ COSDictionary clonedPopupDict = annotDictMap.get(annotationPopup.getCOSObject());
+ if (clonedPopupDict != null)
+ {
+ annotation.getCOSObject().setItem(COSName.POPUP, clonedPopupDict);
+ }
+ else
+ {
+ // orphan popup (not in annotation list); clone it and fix references
+ clonedPopupDict = new COSDictionary(annotationPopup.getCOSObject());
+ annotDictMap.put(annotationPopup.getCOSObject(), clonedPopupDict);
+ PDAnnotationPopup annotationPopupClone =
+ (PDAnnotationPopup) PDAnnotation.createAnnotation(clonedPopupDict);
+ annotationPopupClone.setParent((PDAnnotationMarkup) annotation);
+ ((PDAnnotationMarkup) annotation).setPopup(annotationPopupClone);
+ if (annotationPopupClone.getPage() != null)
+ {
+ annotationPopupClone.setPage(imported);
+ }
+ }
+ }
+ if (annotation instanceof PDAnnotationPopup)
+ {
+ PDAnnotationMarkup annotationMarkup = ((PDAnnotationPopup) annotation).getParent();
+ if (annotationMarkup == null)
+ {
+ continue;
+ }
+ COSDictionary clonedMarkupDict = annotDictMap.get(annotationMarkup.getCOSObject());
+ if (clonedMarkupDict != null)
+ {
+ annotation.getCOSObject().setItem(COSName.PARENT, clonedMarkupDict);
+ }
+ else
+ {
+ // orphan markup (not in annotation list); clone it and fix references
+ clonedMarkupDict = new COSDictionary(annotationMarkup.getCOSObject());
+ annotDictMap.put(annotationMarkup.getCOSObject(), clonedMarkupDict);
+ PDAnnotationMarkup annotationMarkupClone =
+ (PDAnnotationMarkup) PDAnnotation.createAnnotation(clonedMarkupDict);
+ annotationMarkupClone.setPopup((PDAnnotationPopup) annotation);
+ ((PDAnnotationPopup) annotation).setParent(annotationMarkupClone);
+ if (annotationMarkupClone.getPage() != null)
+ {
+ annotationMarkupClone.setPage(imported);
+ }
+ }
+ }
+ }
imported.setAnnotations(clonedAnnotations);
}
Modified: pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java?rev=1917455&r1=1917454&r2=1917455&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/multipdf/PDFMergerUtilityTest.java Wed May 1 14:54:14 2024
@@ -51,6 +51,8 @@ import org.apache.pdfbox.pdmodel.documen
import org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination;
@@ -1091,4 +1093,37 @@ public class PDFMergerUtilityTest extend
}
doc.close();
}
+
+ public void testSplitWithPopupAnnotations() throws IOException
+ {
+ PDDocument doc = PDDocument.load(new File(SRCDIR, "PDFBOX-5809-509329.pdf"));
+ Splitter splitter = new Splitter();
+ splitter.setStartPage(3);
+ splitter.setEndPage(3);
+ splitter.setSplitAtPage(1);
+ List<PDDocument> splitResult = splitter.split(doc);
+ assertEquals(1, splitResult.size());
+ PDDocument dstDoc = splitResult.get(0);
+ checkForPageOrphans(dstDoc);
+ assertEquals(1, dstDoc.getNumberOfPages());
+ List<PDAnnotation> annotations = dstDoc.getPage(0).getAnnotations();
+ assertEquals(5, annotations.size());
+ PDAnnotationText annotationText3 = (PDAnnotationText) annotations.get(3);
+ PDAnnotationPopup annotationPopup4 = (PDAnnotationPopup) annotations.get(4);
+ assertEquals(annotationText3.getPopup(), annotationPopup4);
+ assertEquals(annotationPopup4.getParent(), annotationText3);
+ assertEquals(annotationText3.getPage(), dstDoc.getPage(0));
+ dstDoc.close();
+
+ // Check that source document is ok
+ annotations = doc.getPage(2).getAnnotations();
+ assertEquals(5, annotations.size());
+ annotationText3 = (PDAnnotationText) annotations.get(3);
+ annotationPopup4 = (PDAnnotationPopup) annotations.get(4);
+ assertEquals(annotationText3.getPopup(), annotationPopup4);
+ assertEquals(annotationPopup4.getParent(), annotationText3);
+ assertEquals(annotationText3.getPage(), doc.getPage(2));
+
+ doc.close();
+ }
}