src/com/android/settings/wifi/tether/WifiTetherSettings.java - platform/packages/apps/Settings - Git at Google

 /*
  * Copyright (C) 2017 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.wifi.tether;

 import static android.net.TetheringManager.ACTION_TETHER_STATE_CHANGED;
 import static android.net.wifi.WifiManager.WIFI_AP_STATE_CHANGED_ACTION;

 import android.app.settings.SettingsEnums;
 import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
 import android.content.IntentFilter;
 import android.net.wifi.SoftApConfiguration;
 import android.net.wifi.WifiManager;
 import android.os.Bundle;
 import android.os.UserManager;
 import android.util.FeatureFlagUtils;
 import android.util.Log;

 import androidx.annotation.VisibleForTesting;
 import androidx.preference.PreferenceGroup;

 import com.android.settings.R;
 import com.android.settings.SettingsActivity;
 import com.android.settings.core.FeatureFlags;
 import com.android.settings.dashboard.RestrictedDashboardFragment;
 import com.android.settings.search.BaseSearchIndexProvider;
 import com.android.settings.widget.SwitchBar;
 import com.android.settingslib.TetherUtil;
 import com.android.settingslib.core.AbstractPreferenceController;
 import com.android.settingslib.search.SearchIndexable;

 import java.util.ArrayList;
 import java.util.List;

 @SearchIndexable
 public class WifiTetherSettings extends RestrictedDashboardFragment
         implements WifiTetherBasePreferenceController.OnTetherConfigUpdateListener {

     private static final String TAG = "WifiTetherSettings";
     private static final IntentFilter TETHER_STATE_CHANGE_FILTER;
     private static final String KEY_WIFI_TETHER_SCREEN = "wifi_tether_settings_screen";
     private static final int EXPANDED_CHILD_COUNT_WITH_SECURITY_NON = 3;
     private static final int EXPANDED_CHILD_COUNT_DEFAULT = 4;

     @VisibleForTesting
     static final String KEY_WIFI_TETHER_NETWORK_NAME = "wifi_tether_network_name";
     @VisibleForTesting
     static final String KEY_WIFI_TETHER_NETWORK_PASSWORD = "wifi_tether_network_password";
     @VisibleForTesting
     static final String KEY_WIFI_TETHER_AUTO_OFF = "wifi_tether_auto_turn_off";
     @VisibleForTesting
     static final String KEY_WIFI_TETHER_NETWORK_AP_BAND = "wifi_tether_network_ap_band";

     private WifiTetherSwitchBarController mSwitchBarController;
     private WifiTetherSSIDPreferenceController mSSIDPreferenceController;
     private WifiTetherPasswordPreferenceController mPasswordPreferenceController;
     private WifiTetherApBandPreferenceController mApBandPreferenceController;
     private WifiTetherSecurityPreferenceController mSecurityPreferenceController;

     private WifiManager mWifiManager;
     private boolean mRestartWifiApAfterConfigChange;
     private boolean mUnavailable;

     @VisibleForTesting
     TetherChangeReceiver mTetherChangeReceiver;

     static {
         TETHER_STATE_CHANGE_FILTER = new IntentFilter(ACTION_TETHER_STATE_CHANGED);
         TETHER_STATE_CHANGE_FILTER.addAction(WIFI_AP_STATE_CHANGED_ACTION);
     }

     public WifiTetherSettings() {
         super(UserManager.DISALLOW_CONFIG_TETHERING);
     }

     @Override
     public int getMetricsCategory() {
         return SettingsEnums.WIFI_TETHER_SETTINGS;
     }

     @Override
     protected String getLogTag() {
         return "WifiTetherSettings";
     }

     @Override
     public void onCreate(Bundle icicle) {
         super.onCreate(icicle);
         setIfOnlyAvailableForAdmins(true);
         if (isUiRestricted()) {
             mUnavailable = true;
         }
     }

     @Override
     public void onAttach(Context context) {
         super.onAttach(context);
         mWifiManager = (WifiManager) context.getSystemService(Context.WIFI_SERVICE);
         mTetherChangeReceiver = new TetherChangeReceiver();

         mSSIDPreferenceController = use(WifiTetherSSIDPreferenceController.class);
         mSecurityPreferenceController = use(WifiTetherSecurityPreferenceController.class);
         mPasswordPreferenceController = use(WifiTetherPasswordPreferenceController.class);
         mApBandPreferenceController = use(WifiTetherApBandPreferenceController.class);
     }

     @Override
     public void onActivityCreated(Bundle savedInstanceState) {
         super.onActivityCreated(savedInstanceState);
         if (mUnavailable) {
             return;
         }
         // Assume we are in a SettingsActivity. This is only safe because we currently use
         // SettingsActivity as base for all preference fragments.
         final SettingsActivity activity = (SettingsActivity) getActivity();
         final SwitchBar switchBar = activity.getSwitchBar();
         mSwitchBarController = new WifiTetherSwitchBarController(activity, switchBar);
         getSettingsLifecycle().addObserver(mSwitchBarController);
         switchBar.show();
     }

     @Override
     public void onStart() {
         super.onStart();
         if (mUnavailable) {
             if (!isUiRestrictedByOnlyAdmin()) {
                 getEmptyTextView().setText(R.string.tethering_settings_not_available);
             }
             getPreferenceScreen().removeAll();
             return;
         }
         final Context context = getContext();
         if (context != null) {
             context.registerReceiver(mTetherChangeReceiver, TETHER_STATE_CHANGE_FILTER);
         }
     }

     @Override
     public void onStop() {
         super.onStop();
         if (mUnavailable) {
             return;
         }
         final Context context = getContext();
         if (context != null) {
             context.unregisterReceiver(mTetherChangeReceiver);
         }
     }


     @Override
     protected int getPreferenceScreenResId() {
         return R.xml.wifi_tether_settings;
     }

     @Override
     protected List<AbstractPreferenceController> createPreferenceControllers(Context context) {
         return buildPreferenceControllers(context, this::onTetherConfigUpdated);
     }

     private static List<AbstractPreferenceController> buildPreferenceControllers(Context context,
             WifiTetherBasePreferenceController.OnTetherConfigUpdateListener listener) {
         final List<AbstractPreferenceController> controllers = new ArrayList<>();
         controllers.add(new WifiTetherSSIDPreferenceController(context, listener));
         controllers.add(new WifiTetherSecurityPreferenceController(context, listener));
         controllers.add(new WifiTetherPasswordPreferenceController(context, listener));
         controllers.add(new WifiTetherApBandPreferenceController(context, listener));
         controllers.add(
                 new WifiTetherAutoOffPreferenceController(context, KEY_WIFI_TETHER_AUTO_OFF));

         return controllers;
     }

     @Override
     public void onTetherConfigUpdated(AbstractPreferenceController context) {
         final SoftApConfiguration config = buildNewConfig();
         mPasswordPreferenceController.updateVisibility(config.getSecurityType());

         /**
          * if soft AP is stopped, bring up
          * else restart with new config
          * TODO: update config on a running access point when framework support is added
          */
         if (mWifiManager.getWifiApState() == WifiManager.WIFI_AP_STATE_ENABLED) {
             Log.d("TetheringSettings",
                     "Wifi AP config changed while enabled, stop and restart");
             mRestartWifiApAfterConfigChange = true;
             mSwitchBarController.stopTether();
         }
         mWifiManager.setSoftApConfiguration(config);

         if (context instanceof WifiTetherSecurityPreferenceController) {
             reConfigInitialExpandedChildCount();
         }
     }

     private SoftApConfiguration buildNewConfig() {
         final SoftApConfiguration.Builder configBuilder = new SoftApConfiguration.Builder();
         final int securityType = mSecurityPreferenceController.getSecurityType();
         configBuilder.setSsid(mSSIDPreferenceController.getSSID());
         if (securityType == SoftApConfiguration.SECURITY_TYPE_WPA2_PSK) {
             configBuilder.setPassphrase(
                     mPasswordPreferenceController.getPasswordValidated(securityType),
                     SoftApConfiguration.SECURITY_TYPE_WPA2_PSK);
         }
         configBuilder.setBand(mApBandPreferenceController.getBandIndex());
         return configBuilder.build();
     }

     private void startTether() {
         mRestartWifiApAfterConfigChange = false;
         mSwitchBarController.startTether();
     }

     private void updateDisplayWithNewConfig() {
         use(WifiTetherSSIDPreferenceController.class)
                 .updateDisplay();
         use(WifiTetherSecurityPreferenceController.class)
                 .updateDisplay();
         use(WifiTetherPasswordPreferenceController.class)
                 .updateDisplay();
         use(WifiTetherApBandPreferenceController.class)
                 .updateDisplay();
     }

     public static final BaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER =
             new BaseSearchIndexProvider(R.xml.wifi_tether_settings) {

                 @Override
                 public List<String> getNonIndexableKeys(Context context) {
                     final List<String> keys = super.getNonIndexableKeys(context);

                     if (!TetherUtil.isTetherAvailable(context)) {
                         keys.add(KEY_WIFI_TETHER_NETWORK_NAME);
                         keys.add(KEY_WIFI_TETHER_NETWORK_PASSWORD);
                         keys.add(KEY_WIFI_TETHER_AUTO_OFF);
                         keys.add(KEY_WIFI_TETHER_NETWORK_AP_BAND);
                     }

                     // Remove duplicate
                     keys.add(KEY_WIFI_TETHER_SCREEN);
                     return keys;
                 }

                 @Override
                 protected boolean isPageSearchEnabled(Context context) {
                     return !FeatureFlagUtils.isEnabled(context, FeatureFlags.TETHER_ALL_IN_ONE);
                 }

                 @Override
                 public List<AbstractPreferenceController> createPreferenceControllers(
                         Context context) {
                     return buildPreferenceControllers(context, null /* listener */);
                 }
             };

     @VisibleForTesting
     class TetherChangeReceiver extends BroadcastReceiver {
         @Override
         public void onReceive(Context content, Intent intent) {
             String action = intent.getAction();
             Log.d(TAG, "updating display config due to receiving broadcast action " + action);
             updateDisplayWithNewConfig();
             if (action.equals(ACTION_TETHER_STATE_CHANGED)) {
                 if (mWifiManager.getWifiApState() == WifiManager.WIFI_AP_STATE_DISABLED
                         && mRestartWifiApAfterConfigChange) {
                     startTether();
                 }
             } else if (action.equals(WIFI_AP_STATE_CHANGED_ACTION)) {
                 int state = intent.getIntExtra(WifiManager.EXTRA_WIFI_AP_STATE, 0);
                 if (state == WifiManager.WIFI_AP_STATE_DISABLED
                         && mRestartWifiApAfterConfigChange) {
                     startTether();
                 }
             }
         }
     }

     private void reConfigInitialExpandedChildCount() {
         final PreferenceGroup screen = getPreferenceScreen();
         if (mSecurityPreferenceController.getSecurityType()
                 == SoftApConfiguration.SECURITY_TYPE_OPEN) {
             screen.setInitialExpandedChildrenCount(EXPANDED_CHILD_COUNT_WITH_SECURITY_NON);
             return;
         }
         screen.setInitialExpandedChildrenCount(EXPANDED_CHILD_COUNT_DEFAULT);
     }

     @Override
     public int getInitialExpandedChildCount() {
         if (mSecurityPreferenceController == null) {
             return EXPANDED_CHILD_COUNT_DEFAULT;
         }

         return (mSecurityPreferenceController.getSecurityType()
                 == SoftApConfiguration.SECURITY_TYPE_OPEN)
             ? EXPANDED_CHILD_COUNT_WITH_SECURITY_NON : EXPANDED_CHILD_COUNT_DEFAULT;
     }
 }
	/*
	* Copyright (C) 2017 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.wifi.tether;

	import static android.net.TetheringManager.ACTION_TETHER_STATE_CHANGED;
	import static android.net.wifi.WifiManager.WIFI_AP_STATE_CHANGED_ACTION;

	import android.app.settings.SettingsEnums;
	import android.content.BroadcastReceiver;
	import android.content.Context;
	import android.content.Intent;
	import android.content.IntentFilter;
	import android.net.wifi.SoftApConfiguration;
	import android.net.wifi.WifiManager;
	import android.os.Bundle;
	import android.os.UserManager;
	import android.util.FeatureFlagUtils;
	import android.util.Log;

	import androidx.annotation.VisibleForTesting;
	import androidx.preference.PreferenceGroup;

	import com.android.settings.R;
	import com.android.settings.SettingsActivity;
	import com.android.settings.core.FeatureFlags;
	import com.android.settings.dashboard.RestrictedDashboardFragment;
	import com.android.settings.search.BaseSearchIndexProvider;
	import com.android.settings.widget.SwitchBar;
	import com.android.settingslib.TetherUtil;
	import com.android.settingslib.core.AbstractPreferenceController;
	import com.android.settingslib.search.SearchIndexable;

	import java.util.ArrayList;
	import java.util.List;

	@SearchIndexable
	public class WifiTetherSettings extends RestrictedDashboardFragment
	implements WifiTetherBasePreferenceController.OnTetherConfigUpdateListener {

	private static final String TAG = "WifiTetherSettings";
	private static final IntentFilter TETHER_STATE_CHANGE_FILTER;
	private static final String KEY_WIFI_TETHER_SCREEN = "wifi_tether_settings_screen";
	private static final int EXPANDED_CHILD_COUNT_WITH_SECURITY_NON = 3;
	private static final int EXPANDED_CHILD_COUNT_DEFAULT = 4;

	@VisibleForTesting
	static final String KEY_WIFI_TETHER_NETWORK_NAME = "wifi_tether_network_name";
	@VisibleForTesting
	static final String KEY_WIFI_TETHER_NETWORK_PASSWORD = "wifi_tether_network_password";
	@VisibleForTesting
	static final String KEY_WIFI_TETHER_AUTO_OFF = "wifi_tether_auto_turn_off";
	@VisibleForTesting
	static final String KEY_WIFI_TETHER_NETWORK_AP_BAND = "wifi_tether_network_ap_band";

	private WifiTetherSwitchBarController mSwitchBarController;
	private WifiTetherSSIDPreferenceController mSSIDPreferenceController;
	private WifiTetherPasswordPreferenceController mPasswordPreferenceController;
	private WifiTetherApBandPreferenceController mApBandPreferenceController;
	private WifiTetherSecurityPreferenceController mSecurityPreferenceController;

	private WifiManager mWifiManager;
	private boolean mRestartWifiApAfterConfigChange;
	private boolean mUnavailable;

	@VisibleForTesting
	TetherChangeReceiver mTetherChangeReceiver;

	static {
	TETHER_STATE_CHANGE_FILTER = new IntentFilter(ACTION_TETHER_STATE_CHANGED);
	TETHER_STATE_CHANGE_FILTER.addAction(WIFI_AP_STATE_CHANGED_ACTION);
	}

	public WifiTetherSettings() {
	super(UserManager.DISALLOW_CONFIG_TETHERING);
	}

	@Override
	public int getMetricsCategory() {
	return SettingsEnums.WIFI_TETHER_SETTINGS;
	}

	@Override
	protected String getLogTag() {
	return "WifiTetherSettings";
	}

	@Override
	public void onCreate(Bundle icicle) {
	super.onCreate(icicle);
	setIfOnlyAvailableForAdmins(true);
	if (isUiRestricted()) {
	mUnavailable = true;
	}
	}

	@Override
	public void onAttach(Context context) {
	super.onAttach(context);
	mWifiManager = (WifiManager) context.getSystemService(Context.WIFI_SERVICE);
	mTetherChangeReceiver = new TetherChangeReceiver();

	mSSIDPreferenceController = use(WifiTetherSSIDPreferenceController.class);
	mSecurityPreferenceController = use(WifiTetherSecurityPreferenceController.class);
	mPasswordPreferenceController = use(WifiTetherPasswordPreferenceController.class);
	mApBandPreferenceController = use(WifiTetherApBandPreferenceController.class);
	}

	@Override
	public void onActivityCreated(Bundle savedInstanceState) {
	super.onActivityCreated(savedInstanceState);
	if (mUnavailable) {
	return;
	}
	// Assume we are in a SettingsActivity. This is only safe because we currently use
	// SettingsActivity as base for all preference fragments.
	final SettingsActivity activity = (SettingsActivity) getActivity();
	final SwitchBar switchBar = activity.getSwitchBar();
	mSwitchBarController = new WifiTetherSwitchBarController(activity, switchBar);
	getSettingsLifecycle().addObserver(mSwitchBarController);
	switchBar.show();
	}

	@Override
	public void onStart() {
	super.onStart();
	if (mUnavailable) {
	if (!isUiRestrictedByOnlyAdmin()) {
	getEmptyTextView().setText(R.string.tethering_settings_not_available);
	}
	getPreferenceScreen().removeAll();
	return;
	}
	final Context context = getContext();
	if (context != null) {
	context.registerReceiver(mTetherChangeReceiver, TETHER_STATE_CHANGE_FILTER);
	}
	}

	@Override
	public void onStop() {
	super.onStop();
	if (mUnavailable) {
	return;
	}
	final Context context = getContext();
	if (context != null) {
	context.unregisterReceiver(mTetherChangeReceiver);
	}
	}


	@Override
	protected int getPreferenceScreenResId() {
	return R.xml.wifi_tether_settings;
	}

	@Override
	protected List<AbstractPreferenceController> createPreferenceControllers(Context context) {
	return buildPreferenceControllers(context, this::onTetherConfigUpdated);
	}

	private static List<AbstractPreferenceController> buildPreferenceControllers(Context context,
	WifiTetherBasePreferenceController.OnTetherConfigUpdateListener listener) {
	final List<AbstractPreferenceController> controllers = new ArrayList<>();
	controllers.add(new WifiTetherSSIDPreferenceController(context, listener));
	controllers.add(new WifiTetherSecurityPreferenceController(context, listener));
	controllers.add(new WifiTetherPasswordPreferenceController(context, listener));
	controllers.add(new WifiTetherApBandPreferenceController(context, listener));
	controllers.add(
	new WifiTetherAutoOffPreferenceController(context, KEY_WIFI_TETHER_AUTO_OFF));

	return controllers;
	}

	@Override
	public void onTetherConfigUpdated(AbstractPreferenceController context) {
	final SoftApConfiguration config = buildNewConfig();
	mPasswordPreferenceController.updateVisibility(config.getSecurityType());

	/**
	* if soft AP is stopped, bring up
	* else restart with new config
	* TODO: update config on a running access point when framework support is added
	*/
	if (mWifiManager.getWifiApState() == WifiManager.WIFI_AP_STATE_ENABLED) {
	Log.d("TetheringSettings",
	"Wifi AP config changed while enabled, stop and restart");
	mRestartWifiApAfterConfigChange = true;
	mSwitchBarController.stopTether();
	}
	mWifiManager.setSoftApConfiguration(config);

	if (context instanceof WifiTetherSecurityPreferenceController) {
	reConfigInitialExpandedChildCount();
	}
	}

	private SoftApConfiguration buildNewConfig() {
	final SoftApConfiguration.Builder configBuilder = new SoftApConfiguration.Builder();
	final int securityType = mSecurityPreferenceController.getSecurityType();
	configBuilder.setSsid(mSSIDPreferenceController.getSSID());
	if (securityType == SoftApConfiguration.SECURITY_TYPE_WPA2_PSK) {
	configBuilder.setPassphrase(
	mPasswordPreferenceController.getPasswordValidated(securityType),
	SoftApConfiguration.SECURITY_TYPE_WPA2_PSK);
	}
	configBuilder.setBand(mApBandPreferenceController.getBandIndex());
	return configBuilder.build();
	}

	private void startTether() {
	mRestartWifiApAfterConfigChange = false;
	mSwitchBarController.startTether();
	}

	private void updateDisplayWithNewConfig() {
	use(WifiTetherSSIDPreferenceController.class)
	.updateDisplay();
	use(WifiTetherSecurityPreferenceController.class)
	.updateDisplay();
	use(WifiTetherPasswordPreferenceController.class)
	.updateDisplay();
	use(WifiTetherApBandPreferenceController.class)
	.updateDisplay();
	}

	public static final BaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER =
	new BaseSearchIndexProvider(R.xml.wifi_tether_settings) {

	@Override
	public List<String> getNonIndexableKeys(Context context) {
	final List<String> keys = super.getNonIndexableKeys(context);

	if (!TetherUtil.isTetherAvailable(context)) {
	keys.add(KEY_WIFI_TETHER_NETWORK_NAME);
	keys.add(KEY_WIFI_TETHER_NETWORK_PASSWORD);
	keys.add(KEY_WIFI_TETHER_AUTO_OFF);
	keys.add(KEY_WIFI_TETHER_NETWORK_AP_BAND);
	}

	// Remove duplicate
	keys.add(KEY_WIFI_TETHER_SCREEN);
	return keys;
	}

	@Override
	protected boolean isPageSearchEnabled(Context context) {
	return !FeatureFlagUtils.isEnabled(context, FeatureFlags.TETHER_ALL_IN_ONE);
	}

	@Override
	public List<AbstractPreferenceController> createPreferenceControllers(
	Context context) {
	return buildPreferenceControllers(context, null /* listener */);
	}
	};

	@VisibleForTesting
	class TetherChangeReceiver extends BroadcastReceiver {
	@Override
	public void onReceive(Context content, Intent intent) {
	String action = intent.getAction();
	Log.d(TAG, "updating display config due to receiving broadcast action " + action);
	updateDisplayWithNewConfig();
	if (action.equals(ACTION_TETHER_STATE_CHANGED)) {
	if (mWifiManager.getWifiApState() == WifiManager.WIFI_AP_STATE_DISABLED
	&& mRestartWifiApAfterConfigChange) {
	startTether();
	}
	} else if (action.equals(WIFI_AP_STATE_CHANGED_ACTION)) {
	int state = intent.getIntExtra(WifiManager.EXTRA_WIFI_AP_STATE, 0);
	if (state == WifiManager.WIFI_AP_STATE_DISABLED
	&& mRestartWifiApAfterConfigChange) {
	startTether();
	}
	}
	}
	}

	private void reConfigInitialExpandedChildCount() {
	final PreferenceGroup screen = getPreferenceScreen();
	if (mSecurityPreferenceController.getSecurityType()
	== SoftApConfiguration.SECURITY_TYPE_OPEN) {
	screen.setInitialExpandedChildrenCount(EXPANDED_CHILD_COUNT_WITH_SECURITY_NON);
	return;
	}
	screen.setInitialExpandedChildrenCount(EXPANDED_CHILD_COUNT_DEFAULT);
	}

	@Override
	public int getInitialExpandedChildCount() {
	if (mSecurityPreferenceController == null) {
	return EXPANDED_CHILD_COUNT_DEFAULT;
	}

	return (mSecurityPreferenceController.getSecurityType()
	== SoftApConfiguration.SECURITY_TYPE_OPEN)
	? EXPANDED_CHILD_COUNT_WITH_SECURITY_NON : EXPANDED_CHILD_COUNT_DEFAULT;
	}
	}