Implement the show sensitive content toggle

Implement the show sensitive content only when unlocked toggle on the
notifications on lock screen page. The toggle will become invisible
when the main toggle is unset or when there's no screen locks.

Bug: 367455695
Flag: com.android.server.notification.notification_lock_screen_settings
Test: adb shell settings get secure \
 lock_screen_allow_private_notifications <1|0>
Change-Id: I174478540c4cc2e2df7047049671266041dd41cf
This commit is contained in:
Yining Liu
2024-11-19 22:54:17 +00:00
parent 0d75a26a68
commit c16c9b2df6
3 changed files with 586 additions and 0 deletions

View File

@@ -25,4 +25,14 @@
android:title="@string/switch_on_text"
settings:controller="com.android.settings.notification.LockScreenNotificationsGlobalPreferenceController"/>
<com.android.settingslib.RestrictedSwitchPreference
android:key="lock_screen_notification_show_sensitive_toggle"
android:title="@string/lock_screen_notifications_summary_hide"
settings:controller="com.android.settings.notification.LockScreenNotificationShowSensitiveToggleController" />
<com.android.settingslib.RestrictedSwitchPreference
android:key="work_profile_show_sensitive_notif_toggle"
android:title="@string/lock_screen_notifications_summary_hide_profile"
settings:controller="com.android.settings.notification.LockScreenNotificationShowSensitiveToggleController" />
</PreferenceScreen>

View File

@@ -0,0 +1,222 @@
/*
* 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.notification;
import static android.app.admin.DevicePolicyManager.KEYGUARD_DISABLE_SECURE_NOTIFICATIONS;
import static android.app.admin.DevicePolicyManager.KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS;
import android.app.KeyguardManager;
import android.content.ContentResolver;
import android.content.Context;
import android.content.pm.UserInfo;
import android.database.ContentObserver;
import android.net.Uri;
import android.os.Handler;
import android.os.Looper;
import android.os.UserHandle;
import android.os.UserManager;
import android.provider.Settings;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting;
import androidx.lifecycle.Lifecycle;
import androidx.lifecycle.LifecycleEventObserver;
import androidx.lifecycle.LifecycleOwner;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;
import com.android.settings.core.TogglePreferenceController;
import com.android.settings.overlay.FeatureFactory;
import com.android.settingslib.RestrictedLockUtils;
import com.android.settingslib.RestrictedLockUtilsInternal;
import com.android.settingslib.RestrictedSwitchPreference;
import java.util.List;
/**
* Controls the toggle that determines whether to show sensitive notifications on the lock screen
* when locked.
* Toggle for: Settings.Secure.LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS
*/
public class LockScreenNotificationShowSensitiveToggleController
extends TogglePreferenceController implements LifecycleEventObserver {
private static final int ON = 1;
private static final int OFF = 0;
@VisibleForTesting
static final String KEY_SHOW_SENSITIVE = "lock_screen_notification_show_sensitive_toggle";
@VisibleForTesting
static final String KEY_SHOW_SENSITIVE_WORK_PROFILE =
"work_profile_show_sensitive_notif_toggle";
@Nullable private RestrictedSwitchPreference mPreference;
private final ContentResolver mContentResolver;
private UserManager mUserManager;
private KeyguardManager mKeyguardManager;
@VisibleForTesting
int mWorkProfileUserId;
final ContentObserver mContentObserver = new ContentObserver(
new Handler(Looper.getMainLooper())) {
@Override
public void onChange(boolean selfChange, @Nullable Uri uri) {
updateState(mPreference);
}
};
public LockScreenNotificationShowSensitiveToggleController(@NonNull Context context,
@NonNull String preferenceKey) {
super(context, preferenceKey);
mContentResolver = context.getContentResolver();
mUserManager = context.getSystemService(UserManager.class);
mKeyguardManager = context.getSystemService(KeyguardManager.class);
mWorkProfileUserId = UserHandle.myUserId();
final List<UserInfo> profiles = mUserManager.getProfiles(UserHandle.myUserId());
for (UserInfo profile: profiles) {
if (profile.isManagedProfile()
&& profile.getUserHandle().getIdentifier() != UserHandle.myUserId()) {
mWorkProfileUserId = profile.getUserHandle().getIdentifier();
}
}
}
@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);
mContentResolver.registerContentObserver(
Settings.Secure.getUriFor(
Settings.Secure.LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS),
/* notifyForDescendants= */ false,
mContentObserver
);
} else if (event == Lifecycle.Event.ON_PAUSE) {
mContentResolver.unregisterContentObserver(mContentObserver);
}
}
@Override
public void displayPreference(@NonNull PreferenceScreen screen) {
super.displayPreference(screen);
mPreference = screen.findPreference(getPreferenceKey());
int userId = getUserId();
if (mPreference != null && userId != UserHandle.USER_NULL) {
mPreference.setDisabledByAdmin(getEnforcedAdmin(userId));
}
}
private RestrictedLockUtils.EnforcedAdmin getEnforcedAdmin(int userId) {
RestrictedLockUtils.EnforcedAdmin admin =
RestrictedLockUtilsInternal.checkIfKeyguardFeaturesDisabled(
mContext, KEYGUARD_DISABLE_SECURE_NOTIFICATIONS, userId);
if (admin != null) {
return admin;
}
admin = RestrictedLockUtilsInternal.checkIfKeyguardFeaturesDisabled(
mContext, KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS, userId);
return admin;
}
private int getUserId() {
return KEY_SHOW_SENSITIVE.equals(getPreferenceKey())
? UserHandle.myUserId() : mWorkProfileUserId;
}
@Override
public void updateState(@Nullable Preference preference) {
if (preference == null) return;
setChecked(showSensitiveContentOnlyWhenUnlocked());
preference.setVisible(isAvailable());
}
@Override
public int getAvailabilityStatus() {
// hide setting if no lock screen notification
if (!lockScreenShowNotification()) {
return CONDITIONALLY_UNAVAILABLE;
}
// hide setting if no screen lock
if (!isLockScreenSecure()) {
return CONDITIONALLY_UNAVAILABLE;
}
// For the work profile toggle
if (KEY_SHOW_SENSITIVE_WORK_PROFILE.equals(getPreferenceKey())) {
// hide work profile setting if no work profile
if (mWorkProfileUserId == UserHandle.myUserId()) {
return CONDITIONALLY_UNAVAILABLE;
}
// specifically the work profile setting requires the work profile to be unlocked
if (mKeyguardManager.isDeviceLocked(mWorkProfileUserId)) {
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, ON) != OFF;
}
@Override
public boolean isChecked() {
return showSensitiveContentOnlyWhenUnlocked();
}
private boolean showSensitiveContentOnlyWhenUnlocked() {
int userId = getUserId();
if (!isLockScreenSecure()) return false;
if (getEnforcedAdmin(userId) != null) return true;
return Settings.Secure.getIntForUser(mContext.getContentResolver(),
Settings.Secure.LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS, ON, userId) == OFF;
}
@Override
public boolean setChecked(boolean isChecked) {
return Settings.Secure.putIntForUser(
mContext.getContentResolver(),
Settings.Secure.LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
(isChecked ? OFF : ON), getUserId()
);
}
private boolean isLockScreenSecure() {
return FeatureFactory.getFeatureFactory()
.getSecurityFeatureProvider()
.getLockPatternUtils(mContext)
.isSecure(UserHandle.myUserId());
}
@Override
public int getSliceHighlightMenuRes() {
// not needed since it's not sliceable
return NO_RES;
}
}

View File

@@ -0,0 +1,354 @@
/*
* 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 com.android.settings.notification;
import static android.app.admin.DevicePolicyManager.KEYGUARD_DISABLE_SECURE_NOTIFICATIONS;
import static android.app.admin.DevicePolicyManager.KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS;
import static android.provider.Settings.Secure.LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS;
import static android.provider.Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS;
import static com.android.settings.core.BasePreferenceController.AVAILABLE;
import static com.android.settings.core.BasePreferenceController.CONDITIONALLY_UNAVAILABLE;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.when;
import android.app.KeyguardManager;
import android.app.admin.DevicePolicyManager;
import android.content.Context;
import android.content.pm.UserInfo;
import android.os.UserHandle;
import android.os.UserManager;
import android.provider.Settings;
import androidx.preference.PreferenceScreen;
import com.android.internal.widget.LockPatternUtils;
import com.android.settings.testutils.FakeFeatureFactory;
import com.android.settings.testutils.shadow.ShadowRestrictedLockUtilsInternal;
import com.android.settings.testutils.shadow.ShadowUtils;
import com.android.settingslib.RestrictedSwitchPreference;
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.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import java.util.Arrays;
@RunWith(RobolectricTestRunner.class)
@Config(shadows = {
ShadowUtils.class,
ShadowRestrictedLockUtilsInternal.class,
})
public class LockScreenNotificationShowSensitiveToggleControllerTest {
@Mock
private DevicePolicyManager mDpm;
@Mock
UserManager mUm;
@Mock
KeyguardManager mKm;
@Mock
private PreferenceScreen mScreen;
@Mock
private LockPatternUtils mLockPatternUtils;
@Mock
private Context mMockContext;
private Context mContext;
private LockScreenNotificationShowSensitiveToggleController mController;
private LockScreenNotificationShowSensitiveToggleController mWorkController;
private RestrictedSwitchPreference mPreference;
private RestrictedSwitchPreference mWorkPreference;
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
mContext = RuntimeEnvironment.application;
FakeFeatureFactory featureFactory = FakeFeatureFactory.setupForTest();
when(featureFactory.securityFeatureProvider.getLockPatternUtils(mMockContext))
.thenReturn(mLockPatternUtils);
when(mMockContext.getContentResolver()).thenReturn(mContext.getContentResolver());
when(mMockContext.getSystemService(UserManager.class)).thenReturn(mUm);
when(mMockContext.getSystemService(DevicePolicyManager.class)).thenReturn(mDpm);
when(mMockContext.getSystemService(KeyguardManager.class)).thenReturn(mKm);
when(mUm.getProfiles(anyInt())).thenReturn(Arrays.asList(new UserInfo(0, "", 0)));
mController = new LockScreenNotificationShowSensitiveToggleController(
mMockContext,
LockScreenNotificationShowSensitiveToggleController.KEY_SHOW_SENSITIVE
);
mPreference = new RestrictedSwitchPreference(mContext);
mPreference.setKey(mController.getPreferenceKey());
when(mScreen.findPreference(
mController.getPreferenceKey())).thenReturn(mPreference);
when(mUm.getProfiles(anyInt())).thenReturn(Arrays.asList(
new UserInfo(5, "", 0),
new UserInfo(10, "", UserInfo.FLAG_MANAGED_PROFILE | UserInfo.FLAG_PROFILE)));
mWorkController = new LockScreenNotificationShowSensitiveToggleController(
mMockContext,
LockScreenNotificationShowSensitiveToggleController.KEY_SHOW_SENSITIVE_WORK_PROFILE
);
mWorkPreference = new RestrictedSwitchPreference(mContext);
mWorkPreference.setKey(mWorkController.getPreferenceKey());
when(mScreen.findPreference(
mWorkController.getPreferenceKey())).thenReturn(mWorkPreference);
}
@After
public void tearDown() {
ShadowRestrictedLockUtilsInternal.reset();
}
@Test
public void profileUserIds() {
assertThat(mController.mWorkProfileUserId).isEqualTo(0);
assertThat(mWorkController.mWorkProfileUserId).isEqualTo(10);
}
@Test
public void getAvailabilityStatus_noSecureLockscreen() {
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(false);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 0);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 10);
assertThat(mController.getAvailabilityStatus()).isEqualTo(CONDITIONALLY_UNAVAILABLE);
assertThat(mWorkController.getAvailabilityStatus()).isEqualTo(CONDITIONALLY_UNAVAILABLE);
}
@Test
public void getAvailabilityStatus_noWorkProfile() {
// reset controllers with no work profile
when(mUm.getProfiles(anyInt())).thenReturn(Arrays.asList(
new UserInfo(UserHandle.myUserId(), "", 0)));
mWorkController = new LockScreenNotificationShowSensitiveToggleController(
mMockContext,
LockScreenNotificationShowSensitiveToggleController.KEY_SHOW_SENSITIVE_WORK_PROFILE
);
mController = new LockScreenNotificationShowSensitiveToggleController(mMockContext,
LockScreenNotificationShowSensitiveToggleController.KEY_SHOW_SENSITIVE);
// should otherwise show
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(true);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 0);
assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
assertThat(mWorkController.getAvailabilityStatus()).isEqualTo(CONDITIONALLY_UNAVAILABLE);
}
@Test
public void displayPreference_adminSaysNoRedaction() {
ShadowRestrictedLockUtilsInternal.setKeyguardDisabledFeatures(
KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS);
mController.displayPreference(mScreen);
assertThat(mPreference.isDisabledByAdmin()).isTrue();
mWorkController.displayPreference(mScreen);
assertThat(mWorkPreference.isDisabledByAdmin()).isTrue();
}
@Test
public void displayPreference_adminSaysNoSecure() {
ShadowRestrictedLockUtilsInternal.setKeyguardDisabledFeatures(
KEYGUARD_DISABLE_SECURE_NOTIFICATIONS);
mController.displayPreference(mScreen);
assertThat(mPreference.isDisabledByAdmin()).isTrue();
mWorkController.displayPreference(mScreen);
assertThat(mWorkPreference.isDisabledByAdmin()).isTrue();
}
@Test
public void displayPreference() {
ShadowRestrictedLockUtilsInternal.setKeyguardDisabledFeatures(0);
mController.displayPreference(mScreen);
assertThat(mPreference.isDisabledByAdmin()).isFalse();
mWorkController.displayPreference(mScreen);
assertThat(mWorkPreference.isDisabledByAdmin()).isFalse();
}
@Test
public void getAvailabilityStatus_adminSaysNoNotifications() {
when(mDpm.getKeyguardDisabledFeatures(eq(null), anyInt())).thenReturn(
KEYGUARD_DISABLE_SECURE_NOTIFICATIONS);
// should show
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(true);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 0);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 10);
assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
assertThat(mWorkController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
}
@Test
public void getAvailabilityStatus_noNotifications() {
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(true);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
0, 0);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
0, 10);
assertThat(mController.getAvailabilityStatus()).isEqualTo(CONDITIONALLY_UNAVAILABLE);
assertThat(mWorkController.getAvailabilityStatus()).isEqualTo(CONDITIONALLY_UNAVAILABLE);
}
@Test
public void getAvailabilityStatus_workProfileLocked() {
// should otherwise show
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(true);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 0);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 10);
when(mKm.isDeviceLocked(10)).thenReturn(true);
assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
assertThat(mWorkController.getAvailabilityStatus()).isEqualTo(CONDITIONALLY_UNAVAILABLE);
}
@Test
public void getAvailabilityStatus_show() {
// should show
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(true);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 0);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_SHOW_NOTIFICATIONS,
1, 10);
assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
assertThat(mWorkController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
}
@Test
public void isChecked() {
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(true);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
0, 0);
assertThat(mController.isChecked()).isTrue();
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
1, 0);
assertThat(mController.isChecked()).isFalse();
}
@Test
public void isChecked_work() {
when(mLockPatternUtils.isSecure(anyInt())).thenReturn(true);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
0, 10);
assertThat(mWorkController.isChecked()).isTrue();
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
1, 10);
assertThat(mWorkController.isChecked()).isFalse();
}
@Test
public void isChecked_admin() {
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
1, 0);
ShadowRestrictedLockUtilsInternal.setKeyguardDisabledFeatures(
KEYGUARD_DISABLE_SECURE_NOTIFICATIONS);
assertThat(mController.isChecked()).isFalse();
}
@Test
public void setChecked_false() throws Exception {
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
0, 0);
mController.setChecked(false);
assertThat(Settings.Secure.getIntForUser(
mContext.getContentResolver(), LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS, 0))
.isEqualTo(1);
}
@Test
public void setChecked_workProfile_true() throws Exception {
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
1, 10);
mWorkController.setChecked(true);
assertThat(Settings.Secure.getIntForUser(
mContext.getContentResolver(), LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS, 10))
.isEqualTo(0);
}
@Test
public void setChecked_true() throws Exception {
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
1, 0);
Settings.Secure.putIntForUser(mContext.getContentResolver(),
LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS,
1, 10);
mController.setChecked(true);
mWorkController.setChecked(true);
assertThat(Settings.Secure.getIntForUser(
mContext.getContentResolver(), LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS, 10))
.isEqualTo(0);
assertThat(Settings.Secure.getIntForUser(
mContext.getContentResolver(), LOCK_SCREEN_ALLOW_PRIVATE_NOTIFICATIONS, 0))
.isEqualTo(0);
}
}