Use shared model for non-system overlay toggle

Allows settings applications on other platforms to re-use values by
migrating to Settings.secure and moving HideNonSystemOverlayMixin to
SettingsLib.

Bug: 184967544
Test: atest SettingsUnitTests
Change-Id: If9aaeca29ebb8b481d75622934503e368d7435d3

src/com/android/settings/core/HideNonSystemOverlayMixin.java

@@ -1,72 +0,0 @@
-/*
- * 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.core;
-
-import static android.view.WindowManager.LayoutParams.SYSTEM_FLAG_HIDE_NON_SYSTEM_OVERLAY_WINDOWS;
-
-import static androidx.lifecycle.Lifecycle.Event.ON_START;
-import static androidx.lifecycle.Lifecycle.Event.ON_STOP;
-
-import android.app.Activity;
-import android.view.Window;
-import android.view.WindowManager;
-
-import androidx.annotation.VisibleForTesting;
-import androidx.lifecycle.LifecycleObserver;
-import androidx.lifecycle.OnLifecycleEvent;
-
-import com.android.settings.development.OverlaySettingsPreferenceController;
-
-
-/**
- * A mixin that adds window flag to prevent non-system overlays showing on top of Settings
- * activities.
- */
-public class HideNonSystemOverlayMixin implements LifecycleObserver {
-
-    private final Activity mActivity;
-
-    public HideNonSystemOverlayMixin(Activity activity) {
-        mActivity = activity;
-    }
-
-    @VisibleForTesting
-    boolean isEnabled() {
-        return !OverlaySettingsPreferenceController.isOverlaySettingsEnabled(mActivity);
-    }
-
-    @OnLifecycleEvent(ON_START)
-    public void onStart() {
-        if (mActivity == null || !isEnabled()) {
-            return;
-        }
-        mActivity.getWindow().addSystemFlags(SYSTEM_FLAG_HIDE_NON_SYSTEM_OVERLAY_WINDOWS);
-        android.util.EventLog.writeEvent(0x534e4554, "120484087", -1, "");
-    }
-
-
-    @OnLifecycleEvent(ON_STOP)
-    public void onStop() {
-        if (mActivity == null || !isEnabled()) {
-            return;
-        }
-        final Window window = mActivity.getWindow();
-        final WindowManager.LayoutParams attrs = window.getAttributes();
-        attrs.privateFlags &= ~SYSTEM_FLAG_HIDE_NON_SYSTEM_OVERLAY_WINDOWS;
-        window.setAttributes(attrs);
-    }
-}

src/com/android/settings/core/SettingsBaseActivity.java

@@ -47,6 +47,7 @@ import com.android.settings.R;
 import com.android.settings.SubSettings;
 import com.android.settings.Utils;
 import com.android.settings.dashboard.CategoryManager;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 import com.android.settingslib.drawer.Tile;
 import com.android.settingslib.transition.SettingsTransitionHelper;
 

src/com/android/settings/development/OverlaySettingsPreferenceController.java

@@ -16,8 +16,10 @@
 
 package com.android.settings.development;
 
+import static com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin.SECURE_OVERLAY_SETTINGS;
+
 import android.content.Context;
-import android.content.SharedPreferences;
+import android.provider.Settings;
 
 import androidx.annotation.VisibleForTesting;
 import androidx.preference.Preference;
@@ -33,7 +35,6 @@ import com.android.settingslib.development.DeveloperOptionsPreferenceController;
 public class OverlaySettingsPreferenceController extends DeveloperOptionsPreferenceController
         implements Preference.OnPreferenceChangeListener, PreferenceControllerMixin {
 
-    public static final String SHARE_PERFS = "overlay_settings";
     private static final String KEY_OVERLAY_SETTINGS = "overlay_settings";
 
     public OverlaySettingsPreferenceController(Context context) {
@@ -64,10 +65,10 @@ public class OverlaySettingsPreferenceController extends DeveloperOptionsPrefere
     /**
      * Check if this setting is enabled or not.
      */
-    public static boolean isOverlaySettingsEnabled(Context context) {
+    @VisibleForTesting
-        final SharedPreferences editor = context.getSharedPreferences(SHARE_PERFS,
+    static boolean isOverlaySettingsEnabled(Context context) {
-                Context.MODE_PRIVATE);
+        return Settings.Secure.getInt(context.getContentResolver(),
-        return editor.getBoolean(SHARE_PERFS, false /* defValue */);
+                SECURE_OVERLAY_SETTINGS, 0 /* defValue */) != 0;
     }
 
     /**
@@ -75,9 +76,8 @@ public class OverlaySettingsPreferenceController extends DeveloperOptionsPrefere
      */
     @VisibleForTesting
     static void setOverlaySettingsEnabled(Context context, boolean enabled) {
-        final SharedPreferences editor = context.getSharedPreferences(SHARE_PERFS,
+        Settings.Secure.putInt(context.getContentResolver(),
-                Context.MODE_PRIVATE);
+                SECURE_OVERLAY_SETTINGS, enabled ? 1 : 0);
-        editor.edit().putBoolean(SHARE_PERFS, enabled).apply();
     }
 
     @Override

src/com/android/settings/homepage/SettingsHomepageActivity.java

@@ -39,9 +39,9 @@ import com.android.settings.R;
 import com.android.settings.Utils;
 import com.android.settings.accounts.AvatarViewMixin;
 import com.android.settings.core.FeatureFlags;
-import com.android.settings.core.HideNonSystemOverlayMixin;
 import com.android.settings.homepage.contextualcards.ContextualCardsFragment;
 import com.android.settings.overlay.FeatureFactory;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 import com.android.settingslib.transition.SettingsTransitionHelper;
 
 public class SettingsHomepageActivity extends FragmentActivity {

src/com/android/settings/notification/app/ChannelPanelActivity.java

@@ -31,10 +31,9 @@ import androidx.annotation.Nullable;
 import androidx.fragment.app.FragmentActivity;
 import androidx.fragment.app.FragmentManager;
 
-import com.android.internal.annotations.VisibleForTesting;
 import com.android.settings.R;
-import com.android.settings.core.HideNonSystemOverlayMixin;
 import com.android.settings.core.SubSettingLauncher;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 
 /**
  * Dialog Activity to host channel settings

src/com/android/settings/panel/SettingsPanelActivity.java

@@ -35,7 +35,7 @@ import androidx.fragment.app.FragmentManager;
 
 import com.android.internal.annotations.VisibleForTesting;
 import com.android.settings.R;
-import com.android.settings.core.HideNonSystemOverlayMixin;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 
 /**
  * Dialog Activity to host Settings Slices.

src/com/android/settings/security/CredentialStorage.java

@@ -44,9 +44,9 @@ import androidx.fragment.app.FragmentActivity;
 
 import com.android.internal.widget.LockPatternUtils;
 import com.android.settings.R;
-import com.android.settings.core.HideNonSystemOverlayMixin;
 import com.android.settings.password.ChooseLockSettingsHelper;
 import com.android.settings.vpn2.VpnUtils;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 
 /**
  * CredentialStorage handles resetting and installing keys into KeyStore.

src/com/android/settings/wifi/addappnetworks/AddAppNetworksActivity.java

@@ -30,7 +30,7 @@ import androidx.fragment.app.FragmentManager;
 
 import com.android.internal.annotations.VisibleForTesting;
 import com.android.settings.R;
-import com.android.settings.core.HideNonSystemOverlayMixin;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 
 /**
  * When apps send a new intent with a WifiConfiguration list extra to Settings APP. Settings APP

tests/robotests/src/com/android/settings/core/HideNonSystemOverlayMixinTest.java

@@ -1,104 +0,0 @@
-/*
- * 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.core;
-
-import static android.view.WindowManager.LayoutParams.SYSTEM_FLAG_HIDE_NON_SYSTEM_OVERLAY_WINDOWS;
-
-import static com.google.common.truth.Truth.assertThat;
-
-import android.content.Context;
-import android.content.SharedPreferences;
-import android.os.Bundle;
-import android.view.WindowManager;
-
-import androidx.annotation.Nullable;
-import androidx.appcompat.app.AppCompatActivity;
-
-import com.android.settings.R;
-import com.android.settings.development.OverlaySettingsPreferenceController;
-
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.robolectric.Robolectric;
-import org.robolectric.RobolectricTestRunner;
-import org.robolectric.android.controller.ActivityController;
-
-@RunWith(RobolectricTestRunner.class)
-public class HideNonSystemOverlayMixinTest {
-
-    private ActivityController<TestActivity> mActivityController;
-
-    @Before
-    public void setUp() {
-        mActivityController = Robolectric.buildActivity(TestActivity.class);
-    }
-
-    @Test
-    public void startActivity_shouldHideNonSystemOverlay() {
-        mActivityController.setup();
-        TestActivity activity = mActivityController.get();
-
-        // Activity start: HIDE_NON_SYSTEM_OVERLAY should be set.
-        final WindowManager.LayoutParams attrs = activity.getWindow().getAttributes();
-        assertThat(attrs.privateFlags & SYSTEM_FLAG_HIDE_NON_SYSTEM_OVERLAY_WINDOWS)
-                .isNotEqualTo(0);
-    }
-
-    @Test
-    public void stopActivity_shouldUnhideNonSystemOverlay() {
-        mActivityController.setup().stop();
-        TestActivity activity = mActivityController.get();
-
-        final WindowManager.LayoutParams attrs = activity.getWindow().getAttributes();
-        assertThat(attrs.privateFlags & SYSTEM_FLAG_HIDE_NON_SYSTEM_OVERLAY_WINDOWS)
-                .isEqualTo(0);
-    }
-
-    @Test
-    public void isEnabled_isAllowedOverlaySettings_returnFalse() {
-        mActivityController.setup();
-        final TestActivity activity = mActivityController.get();
-        final SharedPreferences editor = activity.getSharedPreferences(
-                OverlaySettingsPreferenceController.SHARE_PERFS,
-                Context.MODE_PRIVATE);
-        editor.edit().putBoolean(OverlaySettingsPreferenceController.SHARE_PERFS, true).apply();
-
-        assertThat(new HideNonSystemOverlayMixin(activity).isEnabled()).isFalse();
-    }
-
-    @Test
-    public void isEnabled_isNotAllowedOverlaySettings_returnTrue() {
-        mActivityController.setup();
-        TestActivity activity = mActivityController.get();
-        final SharedPreferences editor = activity.getSharedPreferences(
-                OverlaySettingsPreferenceController.SHARE_PERFS,
-                Context.MODE_PRIVATE);
-        editor.edit().putBoolean(OverlaySettingsPreferenceController.SHARE_PERFS, false).apply();
-
-        assertThat(new HideNonSystemOverlayMixin(activity).isEnabled()).isTrue();
-    }
-
-    public static class TestActivity extends AppCompatActivity {
-        @Override
-        protected void onCreate(@Nullable Bundle savedInstanceState) {
-            super.onCreate(savedInstanceState);
-            setTheme(R.style.Theme_AppCompat);
-            getLifecycle().addObserver(new HideNonSystemOverlayMixin(this));
-        }
-    }
-}

tests/robotests/src/com/android/settings/homepage/SettingsHomepageActivityTest.java

@@ -35,11 +35,11 @@ import android.widget.FrameLayout;
 import androidx.fragment.app.Fragment;
 
 import com.android.settings.R;
-import com.android.settings.core.HideNonSystemOverlayMixin;
 import com.android.settings.dashboard.suggestions.SuggestionFeatureProviderImpl;
 import com.android.settings.homepage.contextualcards.slices.BatteryFixSliceTest;
 import com.android.settings.testutils.shadow.ShadowUserManager;
 import com.android.settings.testutils.shadow.ShadowUtils;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 
 import org.junit.Before;
 import org.junit.Test;

tests/robotests/src/com/android/settings/panel/SettingsPanelActivityTest.java

@@ -36,8 +36,8 @@ import android.view.WindowManager;
 import androidx.fragment.app.FragmentManager;
 
 import com.android.settings.R;
-import com.android.settings.core.HideNonSystemOverlayMixin;
 import com.android.settings.testutils.FakeFeatureFactory;
+import com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin;
 
 import org.junit.Before;
 import org.junit.Test;

tests/unit/src/com/android/settings/development/OverlaySettingsPreferenceControllerTest.java

@@ -16,10 +16,12 @@
 
 package com.android.settings.development;
 
+import static com.android.settingslib.core.lifecycle.HideNonSystemOverlayMixin.SECURE_OVERLAY_SETTINGS;
+
 import static com.google.common.truth.Truth.assertThat;
 
 import android.content.Context;
-import android.content.SharedPreferences;
+import android.provider.Settings;
 
 import androidx.preference.SwitchPreference;
 import androidx.test.core.app.ApplicationProvider;
@@ -83,20 +85,16 @@ public class OverlaySettingsPreferenceControllerTest {
 
     @Test
     public void isOverlaySettingsEnabled_sharePreferenceSetTrue_shouldReturnTrue() {
-        final SharedPreferences editor = mContext.getSharedPreferences(
+        Settings.Secure.putInt(mContext.getContentResolver(),
-                OverlaySettingsPreferenceController.SHARE_PERFS,
+                SECURE_OVERLAY_SETTINGS, 1);
-                Context.MODE_PRIVATE);
-        editor.edit().putBoolean(OverlaySettingsPreferenceController.SHARE_PERFS, true).apply();
 
         assertThat(OverlaySettingsPreferenceController.isOverlaySettingsEnabled(mContext)).isTrue();
     }
 
     @Test
     public void isOverlaySettingsEnabled_sharePreferenceSetFalse_shouldReturnFalse() {
-        final SharedPreferences editor = mContext.getSharedPreferences(
+        Settings.Secure.putInt(mContext.getContentResolver(),
-                OverlaySettingsPreferenceController.SHARE_PERFS,
+                SECURE_OVERLAY_SETTINGS, 0);
-                Context.MODE_PRIVATE);
-        editor.edit().putBoolean(OverlaySettingsPreferenceController.SHARE_PERFS, false).apply();
 
         assertThat(
                 OverlaySettingsPreferenceController.isOverlaySettingsEnabled(mContext)).isFalse();