Organize permissions in option to an object

Author: zesik

docs/getting_started.coffee.md

@@ -201,13 +201,17 @@ settings in the `option` object when creating `PDFDocument`. By default, all ope
 You need to explicitly allow certain operations.
 
  * `ownerPassword` - the owner password (string value)
- * `allowPrinting` - whether printing is allowed. Specify `"lowResolution"` to allow degraded printing, or `"highResolution"` to allow printing with high resolution
- * `allowModifying` - whether modifying the file is allowed. Specify `true` to allow modifying document content
- * `allowCopying` - whether copying text or graphics is allowed. Specify `true` to allow copying
- * `allowAnnotating` - whether annotating, form filling is allowed. Specify `true` to allow annotating and form filling
- * `allowFillingForms` - whether form filling and signing is allowed. Specify `true` to allow filling in form fields and signing
- * `allowContentAccessibility` - whether copying text for accessibility is allowed. Specify `true` to allow copying for accessibility
- * `allowDocumentAssembly` - whether assembling document is allowed. Specify `true` to allow document assembly
+ * `permissions` - the object specifying PDF file permissions
+
+Following settings are allowed in `permissions` object:
+
+ * `printing` - whether printing is allowed. Specify `"lowResolution"` to allow degraded printing, or `"highResolution"` to allow printing with high resolution
+ * `modifying` - whether modifying the file is allowed. Specify `true` to allow modifying document content
+ * `copying` - whether copying text or graphics is allowed. Specify `true` to allow copying
+ * `annotating` - whether annotating, form filling is allowed. Specify `true` to allow annotating and form filling
+ * `fillingForms` - whether form filling and signing is allowed. Specify `true` to allow filling in form fields and signing
+ * `contentAccessibility` - whether copying text for accessibility is allowed. Specify `true` to allow copying for accessibility
+ * `documentAssembly` - whether assembling document is allowed. Specify `true` to allow document assembly
 
 You can specify either user password, owner password or both passwords.
 Behavior differs according to passwords you provides:
@@ -225,7 +229,7 @@ Behavior differs according to passwords you provides:
 
 Note that PDF file itself cannot enforce access privileges.
 When file is decrypted, PDF viewer applications have full access to the file content,
-and it is up to them to respect permission settings.
+and it is up to viewer applications to respect permission settings.
 
 To choose encryption method, you need to specify PDF version.
 PDFKit will choose best encryption method available in the PDF version you specified.

lib/security.js

@@ -82,17 +82,17 @@ class PDFSecurity {
       case 1:
         r = 2;
         this.keyBits = 40;
-        permissions = getPermissionsR2(options);
+        permissions = getPermissionsR2(options.permissions);
         break;
       case 2:
         r = 3;
         this.keyBits = 128;
-        permissions = getPermissionsR3(options);
+        permissions = getPermissionsR3(options.permissions);
         break;
       case 4:
         r = 4;
         this.keyBits = 128;
-        permissions = getPermissionsR3(options);
+        permissions = getPermissionsR3(options.permissions);
         break;
     }
 
@@ -208,47 +208,47 @@ class PDFSecurity {
   }
 }
 
-function getPermissionsR2(options) {
+function getPermissionsR2(permissionObject = {}) {
   let permissions = 0xffffffc0 >> 0;
-  if (options.allowPrinting) {
+  if (permissionObject.printing) {
     permissions |= 0b00000000010;
   }
-  if (options.allowModifying) {
+  if (permissionObject.modifying) {
     permissions |= 0b000000001000;
   }
-  if (options.allowCopying) {
+  if (permissionObject.copying) {
     permissions |= 0b000000010000;
   }
-  if (options.allowAnnotating) {
+  if (permissionObject.annotating) {
     permissions |= 0b000000100000;
   }
   return permissions;
 }
 
-function getPermissionsR3(options) {
+function getPermissionsR3(permissionObject = {}) {
   let permissions = 0xfffff0c0 >> 0;
-  if (options.allowPrinting === 'lowResolution') {
+  if (permissionObject.printing === 'lowResolution') {
     permissions |= 0b000000000100;
   }
-  if (options.allowPrinting === 'highResolution') {
+  if (permissionObject.printing === 'highResolution') {
     permissions |= 0b100000000100;
   }
-  if (options.allowModifying) {
+  if (permissionObject.modifying) {
     permissions |= 0b000000001000;
   }
-  if (options.allowCopying) {
+  if (permissionObject.copying) {
     permissions |= 0b000000010000;
   }
-  if (options.allowAnnotating) {
+  if (permissionObject.annotating) {
     permissions |= 0b000000100000;
   }
-  if (options.allowFillingForms) {
+  if (permissionObject.fillingForms) {
     permissions |= 0b000100000000;
   }
-  if (options.allowContentAccessibility) {
+  if (permissionObject.contentAccessibility) {
     permissions |= 0b001000000000;
   }
-  if (options.allowDocumentAssembly) {
+  if (permissionObject.documentAssembly) {
     permissions |= 0b010000000000;
   }
   return permissions;