From 50577a6c36d33830acd809ddbc519ae0f02fa283 Mon Sep 17 00:00:00 2001
From: Yining Liu <liuyining@google.com>
Date: Thu, 9 Jan 2025 01:37:55 +0000
Subject: [PATCH] Notification on lockscreen settings: add WhatToShowController

Add WhatToShowController to handle the visibility change of the
preference category when the global setting changes.

Bug: 367455695
Flag: com.android.server.notification.notification_lock_screen_settings
Test: manual
Change-Id: I432e4c865402ac8bee32f0f79b3cf2bdce7cc882
---
 .../lock_screen_notifications_settings.xml    |   3 +-
 .../LockScreenWhatToShowController.java       | 101 ++++++++++++++++++
 .../LockScreenWhatToShowControllerTest.java   | 100 +++++++++++++++++
 3 files changed, 203 insertions(+), 1 deletion(-)
 create mode 100644 src/com/android/settings/notification/LockScreenWhatToShowController.java
 create mode 100644 tests/robotests/src/com/android/settings/notification/LockScreenWhatToShowControllerTest.java

diff --git a/res/xml/lock_screen_notifications_settings.xml b/res/xml/lock_screen_notifications_settings.xml
index e870143823d..52ae18f3f51 100644
--- a/res/xml/lock_screen_notifications_settings.xml
+++ b/res/xml/lock_screen_notifications_settings.xml
@@ -46,7 +46,8 @@
 
     <PreferenceCategory
         android:key="lockscreen_notification_what_to_show"
-        android:title="@string/lockscreen_notification_what_to_show_title">
+        android:title="@string/lockscreen_notification_what_to_show_title"
+        settings:controller="com.android.settings.notification.LockScreenWhatToShowController">
 
         <SwitchPreferenceCompat
             android:key="lock_screen_notification_show_seen_toggle"
diff --git a/src/com/android/settings/notification/LockScreenWhatToShowController.java b/src/com/android/settings/notification/LockScreenWhatToShowController.java
new file mode 100644
index 00000000000..9e5af4fc3be
--- /dev/null
+++ b/src/com/android/settings/notification/LockScreenWhatToShowController.java
@@ -0,0 +1,101 @@
+/*
+ * 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.notification;
+
+import android.content.ContentResolver;
+import android.content.Context;
+import android.database.ContentObserver;
+import android.net.Uri;
+import android.os.Handler;
+import android.os.Looper;
+import android.provider.Settings;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.lifecycle.Lifecycle;
+import androidx.lifecycle.LifecycleEventObserver;
+import androidx.lifecycle.LifecycleOwner;
+import androidx.preference.Preference;
+import androidx.preference.PreferenceScreen;
+
+import com.android.settings.widget.PreferenceCategoryController;
+
+public class LockScreenWhatToShowController extends PreferenceCategoryController implements
+        LifecycleEventObserver {
+
+    @Nullable
+    private Preference mPreference;
+    private final ContentResolver mContentResolver;
+
+    final ContentObserver mContentObserver = new ContentObserver(
+            new Handler(Looper.getMainLooper())) {
+        @Override
+        public void onChange(boolean selfChange, @Nullable Uri uri) {
+            if (mPreference == null) return;
+            updateState(mPreference);
+        }
+    };
+
+    @Override
+    public void updateState(@Nullable Preference preference) {
+        super.updateState(preference);
+        if (preference == null) return;
+        preference.setVisible(isAvailable());
+    }
+
+    public LockScreenWhatToShowController(@NonNull Context context, @NonNull String key) {
+        super(context, key);
+        mContentResolver = context.getContentResolver();
+    }
+
+    @Override
+    public void displayPreference(@NonNull PreferenceScreen screen) {
+        super.displayPreference(screen);
+        mPreference = screen.findPreference(getPreferenceKey());
+    }
+
+    @Override
+    public int getAvailabilityStatus() {
+        if (!lockScreenShowNotification()) {
+            return CONDITIONALLY_UNAVAILABLE;
+        }
+        return AVAILABLE;
+    }
+
+    /**
+     * @return Whether showing notifications on the lockscreen is enabled.
+     */
+    private boolean lockScreenShowNotification() {
+        return Settings.Secure.getInt(
+                mContext.getContentResolver(),
+                Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS,
+                LockScreenNotificationsGlobalPreferenceController.OFF
+        ) == LockScreenNotificationsGlobalPreferenceController.ON;
+    }
+
+    @Override
+    public void onStateChanged(@NonNull LifecycleOwner lifecycleOwner,
+            @NonNull Lifecycle.Event event) {
+        if (event == Lifecycle.Event.ON_RESUME) {
+            mContentResolver.registerContentObserver(
+                    Settings.Secure.getUriFor(Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS),
+                    /* notifyForDescendants= */ false, mContentObserver);
+        } else if (event == Lifecycle.Event.ON_PAUSE) {
+            mContentResolver.unregisterContentObserver(mContentObserver);
+        }
+    }
+}
diff --git a/tests/robotests/src/com/android/settings/notification/LockScreenWhatToShowControllerTest.java b/tests/robotests/src/com/android/settings/notification/LockScreenWhatToShowControllerTest.java
new file mode 100644
index 00000000000..1e07a43bba3
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/notification/LockScreenWhatToShowControllerTest.java
@@ -0,0 +1,100 @@
+/*
+ * 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.notification;
+
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import android.content.Context;
+import android.platform.test.annotations.EnableFlags;
+import android.platform.test.flag.junit.SetFlagsRule;
+import android.provider.Settings;
+
+import androidx.annotation.Nullable;
+import androidx.preference.Preference;
+import androidx.test.core.app.ApplicationProvider;
+
+import com.android.server.notification.Flags;
+
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.MockitoAnnotations;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.RuntimeEnvironment;
+
+@RunWith(RobolectricTestRunner.class)
+@EnableFlags(Flags.FLAG_NOTIFICATION_LOCK_SCREEN_SETTINGS)
+public class LockScreenWhatToShowControllerTest {
+
+    @Rule
+    public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
+
+    private static final String PREFERENCE_KEY = "lockscreen_notification_what_to_show";
+
+    private LockScreenWhatToShowController mController;
+    private Context mContext;
+    @Nullable
+    private Preference mPreference;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        MockitoAnnotations.initMocks(this);
+        mController = new LockScreenWhatToShowController(
+                RuntimeEnvironment.application,
+                PREFERENCE_KEY);
+        mPreference = new Preference(mContext);
+        mPreference.setKey(PREFERENCE_KEY);
+    }
+
+    @Test
+    public void updateState_preferenceVisibleWhenSettingIsOn() {
+        // Before: the show LOCK_SCREEN_SHOW_NOTIFICATIONS setting is on
+        Settings.Secure.putInt(
+                mContext.getContentResolver(),
+                Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS,
+                LockScreenNotificationsGlobalPreferenceController.ON
+        );
+
+        // When: update state
+        mController.updateState(mPreference);
+
+        // Then: the preference is visible
+        assertNotNull(mPreference);
+        assertTrue(mPreference.isVisible());
+    }
+
+    @Test
+    public void updateState_preferenceInvisibleWhenSettingIsOff() {
+        // Before: the show LOCK_SCREEN_SHOW_NOTIFICATIONS setting is off
+        Settings.Secure.putInt(
+                mContext.getContentResolver(),
+                Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS,
+                LockScreenNotificationsGlobalPreferenceController.OFF
+        );
+
+        // When: update state
+        mController.updateState(mPreference);
+
+        // Then: the preference is not visible
+        assertNotNull(mPreference);
+        assertFalse(mPreference.isVisible());
+    }
+}