├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── main ├── kotlin └── il │ └── co │ └── galex │ └── tools │ └── permissions │ ├── model │ ├── DangerousPermission.kt │ └── PermissionsExtension.kt │ ├── plugin │ └── PermissionsPlugin.kt │ ├── task │ └── GenerateHelperTask.kt │ └── util │ ├── FileExtensions.kt │ └── FilterExtensions.kt └── resources ├── META-INF └── gradle-plugins │ └── il.co.galex.permissions.properties └── templates └── PermissionsHelper.java.template /.gitignore: -------------------------------------------------------------------------------- 1 | *.idea 2 | build 3 | .gradle 4 | *.iml 5 | out 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Android Permissions Gradle Plugin (2.0.1) 2 | ## Introduction 3 | Since Android Marshmallow, developers have to [request permissions](http://developer.android.com/guide/topics/security/permissions.html) the Android SDK considers dangerous, aka [Dangerous Permissions](http://developer.android.com/guide/topics/security/permissions.html#normal-dangerous). 4 | 5 | This plugin generates a class to help with that task. It parses the Android Manifest on build and generates a helper class with the list of the Dangerous Permissions plus a few utility methods. 6 | ## Generated Code 7 | If your manifest contains those three permissions: 8 | ```xml 9 | 10 | 11 | 12 | 13 | 14 | ``` 15 | The plugin will generate this helper class named PermissionsHelper: 16 | 17 | ```java 18 | public class PermissionsHelper { 19 | public static final String [] REQUIRED_PERMISSIONS = { 20 | Manifest.permission.GET_ACCOUNTS, 21 | Manifest.permission.READ_PHONE_STATE 22 | }; 23 | (...) 24 | } 25 | ``` 26 | The generated class contains a static String [] of all the dangerous permissions from the manifest. 27 | Note that you can see here only two declared permissions as the permission `android.permission.INTERNET` is a not a dangerous permission. 28 | ## Usage 29 | In your root build.gradle add the plugin, published in jCenter: 30 | 31 | ```gradle 32 | buildscript { 33 | repositories { 34 | jcenter() 35 | } 36 | dependencies { 37 | (...) 38 | classpath 'il.co.galex.tools.build:permissions:2.0.1' 39 | } 40 | } 41 | 42 | ``` 43 | 44 | In every Android Application or Library module, apply the plugin: 45 | ```gradle 46 | apply plugin: 'il.co.galex.permissions' 47 | ``` 48 | ## Nomenclature 49 | The generated class helper is named by default `PermissionsHelper` and the default package name depends on `variant.applicationId`. 50 | If `variant.applicationId` is for instance `com.example.company`, the package name will be `com.example.company.helper`. 51 | ## Configuration 52 | You can change the package name and the class name to suit your needs. 53 | For instance if you prefer the 'utils' convention: 54 | ```gradle 55 | android { 56 | (...) 57 | } 58 | permissions { 59 | helperPackage android.defaultConfig.applicationId + ".util" 60 | helperClassName "PermissionsUtils" 61 | } 62 | ``` 63 | ## Utility Methods 64 | The class contains utility methods to ease the work with the [System Permissions API](http://developer.android.com/guide/topics/security/permissions.html). 65 | 66 | ```java 67 | public static boolean granted(Context context) {} 68 | public static boolean granted(Context context, String... permissions){} 69 | public static String [] filterGranted(Context context) {} 70 | public static String [] filterGranted(Context context, String... permissions){} 71 | public static String [] filterNotGranted(Context context) {} 72 | public static String [] filterNotGranted(Context context, String... permissions) {} 73 | ``` 74 | 75 | ## Change log 76 | 77 | - *2.0.1* Bug fix where the parameter "helperPackage" was not used as import 78 | - 2.0.0 Entirely rewritten in [Kotlin](https://kotlinlang.org/), yay! 79 | - 1.1.0 Compatibility fix for the Android Gradle Plugin 3.0.0-alpha5 80 | - 1.0.7 Compile plugin with JDK 6 to avoid a compatibility error 81 | - 1.0.6 First release 82 | 83 | ## Next steps 84 | 85 | - Get rid of templates for the code generation and use JavaPoet 86 | - Add an option to generate a Kotlin helper class via KotlinPoet instead of the Java helper class 87 | 88 | ## License 89 | This plugin is available under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). 90 | 91 | (c) All rights reserved Alexander Gherschon -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'maven-publish' 2 | apply plugin: 'kotlin' 3 | apply plugin: 'com.jfrog.bintray' 4 | 5 | ext { 6 | pluginGroupId = 'il.co.galex.tools.build' 7 | pluginVersion = '2.0.1' 8 | 9 | } 10 | 11 | buildscript { 12 | 13 | ext.kotlin_version = '1.2.21' 14 | 15 | repositories { 16 | jcenter() 17 | mavenCentral() 18 | } 19 | dependencies { 20 | classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6' 21 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" 22 | } 23 | } 24 | 25 | repositories { 26 | google() 27 | jcenter() 28 | mavenCentral() 29 | } 30 | 31 | dependencies { 32 | 33 | compile gradleApi() 34 | compileOnly 'com.android.tools.build:gradle:3.0.1' 35 | } 36 | 37 | compileJava { 38 | sourceCompatibility = 1.6 39 | targetCompatibility = 1.6 40 | } 41 | 42 | task sourceJar(type: Jar) { 43 | from sourceSets.main.allJava 44 | } 45 | 46 | task javadocJar(type: Jar, dependsOn: javadoc) { 47 | from javadoc.destinationDir 48 | } 49 | 50 | publishing { 51 | publications { 52 | PermissionsPublication(MavenPublication) { 53 | groupId = pluginGroupId 54 | artifactId = 'permissions' 55 | version = pluginVersion 56 | from components.java 57 | 58 | artifact sourceJar { 59 | classifier "sources" 60 | } 61 | 62 | artifact javadocJar { 63 | classifier = 'javadoc' 64 | } 65 | } 66 | } 67 | } 68 | 69 | bintray { 70 | user bintrayUser 71 | key bintrayPass 72 | pkg { 73 | repo = 'maven' 74 | name = 'android-permissions-gradle-plugin' 75 | licenses = ['Apache-2.0'] 76 | vcsUrl = 'https://github.com/galex/android-permissions-gradle-plugin.git' 77 | 78 | version { 79 | name = pluginVersion 80 | desc = 'Android Permissions Gradle Plugin' 81 | released = new Date() 82 | vcsTag = pluginVersion 83 | publications = ['PermissionsPublication'] 84 | } 85 | } 86 | } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/galex/android-permissions-gradle-plugin/5cf356a8d2a329b096f40407b4ea024538548eb1/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sat Feb 06 11:11:16 IST 2016 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.4.1-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" >&- 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" >&- 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'android-permissions-gradle-plugin' 2 | 3 | -------------------------------------------------------------------------------- /src/main/kotlin/il/co/galex/tools/permissions/model/DangerousPermission.kt: -------------------------------------------------------------------------------- 1 | package il.co.galex.tools.permissions.model 2 | 3 | enum class DangerousPermission { 4 | 5 | READ_CALENDAR, 6 | WRITE_CALENDAR, 7 | CAMERA, 8 | READ_CONTACTS, 9 | WRITE_CONTACTS, 10 | GET_ACCOUNTS, 11 | ACCESS_FINE_LOCATION, 12 | ACCESS_COARSE_LOCATION, 13 | RECORD_AUDIO, 14 | READ_PHONE_STATE, 15 | CALL_PHONE, 16 | READ_CALL_LOG, 17 | WRITE_CALL_LOG, 18 | ADD_VOICEMAIL, 19 | USE_SIP, 20 | PROCESS_OUTGOING_CALLS, 21 | BODY_SENSORS, 22 | SEND_SMS, 23 | RECEIVE_SMS, 24 | READ_SMS, 25 | RECEIVE_WAP_PUSH, 26 | RECEIVE_MMS, 27 | READ_EXTERNAL_STORAGE, 28 | WRITE_EXTERNAL_STORAGE; 29 | 30 | /** 31 | * 'Manifest.permission' + enum name 32 | * @return the name of the variable containing this Permission in the Android SDK 33 | */ 34 | @Suppress("unused") // used from within templates 35 | val sdkName: String 36 | get() = "Manifest.permission.$name" 37 | 38 | companion object { 39 | /** 40 | * Get enum by its string value, if exists. 41 | * @param str 42 | * @return enum if the parameter str has an enum equivalent, and if not returns null 43 | */ 44 | fun get(str: String?): DangerousPermission? = values().firstOrNull { it.name == str } 45 | } 46 | } -------------------------------------------------------------------------------- /src/main/kotlin/il/co/galex/tools/permissions/model/PermissionsExtension.kt: -------------------------------------------------------------------------------- 1 | package il.co.galex.tools.permissions.model 2 | 3 | import java.util.regex.Pattern.compile 4 | 5 | open class PermissionsExtension { 6 | 7 | companion object { 8 | private val PACKAGE_IDENTIFIER = compile("(\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*\\.)*\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*") 9 | private val CLASS_IDENTIFIER = compile("[A-Z_](\$[A-Z_]|[\\w_])*") 10 | private const val ADVICE = ", please fix it or remove it from the permissions plugin configuration" 11 | } 12 | 13 | var helperPackage: String? = null 14 | set(value) { 15 | return if (PACKAGE_IDENTIFIER.matcher(value).matches()) field = value 16 | else throw IllegalArgumentException("helperPackage is not a valid package name" + ADVICE) 17 | } 18 | 19 | var helperClassName: String? = null 20 | set(value) { 21 | return if (CLASS_IDENTIFIER.matcher(value).matches()) field = value 22 | else throw IllegalArgumentException("helperClassName is not a valid class name" + ADVICE) 23 | } 24 | } -------------------------------------------------------------------------------- /src/main/kotlin/il/co/galex/tools/permissions/plugin/PermissionsPlugin.kt: -------------------------------------------------------------------------------- 1 | package il.co.galex.tools.permissions.plugin 2 | 3 | import com.android.build.gradle.AppExtension 4 | import com.android.build.gradle.AppPlugin 5 | import com.android.build.gradle.LibraryExtension 6 | import com.android.build.gradle.LibraryPlugin 7 | import com.android.build.gradle.api.BaseVariant 8 | import com.android.build.gradle.api.BaseVariantOutput 9 | import il.co.galex.tools.permissions.model.PermissionsExtension 10 | import il.co.galex.tools.permissions.task.GenerateHelperTask 11 | import org.gradle.api.DomainObjectSet 12 | import org.gradle.api.Plugin 13 | import org.gradle.api.Project 14 | import java.io.File 15 | 16 | open class PermissionsPlugin : Plugin { 17 | 18 | override fun apply(project: Project) { 19 | 20 | project.run { 21 | 22 | extensions.create("permissions", PermissionsExtension::class.java) 23 | val hasApp = plugins.hasPlugin(AppPlugin::class.java) 24 | val hasLib = plugins.hasPlugin(LibraryPlugin::class.java) 25 | 26 | if (!hasApp && !hasLib) { 27 | throw IllegalStateException("'com.android.application' or 'com.android.library' plugin required.") 28 | } 29 | 30 | val variants: DomainObjectSet = if (hasApp) { 31 | extensions.findByType(AppExtension::class.java)!!.applicationVariants 32 | } else { 33 | extensions.findByType(LibraryExtension::class.java)!!.libraryVariants 34 | } 35 | 36 | variants.all { variant: BaseVariant -> 37 | variant.outputs.all { output: BaseVariantOutput -> 38 | 39 | val taskName = "generate${variant.name.capitalize()}PermissionsHelper" 40 | 41 | val manifestOutFile = File(output.processManifest.manifestOutputDirectory.absolutePath + "/AndroidManifest.xml") 42 | val helperPackage = variant.applicationId + ".helper" 43 | val helperClassName = "PermissionsHelper" 44 | val outputHelper = project.file("${project.buildDir}/generated/source/permissions/${variant.name}/") 45 | 46 | val generateHelperTask = tasks.create(taskName, GenerateHelperTask::class.java) { 47 | it.manifestFile = manifestOutFile 48 | it.helperPackage = helperPackage 49 | it.helperClassName = helperClassName 50 | it.outputDir = outputHelper 51 | } 52 | 53 | generateHelperTask.dependsOn.add("process${variant.name.capitalize()}Manifest") 54 | generateHelperTask.group = "Permissions" 55 | generateHelperTask.description = "Generates an Helper class to help manage the declared dangerous permissions in the AndroidManifest.xml file" 56 | 57 | // register this task as generating code in the output helper folder 58 | variant.registerJavaGeneratingTask(generateHelperTask, outputHelper) 59 | } 60 | } 61 | } 62 | } 63 | } -------------------------------------------------------------------------------- /src/main/kotlin/il/co/galex/tools/permissions/task/GenerateHelperTask.kt: -------------------------------------------------------------------------------- 1 | package il.co.galex.tools.permissions.task 2 | 3 | import groovy.text.GStringTemplateEngine 4 | import il.co.galex.tools.permissions.model.DangerousPermission 5 | import il.co.galex.tools.permissions.model.PermissionsExtension 6 | import il.co.galex.tools.permissions.util.SUFFIX 7 | import il.co.galex.tools.permissions.util.file 8 | import il.co.galex.tools.permissions.util.requiredPermissions 9 | import org.gradle.api.DefaultTask 10 | import org.gradle.api.tasks.Input 11 | import org.gradle.api.tasks.TaskAction 12 | import java.io.File 13 | import java.io.PrintWriter 14 | 15 | open class GenerateHelperTask : DefaultTask() { 16 | 17 | companion object { 18 | private const val HELPER_TEMPLATE_PATH = "/templates/PermissionsHelper.java.template" 19 | } 20 | 21 | @Input 22 | var manifestFile: File? = null 23 | 24 | @Input 25 | var helperPackage: String? = null 26 | 27 | @Input 28 | var helperClassName: String? = null 29 | 30 | @Input 31 | var outputDir: File? = null 32 | 33 | 34 | @Suppress("unused") 35 | @TaskAction 36 | fun generateHelper() { 37 | 38 | val extension: PermissionsExtension? = project.extensions.findByType(PermissionsExtension::class.java) 39 | 40 | extension?.let { 41 | 42 | val classPackage: String? = extension.helperPackage ?: helperPackage 43 | val className: String? = extension.helperClassName ?: helperClassName 44 | val permissions: List? = manifestFile?.requiredPermissions() 45 | 46 | val tempFile: File = javaClass.getResource(HELPER_TEMPLATE_PATH).toURI().file 47 | val binding = mapOf( 48 | "permissions" to permissions, 49 | "helperPackage" to classPackage, 50 | "helperClassName" to className) 51 | 52 | val engine = GStringTemplateEngine() 53 | val template = engine.createTemplate(tempFile).make(binding) 54 | val generatedTemplate = template.toString() 55 | 56 | // write this string to the correct path of file 57 | val fileDirPath: String = outputDir?.absolutePath + "/" + classPackage?.replace('.', '/') + "/" 58 | val fileDir = File(fileDirPath) 59 | fileDir.mkdirs() 60 | val finalFile = File(fileDirPath + className + SUFFIX) 61 | finalFile.createNewFile() 62 | 63 | // write into the final file the generated template 64 | val out = PrintWriter(finalFile) 65 | out.println(generatedTemplate) 66 | out.close() 67 | } 68 | } 69 | } -------------------------------------------------------------------------------- /src/main/kotlin/il/co/galex/tools/permissions/util/FileExtensions.kt: -------------------------------------------------------------------------------- 1 | package il.co.galex.tools.permissions.util 2 | 3 | import org.apache.commons.io.IOUtils 4 | import java.io.File 5 | import java.io.FileOutputStream 6 | import java.io.InputStream 7 | import java.net.URI 8 | import java.util.jar.JarFile 9 | 10 | /** 11 | * File Utility class for file related stuff. 12 | * 13 | * @author Alexander Gherschon 14 | */ 15 | 16 | private const val PREFIX = "PermissionsHelper" 17 | public const val SUFFIX = ".java" 18 | 19 | private val URI.inputStream: InputStream 20 | get() { 21 | val params = toString().split('!') 22 | val jarPath = params[0] 23 | val resourcePath = params[1].substring(1) 24 | val jarFile = JarFile(jarPath.split(':')[2]) 25 | val jarEntry = jarFile.getEntry(resourcePath) 26 | return jarFile.getInputStream(jarEntry) 27 | } 28 | 29 | private val InputStream.resourceFile: File 30 | get() { 31 | val tempFile = File.createTempFile(PREFIX, SUFFIX) 32 | tempFile.deleteOnExit() 33 | val out = FileOutputStream(tempFile) 34 | IOUtils.copy(this, out) 35 | return tempFile 36 | } 37 | 38 | val URI.file: File 39 | get() = this.inputStream.resourceFile 40 | -------------------------------------------------------------------------------- /src/main/kotlin/il/co/galex/tools/permissions/util/FilterExtensions.kt: -------------------------------------------------------------------------------- 1 | package il.co.galex.tools.permissions.util 2 | 3 | import il.co.galex.tools.permissions.model.DangerousPermission 4 | import org.w3c.dom.Document 5 | import org.w3c.dom.NodeList 6 | import java.io.File 7 | import javax.xml.parsers.DocumentBuilderFactory 8 | 9 | 10 | fun File.requiredPermissions(): List { 11 | 12 | val requiredPermissionList = mutableListOf() 13 | 14 | if (exists()) { 15 | 16 | val xmlDoc: Document? = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(this) 17 | 18 | val usesPermissions: NodeList? = xmlDoc?.documentElement?.getElementsByTagName("uses-permission") 19 | 20 | usesPermissions?.let { 21 | 22 | val total = usesPermissions.length 23 | 24 | (0 until total).map { usesPermissions.item(it) }.forEach { 25 | 26 | val namedItem = it?.attributes?.getNamedItem("android:name") 27 | val permission = namedItem?.nodeValue?.substringAfterLast('.') 28 | val dangerousPermission = DangerousPermission.get(permission) 29 | if (dangerousPermission != null) requiredPermissionList.add(dangerousPermission) 30 | } 31 | } 32 | } 33 | return requiredPermissionList 34 | } -------------------------------------------------------------------------------- /src/main/resources/META-INF/gradle-plugins/il.co.galex.permissions.properties: -------------------------------------------------------------------------------- 1 | implementation-class=il.co.galex.tools.permissions.plugin.PermissionsPlugin -------------------------------------------------------------------------------- /src/main/resources/templates/PermissionsHelper.java.template: -------------------------------------------------------------------------------- 1 | package ${helperPackage}; 2 | 3 | import android.Manifest; 4 | import android.content.Context; 5 | import android.content.pm.PackageManager; 6 | import android.support.v4.content.ContextCompat; 7 | 8 | import java.util.ArrayList; 9 | 10 | /** 11 | * Helper class for Permissions Management (API >= 23). 12 | * 13 | * This class contains a static list of the dangerous permissions declared in the Android Manifest, plus 14 | * a set of static functions to help with the task of checking which were granted or not. 15 | * 16 | * @author android-permissions-gradle-plugin 17 | */ 18 | @SuppressWarnings("unused") 19 | public class ${helperClassName} { 20 | 21 | public static final String [] REQUIRED_PERMISSIONS = { <% permissions.eachWithIndex { item, index -> %> 22 | <%= item.getSdkName() %><%= index < permissions.size()-1 ? "," : "" %><% } %> 23 | }; 24 | 25 | private ${helperClassName}(){} 26 | 27 | /** 28 | * Checks if the dangerous permissions declared in the Manifest were granted by the user 29 | * 30 | * @param context Android context 31 | * @param permissions to verify 32 | * @return true if all the permissions were granted by the user 33 | */ 34 | public static boolean granted(Context context, String... permissions) { 35 | for (String permission : permissions) { 36 | if (ContextCompat.checkSelfPermission(context, permission) == PackageManager.PERMISSION_DENIED) 37 | return false; 38 | } 39 | return true; 40 | } 41 | 42 | /** 43 | * Checks if the dangerous permissions declared in the Manifest were granted by the user 44 | * 45 | * @param context Android context 46 | * @return true if all the permissions were granted by the user 47 | */ 48 | public static boolean granted(Context context) { 49 | for (String permission : REQUIRED_PERMISSIONS) { 50 | if (ContextCompat.checkSelfPermission(context, permission) == PackageManager.PERMISSION_DENIED) 51 | return false; 52 | } 53 | return true; 54 | } 55 | 56 | /** 57 | * Returns the permissions that were granted by the user from a set of permissions 58 | * 59 | * @param context Android context 60 | * @param permissions to verify 61 | * @return list of granted permissions 62 | */ 63 | public static String [] filterGranted(Context context, String... permissions) { 64 | ArrayList permitted = new ArrayList<>(); 65 | for (String permission : permissions) { 66 | if (granted(context, permission)) permitted.add(permission); 67 | } 68 | return permitted.toArray(new String [permitted.size()]); 69 | } 70 | 71 | /** 72 | * Returns the permissions that were granted by the user from the dangerous permissions declared in the Manifest 73 | * 74 | * @param context Android context 75 | * @return list of granted permissions 76 | */ 77 | public static String [] filterGranted(Context context) { 78 | ArrayList permitted = new ArrayList<>(); 79 | for (String permission : REQUIRED_PERMISSIONS) { 80 | if (granted(context, permission)) permitted.add(permission); 81 | } 82 | return permitted.toArray(new String [permitted.size()]); 83 | } 84 | 85 | /** 86 | * Returns the permissions that were not granted by the user from a set of permissions 87 | * 88 | * @param context Android context 89 | * @param permissions to verify 90 | * @return list of not granted permissions 91 | */ 92 | public static String [] filterNotGranted(Context context, String... permissions) { 93 | ArrayList nonPermitted = new ArrayList<>(); 94 | for (String permission : permissions) { 95 | if (!granted(context, permission)) nonPermitted.add(permission); 96 | } 97 | return nonPermitted.toArray(new String [nonPermitted.size()]); 98 | } 99 | 100 | /** 101 | * Returns the permissions that were not granted by the user from the dangerous permissions declared in the Manifest 102 | * 103 | * @param context Android context 104 | * @return list of not granted permissions 105 | */ 106 | public static String [] filterNotGranted(Context context) { 107 | ArrayList nonPermitted = new ArrayList<>(); 108 | for (String permission : REQUIRED_PERMISSIONS) { 109 | if (!granted(context, permission)) nonPermitted.add(permission); 110 | } 111 | return nonPermitted.toArray(new String [nonPermitted.size()]); 112 | } 113 | } 114 | --------------------------------------------------------------------------------