From 04c7a300b9a928cb37fd2e49751ffc5251565651 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Mon, 8 Nov 2021 12:47:32 +0100
Subject: [PATCH] Add an explicit reason when shortcut are disabled. Also
 prefer using ShortcutManagerCompat to disable shortcuts

---
 .../app/features/home/ShortcutsHandler.kt     | 24 +++++++++++++++----
 vector/src/main/res/values/strings.xml        |  3 +++
 2 files changed, 22 insertions(+), 5 deletions(-)

diff --git a/vector/src/main/java/im/vector/app/features/home/ShortcutsHandler.kt b/vector/src/main/java/im/vector/app/features/home/ShortcutsHandler.kt
index 01cdbf6e19..7622c8b5de 100644
--- a/vector/src/main/java/im/vector/app/features/home/ShortcutsHandler.kt
+++ b/vector/src/main/java/im/vector/app/features/home/ShortcutsHandler.kt
@@ -21,8 +21,10 @@ import android.content.pm.ShortcutManager
 import android.os.Build
 import androidx.core.content.getSystemService
 import androidx.core.content.pm.ShortcutManagerCompat
+import im.vector.app.R
 import im.vector.app.core.di.ActiveSessionHolder
 import im.vector.app.core.dispatchers.CoroutineDispatchers
+import im.vector.app.core.resources.StringProvider
 import im.vector.app.features.pin.PinCodeStore
 import im.vector.app.features.pin.PinCodeStoreListener
 import kotlinx.coroutines.CoroutineScope
@@ -43,6 +45,7 @@ import javax.inject.Inject
 
 class ShortcutsHandler @Inject constructor(
         private val context: Context,
+        private val stringProvider: StringProvider,
         private val appDispatchers: CoroutineDispatchers,
         private val shortcutCreator: ShortcutCreator,
         private val activeSessionHolder: ActiveSessionHolder,
@@ -72,7 +75,7 @@ class ShortcutsHandler @Inject constructor(
                 .onCompletion { pinCodeStore.removeListener(this@ShortcutsHandler) }
                 .onEach { rooms ->
                     // Remove dead shortcuts (i.e. deleted rooms)
-                    removeDeadShortcut(rooms.map { it.roomId })
+                    removeDeadShortcuts(rooms.map { it.roomId })
 
                     // Create shortcuts
                     createShortcuts(rooms)
@@ -81,7 +84,7 @@ class ShortcutsHandler @Inject constructor(
                 .launchIn(coroutineScope)
     }
 
-    private fun removeDeadShortcut(roomIds: List<String>) {
+    private fun removeDeadShortcuts(roomIds: List<String>) {
         val deadShortcutIds = ShortcutManagerCompat.getShortcuts(context, ShortcutManagerCompat.FLAG_MATCH_DYNAMIC)
                 .map { it.id }
                 .filter { !roomIds.contains(it) }
@@ -91,7 +94,11 @@ class ShortcutsHandler @Inject constructor(
             ShortcutManagerCompat.removeLongLivedShortcuts(context, deadShortcutIds)
             if (isRequestPinShortcutSupported) {
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N_MR1) {
-                    context.getSystemService<ShortcutManager>()?.disableShortcuts(deadShortcutIds)
+                    ShortcutManagerCompat.disableShortcuts(
+                            context,
+                            deadShortcutIds,
+                            stringProvider.getString(R.string.shortcut_disabled_reason_room_left)
+                    )
                 }
             }
         }
@@ -130,8 +137,15 @@ class ShortcutsHandler @Inject constructor(
         if (isRequestPinShortcutSupported) {
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N_MR1) {
                 context.getSystemService<ShortcutManager>()
-                        ?.let {
-                            it.disableShortcuts(it.pinnedShortcuts.map { pinnedShortcut -> pinnedShortcut.id })
+                        ?.pinnedShortcuts
+                        ?.takeIf { it.isNotEmpty() }
+                        ?.map { pinnedShortcut -> pinnedShortcut.id }
+                        ?.let { shortcutIdsToDisable ->
+                            ShortcutManagerCompat.disableShortcuts(
+                                    context,
+                                    shortcutIdsToDisable,
+                                    stringProvider.getString(R.string.shortcut_disabled_reason_sign_out)
+                            )
                         }
             }
         }
diff --git a/vector/src/main/res/values/strings.xml b/vector/src/main/res/values/strings.xml
index 429b2bb34c..7362ebf194 100644
--- a/vector/src/main/res/values/strings.xml
+++ b/vector/src/main/res/values/strings.xml
@@ -1080,6 +1080,9 @@
     <string name="room_settings_forget">Forget</string>
     <string name="room_settings_add_homescreen_shortcut">Add to Home screen</string>
 
+    <string name="shortcut_disabled_reason_room_left">The room has been left!</string>
+    <string name="shortcut_disabled_reason_sign_out">The session has been signed out!</string>
+
     <!-- home sliding menu -->
     <string name="room_sliding_menu_messages">Messages</string>
     <string name="room_sliding_menu_settings">Settings</string>