/* * Copyright (C) 2021 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.car.builtin.os; import android.annotation.NonNull; import android.annotation.SystemApi; import android.annotation.UserIdInt; import android.content.Context; import android.content.pm.UserInfo; import android.os.SystemProperties; import android.os.UserHandle; import android.os.UserManager; import java.util.ArrayList; import java.util.List; /** * Helper for User related operations. * * @hide */ @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) public final class UserManagerHelper { private UserManagerHelper() { throw new UnsupportedOperationException(); } /** user id for invalid user */ public static final @UserIdInt int USER_NULL = UserHandle.USER_NULL; /** A user id constant to indicate the "system" user of the device */ public static final @UserIdInt int USER_SYSTEM = UserHandle.USER_SYSTEM; /** A user id constant to indicate "all" users of the device */ public static final @UserIdInt int USER_ALL = UserHandle.USER_ALL; // Flags copied from UserInfo. public static final int FLAG_PRIMARY = UserInfo.FLAG_PRIMARY; public static final int FLAG_ADMIN = UserInfo.FLAG_ADMIN; public static final int FLAG_GUEST = UserInfo.FLAG_GUEST; public static final int FLAG_RESTRICTED = UserInfo.FLAG_RESTRICTED; public static final int FLAG_INITIALIZED = UserInfo.FLAG_INITIALIZED; public static final int FLAG_MANAGED_PROFILE = UserInfo.FLAG_MANAGED_PROFILE; public static final int FLAG_DISABLED = UserInfo.FLAG_DISABLED; public static final int FLAG_QUIET_MODE = UserInfo.FLAG_QUIET_MODE; public static final int FLAG_EPHEMERAL = UserInfo.FLAG_EPHEMERAL; public static final int FLAG_DEMO = UserInfo.FLAG_DEMO; public static final int FLAG_FULL = UserInfo.FLAG_FULL; public static final int FLAG_SYSTEM = UserInfo.FLAG_SYSTEM; public static final int FLAG_PROFILE = UserInfo.FLAG_PROFILE; /** * Returns all user handles. */ @NonNull public static List getUserHandles(@NonNull UserManager userManager, boolean excludeDying) { return userManager.getUserHandles(excludeDying); } /** * Returns all users based on the boolean flags. * * @deprecated Use {@link #getUserHandles(UserManager, boolean)} instead. */ @Deprecated @NonNull public static List getUserHandles(@NonNull UserManager userManager, boolean excludePartial, boolean excludeDying, boolean excludePreCreated) { List users = userManager.getUsers(excludePartial, excludeDying, excludePreCreated); List result = new ArrayList<>(users.size()); for (UserInfo user : users) { result.add(user.getUserHandle()); } return result; } /** * Checks if a user is ephemeral. */ public static boolean isEphemeralUser(@NonNull UserManager userManager, @NonNull UserHandle user) { return userManager.isUserEphemeral(user.getIdentifier()); } /** Checks if the user is guest. */ public static boolean isGuestUser(@NonNull UserManager userManager, @NonNull UserHandle user) { return userManager.isGuestUser(user.getIdentifier()); } /** Checks if the user is a full user. */ public static boolean isFullUser(@NonNull UserManager userManager, @NonNull UserHandle user) { UserInfo info = userManager.getUserInfo(user.getIdentifier()); return info != null && info.isFull(); } /** * Checks if a user is enabled. */ public static boolean isEnabledUser(@NonNull UserManager userManager, @NonNull UserHandle user) { return userManager.getUserInfo(user.getIdentifier()).isEnabled(); } /** * Checks if a user is initialized. */ public static boolean isInitializedUser(@NonNull UserManager userManager, @NonNull UserHandle user) { return userManager.getUserInfo(user.getIdentifier()).isInitialized(); } /** * Gets DefaultUserType given userInfo flags. */ public static String getDefaultUserTypeForUserInfoFlags(int userInfoFlag) { return UserInfo.getDefaultUserType(userInfoFlag); } /** * Gets the default name for a user. */ @NonNull public static String getDefaultUserName(@NonNull Context context) { return context.getResources().getString(com.android.internal.R.string.owner_name); } /** * Gets the maximum number of users that can be running at any given time. */ public static int getMaxRunningUsers(@NonNull Context context) { return context.getResources() .getInteger(com.android.internal.R.integer.config_multiuserMaxRunningUsers); } /** * Marks guest for deletion */ public static boolean markGuestForDeletion(@NonNull UserManager userManager, @NonNull UserHandle user) { return userManager.markGuestForDeletion(user.getIdentifier()); } /** * Returns the user id for a given uid. */ public static @UserIdInt int getUserId(int uid) { return UserHandle.getUserId(uid); } /** Check {@link UserManager#isVisibleBackgroundUsersSupported()}. */ public static boolean isVisibleBackgroundUsersSupported(@NonNull UserManager userManager) { return userManager.isVisibleBackgroundUsersSupported(); } /** Check {@link UserManager#isVisibleBackgroundUsersOnDefaultDisplaySupported()}. */ public static boolean isVisibleBackgroundUsersOnDefaultDisplaySupported( @NonNull UserManager userManager) { return userManager.isVisibleBackgroundUsersOnDefaultDisplaySupported(); } /** Check {@link UserManager#getMaxSupportedUsers()}. */ public static int getMaxSupportedUsers(@NonNull Context context) { return Math.max(1, SystemProperties.getInt("fw.max_users", context.getResources().getSystem().getInteger( com.android.internal.R.integer.config_multiuserMaximumUsers))); } /** Check {@link UserManager#getMainDisplayIdAssignedToUser()}. */ public static int getMainDisplayIdAssignedToUser(@NonNull UserManager userManager) { return userManager.getMainDisplayIdAssignedToUser(); } }