/*
 * Copyright (C) 2019 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 com.android.server.am;

import static android.os.PowerWhitelistManager.REASON_NOTIFICATION_SERVICE;
import static android.os.PowerWhitelistManager.TEMPORARY_ALLOWLIST_TYPE_FOREGROUND_SERVICE_ALLOWED;
import static android.os.PowerWhitelistManager.TEMPORARY_ALLOWLIST_TYPE_FOREGROUND_SERVICE_NOT_ALLOWED;
import static android.os.Process.INVALID_UID;

import static com.android.dx.mockito.inline.extended.ExtendedMockito.doReturn;
import static com.android.dx.mockito.inline.extended.ExtendedMockito.mockitoSession;
import static com.android.dx.mockito.inline.extended.ExtendedMockito.verify;
import static com.android.server.am.PendingIntentRecord.CANCEL_REASON_NULL;
import static com.android.server.am.PendingIntentRecord.CANCEL_REASON_ONE_SHOT_SENT;
import static com.android.server.am.PendingIntentRecord.CANCEL_REASON_OWNER_CANCELED;
import static com.android.server.am.PendingIntentRecord.CANCEL_REASON_OWNER_FORCE_STOPPED;
import static com.android.server.am.PendingIntentRecord.CANCEL_REASON_SUPERSEDED;
import static com.android.server.am.PendingIntentRecord.CANCEL_REASON_USER_STOPPED;
import static com.android.server.am.PendingIntentRecord.FLAG_ACTIVITY_SENDER;
import static com.android.server.am.PendingIntentRecord.cancelReasonToString;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.anyLong;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import android.annotation.NonNull;
import android.app.ActivityManager;
import android.app.ActivityManagerInternal;
import android.app.ActivityOptions;
import android.app.AppGlobals;
import android.app.BackgroundStartPrivileges;
import android.app.PendingIntent;
import android.content.Intent;
import android.content.pm.IPackageManager;
import android.os.Binder;
import android.os.Bundle;
import android.os.Looper;
import android.os.UserHandle;

import androidx.test.ext.junit.runners.AndroidJUnit4;

import com.android.server.AlarmManagerInternal;
import com.android.server.LocalServices;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoSession;
import org.mockito.quality.Strictness;

@RunWith(AndroidJUnit4.class)
public class PendingIntentControllerTest {
    private static final String TEST_PACKAGE_NAME = "test-package-1";
    private static final String TEST_FEATURE_ID = "test-feature-1";
    private static final int TEST_CALLING_UID = android.os.Process.myUid();
    private static final int TEST_USER_ID = 0;
    private static final Intent[] TEST_INTENTS = new Intent[]{new Intent("com.test.intent")};

    @Mock
    private UserController mUserController;
    @Mock
    private AlarmManagerInternal mAlarmManagerInternal;
    @Mock
    private ActivityManagerInternal mActivityManagerInternal;
    @Mock
    private IPackageManager mIPackageManager;

    private MockitoSession mMockingSession;
    private PendingIntentController mPendingIntentController;

    @Before
    public void setUp() throws Exception {
        mMockingSession = mockitoSession()
                .initMocks(this)
                .mockStatic(LocalServices.class)
                .mockStatic(AppGlobals.class)
                .strictness(Strictness.LENIENT) // Needed to stub LocalServices.getService twice
                .startMocking();
        doReturn(mAlarmManagerInternal).when(
                () -> LocalServices.getService(AlarmManagerInternal.class));
        doReturn(mActivityManagerInternal).when(
                () -> LocalServices.getService(ActivityManagerInternal.class));
        doReturn(mIPackageManager).when(() -> AppGlobals.getPackageManager());
        when(mIPackageManager.getPackageUid(eq(TEST_PACKAGE_NAME), anyLong(), anyInt())).thenReturn(
                TEST_CALLING_UID);
        ActivityManagerConstants constants = mock(ActivityManagerConstants.class);
        constants.PENDINGINTENT_WARNING_THRESHOLD = 2000;
        mPendingIntentController = new PendingIntentController(Looper.getMainLooper(),
                mUserController, constants);
        mPendingIntentController.onActivityManagerInternalAdded();
    }

    @NonNull
    private PendingIntentRecord createPendingIntentRecord(@PendingIntent.Flags int flags) {
        return mPendingIntentController.getIntentSender(ActivityManager.INTENT_SENDER_BROADCAST,
                TEST_PACKAGE_NAME, TEST_FEATURE_ID, TEST_CALLING_UID, TEST_USER_ID, null, null, 0,
                TEST_INTENTS, null, flags, null);
    }

    @Test
    public void alarmsRemovedOnCancel() {
        final PendingIntentRecord pir = createPendingIntentRecord(0);
        mPendingIntentController.cancelIntentSender(pir);
        final ArgumentCaptor<PendingIntent> piCaptor = ArgumentCaptor.forClass(PendingIntent.class);
        verify(mAlarmManagerInternal).remove(piCaptor.capture());
        assertEquals("Wrong target for pending intent passed to alarm manager", pir,
                piCaptor.getValue().getTarget());
    }

    @Test
    public void alarmsRemovedOnRecreateWithCancelCurrent() {
        final PendingIntentRecord pir = createPendingIntentRecord(0);
        createPendingIntentRecord(PendingIntent.FLAG_CANCEL_CURRENT);
        final ArgumentCaptor<PendingIntent> piCaptor = ArgumentCaptor.forClass(PendingIntent.class);
        verify(mAlarmManagerInternal).remove(piCaptor.capture());
        assertEquals("Wrong target for pending intent passed to alarm manager", pir,
                piCaptor.getValue().getTarget());
    }

    @Test
    public void alarmsRemovedOnSendingOneShot() {
        final PendingIntentRecord pir = createPendingIntentRecord(PendingIntent.FLAG_ONE_SHOT);
        pir.send(0, null, null, null, null, null, null);
        final ArgumentCaptor<PendingIntent> piCaptor = ArgumentCaptor.forClass(PendingIntent.class);
        verify(mAlarmManagerInternal).remove(piCaptor.capture());
        assertEquals("Wrong target for pending intent passed to alarm manager", pir,
                piCaptor.getValue().getTarget());
    }

    @Test
    public void testCancellationReason() {
        {
            final PendingIntentRecord pir = createPendingIntentRecord(0);
            assertCancelReason(CANCEL_REASON_NULL, pir.cancelReason);
        }

        {
            final PendingIntentRecord pir = createPendingIntentRecord(0);
            mPendingIntentController.cancelIntentSender(pir);
            assertCancelReason(CANCEL_REASON_OWNER_CANCELED, pir.cancelReason);
        }

        {
            final PendingIntentRecord pir = createPendingIntentRecord(0);
            createPendingIntentRecord(PendingIntent.FLAG_CANCEL_CURRENT);
            assertCancelReason(CANCEL_REASON_SUPERSEDED, pir.cancelReason);
        }

        {
            final PendingIntentRecord pir = createPendingIntentRecord(PendingIntent.FLAG_ONE_SHOT);
            pir.send(0, null, null, null, null, null, null);
            assertCancelReason(CANCEL_REASON_ONE_SHOT_SENT, pir.cancelReason);
        }

        {
            final PendingIntentRecord pir = createPendingIntentRecord(0);
            mPendingIntentController.removePendingIntentsForPackage(TEST_PACKAGE_NAME,
                    TEST_USER_ID, UserHandle.getAppId(TEST_CALLING_UID), true,
                    CANCEL_REASON_OWNER_FORCE_STOPPED);
            assertCancelReason(CANCEL_REASON_OWNER_FORCE_STOPPED, pir.cancelReason);
        }

        {
            final PendingIntentRecord pir = createPendingIntentRecord(0);
            mPendingIntentController.removePendingIntentsForPackage(null,
                    TEST_USER_ID, INVALID_UID, true,
                    CANCEL_REASON_USER_STOPPED);
            assertCancelReason(CANCEL_REASON_USER_STOPPED, pir.cancelReason);
        }
    }

    @Test
    public void testClearAllowBgActivityStartsClearsToken() {
        final PendingIntentRecord pir = createPendingIntentRecord(0);
        Binder token = new Binder();
        pir.setAllowBgActivityStarts(token, FLAG_ACTIVITY_SENDER);
        assertEquals(BackgroundStartPrivileges.allowBackgroundActivityStarts(token),
                pir.getBackgroundStartPrivilegesForActivitySender(token));
        pir.clearAllowBgActivityStarts(token);
        assertEquals(BackgroundStartPrivileges.NONE,
                pir.getBackgroundStartPrivilegesForActivitySender(token));
    }

    @Test
    public void testClearAllowBgActivityStartsClearsDuration() {
        final PendingIntentRecord pir = createPendingIntentRecord(0);
        Binder token = new Binder();
        pir.setAllowlistDurationLocked(token, 1000,
                TEMPORARY_ALLOWLIST_TYPE_FOREGROUND_SERVICE_ALLOWED, REASON_NOTIFICATION_SERVICE,
                "NotificationManagerService");
        PendingIntentRecord.TempAllowListDuration allowlistDurationLocked =
                pir.getAllowlistDurationLocked(token);
        assertEquals(1000, allowlistDurationLocked.duration);
        assertEquals(TEMPORARY_ALLOWLIST_TYPE_FOREGROUND_SERVICE_ALLOWED,
                allowlistDurationLocked.type);
        pir.clearAllowBgActivityStarts(token);
        PendingIntentRecord.TempAllowListDuration allowlistDurationLockedAfterClear =
                pir.getAllowlistDurationLocked(token);
        assertNotNull(allowlistDurationLockedAfterClear);
        assertEquals(1000, allowlistDurationLockedAfterClear.duration);
        assertEquals(TEMPORARY_ALLOWLIST_TYPE_FOREGROUND_SERVICE_NOT_ALLOWED,
                allowlistDurationLocked.type);
    }

    @Test
    public void testSend_withBundleExtras_passesLaunchDisplayId() {
        final PendingIntentRecord pir = createPendingIntentRecord(0);
        final ActivityOptions activityOptions = ActivityOptions.makeBasic();
        activityOptions.setLaunchDisplayId(2);
        activityOptions.setLaunchTaskId(123);
        final Bundle options = activityOptions.toBundle();
        options.putString("testKey", "testValue");

        pir.send(0, null, null, null, null, null, options);

        final ArgumentCaptor<Bundle> resultExtrasCaptor = ArgumentCaptor.forClass(Bundle.class);
        verify(mActivityManagerInternal).broadcastIntentInPackage(
                eq(TEST_PACKAGE_NAME),
                eq(TEST_FEATURE_ID),
                eq(TEST_CALLING_UID),
                eq(TEST_CALLING_UID), // realCallingUid
                anyInt(), // realCallingPid
                any(), // intent
                any(), // resolvedType
                any(), // resultToThread
                any(), // resultTo
                anyInt(), // resultCode
                any(), // resultData
                resultExtrasCaptor.capture(), // resultExtras
                any(), // requiredPermission
                eq(options), // bOptions
                anyBoolean(), // serialized
                anyBoolean(), // sticky
                anyInt(), // userId
                any(),  // backgroundStartPrivileges
                any() // broadcastAllowList
        );
        final Bundle result = resultExtrasCaptor.getValue();
        // Check that only launchDisplayId in ActivityOptions is passed via resultExtras.
        final ActivityOptions expected = ActivityOptions.makeBasic().setLaunchDisplayId(2);
        assertBundleEquals(expected.toBundle(), result);
        // Check that launchTaskId is dropped in resultExtras.
        assertNotEquals(123, ActivityOptions.fromBundle(result).getLaunchTaskId());
    }

    private void assertBundleEquals(@NonNull Bundle expected, @NonNull Bundle observed) {
        assertEquals(expected.size(), observed.size());
        for (String key : expected.keySet()) {
            assertEquals(expected.get(key), observed.get(key));
        }
    }

    private void assertCancelReason(int expectedReason, int actualReason) {
        final String errMsg = "Expected: " + cancelReasonToString(expectedReason)
                + "; Actual: " + cancelReasonToString(actualReason);
        assertEquals(errMsg, expectedReason, actualReason);
    }

    @After
    public void tearDown() {
        if (mMockingSession != null) {
            mMockingSession.finishMocking();
        }
    }
}