Merge pull request #106 from NordicPlayground/permission-notification

philips77 · web-flow · commit fbdb80763355 · 2024-09-10T14:45:24.000+02:00
Add Notification Permission Feature
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -49,6 +49,7 @@ dependencies {
     implementation(project(":permissions-nfc"))
     implementation(project(":permissions-wifi"))
     implementation(project(":permissions-internet"))
+    implementation(project(":permissions-notification"))
 
     implementation(libs.androidx.compose.material.iconsExtended)
 
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
@@ -44,6 +44,8 @@
     <uses-permission
         android:name="android.permission.ACCESS_FINE_LOCATION"
         tools:node="replace" />
+    <uses-permission
+        android:name="android.permission.POST_NOTIFICATIONS" />
 
     <application
         android:allowBackup="true"
diff --git a/app/src/main/java/no/nordicsemi/android/common/test/simple/Advanced.kt b/app/src/main/java/no/nordicsemi/android/common/test/simple/Advanced.kt
@@ -46,6 +46,7 @@ import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import no.nordicsemi.android.common.navigation.createSimpleDestination
 import no.nordicsemi.android.common.navigation.defineDestination
+import no.nordicsemi.android.common.permissions.notification.RequestNotificationPermission
 import no.nordicsemi.android.common.test.R
 import no.nordicsemi.android.common.theme.NordicTheme
 
@@ -61,21 +62,23 @@ val AdvancedDestination = defineDestination(Advanced) {
 private fun AdvancedScreen(
     modifier: Modifier = Modifier,
 ) {
-    Column(
-        modifier = modifier,
-    ) {
+    RequestNotificationPermission { granted ->
         Column(
-            modifier = Modifier.fillMaxSize(),
-            verticalArrangement = Arrangement.spacedBy(16.dp, Alignment.CenterVertically),
-            horizontalAlignment = Alignment.CenterHorizontally,
+            modifier = modifier,
         ) {
-            Text(
-                text = "This is a simple destination with some advanced settings.\nClicking Back button will navigate to the main destination.",
-                textAlign = TextAlign.Center,
-            )
+            Column(
+                modifier = Modifier.fillMaxSize(),
+                verticalArrangement = Arrangement.spacedBy(16.dp, Alignment.CenterVertically),
+                horizontalAlignment = Alignment.CenterHorizontally,
+            ) {
+                Text(
+                    text = "This view requests notifications.\nCurrent state: $granted.\n\nClicking Back button will navigate to the main destination.",
+                    textAlign = TextAlign.Center,
+                )
 
-            Button(onClick = { }) {
-                Text(text = stringResource(id = R.string.action_no_op))
+                Button(onClick = { }) {
+                    Text(text = stringResource(id = R.string.action_no_op))
+                }
             }
         }
     }
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -32,6 +32,7 @@ plugins {
     alias(libs.plugins.android.library) apply false
     alias(libs.plugins.hilt) apply false
     alias(libs.plugins.kotlin.parcelize) apply false
+    alias(libs.plugins.kotlin.dokka) apply false
     alias(libs.plugins.compose.compiler) apply false
 
     // Nordic plugins are defined in https://github.com/NordicSemiconductor/Android-Gradle-Plugins
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,4 +1,5 @@
 [versions]
+accompanist = "0.34.0"
 androidDesugarJdkLibs = "2.1.2"
 androidGradlePlugin = "8.6.0"
 androidxActivity = "1.9.2"
@@ -39,7 +40,7 @@ publishPlugin = "1.2.2"
 markdown = "0.4.1"
 leakcanary = "2.14"
 mockk = "1.13.12"
-slf4j = "1.7.36" # don't update
+slf4j = "2.0.13"
 robolectric = "4.13"
 material3 = "1.3.0"
 material = "1.7.0"
@@ -51,6 +52,7 @@ googleServicesPlugins = "4.4.2"
 firebaseCrashlyticsPlugins = "3.0.2"
 
 [libraries]
+accompanist-permissions = { group = "com.google.accompanist", name = "accompanist-permissions", version.ref = "accompanist" }
 android-desugarJdkLibs = { group = "com.android.tools", name = "desugar_jdk_libs", version.ref = "androidDesugarJdkLibs" }
 androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "androidxActivity" }
 androidx-annotation = { group = "androidx.annotation", name = "annotation", version.ref = "androidxAnnotation" }
@@ -123,6 +125,7 @@ kotlinx-serialization-json = { group = "org.jetbrains.kotlinx", name = "kotlinx-
 lint-api = { group = "com.android.tools.lint", name = "lint-api", version.ref = "lint" }
 markdown = { group = "com.github.jeziellago", name = "compose-markdown", version.ref = "markdown" }
 leakcanary = { group = "com.squareup.leakcanary", name = "leakcanary-android", version.ref = "leakcanary" }
+test-slf4j = { group = "org.slf4j", name = "slf4j-api", version.ref = "slf4j" }
 test-slf4j-simple = { group = "org.slf4j", name = "slf4j-simple", version.ref = "slf4j" }
 test-mockk = { group = "io.mockk", name = "mockk", version.ref = "mockk" }
 test-robolectric = { group = "org.robolectric", name = "robolectric", version.ref = "robolectric" }
diff --git a/permissions-ble/build.gradle.kts b/permissions-ble/build.gradle.kts
@@ -52,9 +52,7 @@ android {
 }
 
 dependencies {
-    implementation(project(":core"))
     implementation(project(":ui"))
-    implementation(project(":navigation"))
 
     implementation(libs.androidx.compose.material.iconsExtended)
 }
diff --git a/permissions-ble/src/main/java/no/nordicsemi/android/common/permissions/ble/view/LocationPermissionRequiredView.kt b/permissions-ble/src/main/java/no/nordicsemi/android/common/permissions/ble/view/LocationPermissionRequiredView.kt
@@ -57,7 +57,6 @@ import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.core.content.ContextCompat
 import androidx.hilt.navigation.compose.hiltViewModel
-import no.nordicsemi.android.common.core.parseBold
 import no.nordicsemi.android.common.permissions.ble.R
 import no.nordicsemi.android.common.permissions.ble.viewmodel.PermissionViewModel
 import no.nordicsemi.android.common.ui.view.WarningView
@@ -97,7 +96,7 @@ internal fun LocationPermissionRequiredView(
     WarningView(
         imageVector = Icons.Default.LocationOff,
         title = stringResource(id = R.string.location_permission_title),
-        hint = stringResource(id = R.string.location_permission_info).parseBold(),
+        hint = stringResource(id = R.string.location_permission_info),
         modifier = Modifier
             .fillMaxSize()
             .verticalScroll(rememberScrollState())
diff --git a/permissions-internet/build.gradle.kts b/permissions-internet/build.gradle.kts
@@ -52,9 +52,7 @@ android {
 }
 
 dependencies {
-    implementation(project(":core"))
     implementation(project(":ui"))
-    implementation(project(":navigation"))
 
     implementation(libs.androidx.compose.material.iconsExtended)
 }
diff --git a/permissions-nfc/build.gradle.kts b/permissions-nfc/build.gradle.kts
@@ -52,7 +52,5 @@ android {
 }
 
 dependencies {
-    implementation(project(":core"))
     implementation(project(":ui"))
-    implementation(project(":navigation"))
 }
diff --git a/permissions-notification/build.gradle.kts b/permissions-notification/build.gradle.kts
@@ -0,0 +1,27 @@
+plugins {
+    alias(libs.plugins.nordic.feature)
+    alias(libs.plugins.nordic.nexus.android)
+}
+
+group = "no.nordicsemi.android.common"
+
+nordicNexusPublishing {
+    POM_ARTIFACT_ID = "permissions-notification"
+    POM_NAME = "Nordic library for checking Notification permission."
+
+    POM_DESCRIPTION = "Nordic Android Common Libraries"
+    POM_URL = "https://github.com/NordicPlayground/Android-Common-Libraries"
+    POM_SCM_URL = "https://github.com/NordicPlayground/Android-Common-Libraries"
+    POM_SCM_CONNECTION = "scm:git@github.com:NordicPlayground/Android-Common-Libraries.git"
+    POM_SCM_DEV_CONNECTION = "scm:git@github.com:NordicPlayground/Android-Common-Libraries.git"
+}
+
+android {
+    namespace = "no.nordicsemi.android.common.permissions.notification"
+}
+
+dependencies {
+    implementation(libs.accompanist.permissions)
+
+    implementation(libs.androidx.compose.material.iconsExtended)
+}
diff --git a/permissions-notification/module-rules.pro b/permissions-notification/module-rules.pro
@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
diff --git a/permissions-notification/src/main/AndroidManifest.xml b/permissions-notification/src/main/AndroidManifest.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <!--    Notification permission to post notifications.-->
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+
+</manifest>
diff --git a/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/RequestNotificationPermission.kt b/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/RequestNotificationPermission.kt
@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2024, Nordic Semiconductor
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this list of
+ * conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice, this list
+ * of conditions and the following disclaimer in the documentation and/or other materials
+ * provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors may be
+ * used to endorse or promote products derived from this software without specific prior
+ * written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package no.nordicsemi.android.common.permissions.notification
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.getValue
+import androidx.hilt.navigation.compose.hiltViewModel
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
+import no.nordicsemi.android.common.permissions.notification.utils.NotAvailableReason
+import no.nordicsemi.android.common.permissions.notification.utils.NotificationPermissionState
+import no.nordicsemi.android.common.permissions.notification.view.NotificationPermissionRequestView
+import no.nordicsemi.android.common.permissions.notification.viewmodel.NotificationPermissionViewModel
+
+@Composable
+fun RequestNotificationPermission(
+    onChanged: (Boolean) -> Unit = {},
+    content: @Composable (Boolean) -> Unit,
+) {
+    val viewModel = hiltViewModel<NotificationPermissionViewModel>()
+    val state by viewModel.notificationState.collectAsStateWithLifecycle()
+
+    LaunchedEffect(state) {
+        onChanged(state is NotificationPermissionState.Available)
+    }
+
+    when (val s = state) {
+        NotificationPermissionState.Available -> content(true)
+        is NotificationPermissionState.NotAvailable -> {
+            when (s.reason) {
+                NotAvailableReason.PERMISSION_REQUIRED -> {
+                    // Request permission
+                    NotificationPermissionRequestView(content)
+                }
+
+                NotAvailableReason.DENIED -> content(false)
+            }
+        }
+    }
+}
diff --git a/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/repository/NotificationStateManager.kt b/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/repository/NotificationStateManager.kt
@@ -0,0 +1,113 @@
+/*
+ * Copyright (c) 2024, Nordic Semiconductor
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this list of
+ * conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice, this list
+ * of conditions and the following disclaimer in the documentation and/or other materials
+ * provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors may be
+ * used to endorse or promote products derived from this software without specific prior
+ * written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package no.nordicsemi.android.common.permissions.notification.repository
+
+import android.app.NotificationManager
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.content.Intent
+import android.content.IntentFilter
+import android.os.Build
+import androidx.core.content.ContextCompat
+import androidx.core.content.ContextCompat.RECEIVER_EXPORTED
+import dagger.hilt.android.qualifiers.ApplicationContext
+import kotlinx.coroutines.channels.awaitClose
+import kotlinx.coroutines.flow.callbackFlow
+import no.nordicsemi.android.common.permissions.notification.utils.LocalDataProvider
+import no.nordicsemi.android.common.permissions.notification.utils.NotAvailableReason
+import no.nordicsemi.android.common.permissions.notification.utils.NotificationPermissionState
+import no.nordicsemi.android.common.permissions.notification.utils.NotificationPermissionUtils
+import javax.inject.Inject
+import javax.inject.Singleton
+
+private const val REFRESH_PERMISSIONS =
+    "no.nordicsemi.android.common.permissions.notification.REFRESH_NOTIFICATION_PERMISSIONS"
+
+@Singleton
+internal class NotificationStateManager @Inject constructor(
+    @ApplicationContext private val context: Context,
+) {
+    private val dataProvider = LocalDataProvider(context)
+    private val utils = NotificationPermissionUtils(context, dataProvider)
+
+    fun notificationState() = callbackFlow {
+        trySend(getNotificationPermissionState())
+
+        val notificationStateChangeHandler = object : BroadcastReceiver() {
+            override fun onReceive(context: Context, intent: Intent) {
+                trySend(getNotificationPermissionState())
+            }
+        }
+        val filter = IntentFilter().apply {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+                addAction(NotificationManager.ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED)
+            }
+            addAction(REFRESH_PERMISSIONS)
+        }
+
+        ContextCompat.registerReceiver(
+            context,
+            notificationStateChangeHandler,
+            filter,
+            RECEIVER_EXPORTED
+        )
+
+        awaitClose {
+            context.unregisterReceiver(notificationStateChangeHandler)
+        }
+    }
+
+    fun refreshPermission() {
+        val intent = Intent(REFRESH_PERMISSIONS)
+        context.sendBroadcast(intent)
+    }
+
+    fun markNotificationPermissionRequested() {
+        dataProvider.notificationPermissionRequested = true
+    }
+
+    fun isNotificationPermissionDenied(context: Context): Boolean {
+        return utils.isNotificationPermissionDenied(context)
+    }
+
+    private fun getNotificationPermissionState(): NotificationPermissionState {
+        return when {
+            !utils.isNotificationPermissionGranted && utils.isNotificationPermissionRequired ->
+                NotificationPermissionState.NotAvailable(NotAvailableReason.PERMISSION_REQUIRED)
+
+            utils.isNotificationPermissionDenied(context) ->
+                NotificationPermissionState.NotAvailable(NotAvailableReason.DENIED)
+
+            else -> NotificationPermissionState.Available
+        }
+    }
+}
diff --git a/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/utils/LocalDataProvider.kt b/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/utils/LocalDataProvider.kt
diff --git a/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/utils/NotificationPermissionState.kt b/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/utils/NotificationPermissionState.kt
diff --git a/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/utils/NotificationPermissionUtils.kt b/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/utils/NotificationPermissionUtils.kt
diff --git a/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/view/NotificationPermissionRequestView.kt b/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/view/NotificationPermissionRequestView.kt
diff --git a/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/viewmodel/NotificationPermissionViewModel.kt b/permissions-notification/src/main/java/no/nordicsemi/android/common/permissions/notification/viewmodel/NotificationPermissionViewModel.kt
diff --git a/settings.gradle.kts b/settings.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,7 @@ android {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`dependencies {`
`55`		`- implementation(project(":core"))`
`56`	`55`	`implementation(project(":ui"))`
`57`		`- implementation(project(":navigation"))`
`58`	`56`
`59`	`57`	`implementation(libs.androidx.compose.material.iconsExtended)`
`60`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,5 @@ android {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`dependencies {`
`55`		`- implementation(project(":core"))`
`56`	`55`	`implementation(project(":ui"))`
`57`		`- implementation(project(":navigation"))`
`58`	`56`	`}`