Fix ignorePageRotationForContent flag

Author: yulian-gaponenko

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfPage.java

@@ -85,10 +85,15 @@ public class PdfPage extends PdfObjectWrapper<PdfDictionary> {
             // TODO This key contains reference to all articles, while this articles could reference to lots of pages.
             // See DEVSIX-191
             PdfName.B));
+
     /**
      * Automatically rotate new content if the page has a rotation ( is disabled by default )
      */
-    private boolean ignoreContentRotation = true;
+    private boolean ignorePageRotationForContent = false;
+    /**
+     * See {@link #isPageRotationInverseMatrixWritten()}.
+     */
+    private boolean pageRotationInverseMatrixWritten = false;
 
     protected PdfPage(PdfDictionary pdfObject) {
         super(pdfObject);
@@ -158,8 +163,9 @@ public int getRotation() {
         }
     }
 
-    public void setRotation(int degAngle) {
+    public PdfPage setRotation(int degAngle) {
         getPdfObject().put(PdfName.Rotate, new PdfNumber(degAngle));
+        return this;
     }
 
     public PdfStream getContentStream(int index) {
@@ -232,9 +238,10 @@ public PdfResources getResources() {
         return this.resources;
     }
 
-    public void setResources(PdfResources pdfResources) {
+    public PdfPage setResources(PdfResources pdfResources) {
         getPdfObject().put(PdfName.Resources, pdfResources.getPdfObject());
         this.resources = pdfResources;
+        return this;
     }
 
 
@@ -416,8 +423,9 @@ public Rectangle getMediaBox() {
         return mediaBox.toRectangle();
     }
 
-    public void setMediaBox(Rectangle rectangle) {
+    public PdfPage setMediaBox(Rectangle rectangle) {
         getPdfObject().put(PdfName.MediaBox, new PdfArray(rectangle));
+        return this;
     }
 
 
@@ -433,30 +441,33 @@ public Rectangle getCropBox() {
         return cropBox.toRectangle();
     }
 
-    public void setCropBox(Rectangle rectangle) {
+    public PdfPage setCropBox(Rectangle rectangle) {
         getPdfObject().put(PdfName.CropBox, new PdfArray(rectangle));
+        return this;
     }
 
-    public void setArtBox(Rectangle rectangle) {
+    public PdfPage setArtBox(Rectangle rectangle) {
         if (getPdfObject().getAsRectangle(PdfName.TrimBox) != null) {
             getPdfObject().remove(PdfName.TrimBox);
             Logger logger = LoggerFactory.getLogger(PdfPage.class);
             logger.warn(LogMessageConstant.ONLY_ONE_OF_ARTBOX_OR_TRIMBOX_CAN_EXIST_IN_THE_PAGE);
         }
         getPdfObject().put(PdfName.ArtBox, new PdfArray(rectangle));
+        return this;
     }
 
     public Rectangle getArtBox() {
         return getPdfObject().getAsRectangle(PdfName.ArtBox);
     }
 
-    public void setTrimBox(Rectangle rectangle) {
+    public PdfPage setTrimBox(Rectangle rectangle) {
         if (getPdfObject().getAsRectangle(PdfName.ArtBox) != null) {
             getPdfObject().remove(PdfName.ArtBox);
             Logger logger = LoggerFactory.getLogger(PdfPage.class);
             logger.warn(LogMessageConstant.ONLY_ONE_OF_ARTBOX_OR_TRIMBOX_CAN_EXIST_IN_THE_PAGE);
         }
         getPdfObject().put(PdfName.TrimBox, new PdfArray(rectangle));
+        return this;
     }
 
     public Rectangle getTrimBox() {
@@ -634,18 +645,19 @@ public List<PdfOutline> getOutlines(boolean updateOutlines) {
      * @return true - if in case the page has a rotation, then new content will be automatically rotated in the
      * opposite direction. On the rotated page this would look like if new content ignores page rotation.
      */
-    public boolean isIgnoreContentRotation() {
-        return ignoreContentRotation;
+    public boolean isIgnorePageRotationForContent() {
+        return ignorePageRotationForContent;
     }
 
     /**
      * If true - defines that in case the page has a rotation, then new content will be automatically rotated in the
      * opposite direction. On the rotated page this would look like if new content ignores page rotation.
      * Default value - {@code false}.
-     * @param ignoreContentRotation - true to ignore rotation of the new content on the rotated page.
+     * @param ignorePageRotationForContent - true to ignore rotation of the new content on the rotated page.
      */
-    public void setIgnoreContentRotation(boolean ignoreContentRotation) {
-        this.ignoreContentRotation = ignoreContentRotation;
+    public PdfPage setIgnorePageRotationForContent(boolean ignorePageRotationForContent) {
+        this.ignorePageRotationForContent = ignorePageRotationForContent;
+        return this;
     }
 
     /**
@@ -708,6 +720,31 @@ public PdfPage put(PdfName key, PdfObject value) {
         return this;
     }
 
+    /**
+     * This flag is meaningful for the case, when page rotation is applied and ignorePageRotationForContent
+     * is set to true. NOTE: It is needed for the internal usage.
+     * <br/><br/>
+     * This flag defines if inverse matrix (which rotates content into the opposite direction from page rotation
+     * direction in order to give the impression of the not rotated text) is already applied to the page content stream.
+     * See {@link #setIgnorePageRotationForContent(boolean)}
+     * @return true, if inverse matrix is already applied, false otherwise.
+     */
+    public boolean isPageRotationInverseMatrixWritten() {
+        return pageRotationInverseMatrixWritten;
+    }
+
+    /**
+     * NOTE: For internal usage! Use this method only if you know what you are doing.
+     * <br/><br/>
+     * This method is called when inverse matrix (which rotates content into the opposite direction from page rotation
+     * direction in order to give the impression of the not rotated text) is applied to the page content stream.
+     * See {@link #setIgnorePageRotationForContent(boolean)}
+     */
+    public void setPageRotationInverseMatrixWritten() {
+        // this method specifically return void to discourage it's unintended usage
+        pageRotationInverseMatrixWritten = true;
+    }
+
     @Override
     protected boolean isWrappedObjectMustBeIndirect() {
         return true;

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/PdfCanvas.java

@@ -218,8 +218,9 @@ public PdfCanvas(PdfStream contentStream, PdfResources resources, PdfDocument do
      * @param page page to create canvas from.
      */
     public PdfCanvas(PdfPage page) {
-        this(page, page.getDocument().getReader() != null && page.getDocument().getWriter() != null &&
-                page.getContentStreamCount() > 0 && page.getLastContentStream().getLength() > 0);
+        this(page, (page.getDocument().getReader() != null && page.getDocument().getWriter() != null
+                        && page.getContentStreamCount() > 0 && page.getLastContentStream().getLength() > 0)
+                   || (page.getRotation() != 0 && page.isIgnorePageRotationForContent()));
     }
 
     /**
@@ -235,27 +236,11 @@ public PdfCanvas(PdfPage page, boolean wrapOldContent) {
             // Wrap old content in q/Q in order not to get unexpected results because of the CTM
             page.newContentStreamBefore().getOutputStream().writeBytes(ByteUtils.getIsoBytes("q\n"));
             contentStream.getOutputStream().writeBytes(ByteUtils.getIsoBytes("Q\n"));
-            if (page.getRotation() != 0 && !page.isIgnoreContentRotation()) {
-                applyRotation(page);
-            }
         }
-
-
-    }
-
-    private void applyRotation(PdfPage page) {
-        Rectangle rectagle = page.getPageSizeWithRotation();
-        int rotation = page.getRotation();
-        switch (rotation) {
-            case 90:
-                concatMatrix(0, 1, -1, 0, rectagle.getTop(), 0);
-                break;
-            case 180:
-                concatMatrix(-1, 0, 0, -1, rectagle.getRight(), rectagle.getTop());
-                break;
-            case 270:
-                concatMatrix(0, -1, 1, 0, 0, rectagle.getRight());
-                break;
+        if (page.getRotation() != 0 && page.isIgnorePageRotationForContent()
+                && (wrapOldContent || !page.isPageRotationInverseMatrixWritten())) {
+            applyRotation(page);
+            page.setPageRotationInverseMatrixWritten();
         }
     }
 
@@ -2383,4 +2368,20 @@ private PdfArray getDashPatternArray(float[] dashArray, float phase) {
         dashPatternArray.add(new PdfNumber(phase));
         return dashPatternArray;
     }
+
+    private void applyRotation(PdfPage page) {
+        Rectangle rectagle = page.getPageSizeWithRotation();
+        int rotation = page.getRotation();
+        switch (rotation) {
+            case 90:
+                concatMatrix(0, 1, -1, 0, rectagle.getTop(), 0);
+                break;
+            case 180:
+                concatMatrix(-1, 0, 0, -1, rectagle.getRight(), rectagle.getTop());
+                break;
+            case 270:
+                concatMatrix(0, -1, 1, 0, 0, rectagle.getRight());
+                break;
+        }
+    }
 }