#1394 remove detect screen off option and use shell for key event actions

Author: sds100

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionData.kt

@@ -48,8 +48,6 @@ sealed class ActionData : Comparable<ActionData> {
     data class InputKeyEvent(
         val keyCode: Int,
         val metaState: Int = 0,
-        // TODO remove this option
-        val useShell: Boolean = false,
         val device: Device? = null,
     ) : ActionData() {
 

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionDataEntityMapper.kt

@@ -79,11 +79,6 @@ object ActionDataEntityMapper {
                     entity.extras.getData(ActionEntity.EXTRA_KEY_EVENT_DEVICE_NAME)
                         .valueOrNull() ?: ""
 
-                val useShell =
-                    entity.extras.getData(ActionEntity.EXTRA_KEY_EVENT_USE_SHELL).then {
-                        (it == "true").success()
-                    }.valueOrNull() ?: false
-
                 val device = if (deviceDescriptor != null) {
                     ActionData.InputKeyEvent.Device(deviceDescriptor, deviceName)
                 } else {
@@ -93,7 +88,6 @@ object ActionDataEntityMapper {
                 ActionData.InputKeyEvent(
                     keyCode = entity.data.toInt(),
                     metaState = metaState,
-                    useShell = useShell,
                     device = device,
                 )
             }
@@ -724,15 +718,6 @@ object ActionDataEntityMapper {
             )
 
         is ActionData.InputKeyEvent -> sequence {
-            if (data.useShell) {
-                val string = if (data.useShell) {
-                    "true"
-                } else {
-                    "false"
-                }
-                yield(EntityExtra(ActionEntity.EXTRA_KEY_EVENT_USE_SHELL, string))
-            }
-
             if (data.metaState != 0) {
                 yield(
                     EntityExtra(

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionErrorSnapshot.kt

@@ -156,13 +156,6 @@ class LazyActionErrorSnapshot(
                 return getAppError(action.packageName)
             }
 
-            is ActionData.InputKeyEvent ->
-                if (
-                    action.useShell && !isPermissionGranted(Permission.ROOT)
-                ) {
-                    return SystemError.PermissionDenied(Permission.ROOT)
-                }
-
             is ActionData.Sound.SoundFile -> {
                 soundsManager.getSound(action.soundUid).onFailure { error ->
                     return error

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionUiHelper.kt

@@ -46,46 +46,43 @@ class ActionUiHelper(
             }
 
             // only a key code can be inputted through the shell
-            if (action.useShell) {
-                getString(R.string.description_keyevent_through_shell, keyCodeString)
-            } else {
-                val metaStateString = buildString {
-                    for (label in KeyCodeStrings.MODIFIER_LABELS.entries) {
-                        val modifier = label.key
-                        val labelRes = label.value
 
-                        if (action.metaState.hasFlag(modifier)) {
-                            append("${getString(labelRes)} + ")
-                        }
-                    }
-                }
+            val metaStateString = buildString {
+                for (label in KeyCodeStrings.MODIFIER_LABELS.entries) {
+                    val modifier = label.key
+                    val labelRes = label.value
 
-                if (action.device != null) {
-                    val name = if (action.device.name.isBlank()) {
-                        getString(R.string.unknown_device_name)
-                    } else {
-                        action.device.name
+                    if (action.metaState.hasFlag(modifier)) {
+                        append("${getString(labelRes)} + ")
                     }
+                }
+            }
 
-                    val nameToShow = if (showDeviceDescriptors) {
-                        InputDeviceUtils.appendDeviceDescriptorToName(
-                            action.device.descriptor,
-                            name,
-                        )
-                    } else {
-                        name
-                    }
+            if (action.device != null) {
+                val name = if (action.device.name.isBlank()) {
+                    getString(R.string.unknown_device_name)
+                } else {
+                    action.device.name
+                }
 
-                    getString(
-                        R.string.description_keyevent_from_device,
-                        arrayOf(metaStateString, keyCodeString, nameToShow),
+                val nameToShow = if (showDeviceDescriptors) {
+                    InputDeviceUtils.appendDeviceDescriptorToName(
+                        action.device.descriptor,
+                        name,
                     )
                 } else {
-                    getString(
-                        R.string.description_keyevent,
-                        args = arrayOf(metaStateString, keyCodeString),
-                    )
+                    name
                 }
+
+                getString(
+                    R.string.description_keyevent_from_device,
+                    arrayOf(metaStateString, keyCodeString, nameToShow),
+                )
+            } else {
+                getString(
+                    R.string.description_keyevent,
+                    args = arrayOf(metaStateString, keyCodeString),
+                )
             }
         }
 
@@ -262,7 +259,7 @@ class ActionUiHelper(
                                 R.string.action_toggle_front_flashlight_with_strength,
                                 action.strengthPercent.toPercentString(),
 
-                            )
+                                )
                         } else {
                             getString(
                                 R.string.action_toggle_flashlight_with_strength,

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionUtils.kt

@@ -852,12 +852,12 @@ object ActionUtils {
 }
 
 fun ActionData.canBeHeldDown(): Boolean = when (this) {
-    is ActionData.InputKeyEvent -> !useShell
+    is ActionData.InputKeyEvent -> true
     else -> false
 }
 
 fun ActionData.canUseImeToPerform(): Boolean = when (this) {
-    is ActionData.InputKeyEvent -> !useShell
+    is ActionData.InputKeyEvent -> true
     is ActionData.Text -> true
     else -> false
 }

base/src/main/java/io/github/sds100/keymapper/base/actions/ChooseActionViewModel.kt

@@ -211,7 +211,6 @@ class ChooseActionViewModel @Inject constructor(
             -> R.string.action_toggle_keyboard_message
 
             ActionId.SECURE_LOCK_DEVICE -> R.string.action_secure_lock_device_message
-            ActionId.POWER_ON_OFF_DEVICE -> R.string.action_power_on_off_device_message
 
             else -> null
         }

base/src/main/java/io/github/sds100/keymapper/base/actions/keyevent/ConfigKeyEventActionViewModel.kt

@@ -105,7 +105,6 @@ class ConfigKeyEventActionViewModel @Inject constructor(
             keyEventState.value = KeyEventState(
                 Success(action.keyCode),
                 inputDevice,
-                useShell = action.useShell,
                 metaState = action.metaState,
             )
         }
@@ -121,10 +120,6 @@ class ConfigKeyEventActionViewModel @Inject constructor(
         keyEventState.value = keyEventState.value.copy(keyCode = keyCodeState)
     }
 
-    fun setUseShell(checked: Boolean) {
-        keyEventState.value = keyEventState.value.copy(useShell = checked)
-    }
-
     @SuppressLint("NullSafeMutableLiveData")
     fun chooseNoDevice() {
         keyEventState.value = keyEventState.value.copy(chosenDevice = null)
@@ -157,7 +152,6 @@ class ConfigKeyEventActionViewModel @Inject constructor(
                 ActionData.InputKeyEvent(
                     keyCode = keyCode,
                     metaState = keyEventState.value.metaState,
-                    useShell = keyEventState.value.useShell,
                     device = device,
                 ),
             )
@@ -171,7 +165,6 @@ class ConfigKeyEventActionViewModel @Inject constructor(
     ): ConfigKeyEventUiState {
         val keyCode = state.keyCode
         val metaState = state.metaState
-        val useShell = state.useShell
         val chosenDevice = state.chosenDevice
 
         val keyCodeString = when (keyCode) {
@@ -226,9 +219,8 @@ class ConfigKeyEventActionViewModel @Inject constructor(
             keyCodeErrorMessage = keyCode.errorOrNull()?.getFullMessage(this),
             keyCodeLabel = keyCodeLabel,
             showKeyCodeLabel = keyCode.isSuccess,
-            isUseShellChecked = useShell,
-            isDevicePickerShown = !useShell,
-            isModifierListShown = !useShell,
+            isDevicePickerShown = true,
+            isModifierListShown = true,
             modifierListItems = modifierListItems,
             isDoneButtonEnabled = keyCode.isSuccess,
             deviceListItems = deviceListItems,
@@ -239,7 +231,6 @@ class ConfigKeyEventActionViewModel @Inject constructor(
     private data class KeyEventState(
         val keyCode: KMResult<Int> = KMError.EmptyText,
         val chosenDevice: InputDeviceInfo? = null,
-        val useShell: Boolean = false,
         val metaState: Int = 0,
     )
 }
@@ -249,7 +240,6 @@ data class ConfigKeyEventUiState(
     val keyCodeErrorMessage: String?,
     val keyCodeLabel: String,
     val showKeyCodeLabel: Boolean,
-    val isUseShellChecked: Boolean,
     val isDevicePickerShown: Boolean,
     val isModifierListShown: Boolean,
     val modifierListItems: List<CheckBoxListItem>,

base/src/main/java/io/github/sds100/keymapper/base/constraints/ChooseConstraintViewModel.kt

@@ -137,19 +137,20 @@ class ChooseConstraintViewModel @Inject constructor(
                 ConstraintId.APP_NOT_IN_FOREGROUND,
                 ConstraintId.APP_PLAYING_MEDIA,
                 ConstraintId.APP_NOT_PLAYING_MEDIA,
-                -> onSelectAppConstraint(constraintType)
+                    -> onSelectAppConstraint(constraintType)
 
                 ConstraintId.MEDIA_PLAYING -> returnResult.emit(Constraint.MediaPlaying())
                 ConstraintId.MEDIA_NOT_PLAYING -> returnResult.emit(Constraint.NoMediaPlaying())
 
                 ConstraintId.BT_DEVICE_CONNECTED,
                 ConstraintId.BT_DEVICE_DISCONNECTED,
-                -> onSelectBluetoothConstraint(
+                    -> onSelectBluetoothConstraint(
                     constraintType,
                 )
 
-                ConstraintId.SCREEN_ON -> onSelectScreenOnConstraint()
-                ConstraintId.SCREEN_OFF -> onSelectScreenOffConstraint()
+                ConstraintId.SCREEN_ON -> returnResult.emit(Constraint.ScreenOn())
+
+                ConstraintId.SCREEN_OFF -> returnResult.emit(Constraint.ScreenOff())
 
                 ConstraintId.ORIENTATION_PORTRAIT ->
                     returnResult.emit(Constraint.OrientationPortrait())
@@ -184,13 +185,13 @@ class ChooseConstraintViewModel @Inject constructor(
 
                 ConstraintId.WIFI_CONNECTED,
                 ConstraintId.WIFI_DISCONNECTED,
-                -> onSelectWifiConnectedConstraint(
+                    -> onSelectWifiConnectedConstraint(
                     constraintType,
                 )
 
                 ConstraintId.IME_CHOSEN,
                 ConstraintId.IME_NOT_CHOSEN,
-                -> onSelectImeChosenConstraint(constraintType)
+                    -> onSelectImeChosenConstraint(constraintType)
 
                 ConstraintId.DEVICE_IS_LOCKED ->
                     returnResult.emit(Constraint.DeviceIsLocked())
@@ -353,28 +354,6 @@ class ChooseConstraintViewModel @Inject constructor(
         }
     }
 
-    private suspend fun onSelectScreenOnConstraint() {
-        val response = showDialog(
-            "screen_on_constraint_limitation",
-            DialogModel.Ok(getString(R.string.dialog_message_screen_constraints_limitation)),
-        )
-
-        response ?: return
-
-        returnResult.emit(Constraint.ScreenOn())
-    }
-
-    private suspend fun onSelectScreenOffConstraint() {
-        val response = showDialog(
-            "screen_on_constraint_limitation",
-            DialogModel.Ok(getString(R.string.dialog_message_screen_constraints_limitation)),
-        )
-
-        response ?: return
-
-        returnResult.emit(Constraint.ScreenOff())
-    }
-
     private suspend fun onSelectBluetoothConstraint(type: ConstraintId) {
         val response = showDialog(
             "bluetooth_device_constraint_limitation",

base/src/main/java/io/github/sds100/keymapper/base/detection/DetectKeyMapsUseCase.kt

@@ -28,7 +28,6 @@ import io.github.sds100.keymapper.data.repositories.GroupRepository
 import io.github.sds100.keymapper.data.repositories.KeyMapRepository
 import io.github.sds100.keymapper.data.repositories.PreferenceRepository
 import io.github.sds100.keymapper.system.popup.ToastAdapter
-import io.github.sds100.keymapper.system.root.SuAdapter
 import io.github.sds100.keymapper.system.vibrator.VibratorAdapter
 import io.github.sds100.keymapper.system.volume.VolumeAdapter
 import kotlinx.coroutines.CoroutineScope
@@ -46,7 +45,6 @@ class DetectKeyMapsUseCaseImpl @AssistedInject constructor(
     private val floatingButtonRepository: FloatingButtonRepository,
     private val groupRepository: GroupRepository,
     private val preferenceRepository: PreferenceRepository,
-    private val suAdapter: SuAdapter,
     private val volumeAdapter: VolumeAdapter,
     private val toastAdapter: ToastAdapter,
     private val resourceProvider: ResourceProvider,
@@ -137,14 +135,6 @@ class DetectKeyMapsUseCaseImpl @AssistedInject constructor(
             keyMapList.filter { it.keyMap.trigger.triggerFromOtherApps }.map { it.keyMap }
         }.flowOn(Dispatchers.Default)
 
-    override val detectScreenOffTriggers: Flow<Boolean> =
-        combine(
-            allKeyMapList,
-            suAdapter.isRootGranted,
-        ) { keyMapList, isRootPermissionGranted ->
-            keyMapList.any { it.keyMap.trigger.screenOffTrigger } && isRootPermissionGranted
-        }.flowOn(Dispatchers.Default)
-
     override val defaultLongPressDelay: Flow<Long> =
         preferenceRepository.get(Keys.defaultLongPressDelay)
             .map { it ?: PreferenceDefaults.LONG_PRESS_DELAY }
@@ -239,7 +229,6 @@ interface DetectKeyMapsUseCase {
     val allKeyMapList: Flow<List<DetectKeyMapModel>>
     val requestFingerprintGestureDetection: Flow<Boolean>
     val keyMapsToTriggerFromOtherApps: Flow<List<KeyMap>>
-    val detectScreenOffTriggers: Flow<Boolean>
 
     val defaultLongPressDelay: Flow<Long>
     val defaultDoublePressDelay: Flow<Long>

base/src/main/java/io/github/sds100/keymapper/base/home/KeyMapListItemCreator.kt

@@ -362,10 +362,6 @@ class KeyMapListItemCreator(
             labels.add(getString(R.string.flag_long_press_double_vibration))
         }
 
-        if (trigger.isDetectingWhenScreenOffAllowed() && trigger.screenOffTrigger) {
-            labels.add(getString(R.string.flag_detect_triggers_screen_off))
-        }
-
         if (trigger.triggerFromOtherApps) {
             labels.add(getString(R.string.flag_trigger_from_other_apps))
         }