PDFBOX-6049: introduce new adjustRotation option

git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1927718 13f79535-47bb-0310-9956-ffa450edef68

Author: THausherr

pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java

@@ -67,6 +67,7 @@ public enum Position
     }
 
     private LayoutPage defaultOverlayPage;
+    private final Map<Integer,LayoutPage> rotatedDefaultOverlayPagesMap = new HashMap<>();
     private LayoutPage firstPageOverlayPage;
     private LayoutPage lastPageOverlayPage;
     private LayoutPage oddPageOverlayPage;
@@ -100,6 +101,7 @@ public enum Position
 
     private int numberOfOverlayPages = 0;
     private boolean useAllOverlayPages = false;
+    private boolean adjustRotation = false;
 
     /**
      * This will add overlays to a document.
@@ -204,6 +206,7 @@ public void close() throws IOException
         }
         openDocumentsSet.clear();
         specificPageOverlayLayoutPageMap.clear();
+        rotatedDefaultOverlayPagesMap.clear();
     }
 
     private void loadPDFs() throws IOException
@@ -288,9 +291,9 @@ private static final class LayoutPage
         private final PDRectangle overlayMediaBox;
         private final COSStream overlayCOSStream;
         private final COSDictionary overlayResources;
-        private final short overlayRotation;
+        private int overlayRotation;
 
-        private LayoutPage(PDRectangle mediaBox, COSStream contentStream, COSDictionary resources, short rotation)
+        private LayoutPage(PDRectangle mediaBox, COSStream contentStream, COSDictionary resources, int rotation)
         {
             overlayMediaBox = mediaBox;
             overlayCOSStream = contentStream;
@@ -326,7 +329,7 @@ private LayoutPage createLayoutPage(PDPage page) throws IOException
             resources = new PDResources();
         }
         return new LayoutPage(page.getMediaBox(), createCombinedContentStream(contents),
-                resources.getCOSObject(), (short) page.getRotation());
+                resources.getCOSObject(), page.getRotation());
     }
 
     private Map<Integer,LayoutPage> createPageOverlayLayoutPageMap(PDDocument doc) throws IOException
@@ -468,7 +471,7 @@ private void overlayPage(PDPage page, LayoutPage layoutPage, COSArray array,
         array.add(createOverlayStream(page, layoutPage, formXObjectId));
     }
 
-    private LayoutPage getLayoutPage(int pageNumber, int numberOfPages)
+    private LayoutPage getLayoutPage(int pageNumber, int numberOfPages) throws IOException
     {
         LayoutPage layoutPage = null;
         if (!useAllOverlayPages && specificPageOverlayLayoutPageMap.containsKey(pageNumber))
@@ -494,6 +497,27 @@ else if ((pageNumber % 2 == 0) && (evenPageOverlayPage != null))
         else if (defaultOverlayPage != null)
         {
             layoutPage = defaultOverlayPage;
+
+            if (adjustRotation)
+            {
+                // PDFBOX-6049: consider the rotation of the document page
+                // Note that this segment is only the second best solution to the problem. The best
+                // would be to make appropriate transforms in calculateAffineTransform()                
+                PDPage page = inputPDFDocument.getPage(pageNumber - 1);
+                if (page.getRotation() != 0)
+                {
+                    LayoutPage rotatedLayoutPage = rotatedDefaultOverlayPagesMap.get(page.getRotation());
+                    if (rotatedLayoutPage == null)
+                    {
+                        // createLayoutPage must be called because we can't reuse the COSStream
+                        rotatedLayoutPage = createLayoutPage(defaultOverlayDocument.getPage(0));
+                        int newRotation = (rotatedLayoutPage.overlayRotation - page.getRotation() + 360) % 360;
+                        rotatedLayoutPage.overlayRotation = newRotation;
+                        rotatedDefaultOverlayPagesMap.put(page.getRotation(), rotatedLayoutPage);
+                    }
+                    return rotatedLayoutPage;
+                }
+            }
         }
         else if (useAllOverlayPages)
         {
@@ -516,15 +540,15 @@ private PDFormXObject createOverlayFormXObject(LayoutPage layoutPage, PDFCloneUt
         {
             case 90:
                 at.translate(0, layoutPage.overlayMediaBox.getWidth());
-                at.rotate(Math.toRadians(-90));
+                at.quadrantRotate(3); // 270
                 break;
             case 180:
                 at.translate(layoutPage.overlayMediaBox.getWidth(), layoutPage.overlayMediaBox.getHeight());
-                at.rotate(Math.toRadians(-180));
+                at.quadrantRotate(2); // 180
                 break;
             case 270:
                 at.translate(layoutPage.overlayMediaBox.getHeight(), 0);
-                at.rotate(Math.toRadians(-270));
+                at.quadrantRotate(1); // 90
                 break;
             default:
                 break;
@@ -795,4 +819,23 @@ public void setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)
     {
         evenPageOverlayDocument = evenPageOverlayPDF;
     }
+
+    /**
+     * This sets whether the overlay is to be rotated according to the rotation of the pages of the
+     * source document. This may look weird if the content of the document is also rotated. So it's
+     * really a users decision to activate this option if the overlay appears rotated in some pages
+     * of the result document and this isn't wanted.
+     * <p>
+     * This setting will only apply to usage of the default overlay, because it is assumed that when
+     * using specific overlays for specific pages, it is known in advance what kind of input there
+     * is.
+     *
+     * @param adjustRotation if true, the overlay will always look the same when the result file is
+     * displayed on the screen. If false (default) then it will be rotated if the page is rotated.
+     */
+    public void setAdjustRotation(boolean adjustRotation)
+    {
+        this.adjustRotation = adjustRotation;
+
+    }
 }

tools/src/main/java/org/apache/pdfbox/tools/OverlayPDF.java

@@ -60,6 +60,9 @@ public final class OverlayPDF implements Callable<Integer>
     @Option(names = "-useAllPages", description = "overlay file used for overlay, all pages are used by simply repeating them")
     private File useAllPages;
 
+    @Option(names = "-adjustRotation", description = "adjust rotation for rotated source pages (applies only if default overlay file is used)")
+    private boolean adjustRotation = false;
+
     @Option(names = "-page", description = "overlay file used for the given page number, may occur more than once")    
     Map<Integer, String> specificPageOverlayFile = new HashMap<>();
 
@@ -140,6 +143,7 @@ public Integer call()
         {
             overlayer.setInputFile(infile.getAbsolutePath());
         }
+        overlayer.setAdjustRotation(adjustRotation);
 
 
         try (PDDocument result = overlayer.overlay(specificPageOverlayFile))