#1235 fix: use new key event relay service WIP

sds100 · sds100 · commit 345c6c1a79b3 · 2024-06-29T20:34:56.000+02:00
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
@@ -22,9 +22,9 @@
     <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
     <uses-permission android:name="android.permission.VIBRATE" />
     <uses-permission android:name="android.permission.WRITE_USER_DICTIONARY" />
-    <uses-permission android:name="io.github.sds100.keymapper.KEY_EVENT_RECEIVER" />
+    <uses-permission android:name="io.github.sds100.keymapper.KEY_EVENT_RELAY_SERVICE" />
 
-    <!-- A signature-protected permission to ask AOSP Keyboard to close the software keyboard.
+    <!-- A signature-protected permission to ask AOSP Keyboar   d to close the software keyboard.
          To use this, add the following line into calling application's AndroidManifest.xml
          <pre>
          {@code
diff --git a/app/src/main/aidl/io/github/sds100/keymapper/IKeyEventRelayService.aidl b/app/src/main/aidl/io/github/sds100/keymapper/IKeyEventRelayService.aidl
@@ -0,0 +1,26 @@
+package io.github.sds100.keymapper;
+
+import android.view.KeyEvent;
+import io.github.sds100.keymapper.IKeyEventRelayServiceCallback;
+
+interface IKeyEventRelayService {
+    /**
+     * Send a key event to the target package that is registered with
+     * a callback.
+     */
+    boolean sendKeyEvent(in KeyEvent event, in String targetPackageName);
+
+    /**
+     * Register a callback to receive key events from this relay service. The service
+     * checks the process uid of the caller to this method and only permits certain applications
+     * from connecting.
+     */
+    void registerCallback(IKeyEventRelayServiceCallback client);
+
+    /**
+     * Unregister a callback to receive key events from this relay service. The service
+     * checks the process uid of the caller to this method and only permits certain applications
+     * from connecting.
+     */
+    void unregisterCallback();
+}
diff --git a/app/src/main/aidl/io/github/sds100/keymapper/IKeyEventRelayServiceCallback.aidl b/app/src/main/aidl/io/github/sds100/keymapper/IKeyEventRelayServiceCallback.aidl
@@ -0,0 +1,7 @@
+package io.github.sds100.keymapper;
+
+import android.view.KeyEvent;
+
+interface IKeyEventRelayServiceCallback {
+    boolean onKeyEvent(in KeyEvent event, in String sourcePackageName);
+}
diff --git a/app/src/main/aidl/io/github/sds100/keymapper/api/IKeyEventReceiver.aidl b/app/src/main/aidl/io/github/sds100/keymapper/api/IKeyEventReceiver.aidl
diff --git a/app/src/main/java/io/github/sds100/keymapper/inputmethod/latin/KeyEventRelayServiceWrapper.kt b/app/src/main/java/io/github/sds100/keymapper/inputmethod/latin/KeyEventRelayServiceWrapper.kt
@@ -0,0 +1,95 @@
+package io.github.sds100.keymapper.inputmethod.latin
+
+import android.content.ComponentName
+import android.content.Context
+import android.content.Intent
+import android.content.ServiceConnection
+import android.os.DeadObjectException
+import android.os.IBinder
+import android.util.Log
+import android.view.KeyEvent
+import io.github.sds100.keymapper.IKeyEventRelayService
+import io.github.sds100.keymapper.IKeyEventRelayServiceCallback
+
+/**
+ * This handles connecting to the relay service and exposes an interface
+ * so other parts of the app can get a reference to the service even when it isn't
+ * bound yet.
+ */
+class KeyEventRelayServiceWrapperImpl(
+    context: Context,
+    private val callback: IKeyEventRelayServiceCallback,
+) : KeyEventRelayServiceWrapper {
+    private val ctx: Context = context.applicationContext
+
+    private val keyEventRelayServiceLock: Any = Any()
+    private var keyEventRelayService: IKeyEventRelayService? = null
+
+    private val keyEventReceiverConnection: ServiceConnection =
+        object : ServiceConnection {
+            override fun onServiceConnected(
+                name: ComponentName?,
+                service: IBinder?,
+            ) {
+                synchronized(keyEventRelayServiceLock) {
+                    keyEventRelayService = IKeyEventRelayService.Stub.asInterface(service)
+                    Log.e(LatinIME.TAG, "Register callback")
+                    keyEventRelayService?.registerCallback(callback)
+                }
+            }
+
+            override fun onServiceDisconnected(name: ComponentName?) {
+                synchronized(keyEventRelayServiceLock) {
+                    keyEventRelayService?.unregisterCallback()
+                    keyEventRelayService = null
+                }
+            }
+        }
+
+    override fun sendKeyEvent(
+        event: KeyEvent?,
+        targetPackageName: String?,
+    ): Boolean {
+        synchronized(keyEventRelayServiceLock) {
+            if (keyEventRelayService == null) {
+                return false
+            }
+
+            try {
+                return keyEventRelayService!!.sendKeyEvent(event, targetPackageName)
+            } catch (e: DeadObjectException) {
+                keyEventRelayService = null
+                return false
+            }
+        }
+    }
+
+    fun bind() {
+        try {
+            val keyEventReceiverComponent =
+                ComponentName("io.github.sds100.keymapper.debug", "io.github.sds100.keymapper.api.KeyEventRelayService")
+            val keyEventReceiverServiceIntent = Intent()
+            keyEventReceiverServiceIntent.setComponent(keyEventReceiverComponent)
+            ctx.bindService(keyEventReceiverServiceIntent, keyEventReceiverConnection, 0)
+
+            Log.e(LatinIME.TAG, "Bind to service")
+        } catch (e: SecurityException) {
+            Log.e(LatinIME.TAG, e.toString())
+        }
+    }
+
+    fun unbind() {
+        try {
+            ctx.unbindService(keyEventReceiverConnection)
+        } catch (e: DeadObjectException) {
+            // do nothing
+        }
+    }
+}
+
+interface KeyEventRelayServiceWrapper {
+    fun sendKeyEvent(
+        event: KeyEvent?,
+        targetPackageName: String?,
+    ): Boolean
+}
diff --git a/app/src/main/java/io/github/sds100/keymapper/inputmethod/latin/LatinIME.java b/app/src/main/java/io/github/sds100/keymapper/inputmethod/latin/LatinIME.java
@@ -16,19 +16,13 @@
 
 package io.github.sds100.keymapper.inputmethod.latin;
 
-import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.FORCE_ASCII;
-import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE;
-import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE_COMPAT;
-
 import android.app.AlertDialog;
 import android.content.BroadcastReceiver;
-import android.content.ComponentName;
 import android.content.Context;
 import android.content.DialogInterface;
 import android.content.DialogInterface.OnClickListener;
 import android.content.Intent;
 import android.content.IntentFilter;
-import android.content.ServiceConnection;
 import android.content.res.Configuration;
 import android.content.res.Resources;
 import android.graphics.Color;
@@ -39,7 +33,6 @@
 import android.os.IBinder;
 import android.os.Message;
 import android.os.Process;
-import android.os.RemoteException;
 import android.text.InputType;
 import android.util.Log;
 import android.util.PrintWriterPrinter;
@@ -65,7 +58,7 @@
 
 import javax.annotation.Nonnull;
 
-import io.github.sds100.keymapper.api.IKeyEventReceiver;
+import io.github.sds100.keymapper.IKeyEventRelayServiceCallback;
 import io.github.sds100.keymapper.inputmethod.accessibility.AccessibilityUtils;
 import io.github.sds100.keymapper.inputmethod.annotations.UsedForTesting;
 import io.github.sds100.keymapper.inputmethod.compat.EditorInfoCompatUtils;
@@ -108,6 +101,10 @@
 import io.github.sds100.keymapper.inputmethod.latin.utils.SubtypeLocaleUtils;
 import io.github.sds100.keymapper.inputmethod.latin.utils.ViewLayoutUtils;
 
+import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.FORCE_ASCII;
+import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE;
+import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE_COMPAT;
+
 /**
  * Input method implementation for Qwerty'ish keyboard.
  */
@@ -167,7 +164,8 @@ public class LatinIME extends InputMethodService implements KeyboardActionListen
     private SuggestionStripView mSuggestionStripView;
 
     private RichInputMethodManager mRichImm;
-    @UsedForTesting final KeyboardSwitcher mKeyboardSwitcher;
+    @UsedForTesting
+    final KeyboardSwitcher mKeyboardSwitcher;
     private final SubtypeState mSubtypeState = new SubtypeState();
     private EmojiAltPhysicalKeyDetector mEmojiAltPhysicalKeyDetector;
     private StatsUtilsManager mStatsUtilsManager;
@@ -199,6 +197,7 @@ public void onReceive(Context context, Intent intent) {
             }
         }
     }
+
     final HideSoftInputReceiver mHideSoftInputReceiver = new HideSoftInputReceiver(this);
 
     final static class RestartAfterDeviceUnlockReceiver extends BroadcastReceiver {
@@ -220,22 +219,17 @@ public void onReceive(Context context, Intent intent) {
 
     final RestartAfterDeviceUnlockReceiver mRestartAfterDeviceUnlockReceiver = new RestartAfterDeviceUnlockReceiver();
 
-    private final Object mKeyEventReceiverLock = new Object();
-    private IKeyEventReceiver mKeyEventReceiverBinder = null;
-
-    private final ServiceConnection mKeyEventReceiverConnection = new ServiceConnection() {
+    private KeyEventRelayServiceWrapperImpl mKeyEventRelayServiceWrapper;
+    private IKeyEventRelayServiceCallback mKeyEventRelayServiceCallback = new IKeyEventRelayServiceCallback.Stub() {
         @Override
-        public void onServiceConnected(ComponentName name, IBinder service) {
-            synchronized (mKeyEventReceiverLock) {
-                mKeyEventReceiverBinder = IKeyEventReceiver.Stub.asInterface(service);
-            }
-        }
+        public boolean onKeyEvent(KeyEvent event, String sourcePackageName) {
+            InputConnection ic = getCurrentInputConnection();
 
-        @Override
-        public void onServiceDisconnected(ComponentName name) {
-            synchronized (mKeyEventReceiverLock) {
-                mKeyEventReceiverBinder = null;
+            if (ic == null) {
+                return false;
             }
+
+            return ic.sendKeyEvent(event);
         }
     };
 
@@ -438,7 +432,7 @@ public void handleMessage(final Message msg) {
                     latinIme.deallocateMemory();
                     break;
                 case MSG_SWITCH_LANGUAGE_AUTOMATICALLY:
-                    latinIme.switchLanguage((InputMethodSubtype)msg.obj);
+                    latinIme.switchLanguage((InputMethodSubtype) msg.obj);
                     break;
                 case MSG_UPDATE_CLIPBOARD_PINNED_CLIPS:
                     @SuppressWarnings("unchecked")
@@ -782,14 +776,10 @@ public void onCreate() {
 
         registerReceiver(mKeyMapperBroadcastReceiver, keyMapperIntentFilter);
 
-        try {
-            ComponentName keyEventReceiverComponent = new ComponentName("io.github.sds100.keymapper", "io.github.sds100.keymapper.api.KeyEventReceiver");
-            Intent keyEventReceiverServiceIntent = new Intent();
-            keyEventReceiverServiceIntent.setComponent(keyEventReceiverComponent);
-            bindService(keyEventReceiverServiceIntent, mKeyEventReceiverConnection, 0);
-        } catch (SecurityException e) {
-            Log.e(TAG, e.toString());
-        }
+        mKeyEventRelayServiceWrapper =
+                new KeyEventRelayServiceWrapperImpl(getApplicationContext(), mKeyEventRelayServiceCallback);
+
+        mKeyEventRelayServiceWrapper.bind();
 
         StatsUtils.onCreate(mSettings.getCurrent(), mRichImm);
     }
@@ -903,7 +893,7 @@ public void onDestroy() {
         unregisterReceiver(mRestartAfterDeviceUnlockReceiver);
         unregisterReceiver(mKeyMapperBroadcastReceiver);
         mStatsUtilsManager.onDestroy(this /* context */);
-        unbindService(mKeyEventReceiverConnection);
+        mKeyEventRelayServiceWrapper.unbind();
         super.onDestroy();
     }
 
@@ -1483,7 +1473,7 @@ public int getCurrentRecapitalizeState() {
 
     /**
      * @param codePoints code points to get coordinates for.
-     * @return x,y coordinates for this keyboard, as a flattened array.
+     * @return x, y coordinates for this keyboard, as a flattened array.
      */
     public int[] getCoordinatesForCurrentKeyboard(final int[] codePoints) {
         final Keyboard keyboard = mKeyboardSwitcher.getKeyboard();
@@ -1528,7 +1518,7 @@ public void onMovePointer(int steps) {
         // for RTL languages we want to invert pointer movement
         if (mRichImm.getCurrentSubtype().isRtlSubtype())
             steps = -steps;
-            
+
         mInputLogic.finishInput();
         if (steps < 0) {
             int availableCharacters = mInputLogic.mConnection.getTextBeforeCursor(64, 0).length();
@@ -1687,6 +1677,7 @@ public void onCancelBatchInput() {
      * IME for the full gesture, possibly updating the TextView to reflect the first suggestion.
      * <p>
      * This method must be run on the UI Thread.
+     *
      * @param suggestedWords suggested words by the IME for the full gesture.
      */
     public void onTailBatchInputResultShown(final SuggestedWords suggestedWords) {
@@ -1836,6 +1827,7 @@ void loadKeyboard() {
      * After an input transaction has been executed, some state must be updated. This includes
      * the shift state of the keyboard and suggestions. This method looks at the finished
      * inputTransaction to find out what is necessary and updates the state accordingly.
+     *
      * @param inputTransaction The transaction that has been executed.
      */
     private void updateStateAfterInputTransaction(final InputTransaction inputTransaction) {
@@ -1923,13 +1915,9 @@ private HardwareEventDecoder getHardwareKeyEventDecoder(final int deviceId) {
     @Override
     public boolean onKeyDown(final int keyCode, final KeyEvent keyEvent) {
 
-        if (mKeyEventReceiverBinder != null) {
-            try {
-                if (mKeyEventReceiverBinder.onKeyEvent(keyEvent)) {
-                    return true;
-                }
-            } catch (RemoteException e) {
-
+        if (mKeyEventRelayServiceWrapper != null) {
+            if (mKeyEventRelayServiceWrapper.sendKeyEvent(keyEvent, "io.github.sds100.keymapper")) {
+                return true;
             }
         }
 
@@ -1959,13 +1947,9 @@ public boolean onKeyDown(final int keyCode, final KeyEvent keyEvent) {
 
     @Override
     public boolean onKeyUp(final int keyCode, final KeyEvent keyEvent) {
-        if (mKeyEventReceiverBinder != null) {
-            try {
-                if (mKeyEventReceiverBinder.onKeyEvent(keyEvent)) {
-                    return true;
-                }
-            } catch (RemoteException e) {
-
+        if (mKeyEventRelayServiceWrapper != null) {
+            if (mKeyEventRelayServiceWrapper.sendKeyEvent(keyEvent, "io.github.sds100.keymapper")) {
+                return true;
             }
         }
 
@@ -2024,7 +2008,7 @@ private void showSubtypeSelectorAndSettings() {
         final CharSequence title = getString(R.string.english_ime_input_options);
         // TODO: Should use new string "Select active input modes".
         final CharSequence languageSelectionTitle = getString(R.string.language_selection_title);
-        final CharSequence[] items = new CharSequence[] {
+        final CharSequence[] items = new CharSequence[]{
                 languageSelectionTitle,
                 getString(ApplicationUtils.getActivityTitleResId(this, SettingsActivity.class))
         };
