| /* |
| * Copyright (C) 2011 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 android.content.pm; |
| |
| import android.annotation.IntDef; |
| import android.annotation.NonNull; |
| import android.annotation.UnsupportedAppUsage; |
| import android.annotation.UserIdInt; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| import android.os.UserHandle; |
| import android.os.UserManager; |
| import android.util.DebugUtils; |
| |
| import com.android.internal.annotations.VisibleForTesting; |
| |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| |
| /** |
| * Per-user information. |
| * |
| * <p>There are 3 base properties of users: {@link #FLAG_SYSTEM}, {@link #FLAG_FULL}, and |
| * {@link #FLAG_PROFILE}. Every user must have one of the following combination of these |
| * flags: |
| * <ul> |
| * <li>FLAG_SYSTEM (user {@link UserHandle#USER_SYSTEM} on a headless-user-0 device)</li> |
| * <li>FLAG_SYSTEM and FLAG_FULL (user {@link UserHandle#USER_SYSTEM} on a regular device)</li> |
| * <li>FLAG_FULL (non-profile secondary user)</li> |
| * <li>FLAG_PROFILE (profile users)</li> |
| * </ul> |
| * Users can have also have additional flags (such as FLAG_GUEST) as appropriate. |
| * |
| * @hide |
| */ |
| public class UserInfo implements Parcelable { |
| |
| /** |
| * *************************** NOTE *************************** |
| * These flag values CAN NOT CHANGE because they are written |
| * directly to storage. |
| */ |
| |
| /** |
| * Primary user. Only one user can have this flag set. It identifies the first human user |
| * on a device. This flag is not supported in headless system user mode. |
| */ |
| @UnsupportedAppUsage |
| public static final int FLAG_PRIMARY = 0x00000001; |
| |
| /** |
| * User with administrative privileges. Such a user can create and |
| * delete users. |
| */ |
| public static final int FLAG_ADMIN = 0x00000002; |
| |
| /** |
| * Indicates a guest user that may be transient. |
| * @deprecated Use {@link UserManager#USER_TYPE_FULL_GUEST} instead. |
| */ |
| @Deprecated |
| public static final int FLAG_GUEST = 0x00000004; |
| |
| /** |
| * Indicates the user has restrictions in privileges, in addition to those for normal users. |
| * Exact meaning TBD. For instance, maybe they can't install apps or administer WiFi access pts. |
| * @deprecated Use {@link UserManager#USER_TYPE_FULL_RESTRICTED} instead. |
| */ |
| @Deprecated |
| public static final int FLAG_RESTRICTED = 0x00000008; |
| |
| /** |
| * Indicates that this user has gone through its first-time initialization. |
| */ |
| public static final int FLAG_INITIALIZED = 0x00000010; |
| |
| /** |
| * Indicates that this user is a profile of another user, for example holding a users |
| * corporate data. |
| * @deprecated Use {@link UserManager#USER_TYPE_PROFILE_MANAGED} instead. |
| */ |
| @Deprecated |
| public static final int FLAG_MANAGED_PROFILE = 0x00000020; |
| |
| /** |
| * Indicates that this user is disabled. |
| * |
| * <p>Note: If an ephemeral user is disabled, it shouldn't be later re-enabled. Ephemeral users |
| * are disabled as their removal is in progress to indicate that they shouldn't be re-entered. |
| */ |
| public static final int FLAG_DISABLED = 0x00000040; |
| |
| public static final int FLAG_QUIET_MODE = 0x00000080; |
| |
| /** |
| * Indicates that this user is ephemeral. I.e. the user will be removed after leaving |
| * the foreground. |
| */ |
| public static final int FLAG_EPHEMERAL = 0x00000100; |
| |
| /** |
| * User is for demo purposes only and can be removed at any time. |
| * @deprecated Use {@link UserManager#USER_TYPE_FULL_DEMO} instead. |
| */ |
| @Deprecated |
| public static final int FLAG_DEMO = 0x00000200; |
| |
| /** |
| * Indicates that this user is a non-profile human user. |
| * |
| * <p>When creating a new (non-system) user, this flag will always be forced true unless the |
| * user is a {@link #FLAG_PROFILE}. If user {@link UserHandle#USER_SYSTEM} is also a |
| * human user, it must also be flagged as FULL. |
| */ |
| public static final int FLAG_FULL = 0x00000400; |
| |
| /** |
| * Indicates that this user is {@link UserHandle#USER_SYSTEM}. Not applicable to created users. |
| */ |
| public static final int FLAG_SYSTEM = 0x00000800; |
| |
| /** |
| * Indicates that this user is a profile human user, such as a managed profile. |
| * Mutually exclusive with {@link #FLAG_FULL}. |
| */ |
| public static final int FLAG_PROFILE = 0x00001000; |
| |
| /** |
| * @hide |
| */ |
| @IntDef(flag = true, prefix = "FLAG_", value = { |
| FLAG_PRIMARY, |
| FLAG_ADMIN, |
| FLAG_GUEST, |
| FLAG_RESTRICTED, |
| FLAG_INITIALIZED, |
| FLAG_MANAGED_PROFILE, |
| FLAG_DISABLED, |
| FLAG_QUIET_MODE, |
| FLAG_EPHEMERAL, |
| FLAG_DEMO, |
| FLAG_FULL, |
| FLAG_SYSTEM, |
| FLAG_PROFILE |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface UserInfoFlag { |
| } |
| |
| public static final int NO_PROFILE_GROUP_ID = UserHandle.USER_NULL; |
| |
| @UnsupportedAppUsage |
| public @UserIdInt int id; |
| @UnsupportedAppUsage |
| public int serialNumber; |
| @UnsupportedAppUsage |
| public String name; |
| @UnsupportedAppUsage |
| public String iconPath; |
| @UnsupportedAppUsage |
| public @UserInfoFlag int flags; |
| @UnsupportedAppUsage |
| public long creationTime; |
| @UnsupportedAppUsage |
| public long lastLoggedInTime; |
| public String lastLoggedInFingerprint; |
| |
| /** |
| * Type of user, such as {@link UserManager#USER_TYPE_PROFILE_MANAGED}, corresponding to |
| * {@link com.android.server.pm.UserTypeDetails#getName()}. |
| */ |
| public String userType; |
| |
| /** |
| * If this user is a parent user, it would be its own user id. |
| * If this user is a child user, it would be its parent user id. |
| * Otherwise, it would be {@link #NO_PROFILE_GROUP_ID}. |
| */ |
| @UnsupportedAppUsage |
| public int profileGroupId; |
| public int restrictedProfileParentId; |
| |
| /** |
| * Index for distinguishing different profiles with the same parent and user type for the |
| * purpose of badging. |
| * It is used for determining which badge color/label to use (if applicable) from |
| * the options available for a particular user type. |
| */ |
| public int profileBadge; |
| |
| /** User is only partially created. */ |
| @UnsupportedAppUsage |
| public boolean partial; |
| @UnsupportedAppUsage |
| public boolean guestToRemove; |
| |
| /** |
| * This is used to optimize the creation of an user, i.e. OEMs might choose to pre-create a |
| * number of users at the first boot, so the actual creation later is faster. |
| * |
| * <p>A {@code preCreated} user is not a real user yet, so it should not show up on regular |
| * user operations (other than user creation per se). |
| * |
| * <p>Once the pre-created is used to create a "real" user later on, {@code preCreate} is set to |
| * {@code false}. |
| */ |
| public boolean preCreated; |
| |
| /** |
| * Creates a UserInfo whose user type is determined automatically by the flags according to |
| * {@link #getDefaultUserType}; can only be used for user types handled there. |
| */ |
| @UnsupportedAppUsage |
| public UserInfo(int id, String name, int flags) { |
| this(id, name, null, flags); |
| } |
| |
| /** |
| * Creates a UserInfo whose user type is determined automatically by the flags according to |
| * {@link #getDefaultUserType}; can only be used for user types handled there. |
| */ |
| @UnsupportedAppUsage |
| public UserInfo(int id, String name, String iconPath, int flags) { |
| this(id, name, iconPath, flags, getDefaultUserType(flags)); |
| } |
| |
| public UserInfo(int id, String name, String iconPath, int flags, String userType) { |
| this.id = id; |
| this.name = name; |
| this.flags = flags; |
| this.userType = userType; |
| this.iconPath = iconPath; |
| this.profileGroupId = NO_PROFILE_GROUP_ID; |
| this.restrictedProfileParentId = NO_PROFILE_GROUP_ID; |
| } |
| |
| /** |
| * Get the user type (such as {@link UserManager#USER_TYPE_PROFILE_MANAGED}) that corresponds to |
| * the given {@link UserInfoFlag}s. |
| |
| * <p>The userInfoFlag can contain GUEST, RESTRICTED, MANAGED_PROFILE, DEMO, or else be |
| * interpreted as a regular "secondary" user. It cannot contain more than one of these. |
| * It can contain other UserInfoFlag properties (like EPHEMERAL), which will be ignored here. |
| * |
| * @throws IllegalArgumentException if userInfoFlag is more than one type of user or if it |
| * is a SYSTEM user. |
| * |
| * @hide |
| */ |
| public static @NonNull String getDefaultUserType(@UserInfoFlag int userInfoFlag) { |
| if ((userInfoFlag & FLAG_SYSTEM) != 0) { |
| throw new IllegalArgumentException("Cannot getDefaultUserType for flags " |
| + Integer.toHexString(userInfoFlag) + " because it corresponds to a " |
| + "SYSTEM user type."); |
| } |
| final int supportedFlagTypes = |
| FLAG_GUEST | FLAG_RESTRICTED | FLAG_MANAGED_PROFILE | FLAG_DEMO; |
| switch (userInfoFlag & supportedFlagTypes) { |
| case 0 : return UserManager.USER_TYPE_FULL_SECONDARY; |
| case FLAG_GUEST: return UserManager.USER_TYPE_FULL_GUEST; |
| case FLAG_RESTRICTED: return UserManager.USER_TYPE_FULL_RESTRICTED; |
| case FLAG_MANAGED_PROFILE: return UserManager.USER_TYPE_PROFILE_MANAGED; |
| case FLAG_DEMO: return UserManager.USER_TYPE_FULL_DEMO; |
| default: |
| throw new IllegalArgumentException("Cannot getDefaultUserType for flags " |
| + Integer.toHexString(userInfoFlag) + " because it doesn't correspond to a " |
| + "valid user type."); |
| } |
| } |
| |
| @UnsupportedAppUsage |
| public boolean isPrimary() { |
| return (flags & FLAG_PRIMARY) == FLAG_PRIMARY; |
| } |
| |
| @UnsupportedAppUsage |
| public boolean isAdmin() { |
| return (flags & FLAG_ADMIN) == FLAG_ADMIN; |
| } |
| |
| @UnsupportedAppUsage |
| public boolean isGuest() { |
| return UserManager.isUserTypeGuest(userType); |
| } |
| |
| @UnsupportedAppUsage |
| public boolean isRestricted() { |
| return UserManager.isUserTypeRestricted(userType); |
| } |
| |
| public boolean isProfile() { |
| return (flags & FLAG_PROFILE) != 0; |
| } |
| |
| @UnsupportedAppUsage |
| public boolean isManagedProfile() { |
| return UserManager.isUserTypeManagedProfile(userType); |
| } |
| |
| @UnsupportedAppUsage |
| public boolean isEnabled() { |
| return (flags & FLAG_DISABLED) != FLAG_DISABLED; |
| } |
| |
| public boolean isQuietModeEnabled() { |
| return (flags & FLAG_QUIET_MODE) == FLAG_QUIET_MODE; |
| } |
| |
| public boolean isEphemeral() { |
| return (flags & FLAG_EPHEMERAL) == FLAG_EPHEMERAL; |
| } |
| |
| public boolean isInitialized() { |
| return (flags & FLAG_INITIALIZED) == FLAG_INITIALIZED; |
| } |
| |
| public boolean isDemo() { |
| return UserManager.isUserTypeDemo(userType); |
| } |
| |
| public boolean isFull() { |
| return (flags & FLAG_FULL) == FLAG_FULL; |
| } |
| |
| /** |
| * Returns true if the user is a split system user. |
| * <p>If {@link UserManager#isSplitSystemUser split system user mode} is not enabled, |
| * the method always returns false. |
| */ |
| public boolean isSystemOnly() { |
| return isSystemOnly(id); |
| } |
| |
| /** |
| * Returns true if the given user is a split system user. |
| * <p>If {@link UserManager#isSplitSystemUser split system user mode} is not enabled, |
| * the method always returns false. |
| */ |
| public static boolean isSystemOnly(int userId) { |
| return userId == UserHandle.USER_SYSTEM && UserManager.isSplitSystemUser(); |
| } |
| |
| /** |
| * @return true if this user can be switched to. |
| **/ |
| public boolean supportsSwitchTo() { |
| if (isEphemeral() && !isEnabled()) { |
| // Don't support switching to an ephemeral user with removal in progress. |
| return false; |
| } |
| return !isProfile(); |
| } |
| |
| /** |
| * @return true if this user can be switched to by end user through UI. |
| */ |
| public boolean supportsSwitchToByUser() { |
| // Hide the system user when it does not represent a human user. |
| boolean hideSystemUser = UserManager.isHeadlessSystemUserMode(); |
| return (!hideSystemUser || id != UserHandle.USER_SYSTEM) && supportsSwitchTo(); |
| } |
| |
| // TODO(b/142482943): Make this logic more specific and customizable. (canHaveProfile(userType)) |
| /* @hide */ |
| public boolean canHaveProfile() { |
| if (isProfile() || isGuest() || isRestricted()) { |
| return false; |
| } |
| if (UserManager.isSplitSystemUser() || UserManager.isHeadlessSystemUserMode()) { |
| return id != UserHandle.USER_SYSTEM; |
| } else { |
| return id == UserHandle.USER_SYSTEM; |
| } |
| } |
| |
| // TODO(b/142482943): Get rid of this (after removing it from all tests) if feasible. |
| /** |
| * @deprecated This is dangerous since it doesn't set the mandatory fields. Use a different |
| * constructor instead. |
| */ |
| @Deprecated |
| @VisibleForTesting |
| public UserInfo() { |
| } |
| |
| public UserInfo(UserInfo orig) { |
| name = orig.name; |
| iconPath = orig.iconPath; |
| id = orig.id; |
| flags = orig.flags; |
| userType = orig.userType; |
| serialNumber = orig.serialNumber; |
| creationTime = orig.creationTime; |
| lastLoggedInTime = orig.lastLoggedInTime; |
| lastLoggedInFingerprint = orig.lastLoggedInFingerprint; |
| partial = orig.partial; |
| preCreated = orig.preCreated; |
| profileGroupId = orig.profileGroupId; |
| restrictedProfileParentId = orig.restrictedProfileParentId; |
| guestToRemove = orig.guestToRemove; |
| profileBadge = orig.profileBadge; |
| } |
| |
| @UnsupportedAppUsage |
| public UserHandle getUserHandle() { |
| return UserHandle.of(id); |
| } |
| |
| // TODO(b/142482943): Probably include mUserType here, which means updating TestDevice, etc. |
| @Override |
| public String toString() { |
| // NOTE: do not change this string, it's used by 'pm list users', which in turn is |
| // used and parsed by TestDevice. In other words, if you change it, you'd have to change |
| // TestDevice, TestDeviceTest, and possibly others.... |
| return "UserInfo{" + id + ":" + name + ":" + Integer.toHexString(flags) + "}"; |
| } |
| |
| /** @hide */ |
| public String toFullString() { |
| return "UserInfo[id=" + id |
| + ", name=" + name |
| + ", type=" + userType |
| + ", flags=" + flagsToString(flags) |
| + (preCreated ? " (pre-created)" : "") |
| + (partial ? " (partial)" : "") |
| + "]"; |
| } |
| |
| /** @hide */ |
| public static String flagsToString(int flags) { |
| return DebugUtils.flagsToString(UserInfo.class, "FLAG_", flags); |
| } |
| |
| @Override |
| public int describeContents() { |
| return 0; |
| } |
| |
| @Override |
| public void writeToParcel(Parcel dest, int parcelableFlags) { |
| dest.writeInt(id); |
| dest.writeString(name); |
| dest.writeString(iconPath); |
| dest.writeInt(flags); |
| dest.writeString(userType); |
| dest.writeInt(serialNumber); |
| dest.writeLong(creationTime); |
| dest.writeLong(lastLoggedInTime); |
| dest.writeString(lastLoggedInFingerprint); |
| dest.writeBoolean(partial); |
| dest.writeBoolean(preCreated); |
| dest.writeInt(profileGroupId); |
| dest.writeBoolean(guestToRemove); |
| dest.writeInt(restrictedProfileParentId); |
| dest.writeInt(profileBadge); |
| } |
| |
| @UnsupportedAppUsage |
| public static final @android.annotation.NonNull Parcelable.Creator<UserInfo> CREATOR |
| = new Parcelable.Creator<UserInfo>() { |
| public UserInfo createFromParcel(Parcel source) { |
| return new UserInfo(source); |
| } |
| public UserInfo[] newArray(int size) { |
| return new UserInfo[size]; |
| } |
| }; |
| |
| private UserInfo(Parcel source) { |
| id = source.readInt(); |
| name = source.readString(); |
| iconPath = source.readString(); |
| flags = source.readInt(); |
| userType = source.readString(); |
| serialNumber = source.readInt(); |
| creationTime = source.readLong(); |
| lastLoggedInTime = source.readLong(); |
| lastLoggedInFingerprint = source.readString(); |
| partial = source.readBoolean(); |
| preCreated = source.readBoolean(); |
| profileGroupId = source.readInt(); |
| guestToRemove = source.readBoolean(); |
| restrictedProfileParentId = source.readInt(); |
| profileBadge = source.readInt(); |
| } |
| } |