Update widgets on lockscreen settings to match POR.
Bug: 423653256
Test: atest WidgetsOnLockscreenPreferenceControllerTest
Flag: com.android.systemui.glanceable_hub_v2
Change-Id: I0460068acf6edea306c94b782b3b3de9343ca4be
diff --git a/res/values/config.xml b/res/values/config.xml
index b6b4e1e..fe854e8 100644
--- a/res/values/config.xml
+++ b/res/values/config.xml
@@ -733,6 +733,12 @@
<!-- Whether posturing detection is supported. -->
<bool name="config_posturing_supported">false</bool>
+ <!-- Whether to show the "glanceable hub" settings. -->
+ <bool name="config_show_glanceable_hub_toggle_setting">false</bool>
+
+ <!-- Whether to show the "glanceable hub" settings on mobile. -->
+ <bool name="config_show_glanceable_hub_toggle_setting_mobile">false</bool>
+
<!-- Whether to show a "restrict to wireless charging" settings option in screensaver and hub
mode settings (false by default). -->
<bool name="config_show_restrict_to_wireless_charging">false</bool>
diff --git a/res/xml/display_settings.xml b/res/xml/display_settings.xml
index f06d454..33f328f 100644
--- a/res/xml/display_settings.xml
+++ b/res/xml/display_settings.xml
@@ -108,12 +108,6 @@
android:persistent="false"
android:title="@string/accessibility_text_reading_options_title"
settings:controller="com.android.settings.accessibility.TextReadingFragmentForDisplaySettingsController"/>
-
- <Preference
- android:key="widgets_on_lockscreen"
- android:title="@string/widgets_on_lockscreen_title"
- android:fragment="com.android.settings.communal.WidgetsOnLockscreenFragment"
- settings:controller="com.android.settings.display.WidgetsOnLockscreenPreferenceController"/>
</PreferenceCategory>
<PreferenceCategory
diff --git a/res/xml/widgets_on_lockscreen_settings.xml b/res/xml/widgets_on_lockscreen_settings.xml
index aeb8613..775fef3 100644
--- a/res/xml/widgets_on_lockscreen_settings.xml
+++ b/res/xml/widgets_on_lockscreen_settings.xml
@@ -20,6 +20,11 @@
android:key="widgets_on_lockscreen"
android:title="@string/widgets_on_lockscreen_title">
+ <com.android.settings.widget.SettingsMainSwitchPreference
+ android:key="widgets_on_lockscreen_main_switch"
+ android:title="@string/widgets_on_lockscreen_title"
+ settings:controller="com.android.settings.display.WidgetsOnLockscreenMainPreferenceController"/>
+
<Preference
android:key="when_to_start_hubmode"
android:title="@string/when_to_auto_show_hubmode_title"
diff --git a/src/com/android/settings/communal/WhenToStartHubPreferenceController.java b/src/com/android/settings/communal/WhenToStartHubPreferenceController.java
index 67931ee..c8aa89e 100644
--- a/src/com/android/settings/communal/WhenToStartHubPreferenceController.java
+++ b/src/com/android/settings/communal/WhenToStartHubPreferenceController.java
@@ -51,7 +51,7 @@
@Override
public int getAvailabilityStatus() {
- return AVAILABLE;
+ return UNSUPPORTED_ON_DEVICE;
}
@Override
diff --git a/src/com/android/settings/display/WidgetsOnLockscreenMainPreferenceController.java b/src/com/android/settings/display/WidgetsOnLockscreenMainPreferenceController.java
new file mode 100644
index 0000000..e6a05e3
--- /dev/null
+++ b/src/com/android/settings/display/WidgetsOnLockscreenMainPreferenceController.java
@@ -0,0 +1,72 @@
+/*
+ * Copyright (C) 2025 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.display;
+
+import android.content.Context;
+import android.widget.CompoundButton;
+import android.widget.CompoundButton.OnCheckedChangeListener;
+
+import androidx.preference.PreferenceScreen;
+
+import com.android.settings.R;
+import com.android.settings.core.TogglePreferenceController;
+import com.android.settings.widget.SettingsMainSwitchPreference;
+
+/** Controls the "widgets on lock screen" main toggle on the "widgets on lock screen" screen. */
+public class WidgetsOnLockscreenMainPreferenceController extends TogglePreferenceController
+ implements OnCheckedChangeListener {
+ public WidgetsOnLockscreenMainPreferenceController(Context context, String preferenceKey) {
+ super(context, preferenceKey);
+ }
+
+ @Override
+ public void displayPreference(PreferenceScreen screen) {
+ super.displayPreference(screen);
+
+ SettingsMainSwitchPreference pref = screen.findPreference(getPreferenceKey());
+ pref.addOnSwitchChangeListener(this);
+ pref.setChecked(WidgetsOnLockscreenPreferenceController.isEnabled(mContext));
+ }
+
+ @Override
+ public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
+ if (isChecked != isChecked()) {
+ setChecked(isChecked);
+ }
+ }
+
+ @Override
+ public boolean isChecked() {
+ return WidgetsOnLockscreenPreferenceController.isEnabled(mContext);
+ }
+
+ @Override
+ public boolean setChecked(boolean isChecked) {
+ WidgetsOnLockscreenPreferenceController.setEnabled(mContext, isChecked);
+ return true;
+ }
+
+ @Override
+ public int getSliceHighlightMenuRes() {
+ return R.string.menu_key_display;
+ }
+
+ @Override
+ public int getAvailabilityStatus() {
+ return AVAILABLE;
+ }
+}
diff --git a/src/com/android/settings/display/WidgetsOnLockscreenPreferenceController.java b/src/com/android/settings/display/WidgetsOnLockscreenPreferenceController.java
index 32ba6ec..3221cc3 100644
--- a/src/com/android/settings/display/WidgetsOnLockscreenPreferenceController.java
+++ b/src/com/android/settings/display/WidgetsOnLockscreenPreferenceController.java
@@ -16,40 +16,119 @@
package com.android.settings.display;
+import static android.provider.Settings.Secure.GLANCEABLE_HUB_ENABLED;
+
+import android.app.admin.DevicePolicyManager;
import android.content.Context;
import android.os.UserHandle;
import android.os.UserManager;
+import android.provider.Settings;
+import android.util.Log;
+
+import androidx.preference.Preference;
import com.android.settings.R;
-import com.android.settings.core.BasePreferenceController;
+import com.android.settings.core.TogglePreferenceController;
+import com.android.settingslib.PrimarySwitchPreference;
+import com.android.settingslib.RestrictedLockUtils;
+import com.android.settingslib.RestrictedLockUtilsInternal;
+import com.android.settingslib.RestrictedSwitchPreference;
+import com.android.systemui.Flags;
-/** Controls the "widgets on lock screen" preferences (under "Display & touch"). */
-public class WidgetsOnLockscreenPreferenceController extends BasePreferenceController {
+/** Controls the "widgets on lock screen" preferences (under "Display & touch > Lock screen"). */
+public class WidgetsOnLockscreenPreferenceController extends TogglePreferenceController {
+ private static final String TAG = "WidgetsOnLockscreen";
+
public WidgetsOnLockscreenPreferenceController(Context context, String preferenceKey) {
super(context, preferenceKey);
}
@Override
- public int getAvailabilityStatus() {
- return isAvailable(mContext) ? AVAILABLE : UNSUPPORTED_ON_DEVICE;
+ public void updateState(Preference preference) {
+ super.updateState(preference);
+ disablePreferenceIfManaged(preference);
}
- /**
- * Returns whether "widgets on lock screen" preferences are available.
- */
- public static boolean isAvailable(Context context) {
- if (!isMainUser(context)) {
- return false;
+ @Override
+ public boolean isChecked() {
+ return isEnabled(mContext);
+ }
+
+ @Override
+ public boolean setChecked(boolean isChecked) {
+ setEnabled(mContext, isChecked);
+ return true;
+ }
+
+ @Override
+ public int getSliceHighlightMenuRes() {
+ return R.string.menu_key_display;
+ }
+
+ @Override
+ public int getAvailabilityStatus() {
+ if (!isMainUser()) {
+ return UNSUPPORTED_ON_DEVICE;
}
- return com.android.systemui.Flags.glanceableHubV2()
- && (context.getResources().getBoolean(R.bool.config_show_communal_settings)
- || context.getResources().getBoolean(
- R.bool.config_show_communal_settings_mobile));
+ // This config should only be true on tablet.
+ if (mContext.getResources().getBoolean(R.bool.config_show_glanceable_hub_toggle_setting)) {
+ return AVAILABLE;
+ }
+
+ if (Flags.glanceableHubV2()
+ && mContext.getResources().getBoolean(
+ R.bool.config_show_glanceable_hub_toggle_setting_mobile)) {
+ return AVAILABLE;
+ }
+
+ return UNSUPPORTED_ON_DEVICE;
}
- private static boolean isMainUser(Context context) {
- final UserManager userManager = context.getSystemService(UserManager.class);
+ static void setEnabled(Context context, boolean isChecked) {
+ Settings.Secure.putInt(
+ context.getContentResolver(), GLANCEABLE_HUB_ENABLED, isChecked ? 1 : 0);
+ }
+
+ static boolean isEnabled(Context context) {
+ return Settings.Secure.getInt(
+ context.getContentResolver(),
+ GLANCEABLE_HUB_ENABLED,
+ getEnabledDefault(context)) == 1;
+ }
+
+ static int getEnabledDefault(Context context) {
+ if (!Flags.glanceableHubV2()) {
+ // The default was just "1" (enabled) pre-hub_v2).
+ return 1;
+ }
+
+ return Flags.glanceableHubEnabledByDefault()
+ || context.getResources().getBoolean(
+ com.android.internal.R.bool.config_glanceableHubEnabledByDefault) ? 1 : 0;
+ }
+
+ private void disablePreferenceIfManaged(Preference pref) {
+ final RestrictedLockUtils.EnforcedAdmin admin =
+ RestrictedLockUtilsInternal.checkIfKeyguardFeaturesDisabled(
+ mContext,
+ DevicePolicyManager.KEYGUARD_DISABLE_WIDGETS_ALL,
+ UserHandle.myUserId());
+ if (admin != null) {
+ if (pref instanceof RestrictedSwitchPreference) {
+ ((RestrictedSwitchPreference) pref).setDisabledByAdmin(admin);
+ ((RestrictedSwitchPreference) pref).setChecked(false);
+ } else if (pref instanceof PrimarySwitchPreference) {
+ ((PrimarySwitchPreference) pref).setDisabledByAdmin(admin);
+ ((PrimarySwitchPreference) pref).setChecked(false);
+ } else {
+ Log.e(TAG, "Unknown pref type passed to disablePreferenceIfManaged: " + pref);
+ }
+ }
+ }
+
+ private boolean isMainUser() {
+ final UserManager userManager = mContext.getSystemService(UserManager.class);
return userManager.getUserInfo(UserHandle.myUserId()).isMain();
}
}
diff --git a/tests/robotests/src/com/android/settings/display/WidgetsOnLockscreenPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/display/WidgetsOnLockscreenPreferenceControllerTest.java
new file mode 100644
index 0000000..b5c35e8
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/display/WidgetsOnLockscreenPreferenceControllerTest.java
@@ -0,0 +1,272 @@
+/*
+ * Copyright (C) 2024 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.display;
+
+import static android.app.admin.DevicePolicyManager.KEYGUARD_DISABLE_WIDGETS_ALL;
+import static android.provider.Settings.Secure.GLANCEABLE_HUB_ENABLED;
+
+import static com.android.systemui.Flags.FLAG_GLANCEABLE_HUB_ENABLED_BY_DEFAULT;
+import static com.android.systemui.Flags.FLAG_GLANCEABLE_HUB_V2;
+import static com.android.settings.core.BasePreferenceController.AVAILABLE;
+import static com.android.settings.core.BasePreferenceController.UNSUPPORTED_ON_DEVICE;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyInt;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import android.annotation.UserIdInt;
+import android.app.admin.DevicePolicyManager;
+import android.content.Context;
+import android.content.pm.UserInfo;
+import android.os.UserHandle;
+import android.os.UserManager;
+import android.platform.test.annotations.DisableFlags;
+import android.platform.test.annotations.EnableFlags;
+import android.platform.test.flag.junit.SetFlagsRule;
+import android.provider.Settings;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import com.android.settings.R;
+import com.android.settings.testutils.shadow.SettingsShadowResources;
+import com.android.settingslib.PrimarySwitchPreference;
+import com.android.settingslib.RestrictedLockUtils;
+import com.android.settingslib.RestrictedLockUtils.EnforcedAdmin;
+import com.android.settingslib.RestrictedLockUtilsInternal;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
+import org.robolectric.annotation.Implementation;
+import org.robolectric.annotation.Implements;
+import org.robolectric.annotation.Resetter;
+
+@RunWith(RobolectricTestRunner.class)
+@Config(shadows = {
+ SettingsShadowResources.class,
+ WidgetsOnLockscreenPreferenceControllerTest.ShadowRestrictedLockUtilsInternal.class,
+})
+public class WidgetsOnLockscreenPreferenceControllerTest {
+ private static final String PREFERENCE_KEY = "preference_key";
+
+ @Rule
+ public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
+
+ @Mock
+ public PrimarySwitchPreference mPreference;
+
+ @Mock
+ private DevicePolicyManager mDevicePolicyManager;
+ @Mock
+ private UserManager mUserManager;
+ @Mock
+ private UserInfo mUserInfo;
+
+ private WidgetsOnLockscreenPreferenceController mController;
+
+ private Context mContext;
+
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+
+ mContext = spy(ApplicationProvider.getApplicationContext());
+
+ when(mContext.getSystemService(eq(Context.DEVICE_POLICY_SERVICE)))
+ .thenReturn(mDevicePolicyManager);
+ when(mDevicePolicyManager.getKeyguardDisabledFeatures(any(), anyInt())).thenReturn(0);
+
+ when(mContext.getSystemService(eq(UserManager.class))).thenReturn(mUserManager);
+ when(mUserManager.getUserInfo(UserHandle.myUserId())).thenReturn(mUserInfo);
+ when(mUserInfo.isMain()).thenReturn(true);
+
+ mController = new WidgetsOnLockscreenPreferenceController(mContext, PREFERENCE_KEY);
+ }
+
+ @After
+ public void tearDown() {
+ ShadowRestrictedLockUtilsInternal.reset();
+ }
+
+ @Test
+ public void getAvailabilityStatus_featureEnabled_available() {
+ setShowGlanceableHubToggleSettingEnabled(true);
+
+ assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
+ }
+
+ @Test
+ public void getAvailabilityStatus_glanceableHubSettingEnabledOnMobile_available() {
+ // The show_glanceable_hub_toggle_setting config needs to be false in order for
+ // getAvailabilityStatus to fall through to the glanceable_hub config check.
+ setShowGlanceableHubToggleSettingEnabled(false);
+ setShowGlanceableHubToggleSettingOnMobileEnabled(true);
+ setGlanceableHubEnabled(true);
+ mSetFlagsRule.enableFlags(FLAG_GLANCEABLE_HUB_V2);
+
+ assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
+ }
+
+ @Test
+ public void getAvailabilityStatus_glanceableHubSettingConfigsDisabled_unsupported() {
+ setShowGlanceableHubToggleSettingEnabled(false);
+ setShowGlanceableHubToggleSettingOnMobileEnabled(false);
+ setGlanceableHubEnabled(true);
+ mSetFlagsRule.enableFlags(FLAG_GLANCEABLE_HUB_V2);
+
+ assertThat(mController.getAvailabilityStatus()).isEqualTo(UNSUPPORTED_ON_DEVICE);
+ }
+
+ @Test
+ public void getAvailabilityStatus_glanceableV2FlagDisabled_unsupported() {
+ // The show_glanceable_hub_toggle_setting config needs to be false in order for
+ // getAvailabilityStatus to fall through to the glanceable_hub config check.
+ setShowGlanceableHubToggleSettingEnabled(false);
+ setShowGlanceableHubToggleSettingOnMobileEnabled(true);
+ setGlanceableHubEnabled(true);
+ mSetFlagsRule.disableFlags(FLAG_GLANCEABLE_HUB_V2);
+
+ assertThat(mController.getAvailabilityStatus()).isEqualTo(UNSUPPORTED_ON_DEVICE);
+ }
+
+ @Test
+ public void getAvailabilityStatus_forSecondaryUser_unsupported() {
+ setShowGlanceableHubToggleSettingEnabled(true);
+
+ when(mUserInfo.isMain()).thenReturn(false);
+ assertThat(mController.getAvailabilityStatus()).isEqualTo(UNSUPPORTED_ON_DEVICE);
+ }
+
+ @Test
+ public void updateState_keyguardWidgetsDisabled_prefDisabledByAdmin() {
+ setShowGlanceableHubToggleSettingEnabled(true);
+ ShadowRestrictedLockUtilsInternal.setKeyguardDisabledFeatures(KEYGUARD_DISABLE_WIDGETS_ALL);
+
+ mController.updateState(mPreference);
+
+ verify(mPreference).setDisabledByAdmin(any(RestrictedLockUtils.EnforcedAdmin.class));
+ verify(mPreference).setChecked(false);
+ }
+
+ @Test
+ public void setChecked_checked_updateSettings() throws Settings.SettingNotFoundException {
+ // set the initial state to off
+ updateSecureSetting(0);
+
+ assertThat(readSecureSetting()).isEqualTo(0);
+
+ mController.setChecked(true);
+
+ assertThat(readSecureSetting()).isEqualTo(1);
+ }
+
+ @Test
+ public void setChecked_unchecked_updateSettings() throws Settings.SettingNotFoundException {
+ // set the initial state to on
+ updateSecureSetting(1);
+
+ assertThat(readSecureSetting()).isEqualTo(1);
+
+ mController.setChecked(false);
+
+ assertThat(readSecureSetting()).isEqualTo(0);
+ }
+
+ @EnableFlags(FLAG_GLANCEABLE_HUB_V2)
+ @DisableFlags(FLAG_GLANCEABLE_HUB_ENABLED_BY_DEFAULT)
+ @Test
+ public void hubEnabledByUser_defaultsToConfigValue_true() {
+ SettingsShadowResources.overrideResource(
+ com.android.internal.R.bool.config_glanceableHubEnabledByDefault, true);
+
+ assertThat(mController.isChecked()).isTrue();
+ }
+
+ @EnableFlags(FLAG_GLANCEABLE_HUB_V2)
+ @DisableFlags(FLAG_GLANCEABLE_HUB_ENABLED_BY_DEFAULT)
+ @Test
+ public void hubEnabledByUser_defaultsToConfigValue_false() {
+ SettingsShadowResources.overrideResource(
+ com.android.internal.R.bool.config_glanceableHubEnabledByDefault, false);
+
+ assertThat(mController.isChecked()).isFalse();
+ }
+
+ @EnableFlags({FLAG_GLANCEABLE_HUB_V2, FLAG_GLANCEABLE_HUB_ENABLED_BY_DEFAULT})
+ @Test
+ public void hubEnabledByUser_defaultsToFlagValue_true() {
+ SettingsShadowResources.overrideResource(
+ com.android.internal.R.bool.config_glanceableHubEnabledByDefault, false);
+
+ assertThat(mController.isChecked()).isTrue();
+ }
+
+ private void updateSecureSetting(int value) {
+ Settings.Secure.putInt(mContext.getContentResolver(), GLANCEABLE_HUB_ENABLED, value);
+ }
+
+ private int readSecureSetting() throws Settings.SettingNotFoundException {
+ return Settings.Secure.getInt(mContext.getContentResolver(), GLANCEABLE_HUB_ENABLED);
+ }
+
+ private void setShowGlanceableHubToggleSettingEnabled(boolean enabled) {
+ SettingsShadowResources.overrideResource(
+ R.bool.config_show_glanceable_hub_toggle_setting, enabled);
+ }
+
+ private void setGlanceableHubEnabled(boolean enabled) {
+ SettingsShadowResources.overrideResource(
+ com.android.internal.R.bool.config_glanceableHubEnabled, enabled);
+ }
+
+ private void setShowGlanceableHubToggleSettingOnMobileEnabled(boolean enabled) {
+ SettingsShadowResources.overrideResource(
+ R.bool.config_show_glanceable_hub_toggle_setting_mobile, enabled);
+ }
+
+ @Implements(RestrictedLockUtilsInternal.class)
+ public static class ShadowRestrictedLockUtilsInternal {
+ private static int sKeyguardDisabledFeatures;
+
+ /** Reset state. */
+ @Resetter
+ public static void reset() {
+ sKeyguardDisabledFeatures = 0;
+ }
+
+ @Implementation
+ protected static EnforcedAdmin checkIfKeyguardFeaturesDisabled(
+ Context context, int features, @UserIdInt final int userId) {
+ return (sKeyguardDisabledFeatures & features) == 0 ? null : new EnforcedAdmin();
+ }
+
+ public static void setKeyguardDisabledFeatures(int features) {
+ sKeyguardDisabledFeatures = features;
+ }
+ }
+}
