Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 482ef73a authored by Tetiana Meronyk's avatar Tetiana Meronyk
Browse files

Refactor BackgroundUserSoundNotifier 

Remove unnecessary Context parameter from some methods where it can be accessed in another way.
Add notificationClientUid parameter to some methods to prepare them for being able to handle specific AudioFocusInfo once multiple AudioFocus handling is implemented.

Bug: 367615180
Test: atest BackgroundUserSoundNotifierTest
Flag: EXEMPT trivial refactoring
Change-Id: Ica949f278cc1e56901345413cfa2f5ccfefef20e
parent 5025d685

services/core/java/com/android/server/pm/BackgroundUserSoundNotifier.java

+40 −40
Original line number Diff line number Diff line
@@ -55,6 +55,8 @@ public class BackgroundUserSoundNotifier { 
    private static final String ACTION_SWITCH_USER = "com.android.server.ACTION_SWITCH_TO_USER";

    private static final String ACTION_DISMISS_NOTIFICATION =

            "com.android.server.ACTION_DISMISS_NOTIFICATION";

    private static final String EXTRA_NOTIFICATION_CLIENT_UID =

            "com.android.server.EXTRA_CLIENT_UID";

    /**

     * The clientUid from the AudioFocusInfo of the background user,

     * for which an active notification is currently displayed.
@@ -101,7 +103,7 @@ public class BackgroundUserSoundNotifier { 
        ActivityManager am = mSystemUserContext.getSystemService(ActivityManager.class);



        registerReceiver(am);

        mBgUserListener = new BackgroundUserListener(mSystemUserContext);

        mBgUserListener = new BackgroundUserListener();

        AudioPolicy.Builder focusControlPolicyBuilder = new AudioPolicy.Builder(mSystemUserContext);

        focusControlPolicyBuilder.setLooper(Looper.getMainLooper());
@@ -119,26 +121,16 @@ public class BackgroundUserSoundNotifier { 


    final class BackgroundUserListener extends AudioPolicy.AudioPolicyFocusListener {



        Context mSystemContext;



        BackgroundUserListener(Context systemContext) {

            mSystemContext = systemContext;

        }



        @SuppressLint("MissingPermission")

        public void onAudioFocusGrant(AudioFocusInfo afi, int requestResult) {

            try {

                BackgroundUserSoundNotifier.this.notifyForegroundUserAboutSoundIfNecessary(afi,

                        mSystemContext.createContextAsUser(

                                UserHandle.of(ActivityManager.getCurrentUser()), 0));

                BackgroundUserSoundNotifier.this.notifyForegroundUserAboutSoundIfNecessary(afi);

            } catch (RemoteException e) {

                throw new RuntimeException(e);

            }

        }



        @SuppressLint("MissingPermission")

        public void onAudioFocusLoss(AudioFocusInfo afi, boolean wasNotified) {

            BackgroundUserSoundNotifier.this.dismissNotificationIfNecessary();

            BackgroundUserSoundNotifier.this.dismissNotificationIfNecessary(afi.getClientUid());

        }

    }
@@ -160,7 +152,7 @@ public class BackgroundUserSoundNotifier { 
                if (mNotificationClientUid == -1) {

                    return;

                }

                dismissNotification();

                dismissNotification(mNotificationClientUid);



                if (DEBUG) {

                    final int actionIndex = intent.getAction().lastIndexOf(".") + 1;
@@ -171,7 +163,7 @@ public class BackgroundUserSoundNotifier { 
                }



                if (ACTION_MUTE_SOUND.equals(intent.getAction())) {

                    muteAlarmSounds(mSystemUserContext);

                    muteAlarmSounds(mNotificationClientUid);

                } else if (ACTION_SWITCH_USER.equals(intent.getAction())) {

                    activityManager.switchUser(UserHandle.getUserId(mNotificationClientUid));

                }
@@ -193,17 +185,17 @@ public class BackgroundUserSoundNotifier { 
     */

    @SuppressLint("MissingPermission")

    @VisibleForTesting

    void muteAlarmSounds(Context context) {

        AudioManager audioManager = context.getSystemService(AudioManager.class);

    void muteAlarmSounds(int notificationClientUid) {

        AudioManager audioManager = mSystemUserContext.getSystemService(AudioManager.class);

        if (audioManager != null) {

            for (AudioPlaybackConfiguration apc : audioManager.getActivePlaybackConfigurations()) {

                if (apc.getClientUid() == mNotificationClientUid && apc.getPlayerProxy() != null) {

                if (apc.getClientUid() == notificationClientUid && apc.getPlayerProxy() != null) {

                    apc.getPlayerProxy().stop();

                }

            }

        }



        AudioFocusInfo currentAfi = getAudioFocusInfoForNotification();

        AudioFocusInfo currentAfi = getAudioFocusInfoForNotification(notificationClientUid);

        if (currentAfi != null) {

            mFocusControlAudioPolicy.sendFocusLossAndUpdate(currentAfi);

        }
@@ -212,9 +204,14 @@ public class BackgroundUserSoundNotifier { 
    /**

     * Check if sound is coming from background user and show notification is required.

     */

    @SuppressLint("MissingPermission")

    @VisibleForTesting

    void notifyForegroundUserAboutSoundIfNecessary(AudioFocusInfo afi, Context foregroundContext)

            throws RemoteException {

    void notifyForegroundUserAboutSoundIfNecessary(AudioFocusInfo afi) throws RemoteException {

        if (afi == null) {

            return;

        }

        Context foregroundContext = mSystemUserContext.createContextAsUser(

                UserHandle.of(ActivityManager.getCurrentUser()), 0);

        final int userId = UserHandle.getUserId(afi.getClientUid());

        final int usage = afi.getAttributes().getUsage();

        UserInfo userInfo = mUserManager.getUserInfo(userId);
@@ -232,8 +229,8 @@ public class BackgroundUserSoundNotifier { 


                mNotificationClientUid = afi.getClientUid();



                mNotificationManager.notifyAsUser(LOG_TAG, mNotificationClientUid,

                        createNotification(userInfo.name, foregroundContext),

                mNotificationManager.notifyAsUser(LOG_TAG, afi.getClientUid(),

                        createNotification(userInfo.name, foregroundContext, afi.getClientUid()),

                        foregroundContext.getUser());

            }

        }
@@ -245,14 +242,15 @@ public class BackgroundUserSoundNotifier { 
     * focus ownership.

     */

    @VisibleForTesting

    void dismissNotificationIfNecessary() {

        if (getAudioFocusInfoForNotification() == null && mNotificationClientUid >= 0) {

    void dismissNotificationIfNecessary(int notificationClientUid) {

        if (getAudioFocusInfoForNotification(notificationClientUid) == null

                && mNotificationClientUid >= 0) {

            if (DEBUG) {

                Log.d(LOG_TAG, "Alarm ringing on background user "

                        + UserHandle.getUserHandleForUid(mNotificationClientUid).getIdentifier()

                        + UserHandle.getUserHandleForUid(notificationClientUid).getIdentifier()

                        + " left focus stack, dismissing notification");

            }

            dismissNotification();

            dismissNotification(notificationClientUid);

            mNotificationClientUid = -1;

        }

    }
@@ -262,8 +260,8 @@ public class BackgroundUserSoundNotifier { 
     * shown.

     */

    @SuppressLint("MissingPermission")

    private void dismissNotification() {

        mNotificationManager.cancelAsUser(LOG_TAG, mNotificationClientUid, UserHandle.ALL);

    private void dismissNotification(int notificationClientUid) {

        mNotificationManager.cancelAsUser(LOG_TAG, notificationClientUid, UserHandle.ALL);

    }



    /**
@@ -272,11 +270,11 @@ public class BackgroundUserSoundNotifier { 
    @SuppressLint("MissingPermission")

    @VisibleForTesting

    @Nullable

    AudioFocusInfo getAudioFocusInfoForNotification() {

        if (mNotificationClientUid >= 0) {

    AudioFocusInfo getAudioFocusInfoForNotification(int notificationClientUid) {

        if (notificationClientUid >= 0) {

            List<AudioFocusInfo> stack = mFocusControlAudioPolicy.getFocusStack();

            for (int i = stack.size() - 1; i >= 0; i--) {

                if (stack.get(i).getClientUid() == mNotificationClientUid) {

                if (stack.get(i).getClientUid() == notificationClientUid) {

                    return stack.get(i);

                }

            }
@@ -284,22 +282,24 @@ public class BackgroundUserSoundNotifier { 
        return null;

    }



    private PendingIntent createPendingIntent(String intentAction) {

    private PendingIntent createPendingIntent(String intentAction, int notificationClientUid) {

        final Intent intent = new Intent(intentAction);

        PendingIntent resultPI =  PendingIntent.getBroadcast(mSystemUserContext, 0, intent,

                PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE);

        return resultPI;

        intent.putExtra(EXTRA_NOTIFICATION_CLIENT_UID, notificationClientUid);

        return PendingIntent.getBroadcast(mSystemUserContext, notificationClientUid, intent,

                PendingIntent.FLAG_IMMUTABLE);

    }



    @SuppressLint("MissingPermission")

    @VisibleForTesting

    Notification createNotification(String userName, Context fgContext) {

    Notification createNotification(String userName, Context fgContext, int notificationClientUid) {

        final String title = fgContext.getString(R.string.bg_user_sound_notification_title_alarm,

                userName);

        final int icon = R.drawable.ic_audio_alarm;



        PendingIntent mutePI = createPendingIntent(ACTION_MUTE_SOUND);

        PendingIntent switchPI = createPendingIntent(ACTION_SWITCH_USER);

        PendingIntent dismissNotificationPI = createPendingIntent(ACTION_DISMISS_NOTIFICATION);

        PendingIntent mutePI = createPendingIntent(ACTION_MUTE_SOUND, notificationClientUid);

        PendingIntent switchPI = createPendingIntent(ACTION_SWITCH_USER, notificationClientUid);

        PendingIntent dismissNotificationPI = createPendingIntent(ACTION_DISMISS_NOTIFICATION,

                notificationClientUid);



        final Notification.Action mute = new Notification.Action.Builder(null,

                fgContext.getString(R.string.bg_user_sound_notification_button_mute),

services/tests/mockingservicestests/src/com/android/server/pm/BackgroundUserSoundNotifierTest.java

+9 −6
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ package com.android.server.pm; 


import static android.media.AudioAttributes.USAGE_ALARM;



import static org.junit.Assume.assumeTrue;

import static org.mockito.ArgumentMatchers.any;

import static org.mockito.ArgumentMatchers.eq;

import static org.mockito.Mockito.clearInvocations;
@@ -91,6 +92,7 @@ public class BackgroundUserSoundNotifierTest { 
    }

    @Test

    public void testAlarmOnBackgroundUser_foregroundUserNotified() throws RemoteException {

        assumeTrue(UserManager.supportsMultipleUsers());

        AudioAttributes aa = new AudioAttributes.Builder().setUsage(USAGE_ALARM).build();

        UserInfo user = createUser("User", UserManager.USER_TYPE_FULL_SECONDARY, 0);

        final int fgUserId = mSpiedContext.getUserId();
@@ -100,7 +102,7 @@ public class BackgroundUserSoundNotifierTest { 
                /* packageName= */ "com.android.car.audio", AudioManager.AUDIOFOCUS_GAIN,

                AudioManager.AUDIOFOCUS_NONE, /* flags= */ 0, Build.VERSION.SDK_INT);

        clearInvocations(mNotificationManager);

        mBackgroundUserSoundNotifier.notifyForegroundUserAboutSoundIfNecessary(afi, mSpiedContext);

        mBackgroundUserSoundNotifier.notifyForegroundUserAboutSoundIfNecessary(afi);

        verify(mNotificationManager)

                .notifyAsUser(eq(BackgroundUserSoundNotifier.class.getSimpleName()),

                        eq(afi.getClientUid()), any(Notification.class),
@@ -116,7 +118,7 @@ public class BackgroundUserSoundNotifierTest { 
                /* packageName= */ "com.android.car.audio", AudioManager.AUDIOFOCUS_GAIN,

                AudioManager.AUDIOFOCUS_NONE, /* flags= */ 0, Build.VERSION.SDK_INT);

        clearInvocations(mNotificationManager);

        mBackgroundUserSoundNotifier.notifyForegroundUserAboutSoundIfNecessary(afi, mSpiedContext);

        mBackgroundUserSoundNotifier.notifyForegroundUserAboutSoundIfNecessary(afi);

        verifyZeroInteractions(mNotificationManager);

    }
@@ -131,7 +133,7 @@ public class BackgroundUserSoundNotifierTest { 
                AudioManager.AUDIOFOCUS_GAIN, AudioManager.AUDIOFOCUS_NONE, /* flags= */ 0,

                Build.VERSION.SDK_INT);

        clearInvocations(mNotificationManager);

        mBackgroundUserSoundNotifier.notifyForegroundUserAboutSoundIfNecessary(afi, mSpiedContext);

        mBackgroundUserSoundNotifier.notifyForegroundUserAboutSoundIfNecessary(afi);

        verifyZeroInteractions(mNotificationManager);

    }
@@ -169,7 +171,7 @@ public class BackgroundUserSoundNotifierTest { 
        doReturn(focusStack).when(mockAudioPolicy).getFocusStack();

        mBackgroundUserSoundNotifier.mFocusControlAudioPolicy = mockAudioPolicy;



        mBackgroundUserSoundNotifier.muteAlarmSounds(mSpiedContext);

        mBackgroundUserSoundNotifier.muteAlarmSounds(bgUserUid);



        verify(apc1.getPlayerProxy()).stop();

        verify(mockAudioPolicy).sendFocusLossAndUpdate(afi);
@@ -178,6 +180,7 @@ public class BackgroundUserSoundNotifierTest { 


    @Test

    public void testOnAudioFocusGrant_alarmOnBackgroundUser_notifiesForegroundUser() {

        assumeTrue(UserManager.supportsMultipleUsers());

        final int fgUserId = mSpiedContext.getUserId();

        UserInfo bgUser = createUser("Background User",  UserManager.USER_TYPE_FULL_SECONDARY, 0);

        int bgUserUid = bgUser.id * 100000;
@@ -205,7 +208,7 @@ public class BackgroundUserSoundNotifierTest { 
                .when(mUserManager).getUserSwitchability(any());



        Notification notification = mBackgroundUserSoundNotifier.createNotification(userName,

                mSpiedContext);

                mSpiedContext, 101000);



        assertEquals("Alarm for BgUser", notification.extras.getString(

                Notification.EXTRA_TITLE));
@@ -232,7 +235,7 @@ public class BackgroundUserSoundNotifierTest { 
                .when(mUserManager).getUserSwitchability(any());



        Notification notification = mBackgroundUserSoundNotifier.createNotification(userName,

                mSpiedContext);

                mSpiedContext, 101000);



        assertEquals(1, notification.actions.length);

        assertEquals(mSpiedContext.getString(