src/com/android/car/settings/wifi/details/WifiDetailsBasePreferenceController.java

/*
 * 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.car.settings.wifi.details;

import android.car.drivingstate.CarUxRestrictions;
import android.content.Context;
import android.net.LinkProperties;
import android.net.Network;
import android.net.NetworkCapabilities;
import android.net.NetworkInfo;
import android.net.wifi.WifiConfiguration;
import android.net.wifi.WifiInfo;

import androidx.preference.Preference;

import com.android.car.settings.common.FragmentController;
import com.android.car.settings.common.PreferenceController;
import com.android.car.settings.wifi.WifiUtil;
import com.android.settingslib.wifi.AccessPoint;

/**
 * Controller for logic pertaining to displaying Wifi information. Only available when wifi is
 * active.
 *
 * <p>Subclasses should use
 * {@link com.android.car.settings.common.PreferenceController#updateState(Preference)} to render UI
 * with latest info if desired.
 *
 * @param <V> the upper bound on the type of {@link Preference} on which the controller
 *            expects to operate.
 */
public abstract class WifiDetailsBasePreferenceController<V extends Preference> extends
        PreferenceController<V> implements WifiInfoProvider.Listener {

    private AccessPoint mAccessPoint;
    private WifiInfoProvider mWifiInfoProvider;

    public WifiDetailsBasePreferenceController(Context context, String preferenceKey,
            FragmentController fragmentController, CarUxRestrictions uxRestrictions) {
        super(context, preferenceKey, fragmentController, uxRestrictions);
    }

    /**
     * Sets all parameters for the controller to run, need to get called as early as possible.
     */
    public WifiDetailsBasePreferenceController init(
            AccessPoint accessPoint, WifiInfoProvider wifiInfoProvider) {
        mAccessPoint = accessPoint;
        mWifiInfoProvider = wifiInfoProvider;
        return this;
    }

    /** Gets the access poing that this controller was initialized with. */
    protected AccessPoint getAccessPoint() {
        return mAccessPoint;
    }

    /** Gets the wifi info provider that this controller was initialized with. */
    protected WifiInfoProvider getWifiInfoProvider() {
        return mWifiInfoProvider;
    }

    @Override
    protected void onStartInternal() {
        mWifiInfoProvider.addListener(this);
    }

    @Override
    protected void onStopInternal() {
        mWifiInfoProvider.removeListener(this);
    }

    @Override
    public void onWifiConfigurationChanged(WifiConfiguration wifiConfiguration,
            NetworkInfo networkInfo, WifiInfo wifiInfo) {
        refreshUi();
    }

    @Override
    public void onLinkPropertiesChanged(Network network, LinkProperties lp) {
        refreshUi();
    }

    @Override
    public void onCapabilitiesChanged(Network network, NetworkCapabilities nc) {
    }

    @Override
    public void onWifiChanged(NetworkInfo networkInfo, WifiInfo wifiInfo) {
        getPreference().setEnabled(true);
        refreshUi();
    }

    @Override
    public void onLost(Network network) {
        getPreference().setEnabled(false);
        refreshUi();
    }

    @Override
    protected int getAvailabilityStatus() {
        if (!WifiUtil.isWifiAvailable(getContext())) {
            return UNSUPPORTED_ON_DEVICE;
        }
        return getAccessPoint().isActive() ? AVAILABLE : CONDITIONALLY_UNAVAILABLE;
    }
}