Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 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 android.util; |
| 18 | |
Fan Zhang | 93d87e6 | 2017-11-13 17:38:53 -0800 | [diff] [blame] | 19 | import android.content.Context; |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 20 | import android.os.SystemProperties; |
Fan Zhang | aa1387c | 2017-11-17 11:07:29 -0800 | [diff] [blame] | 21 | import android.provider.Settings; |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 22 | import android.text.TextUtils; |
| 23 | |
Fan Zhang | 3080636 | 2017-12-07 11:15:26 -0800 | [diff] [blame] | 24 | import java.util.HashMap; |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 25 | import java.util.Map; |
| 26 | |
| 27 | /** |
| 28 | * Util class to get feature flag information. |
| 29 | * |
| 30 | * @hide |
| 31 | */ |
| 32 | public class FeatureFlagUtils { |
| 33 | |
| 34 | public static final String FFLAG_PREFIX = "sys.fflag."; |
| 35 | public static final String FFLAG_OVERRIDE_PREFIX = FFLAG_PREFIX + "override."; |
| 36 | |
Fan Zhang | 3080636 | 2017-12-07 11:15:26 -0800 | [diff] [blame] | 37 | private static final Map<String, String> DEFAULT_FLAGS; |
| 38 | static { |
| 39 | DEFAULT_FLAGS = new HashMap<>(); |
jackqdyulei | ee0e2e9 | 2017-12-08 09:45:23 -0800 | [diff] [blame] | 40 | DEFAULT_FLAGS.put("settings_battery_display_app_list", "false"); |
Joachim Sauer | ee90161 | 2018-01-22 15:52:26 +0000 | [diff] [blame] | 41 | DEFAULT_FLAGS.put("settings_zone_picker_v2", "true"); |
Doris Ling | 8fdafa0 | 2018-02-08 21:25:46 +0000 | [diff] [blame] | 42 | DEFAULT_FLAGS.put("settings_about_phone_v2", "true"); |
Daniel Nishi | 79764127 | 2018-01-02 16:48:33 -0800 | [diff] [blame] | 43 | DEFAULT_FLAGS.put("settings_bluetooth_while_driving", "false"); |
Jan Nordqvist | 5c4a42d | 2018-03-21 15:09:04 -0700 | [diff] [blame] | 44 | DEFAULT_FLAGS.put("settings_data_usage_v2", "true"); |
ryanywlin | 651d033 | 2018-03-27 14:49:11 +0800 | [diff] [blame^] | 45 | DEFAULT_FLAGS.put("settings_audio_switcher", "true"); |
Fan Zhang | 3080636 | 2017-12-07 11:15:26 -0800 | [diff] [blame] | 46 | } |
| 47 | |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 48 | /** |
| 49 | * Whether or not a flag is enabled. |
| 50 | * |
| 51 | * @param feature the flag name |
| 52 | * @return true if the flag is enabled (either by default in system, or override by user) |
| 53 | */ |
Fan Zhang | 93d87e6 | 2017-11-13 17:38:53 -0800 | [diff] [blame] | 54 | public static boolean isEnabled(Context context, String feature) { |
Fan Zhang | aa1387c | 2017-11-17 11:07:29 -0800 | [diff] [blame] | 55 | // Override precedence: |
Fan Zhang | 3080636 | 2017-12-07 11:15:26 -0800 | [diff] [blame] | 56 | // Settings.Global -> sys.fflag.override.* -> static list |
Fan Zhang | aa1387c | 2017-11-17 11:07:29 -0800 | [diff] [blame] | 57 | |
| 58 | // Step 1: check if feature flag is set in Settings.Global. |
| 59 | String value; |
| 60 | if (context != null) { |
| 61 | value = Settings.Global.getString(context.getContentResolver(), feature); |
| 62 | if (!TextUtils.isEmpty(value)) { |
| 63 | return Boolean.parseBoolean(value); |
| 64 | } |
| 65 | } |
| 66 | |
| 67 | // Step 2: check if feature flag has any override. Flag name: sys.fflag.override.<feature> |
| 68 | value = SystemProperties.get(FFLAG_OVERRIDE_PREFIX + feature); |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 69 | if (!TextUtils.isEmpty(value)) { |
| 70 | return Boolean.parseBoolean(value); |
| 71 | } |
Fan Zhang | 3080636 | 2017-12-07 11:15:26 -0800 | [diff] [blame] | 72 | // Step 3: check if feature flag has any default value. |
| 73 | value = getAllFeatureFlags().get(feature); |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 74 | return Boolean.parseBoolean(value); |
| 75 | } |
| 76 | |
| 77 | /** |
Fan Zhang | cfd0274 | 2017-10-03 14:37:44 -0700 | [diff] [blame] | 78 | * Override feature flag to new state. |
| 79 | */ |
Fan Zhang | aa1387c | 2017-11-17 11:07:29 -0800 | [diff] [blame] | 80 | public static void setEnabled(Context context, String feature, boolean enabled) { |
Fan Zhang | cfd0274 | 2017-10-03 14:37:44 -0700 | [diff] [blame] | 81 | SystemProperties.set(FFLAG_OVERRIDE_PREFIX + feature, enabled ? "true" : "false"); |
| 82 | } |
| 83 | |
| 84 | /** |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 85 | * Returns all feature flags in their raw form. |
| 86 | */ |
| 87 | public static Map<String, String> getAllFeatureFlags() { |
Fan Zhang | 3080636 | 2017-12-07 11:15:26 -0800 | [diff] [blame] | 88 | return DEFAULT_FLAGS; |
Fan Zhang | 690986d | 2017-08-17 11:22:31 -0700 | [diff] [blame] | 89 | } |
| 90 | } |