From 845db3499dbac3c64c993aabf8c5f0eac3791e7d Mon Sep 17 00:00:00 2001
From: Weng Su <wengsu@google.com>
Date: Mon, 23 Nov 2020 16:36:14 +0000
Subject: [PATCH] [Provider Model] Add Airplane-safe Networks preference

- Hide the preference when airplane mode is off.

- Reuse PrimarySwitchPreference for RestrictedSwitchPreference

- Screenshot
  https://screenshot.googleplex.com/8HiC5sc8xaqnhz5

Bug: 174022082
Test: atest -c AirplaneSafeNetworksPreferenceControllerTest
Change-Id: I06a56e8e815778cebf200c4a486c414e92f4cb87
---
 res/xml/network_provider_internet.xml         |   7 +-
 ...planeSafeNetworksPreferenceController.java | 106 ++++++++++++++++
 .../network/NetworkDashboardFragment.java     |   1 +
 .../widget/PrimarySwitchController.java       |  47 +++++--
 ...eSafeNetworksPreferenceControllerTest.java | 118 ++++++++++++++++++
 5 files changed, 265 insertions(+), 14 deletions(-)
 create mode 100644 src/com/android/settings/network/AirplaneSafeNetworksPreferenceController.java
 create mode 100644 tests/unit/src/com/android/settings/network/AirplaneSafeNetworksPreferenceControllerTest.java

diff --git a/res/xml/network_provider_internet.xml b/res/xml/network_provider_internet.xml
index a0794780430..20cf2be9dea 100644
--- a/res/xml/network_provider_internet.xml
+++ b/res/xml/network_provider_internet.xml
@@ -57,18 +57,17 @@
         android:key="airplane_mode"
         android:title="@string/airplane_mode"
         android:icon="@drawable/ic_airplanemode_active"
-        android:disableDependentsState="true"
         android:order="-5"
         settings:controller="com.android.settings.network.AirplaneModePreferenceController"
         settings:userRestriction="no_airplane_mode"/>
 
-    <SwitchPreference
+    <com.android.settingslib.RestrictedSwitchPreference
         android:key="airplane_safe_networks"
         android:title="@string/airplane_safe_networks"
         android:icon="@drawable/ic_airplanemode_active"
-        android:order="-4"
         android:summary="@string/airplane_safe_networks_summary"
-        settings:controller="com.android.settings.network.AirplaneSafeNetworkModePreferenceController"
+        android:order="-4"
+        settings:userRestriction="no_airplane_mode"
         settings:keywords="@string/keywords_airplane_safe_networks" />
 
     <com.android.settingslib.RestrictedPreference
diff --git a/src/com/android/settings/network/AirplaneSafeNetworksPreferenceController.java b/src/com/android/settings/network/AirplaneSafeNetworksPreferenceController.java
new file mode 100644
index 00000000000..2b5e66b2812
--- /dev/null
+++ b/src/com/android/settings/network/AirplaneSafeNetworksPreferenceController.java
@@ -0,0 +1,106 @@
+/*
+ * Copyright (C) 2020 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.network;
+
+import android.content.Context;
+
+import androidx.lifecycle.Lifecycle;
+import androidx.lifecycle.LifecycleObserver;
+import androidx.lifecycle.OnLifecycleEvent;
+import androidx.preference.PreferenceScreen;
+
+import com.android.settings.AirplaneModeEnabler;
+import com.android.settings.overlay.FeatureFactory;
+import com.android.settings.widget.PrimarySwitchController;
+import com.android.settings.wifi.WifiEnabler;
+import com.android.settingslib.RestrictedSwitchPreference;
+import com.android.settingslib.core.AbstractPreferenceController;
+
+public class AirplaneSafeNetworksPreferenceController extends AbstractPreferenceController
+        implements LifecycleObserver, AirplaneModeEnabler.OnAirplaneModeChangedListener {
+
+    private static final String PREFERENCE_KEY = "airplane_safe_networks";
+
+    private RestrictedSwitchPreference mPreference;
+
+    private AirplaneModeEnabler mAirplaneModeEnabler;
+    private WifiEnabler mWifiEnabler;
+
+    public AirplaneSafeNetworksPreferenceController(Context context, Lifecycle lifecycle) {
+        super(context);
+        if (lifecycle == null) {
+            throw new IllegalArgumentException("Lifecycle must be set");
+        }
+
+        mAirplaneModeEnabler = new AirplaneModeEnabler(mContext, this);
+        lifecycle.addObserver(this);
+    }
+
+    @Override
+    public String getPreferenceKey() {
+        return PREFERENCE_KEY;
+    }
+
+    @Override
+    public boolean isAvailable() {
+        return mAirplaneModeEnabler.isAirplaneModeOn();
+    }
+
+    @Override
+    public void displayPreference(PreferenceScreen screen) {
+        super.displayPreference(screen);
+        mPreference = screen.findPreference(getPreferenceKey());
+    }
+
+    @OnLifecycleEvent(Lifecycle.Event.ON_START)
+    public void onStart() {
+        mAirplaneModeEnabler.start();
+        if (mPreference != null) {
+            mWifiEnabler = new WifiEnabler(mContext, new PrimarySwitchController(mPreference),
+                    FeatureFactory.getFactory(mContext).getMetricsFeatureProvider());
+        }
+    }
+
+    @OnLifecycleEvent(Lifecycle.Event.ON_STOP)
+    public void onStop() {
+        mAirplaneModeEnabler.stop();
+        if (mWifiEnabler != null) {
+            mWifiEnabler.teardownSwitchController();
+        }
+    }
+
+    @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
+    public void onResume() {
+        if (mWifiEnabler != null) {
+            mWifiEnabler.resume(mContext);
+        }
+    }
+
+    @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
+    public void onPause() {
+        if (mWifiEnabler != null) {
+            mWifiEnabler.pause();
+        }
+    }
+
+    @Override
+    public void onAirplaneModeChanged(boolean isAirplaneModeOn) {
+        if (mPreference != null) {
+            mPreference.setVisible(isAirplaneModeOn);
+        }
+    }
+}
diff --git a/src/com/android/settings/network/NetworkDashboardFragment.java b/src/com/android/settings/network/NetworkDashboardFragment.java
index 76a84bb43b8..e56db27d697 100644
--- a/src/com/android/settings/network/NetworkDashboardFragment.java
+++ b/src/com/android/settings/network/NetworkDashboardFragment.java
@@ -147,6 +147,7 @@ public class NetworkDashboardFragment extends DashboardFragment implements
         controllers.add(privateDnsPreferenceController);
         if (Utils.isProviderModelEnabled(context)) {
             controllers.add(new NetworkProviderCallsSmsController(context, lifecycle));
+            controllers.add(new AirplaneSafeNetworksPreferenceController(context, lifecycle));
         }
         return controllers;
     }
diff --git a/src/com/android/settings/widget/PrimarySwitchController.java b/src/com/android/settings/widget/PrimarySwitchController.java
index 3718a89df79..b9fc58fdd29 100644
--- a/src/com/android/settings/widget/PrimarySwitchController.java
+++ b/src/com/android/settings/widget/PrimarySwitchController.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2017 The Android Open Source Project
+ * Copyright (C) 2020 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.
@@ -21,22 +21,32 @@ import androidx.preference.Preference;
 import com.android.settings.dashboard.DashboardFragment;
 import com.android.settings.overlay.FeatureFactory;
 import com.android.settingslib.RestrictedLockUtils.EnforcedAdmin;
+import com.android.settingslib.RestrictedSwitchPreference;
 import com.android.settingslib.core.instrumentation.MetricsFeatureProvider;
 
 /**
  * The switch controller that is used to update the switch widget in the PrimarySwitchPreference
- * layout.
+ * and RestrictedSwitchPreference layouts.
  */
+// TODO(b/174022082): Modify the class name to GenericSwitchController.
 public class PrimarySwitchController extends SwitchWidgetController implements
         Preference.OnPreferenceChangeListener {
 
-    private final PrimarySwitchPreference mPreference;
-    private final MetricsFeatureProvider mMetricsFeatureProvider;
+    private Preference mPreference;
+    private MetricsFeatureProvider mMetricsFeatureProvider;
 
     public PrimarySwitchController(PrimarySwitchPreference preference) {
+        setPreference(preference);
+    }
+
+    public PrimarySwitchController(RestrictedSwitchPreference preference) {
+        setPreference(preference);
+    }
+
+    private void setPreference(Preference preference) {
         mPreference = preference;
-        mMetricsFeatureProvider = FeatureFactory.getFactory(preference.getContext())
-                .getMetricsFeatureProvider();
+        mMetricsFeatureProvider =
+                FeatureFactory.getFactory(preference.getContext()).getMetricsFeatureProvider();
     }
 
     @Override
@@ -55,17 +65,30 @@ public class PrimarySwitchController extends SwitchWidgetController implements
 
     @Override
     public void setChecked(boolean checked) {
-        mPreference.setChecked(checked);
+        if (mPreference instanceof PrimarySwitchPreference) {
+            ((PrimarySwitchPreference) mPreference).setChecked(checked);
+        } else if (mPreference instanceof RestrictedSwitchPreference) {
+            ((RestrictedSwitchPreference) mPreference).setChecked(checked);
+        }
     }
 
     @Override
     public boolean isChecked() {
-        return mPreference.isChecked();
+        if (mPreference instanceof PrimarySwitchPreference) {
+            return ((PrimarySwitchPreference) mPreference).isChecked();
+        } else if (mPreference instanceof RestrictedSwitchPreference) {
+            return ((RestrictedSwitchPreference) mPreference).isChecked();
+        }
+        return false;
     }
 
     @Override
     public void setEnabled(boolean enabled) {
-        mPreference.setSwitchEnabled(enabled);
+        if (mPreference instanceof PrimarySwitchPreference) {
+            ((PrimarySwitchPreference) mPreference).setSwitchEnabled(enabled);
+        } else if (mPreference instanceof RestrictedSwitchPreference) {
+            ((RestrictedSwitchPreference) mPreference).setEnabled(enabled);
+        }
     }
 
     @Override
@@ -83,6 +106,10 @@ public class PrimarySwitchController extends SwitchWidgetController implements
 
     @Override
     public void setDisabledByAdmin(EnforcedAdmin admin) {
-        mPreference.setDisabledByAdmin(admin);
+        if (mPreference instanceof PrimarySwitchPreference) {
+            ((PrimarySwitchPreference) mPreference).setDisabledByAdmin(admin);
+        } else if (mPreference instanceof RestrictedSwitchPreference) {
+            ((RestrictedSwitchPreference) mPreference).setDisabledByAdmin(admin);
+        }
     }
 }
diff --git a/tests/unit/src/com/android/settings/network/AirplaneSafeNetworksPreferenceControllerTest.java b/tests/unit/src/com/android/settings/network/AirplaneSafeNetworksPreferenceControllerTest.java
new file mode 100644
index 00000000000..4c4c5bd7783
--- /dev/null
+++ b/tests/unit/src/com/android/settings/network/AirplaneSafeNetworksPreferenceControllerTest.java
@@ -0,0 +1,118 @@
+/*
+ * Copyright (C) 2020 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.network;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.spy;
+
+import android.content.ContentResolver;
+import android.content.Context;
+import android.net.wifi.WifiManager;
+import android.os.Looper;
+import android.provider.Settings;
+
+import androidx.preference.PreferenceManager;
+import androidx.preference.PreferenceScreen;
+import androidx.test.core.app.ApplicationProvider;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+
+import com.android.settingslib.RestrictedSwitchPreference;
+import com.android.settingslib.core.lifecycle.Lifecycle;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+@RunWith(AndroidJUnit4.class)
+public class AirplaneSafeNetworksPreferenceControllerTest {
+
+    private static final String KEY_AIRPLANE_SAFE_NETWORKS = "airplane_safe_networks";
+
+    private static final int ON = 1;
+    private static final int OFF = 0;
+
+    private ContentResolver mResolver;
+    private PreferenceScreen mScreen;
+    private RestrictedSwitchPreference mPreference;
+    private AirplaneSafeNetworksPreferenceController mController;
+
+    @Mock
+    private WifiManager mWifiManager;
+
+    @Before
+    public void setUp() {
+        MockitoAnnotations.initMocks(this);
+        final Context context = spy(ApplicationProvider.getApplicationContext());
+        mResolver = context.getContentResolver();
+        doReturn(mWifiManager).when(context).getSystemService(Context.WIFI_SERVICE);
+
+        mController = new AirplaneSafeNetworksPreferenceController(context, mock(Lifecycle.class));
+        if (Looper.myLooper() == null) {
+            Looper.prepare();
+        }
+        final PreferenceManager preferenceManager = new PreferenceManager(context);
+        mScreen = preferenceManager.createPreferenceScreen(context);
+        mPreference = new RestrictedSwitchPreference(context);
+        mPreference.setKey(KEY_AIRPLANE_SAFE_NETWORKS);
+        mScreen.addPreference(mPreference);
+    }
+
+    @Test
+    public void isAvailable_airplaneModeOff_returnFalse() {
+        Settings.Global.putInt(mResolver, Settings.Global.AIRPLANE_MODE_ON, OFF);
+
+        mController.displayPreference(mScreen);
+        mController.onStart();
+
+        assertThat(mController.isAvailable()).isFalse();
+    }
+
+    @Test
+    public void isAvailable_airplaneModeOn_returnTrue() {
+        Settings.Global.putInt(mResolver, Settings.Global.AIRPLANE_MODE_ON, ON);
+
+        mController.displayPreference(mScreen);
+        mController.onStart();
+
+        assertThat(mController.isAvailable()).isTrue();
+    }
+
+    @Test
+    public void isChecked_wifiStateDisabled_returnFalse() {
+        doReturn(WifiManager.WIFI_STATE_DISABLED).when(mWifiManager).getWifiState();
+
+        mController.displayPreference(mScreen);
+        mController.onStart();
+
+        assertThat(mPreference.isChecked()).isFalse();
+    }
+
+    @Test
+    public void isChecked_wifiStateEnabled_returnTrue() {
+        doReturn(WifiManager.WIFI_STATE_ENABLED).when(mWifiManager).getWifiState();
+
+        mController.displayPreference(mScreen);
+        mController.onStart();
+
+        assertThat(mPreference.isChecked()).isTrue();
+    }
+}