diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..400a546c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,12 @@ +language: android + +android: + components: + - build-tools-23.0.1 + - android-23 + - extra-android-support + - extra-google-m2repository + - extra-android-m2repository + +script: + ./gradlew checkstyle build \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..7a4a3ea2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..65eed10d --- /dev/null +++ b/README.md @@ -0,0 +1,134 @@ +Dexter +================== + + +Dexter is an Android library that simplifies the process of requesting permissions at runtime. + +Android Marshmallow includes a new functionality to let users grant or deny permissions when running an app instead of granting them all when installing it. This approach gives the user more control over applications but requires developers to add lots of code to support it. + +The official API is heavily coupled with the ``Activity`` class. +Dexter frees your permission code from your activities and lets you write that logic anywhere you want. + + +Screenshots +----------- + +![Demo screenshot][1] + +Usage +----- + +To start using the library you just need to initialize Dexter with a ``Context``, preferably your ``Application`` as it won't be destroyed during your app lifetime: + +```java +public MyApplication extends Application { + @Override public void onCreate() { + super.onCreate(); + Dexter.initialize(context); + } +} +``` + +Once the library is initialized you can start checking permissions at will. For each permission, register a ``PermissionListener`` implementation to receive the state of the request: + +```java +Dexter.checkPermission(Manifest.permission.CAMERA, new PermissionListener() { + @Override public void onPermissionGranted(String permission) {/* ... */} + @Override public void onPermissionDenied(String permission) {/* ... */} + @Override public void onPermissionRationaleShouldBeShown(String permission, PermissionToken token) {/* ... */} +}); +``` + +To make your life easier we offer some ``PermissionListener`` implementations to perform recurrent actions: + +* ``EmptyPermissionListener`` to make it easier to implement only the methods you want. +* ``DialogOnDeniedPermissionListener`` to show a configurable dialog whenever the user rejects a permission request: + +```java +PermissionListener dialogPermissionListener = + new DialogOnDeniedPermissionListener.Builder(context) + .withTitle("Camera permission") + .withMessage("Camera permission is needed to take pictures of your cat") + .withButtonText(android.R.string.ok) + .withIcon(R.mipmap.my_icon) + .build(); +Dexter.checkPermission(Manifest.permission.CAMERA, dialogPermissionListener); +``` + +* ``SnackbarOnDeniedPermissionListener`` to show a snackbar message whenever the user rejects a permission request: + +```java +PermissionListener snackbarPermissionListener = + new SnackbarOnDeniedPermissionListener.Builder(context, rootView, "Camera access is needed to take pictures of your dog") + .withOpenSettingsButton("Settings") + .build(); +Dexter.checkPermission(Manifest.permission.CAMERA, snackbarPermissionListener); +``` + +* ``MultiPermissionListener`` to compound multiple listeners into one: + +```java +PermissionListener snackbarPermissionListener = /*...*/; +PermissionListener dialogPermissionListener = /*...*/; +Dexter.checkPermission(Manifest.permission.CAMERA, new MultiPermissionListener(snackbarPermissionListener, dialogPermissionListener, /*...*/)); +``` + + +**IMPORTANT**: Remember to follow the [Google design guidelines] [2] to make your application as user-friendly as possible. + +Add it to your project +---------------------- + +Include the library in your ``build.gradle`` + +```groovy +dependencies{ + compile 'com.karumi:dexter:1.0.0' +} +``` + +or to your ``pom.xml`` if you are using Maven + +```xml + + com.karumi + dexter + 1.0.0 + aar + + +``` + +Do you want to contribute? +-------------------------- + +Feel free to add any useful feature to the library, we will be glad to improve it with your help. + +Keep in mind that your PRs **must** be validated by Travis-CI. Please, run a local build with ``./gradlew checkstyle build`` before submiting your code. + + +Libraries used in this project +------------------------------ + +* [Butterknife] [3] + +License +------- + + Copyright 2015 Karumi + + Licensed 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. + +[1]: ./art/example.gif +[2]: http://www.google.es/design/spec/patterns/permissions.html +[3]: https://github.com/JakeWharton/butterknife \ No newline at end of file diff --git a/art/example.gif b/art/example.gif new file mode 100644 index 00000000..921e2592 Binary files /dev/null and b/art/example.gif differ diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..316fafcb --- /dev/null +++ b/build.gradle @@ -0,0 +1,29 @@ +buildscript { + repositories { + jcenter() + } + dependencies { + classpath 'com.android.tools.build:gradle:1.3.0' + } +} + +allprojects { + repositories { + mavenCentral() + } + + apply plugin: 'checkstyle' + + task checkstyle(type: Checkstyle) { + configFile file("${project.rootDir}/config/checkstyle.xml") + source 'src' + include '**/*.java' + exclude '**/gen/**' + + classpath = files() + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/config/checkstyle.xml b/config/checkstyle.xml new file mode 100644 index 00000000..281e5613 --- /dev/null +++ b/config/checkstyle.xml @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dexter/.gitignore b/dexter/.gitignore new file mode 100644 index 00000000..796b96d1 --- /dev/null +++ b/dexter/.gitignore @@ -0,0 +1 @@ +/build diff --git a/dexter/build.gradle b/dexter/build.gradle new file mode 100644 index 00000000..d375ff94 --- /dev/null +++ b/dexter/build.gradle @@ -0,0 +1,26 @@ +apply plugin: 'com.android.library' +apply from: 'https://raw.github.com/chrisbanes/gradle-mvn-push/master/gradle-mvn-push.gradle' + +android { + compileSdkVersion 23 + buildToolsVersion "23.0.1" + + defaultConfig { + minSdkVersion 14 + targetSdkVersion 23 + versionCode 1 + versionName "1.0" + } + buildTypes { + release { + minifyEnabled false + } + } +} + +dependencies { + compile fileTree(dir: 'libs', include: ['*.jar']) + compile 'com.android.support:appcompat-v7:23.1.1' + compile 'com.android.support:design:23.1.1' + testCompile 'junit:junit:4.12' +} diff --git a/dexter/src/main/AndroidManifest.xml b/dexter/src/main/AndroidManifest.xml new file mode 100644 index 00000000..30baf825 --- /dev/null +++ b/dexter/src/main/AndroidManifest.xml @@ -0,0 +1,28 @@ + + + + + + + + + diff --git a/dexter/src/main/java/com/karumi/dexter/Dexter.java b/dexter/src/main/java/com/karumi/dexter/Dexter.java new file mode 100644 index 00000000..a989eb10 --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/Dexter.java @@ -0,0 +1,67 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter; + +import android.app.Activity; +import android.app.Application; +import android.content.Context; +import com.karumi.dexter.listener.PermissionListener; + +/** + * Class to simplify the management of Android runtime permissions + * Dexter needs to be initialized before checking for a permission using {@link + * #initialize(Context)} + */ +public final class Dexter { + + private static DexterInstance instance; + + /** + * Initializes the library + * + * @param context Context used by Dexter. Use your {@link Application} to make sure the instance + * is not cleaned up during your app lifetime + */ + public static void initialize(Context context) { + if (instance == null) { + instance = new DexterInstance(context); + } + } + + /** + * Checks the permission and notifies the listener of its state + * It is important to note that permissions still have to be declared in the manifest + * + * @param permission One of the values found in {@link android.Manifest.permission} + * @param listener The class that will be reported when the state of the permission is ready + */ + public static void checkPermission(String permission, PermissionListener listener) { + instance.checkPermission(permission, listener); + } + + static void onActivityCreated(Activity activity) { + instance.onActivityCreated(activity); + } + + static void onPermissionRequestGranted() { + instance.onPermissionRequestGranted(); + } + + static void onPermissionRequestDenied() { + instance.onPermissionRequestDenied(); + } +} diff --git a/dexter/src/main/java/com/karumi/dexter/DexterActivity.java b/dexter/src/main/java/com/karumi/dexter/DexterActivity.java new file mode 100644 index 00000000..5fa3e8b2 --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/DexterActivity.java @@ -0,0 +1,40 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter; + +import android.app.Activity; +import android.content.pm.PackageManager; +import android.os.Bundle; +import android.view.WindowManager; + +public final class DexterActivity extends Activity { + + @Override protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + Dexter.onActivityCreated(this); + getWindow().addFlags(WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE); + } + + @Override public void onRequestPermissionsResult(int requestCode, String[] permissions, + int[] grantResults) { + if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) { + Dexter.onPermissionRequestGranted(); + } else { + Dexter.onPermissionRequestDenied(); + } + } +} diff --git a/dexter/src/main/java/com/karumi/dexter/DexterInstance.java b/dexter/src/main/java/com/karumi/dexter/DexterInstance.java new file mode 100644 index 00000000..cd740004 --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/DexterInstance.java @@ -0,0 +1,144 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter; + +import android.app.Activity; +import android.content.Context; +import android.content.Intent; +import android.content.pm.PackageManager; +import android.support.v4.app.ActivityCompat; +import android.support.v4.content.ContextCompat; +import com.karumi.dexter.listener.PermissionListener; +import java.util.concurrent.atomic.AtomicBoolean; + +/** + * Inner implementation of a dexter instance + */ +final class DexterInstance { + + private String permission; + private Context context; + private Activity activity; + private PermissionListener listener; + private AtomicBoolean isRequestingPermission = new AtomicBoolean(false); + + DexterInstance(Context context) { + this.context = context; + } + + /** + * Checks the state of a specific permission reporting it when ready to the listener + * + * @param permission One of the values found in {@link android.Manifest.permission} + * @param listener The class that will be reported when the state of the permission is ready + */ + void checkPermission(String permission, PermissionListener listener) { + if (isRequestingPermission.getAndSet(true)) { + throw new IllegalStateException( + "Only one permission request at a time. Currently handling permission: [" + + this.permission + "]"); + } + + this.permission = permission; + this.listener = listener; + + Intent intent = new Intent(context, DexterActivity.class); + intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); + context.startActivity(intent); + } + + /** + * Method called whenever the inner activity has been created and is ready to be used + */ + void onActivityCreated(Activity activity) { + this.activity = activity; + + int permissionState = ContextCompat.checkSelfPermission(activity, permission); + switch (permissionState) { + case PackageManager.PERMISSION_DENIED: + handleDeniedPermission(permission); + break; + case PackageManager.PERMISSION_GRANTED: + default: + finishWithGrantedPermission(permission); + break; + } + } + + /** + * Method called whenever the permission has been granted by the user + */ + void onPermissionRequestGranted() { + finishWithGrantedPermission(permission); + } + + /** + * Method called whenever the permission has been denied by the user + */ + void onPermissionRequestDenied() { + finishWithDeniedPermission(permission); + } + + /** + * Method called when the user has been informed with the rationale and agrees to continue + * with the permission request process + */ + void onContinuePermissionRequest(String permission) { + requestPermission(permission); + } + + /** + * Method called when the user has been informed with the rationale and decides to cancel + * the permission request process + */ + void onCancelPermissionRequest(String permission) { + finishWithDeniedPermission(permission); + } + + /** + * Starts the native request permission process + */ + void requestPermission(String permission) { + int permissionCode = getPermissionCodeForPermission(permission); + ActivityCompat.requestPermissions(activity, new String[] {permission}, permissionCode); + } + + private void handleDeniedPermission(String permission) { + if (ActivityCompat.shouldShowRequestPermissionRationale(activity, permission)) { + PermissionRationaleToken permissionToken = new PermissionRationaleToken(this, permission); + listener.onPermissionRationaleShouldBeShown(permission, permissionToken); + } else { + requestPermission(permission); + } + } + + private void finishWithGrantedPermission(String permission) { + activity.finish(); + listener.onPermissionGranted(permission); + isRequestingPermission.set(false); + } + + private void finishWithDeniedPermission(String permission) { + activity.finish(); + listener.onPermissionDenied(permission); + isRequestingPermission.set(false); + } + + private int getPermissionCodeForPermission(String permission) { + return permission.hashCode(); + } +} diff --git a/dexter/src/main/java/com/karumi/dexter/PermissionRationaleToken.java b/dexter/src/main/java/com/karumi/dexter/PermissionRationaleToken.java new file mode 100644 index 00000000..c80e5256 --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/PermissionRationaleToken.java @@ -0,0 +1,47 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter; + +final class PermissionRationaleToken implements PermissionToken { + + private final DexterInstance dexterInstance; + private final String permission; + private boolean isTokenResolved = false; + + public PermissionRationaleToken(DexterInstance dexterInstance, String permission) { + this.dexterInstance = dexterInstance; + this.permission = permission; + } + + @Override public void continuePermissionRequest() { + if (!isTokenResolved) { + dexterInstance.onContinuePermissionRequest(permission); + isTokenResolved = true; + } + } + + @Override public void cancelPermissionRequest() { + if (!isTokenResolved) { + dexterInstance.onCancelPermissionRequest(permission); + isTokenResolved = true; + } + } + + boolean isTokenResolved() { + return isTokenResolved; + } +} diff --git a/dexter/src/main/java/com/karumi/dexter/PermissionToken.java b/dexter/src/main/java/com/karumi/dexter/PermissionToken.java new file mode 100644 index 00000000..5285ef9b --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/PermissionToken.java @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter; + +/** + * Utility class to let clients show the user how is the permission going to be used + * Clients of this class must call one of the two methods and only once + */ +public interface PermissionToken { + + /** + * Continues with the permission request process + */ + void continuePermissionRequest(); + + /** + * Cancels the permission request process + */ + void cancelPermissionRequest(); +} diff --git a/dexter/src/main/java/com/karumi/dexter/listener/DialogOnDeniedPermissionListener.java b/dexter/src/main/java/com/karumi/dexter/listener/DialogOnDeniedPermissionListener.java new file mode 100644 index 00000000..8544d932 --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/listener/DialogOnDeniedPermissionListener.java @@ -0,0 +1,117 @@ +/* + * Copyright (C) 2015 Karumi. + */ + +package com.karumi.dexter.listener; + +import android.app.AlertDialog; +import android.app.Dialog; +import android.content.Context; +import android.content.DialogInterface; +import android.graphics.drawable.Drawable; +import android.support.annotation.DrawableRes; +import android.support.annotation.StringRes; + +/** + * Utility listener that shows a {@link Dialog} with a minimum configuration when the user rejects + * some permission. + */ +public class DialogOnDeniedPermissionListener extends EmptyPermissionListener { + + private final Context context; + private final String title; + private final String message; + private final String positiveButtonText; + private final Drawable icon; + + private DialogOnDeniedPermissionListener(Context context, String title, String message, + String positiveButtonText, Drawable icon) { + this.context = context; + this.title = title; + this.message = message; + this.positiveButtonText = positiveButtonText; + this.icon = icon; + } + + @Override public void onPermissionDenied(String permission) { + super.onPermissionDenied(permission); + + new AlertDialog.Builder(context) + .setTitle(title) + .setMessage(message) + .setPositiveButton(positiveButtonText, new DialogInterface.OnClickListener() { + @Override public void onClick(DialogInterface dialog, int which) { + dialog.dismiss(); + } + }) + .setIcon(icon) + .show(); + } + + /** + * Builder class to configure the displayed dialog. + * Non set fields will be initialized to an empty string. + */ + public static class Builder { + private final Context context; + private String title; + private String message; + private String buttonText; + private Drawable icon; + + private Builder(Context context) { + this.context = context; + } + + public static Builder withContext(Context context) { + return new Builder(context); + } + + public Builder withTitle(String title) { + this.title = title; + return this; + } + + public Builder withTitle(@StringRes int resId) { + this.title = context.getString(resId); + return this; + } + + public Builder withMessage(String message) { + this.message = message; + return this; + } + + public Builder withMessage(@StringRes int resId) { + this.message = context.getString(resId); + return this; + } + + public Builder withButtonText(String buttonText) { + this.buttonText = buttonText; + return this; + } + + public Builder withButtonText(@StringRes int resId) { + this.buttonText = context.getString(resId); + return this; + } + + public Builder withIcon(Drawable icon) { + this.icon = icon; + return this; + } + + public Builder withIcon(@DrawableRes int resId) { + this.icon = context.getResources().getDrawable(resId); + return this; + } + + public DialogOnDeniedPermissionListener build() { + String title = this.title == null ? "" : this.title; + String message = this.message == null ? "" : this.message; + String buttonText = this.buttonText == null ? "" : this.buttonText; + return new DialogOnDeniedPermissionListener(context, title, message, buttonText, icon); + } + } +} diff --git a/dexter/src/main/java/com/karumi/dexter/listener/EmptyPermissionListener.java b/dexter/src/main/java/com/karumi/dexter/listener/EmptyPermissionListener.java new file mode 100644 index 00000000..3f8054c2 --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/listener/EmptyPermissionListener.java @@ -0,0 +1,39 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter.listener; + +import com.karumi.dexter.PermissionToken; + +/** + * Empty implementation of {@link PermissionListener} to allow extensions to implement only the + * required methods. + */ +public class EmptyPermissionListener implements PermissionListener { + + @Override public void onPermissionGranted(String permission) { + + } + + @Override public void onPermissionDenied(String permission) { + + } + + @Override + public void onPermissionRationaleShouldBeShown(String permission, PermissionToken token) { + + } +} diff --git a/dexter/src/main/java/com/karumi/dexter/listener/MultiPermissionListener.java b/dexter/src/main/java/com/karumi/dexter/listener/MultiPermissionListener.java new file mode 100644 index 00000000..a438eee3 --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/listener/MultiPermissionListener.java @@ -0,0 +1,67 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter.listener; + +import com.karumi.dexter.PermissionToken; +import java.util.Arrays; +import java.util.Collection; + +/** + * Listener that composes multiple listeners into one. + * All inner listeners will be called for a given event unless one of them throws an exception or + * is blocked. + */ +public class MultiPermissionListener implements PermissionListener { + + private final Collection listeners; + + /** + * Creates a {@link MultiPermissionListener} containing all the provided listeners. + * This constructor does not guaranty any calling order on inner listeners. + */ + public MultiPermissionListener(PermissionListener... listeners) { + this(Arrays.asList(listeners)); + } + + /** + * Creates a {@link MultiPermissionListener} containing all the provided listeners. + * This constructor will guaranty that inner listeners are called following the iterator order + * of the collection. + */ + public MultiPermissionListener(Collection listeners) { + this.listeners = listeners; + } + + @Override public void onPermissionGranted(String permission) { + for (PermissionListener listener : listeners) { + listener.onPermissionGranted(permission); + } + } + + @Override public void onPermissionDenied(String permission) { + for (PermissionListener listener : listeners) { + listener.onPermissionDenied(permission); + } + } + + @Override + public void onPermissionRationaleShouldBeShown(String permission, PermissionToken token) { + for (PermissionListener listener : listeners) { + listener.onPermissionRationaleShouldBeShown(permission, token); + } + } +} diff --git a/dexter/src/main/java/com/karumi/dexter/listener/PermissionListener.java b/dexter/src/main/java/com/karumi/dexter/listener/PermissionListener.java new file mode 100644 index 00000000..3376fb7e --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/listener/PermissionListener.java @@ -0,0 +1,52 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter.listener; + +import com.karumi.dexter.PermissionToken; + +/** + * Interface that listens to updates to the permission requests. + */ +public interface PermissionListener { + + /** + * Method called whenever a requested permission has been granted. + * + * @param permission The permission that has been requested. One of the values found in {@link + * android.Manifest.permission} + */ + void onPermissionGranted(String permission); + + /** + * Method called whenever a requested permission has been denied. + * + * @param permission The permission that has been requested. One of the values found in {@link + * android.Manifest.permission} + */ + void onPermissionDenied(String permission); + + /** + * Method called whenever Android asks the application to inform the user of the need for the + * requested permission. The request process won't continue until the token is properly used. + * + * @param permission The permission that has been requested. One of the values found in {@link + * android.Manifest.permission} + * @param token Token used to continue or cancel the permission request process. The permission + * request process will remain blocked until one of the token methods is called. + */ + void onPermissionRationaleShouldBeShown(String permission, PermissionToken token); +} diff --git a/dexter/src/main/java/com/karumi/dexter/listener/SnackbarOnDeniedPermissionListener.java b/dexter/src/main/java/com/karumi/dexter/listener/SnackbarOnDeniedPermissionListener.java new file mode 100644 index 00000000..f31a62ba --- /dev/null +++ b/dexter/src/main/java/com/karumi/dexter/listener/SnackbarOnDeniedPermissionListener.java @@ -0,0 +1,144 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter.listener; + +import android.content.Context; +import android.content.Intent; +import android.net.Uri; +import android.provider.Settings; +import android.support.annotation.StringRes; +import android.support.design.widget.Snackbar; +import android.view.LayoutInflater; +import android.view.View; +import android.view.ViewGroup; +import com.karumi.dexter.R; + +/** + * Utility listener that shows a {@link Snackbar} with a custom text whenever a permission has been + * denied + */ +public class SnackbarOnDeniedPermissionListener extends EmptyPermissionListener { + + private final Context context; + private final ViewGroup rootView; + private final String text; + private final String buttonText; + private final View.OnClickListener onButtonClickListener; + + /** + * @param context Context to inflate the snackbar + * @param rootView Parent view to show the snackbar + * @param text Message displayed in the snackbar + * @param buttonText Message displayed in the snackbar button + * @param onButtonClickListener Action performed when the user clicks the snackbar button + */ + private SnackbarOnDeniedPermissionListener(Context context, ViewGroup rootView, String text, + String buttonText, View.OnClickListener onButtonClickListener) { + this.context = context; + this.rootView = rootView; + this.text = text; + this.buttonText = buttonText; + this.onButtonClickListener = onButtonClickListener; + } + + @Override public void onPermissionDenied(String permission) { + super.onPermissionDenied(permission); + + LayoutInflater inflater = LayoutInflater.from(context); + View snackbarView = inflater.inflate(R.layout.snackbar, rootView); + Snackbar snackbar = Snackbar.make(snackbarView, text, Snackbar.LENGTH_LONG); + if (buttonText != null && onButtonClickListener != null) { + snackbar.setAction(buttonText, onButtonClickListener); + } + snackbar.show(); + } + + /** + * Builder class to configure the displayed snackbar + * Non set fields will not be shown + */ + public static class Builder { + private final Context context; + private final ViewGroup rootView; + private final String text; + private String buttonText; + private View.OnClickListener onClickListener; + + private Builder(Context context, ViewGroup rootView, String text) { + this.context = context; + this.rootView = rootView; + this.text = text; + } + + public static Builder with(Context context, ViewGroup rootView, String text) { + return new Builder(context, rootView, text); + } + + public static Builder with(Context context, ViewGroup rootView, @StringRes int textResourceId) { + return Builder.with(context, rootView, context.getString(textResourceId)); + } + + /** + * Adds a text button with the provided click listener + */ + public Builder withButton(String buttonText, View.OnClickListener onClickListener) { + this.buttonText = buttonText; + this.onClickListener = onClickListener; + return this; + } + + /** + * Adds a text button with the provided click listener + */ + public Builder withButton(@StringRes int buttonTextResourceId, + View.OnClickListener onClickListener) { + return withButton(context.getString(buttonTextResourceId), onClickListener); + } + + /** + * Adds a button that opens the application settings when clicked + */ + public Builder withOpenSettingsButton(String buttonText) { + this.buttonText = buttonText; + this.onClickListener = new View.OnClickListener() { + @Override public void onClick(View v) { + Intent myAppSettings = new Intent(Settings.ACTION_APPLICATION_DETAILS_SETTINGS, + Uri.parse("package:" + context.getPackageName())); + myAppSettings.addCategory(Intent.CATEGORY_DEFAULT); + myAppSettings.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK); + context.startActivity(myAppSettings); + } + }; + return this; + } + + /** + * Adds a button that opens the application settings when clicked + */ + public Builder withOpenSettingsButton(@StringRes int buttonTextResourceId) { + return withOpenSettingsButton(context.getString(buttonTextResourceId)); + } + + /** + * Builds a new instance of {@link SnackbarOnDeniedPermissionListener} + */ + public SnackbarOnDeniedPermissionListener build() { + return new SnackbarOnDeniedPermissionListener(context, rootView, text, buttonText, + onClickListener); + } + } +} diff --git a/dexter/src/main/res/layout/snackbar.xml b/dexter/src/main/res/layout/snackbar.xml new file mode 100644 index 00000000..23a16cb8 --- /dev/null +++ b/dexter/src/main/res/layout/snackbar.xml @@ -0,0 +1,24 @@ + + + + \ No newline at end of file diff --git a/dexter/src/main/res/values/strings.xml b/dexter/src/main/res/values/strings.xml new file mode 100644 index 00000000..30fc8c96 --- /dev/null +++ b/dexter/src/main/res/values/strings.xml @@ -0,0 +1,19 @@ + + + + Dexter + \ No newline at end of file diff --git a/dexter/src/main/res/values/styles.xml b/dexter/src/main/res/values/styles.xml new file mode 100644 index 00000000..8161377e --- /dev/null +++ b/dexter/src/main/res/values/styles.xml @@ -0,0 +1,28 @@ + + + + + + \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 00000000..379e3f48 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,18 @@ +POM_NAME=Dexter +POM_ARTIFACT_ID=dexter +POM_PACKAGING=aar + +VERSION_NAME=1.0.0-SNAPSHOT +VERSION_CODE=100000 +GROUP=com.karumi + +POM_DESCRIPTION=Dexter is an Android library to handle runtime permissions for Marshmallow easily +POM_URL=https://github.com/karumi/Dexter +POM_SCM_URL=https://github.com/karumi/Dexter +POM_SCM_CONNECTION=scm:git@github.com:karumi/Dexter.git +POM_SCM_DEV_CONNECTION=scm:git@github.com:karumi/Dexter.git +POM_LICENCE_NAME=The Apache Software License, Version 2.0 +POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt +POM_LICENCE_DIST=repo +POM_DEVELOPER_ID=karumi +POM_DEVELOPER_NAME=Karumi \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..8c0fb64a Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..4df27c26 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Thu Nov 12 18:14:23 CET 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.4-all.zip diff --git a/gradlew b/gradlew new file mode 100755 index 00000000..91a7e269 --- /dev/null +++ b/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# For Cygwin, ensure paths are in UNIX format before anything is touched. +if $cygwin ; then + [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` +fi + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >&- +APP_HOME="`pwd -P`" +cd "$SAVED" >&- + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..aec99730 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/sample/.gitignore b/sample/.gitignore new file mode 100644 index 00000000..796b96d1 --- /dev/null +++ b/sample/.gitignore @@ -0,0 +1 @@ +/build diff --git a/sample/build.gradle b/sample/build.gradle new file mode 100644 index 00000000..415db4c6 --- /dev/null +++ b/sample/build.gradle @@ -0,0 +1,26 @@ +apply plugin: 'com.android.application' + +android { + compileSdkVersion 23 + buildToolsVersion "23.0.1" + + defaultConfig { + applicationId "com.karumi.dexter.sample" + minSdkVersion 14 + targetSdkVersion 23 + versionCode 1 + versionName "1.0" + } + buildTypes { + release { + minifyEnabled false + } + } +} + +dependencies { + compile fileTree(include: ['*.jar'], dir: 'libs') + compile 'com.android.support:appcompat-v7:23.1.1' + compile 'com.jakewharton:butterknife:7.0.1' + compile project(':dexter') +} diff --git a/sample/src/main/AndroidManifest.xml b/sample/src/main/AndroidManifest.xml new file mode 100644 index 00000000..b9a60ba9 --- /dev/null +++ b/sample/src/main/AndroidManifest.xml @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/sample/src/main/java/com/karumi/dexter/sample/SampleActivity.java b/sample/src/main/java/com/karumi/dexter/sample/SampleActivity.java new file mode 100644 index 00000000..4ce5f491 --- /dev/null +++ b/sample/src/main/java/com/karumi/dexter/sample/SampleActivity.java @@ -0,0 +1,148 @@ +/* + * Copyright (C) 2015 Karumi. + * + * Licensed 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 com.karumi.dexter.sample; + +import android.Manifest; +import android.annotation.TargetApi; +import android.app.Activity; +import android.app.AlertDialog; +import android.content.DialogInterface; +import android.os.Build; +import android.os.Bundle; +import android.support.v4.content.ContextCompat; +import android.view.ViewGroup; +import android.widget.TextView; +import butterknife.Bind; +import butterknife.ButterKnife; +import butterknife.OnClick; +import com.karumi.dexter.Dexter; +import com.karumi.dexter.PermissionToken; +import com.karumi.dexter.listener.DialogOnDeniedPermissionListener; +import com.karumi.dexter.listener.MultiPermissionListener; +import com.karumi.dexter.listener.PermissionListener; +import com.karumi.dexter.listener.SnackbarOnDeniedPermissionListener; + +/** + * Sample activity showing the permission request process with Dexter. + */ +public class SampleActivity extends Activity implements PermissionListener { + + @Bind(R.id.audio_permission_feedback) TextView audioPermissionFeedbackView; + @Bind(R.id.camera_permission_feedback) TextView cameraPermissionFeedbackView; + @Bind(R.id.contacts_permission_feedback) TextView contactsPermissionFeedbackView; + @Bind(android.R.id.content) ViewGroup rootView; + + private PermissionListener cameraPermissionListener; + private PermissionListener contactsPermissionListener; + private PermissionListener audioPermissionListener; + + @Override protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.sample_activity); + ButterKnife.bind(this); + createPermissionListeners(); + } + + @OnClick(R.id.camera_permission_button) public void onCameraPermissionButtonClicked() { + Dexter.checkPermission(Manifest.permission.CAMERA, cameraPermissionListener); + } + + @OnClick(R.id.contacts_permission_button) public void onContactsPermissionButtonClicked() { + Dexter.checkPermission(Manifest.permission.READ_CONTACTS, contactsPermissionListener); + } + + @OnClick(R.id.audio_permission_button) public void onAudioPermissionButtonClicked() { + Dexter.checkPermission(Manifest.permission.RECORD_AUDIO, audioPermissionListener); + } + + @Override public void onPermissionGranted(String permission) { + if (Manifest.permission.CAMERA.equals(permission)) { + showPermissionGranted(cameraPermissionFeedbackView); + } else if (Manifest.permission.READ_CONTACTS.equals(permission)) { + showPermissionGranted(contactsPermissionFeedbackView); + } else if (Manifest.permission.RECORD_AUDIO.equals(permission)) { + showPermissionGranted(audioPermissionFeedbackView); + } + } + + @Override public void onPermissionDenied(String permission) { + if (Manifest.permission.CAMERA.equals(permission)) { + showPermissionDenied(cameraPermissionFeedbackView); + } else if (Manifest.permission.READ_CONTACTS.equals(permission)) { + showPermissionDenied(contactsPermissionFeedbackView); + } else if (Manifest.permission.RECORD_AUDIO.equals(permission)) { + showPermissionDenied(audioPermissionFeedbackView); + } + } + + @TargetApi(Build.VERSION_CODES.JELLY_BEAN_MR1) @Override + public void onPermissionRationaleShouldBeShown(String permission, final PermissionToken token) { + new AlertDialog.Builder(this) + .setTitle(R.string.permission_rationale_title) + .setMessage(R.string.permission_rationale_message) + .setNegativeButton(android.R.string.cancel, new DialogInterface.OnClickListener() { + @Override public void onClick(DialogInterface dialog, int which) { + dialog.dismiss(); + token.cancelPermissionRequest(); + } + }) + .setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() { + @Override public void onClick(DialogInterface dialog, int which) { + dialog.dismiss(); + token.continuePermissionRequest(); + } + }) + .setOnDismissListener(new DialogInterface.OnDismissListener() { + @Override public void onDismiss(DialogInterface dialog) { + token.cancelPermissionRequest(); + } + }) + .show(); + } + + private void showPermissionGranted(TextView feedbackView) { + feedbackView.setText(R.string.permission_granted_feedback); + feedbackView.setTextColor(ContextCompat.getColor(this, R.color.permission_granted)); + } + + private void showPermissionDenied(TextView feedbackView) { + feedbackView.setText(R.string.permission_denied_feedback); + feedbackView.setTextColor(ContextCompat.getColor(this, R.color.permission_denied)); + } + + private void createPermissionListeners() { + cameraPermissionListener = new MultiPermissionListener(this, + SnackbarOnDeniedPermissionListener.Builder + .with(this, rootView, R.string.camera_permission_denied_feedback) + .withOpenSettingsButton(R.string.permission_rationale_settings_button_text) + .build()); + contactsPermissionListener = new MultiPermissionListener(this, + SnackbarOnDeniedPermissionListener.Builder + .with(this, rootView, R.string.contacts_permission_denied_feedback) + .withOpenSettingsButton(R.string.permission_rationale_settings_button_text) + .build()); + PermissionListener dialogOnDeniedPermissionListener = + DialogOnDeniedPermissionListener.Builder + .withContext(this) + .withTitle(R.string.audio_permission_denied_dialog_title) + .withMessage(R.string.audio_permission_denied_dialog_feedback) + .withButtonText(android.R.string.ok) + .withIcon(R.mipmap.ic_logo_karumi) + .build(); + audioPermissionListener = new MultiPermissionListener(this, dialogOnDeniedPermissionListener); + } +} diff --git a/sample/src/main/java/com/karumi/dexter/sample/SampleApplication.java b/sample/src/main/java/com/karumi/dexter/sample/SampleApplication.java new file mode 100644 index 00000000..c84f335f --- /dev/null +++ b/sample/src/main/java/com/karumi/dexter/sample/SampleApplication.java @@ -0,0 +1,19 @@ +/* + * Copyright (C) 2015 Karumi. + */ + +package com.karumi.dexter.sample; + +import android.app.Application; +import com.karumi.dexter.Dexter; + +/** + * Sample application that initializes the Dexter library. + */ +public class SampleApplication extends Application { + + @Override public void onCreate() { + super.onCreate(); + Dexter.initialize(this); + } +} diff --git a/sample/src/main/res/layout/header.xml b/sample/src/main/res/layout/header.xml new file mode 100644 index 00000000..1dfa6065 --- /dev/null +++ b/sample/src/main/res/layout/header.xml @@ -0,0 +1,40 @@ + + + + + + + + + \ No newline at end of file diff --git a/sample/src/main/res/layout/sample_activity.xml b/sample/src/main/res/layout/sample_activity.xml new file mode 100644 index 00000000..1f1c6d2b --- /dev/null +++ b/sample/src/main/res/layout/sample_activity.xml @@ -0,0 +1,88 @@ + + + + + + +