forked from keymapperorg/KeyMapper
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOnboardingUseCase.kt
More file actions
196 lines (160 loc) · 6.88 KB
/
OnboardingUseCase.kt
File metadata and controls
196 lines (160 loc) · 6.88 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
package io.github.sds100.keymapper.onboarding
import io.github.sds100.keymapper.Constants
import io.github.sds100.keymapper.actions.ActionData
import io.github.sds100.keymapper.actions.canUseImeToPerform
import io.github.sds100.keymapper.actions.canUseShizukuToPerform
import io.github.sds100.keymapper.data.Keys
import io.github.sds100.keymapper.data.repositories.PreferenceRepository
import io.github.sds100.keymapper.shizuku.ShizukuAdapter
import io.github.sds100.keymapper.shizuku.ShizukuUtils
import io.github.sds100.keymapper.system.apps.PackageManagerAdapter
import io.github.sds100.keymapper.system.files.FileAdapter
import io.github.sds100.keymapper.system.inputmethod.KeyMapperImeHelper
import io.github.sds100.keymapper.system.leanback.LeanbackAdapter
import io.github.sds100.keymapper.system.permissions.Permission
import io.github.sds100.keymapper.system.permissions.PermissionAdapter
import io.github.sds100.keymapper.util.PrefDelegate
import io.github.sds100.keymapper.util.VersionHelper
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.combine
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.flow.map
/**
* Created by sds100 on 14/02/21.
*/
class OnboardingUseCaseImpl(
private val preferences: PreferenceRepository,
private val fileAdapter: FileAdapter,
private val leanbackAdapter: LeanbackAdapter,
private val shizukuAdapter: ShizukuAdapter,
private val permissionAdapter: PermissionAdapter,
private val packageManagerAdapter: PackageManagerAdapter,
) : PreferenceRepository by preferences,
OnboardingUseCase {
override var shownAppIntro by PrefDelegate(Keys.shownAppIntro, false)
override suspend fun showInstallGuiKeyboardPrompt(action: ActionData): Boolean {
val acknowledged = preferences.get(Keys.acknowledgedGuiKeyboard).first()
val isGuiKeyboardInstalled =
packageManagerAdapter.isAppInstalled(KeyMapperImeHelper.KEY_MAPPER_GUI_IME_PACKAGE)
val isShizukuInstalled = shizukuAdapter.isInstalled.value
return (acknowledged == null || !acknowledged) &&
!isGuiKeyboardInstalled &&
!isShizukuInstalled &&
action.canUseImeToPerform()
}
override suspend fun showInstallShizukuPrompt(action: ActionData): Boolean = !shizukuAdapter.isInstalled.value &&
ShizukuUtils.isRecommendedForSdkVersion() &&
action.canUseShizukuToPerform()
override fun neverShowGuiKeyboardPromptsAgain() {
preferences.set(Keys.acknowledgedGuiKeyboard, true)
}
override var shownParallelTriggerOrderExplanation by PrefDelegate(
Keys.shownParallelTriggerOrderExplanation,
false,
)
override var shownSequenceTriggerExplanation by PrefDelegate(
Keys.shownSequenceTriggerExplanation,
false,
)
override var shownKeyCodeToScanCodeTriggerExplanation by PrefDelegate(
Keys.shownKeyCodeToScanCodeTriggerExplanation,
false,
)
override val showWhatsNew = get(Keys.lastInstalledVersionCodeHomeScreen)
.map { (it ?: -1) < Constants.VERSION_CODE }
override fun showedWhatsNew() {
set(Keys.lastInstalledVersionCodeHomeScreen, Constants.VERSION_CODE)
}
override fun getWhatsNewText(): String = with(fileAdapter.openAsset("whats-new.txt").bufferedReader()) {
readText()
}
override var approvedFloatingButtonFeaturePrompt by PrefDelegate(
Keys.approvedFloatingButtonFeaturePrompt,
false,
)
/**
* Show only when they *upgrade* to the new version and after they've
* completed the app intro, which asks them whether they want to receive notifications.
*/
override val showFloatingButtonFeatureNotification: Flow<Boolean> = combine(
get(Keys.lastInstalledVersionCodeBackground).map { it ?: -1 },
get(Keys.approvedFloatingButtonFeaturePrompt).map { it ?: false },
) { oldVersionCode, approvedPrompt ->
oldVersionCode < VersionHelper.FLOATING_BUTTON_MIN_VERSION && !approvedPrompt
}
override fun showedFloatingButtonFeatureNotification() {
set(Keys.lastInstalledVersionCodeBackground, Constants.VERSION_CODE)
}
override val showQuickStartGuideHint: Flow<Boolean> = get(Keys.shownQuickStartGuideHint).map {
if (it == null) {
true
} else {
!it
}
}
override fun shownQuickStartGuideHint() {
preferences.set(Keys.shownQuickStartGuideHint, true)
}
override fun isTvDevice(): Boolean = leanbackAdapter.isTvDevice()
override val promptForShizukuPermission: Flow<Boolean> = combine(
preferences.get(Keys.shownShizukuPermissionPrompt),
shizukuAdapter.isInstalled,
permissionAdapter.isGrantedFlow(Permission.SHIZUKU),
) {
shownPromptBefore,
isShizkuInstalled,
isShizukuPermissionGranted,
->
shownPromptBefore != true && isShizkuInstalled && !isShizukuPermissionGranted
}
override val showShizukuAppIntroSlide: Boolean
get() = shizukuAdapter.isInstalled.value
override val showNoKeysDetectedBottomSheet: Flow<Boolean> =
preferences.get(Keys.neverShowNoKeysRecordedError).map { neverShow ->
if (neverShow == null) {
true
} else {
!neverShow
}
}
override fun neverShowNoKeysRecordedBottomSheet() {
preferences.set(Keys.neverShowNoKeysRecordedError, true)
}
override val hasViewedAdvancedTriggers: Flow<Boolean> =
get(Keys.viewedAdvancedTriggers).map { it ?: false }
override fun viewedAdvancedTriggers() {
set(Keys.viewedAdvancedTriggers, true)
}
}
interface OnboardingUseCase {
var shownAppIntro: Boolean
/**
* @return whether to prompt the user to install the Key Mapper GUI Keyboard after adding
* this action
*/
suspend fun showInstallGuiKeyboardPrompt(action: ActionData): Boolean
/**
* @return whether to prompt the user to install Shizuku after adding
* this action
*/
suspend fun showInstallShizukuPrompt(action: ActionData): Boolean
fun isTvDevice(): Boolean
fun neverShowGuiKeyboardPromptsAgain()
var shownParallelTriggerOrderExplanation: Boolean
var shownSequenceTriggerExplanation: Boolean
var shownKeyCodeToScanCodeTriggerExplanation: Boolean
val showFloatingButtonFeatureNotification: Flow<Boolean>
fun showedFloatingButtonFeatureNotification()
var approvedFloatingButtonFeaturePrompt: Boolean
val showWhatsNew: Flow<Boolean>
fun showedWhatsNew()
fun getWhatsNewText(): String
val showQuickStartGuideHint: Flow<Boolean>
fun shownQuickStartGuideHint()
val promptForShizukuPermission: Flow<Boolean>
val showShizukuAppIntroSlide: Boolean
val showNoKeysDetectedBottomSheet: Flow<Boolean>
fun neverShowNoKeysRecordedBottomSheet()
val hasViewedAdvancedTriggers: Flow<Boolean>
fun viewedAdvancedTriggers()
}