Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2020 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 | */ |
| 16 | |
| 17 | package com.android.server.wifi; |
| 18 | |
| 19 | import android.annotation.NonNull; |
| 20 | import android.annotation.Nullable; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 21 | import android.content.Context; |
Chris Ye | 04abeb2 | 2021-12-07 19:50:22 -0800 | [diff] [blame] | 22 | import android.net.wifi.WifiManager; |
Roshan Pius | 3225f11 | 2020-02-24 09:12:04 -0800 | [diff] [blame] | 23 | import android.net.wifi.WifiMigration; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 24 | import android.os.Handler; |
| 25 | import android.text.TextUtils; |
| 26 | import android.util.Log; |
| 27 | |
| 28 | import com.android.internal.annotations.GuardedBy; |
Roshan Pius | b0ed8e2 | 2020-03-19 09:08:16 -0700 | [diff] [blame] | 29 | import com.android.server.wifi.util.SettingsMigrationDataHolder; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 30 | import com.android.server.wifi.util.WifiConfigStoreEncryptionUtil; |
| 31 | import com.android.server.wifi.util.XmlUtil; |
| 32 | |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 33 | import org.xmlpull.v1.XmlPullParser; |
| 34 | import org.xmlpull.v1.XmlPullParserException; |
| 35 | import org.xmlpull.v1.XmlSerializer; |
| 36 | |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 37 | import java.io.FileDescriptor; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 38 | import java.io.IOException; |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 39 | import java.io.PrintWriter; |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 40 | import java.util.ArrayList; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 41 | import java.util.HashMap; |
| 42 | import java.util.Map; |
| 43 | |
| 44 | /** |
| 45 | * Store data for storing wifi settings. These are key (string) / value pairs that are stored in |
| 46 | * WifiConfigStore.xml file in a separate section. |
| 47 | */ |
| 48 | public class WifiSettingsConfigStore { |
| 49 | private static final String TAG = "WifiSettingsConfigStore"; |
| 50 | |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 51 | // List of all allowed keys. |
| 52 | private static final ArrayList<Key> sKeys = new ArrayList<>(); |
| 53 | |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 54 | /******** Wifi shared pref keys ***************/ |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 55 | /** |
| 56 | * Indicate whether factory reset request is pending. |
| 57 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 58 | public static final Key<Boolean> WIFI_P2P_PENDING_FACTORY_RESET = |
| 59 | new Key<>("wifi_p2p_pending_factory_reset", false); |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 60 | |
| 61 | /** |
| 62 | * Allow scans to be enabled even wifi is turned off. |
| 63 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 64 | public static final Key<Boolean> WIFI_SCAN_ALWAYS_AVAILABLE = |
| 65 | new Key<>("wifi_scan_always_enabled", false); |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 66 | |
| 67 | /** |
| 68 | * Whether wifi scan throttle is enabled or not. |
| 69 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 70 | public static final Key<Boolean> WIFI_SCAN_THROTTLE_ENABLED = |
| 71 | new Key<>("wifi_scan_throttle_enabled", true); |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 72 | |
| 73 | /** |
Nate(Qiang) Jiang | 6844aa4 | 2023-06-28 21:52:11 +0000 | [diff] [blame] | 74 | * Setting to enable verbose logging in Wi-Fi. |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 75 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 76 | public static final Key<Boolean> WIFI_VERBOSE_LOGGING_ENABLED = |
| 77 | new Key<>("wifi_verbose_logging_enabled", false); |
| 78 | |
| 79 | /** |
Nate(Qiang) Jiang | 6844aa4 | 2023-06-28 21:52:11 +0000 | [diff] [blame] | 80 | * Setting to enable verbose logging in Wi-Fi Aware. |
| 81 | */ |
| 82 | public static final Key<Boolean> WIFI_AWARE_VERBOSE_LOGGING_ENABLED = |
| 83 | new Key<>("wifi_aware_verbose_logging_enabled", false); |
| 84 | |
| 85 | /** |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 86 | * The Wi-Fi peer-to-peer device name |
| 87 | */ |
| 88 | public static final Key<String> WIFI_P2P_DEVICE_NAME = |
| 89 | new Key<>("wifi_p2p_device_name", null); |
| 90 | |
Mingguang Xu | 066d444 | 2021-01-28 14:07:17 -0800 | [diff] [blame] | 91 | /** |
Shuibing Dai | 6e0bfac | 2023-04-05 10:33:46 -0700 | [diff] [blame] | 92 | * The Wi-Fi peer-to-peer device mac address |
| 93 | */ |
| 94 | public static final Key<String> WIFI_P2P_DEVICE_ADDRESS = |
| 95 | new Key<>("wifi_p2p_device_address", null); |
| 96 | |
| 97 | /** |
Mingguang Xu | 066d444 | 2021-01-28 14:07:17 -0800 | [diff] [blame] | 98 | * Whether Wifi scoring is enabled or not. |
| 99 | */ |
| 100 | public static final Key<Boolean> WIFI_SCORING_ENABLED = |
| 101 | new Key<>("wifi_scoring_enabled", true); |
| 102 | |
Roshan Pius | 1ec7610 | 2021-02-11 12:06:57 -0800 | [diff] [blame] | 103 | /** |
Chris Ye | 4ef08dd | 2021-06-14 23:21:45 -0700 | [diff] [blame] | 104 | * Whether Wifi Passpoint is enabled or not. |
| 105 | */ |
| 106 | public static final Key<Boolean> WIFI_PASSPOINT_ENABLED = |
| 107 | new Key<>("wifi_passpoint_enabled", true); |
| 108 | |
| 109 | /** |
Chris Ye | 04abeb2 | 2021-12-07 19:50:22 -0800 | [diff] [blame] | 110 | * Whether Wifi Multi Internet is enabled for multi ap, dbs or disabled. |
| 111 | */ |
| 112 | public static final Key<Integer> WIFI_MULTI_INTERNET_MODE = |
| 113 | new Key<Integer>("wifi_multi_internet_mode", |
| 114 | WifiManager.WIFI_MULTI_INTERNET_MODE_DISABLED); |
| 115 | |
| 116 | /** |
Roshan Pius | 1ec7610 | 2021-02-11 12:06:57 -0800 | [diff] [blame] | 117 | * Store the STA factory MAC address retrieved from the driver on the first bootup. |
| 118 | */ |
| 119 | public static final Key<String> WIFI_STA_FACTORY_MAC_ADDRESS = |
| 120 | new Key<>("wifi_sta_factory_mac_address", null); |
| 121 | |
Sunil Ravi | 15740d6 | 2021-04-11 19:21:06 -0700 | [diff] [blame] | 122 | /** |
zhujiatai | f2b6886 | 2022-11-24 16:21:35 +0800 | [diff] [blame] | 123 | * Store the Secondary STA factory MAC address retrieved from the driver on the first bootup. |
| 124 | */ |
| 125 | public static final Key<String> SECONDARY_WIFI_STA_FACTORY_MAC_ADDRESS = |
| 126 | new Key<>("secondary_wifi_sta_factory_mac_address", null); |
| 127 | |
| 128 | |
| 129 | /** |
Sunil Ravi | 15740d6 | 2021-04-11 19:21:06 -0700 | [diff] [blame] | 130 | * Store the default country code updated via {@link WifiManager#setDefaultCountryCode(String)} |
| 131 | */ |
| 132 | public static final Key<String> WIFI_DEFAULT_COUNTRY_CODE = |
| 133 | new Key<>("wifi_default_country_code", WifiCountryCode.getOemDefaultCountryCode()); |
| 134 | |
Sunil Ravi | 816ae07 | 2022-02-07 12:29:25 -0800 | [diff] [blame] | 135 | /** |
| 136 | * Store the supported features retrieved from WiFi HAL and Supplicant HAL |
| 137 | */ |
| 138 | public static final Key<Long> WIFI_NATIVE_SUPPORTED_FEATURES = |
| 139 | new Key<>("wifi_native_supported_features", 0L); |
| 140 | |
Quang Luong | 32e6836 | 2022-03-14 11:57:26 -0700 | [diff] [blame] | 141 | /** |
Chris Ye | da276ae | 2022-10-12 16:16:28 -0700 | [diff] [blame] | 142 | * Store the supported features retrieved from WiFi HAL and Supplicant HAL |
| 143 | */ |
| 144 | public static final Key<Integer> WIFI_NATIVE_SUPPORTED_STA_BANDS = |
| 145 | new Key<>("wifi_native_supported_sta_bands", 0); |
| 146 | |
| 147 | /** |
Quang Luong | 32e6836 | 2022-03-14 11:57:26 -0700 | [diff] [blame] | 148 | * Store the static chip info retrieved from WiFi HAL |
| 149 | */ |
| 150 | public static final Key<String> WIFI_STATIC_CHIP_INFO = new Key<>("wifi_static_chip_info", ""); |
| 151 | |
Gabriel Biren | 4483065 | 2022-07-13 22:30:52 +0000 | [diff] [blame] | 152 | /** |
Quang Luong | 27d7d57 | 2023-04-07 00:08:00 +0000 | [diff] [blame] | 153 | * Store the last country code used by Soft AP. |
| 154 | */ |
| 155 | public static final Key<String> WIFI_SOFT_AP_COUNTRY_CODE = |
| 156 | new Key<>("wifi_last_country_code", ""); |
| 157 | |
| 158 | /** |
| 159 | * Store the available channel frequencies in a JSON array for Soft AP for the last country |
| 160 | * code used. |
| 161 | */ |
| 162 | public static final Key<String> WIFI_AVAILABLE_SOFT_AP_FREQS_MHZ = |
| 163 | new Key<>("wifi_available_soft_ap_freqs_mhz", "[]"); |
| 164 | |
| 165 | /** |
Gabriel Biren | 4483065 | 2022-07-13 22:30:52 +0000 | [diff] [blame] | 166 | * Whether to show a dialog when third party apps attempt to enable wifi. |
| 167 | */ |
| 168 | public static final Key<Boolean> SHOW_DIALOG_WHEN_THIRD_PARTY_APPS_ENABLE_WIFI = |
| 169 | new Key<>("show_dialog_when_third_party_apps_enable_wifi", false); |
| 170 | |
| 171 | /** |
| 172 | * Whether the |
| 173 | * {@link WifiManager#setThirdPartyAppEnablingWifiConfirmationDialogEnabled(boolean)} API was |
| 174 | * called to set the value of {@link #SHOW_DIALOG_WHEN_THIRD_PARTY_APPS_ENABLE_WIFI}. |
| 175 | */ |
| 176 | public static final Key<Boolean> SHOW_DIALOG_WHEN_THIRD_PARTY_APPS_ENABLE_WIFI_SET_BY_API = |
| 177 | new Key<>("show_dialog_when_third_party_apps_enable_wifi_set_by_api", false); |
| 178 | |
Gabriel Biren | 022fbf1 | 2023-02-27 21:57:57 +0000 | [diff] [blame] | 179 | /** |
| 180 | * AIDL version implemented by the Supplicant service. |
| 181 | */ |
| 182 | public static final Key<Integer> SUPPLICANT_HAL_AIDL_SERVICE_VERSION = |
| 183 | new Key<>("supplicant_hal_aidl_service_version", -1); |
| 184 | |
Khanjan Desai | 6ba8934 | 2023-10-19 16:11:14 +0530 | [diff] [blame] | 185 | /** |
| 186 | * Store wiphy capability for 11be support. |
| 187 | */ |
| 188 | public static final Key<Boolean> WIFI_WIPHY_11BE_SUPPORTED = |
| 189 | new Key<>("wifi_wiphy_11be_supported", true); |
| 190 | |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 191 | /******** Wifi shared pref keys ***************/ |
| 192 | |
| 193 | private final Context mContext; |
| 194 | private final Handler mHandler; |
Roshan Pius | b0ed8e2 | 2020-03-19 09:08:16 -0700 | [diff] [blame] | 195 | private final SettingsMigrationDataHolder mSettingsMigrationDataHolder; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 196 | private final WifiConfigManager mWifiConfigManager; |
| 197 | |
| 198 | private final Object mLock = new Object(); |
| 199 | @GuardedBy("mLock") |
| 200 | private final Map<String, Object> mSettings = new HashMap<>(); |
| 201 | @GuardedBy("mLock") |
| 202 | private final Map<String, Map<OnSettingsChangedListener, Handler>> mListeners = |
| 203 | new HashMap<>(); |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 204 | private WifiMigration.SettingsMigrationData mCachedMigrationData = null; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 205 | |
| 206 | private boolean mHasNewDataToSerialize = false; |
| 207 | |
| 208 | /** |
| 209 | * Interface for a settings change listener. |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 210 | * @param <T> Type of the value. |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 211 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 212 | public interface OnSettingsChangedListener<T> { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 213 | /** |
| 214 | * Invoked when a particular key settings changes. |
| 215 | * |
| 216 | * @param key Key that was changed. |
| 217 | * @param newValue New value that was assigned to the key. |
| 218 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 219 | void onSettingsChanged(@NonNull Key<T> key, @Nullable T newValue); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | public WifiSettingsConfigStore(@NonNull Context context, @NonNull Handler handler, |
Roshan Pius | b0ed8e2 | 2020-03-19 09:08:16 -0700 | [diff] [blame] | 223 | @NonNull SettingsMigrationDataHolder settingsMigrationDataHolder, |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 224 | @NonNull WifiConfigManager wifiConfigManager, |
| 225 | @NonNull WifiConfigStore wifiConfigStore) { |
| 226 | mContext = context; |
| 227 | mHandler = handler; |
Roshan Pius | b0ed8e2 | 2020-03-19 09:08:16 -0700 | [diff] [blame] | 228 | mSettingsMigrationDataHolder = settingsMigrationDataHolder; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 229 | mWifiConfigManager = wifiConfigManager; |
| 230 | |
| 231 | // Register our data store. |
| 232 | wifiConfigStore.registerStoreData(new StoreData()); |
| 233 | } |
| 234 | |
| 235 | private void invokeAllListeners() { |
| 236 | synchronized (mLock) { |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 237 | for (Key key : sKeys) { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 238 | invokeListeners(key); |
| 239 | } |
| 240 | } |
| 241 | } |
| 242 | |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 243 | private <T> void invokeListeners(@NonNull Key<T> key) { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 244 | synchronized (mLock) { |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 245 | if (!mSettings.containsKey(key.key)) return; |
| 246 | Object newValue = mSettings.get(key.key); |
| 247 | Map<OnSettingsChangedListener, Handler> listeners = mListeners.get(key.key); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 248 | if (listeners == null || listeners.isEmpty()) return; |
| 249 | for (Map.Entry<OnSettingsChangedListener, Handler> listener |
| 250 | : listeners.entrySet()) { |
| 251 | // Trigger the callback in the appropriate handler. |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 252 | listener.getValue().post(() -> |
| 253 | listener.getKey().onSettingsChanged(key, newValue)); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 254 | } |
| 255 | } |
| 256 | } |
| 257 | |
| 258 | /** |
| 259 | * Trigger config store writes and invoke listeners in the main wifi service looper's handler. |
| 260 | */ |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 261 | private void triggerSaveToStoreAndInvokeAllListeners() { |
| 262 | mHandler.post(() -> { |
| 263 | mHasNewDataToSerialize = true; |
| 264 | mWifiConfigManager.saveToStore(true); |
| 265 | |
| 266 | invokeAllListeners(); |
| 267 | }); |
| 268 | } |
| 269 | |
| 270 | /** |
| 271 | * Trigger config store writes and invoke listeners in the main wifi service looper's handler. |
| 272 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 273 | private <T> void triggerSaveToStoreAndInvokeListeners(@NonNull Key<T> key) { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 274 | mHandler.post(() -> { |
| 275 | mHasNewDataToSerialize = true; |
| 276 | mWifiConfigManager.saveToStore(true); |
| 277 | |
| 278 | invokeListeners(key); |
| 279 | }); |
| 280 | } |
| 281 | |
| 282 | /** |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 283 | * Performs a one time migration from Settings.Global values to settings store. Only |
| 284 | * performed one time if the settings store is empty. |
| 285 | */ |
| 286 | private void migrateFromSettingsIfNeeded() { |
| 287 | if (!mSettings.isEmpty()) return; // already migrated. |
| 288 | |
Roshan Pius | b0ed8e2 | 2020-03-19 09:08:16 -0700 | [diff] [blame] | 289 | mCachedMigrationData = mSettingsMigrationDataHolder.retrieveData(); |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 290 | if (mCachedMigrationData == null) { |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 291 | Log.e(TAG, "No settings data to migrate"); |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 292 | return; |
| 293 | } |
| 294 | Log.i(TAG, "Migrating data out of settings to shared preferences"); |
| 295 | |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 296 | mSettings.put(WIFI_P2P_DEVICE_NAME.key, |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 297 | mCachedMigrationData.getP2pDeviceName()); |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 298 | mSettings.put(WIFI_P2P_PENDING_FACTORY_RESET.key, |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 299 | mCachedMigrationData.isP2pFactoryResetPending()); |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 300 | mSettings.put(WIFI_SCAN_ALWAYS_AVAILABLE.key, |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 301 | mCachedMigrationData.isScanAlwaysAvailable()); |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 302 | mSettings.put(WIFI_SCAN_THROTTLE_ENABLED.key, |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 303 | mCachedMigrationData.isScanThrottleEnabled()); |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 304 | mSettings.put(WIFI_VERBOSE_LOGGING_ENABLED.key, |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 305 | mCachedMigrationData.isVerboseLoggingEnabled()); |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 306 | triggerSaveToStoreAndInvokeAllListeners(); |
| 307 | } |
| 308 | |
| 309 | /** |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 310 | * Store a value to the stored settings. |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 311 | * |
| 312 | * @param key One of the settings keys. |
| 313 | * @param value Value to be stored. |
| 314 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 315 | public <T> void put(@NonNull Key<T> key, @Nullable T value) { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 316 | synchronized (mLock) { |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 317 | mSettings.put(key.key, value); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 318 | } |
| 319 | triggerSaveToStoreAndInvokeListeners(key); |
| 320 | } |
| 321 | |
| 322 | /** |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 323 | * Retrieve a value from the stored settings. |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 324 | * |
| 325 | * @param key One of the settings keys. |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 326 | * @return value stored in settings, defValue if the key does not exist. |
| 327 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 328 | public @Nullable <T> T get(@NonNull Key<T> key) { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 329 | synchronized (mLock) { |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 330 | return (T) mSettings.getOrDefault(key.key, key.defaultValue); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 331 | } |
| 332 | } |
| 333 | |
| 334 | /** |
| 335 | * Register for settings change listener. |
| 336 | * |
| 337 | * @param key One of the settings keys. |
| 338 | * @param listener Listener to be registered. |
| 339 | * @param handler Handler to post the listener |
| 340 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 341 | public <T> void registerChangeListener(@NonNull Key<T> key, |
| 342 | @NonNull OnSettingsChangedListener<T> listener, @NonNull Handler handler) { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 343 | synchronized (mLock) { |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 344 | mListeners.computeIfAbsent( |
| 345 | key.key, ignore -> new HashMap<>()).put(listener, handler); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 346 | } |
| 347 | } |
| 348 | |
| 349 | /** |
| 350 | * Unregister for settings change listener. |
| 351 | * |
| 352 | * @param key One of the settings keys. |
| 353 | * @param listener Listener to be unregistered. |
| 354 | */ |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 355 | public <T> void unregisterChangeListener(@NonNull Key<T> key, |
| 356 | @NonNull OnSettingsChangedListener<T> listener) { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 357 | synchronized (mLock) { |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 358 | Map<OnSettingsChangedListener, Handler> listeners = mListeners.get(key.key); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 359 | if (listeners == null || listeners.isEmpty()) { |
| 360 | Log.e(TAG, "No listeners for " + key); |
| 361 | return; |
| 362 | } |
| 363 | if (listeners.remove(listener) == null) { |
| 364 | Log.e(TAG, "Unknown listener for " + key); |
| 365 | } |
| 366 | } |
| 367 | } |
| 368 | |
| 369 | /** |
Roshan Pius | da0d199 | 2020-03-04 08:34:42 -0800 | [diff] [blame] | 370 | * Dump output for debugging. |
| 371 | */ |
| 372 | public void dump(FileDescriptor fd, PrintWriter pw, String[] args) { |
| 373 | pw.println(); |
| 374 | pw.println("Dump of " + TAG); |
| 375 | pw.println("Settings:"); |
| 376 | for (Map.Entry<String, Object> entry : mSettings.entrySet()) { |
| 377 | pw.print(entry.getKey()); |
| 378 | pw.print("="); |
| 379 | pw.println(entry.getValue()); |
| 380 | } |
| 381 | if (mCachedMigrationData == null) return; |
| 382 | pw.println("Migration data:"); |
| 383 | pw.print(WIFI_P2P_DEVICE_NAME.key); |
| 384 | pw.print("="); |
| 385 | pw.println(mCachedMigrationData.getP2pDeviceName()); |
| 386 | pw.print(WIFI_P2P_PENDING_FACTORY_RESET.key); |
| 387 | pw.print("="); |
| 388 | pw.println(mCachedMigrationData.isP2pFactoryResetPending()); |
| 389 | pw.print(WIFI_SCAN_ALWAYS_AVAILABLE.key); |
| 390 | pw.print("="); |
| 391 | pw.println(mCachedMigrationData.isScanAlwaysAvailable()); |
| 392 | pw.print(WIFI_SCAN_THROTTLE_ENABLED.key); |
| 393 | pw.print("="); |
| 394 | pw.println(mCachedMigrationData.isScanThrottleEnabled()); |
| 395 | pw.print(WIFI_VERBOSE_LOGGING_ENABLED.key); |
| 396 | pw.print("="); |
| 397 | pw.println(mCachedMigrationData.isVerboseLoggingEnabled()); |
| 398 | pw.println(); |
| 399 | } |
| 400 | |
| 401 | /** |
Roshan Pius | 67ee429 | 2020-02-25 09:51:02 -0800 | [diff] [blame] | 402 | * Base class to store string key and its default value. |
| 403 | * @param <T> Type of the value. |
| 404 | */ |
| 405 | public static class Key<T> { |
| 406 | public final String key; |
| 407 | public final T defaultValue; |
| 408 | |
| 409 | private Key(@NonNull String key, T defaultValue) { |
| 410 | this.key = key; |
| 411 | this.defaultValue = defaultValue; |
| 412 | sKeys.add(this); |
| 413 | } |
| 414 | |
| 415 | @Override |
| 416 | public String toString() { |
| 417 | return "[Key " + key + ", DefaultValue: " + defaultValue + "]"; |
| 418 | } |
| 419 | } |
| 420 | |
| 421 | /** |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 422 | * Store data for persisting the settings data to config store. |
| 423 | */ |
| 424 | private class StoreData implements WifiConfigStore.StoreData { |
| 425 | private static final String XML_TAG_SECTION_HEADER = "Settings"; |
| 426 | private static final String XML_TAG_VALUES = "Values"; |
| 427 | |
| 428 | @Override |
| 429 | public void serializeData(XmlSerializer out, |
| 430 | @Nullable WifiConfigStoreEncryptionUtil encryptionUtil) |
| 431 | throws XmlPullParserException, IOException { |
| 432 | synchronized (mLock) { |
| 433 | XmlUtil.writeNextValue(out, XML_TAG_VALUES, mSettings); |
| 434 | } |
| 435 | } |
| 436 | |
| 437 | @Override |
| 438 | public void deserializeData(XmlPullParser in, int outerTagDepth, |
| 439 | @WifiConfigStore.Version int version, |
Roshan Pius | fdf57e6 | 2020-03-16 13:33:16 -0700 | [diff] [blame] | 440 | @Nullable WifiConfigStoreEncryptionUtil encryptionUtil) |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 441 | throws XmlPullParserException, IOException { |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 442 | if (in == null) { |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 443 | // Empty read triggers the migration since it indicates that there is no settings |
| 444 | // data stored in the settings store. |
| 445 | migrateFromSettingsIfNeeded(); |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 446 | return; |
| 447 | } |
| 448 | Map<String, Object> values = null; |
| 449 | while (!XmlUtil.isNextSectionEnd(in, outerTagDepth)) { |
| 450 | String[] valueName = new String[1]; |
| 451 | Object value = XmlUtil.readCurrentValue(in, valueName); |
| 452 | if (TextUtils.isEmpty(valueName[0])) { |
| 453 | throw new XmlPullParserException("Missing value name"); |
| 454 | } |
| 455 | switch (valueName[0]) { |
| 456 | case XML_TAG_VALUES: |
| 457 | values = (Map) value; |
| 458 | break; |
| 459 | default: |
| 460 | Log.w(TAG, "Ignoring unknown tag under " + XML_TAG_SECTION_HEADER + ": " |
| 461 | + valueName[0]); |
| 462 | break; |
| 463 | } |
| 464 | } |
| 465 | if (values != null) { |
| 466 | synchronized (mLock) { |
| 467 | mSettings.putAll(values); |
| 468 | // Invoke all the registered listeners. |
| 469 | invokeAllListeners(); |
| 470 | } |
| 471 | } |
| 472 | } |
| 473 | |
| 474 | @Override |
| 475 | public void resetData() { |
| 476 | synchronized (mLock) { |
| 477 | mSettings.clear(); |
| 478 | } |
| 479 | } |
| 480 | |
| 481 | @Override |
| 482 | public boolean hasNewDataToSerialize() { |
| 483 | return mHasNewDataToSerialize; |
| 484 | } |
| 485 | |
| 486 | @Override |
| 487 | public String getName() { |
| 488 | return XML_TAG_SECTION_HEADER; |
| 489 | } |
| 490 | |
| 491 | @Override |
| 492 | public @WifiConfigStore.StoreFileId int getStoreFileId() { |
| 493 | // Shared general store. |
Roshan Pius | 0412d2d | 2020-02-10 13:26:42 -0800 | [diff] [blame] | 494 | return WifiConfigStore.STORE_FILE_SHARED_GENERAL; |
Roshan Pius | b790f67 | 2020-02-14 07:06:13 -0800 | [diff] [blame] | 495 | } |
| 496 | } |
| 497 | } |