UserManager.java revision 4a4f275f24f6673c435c5205522273ba3500dbcc
1/* 2 * Copyright (C) 2012 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 */ 16package android.os; 17 18import android.app.ActivityManager; 19import android.app.ActivityManagerNative; 20import android.content.Context; 21import android.content.pm.UserInfo; 22import android.content.res.Resources; 23import android.graphics.Bitmap; 24import android.graphics.Canvas; 25import android.graphics.Bitmap.Config; 26import android.graphics.Rect; 27import android.graphics.drawable.BitmapDrawable; 28import android.graphics.drawable.Drawable; 29import android.provider.Settings; 30import android.util.Log; 31import android.view.WindowManager.LayoutParams; 32 33import com.android.internal.R; 34 35import java.util.ArrayList; 36import java.util.List; 37 38/** 39 * Manages users and user details on a multi-user system. 40 */ 41public class UserManager { 42 43 private static String TAG = "UserManager"; 44 private final IUserManager mService; 45 private final Context mContext; 46 47 /** 48 * Key for user restrictions. Specifies if a user is disallowed from adding and removing 49 * accounts. 50 * The default value is <code>false</code>. 51 * <p/> 52 * Type: Boolean 53 * @see #setUserRestrictions(Bundle) 54 * @see #getUserRestrictions() 55 */ 56 public static final String DISALLOW_MODIFY_ACCOUNTS = "no_modify_accounts"; 57 58 /** 59 * Key for user restrictions. Specifies if a user is disallowed from changing Wi-Fi 60 * access points. 61 * The default value is <code>false</code>. 62 * <p/> 63 * Type: Boolean 64 * @see #setUserRestrictions(Bundle) 65 * @see #getUserRestrictions() 66 */ 67 public static final String DISALLOW_CONFIG_WIFI = "no_config_wifi"; 68 69 /** 70 * Key for user restrictions. Specifies if a user is disallowed from installing applications. 71 * The default value is <code>false</code>. 72 * <p/> 73 * Type: Boolean 74 * @see #setUserRestrictions(Bundle) 75 * @see #getUserRestrictions() 76 */ 77 public static final String DISALLOW_INSTALL_APPS = "no_install_apps"; 78 79 /** 80 * Key for user restrictions. Specifies if a user is disallowed from uninstalling applications. 81 * The default value is <code>false</code>. 82 * <p/> 83 * Type: Boolean 84 * @see #setUserRestrictions(Bundle) 85 * @see #getUserRestrictions() 86 */ 87 public static final String DISALLOW_UNINSTALL_APPS = "no_uninstall_apps"; 88 89 /** 90 * Key for user restrictions. Specifies if a user is disallowed from toggling location sharing. 91 * The default value is <code>false</code>. 92 * <p/> 93 * Type: Boolean 94 * @see #setUserRestrictions(Bundle) 95 * @see #getUserRestrictions() 96 */ 97 public static final String DISALLOW_SHARE_LOCATION = "no_share_location"; 98 99 /** 100 * Key for user restrictions. Specifies if a user is disallowed from enabling the 101 * "Unknown Sources" setting, that allows installation of apps from unknown sources. 102 * The default value is <code>false</code>. 103 * <p/> 104 * Type: Boolean 105 * @see #setUserRestrictions(Bundle) 106 * @see #getUserRestrictions() 107 */ 108 public static final String DISALLOW_INSTALL_UNKNOWN_SOURCES = "no_install_unknown_sources"; 109 110 /** 111 * Key for user restrictions. Specifies if a user is disallowed from configuring bluetooth. 112 * The default value is <code>false</code>. 113 * <p/> 114 * Type: Boolean 115 * @see #setUserRestrictions(Bundle) 116 * @see #getUserRestrictions() 117 */ 118 public static final String DISALLOW_CONFIG_BLUETOOTH = "no_config_bluetooth"; 119 120 /** 121 * Key for user restrictions. Specifies if a user is disallowed from transferring files over 122 * USB. The default value is <code>false</code>. 123 * <p/> 124 * Type: Boolean 125 * @see #setUserRestrictions(Bundle) 126 * @see #getUserRestrictions() 127 */ 128 public static final String DISALLOW_USB_FILE_TRANSFER = "no_usb_file_transfer"; 129 130 /** 131 * Key for user restrictions. Specifies if a user is disallowed from configuring user 132 * credentials. The default value is <code>false</code>. 133 * <p/> 134 * Type: Boolean 135 * @see #setUserRestrictions(Bundle) 136 * @see #getUserRestrictions() 137 */ 138 public static final String DISALLOW_CONFIG_CREDENTIALS = "no_config_credentials"; 139 140 /** 141 * Key for user restrictions. Specifies if a user is disallowed from removing itself and other 142 * users. 143 * The default value is <code>false</code>. 144 * <p/> 145 * Type: Boolean 146 * @see #setUserRestrictions(Bundle) 147 * @see #getUserRestrictions() 148 */ 149 public static final String DISALLOW_REMOVE_USER = "no_remove_user"; 150 151 /** 152 * Key for user restrictions. Specifies if a user is disallowed from enabling or 153 * accessing debugging features. The default value is <code>false</code>. 154 * <p/> 155 * Type: Boolean 156 * @see #setUserRestrictions(Bundle) 157 * @see #getUserRestrictions() 158 */ 159 public static final String DISALLOW_DEBUGGING_FEATURES = "no_debugging_features"; 160 161 /** 162 * Key for user restrictions. Specifies if a user is disallowed from configuring VPN. 163 * The default value is <code>false</code>. 164 * <p/> 165 * Type: Boolean 166 * @see #setUserRestrictions(Bundle) 167 * @see #getUserRestrictions() 168 */ 169 public static final String DISALLOW_CONFIG_VPN = "no_config_vpn"; 170 171 /** 172 * Key for user restrictions. Specifies if a user is disallowed from configuring Tethering 173 * & portable hotspots. The default value is <code>false</code>. 174 * <p/> 175 * Type: Boolean 176 * @see #setUserRestrictions(Bundle) 177 * @see #getUserRestrictions() 178 */ 179 public static final String DISALLOW_CONFIG_TETHERING = "no_config_tethering"; 180 181 /** 182 * Key for user restrictions. Specifies if a user is disallowed from factory resetting 183 * from Settings. 184 * The default value is <code>false</code>. 185 * <p> 186 * @see #setUserRestrictions(Bundle) 187 * @see #getUserRestrictions() 188 */ 189 public static final String DISALLOW_FACTORY_RESET = "no_factory_reset"; 190 191 /** 192 * Key for user restrictions. Specifies if a user is disallowed from adding new users and 193 * profiles. The default value is <code>false</code>. 194 * <p> 195 * Type: Boolean 196 * @see #setUserRestrictions(Bundle) 197 * @see #getUserRestrictions() 198 */ 199 public static final String DISALLOW_ADD_USER = "no_add_user"; 200 201 /** 202 * Key for user restrictions. Specifies if a user is disallowed from disabling application 203 * verification. The default value is <code>false</code>. 204 * <p> 205 * Type: Boolean 206 * @see #setUserRestrictions(Bundle) 207 * @see #getUserRestrictions() 208 */ 209 public static final String ENSURE_VERIFY_APPS = "ensure_verify_apps"; 210 211 /** 212 * Key for user restrictions. Specifies if a user is disallowed from configuring cell 213 * broadcasts. The default value is <code>false</code>. 214 * <p> 215 * Type: Boolean 216 * @see #setUserRestrictions(Bundle) 217 * @see #getUserRestrictions() 218 */ 219 public static final String DISALLOW_CONFIG_CELL_BROADCASTS = "no_config_cell_broadcasts"; 220 221 /** 222 * Key for user restrictions. Specifies if a user is disallowed from configuring mobile 223 * networks. The default value is <code>false</code>. 224 * <p> 225 * Type: Boolean 226 * @see #setUserRestrictions(Bundle) 227 * @see #getUserRestrictions() 228 */ 229 public static final String DISALLOW_CONFIG_MOBILE_NETWORKS = "no_config_mobile_networks"; 230 231 /** 232 * Key for user restrictions. Specifies if a user is disallowed from modifying 233 * applications in Settings or launchers. The following actions will not be allowed when this 234 * restriction is enabled: 235 * <li>uninstalling apps</li> 236 * <li>disabling apps</li> 237 * <li>clearing app caches</li> 238 * <li>clearing app data</li> 239 * <li>force stopping apps</li> 240 * <li>clearing app defaults</li> 241 * <p> 242 * The default value is <code>false</code>. 243 * <p> 244 * Type: Boolean 245 * @see #setUserRestrictions(Bundle) 246 * @see #getUserRestrictions() 247 */ 248 public static final String DISALLOW_APPS_CONTROL = "no_control_apps"; 249 250 /** 251 * Key for user restrictions. Specifies if a user is disallowed from mounting 252 * physical external media. The default value is <code>false</code>. 253 * <p/> 254 * Type: Boolean 255 * @see #setUserRestrictions(Bundle) 256 * @see #getUserRestrictions() 257 */ 258 public static final String DISALLOW_MOUNT_PHYSICAL_MEDIA = "no_physical_media"; 259 260 /** 261 * Key for user restrictions. Specifies if a user is disallowed from adjusting microphone 262 * volume. 263 * The default value is <code>false</code>. 264 * <p/> 265 * Type: Boolean 266 * @see #setUserRestrictions(Bundle) 267 * @see #getUserRestrictions() 268 */ 269 public static final String DISALLOW_UNMUTE_MICROPHONE = "no_unmute_microphone"; 270 271 /** 272 * Key for user restrictions. Specifies if a user is disallowed from adjusting the master 273 * volume. 274 * The default value is <code>false</code>. 275 * <p/> 276 * Type: Boolean 277 * @see #setUserRestrictions(Bundle) 278 * @see #getUserRestrictions() 279 */ 280 public static final String DISALLOW_ADJUST_VOLUME = "no_adjust_volume"; 281 282 /** 283 * Key for user restrictions. Specifies that the user is not allowed to make outgoing 284 * phone calls. Emergency calls are still permitted. 285 * The default value is <code>false</code>. 286 * <p/> 287 * Type: Boolean 288 * @see #setUserRestrictions(Bundle) 289 * @see #getUserRestrictions() 290 */ 291 public static final String DISALLOW_OUTGOING_CALLS = "no_outgoing_calls"; 292 293 /** 294 * Key for user restrictions. Specifies that the user is not allowed to send or receive 295 * SMS messages. 296 * The default value is <code>false</code>. 297 * <p/> 298 * Type: Boolean 299 * @see #setUserRestrictions(Bundle) 300 * @see #getUserRestrictions() 301 */ 302 public static final String DISALLOW_SMS = "no_sms"; 303 304 /** 305 * Key for user restrictions. Specifies that windows besides app windows should not be 306 * created. This will block the creation of the following types of windows. 307 * <li>{@link LayoutParams#TYPE_TOAST}</li> 308 * <li>{@link LayoutParams#TYPE_PHONE}</li> 309 * <li>{@link LayoutParams#TYPE_PRIORITY_PHONE}</li> 310 * <li>{@link LayoutParams#TYPE_SYSTEM_ALERT}</li> 311 * <li>{@link LayoutParams#TYPE_SYSTEM_ERROR}</li> 312 * <li>{@link LayoutParams#TYPE_SYSTEM_OVERLAY}</li> 313 * 314 * <p>The default value is <code>false</code>. 315 * <p/> 316 * Type: Boolean 317 * @see #setUserRestrictions(Bundle) 318 * @see #getUserRestrictions() 319 */ 320 public static final String DISALLOW_CREATE_WINDOWS = "no_create_windows"; 321 322 /** 323 * Key for user restrictions. Specifies if what is copied in the clipboard of this profile can 324 * be pasted in related profiles. Does not restrict if the clipboard of related profiles can be 325 * pasted in this profile. 326 * The default value is <code>false</code>. 327 * <p/> 328 * Type: Boolean 329 * @see #setUserRestrictions(Bundle) 330 * @see #getUserRestrictions() 331 */ 332 public static final String DISALLOW_CROSS_PROFILE_COPY_PASTE = "no_cross_profile_copy_paste"; 333 334 /** @hide */ 335 public static final int PIN_VERIFICATION_FAILED_INCORRECT = -3; 336 /** @hide */ 337 public static final int PIN_VERIFICATION_FAILED_NOT_SET = -2; 338 /** @hide */ 339 public static final int PIN_VERIFICATION_SUCCESS = -1; 340 341 private static UserManager sInstance = null; 342 343 /** @hide */ 344 public synchronized static UserManager get(Context context) { 345 if (sInstance == null) { 346 sInstance = (UserManager) context.getSystemService(Context.USER_SERVICE); 347 } 348 return sInstance; 349 } 350 351 /** @hide */ 352 public UserManager(Context context, IUserManager service) { 353 mService = service; 354 mContext = context; 355 } 356 357 /** 358 * Returns whether the system supports multiple users. 359 * @return true if multiple users can be created by user, false if it is a single user device. 360 * @hide 361 */ 362 public static boolean supportsMultipleUsers() { 363 return getMaxSupportedUsers() > 1 364 && SystemProperties.getBoolean("fw.show_multiuserui", 365 Resources.getSystem().getBoolean(R.bool.config_enableMultiUserUI)); 366 } 367 368 /** 369 * Returns the user handle for the user that the calling process is running on. 370 * 371 * @return the user handle of the user making this call. 372 * @hide 373 */ 374 public int getUserHandle() { 375 return UserHandle.myUserId(); 376 } 377 378 /** 379 * Returns the user name of the user making this call. This call is only 380 * available to applications on the system image; it requires the 381 * MANAGE_USERS permission. 382 * @return the user name 383 */ 384 public String getUserName() { 385 try { 386 return mService.getUserInfo(getUserHandle()).name; 387 } catch (RemoteException re) { 388 Log.w(TAG, "Could not get user name", re); 389 return ""; 390 } 391 } 392 393 /** 394 * Used to determine whether the user making this call is subject to 395 * teleportations. 396 * @return whether the user making this call is a goat 397 */ 398 public boolean isUserAGoat() { 399 return false; 400 } 401 402 /** 403 * Used to check if the user making this call is linked to another user. Linked users may have 404 * a reduced number of available apps, app restrictions and account restrictions. 405 * @return whether the user making this call is a linked user 406 * @hide 407 */ 408 public boolean isLinkedUser() { 409 try { 410 return mService.isRestricted(); 411 } catch (RemoteException re) { 412 Log.w(TAG, "Could not check if user is limited ", re); 413 return false; 414 } 415 } 416 417 /** 418 * Checks if the calling app is running as a guest user. 419 * @return whether the caller is a guest user. 420 * @hide 421 */ 422 public boolean isGuestUser() { 423 UserInfo user = getUserInfo(UserHandle.myUserId()); 424 return user != null ? user.isGuest() : false; 425 } 426 427 /** 428 * Return whether the given user is actively running. This means that 429 * the user is in the "started" state, not "stopped" -- it is currently 430 * allowed to run code through scheduled alarms, receiving broadcasts, 431 * etc. A started user may be either the current foreground user or a 432 * background user; the result here does not distinguish between the two. 433 * @param user The user to retrieve the running state for. 434 */ 435 public boolean isUserRunning(UserHandle user) { 436 try { 437 return ActivityManagerNative.getDefault().isUserRunning( 438 user.getIdentifier(), false); 439 } catch (RemoteException e) { 440 return false; 441 } 442 } 443 444 /** 445 * Return whether the given user is actively running <em>or</em> stopping. 446 * This is like {@link #isUserRunning(UserHandle)}, but will also return 447 * true if the user had been running but is in the process of being stopped 448 * (but is not yet fully stopped, and still running some code). 449 * @param user The user to retrieve the running state for. 450 */ 451 public boolean isUserRunningOrStopping(UserHandle user) { 452 try { 453 return ActivityManagerNative.getDefault().isUserRunning( 454 user.getIdentifier(), true); 455 } catch (RemoteException e) { 456 return false; 457 } 458 } 459 460 /** 461 * Returns the UserInfo object describing a specific user. 462 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 463 * @param userHandle the user handle of the user whose information is being requested. 464 * @return the UserInfo object for a specific user. 465 * @hide 466 */ 467 public UserInfo getUserInfo(int userHandle) { 468 try { 469 return mService.getUserInfo(userHandle); 470 } catch (RemoteException re) { 471 Log.w(TAG, "Could not get user info", re); 472 return null; 473 } 474 } 475 476 /** 477 * Returns the user-wide restrictions imposed on this user. 478 * @return a Bundle containing all the restrictions. 479 */ 480 public Bundle getUserRestrictions() { 481 return getUserRestrictions(Process.myUserHandle()); 482 } 483 484 /** 485 * Returns the user-wide restrictions imposed on the user specified by <code>userHandle</code>. 486 * @param userHandle the UserHandle of the user for whom to retrieve the restrictions. 487 * @return a Bundle containing all the restrictions. 488 */ 489 public Bundle getUserRestrictions(UserHandle userHandle) { 490 try { 491 return mService.getUserRestrictions(userHandle.getIdentifier()); 492 } catch (RemoteException re) { 493 Log.w(TAG, "Could not get user restrictions", re); 494 return Bundle.EMPTY; 495 } 496 } 497 498 /** 499 * Sets all the user-wide restrictions for this user. 500 * Requires the MANAGE_USERS permission. 501 * @param restrictions the Bundle containing all the restrictions. 502 */ 503 public void setUserRestrictions(Bundle restrictions) { 504 setUserRestrictions(restrictions, Process.myUserHandle()); 505 } 506 507 /** 508 * Sets all the user-wide restrictions for the specified user. 509 * Requires the MANAGE_USERS permission. 510 * @param restrictions the Bundle containing all the restrictions. 511 * @param userHandle the UserHandle of the user for whom to set the restrictions. 512 */ 513 public void setUserRestrictions(Bundle restrictions, UserHandle userHandle) { 514 try { 515 mService.setUserRestrictions(restrictions, userHandle.getIdentifier()); 516 } catch (RemoteException re) { 517 Log.w(TAG, "Could not set user restrictions", re); 518 } 519 } 520 521 /** 522 * Sets the value of a specific restriction. 523 * Requires the MANAGE_USERS permission. 524 * @param key the key of the restriction 525 * @param value the value for the restriction 526 */ 527 public void setUserRestriction(String key, boolean value) { 528 Bundle bundle = getUserRestrictions(); 529 bundle.putBoolean(key, value); 530 setUserRestrictions(bundle); 531 } 532 533 /** 534 * @hide 535 * Sets the value of a specific restriction on a specific user. 536 * Requires the MANAGE_USERS permission. 537 * @param key the key of the restriction 538 * @param value the value for the restriction 539 * @param userHandle the user whose restriction is to be changed. 540 */ 541 public void setUserRestriction(String key, boolean value, UserHandle userHandle) { 542 Bundle bundle = getUserRestrictions(userHandle); 543 bundle.putBoolean(key, value); 544 setUserRestrictions(bundle, userHandle); 545 } 546 547 /** 548 * Returns whether the current user has been disallowed from performing certain actions 549 * or setting certain settings. 550 * 551 * @param restrictionKey The string key representing the restriction. 552 * @return {@code true} if the current user has the given restriction, {@code false} otherwise. 553 */ 554 public boolean hasUserRestriction(String restrictionKey) { 555 return hasUserRestriction(restrictionKey, Process.myUserHandle()); 556 } 557 558 /** 559 * @hide 560 * Returns whether the given user has been disallowed from performing certain actions 561 * or setting certain settings. 562 * @param restrictionKey the string key representing the restriction 563 * @param userHandle the UserHandle of the user for whom to retrieve the restrictions. 564 */ 565 public boolean hasUserRestriction(String restrictionKey, UserHandle userHandle) { 566 return getUserRestrictions(userHandle).getBoolean(restrictionKey, false); 567 } 568 569 /** 570 * Return the serial number for a user. This is a device-unique 571 * number assigned to that user; if the user is deleted and then a new 572 * user created, the new users will not be given the same serial number. 573 * @param user The user whose serial number is to be retrieved. 574 * @return The serial number of the given user; returns -1 if the 575 * given UserHandle does not exist. 576 * @see #getUserForSerialNumber(long) 577 */ 578 public long getSerialNumberForUser(UserHandle user) { 579 return getUserSerialNumber(user.getIdentifier()); 580 } 581 582 /** 583 * Return the user associated with a serial number previously 584 * returned by {@link #getSerialNumberForUser(UserHandle)}. 585 * @param serialNumber The serial number of the user that is being 586 * retrieved. 587 * @return Return the user associated with the serial number, or null 588 * if there is not one. 589 * @see #getSerialNumberForUser(UserHandle) 590 */ 591 public UserHandle getUserForSerialNumber(long serialNumber) { 592 int ident = getUserHandle((int)serialNumber); 593 return ident >= 0 ? new UserHandle(ident) : null; 594 } 595 596 /** 597 * Creates a user with the specified name and options. 598 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 599 * 600 * @param name the user's name 601 * @param flags flags that identify the type of user and other properties. 602 * @see UserInfo 603 * 604 * @return the UserInfo object for the created user, or null if the user could not be created. 605 * @hide 606 */ 607 public UserInfo createUser(String name, int flags) { 608 try { 609 return mService.createUser(name, flags); 610 } catch (RemoteException re) { 611 Log.w(TAG, "Could not create a user", re); 612 return null; 613 } 614 } 615 616 /** 617 * Creates a guest user and configures it. 618 * @param context an application context 619 * @param name the name to set for the user 620 * @hide 621 */ 622 public UserInfo createGuest(Context context, String name) { 623 UserInfo guest = createUser(name, UserInfo.FLAG_GUEST); 624 if (guest != null) { 625 Settings.Secure.putStringForUser(context.getContentResolver(), 626 Settings.Secure.SKIP_FIRST_USE_HINTS, "1", guest.id); 627 try { 628 Bundle guestRestrictions = mService.getDefaultGuestRestrictions(); 629 guestRestrictions.putBoolean(DISALLOW_SMS, true); 630 mService.setUserRestrictions(guestRestrictions, guest.id); 631 } catch (RemoteException re) { 632 Log.w(TAG, "Could not update guest restrictions"); 633 } 634 } 635 return guest; 636 } 637 638 /** 639 * Creates a user with the specified name and options as a profile of another user. 640 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 641 * 642 * @param name the user's name 643 * @param flags flags that identify the type of user and other properties. 644 * @see UserInfo 645 * @param userHandle new user will be a profile of this use. 646 * 647 * @return the UserInfo object for the created user, or null if the user could not be created. 648 * @hide 649 */ 650 public UserInfo createProfileForUser(String name, int flags, int userHandle) { 651 try { 652 return mService.createProfileForUser(name, flags, userHandle); 653 } catch (RemoteException re) { 654 Log.w(TAG, "Could not create a user", re); 655 return null; 656 } 657 } 658 659 /** 660 * Sets the user as enabled, if such an user exists. 661 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 662 * Note that the default is true, it's only that managed profiles might not be enabled. 663 * 664 * @param userHandle the id of the profile to enable 665 * @hide 666 */ 667 public void setUserEnabled(int userHandle) { 668 try { 669 mService.setUserEnabled(userHandle); 670 } catch (RemoteException e) { 671 Log.w(TAG, "Could not enable the profile", e); 672 } 673 } 674 675 /** 676 * Return the number of users currently created on the device. 677 */ 678 public int getUserCount() { 679 List<UserInfo> users = getUsers(); 680 return users != null ? users.size() : 1; 681 } 682 683 /** 684 * Returns information for all users on this device. 685 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 686 * @return the list of users that were created. 687 * @hide 688 */ 689 public List<UserInfo> getUsers() { 690 try { 691 return mService.getUsers(false); 692 } catch (RemoteException re) { 693 Log.w(TAG, "Could not get user list", re); 694 return null; 695 } 696 } 697 698 /** 699 * Returns list of the profiles of userHandle including 700 * userHandle itself. 701 * Note that it this returns both enabled and not enabled profiles. See 702 * {@link #getUserProfiles()} if you need only the enabled ones. 703 * 704 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 705 * @param userHandle profiles of this user will be returned. 706 * @return the list of profiles. 707 * @hide 708 */ 709 public List<UserInfo> getProfiles(int userHandle) { 710 try { 711 return mService.getProfiles(userHandle, false /* enabledOnly */); 712 } catch (RemoteException re) { 713 Log.w(TAG, "Could not get user list", re); 714 return null; 715 } 716 } 717 718 /** 719 * Returns a list of UserHandles for profiles associated with the user that the calling process 720 * is running on, including the user itself. 721 * 722 * @return A non-empty list of UserHandles associated with the calling user. 723 */ 724 public List<UserHandle> getUserProfiles() { 725 ArrayList<UserHandle> profiles = new ArrayList<UserHandle>(); 726 List<UserInfo> users = new ArrayList<UserInfo>(); 727 try { 728 users = mService.getProfiles(UserHandle.myUserId(), true /* enabledOnly */); 729 } catch (RemoteException re) { 730 Log.w(TAG, "Could not get user list", re); 731 return null; 732 } 733 for (UserInfo info : users) { 734 UserHandle userHandle = new UserHandle(info.id); 735 profiles.add(userHandle); 736 } 737 return profiles; 738 } 739 740 /** 741 * Returns the parent of the profile which this method is called from 742 * or null if called from a user that is not a profile. 743 * 744 * @hide 745 */ 746 public UserInfo getProfileParent(int userHandle) { 747 try { 748 return mService.getProfileParent(userHandle); 749 } catch (RemoteException re) { 750 Log.w(TAG, "Could not get profile parent", re); 751 return null; 752 } 753 } 754 755 /** 756 * If the target user is a managed profile of the calling user or the caller 757 * is itself a managed profile, then this returns a badged copy of the given 758 * icon to be able to distinguish it from the original icon. For badging an 759 * arbitrary drawable use {@link #getBadgedDrawableForUser( 760 * android.graphics.drawable.Drawable, UserHandle, android.graphics.Rect, int)}. 761 * <p> 762 * If the original drawable is a BitmapDrawable and the backing bitmap is 763 * mutable as per {@link android.graphics.Bitmap#isMutable()}, the bading 764 * is performed in place and the original drawable is returned. 765 * </p> 766 * 767 * @param icon The icon to badge. 768 * @param user The target user. 769 * @return A drawable that combines the original icon and a badge as 770 * determined by the system. 771 */ 772 public Drawable getBadgedIconForUser(Drawable icon, UserHandle user) { 773 final int badgeResId = getBadgeResIdForUser(user.getIdentifier()); 774 if (badgeResId == 0) { 775 return icon; 776 } 777 Drawable badgeIcon = mContext.getPackageManager() 778 .getDrawable("system", badgeResId, null); 779 return getBadgedDrawable(icon, badgeIcon, null, true); 780 } 781 782 /** 783 * If the target user is a managed profile of the calling user or the caller 784 * is itself a managed profile, then this returns a badged copy of the given 785 * icon to be able to distinguish it from the original icon. 786 * <p> 787 * If the original drawable is not a BitmapDrawable, then the original 788 * drawable is returned. 789 * </p> 790 * 791 * @param icon The icon to badge. 792 * @param user The target user. 793 * @return A drawable that combines the original icon and a badge as 794 * determined by the system. 795 * 796 * @deprecation Use {@link #getBadgedIconForUser( 797 * android.graphics.drawable.Drawable, UserHandle)} 798 * 799 * @hide 800 */ 801 @Deprecated 802 public Drawable getBadgedDrawableForUser(Drawable icon, UserHandle user) { 803 int badgeResId = getBadgeResIdForUser(user.getIdentifier()); 804 if (badgeResId == 0) { 805 return icon; 806 } else { 807 Drawable badgeIcon = mContext.getPackageManager() 808 .getDrawable("system", badgeResId, null); 809 return getBadgedDrawable(icon, badgeIcon, null, false); 810 } 811 } 812 813 /** 814 * If the target user is a managed profile of the calling user or the caller 815 * is itself a managed profile, then this returns a badged copy of the given 816 * drawable allowing the user to distinguish it from the original drawable. 817 * The caller can specify the location in the bounds of the drawable to be 818 * badged where the badge should be applied as well as the density of the 819 * badge to be used. 820 * <p> 821 * If the original drawable is a BitmapDrawable and the backing bitmap is 822 * mutable as per {@link android.graphics.Bitmap#isMutable()}, the bading 823 * is performed in place and the original drawable is returned. 824 * </p> 825 * 826 * @param badgedDrawable The drawable to badge. 827 * @param user The target user. 828 * @param badgeLocation Where in the bounds of the badged drawable to place 829 * the badge. If not provided, the badge is applied on top of the entire 830 * drawable being badged. 831 * @param badgeDensity The optional desired density for the badge as per 832 * {@link android.util.DisplayMetrics#densityDpi}. If not provided, 833 * the density of the display is used. 834 * @return A drawable that combines the original drawable and a badge as 835 * determined by the system. 836 */ 837 public Drawable getBadgedDrawableForUser(Drawable badgedDrawable, UserHandle user, 838 Rect badgeLocation, int badgeDensity) { 839 Drawable badgeDrawable = getBadgeForUser(user, badgeDensity); 840 if (badgeDrawable == null) { 841 return badgedDrawable; 842 } 843 return getBadgedDrawable(badgedDrawable, badgeDrawable, badgeLocation, true); 844 } 845 846 /** 847 * If the target user is a managed profile of the calling user or the caller 848 * is itself a managed profile, then this returns a copy of the label with 849 * badging for accessibility services like talkback. E.g. passing in "Email" 850 * and it might return "Work Email" for Email in the work profile. 851 * 852 * @param label The label to change. 853 * @param user The target user. 854 * @return A label that combines the original label and a badge as 855 * determined by the system. 856 */ 857 public CharSequence getBadgedLabelForUser(CharSequence label, UserHandle user) { 858 UserInfo userInfo = getUserIfProfile(user.getIdentifier()); 859 if (userInfo != null && userInfo.isManagedProfile()) { 860 return Resources.getSystem().getString( 861 R.string.managed_profile_label_badge, label); 862 } 863 return label; 864 } 865 866 /** 867 * If the target user is a managed profile of the calling user or the caller 868 * is itself a managed profile, then this returns a drawable to use as a small 869 * icon to include in a view to distinguish it from the original icon. 870 * 871 * @param user The target user. 872 * @param density The optional desired density for the badge as per 873 * {@link android.util.DisplayMetrics#densityDpi}. If not provided 874 * the density of the current display is used. 875 * @return the drawable or null if no drawable is required. 876 * @hide 877 */ 878 public Drawable getBadgeForUser(UserHandle user, int density) { 879 UserInfo userInfo = getUserIfProfile(user.getIdentifier()); 880 if (userInfo != null && userInfo.isManagedProfile()) { 881 if (density <= 0) { 882 density = mContext.getResources().getDisplayMetrics().densityDpi; 883 } 884 return Resources.getSystem().getDrawableForDensity( 885 com.android.internal.R.drawable.ic_corp_badge, density); 886 } 887 return null; 888 } 889 890 private int getBadgeResIdForUser(int userHandle) { 891 // Return the framework-provided badge. 892 UserInfo userInfo = getUserIfProfile(userHandle); 893 if (userInfo != null && userInfo.isManagedProfile()) { 894 return com.android.internal.R.drawable.ic_corp_icon_badge; 895 } 896 return 0; 897 } 898 899 /** 900 * @return UserInfo for userHandle if it exists and is a profile of the current 901 * user or null. 902 */ 903 private UserInfo getUserIfProfile(int userHandle) { 904 List<UserInfo> userProfiles = getProfiles(getUserHandle()); 905 for (UserInfo user : userProfiles) { 906 if (user.id == userHandle) { 907 return user; 908 } 909 } 910 return null; 911 } 912 913 private Drawable getBadgedDrawable(Drawable badgedDrawable, Drawable badgeDrawable, 914 Rect badgeLocation, boolean tryBadgeInPlace) { 915 final int badgedWidth = badgedDrawable.getIntrinsicWidth(); 916 final int badgedHeight = badgedDrawable.getIntrinsicHeight(); 917 final boolean canBadgeInPlace = tryBadgeInPlace 918 && (badgedDrawable instanceof BitmapDrawable) 919 && ((BitmapDrawable) badgedDrawable).getBitmap().isMutable(); 920 921 final Bitmap bitmap; 922 if (canBadgeInPlace) { 923 bitmap = ((BitmapDrawable) badgedDrawable).getBitmap(); 924 } else { 925 bitmap = Bitmap.createBitmap(badgedWidth, badgedHeight, Config.ARGB_8888); 926 } 927 Canvas canvas = new Canvas(bitmap); 928 929 if (!canBadgeInPlace) { 930 badgedDrawable.setBounds(0, 0, badgedWidth, badgedHeight); 931 badgedDrawable.draw(canvas); 932 } 933 934 if (badgeLocation != null) { 935 if (badgeLocation.left < 0 || badgeLocation.top < 0 936 || badgeLocation.right > badgedWidth || badgeLocation.bottom > badgedHeight) { 937 throw new IllegalArgumentException("Badge location " + badgeLocation 938 + " not in badged drawable bounds " 939 + new Rect(0, 0, badgedWidth, badgedHeight)); 940 } 941 badgeDrawable.setBounds(0, 0, badgeLocation.width(), badgeLocation.height()); 942 943 canvas.save(); 944 canvas.translate(badgeLocation.left, badgeLocation.top); 945 badgeDrawable.draw(canvas); 946 canvas.restore(); 947 } else { 948 badgeDrawable.setBounds(0, 0, badgedWidth, badgedHeight); 949 badgeDrawable.draw(canvas); 950 } 951 952 if (!canBadgeInPlace) { 953 BitmapDrawable mergedDrawable = new BitmapDrawable(mContext.getResources(), bitmap); 954 955 if (badgedDrawable instanceof BitmapDrawable) { 956 BitmapDrawable bitmapDrawable = (BitmapDrawable) badgedDrawable; 957 mergedDrawable.setTargetDensity(bitmapDrawable.getBitmap().getDensity()); 958 } 959 960 return mergedDrawable; 961 } 962 963 return badgedDrawable; 964 } 965 966 /** 967 * Returns information for all users on this device. Requires 968 * {@link android.Manifest.permission#MANAGE_USERS} permission. 969 * 970 * @param excludeDying specify if the list should exclude users being 971 * removed. 972 * @return the list of users that were created. 973 * @hide 974 */ 975 public List<UserInfo> getUsers(boolean excludeDying) { 976 try { 977 return mService.getUsers(excludeDying); 978 } catch (RemoteException re) { 979 Log.w(TAG, "Could not get user list", re); 980 return null; 981 } 982 } 983 984 /** 985 * Removes a user and all associated data. 986 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 987 * @param userHandle the integer handle of the user, where 0 is the primary user. 988 * @hide 989 */ 990 public boolean removeUser(int userHandle) { 991 try { 992 return mService.removeUser(userHandle); 993 } catch (RemoteException re) { 994 Log.w(TAG, "Could not remove user ", re); 995 return false; 996 } 997 } 998 999 /** 1000 * Updates the user's name. 1001 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 1002 * 1003 * @param userHandle the user's integer handle 1004 * @param name the new name for the user 1005 * @hide 1006 */ 1007 public void setUserName(int userHandle, String name) { 1008 try { 1009 mService.setUserName(userHandle, name); 1010 } catch (RemoteException re) { 1011 Log.w(TAG, "Could not set the user name ", re); 1012 } 1013 } 1014 1015 /** 1016 * Sets the user's photo. 1017 * @param userHandle the user for whom to change the photo. 1018 * @param icon the bitmap to set as the photo. 1019 * @hide 1020 */ 1021 public void setUserIcon(int userHandle, Bitmap icon) { 1022 try { 1023 mService.setUserIcon(userHandle, icon); 1024 } catch (RemoteException re) { 1025 Log.w(TAG, "Could not set the user icon ", re); 1026 } 1027 } 1028 1029 /** 1030 * Returns a file descriptor for the user's photo. PNG data can be read from this file. 1031 * @param userHandle the user whose photo we want to read. 1032 * @return a {@link Bitmap} of the user's photo, or null if there's no photo. 1033 * @hide 1034 */ 1035 public Bitmap getUserIcon(int userHandle) { 1036 try { 1037 return mService.getUserIcon(userHandle); 1038 } catch (RemoteException re) { 1039 Log.w(TAG, "Could not get the user icon ", re); 1040 return null; 1041 } 1042 } 1043 1044 /** 1045 * Returns the maximum number of users that can be created on this device. A return value 1046 * of 1 means that it is a single user device. 1047 * @hide 1048 * @return a value greater than or equal to 1 1049 */ 1050 public static int getMaxSupportedUsers() { 1051 // Don't allow multiple users on certain builds 1052 if (android.os.Build.ID.startsWith("JVP")) return 1; 1053 // Svelte devices don't get multi-user. 1054 if (ActivityManager.isLowRamDeviceStatic()) return 1; 1055 return SystemProperties.getInt("fw.max_users", 1056 Resources.getSystem().getInteger(R.integer.config_multiuserMaximumUsers)); 1057 } 1058 1059 /** 1060 * Returns true if the user switcher should be shown, this will be if there 1061 * are multiple users that aren't managed profiles. 1062 * @hide 1063 * @return true if user switcher should be shown. 1064 */ 1065 public boolean isUserSwitcherEnabled() { 1066 List<UserInfo> users = getUsers(true); 1067 if (users == null) { 1068 return false; 1069 } 1070 int switchableUserCount = 0; 1071 for (UserInfo user : users) { 1072 if (user.supportsSwitchTo()) { 1073 ++switchableUserCount; 1074 } 1075 } 1076 final boolean guestEnabled = Settings.Global.getInt(mContext.getContentResolver(), 1077 Settings.Global.GUEST_USER_ENABLED, 0) == 1; 1078 return switchableUserCount > 1 || guestEnabled; 1079 } 1080 1081 /** 1082 * Returns a serial number on this device for a given userHandle. User handles can be recycled 1083 * when deleting and creating users, but serial numbers are not reused until the device is wiped. 1084 * @param userHandle 1085 * @return a serial number associated with that user, or -1 if the userHandle is not valid. 1086 * @hide 1087 */ 1088 public int getUserSerialNumber(int userHandle) { 1089 try { 1090 return mService.getUserSerialNumber(userHandle); 1091 } catch (RemoteException re) { 1092 Log.w(TAG, "Could not get serial number for user " + userHandle); 1093 } 1094 return -1; 1095 } 1096 1097 /** 1098 * Returns a userHandle on this device for a given user serial number. User handles can be 1099 * recycled when deleting and creating users, but serial numbers are not reused until the device 1100 * is wiped. 1101 * @param userSerialNumber 1102 * @return the userHandle associated with that user serial number, or -1 if the serial number 1103 * is not valid. 1104 * @hide 1105 */ 1106 public int getUserHandle(int userSerialNumber) { 1107 try { 1108 return mService.getUserHandle(userSerialNumber); 1109 } catch (RemoteException re) { 1110 Log.w(TAG, "Could not get userHandle for user " + userSerialNumber); 1111 } 1112 return -1; 1113 } 1114 1115 /** 1116 * Returns a Bundle containing any saved application restrictions for this user, for the 1117 * given package name. Only an application with this package name can call this method. 1118 * @param packageName the package name of the calling application 1119 * @return a Bundle with the restrictions as key/value pairs, or null if there are no 1120 * saved restrictions. The values can be of type Boolean, String or String[], depending 1121 * on the restriction type, as defined by the application. 1122 */ 1123 public Bundle getApplicationRestrictions(String packageName) { 1124 try { 1125 return mService.getApplicationRestrictions(packageName); 1126 } catch (RemoteException re) { 1127 Log.w(TAG, "Could not get application restrictions for package " + packageName); 1128 } 1129 return null; 1130 } 1131 1132 /** 1133 * @hide 1134 */ 1135 public Bundle getApplicationRestrictions(String packageName, UserHandle user) { 1136 try { 1137 return mService.getApplicationRestrictionsForUser(packageName, user.getIdentifier()); 1138 } catch (RemoteException re) { 1139 Log.w(TAG, "Could not get application restrictions for user " + user.getIdentifier()); 1140 } 1141 return null; 1142 } 1143 1144 /** 1145 * @hide 1146 */ 1147 public void setApplicationRestrictions(String packageName, Bundle restrictions, 1148 UserHandle user) { 1149 try { 1150 mService.setApplicationRestrictions(packageName, restrictions, user.getIdentifier()); 1151 } catch (RemoteException re) { 1152 Log.w(TAG, "Could not set application restrictions for user " + user.getIdentifier()); 1153 } 1154 } 1155 1156 /** 1157 * Sets a new challenge PIN for restrictions. This is only for use by pre-installed 1158 * apps and requires the MANAGE_USERS permission. 1159 * @param newPin the PIN to use for challenge dialogs. 1160 * @return Returns true if the challenge PIN was set successfully. 1161 */ 1162 public boolean setRestrictionsChallenge(String newPin) { 1163 try { 1164 return mService.setRestrictionsChallenge(newPin); 1165 } catch (RemoteException re) { 1166 Log.w(TAG, "Could not change restrictions pin"); 1167 } 1168 return false; 1169 } 1170 1171 /** 1172 * @hide 1173 * @param pin The PIN to verify, or null to get the number of milliseconds to wait for before 1174 * allowing the user to enter the PIN. 1175 * @return Returns a positive number (including zero) for how many milliseconds before 1176 * you can accept another PIN, when the input is null or the input doesn't match the saved PIN. 1177 * Returns {@link #PIN_VERIFICATION_SUCCESS} if the input matches the saved PIN. Returns 1178 * {@link #PIN_VERIFICATION_FAILED_NOT_SET} if there is no PIN set. 1179 */ 1180 public int checkRestrictionsChallenge(String pin) { 1181 try { 1182 return mService.checkRestrictionsChallenge(pin); 1183 } catch (RemoteException re) { 1184 Log.w(TAG, "Could not check restrictions pin"); 1185 } 1186 return PIN_VERIFICATION_FAILED_INCORRECT; 1187 } 1188 1189 /** 1190 * @hide 1191 * Checks whether the user has restrictions that are PIN-protected. An application that 1192 * participates in restrictions can check if the owner has requested a PIN challenge for 1193 * any restricted operations. If there is a PIN in effect, the application should launch 1194 * the PIN challenge activity {@link android.content.Intent#ACTION_RESTRICTIONS_CHALLENGE}. 1195 * @see android.content.Intent#ACTION_RESTRICTIONS_CHALLENGE 1196 * @return whether a restrictions PIN is in effect. 1197 */ 1198 public boolean hasRestrictionsChallenge() { 1199 try { 1200 return mService.hasRestrictionsChallenge(); 1201 } catch (RemoteException re) { 1202 Log.w(TAG, "Could not change restrictions pin"); 1203 } 1204 return false; 1205 } 1206 1207 /** @hide */ 1208 public void removeRestrictions() { 1209 try { 1210 mService.removeRestrictions(); 1211 } catch (RemoteException re) { 1212 Log.w(TAG, "Could not change restrictions pin"); 1213 } 1214 } 1215 1216 /** 1217 * @hide 1218 * Set restrictions that should apply to any future guest user that's created. 1219 */ 1220 public void setDefaultGuestRestrictions(Bundle restrictions) { 1221 try { 1222 mService.setDefaultGuestRestrictions(restrictions); 1223 } catch (RemoteException re) { 1224 Log.w(TAG, "Could not set guest restrictions"); 1225 } 1226 } 1227 1228 /** 1229 * @hide 1230 * Gets the default guest restrictions. 1231 */ 1232 public Bundle getDefaultGuestRestrictions() { 1233 try { 1234 return mService.getDefaultGuestRestrictions(); 1235 } catch (RemoteException re) { 1236 Log.w(TAG, "Could not set guest restrictions"); 1237 } 1238 return new Bundle(); 1239 } 1240} 1241