Merge pull request #1739 from OneSignal/user-model/permission-fallback-detection

[User Model] Update logic for detecting when to show fallback settings

Author: brismithers

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/activities/PermissionsActivity.kt

@@ -10,9 +10,13 @@ import com.onesignal.OneSignal
 import com.onesignal.common.AndroidSupportV4Compat
 import com.onesignal.core.R
 import com.onesignal.core.internal.permissions.impl.RequestPermissionService
+import com.onesignal.core.internal.preferences.IPreferencesService
+import com.onesignal.core.internal.preferences.PreferenceOneSignalKeys
+import com.onesignal.core.internal.preferences.PreferenceStores
 
 class PermissionsActivity : Activity() {
     private var _requestPermissionService: RequestPermissionService? = null
+    private var _preferenceService: IPreferencesService? = null
     private var permissionRequestType: String? = null
     private var androidPermissionString: String? = null
 
@@ -21,6 +25,7 @@ class PermissionsActivity : Activity() {
         OneSignal.initWithContext(this)
 
         _requestPermissionService = OneSignal.getService()
+        _preferenceService = OneSignal.getService()
 
         handleBundleParams(intent.extras)
     }
@@ -62,8 +67,8 @@ class PermissionsActivity : Activity() {
     private fun requestPermission(androidPermissionString: String?) {
         if (!_requestPermissionService!!.waiting) {
             _requestPermissionService!!.waiting = true
-            _requestPermissionService!!.neverAskAgainClicked =
-                !AndroidSupportV4Compat.ActivityCompat.shouldShowRequestPermissionRationale(
+            _requestPermissionService!!.shouldShowRequestPermissionRationaleBeforeRequest =
+                AndroidSupportV4Compat.ActivityCompat.shouldShowRequestPermissionRationale(
                     this@PermissionsActivity,
                     androidPermissionString
                 )
@@ -107,14 +112,34 @@ class PermissionsActivity : Activity() {
     }
 
     private fun shouldShowSettings(): Boolean {
-        return (
-            _requestPermissionService!!.fallbackToSettings &&
-                _requestPermissionService!!.neverAskAgainClicked &&
-                !AndroidSupportV4Compat.ActivityCompat.shouldShowRequestPermissionRationale(
+        if (!_requestPermissionService!!.fallbackToSettings)
+            return false;
+
+        // We want to show settings after the user has clicked "Don't Allow" 2 times.
+        // After the first time shouldShowRequestPermissionRationale becomes true, after
+        // the second time shouldShowRequestPermissionRationale becomes false again. We
+        // look for the change from `true` -> `false`. When this happens we remember this
+        // rejection, as the user will never be prompted again.
+        if (_requestPermissionService!!.shouldShowRequestPermissionRationaleBeforeRequest) {
+            if (!AndroidSupportV4Compat.ActivityCompat.shouldShowRequestPermissionRationale(
                     this@PermissionsActivity,
                     androidPermissionString
                 )
-            )
+            ) {
+                _preferenceService!!.saveBool(
+                    PreferenceStores.ONESIGNAL,
+                    "${PreferenceOneSignalKeys.PREFS_OS_USER_REJECTED_PERMISSION_PREFIX}${androidPermissionString}",
+                    true
+                )
+                return false;
+            }
+        }
+
+        return _preferenceService!!.getBool(
+            PreferenceStores.ONESIGNAL,
+            "${PreferenceOneSignalKeys.PREFS_OS_USER_REJECTED_PERMISSION_PREFIX}$androidPermissionString",
+            false
+        )!!
     }
 
     companion object {

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/permissions/impl/RequestPermissionService.kt

@@ -9,12 +9,12 @@ import com.onesignal.core.internal.application.IApplicationService
 import com.onesignal.core.internal.permissions.IRequestPermissionService
 
 internal class RequestPermissionService(
-    private val _application: IApplicationService
+    private val _application: IApplicationService,
 ) : Activity(), IRequestPermissionService {
 
     var waiting = false
     var fallbackToSettings = false
-    var neverAskAgainClicked = false
+    var shouldShowRequestPermissionRationaleBeforeRequest = false
     private val callbackMap = HashMap<String?, IRequestPermissionService.PermissionCallback>()
 
     override fun registerAsCallback(

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/preferences/IPreferencesService.kt

@@ -151,6 +151,13 @@ object PreferenceOneSignalKeys {
      */
     const val PREFS_OS_LAST_LOCATION_TIME = "OS_LAST_LOCATION_TIME"
 
+    // Permissions
+    /**
+     * (Boolean) A prefix key for the permission state. When true, the user has rejected this
+     * permission too many times and will not be prompted again.
+     */
+    const val PREFS_OS_USER_REJECTED_PERMISSION_PREFIX = "USER_REJECTED_PERMISSION_"
+
     // HTTP
     /**
      * (String) A prefix key for retrieving the ETAG for a given HTTP GET cache key. The cache

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/notifications/INotificationsManager.kt

@@ -9,6 +9,11 @@ interface INotificationsManager {
      */
     val permission: Boolean
 
+    /**
+     * Whether this app can request push notification permission.
+     */
+    val canRequestPermission: Boolean
+
     /**
      * Prompt the user for permission to push notifications.  This will display the native
      * OS prompt to request push notification permission.  If the user enables, a push

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/notifications/internal/MisconfiguredNotificationsManager.kt

@@ -12,6 +12,8 @@ import com.onesignal.notifications.IPermissionChangedHandler
 internal class MisconfiguredNotificationsManager : INotificationsManager {
     override val permission: Boolean
         get() = throw EXCEPTION
+    override val canRequestPermission: Boolean
+        get() = throw EXCEPTION
 
     override suspend fun requestPermission(fallbackToSettings: Boolean): Boolean = throw EXCEPTION
     override fun removeNotification(id: Int) = throw EXCEPTION

OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/NotificationsManager.kt

@@ -45,6 +45,9 @@ internal class NotificationsManager(
 
     override var permission: Boolean = NotificationHelper.areNotificationsEnabled(_applicationService.appContext)
 
+    override val canRequestPermission: Boolean
+        get() = _notificationPermissionController.canRequestPermission
+
     private val _permissionChangedNotifier = EventProducer<IPermissionChangedHandler>()
 
     init {

OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/permissions/INotificationPermissionController.kt

@@ -31,6 +31,11 @@ import com.onesignal.common.events.IEventNotifier
 
 internal interface INotificationPermissionController :
     IEventNotifier<INotificationPermissionChangedHandler> {
+    /**
+     * Whether this app can request push notification permission.
+     */
+    val canRequestPermission: Boolean
+
     /**
      * Prompt the user for notification permission.  Note it is possible the application
      * will be killed while the permission prompt is being displayed to the user. When the

OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/permissions/impl/NotificationPermissionController.kt

@@ -36,6 +36,9 @@ import com.onesignal.core.internal.application.ApplicationLifecycleHandlerBase
 import com.onesignal.core.internal.application.IApplicationService
 import com.onesignal.core.internal.permissions.AlertDialogPrepromptForAndroidSettings
 import com.onesignal.core.internal.permissions.IRequestPermissionService
+import com.onesignal.core.internal.preferences.IPreferencesService
+import com.onesignal.core.internal.preferences.PreferenceOneSignalKeys
+import com.onesignal.core.internal.preferences.PreferenceStores
 import com.onesignal.notifications.R
 import com.onesignal.notifications.internal.common.NotificationHelper
 import com.onesignal.notifications.internal.permissions.INotificationPermissionChangedHandler
@@ -44,13 +47,21 @@ import com.onesignal.notifications.internal.permissions.INotificationPermissionC
 internal class NotificationPermissionController(
     private val _application: IApplicationService,
     private val _requestPermission: IRequestPermissionService,
-    private val _applicationService: IApplicationService
+    private val _applicationService: IApplicationService,
+    private val _preferenceService: IPreferencesService
 ) : IRequestPermissionService.PermissionCallback,
     INotificationPermissionController {
 
     private val _waiter = WaiterWithValue<Boolean>()
     private val _events = EventProducer<INotificationPermissionChangedHandler>()
 
+    override val canRequestPermission: Boolean
+        get() = !_preferenceService.getBool(
+            PreferenceStores.ONESIGNAL,
+            "${PreferenceOneSignalKeys.PREFS_OS_USER_REJECTED_PERMISSION_PREFIX}${ANDROID_PERMISSION_STRING}",
+            false
+        )!!
+
     init {
         _requestPermission.registerAsCallback(PERMISSION_TYPE, this)
     }