Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 1 | /* |
| 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 | |
| 17 | package com.android.server.role; |
| 18 | |
| 19 | import android.annotation.CheckResult; |
| 20 | import android.annotation.NonNull; |
| 21 | import android.annotation.Nullable; |
| 22 | import android.annotation.UserIdInt; |
| 23 | import android.annotation.WorkerThread; |
| 24 | import android.os.Environment; |
| 25 | import android.os.Handler; |
| 26 | import android.util.ArrayMap; |
| 27 | import android.util.ArraySet; |
| 28 | import android.util.AtomicFile; |
| 29 | import android.util.Slog; |
| 30 | import android.util.Xml; |
| 31 | |
| 32 | import com.android.internal.annotations.GuardedBy; |
| 33 | import com.android.internal.os.BackgroundThread; |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 34 | import com.android.internal.util.CollectionUtils; |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 35 | import com.android.internal.util.dump.DualDumpOutputStream; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 36 | import com.android.internal.util.function.pooled.PooledLambda; |
| 37 | |
| 38 | import libcore.io.IoUtils; |
| 39 | |
| 40 | import org.xmlpull.v1.XmlPullParser; |
| 41 | import org.xmlpull.v1.XmlPullParserException; |
| 42 | import org.xmlpull.v1.XmlSerializer; |
| 43 | |
| 44 | import java.io.File; |
| 45 | import java.io.FileInputStream; |
| 46 | import java.io.FileNotFoundException; |
| 47 | import java.io.FileOutputStream; |
| 48 | import java.io.IOException; |
| 49 | import java.nio.charset.StandardCharsets; |
Eugene Susla | a2a8032 | 2018-12-12 17:09:38 -0800 | [diff] [blame] | 50 | import java.util.ArrayList; |
Hai Zhang | 8e60a8f | 2018-11-20 11:21:09 -0800 | [diff] [blame] | 51 | import java.util.List; |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 52 | import java.util.Objects; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * Stores the state of roles for a user. |
| 56 | */ |
| 57 | public class RoleUserState { |
| 58 | |
| 59 | private static final String LOG_TAG = RoleUserState.class.getSimpleName(); |
| 60 | |
| 61 | public static final int VERSION_UNDEFINED = -1; |
| 62 | |
| 63 | private static final String ROLES_FILE_NAME = "roles.xml"; |
| 64 | |
Hai Zhang | b3e9b9b | 2018-12-05 18:32:40 -0800 | [diff] [blame] | 65 | private static final long WRITE_DELAY_MILLIS = 200; |
Hai Zhang | b3e9b9b | 2018-12-05 18:32:40 -0800 | [diff] [blame] | 66 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 67 | private static final String TAG_ROLES = "roles"; |
| 68 | private static final String TAG_ROLE = "role"; |
| 69 | private static final String TAG_HOLDER = "holder"; |
| 70 | private static final String ATTRIBUTE_VERSION = "version"; |
| 71 | private static final String ATTRIBUTE_NAME = "name"; |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 72 | private static final String ATTRIBUTE_PACKAGES_HASH = "packagesHash"; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 73 | |
| 74 | @UserIdInt |
| 75 | private final int mUserId; |
| 76 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 77 | @NonNull |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 78 | private final Callback mCallback; |
| 79 | |
| 80 | @NonNull |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 81 | private final Object mLock = new Object(); |
| 82 | |
| 83 | @GuardedBy("mLock") |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 84 | private int mVersion = VERSION_UNDEFINED; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 85 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 86 | @GuardedBy("mLock") |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 87 | @Nullable |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 88 | private String mPackagesHash; |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 89 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 90 | /** |
| 91 | * Maps role names to its holders' package names. The values should never be null. |
| 92 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 93 | @GuardedBy("mLock") |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 94 | @NonNull |
| 95 | private ArrayMap<String, ArraySet<String>> mRoles = new ArrayMap<>(); |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 96 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 97 | @GuardedBy("mLock") |
Hai Zhang | bc543085 | 2018-12-06 23:25:43 -0800 | [diff] [blame] | 98 | private boolean mWriteScheduled; |
Hai Zhang | b3e9b9b | 2018-12-05 18:32:40 -0800 | [diff] [blame] | 99 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 100 | @GuardedBy("mLock") |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 101 | private boolean mDestroyed; |
| 102 | |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 103 | @NonNull |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 104 | private final Handler mWriteHandler = new Handler(BackgroundThread.getHandler().getLooper()); |
| 105 | |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 106 | /** |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 107 | * Create a new user state, and read its state from disk if previously persisted. |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 108 | * |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 109 | * @param userId the user id for this user state |
| 110 | * @param callback the callback for this user state |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 111 | */ |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 112 | public RoleUserState(@UserIdInt int userId, @NonNull Callback callback) { |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 113 | mUserId = userId; |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 114 | mCallback = callback; |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 115 | |
| 116 | readFile(); |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Get the version of this user state. |
| 121 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 122 | public int getVersion() { |
| 123 | synchronized (mLock) { |
| 124 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 125 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 126 | return mVersion; |
| 127 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Set the version of this user state. |
| 132 | * |
| 133 | * @param version the version to set |
| 134 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 135 | public void setVersion(int version) { |
| 136 | synchronized (mLock) { |
| 137 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 138 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 139 | if (mVersion == version) { |
| 140 | return; |
| 141 | } |
| 142 | mVersion = version; |
| 143 | scheduleWriteFileLocked(); |
Hai Zhang | 8e60a8f | 2018-11-20 11:21:09 -0800 | [diff] [blame] | 144 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 145 | } |
| 146 | |
| 147 | /** |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 148 | * Get the hash representing the state of packages during the last time initial grants was run. |
| 149 | * |
| 150 | * @return the hash representing the state of packages |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 151 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 152 | @Nullable |
| 153 | public String getPackagesHash() { |
| 154 | synchronized (mLock) { |
| 155 | return mPackagesHash; |
| 156 | } |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | /** |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 160 | * Set the hash representing the state of packages during the last time initial grants was run. |
| 161 | * |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 162 | * @param packagesHash the hash representing the state of packages |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 163 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 164 | public void setPackagesHash(@Nullable String packagesHash) { |
| 165 | synchronized (mLock) { |
| 166 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 167 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 168 | if (Objects.equals(mPackagesHash, packagesHash)) { |
| 169 | return; |
| 170 | } |
| 171 | mPackagesHash = packagesHash; |
| 172 | scheduleWriteFileLocked(); |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 173 | } |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | /** |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 177 | * Get whether the role is available. |
| 178 | * |
| 179 | * @param roleName the name of the role to get the holders for |
| 180 | * |
| 181 | * @return whether the role is available |
| 182 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 183 | public boolean isRoleAvailable(@NonNull String roleName) { |
| 184 | synchronized (mLock) { |
| 185 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 186 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 187 | return mRoles.containsKey(roleName); |
| 188 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 189 | } |
| 190 | |
| 191 | /** |
| 192 | * Get the holders of a role. |
| 193 | * |
| 194 | * @param roleName the name of the role to query for |
| 195 | * |
Hai Zhang | b175864 | 2019-01-14 17:43:04 -0800 | [diff] [blame] | 196 | * @return the set of role holders, or {@code null} if and only if the role is not found |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 197 | */ |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 198 | @Nullable |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 199 | public ArraySet<String> getRoleHolders(@NonNull String roleName) { |
| 200 | synchronized (mLock) { |
| 201 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 202 | |
Hai Zhang | b175864 | 2019-01-14 17:43:04 -0800 | [diff] [blame] | 203 | ArraySet<String> packageNames = mRoles.get(roleName); |
| 204 | if (packageNames == null) { |
| 205 | return null; |
| 206 | } |
| 207 | return new ArraySet<>(packageNames); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 208 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 209 | } |
| 210 | |
| 211 | /** |
Eugene Susla | 4ab9511 | 2018-12-17 14:45:11 -0800 | [diff] [blame] | 212 | * Adds the given role, effectively marking it as {@link #isRoleAvailable available} |
| 213 | * |
| 214 | * @param roleName the name of the role |
| 215 | * |
| 216 | * @return whether any changes were made |
| 217 | */ |
| 218 | public boolean addRoleName(@NonNull String roleName) { |
| 219 | synchronized (mLock) { |
| 220 | throwIfDestroyedLocked(); |
| 221 | |
| 222 | if (!mRoles.containsKey(roleName)) { |
| 223 | mRoles.put(roleName, new ArraySet<>()); |
| 224 | Slog.i(LOG_TAG, "Added new role: " + roleName); |
| 225 | scheduleWriteFileLocked(); |
| 226 | return true; |
| 227 | } else { |
| 228 | return false; |
| 229 | } |
| 230 | } |
| 231 | } |
| 232 | |
| 233 | /** |
Hai Zhang | 8e60a8f | 2018-11-20 11:21:09 -0800 | [diff] [blame] | 234 | * Set the names of all available roles. |
| 235 | * |
| 236 | * @param roleNames the names of all the available roles |
| 237 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 238 | public void setRoleNames(@NonNull List<String> roleNames) { |
| 239 | synchronized (mLock) { |
| 240 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 241 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 242 | boolean changed = false; |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 243 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 244 | for (int i = mRoles.size() - 1; i >= 0; i--) { |
| 245 | String roleName = mRoles.keyAt(i); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 246 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 247 | if (!roleNames.contains(roleName)) { |
| 248 | ArraySet<String> packageNames = mRoles.valueAt(i); |
| 249 | if (!packageNames.isEmpty()) { |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 250 | Slog.e(LOG_TAG, "Holders of a removed role should have been cleaned up," |
| 251 | + " role: " + roleName + ", holders: " + packageNames); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 252 | } |
| 253 | mRoles.removeAt(i); |
| 254 | changed = true; |
Hai Zhang | 8e60a8f | 2018-11-20 11:21:09 -0800 | [diff] [blame] | 255 | } |
Hai Zhang | 8e60a8f | 2018-11-20 11:21:09 -0800 | [diff] [blame] | 256 | } |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 257 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 258 | int roleNamesSize = roleNames.size(); |
| 259 | for (int i = 0; i < roleNamesSize; i++) { |
Eugene Susla | 4ab9511 | 2018-12-17 14:45:11 -0800 | [diff] [blame] | 260 | changed |= addRoleName(roleNames.get(i)); |
Hai Zhang | 8e60a8f | 2018-11-20 11:21:09 -0800 | [diff] [blame] | 261 | } |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 262 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 263 | if (changed) { |
| 264 | scheduleWriteFileLocked(); |
| 265 | } |
Hai Zhang | 8e60a8f | 2018-11-20 11:21:09 -0800 | [diff] [blame] | 266 | } |
| 267 | } |
| 268 | |
| 269 | /** |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 270 | * Add a holder to a role. |
| 271 | * |
| 272 | * @param roleName the name of the role to add the holder to |
| 273 | * @param packageName the package name of the new holder |
| 274 | * |
Hai Zhang | b175864 | 2019-01-14 17:43:04 -0800 | [diff] [blame] | 275 | * @return {@code false} if and only if the role is not found |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 276 | */ |
| 277 | @CheckResult |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 278 | public boolean addRoleHolder(@NonNull String roleName, @NonNull String packageName) { |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 279 | boolean changed; |
| 280 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 281 | synchronized (mLock) { |
| 282 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 283 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 284 | ArraySet<String> roleHolders = mRoles.get(roleName); |
| 285 | if (roleHolders == null) { |
| 286 | Slog.e(LOG_TAG, "Cannot add role holder for unknown role, role: " + roleName |
| 287 | + ", package: " + packageName); |
| 288 | return false; |
| 289 | } |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 290 | changed = roleHolders.add(packageName); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 291 | if (changed) { |
| 292 | scheduleWriteFileLocked(); |
| 293 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 294 | } |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 295 | |
| 296 | if (changed) { |
| 297 | mCallback.onRoleHoldersChanged(roleName, mUserId); |
| 298 | } |
| 299 | return true; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 300 | } |
| 301 | |
| 302 | /** |
| 303 | * Remove a holder from a role. |
| 304 | * |
| 305 | * @param roleName the name of the role to remove the holder from |
| 306 | * @param packageName the package name of the holder to remove |
| 307 | * |
Hai Zhang | b175864 | 2019-01-14 17:43:04 -0800 | [diff] [blame] | 308 | * @return {@code false} if and only if the role is not found |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 309 | */ |
| 310 | @CheckResult |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 311 | public boolean removeRoleHolder(@NonNull String roleName, @NonNull String packageName) { |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 312 | boolean changed; |
| 313 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 314 | synchronized (mLock) { |
| 315 | throwIfDestroyedLocked(); |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 316 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 317 | ArraySet<String> roleHolders = mRoles.get(roleName); |
| 318 | if (roleHolders == null) { |
| 319 | Slog.e(LOG_TAG, "Cannot remove role holder for unknown role, role: " + roleName |
| 320 | + ", package: " + packageName); |
| 321 | return false; |
| 322 | } |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 323 | |
| 324 | changed = roleHolders.remove(packageName); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 325 | if (changed) { |
| 326 | scheduleWriteFileLocked(); |
| 327 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 328 | } |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 329 | |
| 330 | if (changed) { |
| 331 | mCallback.onRoleHoldersChanged(roleName, mUserId); |
| 332 | } |
| 333 | return true; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 334 | } |
| 335 | |
| 336 | /** |
Eugene Susla | a2a8032 | 2018-12-12 17:09:38 -0800 | [diff] [blame] | 337 | * @see android.app.role.RoleManager#getHeldRolesFromController |
| 338 | */ |
| 339 | @NonNull |
| 340 | public List<String> getHeldRoles(@NonNull String packageName) { |
| 341 | ArrayList<String> result = new ArrayList<>(); |
| 342 | int size = mRoles.size(); |
| 343 | for (int i = 0; i < size; i++) { |
| 344 | if (mRoles.valueAt(i).contains(packageName)) { |
| 345 | result.add(mRoles.keyAt(i)); |
| 346 | } |
| 347 | } |
| 348 | return result; |
| 349 | } |
| 350 | |
| 351 | /** |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 352 | * Schedule writing the state to file. |
| 353 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 354 | @GuardedBy("mLock") |
| 355 | private void scheduleWriteFileLocked() { |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 356 | throwIfDestroyedLocked(); |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 357 | |
Hai Zhang | bc543085 | 2018-12-06 23:25:43 -0800 | [diff] [blame] | 358 | if (!mWriteScheduled) { |
| 359 | mWriteHandler.sendMessageDelayed(PooledLambda.obtainMessage(RoleUserState::writeFile, |
| 360 | this), WRITE_DELAY_MILLIS); |
| 361 | mWriteScheduled = true; |
Hai Zhang | b3e9b9b | 2018-12-05 18:32:40 -0800 | [diff] [blame] | 362 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 363 | } |
| 364 | |
| 365 | @WorkerThread |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 366 | private void writeFile() { |
| 367 | int version; |
| 368 | String packagesHash; |
| 369 | ArrayMap<String, ArraySet<String>> roles; |
| 370 | synchronized (mLock) { |
| 371 | if (mDestroyed) { |
| 372 | return; |
| 373 | } |
| 374 | |
Hai Zhang | bc543085 | 2018-12-06 23:25:43 -0800 | [diff] [blame] | 375 | mWriteScheduled = false; |
| 376 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 377 | version = mVersion; |
| 378 | packagesHash = mPackagesHash; |
Philip P. Moltmann | 538b361 | 2019-01-30 14:22:27 -0800 | [diff] [blame] | 379 | roles = snapshotRolesLocked(); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 380 | } |
| 381 | |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 382 | AtomicFile atomicFile = new AtomicFile(getFile(mUserId), "roles-" + mUserId); |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 383 | FileOutputStream out = null; |
| 384 | try { |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 385 | out = atomicFile.startWrite(); |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 386 | |
| 387 | XmlSerializer serializer = Xml.newSerializer(); |
| 388 | serializer.setOutput(out, StandardCharsets.UTF_8.name()); |
| 389 | serializer.setFeature( |
| 390 | "http://xmlpull.org/v1/doc/features.html#indent-output", true); |
| 391 | serializer.startDocument(null, true); |
| 392 | |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 393 | serializeRoles(serializer, version, packagesHash, roles); |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 394 | |
| 395 | serializer.endDocument(); |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 396 | atomicFile.finishWrite(out); |
Hai Zhang | b3e9b9b | 2018-12-05 18:32:40 -0800 | [diff] [blame] | 397 | Slog.i(LOG_TAG, "Wrote roles.xml successfully"); |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 398 | } catch (IllegalArgumentException | IllegalStateException | IOException e) { |
| 399 | Slog.wtf(LOG_TAG, "Failed to write roles.xml, restoring backup", e); |
| 400 | if (out != null) { |
| 401 | atomicFile.failWrite(out); |
| 402 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 403 | } finally { |
| 404 | IoUtils.closeQuietly(out); |
| 405 | } |
| 406 | } |
| 407 | |
| 408 | @WorkerThread |
| 409 | private void serializeRoles(@NonNull XmlSerializer serializer, int version, |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 410 | @Nullable String packagesHash, @NonNull ArrayMap<String, ArraySet<String>> roles) |
Eugene Susla | abdefba | 2018-11-09 18:06:43 -0800 | [diff] [blame] | 411 | throws IOException { |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 412 | serializer.startTag(null, TAG_ROLES); |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 413 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 414 | serializer.attribute(null, ATTRIBUTE_VERSION, Integer.toString(version)); |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 415 | |
| 416 | if (packagesHash != null) { |
| 417 | serializer.attribute(null, ATTRIBUTE_PACKAGES_HASH, packagesHash); |
| 418 | } |
| 419 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 420 | for (int i = 0, size = roles.size(); i < size; ++i) { |
| 421 | String roleName = roles.keyAt(i); |
| 422 | ArraySet<String> roleHolders = roles.valueAt(i); |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 423 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 424 | serializer.startTag(null, TAG_ROLE); |
| 425 | serializer.attribute(null, ATTRIBUTE_NAME, roleName); |
| 426 | serializeRoleHolders(serializer, roleHolders); |
| 427 | serializer.endTag(null, TAG_ROLE); |
| 428 | } |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 429 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 430 | serializer.endTag(null, TAG_ROLES); |
| 431 | } |
| 432 | |
| 433 | @WorkerThread |
| 434 | private void serializeRoleHolders(@NonNull XmlSerializer serializer, |
| 435 | @NonNull ArraySet<String> roleHolders) throws IOException { |
| 436 | for (int i = 0, size = roleHolders.size(); i < size; ++i) { |
| 437 | String roleHolder = roleHolders.valueAt(i); |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 438 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 439 | serializer.startTag(null, TAG_HOLDER); |
| 440 | serializer.attribute(null, ATTRIBUTE_NAME, roleHolder); |
| 441 | serializer.endTag(null, TAG_HOLDER); |
| 442 | } |
| 443 | } |
| 444 | |
| 445 | /** |
| 446 | * Read the state from file. |
| 447 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 448 | private void readFile() { |
| 449 | synchronized (mLock) { |
| 450 | File file = getFile(mUserId); |
| 451 | try (FileInputStream in = new AtomicFile(file).openRead()) { |
| 452 | XmlPullParser parser = Xml.newPullParser(); |
| 453 | parser.setInput(in, null); |
| 454 | parseXmlLocked(parser); |
| 455 | Slog.i(LOG_TAG, "Read roles.xml successfully"); |
| 456 | } catch (FileNotFoundException e) { |
| 457 | Slog.i(LOG_TAG, "roles.xml not found"); |
| 458 | } catch (XmlPullParserException | IOException e) { |
| 459 | throw new IllegalStateException("Failed to parse roles.xml: " + file, e); |
| 460 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 461 | } |
| 462 | } |
| 463 | |
| 464 | private void parseXmlLocked(@NonNull XmlPullParser parser) throws IOException, |
| 465 | XmlPullParserException { |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 466 | int type; |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 467 | int depth; |
| 468 | int innerDepth = parser.getDepth() + 1; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 469 | while ((type = parser.next()) != XmlPullParser.END_DOCUMENT |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 470 | && ((depth = parser.getDepth()) >= innerDepth || type != XmlPullParser.END_TAG)) { |
| 471 | if (depth > innerDepth || type != XmlPullParser.START_TAG) { |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 472 | continue; |
| 473 | } |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 474 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 475 | if (parser.getName().equals(TAG_ROLES)) { |
| 476 | parseRolesLocked(parser); |
| 477 | return; |
| 478 | } |
| 479 | } |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 480 | Slog.w(LOG_TAG, "Missing <" + TAG_ROLES + "> in roles.xml"); |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 481 | } |
| 482 | |
| 483 | private void parseRolesLocked(@NonNull XmlPullParser parser) throws IOException, |
| 484 | XmlPullParserException { |
| 485 | mVersion = Integer.parseInt(parser.getAttributeValue(null, ATTRIBUTE_VERSION)); |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 486 | mPackagesHash = parser.getAttributeValue(null, ATTRIBUTE_PACKAGES_HASH); |
Hai Zhang | 458cedb | 2018-12-03 15:41:11 -0800 | [diff] [blame] | 487 | mRoles.clear(); |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 488 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 489 | int type; |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 490 | int depth; |
| 491 | int innerDepth = parser.getDepth() + 1; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 492 | while ((type = parser.next()) != XmlPullParser.END_DOCUMENT |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 493 | && ((depth = parser.getDepth()) >= innerDepth || type != XmlPullParser.END_TAG)) { |
| 494 | if (depth > innerDepth || type != XmlPullParser.START_TAG) { |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 495 | continue; |
| 496 | } |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 497 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 498 | if (parser.getName().equals(TAG_ROLE)) { |
| 499 | String roleName = parser.getAttributeValue(null, ATTRIBUTE_NAME); |
| 500 | ArraySet<String> roleHolders = parseRoleHoldersLocked(parser); |
| 501 | mRoles.put(roleName, roleHolders); |
| 502 | } |
| 503 | } |
| 504 | } |
| 505 | |
| 506 | @NonNull |
| 507 | private ArraySet<String> parseRoleHoldersLocked(@NonNull XmlPullParser parser) |
| 508 | throws IOException, XmlPullParserException { |
| 509 | ArraySet<String> roleHolders = new ArraySet<>(); |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 510 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 511 | int type; |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 512 | int depth; |
| 513 | int innerDepth = parser.getDepth() + 1; |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 514 | while ((type = parser.next()) != XmlPullParser.END_DOCUMENT |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 515 | && ((depth = parser.getDepth()) >= innerDepth || type != XmlPullParser.END_TAG)) { |
| 516 | if (depth > innerDepth || type != XmlPullParser.START_TAG) { |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 517 | continue; |
| 518 | } |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 519 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 520 | if (parser.getName().equals(TAG_HOLDER)) { |
| 521 | String roleHolder = parser.getAttributeValue(null, ATTRIBUTE_NAME); |
| 522 | roleHolders.add(roleHolder); |
| 523 | } |
| 524 | } |
Hai Zhang | b295ac4 | 2018-11-16 16:08:18 -0800 | [diff] [blame] | 525 | |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 526 | return roleHolders; |
| 527 | } |
| 528 | |
| 529 | /** |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 530 | * Dump this user state. |
| 531 | * |
| 532 | * @param dumpOutputStream the output stream to dump to |
| 533 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 534 | public void dump(@NonNull DualDumpOutputStream dumpOutputStream, @NonNull String fieldName, |
| 535 | long fieldId) { |
| 536 | int version; |
| 537 | String packagesHash; |
| 538 | ArrayMap<String, ArraySet<String>> roles; |
| 539 | synchronized (mLock) { |
| 540 | throwIfDestroyedLocked(); |
| 541 | |
| 542 | version = mVersion; |
| 543 | packagesHash = mPackagesHash; |
Philip P. Moltmann | 538b361 | 2019-01-30 14:22:27 -0800 | [diff] [blame] | 544 | roles = snapshotRolesLocked(); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 545 | } |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 546 | |
| 547 | long fieldToken = dumpOutputStream.start(fieldName, fieldId); |
| 548 | dumpOutputStream.write("user_id", RoleUserStateProto.USER_ID, mUserId); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 549 | dumpOutputStream.write("version", RoleUserStateProto.VERSION, version); |
| 550 | dumpOutputStream.write("packages_hash", RoleUserStateProto.PACKAGES_HASH, packagesHash); |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 551 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 552 | int rolesSize = roles.size(); |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 553 | for (int rolesIndex = 0; rolesIndex < rolesSize; rolesIndex++) { |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 554 | String roleName = roles.keyAt(rolesIndex); |
| 555 | ArraySet<String> roleHolders = roles.valueAt(rolesIndex); |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 556 | |
| 557 | long rolesToken = dumpOutputStream.start("roles", RoleUserStateProto.ROLES); |
| 558 | dumpOutputStream.write("name", RoleProto.NAME, roleName); |
| 559 | |
| 560 | int roleHoldersSize = roleHolders.size(); |
| 561 | for (int roleHoldersIndex = 0; roleHoldersIndex < roleHoldersSize; roleHoldersIndex++) { |
| 562 | String roleHolder = roleHolders.valueAt(roleHoldersIndex); |
| 563 | |
| 564 | dumpOutputStream.write("holders", RoleProto.HOLDERS, roleHolder); |
| 565 | } |
| 566 | |
| 567 | dumpOutputStream.end(rolesToken); |
| 568 | } |
| 569 | |
| 570 | dumpOutputStream.end(fieldToken); |
| 571 | } |
| 572 | |
Philip P. Moltmann | 70b42ae | 2019-01-29 16:24:19 -0800 | [diff] [blame] | 573 | /** |
| 574 | * Get the roles and their holders. |
| 575 | * |
| 576 | * @return A copy of the roles and their holders |
| 577 | */ |
| 578 | @NonNull |
Hai Zhang | 85fd062 | 2019-02-01 14:06:04 -0800 | [diff] [blame] | 579 | public ArrayMap<String, ArraySet<String>> getRolesAndHolders() { |
Philip P. Moltmann | 70b42ae | 2019-01-29 16:24:19 -0800 | [diff] [blame] | 580 | synchronized (mLock) { |
Philip P. Moltmann | 538b361 | 2019-01-30 14:22:27 -0800 | [diff] [blame] | 581 | return snapshotRolesLocked(); |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 582 | } |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 583 | } |
| 584 | |
Philip P. Moltmann | 538b361 | 2019-01-30 14:22:27 -0800 | [diff] [blame] | 585 | @GuardedBy("mLock") |
Hai Zhang | 85fd062 | 2019-02-01 14:06:04 -0800 | [diff] [blame] | 586 | @NonNull |
Philip P. Moltmann | 538b361 | 2019-01-30 14:22:27 -0800 | [diff] [blame] | 587 | private ArrayMap<String, ArraySet<String>> snapshotRolesLocked() { |
| 588 | ArrayMap<String, ArraySet<String>> roles = new ArrayMap<>(); |
| 589 | for (int i = 0, size = CollectionUtils.size(mRoles); i < size; ++i) { |
| 590 | String roleName = mRoles.keyAt(i); |
| 591 | ArraySet<String> roleHolders = mRoles.valueAt(i); |
| 592 | |
| 593 | roleHolders = new ArraySet<>(roleHolders); |
| 594 | roles.put(roleName, roleHolders); |
| 595 | } |
| 596 | return roles; |
| 597 | } |
| 598 | |
Hai Zhang | 33456fb | 2018-12-05 17:30:35 -0800 | [diff] [blame] | 599 | /** |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 600 | * Destroy this user state and delete the corresponding file. Any pending writes to the file |
| 601 | * will be cancelled, and any future interaction with this state will throw an exception. |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 602 | */ |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 603 | public void destroy() { |
| 604 | synchronized (mLock) { |
| 605 | throwIfDestroyedLocked(); |
| 606 | mWriteHandler.removeCallbacksAndMessages(null); |
| 607 | getFile(mUserId).delete(); |
| 608 | mDestroyed = true; |
| 609 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 610 | } |
| 611 | |
Hai Zhang | cdc85c5 | 2018-12-06 13:56:55 -0800 | [diff] [blame] | 612 | @GuardedBy("mLock") |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 613 | private void throwIfDestroyedLocked() { |
| 614 | if (mDestroyed) { |
| 615 | throw new IllegalStateException("This RoleUserState has already been destroyed"); |
| 616 | } |
| 617 | } |
| 618 | |
Hai Zhang | 85fd062 | 2019-02-01 14:06:04 -0800 | [diff] [blame] | 619 | @NonNull |
| 620 | private static File getFile(@UserIdInt int userId) { |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 621 | return new File(Environment.getUserSystemDirectory(userId), ROLES_FILE_NAME); |
| 622 | } |
Hai Zhang | 31d06ba | 2018-12-06 18:14:42 -0800 | [diff] [blame] | 623 | |
| 624 | /** |
| 625 | * Callback for a user state. |
| 626 | */ |
| 627 | public interface Callback { |
| 628 | |
| 629 | /** |
| 630 | * Called when the holders of roles are changed. |
| 631 | * |
| 632 | * @param roleName the name of the role whose holders are changed |
| 633 | * @param userId the user id for this role holder change |
| 634 | */ |
| 635 | void onRoleHoldersChanged(@NonNull String roleName, @UserIdInt int userId); |
| 636 | } |
Hai Zhang | b777668 | 2018-09-25 15:10:57 -0700 | [diff] [blame] | 637 | } |