From 36e74d4db8300935d535c77aa760cbc76a6b4437 Mon Sep 17 00:00:00 2001
From: Felipe Leme <felipeal@google.com>
Date: Thu, 21 Jul 2022 14:48:22 -0700
Subject: [PATCH] Initial implementation of UserManager.isUserVisible().

This API will be used to determine if the user is interacting with
the device and hence is able to do stuff like launching activities.

This initial version only returns true for the current foreground
user, but it will be expanded to also return true for:

- Background users associated with secondary displays
- (Running) profile of other visible users

Test: atest CtsMultiUserTestCases:android.multiuser.cts.UserManagerTest#testIsUserVisible_currentUser
Test: manual verification with Automotive's KitchenSink
Test: m update-api
Bug: 239824814

Change-Id: Ie8da07f69898d2b376bcf60d1da4221aed03ee3b
---
 core/api/current.txt                          |  1 +
 core/java/android/os/IUserManager.aidl        |  1 +
 core/java/android/os/UserManager.java         | 24 +++++++++++++++++++
 .../android/server/pm/UserManagerService.java |  6 +++++
 4 files changed, 32 insertions(+)

diff --git a/core/api/current.txt b/core/api/current.txt
index da3746d07bada..41f30de1f477c 100644
--- a/core/api/current.txt
+++ b/core/api/current.txt
@@ -32263,6 +32263,7 @@ package android.os {
     method @RequiresPermission(anyOf={"android.permission.MANAGE_USERS", "android.permission.INTERACT_ACROSS_USERS"}, conditional=true) public boolean isUserRunningOrStopping(android.os.UserHandle);
     method public boolean isUserUnlocked();
     method @RequiresPermission(anyOf={"android.permission.MANAGE_USERS", "android.permission.INTERACT_ACROSS_USERS"}, conditional=true) public boolean isUserUnlocked(android.os.UserHandle);
+    method public boolean isUserVisible();
     method @RequiresPermission(anyOf={"android.permission.MANAGE_USERS", "android.permission.MODIFY_QUIET_MODE"}, conditional=true) public boolean requestQuietModeEnabled(boolean, @NonNull android.os.UserHandle);
     method public boolean requestQuietModeEnabled(boolean, @NonNull android.os.UserHandle, int);
     method @Deprecated public boolean setRestrictionsChallenge(String);
diff --git a/core/java/android/os/IUserManager.aidl b/core/java/android/os/IUserManager.aidl
index e5de3e157c88c..f69d6b0652467 100644
--- a/core/java/android/os/IUserManager.aidl
+++ b/core/java/android/os/IUserManager.aidl
@@ -125,6 +125,7 @@ interface IUserManager {
     boolean isUserUnlocked(int userId);
     boolean isUserRunning(int userId);
     boolean isUserForeground(int userId);
+    boolean isUserVisible(int userId);
     boolean isUserNameSet(int userId);
     boolean hasRestrictedProfiles(int userId);
     boolean requestQuietModeEnabled(String callingPackage, boolean enableQuietMode, int userId, in IntentSender target, int flags);
diff --git a/core/java/android/os/UserManager.java b/core/java/android/os/UserManager.java
index d14d2e4402fe2..c802e56c8dc75 100644
--- a/core/java/android/os/UserManager.java
+++ b/core/java/android/os/UserManager.java
@@ -2857,6 +2857,30 @@ public class UserManager {
         return isUsersOnSecondaryDisplaysEnabled();
     }
 
+    /**
+     * Checks if the user is visible at the moment.
+     *
+     * <p>Roughly speaking, a "visible user" is a user that can present UI on at least one display.
+     * It includes:
+     *
+     * <ol>
+     *   <li>The current foreground user in the main display.
+     *   <li>Current background users in secondary displays (for example, passenger users on
+     *   automotive, using the display associated with their seats).
+     *   <li>Profile users (in the running / started state) of other visible users.
+     * </ol>
+     *
+     * @return whether the user is visible at the moment, as defined above.
+     */
+    @UserHandleAware
+    public boolean isUserVisible() {
+        try {
+            return mService.isUserVisible(mUserId);
+        } catch (RemoteException re) {
+            throw re.rethrowFromSystemServer();
+        }
+    }
+
     /**
      * Return whether the context user is running in an "unlocked" state.
      * <p>
diff --git a/services/core/java/com/android/server/pm/UserManagerService.java b/services/core/java/com/android/server/pm/UserManagerService.java
index 0c1c265428c68..60f22b032366b 100644
--- a/services/core/java/com/android/server/pm/UserManagerService.java
+++ b/services/core/java/com/android/server/pm/UserManagerService.java
@@ -1654,6 +1654,12 @@ public class UserManagerService extends IUserManager.Stub {
         return currentUser == userId;
     }
 
+    @Override
+    public boolean isUserVisible(@UserIdInt int userId) {
+        // TODO(b/239824814): implement other cases like bg user, profile, user on secondary display
+        return isUserForeground(userId);
+    }
+
     @Override
     public @NonNull String getUserName() {
         final int callingUid = Binder.getCallingUid();