blob: fc2f8f1541565f85edecc29982ce9caf6c782a34 [file] [log] [blame]
Antony Sargent74cb7242018-12-14 12:45:04 -08001/*
2 * Copyright (C) 2018 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.settings.wifi;
18
19import android.content.Context;
20import android.os.Bundle;
Arc Wangebf8ffd2020-03-27 16:24:02 +080021import android.os.Handler;
22import android.os.HandlerThread;
23import android.os.Looper;
24import android.os.Process;
25import android.os.SimpleClock;
26import android.os.SystemClock;
Antony Sargent74cb7242018-12-14 12:45:04 -080027
Arc Wangebf8ffd2020-03-27 16:24:02 +080028import androidx.annotation.VisibleForTesting;
Arc Wang3157be52020-08-06 14:47:43 +080029import androidx.lifecycle.LifecycleObserver;
30import androidx.lifecycle.OnLifecycleEvent;
Fan Zhang31b21002019-01-16 13:49:47 -080031import androidx.preference.PreferenceGroup;
32import androidx.preference.PreferenceScreen;
33
Antony Sargent74cb7242018-12-14 12:45:04 -080034import com.android.settings.R;
35import com.android.settings.core.SubSettingLauncher;
Steven Liuc1477652020-12-16 15:08:51 -080036import com.android.settings.overlay.FeatureFactory;
Weng Su56c0fe12021-07-15 11:38:38 +080037import com.android.settings.wifi.details.WifiNetworkDetailsFragment;
Antony Sargent74cb7242018-12-14 12:45:04 -080038import com.android.settingslib.core.AbstractPreferenceController;
39import com.android.settingslib.core.lifecycle.Lifecycle;
Arc Wangebf8ffd2020-03-27 16:24:02 +080040import com.android.settingslib.wifi.WifiEntryPreference;
41import com.android.wifitrackerlib.WifiEntry;
42import com.android.wifitrackerlib.WifiPickerTracker;
43
44import java.time.Clock;
45import java.time.ZoneOffset;
Antony Sargent74cb7242018-12-14 12:45:04 -080046
Arc Wang005fe692020-03-04 21:03:54 +080047// TODO(b/151133650): Replace AbstractPreferenceController with BasePreferenceController.
Antony Sargent74cb7242018-12-14 12:45:04 -080048/**
49 * This places a preference into a PreferenceGroup owned by some parent
50 * controller class when there is a wifi connection present.
51 */
52public class WifiConnectionPreferenceController extends AbstractPreferenceController implements
Arc Wang3157be52020-08-06 14:47:43 +080053 WifiPickerTracker.WifiPickerTrackerCallback, LifecycleObserver {
Antony Sargent74cb7242018-12-14 12:45:04 -080054
55 private static final String TAG = "WifiConnPrefCtrl";
56
57 private static final String KEY = "active_wifi_connection";
58
Arc Wangebf8ffd2020-03-27 16:24:02 +080059 // Max age of tracked WifiEntries.
60 private static final long MAX_SCAN_AGE_MILLIS = 15_000;
61 // Interval between initiating WifiPickerTracker scans.
62 private static final long SCAN_INTERVAL_MILLIS = 10_000;
63
Antony Sargent74cb7242018-12-14 12:45:04 -080064 private UpdateListener mUpdateListener;
65 private Context mPrefContext;
66 private String mPreferenceGroupKey;
67 private PreferenceGroup mPreferenceGroup;
Arc Wangebf8ffd2020-03-27 16:24:02 +080068 @VisibleForTesting
69 public WifiPickerTracker mWifiPickerTracker;
70 private WifiEntryPreference mPreference;
Antony Sargent74cb7242018-12-14 12:45:04 -080071 private int order;
72 private int mMetricsCategory;
Arc Wangebf8ffd2020-03-27 16:24:02 +080073 // Worker thread used for WifiPickerTracker work.
74 private HandlerThread mWorkerThread;
Antony Sargent74cb7242018-12-14 12:45:04 -080075
76 /**
77 * Used to notify a parent controller that this controller has changed in availability, or has
78 * updated the content in the preference that it manages.
79 */
80 public interface UpdateListener {
81 void onChildrenUpdated();
82 }
83
84 /**
85 * @param context the context for the UI where we're placing the preference
86 * @param lifecycle for listening to lifecycle events for the UI
87 * @param updateListener for notifying a parent controller of changes
88 * @param preferenceGroupKey the key to use to lookup the PreferenceGroup where this controller
89 * will add its preference
90 * @param order the order that the preference added by this controller should use -
91 * useful when this preference needs to be ordered in a specific way
92 * relative to others in the PreferenceGroup
93 * @param metricsCategory - the category to use as the source when handling the click on the
94 * pref to go to the wifi connection detail page
95 */
96 public WifiConnectionPreferenceController(Context context, Lifecycle lifecycle,
97 UpdateListener updateListener, String preferenceGroupKey, int order,
98 int metricsCategory) {
99 super(context);
Arc Wang3157be52020-08-06 14:47:43 +0800100 lifecycle.addObserver(this);
Antony Sargent74cb7242018-12-14 12:45:04 -0800101 mUpdateListener = updateListener;
102 mPreferenceGroupKey = preferenceGroupKey;
Antony Sargent74cb7242018-12-14 12:45:04 -0800103 this.order = order;
104 mMetricsCategory = metricsCategory;
Arc Wangebf8ffd2020-03-27 16:24:02 +0800105
106 mWorkerThread = new HandlerThread(
107 TAG + "{" + Integer.toHexString(System.identityHashCode(this)) + "}",
108 Process.THREAD_PRIORITY_BACKGROUND);
109 mWorkerThread.start();
110 final Clock elapsedRealtimeClock = new SimpleClock(ZoneOffset.UTC) {
111 @Override
112 public long millis() {
113 return SystemClock.elapsedRealtime();
114 }
115 };
Steven Liuc1477652020-12-16 15:08:51 -0800116 mWifiPickerTracker = FeatureFactory.getFactory(context)
117 .getWifiTrackerLibProvider()
118 .createWifiPickerTracker(lifecycle, context,
119 new Handler(Looper.getMainLooper()),
120 mWorkerThread.getThreadHandler(),
121 elapsedRealtimeClock,
122 MAX_SCAN_AGE_MILLIS,
123 SCAN_INTERVAL_MILLIS,
124 this);
Antony Sargent74cb7242018-12-14 12:45:04 -0800125 }
126
Arc Wang3157be52020-08-06 14:47:43 +0800127 /**
128 * This event is triggered when users click back button at 'Network & internet'.
129 */
130 @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
131 public void onDestroy() {
132 mWorkerThread.quit();
133 }
134
Antony Sargent74cb7242018-12-14 12:45:04 -0800135 @Override
136 public boolean isAvailable() {
Arc Wangebf8ffd2020-03-27 16:24:02 +0800137 return mWifiPickerTracker.getConnectedWifiEntry() != null;
Antony Sargent74cb7242018-12-14 12:45:04 -0800138 }
139
140 @Override
141 public String getPreferenceKey() {
142 return KEY;
143 }
144
145 @Override
146 public void displayPreference(PreferenceScreen screen) {
147 super.displayPreference(screen);
Fan Zhang7db118e2019-02-14 12:25:29 -0800148 mPreferenceGroup = screen.findPreference(mPreferenceGroupKey);
Antony Sargent74cb7242018-12-14 12:45:04 -0800149 mPrefContext = screen.getContext();
150 update();
151 }
152
Arc Wangebf8ffd2020-03-27 16:24:02 +0800153 private void updatePreference(WifiEntry wifiEntry) {
Antony Sargent74cb7242018-12-14 12:45:04 -0800154 if (mPreference != null) {
155 mPreferenceGroup.removePreference(mPreference);
156 mPreference = null;
157 }
Arc Wangebf8ffd2020-03-27 16:24:02 +0800158 if (wifiEntry == null || mPrefContext == null) {
Antony Sargent74cb7242018-12-14 12:45:04 -0800159 return;
160 }
Antony Sargent74cb7242018-12-14 12:45:04 -0800161
Arc Wangebf8ffd2020-03-27 16:24:02 +0800162 mPreference = new WifiEntryPreference(mPrefContext, wifiEntry);
163 mPreference.setKey(KEY);
164 mPreference.refresh();
165 mPreference.setOrder(order);
166 mPreference.setOnPreferenceClickListener(pref -> {
167 final Bundle args = new Bundle();
Weng Su56c0fe12021-07-15 11:38:38 +0800168 args.putString(WifiNetworkDetailsFragment.KEY_CHOSEN_WIFIENTRY_KEY,
Arc Wangebf8ffd2020-03-27 16:24:02 +0800169 wifiEntry.getKey());
170 new SubSettingLauncher(mPrefContext)
171 .setTitleRes(R.string.pref_title_network_details)
Weng Su56c0fe12021-07-15 11:38:38 +0800172 .setDestination(WifiNetworkDetailsFragment.class.getName())
Arc Wangebf8ffd2020-03-27 16:24:02 +0800173 .setArguments(args)
174 .setSourceMetricsCategory(mMetricsCategory)
175 .launch();
176 return true;
177 });
178 mPreferenceGroup.addPreference(mPreference);
Antony Sargent74cb7242018-12-14 12:45:04 -0800179 }
180
181 private void update() {
Arc Wangebf8ffd2020-03-27 16:24:02 +0800182 final WifiEntry connectedWifiEntry = mWifiPickerTracker.getConnectedWifiEntry();
183 if (connectedWifiEntry == null) {
Antony Sargent74cb7242018-12-14 12:45:04 -0800184 updatePreference(null);
185 } else {
Arc Wangebf8ffd2020-03-27 16:24:02 +0800186 if (mPreference == null || !mPreference.getWifiEntry().equals(connectedWifiEntry)) {
187 updatePreference(connectedWifiEntry);
188 } else if (mPreference != null) {
189 mPreference.refresh();
190 }
Antony Sargent74cb7242018-12-14 12:45:04 -0800191 }
192 mUpdateListener.onChildrenUpdated();
193 }
194
Arc Wangebf8ffd2020-03-27 16:24:02 +0800195 /** Called when the state of Wifi has changed. */
Antony Sargent74cb7242018-12-14 12:45:04 -0800196 @Override
Arc Wangebf8ffd2020-03-27 16:24:02 +0800197 public void onWifiStateChanged() {
198 update();
199 }
200
201 /**
202 * Update the results when data changes.
203 */
204 @Override
205 public void onWifiEntriesChanged() {
Antony Sargent74cb7242018-12-14 12:45:04 -0800206 update();
207 }
208
209 @Override
Arc Wangebf8ffd2020-03-27 16:24:02 +0800210 public void onNumSavedSubscriptionsChanged() {
211 // Do nothing.
Antony Sargent74cb7242018-12-14 12:45:04 -0800212 }
213
214 @Override
Arc Wangebf8ffd2020-03-27 16:24:02 +0800215 public void onNumSavedNetworksChanged() {
216 // Do nothing.
Antony Sargent74cb7242018-12-14 12:45:04 -0800217 }
218}