You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by rk...@apache.org on 2016/01/14 02:36:50 UTC
cordova-plugin-geolocation git commit: CB-10319 android: Adding
reflective helper methods for permission requests
Repository: cordova-plugin-geolocation
Updated Branches:
refs/heads/master 2134d2b89 -> 9420f405f
CB-10319 android: Adding reflective helper methods for permission requests
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation/commit/9420f405
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation/tree/9420f405
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation/diff/9420f405
Branch: refs/heads/master
Commit: 9420f405f64fded667eb8335fc9cddc2401d6ff3
Parents: 2134d2b
Author: riknoll <ri...@gmail.com>
Authored: Mon Jan 11 11:06:37 2016 -0800
Committer: riknoll <ri...@gmail.com>
Committed: Mon Jan 11 11:06:37 2016 -0800
----------------------------------------------------------------------
plugin.xml | 16 ++--
src/android/Geolocation.java | 10 +--
src/android/PermissionHelper.java | 138 +++++++++++++++++++++++++++++++++
3 files changed, 147 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation/blob/9420f405/plugin.xml
----------------------------------------------------------------------
diff --git a/plugin.xml b/plugin.xml
index e6269ca..1d341f3 100644
--- a/plugin.xml
+++ b/plugin.xml
@@ -31,11 +31,6 @@ xmlns:android="http://schemas.android.com/apk/res/android"
<repo>https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git</repo>
<issue>https://issues.apache.org/jira/browse/CB/component/12320638</issue>
- <engines>
- <engine name="cordova-android" version=">=5.0.0-dev" />
- </engines>
-
-
<!-- android -->
<platform name="android">
@@ -51,6 +46,7 @@ xmlns:android="http://schemas.android.com/apk/res/android"
</config-file>
<source-file src="src/android/Geolocation.java" target-dir="src/org/apache/cordova/geolocation/" />
+ <source-file src="src/android/PermissionHelper.java" target-dir="src/org/apache/cordova/geolocation/" />
<js-module src="www/android/geolocation.js" name="geolocation">
<clobbers target="navigator.geolocation" />
@@ -70,9 +66,9 @@ xmlns:android="http://schemas.android.com/apk/res/android"
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
</config-file>
-
+
</platform>
-
+
<!-- ios -->
<platform name="ios">
@@ -100,11 +96,11 @@ xmlns:android="http://schemas.android.com/apk/res/android"
<header-file src="src/ios/CDVLocation.h" />
<source-file src="src/ios/CDVLocation.m" />
<framework src="CoreLocation.framework" />
-
+
<config-file target="*-Info.plist" parent="NSLocationWhenInUseUsageDescription">
<string></string>
</config-file>
-
+
</platform>
<!-- blackberry10 -->
@@ -240,7 +236,7 @@ xmlns:android="http://schemas.android.com/apk/res/android"
<clobbers target="navigator.geolocation" />
</js-module>
</platform>
-
+
<!-- firefoxos -->
<platform name="firefoxos">
<config-file target="config.xml" parent="/*">
http://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation/blob/9420f405/src/android/Geolocation.java
----------------------------------------------------------------------
diff --git a/src/android/Geolocation.java b/src/android/Geolocation.java
index 79c6d2c..79f0684 100644
--- a/src/android/Geolocation.java
+++ b/src/android/Geolocation.java
@@ -51,7 +51,7 @@ public class Geolocation extends CordovaPlugin {
return true;
}
else {
- cordova.requestPermissions(this, 0, permissions);
+ PermissionHelper.requestPermissions(this, 0, permissions);
}
return true;
}
@@ -78,13 +78,9 @@ public class Geolocation extends CordovaPlugin {
}
public boolean hasPermisssion() {
- if(Build.VERSION.SDK_INT < Build.VERSION_CODES.M)
- {
- return true;
- }
for(String p : permissions)
{
- if(PackageManager.PERMISSION_DENIED == cordova.getActivity().checkSelfPermission(p))
+ if(!PermissionHelper.hasPermission(this, p))
{
return false;
}
@@ -99,7 +95,7 @@ public class Geolocation extends CordovaPlugin {
public void requestPermissions(int requestCode)
{
- cordova.requestPermissions(this, requestCode, permissions);
+ PermissionHelper.requestPermissions(this, requestCode, permissions);
}
http://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation/blob/9420f405/src/android/PermissionHelper.java
----------------------------------------------------------------------
diff --git a/src/android/PermissionHelper.java b/src/android/PermissionHelper.java
new file mode 100644
index 0000000..4a3ca2d
--- /dev/null
+++ b/src/android/PermissionHelper.java
@@ -0,0 +1,138 @@
+/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+*/
+package org.apache.cordova.geolocation;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.Arrays;
+
+import org.apache.cordova.CordovaInterface;
+import org.apache.cordova.CordovaPlugin;
+import org.apache.cordova.LOG;
+
+import android.content.pm.PackageManager;
+
+/**
+ * This class provides reflective methods for permission requesting and checking so that plugins
+ * written for cordova-android 5.0.0+ can still compile with earlier cordova-android versions.
+ */
+public class PermissionHelper {
+ private static final String LOG_TAG = "CordovaPermissionHelper";
+
+ /**
+ * Requests a "dangerous" permission for the application at runtime. This is a helper method
+ * alternative to cordovaInterface.requestPermission() that does not require the project to be
+ * built with cordova-android 5.0.0+
+ *
+ * @param plugin The plugin the permission is being requested for
+ * @param requestCode A requestCode to be passed to the plugin's onRequestPermissionResult()
+ * along with the result of the permission request
+ * @param permission The permission to be requested
+ */
+ public static void requestPermission(CordovaPlugin plugin, int requestCode, String permission) {
+ PermissionHelper.requestPermissions(plugin, requestCode, new String[] {permission});
+ }
+
+ /**
+ * Requests "dangerous" permissions for the application at runtime. This is a helper method
+ * alternative to cordovaInterface.requestPermissions() that does not require the project to be
+ * built with cordova-android 5.0.0+
+ *
+ * @param plugin The plugin the permissions are being requested for
+ * @param requestCode A requestCode to be passed to the plugin's onRequestPermissionResult()
+ * along with the result of the permissions request
+ * @param permissions The permissions to be requested
+ */
+ public static void requestPermissions(CordovaPlugin plugin, int requestCode, String[] permissions) {
+ try {
+ Method requestPermission = CordovaInterface.class.getDeclaredMethod(
+ "requestPermissions", CordovaPlugin.class, int.class, String[].class);
+
+ // If there is no exception, then this is cordova-android 5.0.0+
+ requestPermission.invoke(plugin.cordova, plugin, requestCode, permissions);
+ } catch (NoSuchMethodException noSuchMethodException) {
+ // cordova-android version is less than 5.0.0, so permission is implicitly granted
+ LOG.d(LOG_TAG, "No need to request permissions " + Arrays.toString(permissions));
+
+ // Notify the plugin that all were granted by using more reflection
+ deliverPermissionResult(plugin, requestCode, permissions);
+ } catch (IllegalAccessException illegalAccessException) {
+ // Should never be caught; this is a public method
+ LOG.e(LOG_TAG, "IllegalAccessException when requesting permissions " + Arrays.toString(permissions), illegalAccessException);
+ } catch(InvocationTargetException invocationTargetException) {
+ // This method does not throw any exceptions, so this should never be caught
+ LOG.e(LOG_TAG, "invocationTargetException when requesting permissions " + Arrays.toString(permissions), invocationTargetException);
+ }
+ }
+
+ /**
+ * Checks at runtime to see if the application has been granted a permission. This is a helper
+ * method alternative to cordovaInterface.hasPermission() that does not require the project to
+ * be built with cordova-android 5.0.0+
+ *
+ * @param plugin The plugin the permission is being checked against
+ * @param permission The permission to be checked
+ *
+ * @return True if the permission has already been granted and false otherwise
+ */
+ public static boolean hasPermission(CordovaPlugin plugin, String permission) {
+ try {
+ Method hasPermission = CordovaInterface.class.getDeclaredMethod("hasPermission", String.class);
+
+ // If there is no exception, then this is cordova-android 5.0.0+
+ return (Boolean) hasPermission.invoke(plugin.cordova, permission);
+ } catch (NoSuchMethodException noSuchMethodException) {
+ // cordova-android version is less than 5.0.0, so permission is implicitly granted
+ LOG.d(LOG_TAG, "No need to check for permission " + permission);
+ return true;
+ } catch (IllegalAccessException illegalAccessException) {
+ // Should never be caught; this is a public method
+ LOG.e(LOG_TAG, "IllegalAccessException when checking permission " + permission, illegalAccessException);
+ } catch(InvocationTargetException invocationTargetException) {
+ // This method does not throw any exceptions, so this should never be caught
+ LOG.e(LOG_TAG, "invocationTargetException when checking permission " + permission, invocationTargetException);
+ }
+ return false;
+ }
+
+ private static void deliverPermissionResult(CordovaPlugin plugin, int requestCode, String[] permissions) {
+ // Generate the request results
+ int[] requestResults = new int[permissions.length];
+ Arrays.fill(requestResults, PackageManager.PERMISSION_GRANTED);
+
+ try {
+ Method onRequestPermissionResult = CordovaPlugin.class.getDeclaredMethod(
+ "onRequestPermissionResult", int.class, String[].class, int[].class);
+
+ onRequestPermissionResult.invoke(plugin, requestCode, permissions, requestResults);
+ } catch (NoSuchMethodException noSuchMethodException) {
+ // Should never be caught since the plugin must be written for cordova-android 5.0.0+ if it
+ // made it to this point
+ LOG.e(LOG_TAG, "NoSuchMethodException when delivering permissions results", noSuchMethodException);
+ } catch (IllegalAccessException illegalAccessException) {
+ // Should never be caught; this is a public method
+ LOG.e(LOG_TAG, "IllegalAccessException when delivering permissions results", illegalAccessException);
+ } catch(InvocationTargetException invocationTargetException) {
+ // This method may throw a JSONException. We are just duplicating cordova-android's
+ // exception handling behavior here; all it does is log the exception in CordovaActivity,
+ // print the stacktrace, and ignore it
+ LOG.e(LOG_TAG, "InvocationTargetException when delivering permissions results", invocationTargetException);
+ }
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org