• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2021 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 package com.android.car.user;
17 
18 import android.annotation.NonNull;
19 import android.annotation.Nullable;
20 import android.annotation.UserIdInt;
21 import android.car.builtin.os.UserManagerHelper;
22 import android.content.Context;
23 import android.os.UserHandle;
24 import android.os.UserManager;
25 
26 import java.util.List;
27 
28 /**
29  * Helper class to get User properties using UserHandle
30  */
31 //TODO(b/214340360) : Add unit test
32 public final class UserHandleHelper {
33 
34     private final Context mContext;
35     private final UserManager mUserManager;
36 
UserHandleHelper(@onNull Context context, @NonNull UserManager userManager)37     public UserHandleHelper(@NonNull Context context, @NonNull UserManager userManager) {
38         mContext = context;
39         mUserManager = userManager;
40     }
41 
42     /**
43      * Gets user handle if user exists
44      */
45     @Nullable
getExistingUserHandle(@serIdInt int userId)46     public UserHandle getExistingUserHandle(@UserIdInt int userId) {
47         List<UserHandle> users = UserManagerHelper.getUserHandles(mUserManager,
48                 /* excludePartial= */ false, /* excludeDying= */ false,
49                 /* excludePreCreated= */ true);
50 
51         for (UserHandle user : users) {
52             if (user.getIdentifier() == userId) return user;
53         }
54         return null;
55     }
56 
57     /**
58      * Gets user handle if user exists
59      */
60     @NonNull
getUserHandles(boolean excludePartial, boolean excludeDying, boolean excludePreCreated)61     public List<UserHandle> getUserHandles(boolean excludePartial, boolean excludeDying,
62             boolean excludePreCreated) {
63         return UserManagerHelper.getUserHandles(mUserManager, excludePartial,
64                 excludeDying, excludePreCreated);
65     }
66 
67     /**
68      * Get enabled profiles
69      */
70     @NonNull
getEnabledProfiles(@serIdInt int userId)71     public List<UserHandle> getEnabledProfiles(@UserIdInt int userId) {
72         return getUserContextAwareUserManager(userId).getEnabledProfiles();
73     }
74 
75     /**
76      * Is User a guest user?
77      */
isGuestUser(UserHandle user)78     public boolean isGuestUser(UserHandle user) {
79         return getUserContextAwareUserManager(user.getIdentifier()).isGuestUser();
80     }
81 
82     /**
83      * Is User an admin user?
84      */
isAdminUser(UserHandle user)85     public boolean isAdminUser(UserHandle user) {
86         return getUserContextAwareUserManager(user.getIdentifier()).isAdminUser();
87     }
88 
89     /**
90      * Is User an ephemeral user?
91      */
isEphemeralUser(UserHandle user)92     public boolean isEphemeralUser(UserHandle user) {
93         return UserManagerHelper.isEphemeralUser(mUserManager, user);
94     }
95 
96     /**
97      * Is User enabled?
98      */
isEnabledUser(UserHandle user)99     public boolean isEnabledUser(UserHandle user) {
100         return UserManagerHelper.isEnabledUser(mUserManager, user);
101     }
102 
103     /**
104      * Is User a managed profile?
105      */
isManagedProfile(UserHandle user)106     public boolean isManagedProfile(UserHandle user) {
107         return mUserManager.isManagedProfile(user.getIdentifier());
108     }
109 
110     /**
111      * Is user for a profile?
112      */
isProfileUser(UserHandle user)113     public boolean isProfileUser(UserHandle user) {
114         return getUserContextAwareUserManager(user.getIdentifier()).isProfile();
115     }
116 
117     /**
118      * Is User Initialized?
119      */
isInitializedUser(UserHandle user)120     public boolean isInitializedUser(UserHandle user) {
121         return UserManagerHelper.isInitializedUser(mUserManager, user);
122     }
123 
124     /**
125      * Is user preCreated?
126      */
isPreCreatedUser(UserHandle user)127     public boolean isPreCreatedUser(UserHandle user) {
128         return UserManagerHelper.isPreCreatedUser(mUserManager, user);
129     }
130 
getUserContextAwareUserManager(@serIdInt int userId)131     private UserManager getUserContextAwareUserManager(@UserIdInt int userId) {
132         Context userContext = mContext.createContextAsUser(UserHandle.of(userId), /* flags= */ 0);
133         return userContext.getSystemService(UserManager.class);
134     }
135 }
136