1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*
* Copyright (C) 2024 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.connecteddevice.threadnetwork
import android.content.BroadcastReceiver
import android.content.Context
import android.content.Intent
import android.content.IntentFilter
import android.content.pm.PackageManager
import android.net.thread.ThreadNetworkController
import android.net.thread.ThreadNetworkController.StateCallback
import android.net.thread.ThreadNetworkException
import android.net.thread.ThreadNetworkManager
import android.os.OutcomeReceiver
import android.provider.Settings
import android.util.Log
import androidx.annotation.VisibleForTesting
import androidx.core.content.ContextCompat
import androidx.lifecycle.Lifecycle
import androidx.lifecycle.LifecycleEventObserver
import androidx.lifecycle.LifecycleOwner
import androidx.preference.Preference
import androidx.preference.PreferenceScreen
import com.android.net.thread.platform.flags.Flags
import com.android.settings.R
import com.android.settings.core.TogglePreferenceController
import java.util.concurrent.Executor
/** Controller for the "Thread" toggle in "Connected devices > Connection preferences". */
class ThreadNetworkPreferenceController @VisibleForTesting constructor(
context: Context,
key: String,
private val executor: Executor,
private val threadController: BaseThreadNetworkController?
) : TogglePreferenceController(context, key), LifecycleEventObserver {
private val stateCallback: StateCallback
private val airplaneModeReceiver: BroadcastReceiver
private var threadEnabled = false
private var airplaneModeOn = false
private var preference: Preference? = null
/**
* A testable interface for [ThreadNetworkController] which is `final`.
*
* We are in a awkward situation that Android API guideline suggest `final` for API classes
* while Robolectric test is being deprecated for platform testing (See
* tests/robotests/new_tests_hook.sh). This force us to use "mockito-target-extended" but it's
* conflicting with the default "mockito-target" which is somehow indirectly depended by the
* `SettingsUnitTests` target.
*/
@VisibleForTesting
interface BaseThreadNetworkController {
fun setEnabled(
enabled: Boolean,
executor: Executor,
receiver: OutcomeReceiver<Void?, ThreadNetworkException>
)
fun registerStateCallback(executor: Executor, callback: StateCallback)
fun unregisterStateCallback(callback: StateCallback)
}
constructor(context: Context, key: String) : this(
context,
key,
ContextCompat.getMainExecutor(context),
getThreadNetworkController(context)
)
init {
stateCallback = newStateCallback()
airplaneModeReceiver = newAirPlaneModeReceiver()
}
val isThreadSupportedOnDevice: Boolean
get() = threadController != null
private fun newStateCallback(): StateCallback {
return object : StateCallback {
override fun onThreadEnableStateChanged(enabledState: Int) {
threadEnabled = enabledState == ThreadNetworkController.STATE_ENABLED
}
override fun onDeviceRoleChanged(role: Int) {}
}
}
private fun newAirPlaneModeReceiver(): BroadcastReceiver {
return object : BroadcastReceiver() {
override fun onReceive(context: Context, intent: Intent) {
airplaneModeOn = isAirplaneModeOn(context)
Log.i(TAG, "Airplane mode is " + if (airplaneModeOn) "ON" else "OFF")
preference?.let { preference -> updateState(preference) }
}
}
}
override fun getAvailabilityStatus(): Int {
return if (!Flags.threadEnabledPlatform()) {
CONDITIONALLY_UNAVAILABLE
} else if (!isThreadSupportedOnDevice) {
UNSUPPORTED_ON_DEVICE
} else if (airplaneModeOn) {
DISABLED_DEPENDENT_SETTING
} else {
AVAILABLE
}
}
override fun displayPreference(screen: PreferenceScreen) {
super.displayPreference(screen)
preference = screen.findPreference(preferenceKey)
}
override fun isChecked(): Boolean {
// TODO (b/322742298):
// Check airplane mode here because it's planned to disable Thread state in airplane mode
// (code in the mainline module). But it's currently not implemented yet (b/322742298).
// By design, the toggle should be unchecked in airplane mode, so explicitly check the
// airplane mode here to acchieve the same UX.
return !airplaneModeOn && threadEnabled
}
override fun setChecked(isChecked: Boolean): Boolean {
if (threadController == null) {
return false
}
val action = if (isChecked) "enable" else "disable"
threadController.setEnabled(
isChecked,
executor,
object : OutcomeReceiver<Void?, ThreadNetworkException> {
override fun onError(e: ThreadNetworkException) {
// TODO(b/327549838): gracefully handle the failure by resetting the UI state
Log.e(TAG, "Failed to $action Thread", e)
}
override fun onResult(unused: Void?) {
Log.d(TAG, "Successfully $action Thread")
}
})
return true
}
override fun onStateChanged(lifecycleOwner: LifecycleOwner, event: Lifecycle.Event) {
if (threadController == null) {
return
}
when (event) {
Lifecycle.Event.ON_START -> {
threadController.registerStateCallback(executor, stateCallback)
airplaneModeOn = isAirplaneModeOn(mContext)
mContext.registerReceiver(
airplaneModeReceiver,
IntentFilter(Intent.ACTION_AIRPLANE_MODE_CHANGED)
)
preference?.let { preference -> updateState(preference) }
}
Lifecycle.Event.ON_STOP -> {
threadController.unregisterStateCallback(stateCallback)
mContext.unregisterReceiver(airplaneModeReceiver)
}
else -> {}
}
}
override fun updateState(preference: Preference) {
super.updateState(preference)
preference.isEnabled = !airplaneModeOn
refreshSummary(preference)
}
override fun getSummary(): CharSequence {
val resId: Int = if (airplaneModeOn) {
R.string.thread_network_settings_summary_airplane_mode
} else {
R.string.thread_network_settings_summary
}
return mContext.getResources().getString(resId)
}
override fun getSliceHighlightMenuRes(): Int {
return R.string.menu_key_connected_devices
}
companion object {
private const val TAG = "ThreadNetworkSettings"
private fun getThreadNetworkController(context: Context): BaseThreadNetworkController? {
if (!context.packageManager.hasSystemFeature(PackageManager.FEATURE_THREAD_NETWORK)) {
return null
}
val manager = context.getSystemService(ThreadNetworkManager::class.java) ?: return null
val controller = manager.allThreadNetworkControllers[0]
return object : BaseThreadNetworkController {
override fun setEnabled(
enabled: Boolean,
executor: Executor,
receiver: OutcomeReceiver<Void?, ThreadNetworkException>
) {
controller.setEnabled(enabled, executor, receiver)
}
override fun registerStateCallback(executor: Executor, callback: StateCallback) {
controller.registerStateCallback(executor, callback)
}
override fun unregisterStateCallback(callback: StateCallback) {
controller.unregisterStateCallback(callback)
}
}
}
private fun isAirplaneModeOn(context: Context): Boolean {
return Settings.Global.getInt(
context.contentResolver,
Settings.Global.AIRPLANE_MODE_ON,
0
) == 1
}
}
}
|
