Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 91f89d0a authored by Al Sutton's avatar Al Sutton
Browse files

Move the validators out of the settings class 

Currently the validators static initialiser gets triggered when the
relevant settings class is accessed. Moving them out to the
SettingsBackupAgent (which is the only place they're used) has two
main advantages;

1) All apps accessing the Settings classes no longer trigger the
static initialisers and so are faster.

2) Putting them in SettingsBackupAgent gets them off the
bootclasspath of all apps and makes the framework jars smaller.

Bug: 139449903
Test: atest SettingsProviderTest RunBackupFrameworksServicesRoboTests CtsBackupTestCases CtsBackupHostTestCases GtsBackupTestCases GtsBackupHostTestCases
Change-Id: Ie740c1ea25a01c715964175094677af2e3328732
parent a5369e31

core/java/android/provider/Settings.java

+0 −1138

File changed.

Preview size limit exceeded, changes collapsed.

packages/SettingsProvider/Android.bp

+3 −0
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ android_test { 
    // because this test is not an instrumentation test. (because the target runs in the system process.)

    srcs: [

        "test/**/*.java",

        "src/android/provider/settings/validators/*",

        "src/com/android/providers/settings/SettingsBackupAgent.java",

        "src/com/android/providers/settings/SettingsState.java",

        "src/com/android/providers/settings/SettingsHelper.java",
@@ -31,6 +32,8 @@ android_test { 
    static_libs: [

        "androidx.test.rules",

        "SettingsLibDisplayDensityUtils",

        "platform-test-annotations",

        "truth-prebuilt",

    ],

    libs: [

        "android.test.base",

core/java/android/provider/settings/validators/ComponentNameListValidator.java→packages/SettingsProvider/src/android/provider/settings/validators/ComponentNameListValidator.java

+0 −0

File moved.

View file

core/java/android/provider/settings/validators/DiscreteValueValidator.java→packages/SettingsProvider/src/android/provider/settings/validators/DiscreteValueValidator.java

+0 −0

File moved.

View file

packages/SettingsProvider/src/android/provider/settings/validators/GlobalSettingsValidators.java

0 → 100644
+152 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2019 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.provider.settings.validators;



import static android.provider.settings.validators.SettingsValidators.ANY_INTEGER_VALIDATOR;

import static android.provider.settings.validators.SettingsValidators.ANY_STRING_VALIDATOR;

import static android.provider.settings.validators.SettingsValidators.BOOLEAN_VALIDATOR;

import static android.provider.settings.validators.SettingsValidators.PACKAGE_NAME_VALIDATOR;

import static android.provider.settings.validators.SettingsValidators.PERCENTAGE_INTEGER_VALIDATOR;



import android.media.AudioFormat;

import android.os.BatteryManager;

import android.provider.Settings.Global;

import android.text.TextUtils;

import android.util.ArrayMap;



import java.util.Map;



/**

 * Validators for Global settings

 */

public class GlobalSettingsValidators {

    /**

     * All settings in {@link Global.SETTINGS_TO_BACKUP} array *must* have a non-null validator,

     * otherwise they won't be restored.

     */

    public static final Map<String, Validator> VALIDATORS = new ArrayMap<>();



    static {

        VALIDATORS.put(Global.APPLY_RAMPING_RINGER, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.BUGREPORT_IN_POWER_MENU, BOOLEAN_VALIDATOR);

        VALIDATORS.put(

                Global.STAY_ON_WHILE_PLUGGED_IN,

                value -> {

                    try {

                        int val = Integer.parseInt(value);

                        return (val == 0)

                                || (val == BatteryManager.BATTERY_PLUGGED_AC)

                                || (val == BatteryManager.BATTERY_PLUGGED_USB)

                                || (val == BatteryManager.BATTERY_PLUGGED_WIRELESS)

                                || (val

                                        == (BatteryManager.BATTERY_PLUGGED_AC

                                                | BatteryManager.BATTERY_PLUGGED_USB))

                                || (val

                                        == (BatteryManager.BATTERY_PLUGGED_AC

                                                | BatteryManager.BATTERY_PLUGGED_WIRELESS))

                                || (val

                                        == (BatteryManager.BATTERY_PLUGGED_USB

                                                | BatteryManager.BATTERY_PLUGGED_WIRELESS))

                                || (val

                                        == (BatteryManager.BATTERY_PLUGGED_AC

                                                | BatteryManager.BATTERY_PLUGGED_USB

                                                | BatteryManager.BATTERY_PLUGGED_WIRELESS));

                    } catch (NumberFormatException e) {

                        return false;

                    }

                });

        VALIDATORS.put(Global.AUTO_TIME, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.AUTO_TIME_ZONE, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.POWER_SOUNDS_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.DOCK_SOUNDS_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.CHARGING_SOUNDS_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.USB_MASS_STORAGE_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(

                Global.NETWORK_RECOMMENDATIONS_ENABLED,

                new DiscreteValueValidator(new String[] {"-1", "0", "1"}));

        VALIDATORS.put(Global.WIFI_WAKEUP_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON, BOOLEAN_VALIDATOR);

        VALIDATORS.put(

                Global.USE_OPEN_WIFI_PACKAGE,

                value -> (value == null) || PACKAGE_NAME_VALIDATOR.validate(value));

        VALIDATORS.put(Global.WIFI_WATCHDOG_POOR_NETWORK_TEST_ENABLED, ANY_STRING_VALIDATOR);

        VALIDATORS.put(

                Global.EMERGENCY_TONE, new DiscreteValueValidator(new String[] {"0", "1", "2"}));

        VALIDATORS.put(Global.CALL_AUTO_RETRY, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.DOCK_AUDIO_MEDIA_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(

                Global.ENABLE_AUTOMATIC_SYSTEM_SERVER_HEAP_DUMPS,

                new DiscreteValueValidator(new String[] {"0", "1"}));

        VALIDATORS.put(

                Global.ENCODED_SURROUND_OUTPUT,

                new DiscreteValueValidator(new String[] {"0", "1", "2", "3"}));

        VALIDATORS.put(

                Global.ENCODED_SURROUND_OUTPUT_ENABLED_FORMATS,

                value -> {

                    try {

                        String[] surroundFormats = TextUtils.split(value, ",");

                        for (String format : surroundFormats) {

                            int audioFormat = Integer.valueOf(format);

                            boolean isSurroundFormat = false;

                            for (int sf : AudioFormat.SURROUND_SOUND_ENCODING) {

                                if (sf == audioFormat) {

                                    isSurroundFormat = true;

                                    break;

                                }

                            }

                            if (!isSurroundFormat) {

                                return false;

                            }

                        }

                        return true;

                    } catch (NumberFormatException e) {

                        return false;

                    }

                });

        VALIDATORS.put(

                Global.LOW_POWER_MODE_STICKY_AUTO_DISABLE_LEVEL,

                new InclusiveIntegerRangeValidator(0, 100));

        VALIDATORS.put(

                Global.LOW_POWER_MODE_STICKY_AUTO_DISABLE_ENABLED,

                new DiscreteValueValidator(new String[] {"0", "1"}));

        VALIDATORS.put(Global.LOW_POWER_MODE_TRIGGER_LEVEL, PERCENTAGE_INTEGER_VALIDATOR);

        VALIDATORS.put(Global.LOW_POWER_MODE_TRIGGER_LEVEL_MAX, PERCENTAGE_INTEGER_VALIDATOR);

        VALIDATORS.put(

                Global.AUTOMATIC_POWER_SAVE_MODE,

                new DiscreteValueValidator(new String[] {"0", "1"}));

        VALIDATORS.put(

                Global.DYNAMIC_POWER_SAVINGS_DISABLE_THRESHOLD, PERCENTAGE_INTEGER_VALIDATOR);

        VALIDATORS.put(Global.BLUETOOTH_ON, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.PRIVATE_DNS_MODE, ANY_STRING_VALIDATOR);

        VALIDATORS.put(Global.PRIVATE_DNS_SPECIFIER, ANY_STRING_VALIDATOR);

        VALIDATORS.put(Global.SOFT_AP_TIMEOUT_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.WIFI_SCAN_THROTTLE_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.APP_AUTO_RESTRICTION_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.ZEN_DURATION, ANY_INTEGER_VALIDATOR);

        VALIDATORS.put(Global.CHARGING_VIBRATION_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.DEVICE_PROVISIONING_MOBILE_DATA_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.REQUIRE_PASSWORD_TO_DECRYPT, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.DEVICE_DEMO_MODE, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.WIFI_PNO_FREQUENCY_CULLING_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.WIFI_PNO_RECENCY_SORTING_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.WIFI_LINK_PROBING_ENABLED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.AWARE_ALLOWED, BOOLEAN_VALIDATOR);

        VALIDATORS.put(Global.POWER_BUTTON_LONG_PRESS, new InclusiveIntegerRangeValidator(0, 5));

        VALIDATORS.put(

                Global.POWER_BUTTON_VERY_LONG_PRESS, new InclusiveIntegerRangeValidator(0, 1));

    }

}