fix: choosing key mapper input method does not launch IME settings screen if GUI keyboard also installed

Author: sds100

base/src/main/java/io/github/sds100/keymapper/base/keymaps/DisplayKeyMapUseCase.kt

@@ -212,7 +212,7 @@ class DisplayKeyMapUseCaseImpl @Inject constructor(
                     inputMethodAdapter.showImePicker(fromForeground = true)
                 }
 
-            KMError.NoCompatibleImeEnabled -> keyMapperImeHelper.enableCompatibleInputMethods()
+            KMError.NoCompatibleImeEnabled -> keyMapperImeHelper.enableCompatibleInputMethod()
 
             is ImeDisabled -> switchImeInterface.enableIme(error.ime.id)
 
@@ -224,7 +224,7 @@ class DisplayKeyMapUseCaseImpl @Inject constructor(
 
             is KMError.CantDetectKeyEventsInPhoneCall -> {
                 if (!keyMapperImeHelper.isCompatibleImeEnabled()) {
-                    keyMapperImeHelper.enableCompatibleInputMethods()
+                    keyMapperImeHelper.enableCompatibleInputMethod()
                 }
 
                 // wait for compatible ime to be enabled then choose it.
@@ -244,7 +244,7 @@ class DisplayKeyMapUseCaseImpl @Inject constructor(
                 if (keyMapperImeHelper.isCompatibleImeEnabled()) {
                     keyMapperImeHelper.chooseCompatibleInputMethod()
                 } else {
-                    keyMapperImeHelper.enableCompatibleInputMethods()
+                    keyMapperImeHelper.enableCompatibleInputMethod()
                 }
             }
 

base/src/main/java/io/github/sds100/keymapper/base/settings/ConfigSettingsUseCase.kt

@@ -102,7 +102,7 @@ class ConfigSettingsUseCaseImpl @Inject constructor(
         get() = devicesAdapter.connectedInputDevices
 
     override suspend fun enableCompatibleIme() {
-        imeHelper.enableCompatibleInputMethods()
+        imeHelper.enableCompatibleInputMethod()
     }
 
     override suspend fun chooseCompatibleIme(): KMResult<ImeInfo> =

base/src/main/java/io/github/sds100/keymapper/base/system/inputmethod/KeyMapperImeHelper.kt

@@ -4,6 +4,7 @@ import io.github.sds100.keymapper.common.utils.KMError
 import io.github.sds100.keymapper.common.utils.KMResult
 import io.github.sds100.keymapper.common.utils.Success
 import io.github.sds100.keymapper.common.utils.firstBlocking
+import io.github.sds100.keymapper.common.utils.isSuccess
 import io.github.sds100.keymapper.common.utils.onSuccess
 import io.github.sds100.keymapper.common.utils.then
 import io.github.sds100.keymapper.common.utils.valueOrNull
@@ -58,14 +59,19 @@ class KeyMapperImeHelper(
                 }
             }
 
-    fun enableCompatibleInputMethods(): KMResult<Unit> {
+    fun enableCompatibleInputMethod(): KMResult<Unit> {
         var result: KMResult<Unit>? = null
 
         for (imePackageName in keyMapperImePackageList) {
             val imeId =
                 imeAdapter.getInfoByPackageName(imePackageName).valueOrNull()?.id ?: continue
 
             result = switchImeInterface.enableIme(imeId)
+
+            // Stop trying to enable IMEs if one is enabled.
+            if (result.isSuccess) {
+                break
+            }
         }
 
         return result ?: KMError.InputMethodNotFound(packageName)

base/src/main/java/io/github/sds100/keymapper/base/system/inputmethod/SwitchImeAsyncImpl.kt

@@ -55,14 +55,16 @@ class SwitchImeAsyncImpl @Inject constructor(
     }
 
     private fun enableImeWithoutUserInput(imeId: String): KMResult<Unit> {
-        return inputMethodAdapter.getInfoByPackageName(buildConfigProvider.packageName)
-            .then { keyMapperImeInfo ->
+        return inputMethodAdapter.getInfoById(imeId)
+            .then { imeInfo ->
+                // The accessibility service can only enable IMEs that have the same
+                // package name as the accessibility service.
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
-                    imeId == keyMapperImeInfo.id
+                    imeInfo.packageName == buildConfigProvider.packageName
                 ) {
                     serviceAdapter.sendAsync(
                         AccessibilityServiceEvent.EnableInputMethod(
-                            keyMapperImeInfo.id,
+                            imeInfo.id,
                         ),
                     )
                 } else {

base/src/main/java/io/github/sds100/keymapper/base/trigger/SetupInputMethodUseCase.kt

@@ -29,7 +29,7 @@ class SetupInputMethodUseCaseImpl @Inject constructor(
     override val isEnabled: Flow<Boolean> = keyMapperImeHelper.isCompatibleImeEnabledFlow
 
     override suspend fun enableInputMethod(): KMResult<Unit> {
-        return keyMapperImeHelper.enableCompatibleInputMethods()
+        return keyMapperImeHelper.enableCompatibleInputMethod()
     }
 
     override val isChosen: Flow<Boolean> = keyMapperImeHelper.isCompatibleImeChosenFlow
@@ -38,7 +38,7 @@ class SetupInputMethodUseCaseImpl @Inject constructor(
         // On Android 13+, the accessibility service can enable the input method without
         // any user input
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-            return keyMapperImeHelper.enableCompatibleInputMethods()
+            return keyMapperImeHelper.enableCompatibleInputMethod()
                 .onFailure {
                     Timber.e("Failed to enable compatible input method: $it")
                 }