#1619 Automatically select the non key mapper keyboard when the device is locked and wanting to type.

Author: sds100

CHANGELOG.md

@@ -5,6 +5,7 @@ _See the changes from previous 3.0 Beta releases as well._
 ## Added
 
 - #1620 enable Key Mapper Basic Input Method without user interaction on Android 13+.
+- #1619 Automatically select the non key mapper keyboard when the device is locked and wanting to type.
 
 ## Changed
 

app/src/main/AndroidManifest.xml

@@ -79,6 +79,7 @@
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
+        android:directBootAware="true"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/AppTheme.NoActionBar"
@@ -174,6 +175,7 @@
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.BOOT_COMPLETED" />
+                <action android:name="android.intent.action.LOCKED_BOOT_COMPLETED" />
             </intent-filter>
         </receiver>
 
@@ -231,8 +233,10 @@
                 android:resource="@xml/config_accessibility_service" />
         </service>
 
+        <!--  IMPORTANT! Must be direct boot aware so it can automatically choose a proper keyboard when the user wants to unlock their phone.  -->
         <service
             android:name=".system.inputmethod.KeyMapperImeService"
+            android:directBootAware="true"
             android:exported="true"
             android:label="@string/ime_service_label"
             android:permission="android.permission.BIND_INPUT_METHOD">

app/src/main/java/io/github/sds100/keymapper/KeyMapperApp.kt

@@ -1,8 +1,12 @@
 package io.github.sds100.keymapper
 
+import android.annotation.SuppressLint
 import android.content.Intent
 import android.os.Build
+import android.os.UserManager
+import android.util.Log
 import androidx.appcompat.app.AppCompatDelegate
+import androidx.core.content.getSystemService
 import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.LifecycleObserver
 import androidx.lifecycle.OnLifecycleEvent
@@ -64,7 +68,10 @@ import java.util.Calendar
 /**
  * Created by sds100 on 19/05/2020.
  */
+@SuppressLint("LogNotTimber")
 class KeyMapperApp : MultiDexApplication() {
+    private val TAG = KeyMapperApp::class.simpleName
+
     val appCoroutineScope = MainScope()
 
     val notificationAdapter by lazy { AndroidNotificationAdapter(this, appCoroutineScope) }
@@ -167,9 +174,16 @@ class KeyMapperApp : MultiDexApplication() {
 
     private val processLifecycleOwner by lazy { ProcessLifecycleOwner.get() }
 
+    private val userManager: UserManager? by lazy { getSystemService<UserManager>() }
+
+    private val initLock: Any = Any()
+    private var initialized = false
+
     override fun onCreate() {
         val priorExceptionHandler = Thread.getDefaultUncaughtExceptionHandler()
 
+        Log.i(TAG, "KeyMapperApp: OnCreate")
+
         Thread.setDefaultUncaughtExceptionHandler { thread, exception ->
             // log in a blocking manner and always log regardless of whether the setting is turned on
             val entry = LogEntryEntity(
@@ -188,9 +202,30 @@ class KeyMapperApp : MultiDexApplication() {
 
         super.onCreate()
 
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
-//            DynamicColors.applyToActivitiesIfAvailable(this)
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N && userManager?.isUserUnlocked == false) {
+            Log.i(TAG, "KeyMapperApp: Delay init because locked.")
+            // If the device is still encrypted and locked do not initialize anything that
+            // may potentially need the encrypted app storage like databases.
+            return
+        }
+
+        synchronized(initLock) {
+            init()
+            initialized = true
         }
+    }
+
+    fun onBootUnlocked() {
+        synchronized(initLock) {
+            if (!initialized) {
+                init()
+            }
+            initialized = true
+        }
+    }
+
+    private fun init() {
+        Log.i(TAG, "KeyMapperApp: Init")
 
         ServiceLocator.settingsRepository(this).get(Keys.darkTheme)
             .map { it?.toIntOrNull() }

app/src/main/java/io/github/sds100/keymapper/system/BootBroadcastReceiver.kt

@@ -3,7 +3,7 @@ package io.github.sds100.keymapper.system
 import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
-import io.github.sds100.keymapper.ServiceLocator
+import io.github.sds100.keymapper.KeyMapperApp
 
 /**
  * Created by sds100 on 24/03/2019.
@@ -12,12 +12,9 @@ import io.github.sds100.keymapper.ServiceLocator
 class BootBroadcastReceiver : BroadcastReceiver() {
     override fun onReceive(context: Context?, intent: Intent?) {
         context ?: return
-        if (intent?.action == Intent.ACTION_BOOT_COMPLETED) {
-            /*
-            Initializing the controller will update any notifications since it will collect the values
-            in the constructor
-             */
-            ServiceLocator.notificationController(context)
+
+        if (intent?.action == Intent.ACTION_LOCKED_BOOT_COMPLETED) {
+            (context.applicationContext as? KeyMapperApp)?.onBootUnlocked()
         }
     }
 }

app/src/main/java/io/github/sds100/keymapper/system/inputmethod/KeyMapperImeService.kt

@@ -1,13 +1,21 @@
 package io.github.sds100.keymapper.system.inputmethod
 
+import android.annotation.SuppressLint
+import android.app.KeyguardManager
 import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
 import android.content.IntentFilter
 import android.inputmethodservice.InputMethodService
+import android.os.Build
+import android.os.UserManager
+import android.util.Log
 import android.view.KeyEvent
 import android.view.MotionEvent
+import android.view.inputmethod.EditorInfo
+import android.view.inputmethod.InputMethodManager
 import androidx.core.content.ContextCompat
+import androidx.core.content.getSystemService
 import io.github.sds100.keymapper.Constants
 import io.github.sds100.keymapper.api.IKeyEventRelayServiceCallback
 import io.github.sds100.keymapper.api.KeyEventRelayService
@@ -36,6 +44,15 @@ class KeyMapperImeService : InputMethodService() {
             "io.github.sds100.keymapper.inputmethod.EXTRA_KEY_EVENT"
     }
 
+    private val userManager: UserManager? by lazy { getSystemService<UserManager>() }
+    private val inputMethodManager: InputMethodManager? by lazy {
+        getSystemService<InputMethodManager>()
+    }
+
+    private val keyguardManager: KeyguardManager? by lazy {
+        getSystemService<KeyguardManager>()
+    }
+
     private val broadcastReceiver = object : BroadcastReceiver() {
         override fun onReceive(context: Context?, intent: Intent?) {
             val action = intent?.action ?: return
@@ -120,6 +137,23 @@ class KeyMapperImeService : InputMethodService() {
         keyEventRelayServiceWrapper.onCreate()
     }
 
+    override fun onStartInput(attribute: EditorInfo?, restarting: Boolean) {
+        super.onStartInput(attribute, restarting)
+
+        // IMPORTANT! Select a keyboard with an actual GUI if the user needs
+        // to unlock their device. This must not be in onCreate because
+        // the switchInputMethod does not work there.
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N && userManager?.isUserUnlocked == false) {
+            selectNonBasicKeyboard()
+        } else if (
+            !restarting &&
+            Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP_MR1 &&
+            keyguardManager?.isDeviceLocked == true
+        ) {
+            selectNonBasicKeyboard()
+        }
+    }
+
     override fun onGenericMotionEvent(event: MotionEvent?): Boolean {
         event ?: return super.onGenericMotionEvent(null)
 
@@ -174,4 +208,28 @@ class KeyMapperImeService : InputMethodService() {
 
         super.onDestroy()
     }
+
+    @SuppressLint("LogNotTimber")
+    private fun selectNonBasicKeyboard() {
+        inputMethodManager ?: return
+
+        inputMethodManager!!.enabledInputMethodList
+            .filter {
+                it.packageName != "io.github.sds100.keymapper" &&
+                    it.packageName != "io.github.sds100.keymapper.debug" &&
+                    it.packageName != "io.github.sds100.keymapper.ci"
+            }
+            // Select a random one in case one of them can't be used on the lock screen such as
+            // the Google Voice Typing keyboard. This is critical because i
+            // f an input method can't be used
+            // then it will select the Key Mapper Basic Input method again and loop forever.
+            .randomOrNull()
+            ?.also {
+                Log.e(
+                    KeyMapperImeService::class.simpleName,
+                    "Device is locked! Select ${it.id} input method",
+                )
+                switchInputMethod(it.id)
+            }
+    }
 }