├── sample ├── .gitignore ├── src │ └── main │ │ ├── res │ │ ├── values │ │ │ ├── strings.xml │ │ │ ├── themes.xml │ │ │ └── colors.xml │ │ ├── mipmap-hdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-mdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-xhdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-xxhdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-xxxhdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-anydpi-v26 │ │ │ └── ic_launcher.xml │ │ └── drawable │ │ │ └── ic_call.xml │ │ ├── java │ │ └── com │ │ │ └── alexstyl │ │ │ └── warden │ │ │ └── sample │ │ │ ├── theme │ │ │ ├── Color.kt │ │ │ ├── Theme.kt │ │ │ └── Type.kt │ │ │ ├── Intents.kt │ │ │ ├── DialerActivity.kt │ │ │ └── DialerScreen.kt │ │ └── AndroidManifest.xml ├── README.md ├── proguard-rules.pro └── build.gradle ├── library ├── .gitignore ├── consumer-rules.pro ├── proguard-rules.pro ├── src │ └── main │ │ ├── java │ │ └── com │ │ │ └── alexstyl │ │ │ └── warden │ │ │ ├── PermissionState.kt │ │ │ ├── PermissionResultListener.kt │ │ │ ├── PermissionResults.kt │ │ │ ├── Warden.kt │ │ │ ├── WardenActivity.kt │ │ │ ├── PermissionResultsListener.kt │ │ │ └── AndroidWarden.kt │ │ ├── AndroidManifest.xml │ │ └── res │ │ └── values │ │ └── themes.xml └── build.gradle ├── assets └── banner.png ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── settings.gradle ├── versions.gradle ├── scripts ├── publish-root.gradle └── publish-module.gradle ├── gradle.properties ├── .gitignore ├── gradlew.bat ├── README.md ├── gradlew └── LICENSE /sample/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /library/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /library/consumer-rules.pro: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /assets/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alexstyl/warden/HEAD/assets/banner.png -------------------------------------------------------------------------------- /library/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | -keep public class * { 2 | public protected *; 3 | } 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alexstyl/warden/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /sample/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Warden (Sample) 3 | -------------------------------------------------------------------------------- /sample/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 15 | 16 | -------------------------------------------------------------------------------- /versions.gradle: -------------------------------------------------------------------------------- 1 | ext { 2 | majorVersion = 0 3 | minVersion = 0 4 | patchVersion = 2 5 | // libraryVersionName = "${majorVersion}.${minVersion}.${patchVersion}" 6 | libraryVersionName = "1.0.0-alpha${patchVersion}" 7 | libraryVersionCode = majorVersion * 1000 + minVersion * 100 + patchVersion 8 | 9 | javaVersion = JavaVersion.VERSION_11 10 | 11 | androidCompileSdkVersion = 31 12 | androidMinSdkVersion = 1 13 | 14 | composeVersion = '1.1.1' 15 | activityComposeVersion = '1.4.0' 16 | lifecycleViewModelComposeVersion = "2.5.0-alpha03" 17 | coreVersion = '1.7.0' 18 | gradlePluginVersion = '7.1.1' 19 | 20 | kotlinVersion = '1.6.10' 21 | coroutinesVersion = '1.6.0' 22 | 23 | hiltVersion = '2.40.5' 24 | junitVersion = '4.13.2' 25 | testRunnerVersion = '1.4.0' 26 | testRulesVersion = '1.4.0' 27 | testCoreVersion = '1.4.0' 28 | gradleNexusVersion = '1.1.0' 29 | assertjVersion = '3.21.0' 30 | robolectricVersion = '4.5.1' 31 | rxJavaVersion = '3.1.3' 32 | } 33 | -------------------------------------------------------------------------------- /sample/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | 8 | 14 | 15 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /scripts/publish-root.gradle: -------------------------------------------------------------------------------- 1 | File secretPropsFile = project.rootProject.file('local.properties') 2 | if (secretPropsFile.exists()) { 3 | // Read local.properties file first if it exists 4 | Properties p = new Properties() 5 | new FileInputStream(secretPropsFile).withCloseable { is -> p.load(is) } 6 | p.each { name, value -> ext[name] = value } 7 | } else { 8 | // Use system environment variables 9 | ext["ossrhUsername"] = System.getenv('OSSRH_USERNAME') 10 | ext["ossrhPassword"] = System.getenv('OSSRH_PASSWORD') 11 | ext["sonatypeStagingProfileId"] = System.getenv('SONATYPE_STAGING_PROFILE_ID') 12 | ext["signing.keyId"] = System.getenv('SIGNING_KEY_ID') 13 | ext["signing.password"] = System.getenv('SIGNING_PASSWORD') 14 | ext["signing.key"] = System.getenv('SIGNING_KEY') 15 | } 16 | 17 | nexusPublishing { 18 | repositories { 19 | sonatype { 20 | stagingProfileId = sonatypeStagingProfileId 21 | username = ossrhUsername 22 | password = ossrhPassword 23 | nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/")) 24 | snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")) 25 | } 26 | } 27 | } -------------------------------------------------------------------------------- /library/src/main/java/com/alexstyl/warden/WardenActivity.kt: -------------------------------------------------------------------------------- 1 | package com.alexstyl.warden 2 | 3 | import android.content.Context 4 | import android.content.Intent 5 | import android.os.Bundle 6 | import androidx.activity.ComponentActivity 7 | import androidx.activity.result.contract.ActivityResultContracts.RequestMultiplePermissions 8 | 9 | internal class WardenActivity : ComponentActivity() { 10 | 11 | private val requestPermission = registerForActivityResult(RequestMultiplePermissions()) { 12 | PermissionResultsListener.processPermissionResult(this, it) 13 | finish() 14 | } 15 | 16 | override fun onCreate(savedInstanceState: Bundle?) { 17 | super.onCreate(savedInstanceState) 18 | 19 | val permissions: Array = requireNotNull( 20 | intent.getStringArrayExtra(EXTRA_PERMISSIONS) 21 | ) 22 | requestPermission.launch(permissions) 23 | } 24 | 25 | companion object { 26 | private const val EXTRA_PERMISSIONS = "extra:permissions" 27 | 28 | fun requestPermission(context: Context, forPermission: Array): Intent { 29 | return Intent(context, WardenActivity::class.java).apply { 30 | flags = Intent.FLAG_ACTIVITY_NEW_TASK 31 | putExtra(EXTRA_PERMISSIONS, forPermission) 32 | } 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app"s APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Kotlin code style for this project: "official" or "obsolete": 19 | kotlin.code.style=official 20 | # Enables namespacing of each library's R class so that its R class includes only the 21 | # resources declared in the library itself and none from the library's dependencies, 22 | # thereby reducing the size of the R class for that library 23 | android.nonTransitiveRClass=true -------------------------------------------------------------------------------- /library/src/main/java/com/alexstyl/warden/PermissionResultsListener.kt: -------------------------------------------------------------------------------- 1 | package com.alexstyl.warden 2 | 3 | import android.app.Activity 4 | import androidx.core.app.ActivityCompat 5 | import kotlinx.coroutines.flow.Flow 6 | import kotlinx.coroutines.flow.MutableSharedFlow 7 | import kotlinx.coroutines.flow.filter 8 | 9 | internal object PermissionResultsListener : PermissionResultListener { 10 | 11 | private val onPermissionResults = MutableSharedFlow( 12 | extraBufferCapacity = 1 13 | ) 14 | 15 | override fun processPermissionResult(activity: Activity, results: Map) { 16 | val value = results.map { (permission, isGranted) -> 17 | val state = if (isGranted) { 18 | PermissionState.Granted 19 | } else { 20 | val shouldShowRationale = ActivityCompat.shouldShowRequestPermissionRationale( 21 | activity, 22 | permission 23 | ) 24 | PermissionState.Denied(shouldShowRationale) 25 | } 26 | permission to state 27 | }.toMap() 28 | 29 | onPermissionResults.tryEmit(PermissionResults(value)) 30 | } 31 | 32 | override fun observePermissionResults(permissions: Array): Flow { 33 | val keys = permissions.toSet() 34 | return onPermissionResults.filter { 35 | it.value.keys == keys 36 | } 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /sample/src/main/java/com/alexstyl/warden/sample/DialerActivity.kt: -------------------------------------------------------------------------------- 1 | package com.alexstyl.warden.sample 2 | 3 | import android.Manifest 4 | import android.os.Bundle 5 | import android.view.Window 6 | import androidx.activity.ComponentActivity 7 | import androidx.activity.compose.setContent 8 | import androidx.lifecycle.lifecycleScope 9 | import com.alexstyl.warden.PermissionState 10 | import com.alexstyl.warden.Warden 11 | import com.alexstyl.warden.sample.theme.SampleAppTheme 12 | import kotlinx.coroutines.launch 13 | 14 | class DialerActivity : ComponentActivity() { 15 | 16 | override fun onCreate(savedInstanceState: Bundle?) { 17 | super.onCreate(savedInstanceState) 18 | 19 | requestWindowFeature(Window.FEATURE_NO_TITLE) 20 | 21 | setContent { 22 | SampleAppTheme { 23 | DialerScreen( 24 | onCallButtonClick = { phoneNumber -> 25 | startPhoneCallOrDial(phoneNumber) 26 | } 27 | ) 28 | } 29 | } 30 | } 31 | 32 | private fun startPhoneCallOrDial(phoneNumber: String) { 33 | lifecycleScope.launch { 34 | val result = 35 | Warden.with(this@DialerActivity).requestPermission(Manifest.permission.CALL_PHONE) 36 | when (result) { 37 | is PermissionState.Denied -> startActivity(dialNumber(phoneNumber)) 38 | PermissionState.Granted -> startActivity(callNumber(phoneNumber)) 39 | } 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /library/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.library' 3 | id 'kotlin-android' 4 | } 5 | 6 | ext { 7 | PUBLISH_GROUP_ID = 'com.alexstyl' 8 | PUBLISH_VERSION = libraryVersionName 9 | PUBLISH_ARTIFACT_ID = 'warden' 10 | } 11 | 12 | apply from: "${rootProject.projectDir}/scripts/publish-module.gradle" 13 | 14 | android { 15 | kotlinOptions { 16 | jvmTarget = javaVersion 17 | useIR = true 18 | freeCompilerArgs = [ 19 | "-Xexplicit-api=strict" 20 | ] 21 | } 22 | compileSdkVersion androidCompileSdkVersion 23 | 24 | defaultConfig { 25 | minSdkVersion androidMinSdkVersion 26 | targetSdkVersion androidCompileSdkVersion 27 | versionCode libraryVersionCode 28 | versionName libraryVersionName 29 | 30 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 31 | consumerProguardFiles "consumer-rules.pro" 32 | } 33 | 34 | buildTypes { 35 | release { 36 | minifyEnabled true 37 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 38 | } 39 | } 40 | compileOptions { 41 | sourceCompatibility javaVersion 42 | targetCompatibility javaVersion 43 | } 44 | kotlinOptions { 45 | jvmTarget = javaVersion 46 | } 47 | } 48 | 49 | dependencies { 50 | implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutinesVersion" 51 | implementation "androidx.core:core-ktx:$coreVersion" 52 | implementation 'androidx.activity:activity-ktx:1.4.0' 53 | } -------------------------------------------------------------------------------- /library/src/main/java/com/alexstyl/warden/AndroidWarden.kt: -------------------------------------------------------------------------------- 1 | package com.alexstyl.warden 2 | 3 | import android.content.Context 4 | import android.content.pm.PackageManager 5 | import androidx.core.content.ContextCompat 6 | import kotlinx.coroutines.flow.Flow 7 | import kotlinx.coroutines.flow.first 8 | 9 | public class AndroidWarden internal constructor( 10 | private val context: Context, 11 | private val observer: PermissionResultListener 12 | ) : Warden { 13 | 14 | override suspend fun requestPermission(forPermission: String): PermissionState { 15 | return requestPermissions(arrayOf(forPermission)).value.values.first() 16 | } 17 | 18 | override suspend fun requestPermissions(forPermission: Array): PermissionResults { 19 | val allGranted = forPermission.fold(true) { acc, permission -> 20 | acc && isPermissionGranted(permission) 21 | } 22 | return if (allGranted) { 23 | PermissionResults(forPermission.associateWith { PermissionState.Granted }) 24 | } else { 25 | context.startActivity(WardenActivity.requestPermission(context, forPermission)) 26 | return observeResponse(forPermission).first() 27 | } 28 | } 29 | 30 | private fun isPermissionGranted(forPermission: String): Boolean { 31 | return ContextCompat 32 | .checkSelfPermission(context, forPermission) == PackageManager.PERMISSION_GRANTED 33 | } 34 | 35 | private fun observeResponse(forPermission: Array): Flow { 36 | return observer.observePermissionResults(forPermission) 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.aar 4 | *.ap_ 5 | *.aab 6 | 7 | # Files for the ART/Dalvik VM 8 | *.dex 9 | 10 | # Java class files 11 | *.class 12 | 13 | # Generated files 14 | bin/ 15 | gen/ 16 | out/ 17 | # Uncomment the following line in case you need and you don't have the release build type files in your app 18 | # release/ 19 | 20 | # Gradle files 21 | .gradle/ 22 | build/ 23 | 24 | # Local configuration file (sdk path, etc) 25 | local.properties 26 | 27 | # Proguard folder generated by Eclipse 28 | proguard/ 29 | 30 | # Log Files 31 | *.log 32 | 33 | # Android Studio Navigation editor temp files 34 | .navigation/ 35 | 36 | # Android Studio captures folder 37 | captures/ 38 | 39 | # IntelliJ 40 | *.iml 41 | .idea/workspace.xml 42 | .idea/tasks.xml 43 | .idea/gradle.xml 44 | .idea/assetWizardSettings.xml 45 | .idea/dictionaries 46 | .idea/libraries 47 | # Android Studio 3 in .gitignore file. 48 | .idea/caches 49 | .idea/modules.xml 50 | # Comment next line if keeping position of elements in Navigation Editor is relevant for you 51 | .idea/navEditor.xml 52 | 53 | # Keystore files 54 | # Uncomment the following lines if you do not want to check your keystore files in. 55 | #*.jks 56 | #*.keystore 57 | 58 | # External native build folder generated in Android Studio 2.2 and later 59 | .externalNativeBuild 60 | .cxx/ 61 | 62 | # Google Services (e.g. APIs or Firebase) 63 | # google-services.json 64 | 65 | # Freeline 66 | freeline.py 67 | freeline/ 68 | freeline_project_description.json 69 | 70 | # fastlane 71 | fastlane/report.xml 72 | fastlane/Preview.html 73 | fastlane/screenshots 74 | fastlane/test_output 75 | fastlane/readme.md 76 | 77 | # Version control 78 | vcs.xml 79 | 80 | # lint 81 | lint/intermediates/ 82 | lint/generated/ 83 | lint/outputs/ 84 | lint/tmp/ 85 | # lint/reports/ 86 | -------------------------------------------------------------------------------- /sample/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'org.jetbrains.kotlin.android' 4 | } 5 | 6 | android { 7 | compileSdk androidCompileSdkVersion 8 | 9 | defaultConfig { 10 | applicationId "com.alexstyl.warden.sample" 11 | minSdkVersion 21 12 | targetSdkVersion androidCompileSdkVersion 13 | versionCode libraryVersionCode 14 | versionName libraryVersionName 15 | 16 | vectorDrawables { 17 | useSupportLibrary true 18 | } 19 | signingConfig signingConfigs.debug 20 | } 21 | 22 | buildTypes { 23 | release { 24 | minifyEnabled false 25 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 26 | } 27 | } 28 | compileOptions { 29 | sourceCompatibility javaVersion 30 | targetCompatibility javaVersion 31 | } 32 | kotlinOptions { 33 | jvmTarget = javaVersion 34 | useIR = true 35 | freeCompilerArgs += "-Xopt-in=androidx.compose.material.ExperimentalMaterialApi" 36 | freeCompilerArgs += "-Xopt-in=coil.annotation.ExperimentalCoilApi" 37 | } 38 | buildFeatures { 39 | compose true 40 | } 41 | composeOptions { 42 | kotlinCompilerExtensionVersion composeVersion 43 | } 44 | } 45 | 46 | dependencies { 47 | implementation project(":library") 48 | implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutinesVersion" 49 | 50 | implementation "androidx.compose.ui:ui:$composeVersion" 51 | implementation "androidx.lifecycle:lifecycle-viewmodel-compose:$lifecycleViewModelComposeVersion" 52 | implementation "androidx.compose.material:material:$composeVersion" 53 | implementation "androidx.compose.ui:ui-tooling:$composeVersion" 54 | implementation "androidx.activity:activity-compose:$activityComposeVersion" 55 | } 56 | -------------------------------------------------------------------------------- /scripts/publish-module.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'maven-publish' 2 | apply plugin: 'signing' 3 | 4 | task androidSourcesJar(type: Jar) { 5 | archiveClassifier.set('sources') 6 | if (project.plugins.findPlugin('com.android.library')) { 7 | // For Android libraries 8 | from android.sourceSets.main.java.srcDirs 9 | from android.sourceSets.main.kotlin.srcDirs 10 | } else { 11 | // For pure Kotlin libraries, in case you have them 12 | from sourceSets.main.java.srcDirs 13 | from sourceSets.main.kotlin.srcDirs 14 | } 15 | } 16 | 17 | artifacts { 18 | archives androidSourcesJar 19 | } 20 | 21 | group = PUBLISH_GROUP_ID 22 | version = PUBLISH_VERSION 23 | 24 | afterEvaluate { 25 | publishing { 26 | publications { 27 | release(MavenPublication) { 28 | groupId PUBLISH_GROUP_ID 29 | artifactId PUBLISH_ARTIFACT_ID 30 | version PUBLISH_VERSION 31 | 32 | if (project.plugins.findPlugin('com.android.library')) { 33 | from components.release 34 | } else { 35 | from components.java 36 | } 37 | 38 | artifact androidSourcesJar 39 | 40 | pom { 41 | name = PUBLISH_ARTIFACT_ID 42 | description = 'Android permissions as suspend functions' 43 | url = 'https://github.com/alexstyl/warden' 44 | licenses { 45 | license { 46 | name = 'Warden License' 47 | url = 'https://github.com/alexstyl/warden/blob/main/LICENSE' 48 | } 49 | } 50 | developers { 51 | developer { 52 | id = 'alexstyl' 53 | name = 'Alex Styl' 54 | email = 'alex@alexstyl.com' 55 | } 56 | } 57 | 58 | scm { 59 | connection = 'scm:git:github.com/alexstyl/warden.git' 60 | developerConnection = 'scm:git:ssh://github.com/alexstyl/warden.git' 61 | url = 'https://github.com/alexstyl/warden/tree/main' 62 | } 63 | } 64 | } 65 | } 66 | } 67 | } 68 | 69 | signing { 70 | useInMemoryPgpKeys( 71 | rootProject.ext["signing.keyId"], 72 | rootProject.ext["signing.key"], 73 | rootProject.ext["signing.password"], 74 | ) 75 | sign publishing.publications 76 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Warden [![Featured on Android Weekly](https://androidweekly.net/issues/issue-508/badge)](https://androidweekly.net/issues/issue-508) 2 | 3 | ![Android permissions as suspend functions](/assets/banner.png) 4 | 5 | Permission handling in Android can be complicated. It requires boilerplate code to setup the 6 | permission request, receive the result and then forward the result to the place of your codebase 7 | where the actual handling logic takes place. 8 | 9 | Warden removes all this boilerplate code and enables requesting permissions and receiving the result 10 | from any coroutine in your codebase (such as your ViewModels). 11 | 12 | ## Quick Start 13 | 14 | Install Warden via Gradle by adding the dependency in your `app/build.gradle` file: 15 | 16 | ```gradle 17 | repositories { 18 | ... 19 | mavenCentral() 20 | } 21 | 22 | dependencies { 23 | implementation 'com.alexstyl:warden:1.0.0-alpha2' 24 | } 25 | ``` 26 | 27 | The following example showcases how to use Warden to request the `CALL_PHONE` permission. 28 | 29 | ```kotlin 30 | coroutineScope.launch { 31 | val result = Warden.with(anyContext).requestPermission(Manifest.permission.CALL_PHONE) 32 | when (result) { 33 | is PermissionState.Denied -> dialNumber(phoneNumber) 34 | PermissionState.Granted -> startCall(phoneNumber) 35 | } 36 | } 37 | ``` 38 | 39 | As soon as `requestPermission()` is called, Warden will ask Android for the requested permission and 40 | will suspend the coroutine until the permission dialog has been dismissed. 41 | 42 | You can use the `requestPermissions()` suspend function to request multiple permissions at once. 43 | 44 | > The `Denied` state contains a `shouldShowRationale` property. When true, it is the right 45 | > time to show an educational message towards why your app requires the said permission. 46 | 47 | ## Limitations 48 | 49 | ### Requesting permissions on the background 50 | 51 | The way Warden works is via launching an activity which handles the permission requests for you. This is what enables Warden to request permission and receive the results from any part of your app. 52 | 53 | If you need to request permissions while no activity is visible (such as from a service), you might be limited by the [restrictions on starting activities from the background](https://developer.android.com/guide/components/activities/background-starts). 54 | 55 | ### Orientation changes and process death 56 | 57 | Warden assumes that the coroutine context you are requesting the permission from lives long enough until the permission dialog is dismissed. 58 | For the cases the coroutine context doesn't exist, no one will be there to receive the result. 59 | 60 | ## Sample app 61 | 62 | The repository comes with a [sample app](/sample) for an example of usage. 63 | 64 | ## Getting Help 65 | 66 | To report a problem or request a feature, [open a new issue on Github][1]. 67 | 68 | ## License 69 | 70 | Apache 2.0. See the [LICENSE](https://github.com/alexstyl/warden/blob/main/LICENSE) file for 71 | details. 72 | 73 | ## Author 74 | 75 | Made by Alex Styl. [Follow @alexstyl](https://www.twitter.com/alexstyl) on Twitter for future 76 | updates. 77 | 78 | [1]: https://github.com/alexstyl/warden/issues 79 | -------------------------------------------------------------------------------- /sample/src/main/java/com/alexstyl/warden/sample/DialerScreen.kt: -------------------------------------------------------------------------------- 1 | @file:OptIn(ExperimentalMaterialApi::class) 2 | 3 | package com.alexstyl.warden.sample 4 | 5 | import androidx.compose.foundation.layout.Arrangement 6 | import androidx.compose.foundation.layout.Box 7 | import androidx.compose.foundation.layout.Column 8 | import androidx.compose.foundation.layout.Row 9 | import androidx.compose.foundation.layout.Spacer 10 | import androidx.compose.foundation.layout.fillMaxSize 11 | import androidx.compose.foundation.layout.height 12 | import androidx.compose.foundation.layout.padding 13 | import androidx.compose.foundation.layout.size 14 | import androidx.compose.foundation.shape.CircleShape 15 | import androidx.compose.material.ExperimentalMaterialApi 16 | import androidx.compose.material.Icon 17 | import androidx.compose.material.MaterialTheme 18 | import androidx.compose.material.Scaffold 19 | import androidx.compose.material.Surface 20 | import androidx.compose.material.Text 21 | import androidx.compose.runtime.Composable 22 | import androidx.compose.runtime.mutableStateOf 23 | import androidx.compose.runtime.remember 24 | import androidx.compose.ui.Alignment 25 | import androidx.compose.ui.Modifier 26 | import androidx.compose.ui.graphics.Color 27 | import androidx.compose.ui.res.painterResource 28 | import androidx.compose.ui.unit.dp 29 | import androidx.compose.ui.unit.sp 30 | 31 | @Composable 32 | fun DialerScreen( 33 | onCallButtonClick: (String) -> Unit 34 | ) { 35 | Scaffold { 36 | Column( 37 | modifier = Modifier 38 | .fillMaxSize() 39 | .padding(20.dp), 40 | ) { 41 | Spacer(Modifier.height(20.dp)) 42 | 43 | val numberState = remember { mutableStateOf("555") } 44 | 45 | CenteredRow(Modifier.weight(1f)) { 46 | Text( 47 | text = numberState.value, 48 | letterSpacing = 2.sp, 49 | modifier = Modifier.weight(1f), 50 | style = MaterialTheme.typography.body1 51 | ) 52 | } 53 | 54 | Row(Modifier.weight(1f)) { 55 | DialButton(Modifier.weight(1f), "1", "abc") 56 | DialButton(Modifier.weight(1f), "2", "def") 57 | DialButton(Modifier.weight(1f), "3", "def") 58 | } 59 | 60 | Row(Modifier.weight(1f)) { 61 | DialButton(Modifier.weight(1f), "4", "ghi") 62 | DialButton(Modifier.weight(1f), "5", "jkl") 63 | DialButton(Modifier.weight(1f), "6", "mno") 64 | } 65 | 66 | Row(Modifier.weight(1f)) { 67 | DialButton(Modifier.weight(1f), "7", "pqrs") 68 | DialButton(Modifier.weight(1f), "8", "tuv") 69 | DialButton(Modifier.weight(1f), "9", "wxyz") 70 | } 71 | 72 | Row(Modifier.weight(1f)) { 73 | DialButton(Modifier.weight(1f), "*") 74 | DialButton(Modifier.weight(1f), "0", "+") 75 | DialButton(Modifier.weight(1f), "#") 76 | } 77 | 78 | CenteredRow(Modifier.weight(1f)) { 79 | CallButton(onClick = { onCallButtonClick(numberState.value) }) 80 | } 81 | } 82 | } 83 | } 84 | 85 | @Composable 86 | private fun CenteredRow( 87 | modifier: Modifier, 88 | content: @Composable () -> Unit 89 | ) { 90 | Row(modifier) { 91 | Box( 92 | modifier = Modifier.weight(1f), 93 | contentAlignment = Alignment.Center 94 | ) { 95 | content() 96 | } 97 | } 98 | } 99 | 100 | @Composable 101 | private fun CallButton( 102 | modifier: Modifier = Modifier, 103 | onClick: () -> Unit 104 | ) { 105 | Box( 106 | modifier, 107 | contentAlignment = Alignment.Center 108 | ) { 109 | Surface( 110 | color = MaterialTheme.colors.primary, 111 | onClick = onClick, 112 | modifier = Modifier.size(96.dp), 113 | shape = CircleShape, elevation = 4.dp 114 | ) { 115 | Box(contentAlignment = Alignment.Center) { 116 | Icon( 117 | painter = painterResource(R.drawable.ic_call), 118 | contentDescription = "Call", 119 | modifier = Modifier.size(48.dp), 120 | tint = Color.White, 121 | ) 122 | } 123 | } 124 | } 125 | 126 | } 127 | 128 | @Composable 129 | private fun DialButton( 130 | modifier: Modifier = Modifier, 131 | title: String, 132 | subtitle: String = "", 133 | ) { 134 | Box( 135 | modifier, 136 | contentAlignment = Alignment.Center 137 | ) { 138 | Surface( 139 | modifier = Modifier.size(96.dp), 140 | shape = CircleShape, elevation = 4.dp 141 | ) { 142 | Column( 143 | horizontalAlignment = Alignment.CenterHorizontally, 144 | verticalArrangement = Arrangement.Center 145 | ) { 146 | Text(title, style = MaterialTheme.typography.body1) 147 | if (subtitle.isNotEmpty()) { 148 | Spacer(Modifier.height(2.dp)) 149 | Text( 150 | subtitle.uppercase(), 151 | style = MaterialTheme.typography.body2, 152 | letterSpacing = 2.sp 153 | ) 154 | } 155 | } 156 | } 157 | } 158 | } 159 | 160 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------