Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2019 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 | |
| 17 | package com.android.systemui.broadcast |
| 18 | |
| 19 | import android.content.BroadcastReceiver |
| 20 | import android.content.Context |
| 21 | import android.content.IntentFilter |
| 22 | import android.os.Handler |
Fabian Kozynski | 5e92c6f | 2020-01-03 13:56:17 -0500 | [diff] [blame] | 23 | import android.os.HandlerExecutor |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 24 | import android.os.Looper |
| 25 | import android.os.Message |
| 26 | import android.os.UserHandle |
Fabian Kozynski | cfe8045 | 2019-10-17 14:29:03 +0000 | [diff] [blame] | 27 | import android.text.TextUtils |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 28 | import android.util.Log |
| 29 | import android.util.SparseArray |
| 30 | import com.android.internal.annotations.VisibleForTesting |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 31 | import com.android.systemui.Dumpable |
Dave Mankoff | 00e8a2f | 2019-12-18 16:59:49 -0500 | [diff] [blame] | 32 | import com.android.systemui.dagger.qualifiers.Background |
| 33 | import com.android.systemui.dagger.qualifiers.Main |
Ned Burns | c7cfa69 | 2020-02-12 21:38:50 -0500 | [diff] [blame] | 34 | import com.android.systemui.dump.DumpManager |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 35 | import java.io.FileDescriptor |
| 36 | import java.io.PrintWriter |
Fabian Kozynski | 5e92c6f | 2020-01-03 13:56:17 -0500 | [diff] [blame] | 37 | import java.util.concurrent.Executor |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 38 | import javax.inject.Inject |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 39 | import javax.inject.Singleton |
| 40 | |
| 41 | data class ReceiverData( |
| 42 | val receiver: BroadcastReceiver, |
| 43 | val filter: IntentFilter, |
Fabian Kozynski | 5e92c6f | 2020-01-03 13:56:17 -0500 | [diff] [blame] | 44 | val executor: Executor, |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 45 | val user: UserHandle |
| 46 | ) |
| 47 | |
| 48 | private const val MSG_ADD_RECEIVER = 0 |
| 49 | private const val MSG_REMOVE_RECEIVER = 1 |
| 50 | private const val MSG_REMOVE_RECEIVER_FOR_USER = 2 |
| 51 | private const val TAG = "BroadcastDispatcher" |
Fabian Kozynski | 2c9b3b4 | 2019-12-06 16:39:50 -0500 | [diff] [blame] | 52 | private const val DEBUG = true |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * SystemUI master Broadcast Dispatcher. |
| 56 | * |
| 57 | * This class allows [BroadcastReceiver] to register and centralizes registrations to [Context] |
| 58 | * from SystemUI. That way the number of calls to [BroadcastReceiver.onReceive] can be reduced for |
| 59 | * a given broadcast. |
| 60 | * |
| 61 | * Use only for IntentFilters with actions and optionally categories. It does not support, |
Fabian Kozynski | cb6968c | 2019-11-26 13:09:11 -0500 | [diff] [blame] | 62 | * permissions, schemes, data types, data authorities or priority different than 0. |
Fabian Kozynski | cfe8045 | 2019-10-17 14:29:03 +0000 | [diff] [blame] | 63 | * Cannot be used for getting sticky broadcasts. |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 64 | */ |
| 65 | @Singleton |
| 66 | open class BroadcastDispatcher @Inject constructor ( |
| 67 | private val context: Context, |
Dave Mankoff | 00e8a2f | 2019-12-18 16:59:49 -0500 | [diff] [blame] | 68 | @Main private val mainHandler: Handler, |
Ned Burns | c7cfa69 | 2020-02-12 21:38:50 -0500 | [diff] [blame] | 69 | @Background private val bgLooper: Looper, |
| 70 | dumpManager: DumpManager |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 71 | ) : Dumpable { |
| 72 | |
| 73 | // Only modify in BG thread |
| 74 | private val receiversByUser = SparseArray<UserBroadcastDispatcher>(20) |
| 75 | |
Ned Burns | c7cfa69 | 2020-02-12 21:38:50 -0500 | [diff] [blame] | 76 | init { |
| 77 | // TODO: Don't do this in the constructor |
| 78 | dumpManager.registerDumpable(javaClass.name, this) |
| 79 | } |
| 80 | |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 81 | /** |
| 82 | * Register a receiver for broadcast with the dispatcher |
| 83 | * |
| 84 | * @param receiver A receiver to dispatch the [Intent] |
| 85 | * @param filter A filter to determine what broadcasts should be dispatched to this receiver. |
Fabian Kozynski | cfe8045 | 2019-10-17 14:29:03 +0000 | [diff] [blame] | 86 | * It will only take into account actions and categories for filtering. It must |
| 87 | * have at least one action. |
Fabian Kozynski | 5e92c6f | 2020-01-03 13:56:17 -0500 | [diff] [blame] | 88 | * @param handler A handler to dispatch [BroadcastReceiver.onReceive]. |
| 89 | * @param user A user handle to determine which broadcast should be dispatched to this receiver. |
| 90 | * By default, it is the current user. |
| 91 | * @throws IllegalArgumentException if the filter has other constraints that are not actions or |
| 92 | * categories or the filter has no actions. |
| 93 | */ |
| 94 | @Deprecated(message = "Replacing Handler for Executor in SystemUI", |
| 95 | replaceWith = ReplaceWith("registerReceiver(receiver, filter, executor, user)")) |
| 96 | @JvmOverloads |
Fabian Kozynski | 8116816 | 2020-03-18 14:22:26 -0400 | [diff] [blame] | 97 | open fun registerReceiverWithHandler( |
Fabian Kozynski | 5e92c6f | 2020-01-03 13:56:17 -0500 | [diff] [blame] | 98 | receiver: BroadcastReceiver, |
| 99 | filter: IntentFilter, |
| 100 | handler: Handler, |
| 101 | user: UserHandle = context.user |
| 102 | ) { |
| 103 | registerReceiver(receiver, filter, HandlerExecutor(handler), user) |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Register a receiver for broadcast with the dispatcher |
| 108 | * |
| 109 | * @param receiver A receiver to dispatch the [Intent] |
| 110 | * @param filter A filter to determine what broadcasts should be dispatched to this receiver. |
| 111 | * It will only take into account actions and categories for filtering. It must |
| 112 | * have at least one action. |
| 113 | * @param executor An executor to dispatch [BroadcastReceiver.onReceive]. Pass null to use an |
| 114 | * executor in the main thread (default). |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 115 | * @param user A user handle to determine which broadcast should be dispatched to this receiver. |
| 116 | * By default, it is the current user. |
Fabian Kozynski | cfe8045 | 2019-10-17 14:29:03 +0000 | [diff] [blame] | 117 | * @throws IllegalArgumentException if the filter has other constraints that are not actions or |
| 118 | * categories or the filter has no actions. |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 119 | */ |
| 120 | @JvmOverloads |
Fabian Kozynski | 8116816 | 2020-03-18 14:22:26 -0400 | [diff] [blame] | 121 | open fun registerReceiver( |
Ned Burns | c7cfa69 | 2020-02-12 21:38:50 -0500 | [diff] [blame] | 122 | receiver: BroadcastReceiver, |
| 123 | filter: IntentFilter, |
| 124 | executor: Executor? = context.mainExecutor, |
| 125 | user: UserHandle = context.user |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 126 | ) { |
Fabian Kozynski | cfe8045 | 2019-10-17 14:29:03 +0000 | [diff] [blame] | 127 | checkFilter(filter) |
Fabian Kozynski | ff5e91f | 2019-09-24 15:38:08 -0400 | [diff] [blame] | 128 | this.handler |
| 129 | .obtainMessage(MSG_ADD_RECEIVER, |
Fabian Kozynski | 5e92c6f | 2020-01-03 13:56:17 -0500 | [diff] [blame] | 130 | ReceiverData(receiver, filter, executor ?: context.mainExecutor, user)) |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 131 | .sendToTarget() |
| 132 | } |
| 133 | |
Fabian Kozynski | cfe8045 | 2019-10-17 14:29:03 +0000 | [diff] [blame] | 134 | private fun checkFilter(filter: IntentFilter) { |
| 135 | val sb = StringBuilder() |
| 136 | if (filter.countActions() == 0) sb.append("Filter must contain at least one action. ") |
| 137 | if (filter.countDataAuthorities() != 0) sb.append("Filter cannot contain DataAuthorities. ") |
| 138 | if (filter.countDataPaths() != 0) sb.append("Filter cannot contain DataPaths. ") |
| 139 | if (filter.countDataSchemes() != 0) sb.append("Filter cannot contain DataSchemes. ") |
| 140 | if (filter.countDataTypes() != 0) sb.append("Filter cannot contain DataTypes. ") |
Fabian Kozynski | cb6968c | 2019-11-26 13:09:11 -0500 | [diff] [blame] | 141 | if (filter.priority != 0) sb.append("Filter cannot modify priority. ") |
Fabian Kozynski | cfe8045 | 2019-10-17 14:29:03 +0000 | [diff] [blame] | 142 | if (!TextUtils.isEmpty(sb)) throw IllegalArgumentException(sb.toString()) |
| 143 | } |
| 144 | |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 145 | /** |
| 146 | * Unregister receiver for all users. |
| 147 | * <br> |
| 148 | * This will remove every registration of [receiver], not those done just with [UserHandle.ALL]. |
| 149 | * |
| 150 | * @param receiver The receiver to unregister. It will be unregistered for all users. |
| 151 | */ |
Fabian Kozynski | 8116816 | 2020-03-18 14:22:26 -0400 | [diff] [blame] | 152 | open fun unregisterReceiver(receiver: BroadcastReceiver) { |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 153 | handler.obtainMessage(MSG_REMOVE_RECEIVER, receiver).sendToTarget() |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Unregister receiver for a particular user. |
| 158 | * |
| 159 | * @param receiver The receiver to unregister. It will be unregistered for all users. |
| 160 | * @param user The user associated to the registered [receiver]. It can be [UserHandle.ALL]. |
| 161 | */ |
Fabian Kozynski | 8116816 | 2020-03-18 14:22:26 -0400 | [diff] [blame] | 162 | open fun unregisterReceiverForUser(receiver: BroadcastReceiver, user: UserHandle) { |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 163 | handler.obtainMessage(MSG_REMOVE_RECEIVER_FOR_USER, user.identifier, 0, receiver) |
| 164 | .sendToTarget() |
| 165 | } |
| 166 | |
| 167 | @VisibleForTesting |
| 168 | protected open fun createUBRForUser(userId: Int) = |
Fabian Kozynski | aaf4c5e | 2020-03-27 13:29:15 -0400 | [diff] [blame] | 169 | UserBroadcastDispatcher(context, userId, bgLooper) |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 170 | |
Lucas Dupin | 64171fe | 2019-10-30 14:28:29 -0700 | [diff] [blame] | 171 | override fun dump(fd: FileDescriptor, pw: PrintWriter, args: Array<out String>) { |
| 172 | pw.println("Broadcast dispatcher:") |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 173 | for (index in 0 until receiversByUser.size()) { |
Lucas Dupin | 64171fe | 2019-10-30 14:28:29 -0700 | [diff] [blame] | 174 | pw.println(" User ${receiversByUser.keyAt(index)}") |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 175 | receiversByUser.valueAt(index).dump(fd, pw, args) |
| 176 | } |
| 177 | } |
| 178 | |
| 179 | private val handler = object : Handler(bgLooper) { |
| 180 | override fun handleMessage(msg: Message) { |
| 181 | when (msg.what) { |
| 182 | MSG_ADD_RECEIVER -> { |
| 183 | val data = msg.obj as ReceiverData |
Fabian Kozynski | 2c9b3b4 | 2019-12-06 16:39:50 -0500 | [diff] [blame] | 184 | // If the receiver asked to be registered under the current user, we register |
| 185 | // under the actual current user. |
| 186 | val userId = if (data.user.identifier == UserHandle.USER_CURRENT) { |
| 187 | context.userId |
| 188 | } else { |
| 189 | data.user.identifier |
| 190 | } |
Fabian Kozynski | 42f86a0 | 2019-07-09 12:39:03 -0400 | [diff] [blame] | 191 | if (userId < UserHandle.USER_ALL) { |
| 192 | if (DEBUG) Log.w(TAG, "Register receiver for invalid user: $userId") |
| 193 | return |
| 194 | } |
| 195 | val uBR = receiversByUser.get(userId, createUBRForUser(userId)) |
| 196 | receiversByUser.put(userId, uBR) |
| 197 | uBR.registerReceiver(data) |
| 198 | } |
| 199 | |
| 200 | MSG_REMOVE_RECEIVER -> { |
| 201 | for (it in 0 until receiversByUser.size()) { |
| 202 | receiversByUser.valueAt(it).unregisterReceiver(msg.obj as BroadcastReceiver) |
| 203 | } |
| 204 | } |
| 205 | |
| 206 | MSG_REMOVE_RECEIVER_FOR_USER -> { |
| 207 | receiversByUser.get(msg.arg1)?.unregisterReceiver(msg.obj as BroadcastReceiver) |
| 208 | } |
| 209 | |
| 210 | else -> super.handleMessage(msg) |
| 211 | } |
| 212 | } |
| 213 | } |
| 214 | } |