Fix the logic used that determines whether the automatic time zone detection toggle is available in the Settings UI Date & Time screen. Also, ensure that the TimeZonePreferenceController uses correct logic for whether the user can manually enter a time zone. This change migrates the controllers to use a existing high-level TimeManager API rather than (incorrectly) duplicating in Settings UI the logic for whether time zone detection is supported / enabled. Without this change, WiFi-only devices _with_ location-based time zone detection enabled would incorrectly hide the "auto time zone" toggle, which would have the knock-on of making it look like the user is allowed to enter a time zone manually when they aren't (because it is enabled/disabled based on the presence of the toggle). That toggle still needs to be present while there is a possible time zone detection mechanism. All the (quite complex) logic around this is already considered by the TimeManager API. Possible side effects: This change decouples the "does the toggle show true or false?" (isEnabled()) from the "should the toggle be shown at all?" (isAvailable()) logic by removing a call to isAvailable() inside of isEnabled(). This is to avoid making multiple (probably more expensive than what it was doing before) calls to the time_zone_detector service, and avoid the extra complexity of caching / cache invalidation that would be needed to mitigate it. Previously, as a result of the call to isAvailable(), isEnabled() would always return false when mIsFromSUW is true, but now it will return the underlying value of the device's auto_time_zone setting. This means that if the UI is changed in future to render a visible-but-can't-be-changed-by-the-user toggle for auto time zone, it will display the current setting value, which is perfectly reasonable. It is assumed it will have no other side effects. The AutoTimeZonePreferenceControllerTest.isFromSUW_notEnable test has been changed to reflect the change in behavior. Various name changes made to tests to reflect the new behavior. Bug: 228247623 Bug: 186625820 Bug: 172891783 Test: treehugger Test: Manual test on a device with telephony Test: m ROBOTEST_FILTER=AutoTimeZonePreferenceControllerTest RunSettingsRoboTests -j40 Test: m ROBOTEST_FILTER=TimeZonePreferenceControllerTest RunSettingsRoboTests -j40 Change-Id: I4c7608e8645eee5994c8ecf85a14a27d3278ac04
112 lines
4.0 KiB
Java
112 lines
4.0 KiB
Java
/*
|
|
* Copyright (C) 2016 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 com.android.settings.datetime;
|
|
|
|
import static android.app.time.Capabilities.CAPABILITY_NOT_ALLOWED;
|
|
import static android.app.time.Capabilities.CAPABILITY_NOT_APPLICABLE;
|
|
import static android.app.time.Capabilities.CAPABILITY_NOT_SUPPORTED;
|
|
import static android.app.time.Capabilities.CAPABILITY_POSSESSED;
|
|
|
|
import android.app.time.TimeManager;
|
|
import android.app.time.TimeZoneCapabilities;
|
|
import android.app.time.TimeZoneCapabilitiesAndConfig;
|
|
import android.app.time.TimeZoneConfiguration;
|
|
import android.content.Context;
|
|
|
|
import androidx.annotation.VisibleForTesting;
|
|
import androidx.preference.Preference;
|
|
import androidx.preference.SwitchPreference;
|
|
|
|
import com.android.settings.core.PreferenceControllerMixin;
|
|
import com.android.settingslib.core.AbstractPreferenceController;
|
|
|
|
public class AutoTimeZonePreferenceController extends AbstractPreferenceController
|
|
implements PreferenceControllerMixin, Preference.OnPreferenceChangeListener {
|
|
|
|
private static final String KEY_AUTO_TIME_ZONE = "auto_zone";
|
|
|
|
private final boolean mIsFromSUW;
|
|
private final UpdateTimeAndDateCallback mCallback;
|
|
private final TimeManager mTimeManager;
|
|
|
|
public AutoTimeZonePreferenceController(Context context, UpdateTimeAndDateCallback callback,
|
|
boolean isFromSUW) {
|
|
super(context);
|
|
mTimeManager = context.getSystemService(TimeManager.class);
|
|
mCallback = callback;
|
|
mIsFromSUW = isFromSUW;
|
|
}
|
|
|
|
@Override
|
|
public boolean isAvailable() {
|
|
if (mIsFromSUW) {
|
|
return false;
|
|
}
|
|
|
|
TimeZoneCapabilities timeZoneCapabilities =
|
|
getTimeZoneCapabilitiesAndConfig().getCapabilities();
|
|
int capability = timeZoneCapabilities.getConfigureAutoDetectionEnabledCapability();
|
|
|
|
// The preference only has two states: present and not present. The preference is never
|
|
// present but disabled.
|
|
if (capability == CAPABILITY_NOT_SUPPORTED
|
|
|| capability == CAPABILITY_NOT_ALLOWED
|
|
|| capability == CAPABILITY_NOT_APPLICABLE) {
|
|
return false;
|
|
} else if (capability == CAPABILITY_POSSESSED) {
|
|
return true;
|
|
} else {
|
|
throw new IllegalStateException("Unknown capability=" + capability);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public String getPreferenceKey() {
|
|
return KEY_AUTO_TIME_ZONE;
|
|
}
|
|
|
|
@Override
|
|
public void updateState(Preference preference) {
|
|
if (!(preference instanceof SwitchPreference)) {
|
|
return;
|
|
}
|
|
((SwitchPreference) preference).setChecked(isEnabled());
|
|
}
|
|
|
|
@Override
|
|
public boolean onPreferenceChange(Preference preference, Object newValue) {
|
|
boolean autoZoneEnabled = (Boolean) newValue;
|
|
TimeZoneConfiguration configuration = new TimeZoneConfiguration.Builder()
|
|
.setAutoDetectionEnabled(autoZoneEnabled)
|
|
.build();
|
|
boolean result = mTimeManager.updateTimeZoneConfiguration(configuration);
|
|
|
|
mCallback.updateTimeAndDateDisplay(mContext);
|
|
return result;
|
|
}
|
|
|
|
@VisibleForTesting
|
|
boolean isEnabled() {
|
|
TimeZoneConfiguration config = getTimeZoneCapabilitiesAndConfig().getConfiguration();
|
|
return config.isAutoDetectionEnabled();
|
|
}
|
|
|
|
private TimeZoneCapabilitiesAndConfig getTimeZoneCapabilitiesAndConfig() {
|
|
return mTimeManager.getTimeZoneCapabilitiesAndConfig();
|
|
}
|
|
}
|