Merge pull request #21 from PSPDFKit/rad/document-password

Add the ability to pass the document's password

Author: davidschreiber

README.md

@@ -28,7 +28,8 @@ function showMyDocument() {
 		page: 4,
 		scrollDirection: PSPDFKit.PageScrollDirection.VERTICAL,
 		scrollMode: PSPDFKit.ScrollMode.CONTINUOUS,
-		useImmersiveMode: true
+		useImmersiveMode: true,
+		password: "my-document-password"
 	});
 }
 ```
@@ -88,7 +89,8 @@ var options {
 	annotationEditing: {
 		enabled: true, // activate annotation editing (default: true)
 		creatorName: 'John Doe' // author name written into new annotations (default: null)
-	}
+	},
+	password: "my-document-password" // use this to open encrypted PDF files
 };
 
 PSPDFKit.showDocumentFromAssets('www/documents/myFile.pdf', options);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pspdfkit-cordova-android",
-  "version": "3.2.0",
+  "version": "3.3.3",
   "description": "Integration of the PSPDFKit for Android library.",
   "cordova": {
     "id": "pspdfkit-cordova-android",

plugin.xml

@@ -11,7 +11,7 @@
   ~   UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
   ~   This notice may not be removed from this file.
 -->
-<plugin id="pspdfkit-cordova-android" version="3.2.0" xmlns="http://apache.org/cordova/ns/plugins/1.0"
+<plugin id="pspdfkit-cordova-android" version="3.3.3" xmlns="http://apache.org/cordova/ns/plugins/1.0"
         xmlns:android="http://schemas.android.com/apk/res/android">
     <name>PSPDFKit-Android</name>
     <description>Integration of the PSPDFKit for Android library.</description>

src/android/java/com/pspdfkit/cordova/PSPDFKitCordovaPlugin.java

@@ -51,6 +51,7 @@ public class PSPDFKitCordovaPlugin extends CordovaPlugin {
 
     private static final int ARG_DOCUMENT_URI = 0;
     private static final int ARG_OPTIONS = 1;
+    private static final int ARG_DOCUMENT_PASSWORD = 2;
 
     @Override public void initialize(CordovaInterface cordova, CordovaWebView webView) {
         super.initialize(cordova, webView);
@@ -77,13 +78,14 @@ public class PSPDFKitCordovaPlugin extends CordovaPlugin {
 
     @Override public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
         final PdfActivityConfiguration configuration = parseOptionsToConfiguration(args.getJSONObject(ARG_OPTIONS));
+        final String password = convertJsonNullToJavaNull(args.getString(ARG_DOCUMENT_PASSWORD));
 
         if (action.equals("showDocument")) {
             final Uri documentUri = Uri.parse(args.getString(ARG_DOCUMENT_URI));
-            this.showDocument(documentUri, configuration, callbackContext);
+            this.showDocument(documentUri, password, configuration, callbackContext);
             return true;
         } else if (action.equals("showDocumentFromAssets")) {
-            this.showDocumentFromAssets(args.getString(ARG_DOCUMENT_URI), configuration, callbackContext);
+            this.showDocumentFromAssets(args.getString(ARG_DOCUMENT_URI), password, configuration, callbackContext);
             return true;
         }
 
@@ -152,7 +154,7 @@ public class PSPDFKitCordovaPlugin extends CordovaPlugin {
                 } else if ("toGrayscale".equals(option)) {
                     builder.toGrayscale((Boolean) value);
                 } else if ("title".equals(option)) {
-                    builder.title(fromJsonString(options.getString("title")));
+                    builder.title(convertJsonNullToJavaNull(options.getString("title")));
                 } else if ("startZoomScale".equals(option)) {
                     builder.startZoomScale((float) options.getDouble("startZoomScale"));
                 } else if ("maxZoomScale".equals(option)) {
@@ -182,7 +184,7 @@ public class PSPDFKitCordovaPlugin extends CordovaPlugin {
                             if ((Boolean) annotationEditingValue) builder.enableAnnotationEditing();
                             else builder.disableAnnotationEditing();
                         } else if ("creatorName".equals(annotationEditingOption)) {
-                            PSPDFKitPreferences.get(activity).setAnnotationCreator(fromJsonString(annotationEditing.getString("creatorName")));
+                            PSPDFKitPreferences.get(activity).setAnnotationCreator(convertJsonNullToJavaNull(annotationEditing.getString("creatorName")));
                         } else {
                             throw new IllegalArgumentException(String.format("Invalid annotation editing option '%s'", annotationEditingOption));
                         }
@@ -201,37 +203,37 @@ public class PSPDFKitCordovaPlugin extends CordovaPlugin {
     /**
      * Ensures that Javascript "null" strings are correctly converted to javas <code>null</code>.
      */
-    @Nullable private String fromJsonString(@Nullable String creatorName) {
-        if (creatorName == null || creatorName.equals("null")) return null;
-        return creatorName;
+    @Nullable private static String convertJsonNullToJavaNull(@Nullable String value) {
+        if (value == null || value.equals("null")) return null;
+        return value;
     }
 
     /**
      * Starts the {@link PdfActivity} to show a single document.
      * @param documentUri     Local filesystem Uri pointing to a document.
-     * @param configuration   PSPDFKit configuration.
+     * @param configuration   PSPDFKit configuration
+     * @param password        PDF password
      * @param callbackContext Cordova callback.
      */
 
-    private void showDocument(@NonNull Uri documentUri, @NonNull final PdfActivityConfiguration configuration,
-                              @NonNull final CallbackContext callbackContext) {
-        showDocumentForUri(documentUri, configuration);
+    private void showDocument(@NonNull Uri documentUri, @Nullable final String password, @NonNull final PdfActivityConfiguration configuration, @NonNull final CallbackContext callbackContext) {
+        showDocumentForUri(documentUri, password, configuration);
         callbackContext.success();
     }
 
     /**
      * Starts the {@link PdfActivity} to show a single document stored within the app's assets.
      * @param assetPath       Relative path inside the app's assets folder.
      * @param configuration   PSPDFKit configuration.
+     * @param password        PDF password
      * @param callbackContext Cordova callback.
      */
-    private void showDocumentFromAssets(@NonNull final String assetPath, @NonNull final PdfActivityConfiguration configuration,
-                                        @NonNull final CallbackContext callbackContext) {
+    private void showDocumentFromAssets(@NonNull final String assetPath, @Nullable final String password, @NonNull final PdfActivityConfiguration configuration, @NonNull final CallbackContext callbackContext) {
         ExtractAssetTask.extract(assetPath, cordova.getActivity(), new ExtractAssetTask.OnDocumentExtractedCallback() {
             @Override
             public void onDocumentExtracted(File documentFile) {
                 if (documentFile != null) {
-                    showDocumentForUri(Uri.fromFile(documentFile), configuration);
+                    showDocumentForUri(Uri.fromFile(documentFile), password, configuration);
                     callbackContext.success();
                 } else {
                     callbackContext.error("Could not load '" + assetPath + "' from the assets.");
@@ -240,7 +242,7 @@ public void onDocumentExtracted(File documentFile) {
         });
     }
 
-    private void showDocumentForUri(@NonNull Uri uri, @NonNull final PdfActivityConfiguration configuration) {
-        PdfActivity.showDocument(cordova.getActivity(), uri, configuration);
+    private void showDocumentForUri(@NonNull Uri uri, @Nullable final String password, @NonNull final PdfActivityConfiguration configuration) {
+        PdfActivity.showDocument(cordova.getActivity(), uri, password, configuration);
     }
 }

tests/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pspdfkit-cordova-android-tests",
-  "version": "3.2.0",
+  "version": "3.3.3",
   "description": "Test suite of the PSPDFKit for Android library Cordova plugin.",
   "cordova": {
     "id": "pspdfkit-cordova-android-tests",

tests/plugin.xml

@@ -13,7 +13,7 @@
 -->
 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
         id="pspdfkit-cordova-android-tests"
-        version="3.2.0">
+        version="3.3.3">
     <name>PSPDFKit-Android Tests</name>
     <license>MIT</license>
 

tests/tests.js

@@ -90,4 +90,20 @@ exports.defineManualTests = function(contentEl, createActionButton) {
             console.log('Error while loading the document:' + error)
         });
     });
+
+    createActionButton('Password protected document', function() {
+        var asset = 'www/password.pdf';
+        var options = {
+          title: "Password protected document",
+          password: "test123"
+        };
+
+        console.log('Opening encrypted document ' + asset);
+
+        window.PSPDFKit.showDocumentFromAssets(asset, options, function() {
+            console.log("Document was successfully loaded.");
+        }, function(error) {
+            console.log('Error while loading the document:' + error)
+        });
+    });
 };

www/PSPDFKit.js

@@ -13,6 +13,15 @@
 
 var exec = require('cordova/exec');
 
+/**
+ * Retrieves a named property from the given target object while removing the property from the object.
+ */
+function getPropertyAndUnset(target, name) {
+    var value = target.hasOwnProperty(name) ? target[name] : null;
+    delete target[name];
+    return value;
+};
+
 /**
  * Opens the PSPDFActivity to show a document from the local device file system.
  *
@@ -23,7 +32,8 @@ var exec = require('cordova/exec');
  */
 exports.showDocument = function (uri, options, success, error) {
     options = options || {};
-    exec(success, error, "PSPDFKitCordovaPlugin", "showDocument", [uri, options]);
+    var password = getPropertyAndUnset(options, "password");
+    exec(success, error, "PSPDFKitCordovaPlugin", "showDocument", [uri, options, password]);
 };
 
 /**
@@ -38,7 +48,8 @@ exports.showDocument = function (uri, options, success, error) {
  */
 exports.showDocumentFromAssets = function (assetFile, options, success, error) {
     options = options || {};
-    exec(success, error, "PSPDFKitCordovaPlugin", "showDocumentFromAssets", [assetFile, options]);
+    var password = getPropertyAndUnset(options, "password");
+    exec(success, error, "PSPDFKitCordovaPlugin", "showDocumentFromAssets", [assetFile, options, password]);
 };
 
 /**