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