Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e92e07eb authored by Antony Sargent's avatar Antony Sargent
Browse files

Add subscriptions list to the multi-network header 

The new UX for showing multiple active mobile plan subscriptions (SIMs,
eSIMs, etc.)  needs a header at the top of the Network & internet page
that shows wifi status and a list of active mobile subscriptions in the
form of one Preference per subscription.

This CL adds display of the mobile subscriptions to this header. It does
not yet show the correct summary text or do anything when you tap on
them - that will be coming in subsequent CLs. Also, since adding a
variable number of items to the top of the page messes up our current
strategy of having a fixed number of hidden items at the bottom based on
overall item count, this CL just makes all items visible. Subsequent CLs
can restore this behavior with dynamic adjustment.

Bug: 116349402
Test: make RunSettingsRoboTests
Change-Id: Ibfadf8cb61f6f5aff6ce38b7974267b1e4ddc719
parent 3f5966bb

res/xml/network_and_internet_v2.xml

+1 −2
Original line number Diff line number Diff line
@@ -18,8 +18,7 @@ 
    xmlns:android="http://schemas.android.com/apk/res/android"

    xmlns:settings="http://schemas.android.com/apk/res-auto"

    android:key="network_and_internet_screen"

    android:title="@string/network_dashboard_title"

    settings:initialExpandedChildrenCount="5">

    android:title="@string/network_dashboard_title">



    <PreferenceCategory

        android:key="multi_network_header"

src/com/android/settings/network/MultiNetworkHeaderController.java

+40 −3
Original line number Diff line number Diff line
@@ -19,18 +19,55 @@ package com.android.settings.network; 
import android.content.Context;



import com.android.settings.core.BasePreferenceController;

import com.android.settingslib.core.lifecycle.Lifecycle;



import androidx.annotation.VisibleForTesting;

import androidx.preference.PreferenceCategory;

import androidx.preference.PreferenceScreen;



// This controls a header at the top of the Network & internet page that only appears when there

// are two or more active mobile subscriptions. It shows an overview of available network

// connections with an entry for wifi (if connected) and an entry for each subscription.

public class MultiNetworkHeaderController extends BasePreferenceController {

public class MultiNetworkHeaderController extends BasePreferenceController implements

        SubscriptionsPreferenceController.UpdateListener {

    public static final String TAG = "MultiNetworkHdrCtrl";



    private SubscriptionsPreferenceController mSubscriptionsController;

    private PreferenceCategory mPreferenceCategory;



    public MultiNetworkHeaderController(Context context, String key) {

        super(context, key);

    }



    public void init(Lifecycle lifecycle) {

        mSubscriptionsController = createSubscriptionsController(lifecycle);

        // TODO(asargent) - add in a controller for showing wifi status here

    }



    @VisibleForTesting

    SubscriptionsPreferenceController createSubscriptionsController(Lifecycle lifecycle) {

        return new SubscriptionsPreferenceController(mContext, lifecycle, this, mPreferenceKey, 10);

    }



    @Override

    public void displayPreference(PreferenceScreen screen) {

        super.displayPreference(screen);

        mPreferenceCategory = (PreferenceCategory) screen.findPreference(mPreferenceKey);

        mPreferenceCategory.setVisible(isAvailable());

        mSubscriptionsController.displayPreference(screen);

    }



    @Override

    public int getAvailabilityStatus() {

        return UNSUPPORTED_ON_DEVICE;

        if (mSubscriptionsController == null || !mSubscriptionsController.isAvailable()) {

            return CONDITIONALLY_UNAVAILABLE;

        } else {

            return AVAILABLE;

        }

    }



    @Override

    public void onChildrenUpdated() {

        mPreferenceCategory.setVisible(isAvailable());

    }

}

src/com/android/settings/network/NetworkDashboardFragment.java

+3 −0
Original line number Diff line number Diff line
@@ -72,6 +72,9 @@ public class NetworkDashboardFragment extends DashboardFragment implements 
    public void onAttach(Context context) {

        super.onAttach(context);



        if (FeatureFlagUtils.isEnabled(context, FeatureFlags.NETWORK_INTERNET_V2)) {

            use(MultiNetworkHeaderController.class).init(getSettingsLifecycle());

        }

        use(AirplaneModePreferenceController.class).setFragment(this);

    }

src/com/android/settings/network/SubscriptionUtil.java

+12 −0
Original line number Diff line number Diff line
@@ -24,8 +24,20 @@ import java.util.ArrayList; 
import java.util.Iterator;

import java.util.List;



import androidx.annotation.VisibleForTesting;



public class SubscriptionUtil {

    private static List<SubscriptionInfo> sResultsForTesting;



    @VisibleForTesting

    static void setAvailableSubscriptionsForTesting(List<SubscriptionInfo> results) {

        sResultsForTesting = results;

    }



    public static List<SubscriptionInfo> getAvailableSubscriptions(SubscriptionManager manager) {

        if (sResultsForTesting != null) {

            return sResultsForTesting;

        }

        List<SubscriptionInfo> subscriptions = manager.getAvailableSubscriptionInfoList();

        if (subscriptions == null) {

            subscriptions = new ArrayList<>();

src/com/android/settings/network/SubscriptionsPreferenceController.java

0 → 100644
+183 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2018 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 androidx.lifecycle.Lifecycle.Event.ON_PAUSE;

import static androidx.lifecycle.Lifecycle.Event.ON_RESUME;



import android.content.Context;

import android.telephony.SubscriptionInfo;

import android.telephony.SubscriptionManager;



import com.android.settings.R;

import com.android.settingslib.core.AbstractPreferenceController;



import java.util.Map;



import androidx.collection.ArrayMap;

import androidx.lifecycle.Lifecycle;

import androidx.lifecycle.LifecycleObserver;

import androidx.lifecycle.OnLifecycleEvent;

import androidx.preference.Preference;

import androidx.preference.PreferenceGroup;

import androidx.preference.PreferenceScreen;



/**

 * This manages a set of Preferences it places into a PreferenceGroup owned by some parent

 * controller class - one for each available subscription. This controller is only considered

 * available if there are 2 or more subscriptions.

 */

public class SubscriptionsPreferenceController extends AbstractPreferenceController implements

        LifecycleObserver, SubscriptionsChangeListener.SubscriptionsChangeListenerClient {

    private static final String TAG = "SubscriptionsPrefCntrlr";



    private UpdateListener mUpdateListener;

    private String mPreferenceGroupKey;

    private PreferenceGroup mPreferenceGroup;

    private SubscriptionManager mManager;

    private SubscriptionsChangeListener mSubscriptionsListener;



    // Map of subscription id to Preference

    private Map<Integer, Preference> mSubscriptionPreferences;

    private int mStartOrder;



    /**

     * This interface lets a parent of this class know that some change happened - this could

     * either be because overall availability changed, or because we've added/removed/updated some

     * preferences.

     */

    public interface UpdateListener {

        void onChildrenUpdated();

    }



    /**

     * @param context            the context for the UI where we're placing these preferences

     * @param lifecycle          for listening to lifecycle events for the UI

     * @param updateListener     called to let our parent controller know that our availability has

     *                           changed, or that one or more of the preferences we've placed in the

     *                           PreferenceGroup has changed

     * @param preferenceGroupKey the key used to lookup the PreferenceGroup where Preferences will

     *                           be placed

     * @param startOrder         the order that should be given to the first Preference placed into

     *                           the PreferenceGroup; the second will use startOrder+1, third will

     *                           use startOrder+2, etc. - this is useful for when the parent wants

     *                           to have other preferences in the same PreferenceGroup and wants

     *                           a specific ordering relative to this controller's prefs.

     */

    public SubscriptionsPreferenceController(Context context, Lifecycle lifecycle,

            UpdateListener updateListener, String preferenceGroupKey, int startOrder) {

        super(context);

        mUpdateListener = updateListener;

        mPreferenceGroupKey = preferenceGroupKey;

        mStartOrder = startOrder;

        mManager = context.getSystemService(SubscriptionManager.class);

        mSubscriptionPreferences = new ArrayMap<>();

        mSubscriptionsListener = new SubscriptionsChangeListener(context, this);

        lifecycle.addObserver(this);

    }



    @OnLifecycleEvent(ON_RESUME)

    public void onResume() {

        mSubscriptionsListener.start();

        update();

    }



    @OnLifecycleEvent(ON_PAUSE)

    public void onPause() {

        mSubscriptionsListener.stop();

    }



    @Override

    public void displayPreference(PreferenceScreen screen) {

        mPreferenceGroup = (PreferenceGroup) screen.findPreference(mPreferenceGroupKey);

        update();

    }



    private void update() {

        if (mPreferenceGroup == null) {

            return;

        }



        if (mSubscriptionsListener.isAirplaneModeOn()) {

            for (Preference pref : mSubscriptionPreferences.values()) {

                mPreferenceGroup.removePreference(pref);

            }

            mSubscriptionPreferences.clear();

            mUpdateListener.onChildrenUpdated();

            return;

        }



        final Map<Integer, Preference> existingPrefs = mSubscriptionPreferences;

        mSubscriptionPreferences = new ArrayMap<>();



        int order = mStartOrder;

        for (SubscriptionInfo info :  SubscriptionUtil.getAvailableSubscriptions(mManager) ) {

            final int subId = info.getSubscriptionId();

            Preference pref = existingPrefs.remove(subId);

            if (pref == null) {

                pref = new Preference(mPreferenceGroup.getContext());

                mPreferenceGroup.addPreference(pref);

            }

            pref.setTitle(info.getDisplayName());

            pref.setIcon(R.drawable.ic_network_cell);

            pref.setOrder(order++);



            // TODO(asargent) - set summary here to indicate default for calls/sms and data



            pref.setOnPreferenceClickListener(clickedPref -> {

                // TODO(asargent) - make this start MobileNetworkActivity once we've

                // added support for it to take a subscription id

                return true;

            });



            mSubscriptionPreferences.put(subId, pref);

        }



        // Remove any old preferences that no longer map to a subscription.

        for (Preference pref : existingPrefs.values()) {

            mPreferenceGroup.removePreference(pref);

        }

        mUpdateListener.onChildrenUpdated();

    }



    /**

     *

     * @return true if there are at least 2 available subscriptions.

     */

    @Override

    public boolean isAvailable() {

        if (mSubscriptionsListener.isAirplaneModeOn()) {

            return false;

        }

        return SubscriptionUtil.getAvailableSubscriptions(mManager).size() >= 2;

    }



    @Override

    public String getPreferenceKey() {

        return null;

    }



    @Override

    public void onAirplaneModeChanged(boolean airplaneModeEnabled) {

        update();

    }



    @Override

    public void onSubscriptionsChanged() {

        update();

    }

}