Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2023 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Stefan Andonian | 146701c | 2022-11-10 23:07:40 +0000 | [diff] [blame] | 16 | package com.android.launcher3 |
| 17 | |
| 18 | import android.content.Context |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 19 | import android.content.Context.MODE_PRIVATE |
Stefan Andonian | 146701c | 2022-11-10 23:07:40 +0000 | [diff] [blame] | 20 | import android.content.SharedPreferences |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 21 | import android.content.SharedPreferences.OnSharedPreferenceChangeListener |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 22 | import android.util.Log |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 23 | import androidx.annotation.VisibleForTesting |
fbaron | e58aaf1 | 2023-09-25 11:34:56 -0700 | [diff] [blame] | 24 | import com.android.launcher3.BuildConfig.WIDGET_ON_FIRST_SCREEN |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 25 | import com.android.launcher3.LauncherFiles.DEVICE_PREFERENCES_KEY |
| 26 | import com.android.launcher3.LauncherFiles.SHARED_PREFERENCES_KEY |
Andreas Agvard | fc74c09 | 2023-11-16 15:06:46 +0100 | [diff] [blame^] | 27 | import com.android.launcher3.config.FeatureFlags.LPNH_HAPTIC_HINT_DELAY |
Andreas Agvard | b36bcff | 2023-11-10 15:16:55 +0100 | [diff] [blame] | 28 | import com.android.launcher3.config.FeatureFlags.LPNH_HAPTIC_HINT_END_SCALE_PERCENT |
| 29 | import com.android.launcher3.config.FeatureFlags.LPNH_HAPTIC_HINT_ITERATIONS |
| 30 | import com.android.launcher3.config.FeatureFlags.LPNH_HAPTIC_HINT_SCALE_EXPONENT |
| 31 | import com.android.launcher3.config.FeatureFlags.LPNH_HAPTIC_HINT_START_SCALE_PERCENT |
Anushree Ganjam | cb571da | 2023-10-24 14:47:09 -0700 | [diff] [blame] | 32 | import com.android.launcher3.config.FeatureFlags.LPNH_SLOP_PERCENTAGE |
| 33 | import com.android.launcher3.config.FeatureFlags.LPNH_TIMEOUT_MS |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 34 | import com.android.launcher3.model.DeviceGridState |
| 35 | import com.android.launcher3.pm.InstallSessionHelper |
| 36 | import com.android.launcher3.provider.RestoreDbTask |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 37 | import com.android.launcher3.states.RotationHelper |
| 38 | import com.android.launcher3.util.DisplayController |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 39 | import com.android.launcher3.util.MainThreadInitializedObject |
| 40 | import com.android.launcher3.util.Themes |
Stefan Andonian | 146701c | 2022-11-10 23:07:40 +0000 | [diff] [blame] | 41 | |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 42 | /** |
| 43 | * Use same context for shared preferences, so that we use a single cached instance |
Jordan Demeulenaere | be82bc6 | 2023-03-01 09:11:48 +0000 | [diff] [blame] | 44 | * |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 45 | * TODO(b/262721340): Replace all direct SharedPreference refs with LauncherPrefs / Item methods. |
Stefan Andonian | 956b88e | 2023-03-20 20:38:46 +0000 | [diff] [blame] | 46 | * TODO(b/274501660): Fix ReorderWidgets#simpleReorder test before enabling |
| 47 | * isBootAwareStartupDataEnabled |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 48 | */ |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 49 | class LauncherPrefs(private val encryptedContext: Context) { |
| 50 | private val deviceProtectedStorageContext = |
| 51 | encryptedContext.createDeviceProtectedStorageContext() |
| 52 | |
| 53 | private val bootAwarePrefs |
| 54 | get() = |
| 55 | deviceProtectedStorageContext.getSharedPreferences(BOOT_AWARE_PREFS_KEY, MODE_PRIVATE) |
| 56 | |
| 57 | private val Item.encryptedPrefs |
| 58 | get() = encryptedContext.getSharedPreferences(sharedPrefFile, MODE_PRIVATE) |
| 59 | |
| 60 | // This call to `SharedPreferences` needs to be explicit rather than using `get` since doing so |
| 61 | // would result in a circular dependency between `isStartupDataMigrated` and `choosePreferences` |
| 62 | val isStartupDataMigrated: Boolean |
| 63 | get() = |
| 64 | bootAwarePrefs.getBoolean( |
| 65 | IS_STARTUP_DATA_MIGRATED.sharedPrefKey, |
| 66 | IS_STARTUP_DATA_MIGRATED.defaultValue |
| 67 | ) |
| 68 | |
| 69 | private fun chooseSharedPreferences(item: Item): SharedPreferences = |
Stefan Andonian | 939d5f8 | 2023-09-25 18:07:43 +0000 | [diff] [blame] | 70 | if ( |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 71 | (moveStartupDataToDeviceProtectedStorageIsEnabled && |
| 72 | item.encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED && |
| 73 | isStartupDataMigrated) || item.encryptionType == EncryptionType.DEVICE_PROTECTED |
Stefan Andonian | 939d5f8 | 2023-09-25 18:07:43 +0000 | [diff] [blame] | 74 | ) |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 75 | bootAwarePrefs |
| 76 | else item.encryptedPrefs |
Stefan Andonian | 146701c | 2022-11-10 23:07:40 +0000 | [diff] [blame] | 77 | |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 78 | /** Wrapper around `getInner` for a `ContextualItem` */ |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 79 | fun <T> get(item: ContextualItem<T>): T = |
| 80 | getInner(item, item.defaultValueFromContext(encryptedContext)) |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 81 | |
| 82 | /** Wrapper around `getInner` for an `Item` */ |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 83 | fun <T> get(item: ConstantItem<T>): T = getInner(item, item.defaultValue) |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 84 | |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 85 | /** |
| 86 | * Retrieves the value for an [Item] from [SharedPreferences]. It handles method typing via the |
| 87 | * default value type, and will throw an error if the type of the item provided is not a |
| 88 | * `String`, `Boolean`, `Float`, `Int`, `Long`, or `Set<String>`. |
| 89 | */ |
| 90 | @Suppress("IMPLICIT_CAST_TO_ANY", "UNCHECKED_CAST") |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 91 | private fun <T> getInner(item: Item, default: T): T { |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 92 | val sp = chooseSharedPreferences(item) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 93 | |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 94 | return when (item.type) { |
| 95 | String::class.java -> sp.getString(item.sharedPrefKey, default as? String) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 96 | Boolean::class.java, |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 97 | java.lang.Boolean::class.java -> sp.getBoolean(item.sharedPrefKey, default as Boolean) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 98 | Int::class.java, |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 99 | java.lang.Integer::class.java -> sp.getInt(item.sharedPrefKey, default as Int) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 100 | Float::class.java, |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 101 | java.lang.Float::class.java -> sp.getFloat(item.sharedPrefKey, default as Float) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 102 | Long::class.java, |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 103 | java.lang.Long::class.java -> sp.getLong(item.sharedPrefKey, default as Long) |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 104 | Set::class.java -> sp.getStringSet(item.sharedPrefKey, default as? Set<String>) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 105 | else -> |
| 106 | throw IllegalArgumentException( |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 107 | "item type: ${item.type}" + " is not compatible with sharedPref methods" |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 108 | ) |
| 109 | } |
| 110 | as T |
Stefan Andonian | 146701c | 2022-11-10 23:07:40 +0000 | [diff] [blame] | 111 | } |
| 112 | |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 113 | /** |
| 114 | * Stores each of the values provided in `SharedPreferences` according to the configuration |
| 115 | * contained within the associated items provided. Internally, it uses apply, so the caller |
| 116 | * cannot assume that the values that have been put are immediately available for use. |
| 117 | * |
| 118 | * The forEach loop is necessary here since there is 1 `SharedPreference.Editor` returned from |
| 119 | * prepareToPutValue(itemsToValues) for every distinct `SharedPreferences` file present in the |
| 120 | * provided item configurations. |
| 121 | */ |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 122 | fun put(vararg itemsToValues: Pair<Item, Any>): Unit = |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 123 | prepareToPutValues(itemsToValues).forEach { it.apply() } |
| 124 | |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 125 | /** See referenced `put` method above. */ |
| 126 | fun <T : Any> put(item: Item, value: T): Unit = put(item.to(value)) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 127 | |
| 128 | /** |
| 129 | * Synchronously stores all the values provided according to their associated Item |
| 130 | * configuration. |
| 131 | */ |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 132 | fun putSync(vararg itemsToValues: Pair<Item, Any>): Unit = |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 133 | prepareToPutValues(itemsToValues).forEach { it.commit() } |
| 134 | |
| 135 | /** |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 136 | * Updates the values stored in `SharedPreferences` for each corresponding Item-value pair. If |
| 137 | * the item is boot aware, this method updates both the boot aware and the encrypted files. This |
| 138 | * is done because: 1) It allows for easy roll-back if the data is already in encrypted prefs |
| 139 | * and we need to turn off the boot aware data feature & 2) It simplifies Backup/Restore, which |
| 140 | * already points to encrypted storage. |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 141 | * |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 142 | * Returns a list of editors with all transactions added so that the caller can determine to use |
| 143 | * .apply() or .commit() |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 144 | */ |
| 145 | private fun prepareToPutValues( |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 146 | updates: Array<out Pair<Item, Any>> |
| 147 | ): List<SharedPreferences.Editor> { |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 148 | val updatesPerPrefFile = |
| 149 | updates |
| 150 | .filter { it.first.encryptionType != EncryptionType.DEVICE_PROTECTED } |
| 151 | .groupBy { it.first.encryptedPrefs } |
| 152 | .toMutableMap() |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 153 | |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 154 | val bootAwareUpdates = |
| 155 | updates.filter { |
| 156 | (it.first.encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED && |
| 157 | moveStartupDataToDeviceProtectedStorageIsEnabled) || |
| 158 | it.first.encryptionType == EncryptionType.DEVICE_PROTECTED |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 159 | } |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 160 | if (bootAwareUpdates.isNotEmpty()) { |
| 161 | updatesPerPrefFile[bootAwarePrefs] = bootAwareUpdates |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | return updatesPerPrefFile.map { prefToItemValueList -> |
| 165 | prefToItemValueList.key.edit().apply { |
| 166 | prefToItemValueList.value.forEach { itemToValue: Pair<Item, Any> -> |
| 167 | putValue(itemToValue.first, itemToValue.second) |
| 168 | } |
| 169 | } |
| 170 | } |
| 171 | } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 172 | |
| 173 | /** |
| 174 | * Handles adding values to `SharedPreferences` regardless of type. This method is especially |
| 175 | * helpful for updating `SharedPreferences` values for `List<<Item>Any>` that have multiple |
| 176 | * types of Item values. |
| 177 | */ |
| 178 | @Suppress("UNCHECKED_CAST") |
| 179 | private fun SharedPreferences.Editor.putValue( |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 180 | item: Item, |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 181 | value: Any? |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 182 | ): SharedPreferences.Editor = |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 183 | when (item.type) { |
| 184 | String::class.java -> putString(item.sharedPrefKey, value as? String) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 185 | Boolean::class.java, |
| 186 | java.lang.Boolean::class.java -> putBoolean(item.sharedPrefKey, value as Boolean) |
| 187 | Int::class.java, |
| 188 | java.lang.Integer::class.java -> putInt(item.sharedPrefKey, value as Int) |
| 189 | Float::class.java, |
| 190 | java.lang.Float::class.java -> putFloat(item.sharedPrefKey, value as Float) |
| 191 | Long::class.java, |
| 192 | java.lang.Long::class.java -> putLong(item.sharedPrefKey, value as Long) |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 193 | Set::class.java -> putStringSet(item.sharedPrefKey, value as? Set<String>) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 194 | else -> |
| 195 | throw IllegalArgumentException( |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 196 | "item type: ${item.type} is not compatible with sharedPref methods" |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 197 | ) |
| 198 | } |
| 199 | |
| 200 | /** |
| 201 | * After calling this method, the listener will be notified of any future updates to the |
| 202 | * `SharedPreferences` files associated with the provided list of items. The listener will need |
| 203 | * to filter update notifications so they don't activate for non-relevant updates. |
| 204 | */ |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 205 | fun addListener(listener: OnSharedPreferenceChangeListener, vararg items: Item) { |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 206 | items |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 207 | .map { chooseSharedPreferences(it) } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 208 | .distinct() |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 209 | .forEach { it.registerOnSharedPreferenceChangeListener(listener) } |
Thales Lima | 03ac377 | 2023-01-06 15:16:41 +0000 | [diff] [blame] | 210 | } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 211 | |
| 212 | /** |
| 213 | * Stops the listener from getting notified of any more updates to any of the |
| 214 | * `SharedPreferences` files associated with any of the provided list of [Item]. |
| 215 | */ |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 216 | fun removeListener(listener: OnSharedPreferenceChangeListener, vararg items: Item) { |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 217 | // If a listener is not registered to a SharedPreference, unregistering it does nothing |
| 218 | items |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 219 | .map { chooseSharedPreferences(it) } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 220 | .distinct() |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 221 | .forEach { it.unregisterOnSharedPreferenceChangeListener(listener) } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 222 | } |
| 223 | |
| 224 | /** |
| 225 | * Checks if all the provided [Item] have values stored in their corresponding |
| 226 | * `SharedPreferences` files. |
| 227 | */ |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 228 | fun has(vararg items: Item): Boolean { |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 229 | items |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 230 | .groupBy { chooseSharedPreferences(it) } |
| 231 | .forEach { (prefs, itemsSublist) -> |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 232 | if (!itemsSublist.none { !prefs.contains(it.sharedPrefKey) }) return false |
| 233 | } |
| 234 | return true |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * Asynchronously removes the [Item]'s value from its corresponding `SharedPreferences` file. |
| 239 | */ |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 240 | fun remove(vararg items: Item) = prepareToRemove(items).forEach { it.apply() } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 241 | |
| 242 | /** Synchronously removes the [Item]'s value from its corresponding `SharedPreferences` file. */ |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 243 | fun removeSync(vararg items: Item) = prepareToRemove(items).forEach { it.commit() } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 244 | |
| 245 | /** |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 246 | * Removes the key value pairs stored in `SharedPreferences` for each corresponding Item. If the |
| 247 | * item is boot aware, this method removes the data from both the boot aware and encrypted |
| 248 | * files. |
| 249 | * |
| 250 | * @return a list of editors with all transactions added so that the caller can determine to use |
Stefan Andonian | 956b88e | 2023-03-20 20:38:46 +0000 | [diff] [blame] | 251 | * .apply() or .commit() |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 252 | */ |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 253 | private fun prepareToRemove(items: Array<out Item>): List<SharedPreferences.Editor> { |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 254 | val itemsPerFile = |
| 255 | items |
| 256 | .filter { it.encryptionType != EncryptionType.DEVICE_PROTECTED } |
| 257 | .groupBy { it.encryptedPrefs } |
| 258 | .toMutableMap() |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 259 | |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 260 | val bootAwareUpdates = |
| 261 | items.filter { |
| 262 | (it.encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED && |
| 263 | moveStartupDataToDeviceProtectedStorageIsEnabled) || |
| 264 | it.encryptionType == EncryptionType.DEVICE_PROTECTED |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 265 | } |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 266 | if (bootAwareUpdates.isNotEmpty()) { |
| 267 | itemsPerFile[bootAwarePrefs] = bootAwareUpdates |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 268 | } |
| 269 | |
| 270 | return itemsPerFile.map { (prefs, items) -> |
| 271 | prefs.edit().also { editor -> |
| 272 | items.forEach { item -> editor.remove(item.sharedPrefKey) } |
| 273 | } |
| 274 | } |
| 275 | } |
| 276 | |
| 277 | fun migrateStartupDataToDeviceProtectedStorage() { |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 278 | if (!moveStartupDataToDeviceProtectedStorageIsEnabled) return |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 279 | |
| 280 | Log.d( |
| 281 | TAG, |
| 282 | "Migrating data to unencrypted shared preferences to enable preloading " + |
| 283 | "while the user is locked the next time the device reboots." |
| 284 | ) |
| 285 | |
| 286 | with(bootAwarePrefs.edit()) { |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 287 | ITEMS_TO_MOVE_TO_DEVICE_PROTECTED_STORAGE.forEach { putValue(it, get(it)) } |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 288 | putBoolean(IS_STARTUP_DATA_MIGRATED.sharedPrefKey, true) |
| 289 | apply() |
| 290 | } |
| 291 | } |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 292 | |
| 293 | companion object { |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 294 | private const val TAG = "LauncherPrefs" |
| 295 | @VisibleForTesting const val BOOT_AWARE_PREFS_KEY = "boot_aware_prefs" |
| 296 | |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 297 | @JvmField var INSTANCE = MainThreadInitializedObject { LauncherPrefs(it) } |
| 298 | |
| 299 | @JvmStatic fun get(context: Context): LauncherPrefs = INSTANCE.get(context) |
| 300 | |
Jagrut Desai | c6d625b | 2023-04-03 16:57:32 -0700 | [diff] [blame] | 301 | const val TASKBAR_PINNING_KEY = "TASKBAR_PINNING_KEY" |
fbaron | e58aaf1 | 2023-09-25 11:34:56 -0700 | [diff] [blame] | 302 | const val SHOULD_SHOW_SMARTSPACE_KEY = "SHOULD_SHOW_SMARTSPACE_KEY" |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 303 | @JvmField |
| 304 | val ICON_STATE = |
| 305 | nonRestorableItem( |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 306 | "pref_icon_shape_path", |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 307 | "", |
| 308 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 309 | ) |
Andy Wickham | af5bb30 | 2023-05-17 14:13:44 -0700 | [diff] [blame] | 310 | @JvmField |
| 311 | val ALL_APPS_OVERVIEW_THRESHOLD = |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 312 | nonRestorableItem( |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 313 | "pref_all_apps_overview_threshold", |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 314 | 180, |
| 315 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 316 | ) |
| 317 | @JvmField |
Andy Wickham | 9fbc52f | 2023-09-22 17:44:23 -0700 | [diff] [blame] | 318 | val LONG_PRESS_NAV_HANDLE_SLOP_PERCENTAGE = |
Anushree Ganjam | cb571da | 2023-10-24 14:47:09 -0700 | [diff] [blame] | 319 | nonRestorableItem( |
| 320 | "pref_long_press_nav_handle_slop_percentage", |
| 321 | LPNH_SLOP_PERCENTAGE.get(), |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 322 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
Anushree Ganjam | cb571da | 2023-10-24 14:47:09 -0700 | [diff] [blame] | 323 | ) |
Andy Wickham | 9fbc52f | 2023-09-22 17:44:23 -0700 | [diff] [blame] | 324 | @JvmField |
| 325 | val LONG_PRESS_NAV_HANDLE_TIMEOUT_MS = |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 326 | nonRestorableItem( |
| 327 | "pref_long_press_nav_handle_timeout_ms", |
Anushree Ganjam | cb571da | 2023-10-24 14:47:09 -0700 | [diff] [blame] | 328 | LPNH_TIMEOUT_MS.get(), |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 329 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 330 | ) |
| 331 | @JvmField |
| 332 | val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_START_SCALE_PERCENT = |
| 333 | nonRestorableItem( |
| 334 | "pref_long_press_nav_handle_haptic_hint_start_scale_percent", |
Andreas Agvard | b36bcff | 2023-11-10 15:16:55 +0100 | [diff] [blame] | 335 | LPNH_HAPTIC_HINT_START_SCALE_PERCENT.get(), |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 336 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 337 | ) |
| 338 | @JvmField |
| 339 | val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_END_SCALE_PERCENT = |
| 340 | nonRestorableItem( |
| 341 | "pref_long_press_nav_handle_haptic_hint_end_scale_percent", |
Andreas Agvard | b36bcff | 2023-11-10 15:16:55 +0100 | [diff] [blame] | 342 | LPNH_HAPTIC_HINT_END_SCALE_PERCENT.get(), |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 343 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 344 | ) |
| 345 | @JvmField |
| 346 | val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_SCALE_EXPONENT = |
| 347 | nonRestorableItem( |
| 348 | "pref_long_press_nav_handle_haptic_hint_scale_exponent", |
Andreas Agvard | b36bcff | 2023-11-10 15:16:55 +0100 | [diff] [blame] | 349 | LPNH_HAPTIC_HINT_SCALE_EXPONENT.get(), |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 350 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 351 | ) |
| 352 | @JvmField |
| 353 | val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_ITERATIONS = |
| 354 | nonRestorableItem( |
| 355 | "pref_long_press_nav_handle_haptic_hint_iterations", |
Andreas Agvard | b36bcff | 2023-11-10 15:16:55 +0100 | [diff] [blame] | 356 | LPNH_HAPTIC_HINT_ITERATIONS.get(), |
Andreas Agvard | d167498 | 2023-10-16 15:49:56 +0200 | [diff] [blame] | 357 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 358 | ) |
Andy Wickham | 9fbc52f | 2023-09-22 17:44:23 -0700 | [diff] [blame] | 359 | @JvmField |
Andreas Agvard | fc74c09 | 2023-11-16 15:06:46 +0100 | [diff] [blame^] | 360 | val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_DELAY = |
| 361 | nonRestorableItem( |
| 362 | "pref_long_press_nav_handle_haptic_hint_delay", |
| 363 | LPNH_HAPTIC_HINT_DELAY.get(), |
| 364 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 365 | ) |
| 366 | @JvmField |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 367 | val THEMED_ICONS = |
| 368 | backedUpItem(Themes.KEY_THEMED_ICONS, false, EncryptionType.MOVE_TO_DEVICE_PROTECTED) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 369 | @JvmField val PROMISE_ICON_IDS = backedUpItem(InstallSessionHelper.PROMISE_ICON_IDS, "") |
Sunny Goyal | 576f7a5 | 2023-10-06 11:28:25 -0700 | [diff] [blame] | 370 | @JvmField val WORK_EDU_STEP = backedUpItem("showed_work_profile_edu", 0) |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 371 | @JvmField |
| 372 | val WORKSPACE_SIZE = |
| 373 | backedUpItem( |
| 374 | DeviceGridState.KEY_WORKSPACE_SIZE, |
| 375 | "", |
| 376 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 377 | ) |
| 378 | @JvmField |
| 379 | val HOTSEAT_COUNT = |
| 380 | backedUpItem( |
| 381 | DeviceGridState.KEY_HOTSEAT_COUNT, |
| 382 | -1, |
| 383 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 384 | ) |
| 385 | @JvmField |
| 386 | val TASKBAR_PINNING = |
| 387 | backedUpItem(TASKBAR_PINNING_KEY, false, EncryptionType.DEVICE_PROTECTED) |
Jagrut Desai | c6d625b | 2023-04-03 16:57:32 -0700 | [diff] [blame] | 388 | |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 389 | @JvmField |
| 390 | val DEVICE_TYPE = |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 391 | backedUpItem( |
| 392 | DeviceGridState.KEY_DEVICE_TYPE, |
| 393 | InvariantDeviceProfile.TYPE_PHONE, |
| 394 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
| 395 | ) |
| 396 | @JvmField |
| 397 | val DB_FILE = |
| 398 | backedUpItem(DeviceGridState.KEY_DB_FILE, "", EncryptionType.MOVE_TO_DEVICE_PROTECTED) |
fbaron | e58aaf1 | 2023-09-25 11:34:56 -0700 | [diff] [blame] | 399 | @JvmField |
| 400 | val SHOULD_SHOW_SMARTSPACE = |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 401 | backedUpItem( |
| 402 | SHOULD_SHOW_SMARTSPACE_KEY, |
| 403 | WIDGET_ON_FIRST_SCREEN, |
| 404 | EncryptionType.DEVICE_PROTECTED |
| 405 | ) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 406 | @JvmField |
| 407 | val RESTORE_DEVICE = |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 408 | backedUpItem( |
| 409 | RestoreDbTask.RESTORED_DEVICE_TYPE, |
| 410 | InvariantDeviceProfile.TYPE_PHONE, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 411 | EncryptionType.MOVE_TO_DEVICE_PROTECTED |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 412 | ) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 413 | @JvmField val APP_WIDGET_IDS = backedUpItem(RestoreDbTask.APPWIDGET_IDS, "") |
| 414 | @JvmField val OLD_APP_WIDGET_IDS = backedUpItem(RestoreDbTask.APPWIDGET_OLD_IDS, "") |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 415 | @JvmField |
| 416 | val GRID_NAME = |
| 417 | ConstantItem( |
| 418 | "idp_grid_name", |
| 419 | isBackedUp = true, |
| 420 | defaultValue = null, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 421 | encryptionType = EncryptionType.MOVE_TO_DEVICE_PROTECTED, |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 422 | type = String::class.java |
| 423 | ) |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 424 | @JvmField |
| 425 | val ALLOW_ROTATION = |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 426 | backedUpItem(RotationHelper.ALLOW_ROTATION_PREFERENCE_KEY, Boolean::class.java) { |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 427 | RotationHelper.getAllowRotationDefaultValue(DisplayController.INSTANCE.get(it).info) |
| 428 | } |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 429 | @JvmField |
| 430 | val IS_STARTUP_DATA_MIGRATED = |
| 431 | ConstantItem( |
| 432 | "is_startup_data_boot_aware", |
| 433 | isBackedUp = false, |
| 434 | defaultValue = false, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 435 | encryptionType = EncryptionType.DEVICE_PROTECTED |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 436 | ) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 437 | |
Sunny Goyal | 576f7a5 | 2023-10-06 11:28:25 -0700 | [diff] [blame] | 438 | // Preferences for widget configurations |
| 439 | @JvmField |
| 440 | val RECONFIGURABLE_WIDGET_EDUCATION_TIP_SEEN = |
| 441 | backedUpItem("launcher.reconfigurable_widget_education_tip_seen", false) |
| 442 | @JvmField |
| 443 | val WIDGETS_EDUCATION_DIALOG_SEEN = |
| 444 | backedUpItem("launcher.widgets_education_dialog_seen", false) |
| 445 | @JvmField |
| 446 | val WIDGETS_EDUCATION_TIP_SEEN = backedUpItem("launcher.widgets_education_tip_seen", false) |
| 447 | |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 448 | @JvmStatic |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 449 | fun <T> backedUpItem( |
| 450 | sharedPrefKey: String, |
| 451 | defaultValue: T, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 452 | encryptionType: EncryptionType = EncryptionType.ENCRYPTED |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 453 | ): ConstantItem<T> = |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 454 | ConstantItem(sharedPrefKey, isBackedUp = true, defaultValue, encryptionType) |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 455 | |
| 456 | @JvmStatic |
| 457 | fun <T> backedUpItem( |
| 458 | sharedPrefKey: String, |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 459 | type: Class<out T>, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 460 | encryptionType: EncryptionType = EncryptionType.ENCRYPTED, |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 461 | defaultValueFromContext: (c: Context) -> T |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 462 | ): ContextualItem<T> = |
| 463 | ContextualItem( |
| 464 | sharedPrefKey, |
| 465 | isBackedUp = true, |
| 466 | defaultValueFromContext, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 467 | encryptionType, |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 468 | type |
| 469 | ) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 470 | |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 471 | @JvmStatic |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 472 | fun <T> nonRestorableItem( |
| 473 | sharedPrefKey: String, |
| 474 | defaultValue: T, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 475 | encryptionType: EncryptionType = EncryptionType.ENCRYPTED |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 476 | ): ConstantItem<T> = |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 477 | ConstantItem(sharedPrefKey, isBackedUp = false, defaultValue, encryptionType) |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 478 | |
| 479 | @Deprecated("Don't use shared preferences directly. Use other LauncherPref methods.") |
| 480 | @JvmStatic |
| 481 | fun getPrefs(context: Context): SharedPreferences { |
| 482 | // Use application context for shared preferences, so we use single cached instance |
| 483 | return context.applicationContext.getSharedPreferences( |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 484 | SHARED_PREFERENCES_KEY, |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 485 | MODE_PRIVATE |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 486 | ) |
| 487 | } |
| 488 | |
| 489 | @Deprecated("Don't use shared preferences directly. Use other LauncherPref methods.") |
| 490 | @JvmStatic |
| 491 | fun getDevicePrefs(context: Context): SharedPreferences { |
| 492 | // Use application context for shared preferences, so we use a single cached instance |
| 493 | return context.applicationContext.getSharedPreferences( |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 494 | DEVICE_PREFERENCES_KEY, |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 495 | MODE_PRIVATE |
Stefan Andonian | d1b33b3 | 2022-12-16 21:22:27 +0000 | [diff] [blame] | 496 | ) |
| 497 | } |
| 498 | } |
| 499 | } |
| 500 | |
Stefan Andonian | dbc8ec5 | 2023-09-21 19:05:07 +0000 | [diff] [blame] | 501 | // It is a var because the unit tests are setting this to true so they can run. |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 502 | var moveStartupDataToDeviceProtectedStorageIsEnabled: Boolean = |
| 503 | com.android.launcher3.config.FeatureFlags.MOVE_STARTUP_DATA_TO_DEVICE_PROTECTED_STORAGE.get() |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 504 | |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 505 | private val ITEMS_TO_MOVE_TO_DEVICE_PROTECTED_STORAGE: MutableSet<ConstantItem<*>> = mutableSetOf() |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 506 | |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 507 | abstract class Item { |
| 508 | abstract val sharedPrefKey: String |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 509 | abstract val isBackedUp: Boolean |
| 510 | abstract val type: Class<*> |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 511 | abstract val encryptionType: EncryptionType |
Stefan Andonian | 246eeaa | 2023-02-21 22:14:47 +0000 | [diff] [blame] | 512 | val sharedPrefFile: String |
| 513 | get() = if (isBackedUp) SHARED_PREFERENCES_KEY else DEVICE_PREFERENCES_KEY |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 514 | |
| 515 | fun <T> to(value: T): Pair<Item, T> = Pair(this, value) |
| 516 | } |
| 517 | |
| 518 | data class ConstantItem<T>( |
| 519 | override val sharedPrefKey: String, |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 520 | override val isBackedUp: Boolean, |
| 521 | val defaultValue: T, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 522 | override val encryptionType: EncryptionType, |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 523 | // The default value can be null. If so, the type needs to be explicitly stated, or else NPE |
| 524 | override val type: Class<out T> = defaultValue!!::class.java |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 525 | ) : Item() { |
| 526 | init { |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 527 | if ( |
| 528 | encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED && |
| 529 | moveStartupDataToDeviceProtectedStorageIsEnabled |
| 530 | ) { |
| 531 | ITEMS_TO_MOVE_TO_DEVICE_PROTECTED_STORAGE.add(this) |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 532 | } |
| 533 | } |
Sunny Goyal | cd44740 | 2023-10-06 13:47:50 -0700 | [diff] [blame] | 534 | |
| 535 | fun get(c: Context): T = LauncherPrefs.get(c).get(this) |
Stefan Andonian | 5bd9a22 | 2023-02-23 00:58:33 +0000 | [diff] [blame] | 536 | } |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 537 | |
| 538 | data class ContextualItem<T>( |
| 539 | override val sharedPrefKey: String, |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 540 | override val isBackedUp: Boolean, |
| 541 | private val defaultSupplier: (c: Context) -> T, |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 542 | override val encryptionType: EncryptionType, |
Stefan Andonian | 4c9612b | 2023-02-22 00:00:03 +0000 | [diff] [blame] | 543 | override val type: Class<out T> |
Stefan Andonian | 1d7f703 | 2023-01-23 21:55:04 +0000 | [diff] [blame] | 544 | ) : Item() { |
| 545 | private var default: T? = null |
| 546 | |
| 547 | fun defaultValueFromContext(context: Context): T { |
| 548 | if (default == null) { |
| 549 | default = defaultSupplier(context) |
| 550 | } |
| 551 | return default!! |
| 552 | } |
Sunny Goyal | cd44740 | 2023-10-06 13:47:50 -0700 | [diff] [blame] | 553 | |
| 554 | fun get(c: Context): T = LauncherPrefs.get(c).get(this) |
Thales Lima | 03ac377 | 2023-01-06 15:16:41 +0000 | [diff] [blame] | 555 | } |
Stefan Andonian | 54495f3 | 2023-09-29 23:41:26 +0000 | [diff] [blame] | 556 | |
| 557 | enum class EncryptionType { |
| 558 | ENCRYPTED, |
| 559 | DEVICE_PROTECTED, |
| 560 | MOVE_TO_DEVICE_PROTECTED |
| 561 | } |