Implement auto 12/24h setting toggle.

This implements an explicit toggle to enable/disable automatic 12h/24h
time formatting detection based on the current locale.

Previously automatic detection was the norm on a freshly wiped device,
but could never be re-enabled once either 12h or 24h format was
configured.

Bug: 32761619
Test: m RunSettingsRoboTests
Change-Id: Idbbb8f79fccec95e33bf2f12767d5736e1118fa7

res/values/strings.xml

@@ -710,6 +710,10 @@
     <!-- Date & time setting screen setting option summary text when Automatic time zone check box is clear
         [CHAR LIMIT=100] -->
     <string name="zone_auto_summaryOff">Use network-provided time zone</string>
+    <!-- Date & time setting screen setting check box title if the 24 hour setting should be determined automatically [CHAR LIMIT=30] -->
+    <string name="date_time_24hour_auto">Automatic 24\u2011hour format</string>
+    <!-- Date & time setting screen setting option summary text for the automatic 24 hour setting checkbox [CHAR LIMIT=100] -->
+    <string name="date_time_24hour_auto_summary">Use locale default</string>
     <!-- Date & time setting screen setting check box title [CHAR LIMIT=30] -->
     <string name="date_time_24hour_title">24\u2011hour format</string>
     <!-- Date & time setting screen setting check box title -->

res/xml/date_time_prefs.xml

@@ -20,38 +20,53 @@
     android:title="@string/date_and_time"
     settings:keywords="@string/keywords_date_and_time">
 
-    <com.android.settingslib.RestrictedSwitchPreference
+    <PreferenceCategory
-        android:key="auto_time"
+        android:key="date_time_preference_category">
-        android:title="@string/date_time_auto"
+        <com.android.settingslib.RestrictedSwitchPreference
-        android:summaryOn="@string/date_time_auto_summaryOn"
+            android:key="auto_time"
-        android:summaryOff="@string/date_time_auto_summaryOff"
+            android:title="@string/date_time_auto"
-        settings:useAdditionalSummary="true"
+            android:summaryOn="@string/date_time_auto_summaryOn"
-        settings:restrictedSwitchSummary="@string/enabled_by_admin" />
+            android:summaryOff="@string/date_time_auto_summaryOff"
+            settings:useAdditionalSummary="true"
+            settings:restrictedSwitchSummary="@string/enabled_by_admin" />
 
-    <SwitchPreference
+        <Preference
-        android:key="auto_zone"
+            android:key="date"
-        android:title="@string/zone_auto"
+            android:title="@string/date_time_set_date"
-        android:summaryOn="@string/zone_auto_summaryOn"
+            android:summary="@string/summary_placeholder" />
-        android:summaryOff="@string/zone_auto_summaryOff" />
 
-    <Preference
+        <Preference
-        android:key="date"
+            android:key="time"
-        android:title="@string/date_time_set_date"
+            android:title="@string/date_time_set_time"
-        android:summary="@string/summary_placeholder" />
+            android:summary="@string/summary_placeholder" />
+    </PreferenceCategory>
 
-    <Preference
+    <PreferenceCategory
-        android:key="time"
+        android:key="time_zone_preference_category">
-        android:title="@string/date_time_set_time"
+        <SwitchPreference
-        android:summary="@string/summary_placeholder" />
+            android:key="auto_zone"
+            android:title="@string/zone_auto"
+            android:summaryOn="@string/zone_auto_summaryOn"
+            android:summaryOff="@string/zone_auto_summaryOff" />
 
-    <Preference
+        <Preference
-        android:fragment="com.android.settings.datetime.ZonePicker"
+            android:fragment="com.android.settings.datetime.ZonePicker"
-        android:key="timezone"
+            android:key="timezone"
-        android:title="@string/date_time_set_timezone"
+            android:title="@string/date_time_set_timezone"
-        android:summary="GMT-8:00" />
+            android:summary="GMT-8:00" />
+    </PreferenceCategory>
 
-    <SwitchPreference
+    <PreferenceCategory
-        android:key="24 hour"
+        android:key="time_format_preference_category">
-        android:title="@string/date_time_24hour" />
+        <SwitchPreference
+            android:key="auto_24hour"
+            android:title="@string/date_time_24hour_auto"
+            android:summaryOn="@string/date_time_24hour_auto_summary"
+            android:summaryOff="@string/date_time_24hour_auto_summary" />
+
+        <SwitchPreference
+            android:key="24 hour"
+            android:title="@string/date_time_24hour" />
+    </PreferenceCategory>
 
 </PreferenceScreen>

src/com/android/settings/DateTimeSettings.java

@@ -26,6 +26,7 @@ import android.provider.SearchIndexableResource;
 import com.android.internal.logging.nano.MetricsProto.MetricsEvent;
 import com.android.settings.dashboard.DashboardFragment;
 import com.android.settings.dashboard.SummaryLoader;
+import com.android.settings.datetime.AutoTimeFormatPreferenceController;
 import com.android.settings.datetime.AutoTimePreferenceController;
 import com.android.settings.datetime.AutoTimeZonePreferenceController;
 import com.android.settings.datetime.DatePreferenceController;
@@ -84,8 +85,12 @@ public class DateTimeSettings extends DashboardFragment implements
         final AutoTimePreferenceController autoTimePreferenceController =
                 new AutoTimePreferenceController(
                         activity, this /* UpdateTimeAndDateCallback */);
+        final AutoTimeFormatPreferenceController autoTimeFormatPreferenceController =
+                new AutoTimeFormatPreferenceController(
+                        activity, this /* UpdateTimeAndDateCallback */);
         controllers.add(autoTimeZonePreferenceController);
         controllers.add(autoTimePreferenceController);
+        controllers.add(autoTimeFormatPreferenceController);
 
         controllers.add(new TimeFormatPreferenceController(
                 activity, this /* UpdateTimeAndDateCallback */, isFromSUW));

src/com/android/settings/datetime/AutoTimeFormatPreferenceController.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2017 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 android.content.Context;
+import android.provider.Settings;
+import android.provider.Settings.System;
+import android.support.v14.preference.SwitchPreference;
+import android.support.v7.preference.Preference;
+import android.support.v7.preference.TwoStatePreference;
+import android.text.TextUtils;
+import android.text.format.DateFormat;
+import com.android.settings.core.PreferenceControllerMixin;
+import com.android.settingslib.core.AbstractPreferenceController;
+import java.util.Locale;
+
+public class AutoTimeFormatPreferenceController extends AbstractPreferenceController
+          implements PreferenceControllerMixin {
+
+    private static final String KEY_AUTO_24_HOUR = "auto_24hour";
+
+    public AutoTimeFormatPreferenceController(Context context, UpdateTimeAndDateCallback callback) {
+        super(context);
+    }
+
+    @Override
+    public boolean isAvailable() {
+        return true;
+    }
+
+    @Override
+    public String getPreferenceKey() {
+        return KEY_AUTO_24_HOUR;
+    }
+
+    @Override
+    public void updateState(Preference preference) {
+        if (!(preference instanceof SwitchPreference)) {
+            return;
+        }
+        ((SwitchPreference) preference).setChecked(isAutoTimeFormatSelection(mContext));
+    }
+
+    @Override
+    public boolean handlePreferenceTreeClick(Preference preference) {
+        if (!(preference instanceof TwoStatePreference)
+            || !TextUtils.equals(KEY_AUTO_24_HOUR, preference.getKey())) {
+            return false;
+        }
+        boolean auto24HourEnabled = ((SwitchPreference) preference).isChecked();
+        Boolean is24Hour;
+        if (auto24HourEnabled) {
+            is24Hour = null;
+        } else {
+            is24Hour = is24HourLocale(mContext.getResources().getConfiguration().locale);
+        }
+        TimeFormatPreferenceController.update24HourFormat(mContext, is24Hour);
+        return true;
+    }
+
+    boolean is24HourLocale(Locale locale) {
+        return DateFormat.is24HourLocale(locale);
+    }
+
+    /**
+     * Returns if the system is currently configured to pick the time format automatically based on
+     * the locale.
+     */
+    static boolean isAutoTimeFormatSelection(Context context) {
+        return Settings.System.getString(context.getContentResolver(), System.TIME_12_24) == null;
+    }
+}

src/com/android/settings/datetime/TimeFormatPreferenceController.java

@@ -63,6 +63,8 @@ public class TimeFormatPreferenceController extends AbstractPreferenceController
         if (!(preference instanceof TwoStatePreference)) {
             return;
         }
+        preference.setEnabled(
+            !AutoTimeFormatPreferenceController.isAutoTimeFormatSelection(mContext));
         ((TwoStatePreference) preference).setChecked(is24Hour());
         final Calendar now = Calendar.getInstance();
         mDummyDate.setTimeZone(now.getTimeZone());
@@ -80,8 +82,7 @@ public class TimeFormatPreferenceController extends AbstractPreferenceController
             return false;
         }
         final boolean is24Hour = ((SwitchPreference) preference).isChecked();
-        set24Hour(is24Hour);
+        update24HourFormat(mContext, is24Hour);
-        timeUpdated(is24Hour);
         mUpdateTimeAndDateCallback.updateTimeAndDateDisplay(mContext);
         return true;
     }
@@ -95,18 +96,28 @@ public class TimeFormatPreferenceController extends AbstractPreferenceController
         return DateFormat.is24HourFormat(mContext);
     }
 
-    private void timeUpdated(boolean is24Hour) {
+    static void update24HourFormat(Context context, Boolean is24Hour) {
-        Intent timeChanged = new Intent(Intent.ACTION_TIME_CHANGED);
+        set24Hour(context, is24Hour);
-        int timeFormatPreference =
+        timeUpdated(context, is24Hour);
-                is24Hour ? Intent.EXTRA_TIME_PREF_VALUE_USE_24_HOUR
-                        : Intent.EXTRA_TIME_PREF_VALUE_USE_12_HOUR;
-        timeChanged.putExtra(Intent.EXTRA_TIME_PREF_24_HOUR_FORMAT, timeFormatPreference);
-        mContext.sendBroadcast(timeChanged);
     }
 
-    private void set24Hour(boolean is24Hour) {
+    static void timeUpdated(Context context, Boolean is24Hour) {
-        Settings.System.putString(mContext.getContentResolver(),
+        Intent timeChanged = new Intent(Intent.ACTION_TIME_CHANGED);
-                Settings.System.TIME_12_24,
+        int timeFormatPreference;
-                is24Hour ? HOURS_24 : HOURS_12);
+        if (is24Hour == null) {
+            timeFormatPreference = Intent.EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT;
+        } else {
+            timeFormatPreference = is24Hour ? Intent.EXTRA_TIME_PREF_VALUE_USE_24_HOUR
+                : Intent.EXTRA_TIME_PREF_VALUE_USE_12_HOUR;
+        }
+        timeChanged.putExtra(Intent.EXTRA_TIME_PREF_24_HOUR_FORMAT, timeFormatPreference);
+        context.sendBroadcast(timeChanged);
+    }
+
+    static void set24Hour(Context context, Boolean is24Hour) {
+        String value = is24Hour == null ? null :
+            is24Hour ? HOURS_24 : HOURS_12;
+        Settings.System.putString(context.getContentResolver(),
+                Settings.System.TIME_12_24, value);
     }
 }

tests/robotests/src/com/android/settings/datetime/AutoTimeFormatPreferenceControllerTest.java

@@ -0,0 +1,186 @@
+/*
+ * Copyright (C) 2017 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 com.google.common.truth.Truth.assertThat;
+import static org.mockito.Answers.RETURNS_DEEP_STUBS;
+
+import android.content.Context;
+import android.content.Intent;
+import android.provider.Settings;
+import android.support.v14.preference.SwitchPreference;
+import android.support.v7.preference.PreferenceScreen;
+import android.text.format.DateFormat;
+import com.android.settings.TestConfig;
+import com.android.settings.testutils.SettingsRobolectricTestRunner;
+import java.util.List;
+import java.util.Locale;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.robolectric.annotation.Config;
+import org.robolectric.annotation.Implementation;
+import org.robolectric.annotation.Implements;
+import org.robolectric.annotation.Resetter;
+import org.robolectric.shadows.ShadowApplication;
+
+@RunWith(SettingsRobolectricTestRunner.class)
+@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
+public class AutoTimeFormatPreferenceControllerTest {
+
+    @Mock(answer = RETURNS_DEEP_STUBS)
+    private PreferenceScreen mScreen;
+    @Mock
+    private UpdateTimeAndDateCallback mCallback;
+
+    private ShadowApplication mApplication;
+    private Context mContext;
+    private SwitchPreference mPreference;
+    private TestAutoTimeFormatPreferenceController mController;
+
+    @Before
+    public void setUp() {
+        MockitoAnnotations.initMocks(this);
+        mApplication = ShadowApplication.getInstance();
+        mContext = mApplication.getApplicationContext();
+    }
+
+    @Test
+    public void updateState_24HourSet_shouldCheckPreference() {
+        mController = new TestAutoTimeFormatPreferenceController(mContext, mCallback);
+        mPreference = new SwitchPreference(mContext);
+        mPreference.setKey(mController.getPreferenceKey());
+        Settings.System.putString(mContext.getContentResolver(), Settings.System.TIME_12_24,
+                TimeFormatPreferenceController.HOURS_24);
+
+        mController.updateState(mPreference);
+
+        assertThat(mPreference.isChecked()).isFalse();
+    }
+
+    @Test
+    public void updateState_12HourSet_shouldCheckPreference() {
+        mController = new TestAutoTimeFormatPreferenceController(mContext, mCallback);
+        mPreference = new SwitchPreference(mContext);
+        mPreference.setKey(mController.getPreferenceKey());
+        Settings.System.putString(mContext.getContentResolver(), Settings.System.TIME_12_24,
+                TimeFormatPreferenceController.HOURS_12);
+
+        mController.updateState(mPreference);
+
+        assertThat(mPreference.isChecked()).isFalse();
+    }
+
+    @Test
+    public void updateState_autoSet_shouldNotCheckPreference() {
+        mController = new TestAutoTimeFormatPreferenceController(mContext, mCallback);
+        mPreference = new SwitchPreference(mContext);
+        mPreference.setKey(mController.getPreferenceKey());
+        Settings.System.putString(mContext.getContentResolver(), Settings.System.TIME_12_24, null);
+
+        mController.updateState(mPreference);
+
+        assertThat(mPreference.isChecked()).isTrue();
+    }
+
+    @Test
+    public void updatePreference_autoSet_shouldSendIntent_12HourLocale() {
+        mController = new TestAutoTimeFormatPreferenceController(mContext, mCallback);
+        mPreference = new SwitchPreference(mContext);
+        mPreference.setKey(mController.getPreferenceKey());
+        mPreference.setChecked(false);
+
+        boolean result = mController.handlePreferenceTreeClick(mPreference);
+
+        assertThat(result).isTrue();
+
+        List<Intent> intentsFired = mApplication.getBroadcastIntents();
+        assertThat(intentsFired.size()).isEqualTo(1);
+        Intent intentFired = intentsFired.get(0);
+        assertThat(intentFired.getAction()).isEqualTo(Intent.ACTION_TIME_CHANGED);
+        assertThat(intentFired.getIntExtra(Intent.EXTRA_TIME_PREF_24_HOUR_FORMAT, -1))
+                .isEqualTo(Intent.EXTRA_TIME_PREF_VALUE_USE_12_HOUR);
+    }
+
+    @Test
+    public void updatePreference_autoSet_shouldSendIntent_24HourLocale() {
+        mController = new TestAutoTimeFormatPreferenceController(mContext, mCallback);
+        mPreference = new SwitchPreference(mContext);
+        mPreference.setKey(mController.getPreferenceKey());
+        mPreference.setChecked(false);
+
+        mController.setIs24HourLocale(true);
+        boolean result = mController.handlePreferenceTreeClick(mPreference);
+
+        assertThat(result).isTrue();
+
+        List<Intent> intentsFired = mApplication.getBroadcastIntents();
+        assertThat(intentsFired.size()).isEqualTo(1);
+        Intent intentFired = intentsFired.get(0);
+        assertThat(intentFired.getAction()).isEqualTo(Intent.ACTION_TIME_CHANGED);
+        assertThat(intentFired.getIntExtra(Intent.EXTRA_TIME_PREF_24_HOUR_FORMAT, -1))
+                .isEqualTo(Intent.EXTRA_TIME_PREF_VALUE_USE_24_HOUR);
+    }
+
+    @Test
+    public void updatePreference_24HourSet_shouldSendIntent() {
+        mController = new TestAutoTimeFormatPreferenceController(mContext, mCallback);
+        mPreference = new SwitchPreference(mContext);
+        mPreference.setKey(mController.getPreferenceKey());
+        mPreference.setChecked(true);
+
+        mController.setIs24HourLocale(false);
+        boolean result = mController.handlePreferenceTreeClick(mPreference);
+
+        assertThat(result).isTrue();
+
+        List<Intent> intentsFired = mApplication.getBroadcastIntents();
+        assertThat(intentsFired.size()).isEqualTo(1);
+        Intent intentFired = intentsFired.get(0);
+        assertThat(intentFired.getAction()).isEqualTo(Intent.ACTION_TIME_CHANGED);
+        assertThat(intentFired.getIntExtra(Intent.EXTRA_TIME_PREF_24_HOUR_FORMAT, -1))
+                .isEqualTo(Intent.EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT);
+    }
+
+    /**
+     * Extend class under test to change {@link #is24HourLocale()} to not call
+     * {@link DateFormat#is24HourLocale(Locale)} because that's not available in roboelectric.
+     */
+    private static class TestAutoTimeFormatPreferenceController
+            extends AutoTimeFormatPreferenceController {
+
+        private boolean is24HourLocale = false;
+
+        public TestAutoTimeFormatPreferenceController(Context context,
+              UpdateTimeAndDateCallback callback) {
+            super(context, callback);
+        }
+
+        void setIs24HourLocale(boolean value) {
+            is24HourLocale = value;
+        }
+
+        @Override
+        boolean is24HourLocale(Locale locale) {
+            return is24HourLocale;
+        }
+    }
+}

tests/robotests/src/com/android/settings/datetime/TimeFormatPreferenceControllerTest.java

@@ -39,6 +39,7 @@ import org.robolectric.shadows.ShadowApplication;
 import static com.google.common.truth.Truth.assertThat;
 import static org.mockito.Answers.RETURNS_DEEP_STUBS;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 @RunWith(SettingsRobolectricTestRunner.class)
 @Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
@@ -101,6 +102,18 @@ public class TimeFormatPreferenceControllerTest {
         assertThat(mPreference.isChecked()).isFalse();
     }
 
+    @Test
+    public void updateState_autoSet_shouldNotEnablePreference() {
+        mController = new TimeFormatPreferenceController(mContext, mCallback, false);
+        Settings.System.putString(mContext.getContentResolver(), Settings.System.TIME_12_24, null);
+        mPreference = new SwitchPreference(mContext);
+        mPreference.setKey(mController.getPreferenceKey());
+
+        mController.updateState(mPreference);
+
+        assertThat(mPreference.isEnabled()).isFalse();
+    }
+
     @Test
     public void updatePreference_12HourSet_shouldSendIntent() {
         mController = new TimeFormatPreferenceController(mContext, mCallback, false);