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 2022/05/30 12:34:57 UTC

svn commit: r1901413 - in /pdfbox/branches/2.0: debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/ pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/ pdfbox/src/test/java/org/apache/pdfbox/encryption/ tools/src/main/java/org/apache...

Author: tilman
Date: Mon May 30 12:34:57 2022
New Revision: 1901413

URL: http://svn.apache.org/viewvc?rev=1901413&view=rev
Log:
PDFBOX-5448: rename canPrintDegraded to canPrintFaithful to clarify

Modified:
    pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/EncryptFlag.java
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java
    pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestPublicKeyEncryption.java
    pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestSymmetricKeyEncryption.java
    pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java

Modified: pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/EncryptFlag.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/EncryptFlag.java?rev=1901413&r1=1901412&r2=1901413&view=diff
==============================================================================
--- pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/EncryptFlag.java (original)
+++ pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/EncryptFlag.java Mon May 30 12:34:57 2022
@@ -63,7 +63,7 @@ public class EncryptFlag extends Flag
                 new Object[]{9, "can fill in form fields", ap.canFillInForm()},
                 new Object[]{10, "can extract for accessibility", ap.canExtractForAccessibility()},
                 new Object[]{11, "can assemble document", ap.canAssembleDocument()},
-                new Object[]{12, "can print degraded", ap.canPrintDegraded()},
+                new Object[]{12, "can print faithful", ap.canPrintFaithful()},
         };
     }
 }

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java?rev=1901413&r1=1901412&r2=1901413&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java Mon May 30 12:34:57 2022
@@ -57,7 +57,7 @@ public class AccessPermission
     private static final int FILL_IN_FORM_BIT = 9;
     private static final int EXTRACT_FOR_ACCESSIBILITY_BIT = 10;
     private static final int ASSEMBLE_DOCUMENT_BIT = 11;
-    private static final int DEGRADED_PRINT_BIT = 12;
+    private static final int FAITHFUL_PRINT_BIT = 12;
 
     private int bytes;
 
@@ -140,7 +140,7 @@ public class AccessPermission
                 && this.canModify()
                 && this.canModifyAnnotations()
                 && this.canPrint()
-                && this.canPrintDegraded()
+                && this.canPrintFaithful()
                 );
     }
 
@@ -160,7 +160,7 @@ public class AccessPermission
         ret.setCanModify(true);
         ret.setCanModifyAnnotations(true);
         ret.setCanPrint(true);
-        ret.setCanPrintDegraded(true);
+        ret.setCanPrintFaithful(true);
         return ret;
     }
 
@@ -390,29 +390,64 @@ public class AccessPermission
     }
 
     /**
-     * This will tell if the user can print the document in a degraded format.
+     * This will tell if the user can print the document in a faithful format or in a degraded
+     * format.
      *
-     * @return true If supplied with the user password they are allowed to print the
-     *              document in a degraded format.
+     * @return true If supplied with the user password they are allowed to print the document in a
+     * faithful format.
+     * 
+     * @deprecated use {@link #canPrintFaithful() }
      */
+    @Deprecated
     public boolean canPrintDegraded()
     {
-        return isPermissionBitOn( DEGRADED_PRINT_BIT );
+        return isPermissionBitOn(FAITHFUL_PRINT_BIT);
     }
 
     /**
-     * Set if the user can print the document in a degraded format.
+     * Set if the user can print the document in a faithful format or in a degraded format.
      * <p>
      * This method will have no effect if the object is in read only mode.
      *
-     * @param canPrintDegraded A boolean determining if the user can print the
-     *        document in a degraded format.
+     * @param canPrintFaithful A boolean determining if the user can print the document in a
+     * faithful format.
+     * 
+     * @deprecated use {@link #setCanPrintFaithful(boolean)}
      */
-    public void setCanPrintDegraded( boolean canPrintDegraded )
+    @Deprecated
+    public void setCanPrintDegraded(boolean canPrintFaithful)
     {
-        if(!readOnly)
+        if (!readOnly)
+        {
+            setPermissionBit(FAITHFUL_PRINT_BIT, canPrintFaithful);
+        }
+    }
+
+    /**
+     * This will tell if the user can print the document in a faithful format or in a degraded
+     * format.
+     *
+     * @return true If supplied with the user password they are allowed to print the document in a
+     * degraded format.
+     */
+    public boolean canPrintFaithful()
+    {
+        return isPermissionBitOn(FAITHFUL_PRINT_BIT);
+    }
+
+    /**
+     * Set if the user can print the document in a faithful format or in a degraded format.
+     * <p>
+     * This method will have no effect if the object is in read only mode.
+     *
+     * @param canPrintFaithful A boolean determining if the user can print the document in a
+     * degraded format.
+     */
+    public void setCanPrintFaithful(boolean canPrintFaithful)
+    {
+        if (!readOnly)
         {
-            setPermissionBit( DEGRADED_PRINT_BIT, canPrintDegraded );
+            setPermissionBit(FAITHFUL_PRINT_BIT, canPrintFaithful);
         }
     }
 
@@ -457,6 +492,6 @@ public class AccessPermission
         {
             return true;
         }
-        return canPrintDegraded();
+        return canPrintFaithful();
     }
 }

Modified: pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestPublicKeyEncryption.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestPublicKeyEncryption.java?rev=1901413&r1=1901412&r2=1901413&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestPublicKeyEncryption.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestPublicKeyEncryption.java Mon May 30 12:34:57 2022
@@ -113,7 +113,7 @@ public class TestPublicKeyEncryption
         permission1.setCanModify(false);
         permission1.setCanModifyAnnotations(false);
         permission1.setCanPrint(false);
-        permission1.setCanPrintDegraded(false);
+        permission1.setCanPrintFaithful(false);
 
         permission2 = new AccessPermission();
         permission2.setCanAssembleDocument(false);
@@ -123,7 +123,7 @@ public class TestPublicKeyEncryption
         permission2.setCanModify(false);
         permission2.setCanModifyAnnotations(false);
         permission2.setCanPrint(true); // it is true now !
-        permission2.setCanPrintDegraded(false);
+        permission2.setCanPrintFaithful(false);
 
         recipient1 = getRecipient("test1.der", permission1);
         recipient2 = getRecipient("test2.der", permission2);
@@ -215,7 +215,7 @@ public class TestPublicKeyEncryption
             Assert.assertFalse(permission.canModify());
             Assert.assertFalse(permission.canModifyAnnotations());
             Assert.assertFalse(permission.canPrint());
-            Assert.assertFalse(permission.canPrintDegraded());
+            Assert.assertFalse(permission.canPrintFaithful());
         } 
         finally 
         {
@@ -251,7 +251,7 @@ public class TestPublicKeyEncryption
             Assert.assertFalse(permission.canModify());
             Assert.assertFalse(permission.canModifyAnnotations());
             Assert.assertFalse(permission.canPrint());
-            Assert.assertFalse(permission.canPrintDegraded());
+            Assert.assertFalse(permission.canPrintFaithful());
         } 
         finally 
         {
@@ -270,7 +270,7 @@ public class TestPublicKeyEncryption
             Assert.assertFalse(permission.canModify());
             Assert.assertFalse(permission.canModifyAnnotations());
             Assert.assertTrue(permission.canPrint());
-            Assert.assertFalse(permission.canPrintDegraded());
+            Assert.assertFalse(permission.canPrintFaithful());
         } 
         finally 
         {

Modified: pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestSymmetricKeyEncryption.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestSymmetricKeyEncryption.java?rev=1901413&r1=1901412&r2=1901413&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestSymmetricKeyEncryption.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/test/java/org/apache/pdfbox/encryption/TestSymmetricKeyEncryption.java Mon May 30 12:34:57 2022
@@ -97,7 +97,7 @@ public class TestSymmetricKeyEncryption
         permission.setCanModify(false);
         permission.setCanModifyAnnotations(false);
         permission.setCanPrint(true);
-        permission.setCanPrintDegraded(false);
+        permission.setCanPrintFaithful(false);
         permission.setReadOnly();
     }
 
@@ -133,7 +133,7 @@ public class TestSymmetricKeyEncryption
 
         restrAP.setCanAssembleDocument(false);
         restrAP.setCanExtractForAccessibility(false);
-        restrAP.setCanPrintDegraded(false);
+        restrAP.setCanPrintFaithful(false);
 
         inputFileAsByteArray = getFileResourceAsByteArray("PasswordSample-128bit.pdf");
         checkPerms(inputFileAsByteArray, "owner", fullAP);
@@ -182,7 +182,7 @@ public class TestSymmetricKeyEncryption
         assertEquals(expectedPermissions.canModify(), currentAccessPermission.canModify());
         assertEquals(expectedPermissions.canModifyAnnotations(), currentAccessPermission.canModifyAnnotations());
         assertEquals(expectedPermissions.canPrint(), currentAccessPermission.canPrint());
-        assertEquals(expectedPermissions.canPrintDegraded(), currentAccessPermission.canPrintDegraded());
+        assertEquals(expectedPermissions.canPrintFaithful(), currentAccessPermission.canPrintFaithful());
 
         new PDFRenderer(doc).renderImage(0);
 

Modified: pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java?rev=1901413&r1=1901412&r2=1901413&view=diff
==============================================================================
--- pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java (original)
+++ pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java Mon May 30 12:34:57 2022
@@ -124,9 +124,9 @@ public final class Encrypt
                     {
                         ap.setCanPrint( args[++i].equalsIgnoreCase( "true" ) );
                     }
-                    else if( key.equals( "-canPrintDegraded" ) )
+                    else if( key.equals( "-canPrintDegraded") || key.equals( "-canPrintFaithful") )
                     {
-                        ap.setCanPrintDegraded( args[++i].equalsIgnoreCase( "true" ) );
+                        ap.setCanPrintFaithful( args[++i].equalsIgnoreCase( "true" ) );
                     }
                     else if( key.equals( "-certFile" ) )
                     {
@@ -241,7 +241,7 @@ public final class Encrypt
                 + "  -canModify <true|false>                  : Set the modify permission\n"
                 + "  -canModifyAnnotations <true|false>       : Set the modify annots permission\n"
                 + "  -canPrint <true|false>                   : Set the print permission\n"
-                + "  -canPrintDegraded <true|false>           : Set the print degraded permission\n"
+                + "  -canPrintFaithful <true|false>           : Set the print faithful permission\n"
                 + "  -keyLength <length>                      : Key length in bits "
                 + "(valid values: 40, 128 or 256, default is 256)\n"
                 + "\nNote: By default all permissions are set to true!";