xref: /frameworks/base/packages/SystemUI/tests/utils/src/com/android/systemui/statusbar/notification/collection/NotificationEntryBuilder.java

/*
 * 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.systemui.statusbar.notification.collection;

import android.annotation.Nullable;
import android.app.Notification;
import android.app.NotificationChannel;
import android.app.NotificationManager;
import android.content.Context;
import android.content.pm.ShortcutInfo;
import android.os.UserHandle;
import android.service.notification.NotificationListenerService.Ranking;
import android.service.notification.SnoozeCriterion;
import android.service.notification.StatusBarNotification;

import androidx.annotation.NonNull;

import com.android.internal.logging.InstanceId;
import com.android.systemui.statusbar.RankingBuilder;
import com.android.systemui.statusbar.SbnBuilder;
import com.android.systemui.statusbar.notification.collection.listbuilder.NotifSection;
import com.android.systemui.util.time.FakeSystemClock;

import kotlin.Unit;

import java.util.ArrayList;
import java.util.function.Consumer;

/**
 * Combined builder for constructing a NotificationEntry and its associated StatusBarNotification
 * and Ranking. Is largely a proxy for the SBN and Ranking builders, but does a little extra magic
 * to make sure the keys match between the two, etc.
 *
 * Has the ability to set ListEntry properties as well.
 *
 * Only for use in tests.
 */
public class NotificationEntryBuilder {
    private final SbnBuilder mSbnBuilder;
    private final RankingBuilder mRankingBuilder;
    private final FakeSystemClock mClock = new FakeSystemClock();
    private StatusBarNotification mSbn = null;

    /* ListEntry properties */
    private GroupEntry mParent;
    private NotifSection mNotifSection;

    /* If set, use this creation time instead of mClock.uptimeMillis */
    private long mCreationTime = -1;
    private int mStableIndex = -1;

    public NotificationEntryBuilder() {
        mSbnBuilder = new SbnBuilder();
        mRankingBuilder = new RankingBuilder();
    }

    public NotificationEntryBuilder(NotificationEntry source) {
        mSbnBuilder = new SbnBuilder(source.getSbn());
        mRankingBuilder = new RankingBuilder(source.getRanking());

        mParent = source.getParent();
        mCreationTime = source.getCreationTime();
    }

    /** Allows the caller to sub-build the ranking */
    @NonNull
    public NotificationEntryBuilder updateRanking(@NonNull Consumer<RankingBuilder> rankingUpdater) {
        rankingUpdater.accept(mRankingBuilder);
        return this;
    }

    /** Allows the caller to sub-build the SBN */
    @NonNull
    public NotificationEntryBuilder updateSbn(@NonNull Consumer<SbnBuilder> sbnUpdater) {
        sbnUpdater.accept(mSbnBuilder);
        return this;
    }

    /** Update an the parent on an existing entry */
    public static void setNewParent(NotificationEntry entry, GroupEntry parent) {
        entry.setParent(parent);
    }

    /** Build a new instance of NotificationEntry */
    public NotificationEntry build() {
        return buildOrApply(null);
    }

    /** Modifies [target] to match the contents of this builder */
    public void apply(NotificationEntry target) {
        buildOrApply(target);
    }

    /** Convenience method for Kotlin callbacks that are passed a builder and need to return Unit */
    public Unit done() {
        return Unit.INSTANCE;
    }

    private NotificationEntry buildOrApply(NotificationEntry target) {
        final StatusBarNotification sbn = mSbn != null ? mSbn : mSbnBuilder.build();
        final Ranking ranking = mRankingBuilder.setKey(sbn.getKey()).build();
        final long creationTime = mCreationTime != -1 ? mCreationTime : mClock.uptimeMillis();

        final NotificationEntry entry;
        if (target == null) {
            entry = new NotificationEntry(sbn, ranking, creationTime);
        } else {
            entry = target;
            entry.setSbn(sbn);
            entry.setRanking(ranking);
            // Note: we can't modify the creation time as it's immutable
        }

        /* ListEntry properties */
        entry.setParent(mParent);
        entry.getAttachState().setSection(mNotifSection);
        entry.getAttachState().setStableIndex(mStableIndex);
        return entry;
    }

    /**
     * Sets the parent.
     */
    public NotificationEntryBuilder setParent(@Nullable GroupEntry parent) {
        mParent = parent;
        return this;
    }

    /**
     * Sets the parent.
     */
    public NotificationEntryBuilder setSection(@Nullable NotifSection section) {
        mNotifSection = section;
        return this;
    }

    /**
     * Sets the SBN directly. If set, causes all calls to delegated SbnBuilder methods to be
     * ignored.
     */
    public NotificationEntryBuilder setSbn(@Nullable StatusBarNotification sbn) {
        mSbn = sbn;
        return this;
    }

    public NotificationEntryBuilder setStableIndex(int index) {
        mStableIndex = index;
        return this;
    }

    /**
     * Set the creation time
     */
    public NotificationEntryBuilder setCreationTime(long creationTime) {
        mCreationTime = creationTime;
        return this;
    }

    /* Delegated to SbnBuilder */

    public NotificationEntryBuilder setPkg(String pkg) {
        mSbnBuilder.setPkg(pkg);
        return this;
    }

    public NotificationEntryBuilder setOpPkg(String opPkg) {
        mSbnBuilder.setOpPkg(opPkg);
        return this;
    }

    public NotificationEntryBuilder setId(int id) {
        mSbnBuilder.setId(id);
        return this;
    }

    public NotificationEntryBuilder setTag(String tag) {
        mSbnBuilder.setTag(tag);
        return this;
    }

    public NotificationEntryBuilder setUid(int uid) {
        mSbnBuilder.setUid(uid);
        return this;
    }

    public NotificationEntryBuilder setInitialPid(int initialPid) {
        mSbnBuilder.setInitialPid(initialPid);
        return this;
    }

    public NotificationEntryBuilder setNotification(Notification notification) {
        mSbnBuilder.setNotification(notification);
        return this;
    }

    public Notification.Builder modifyNotification(Context context) {
        return mSbnBuilder.modifyNotification(context);
    }

    public NotificationEntryBuilder setUser(UserHandle user) {
        mSbnBuilder.setUser(user);
        return this;
    }

    public NotificationEntryBuilder setOverrideGroupKey(String overrideGroupKey) {
        mSbnBuilder.setOverrideGroupKey(overrideGroupKey);
        return this;
    }

    public NotificationEntryBuilder setPostTime(long postTime) {
        mSbnBuilder.setPostTime(postTime);
        return this;
    }

    public NotificationEntryBuilder setInstanceId(InstanceId instanceId) {
        mSbnBuilder.setInstanceId(instanceId);
        return this;
    }

    /* Delegated to Notification.Builder (via SbnBuilder) */

    public NotificationEntryBuilder setContentTitle(Context context, String contentTitle) {
        mSbnBuilder.setContentTitle(context, contentTitle);
        return this;
    }

    public NotificationEntryBuilder setContentText(Context context, String contentText) {
        mSbnBuilder.setContentText(context, contentText);
        return this;
    }

    public NotificationEntryBuilder setGroup(Context context, String groupKey) {
        mSbnBuilder.setGroup(context, groupKey);
        return this;
    }

    public NotificationEntryBuilder setGroupSummary(Context context, boolean isGroupSummary) {
        mSbnBuilder.setGroupSummary(context, isGroupSummary);
        return this;
    }

    public NotificationEntryBuilder setFlag(Context context, int mask, boolean value) {
        mSbnBuilder.setFlag(context, mask, value);
        return this;
    }

    /* Delegated to RankingBuilder */

    public NotificationEntryBuilder setRank(int rank) {
        mRankingBuilder.setRank(rank);
        return this;
    }

    public NotificationEntryBuilder setMatchesInterruptionFilter(
            boolean matchesInterruptionFilter) {
        mRankingBuilder.setMatchesInterruptionFilter(matchesInterruptionFilter);
        return this;
    }

    public NotificationEntryBuilder setVisibilityOverride(int visibilityOverride) {
        mRankingBuilder.setVisibilityOverride(visibilityOverride);
        return this;
    }

    public NotificationEntryBuilder setSuppressedVisualEffects(int suppressedVisualEffects) {
        mRankingBuilder.setSuppressedVisualEffects(suppressedVisualEffects);
        return this;
    }

    public NotificationEntryBuilder setExplanation(CharSequence explanation) {
        mRankingBuilder.setExplanation(explanation);
        return this;
    }

    public NotificationEntryBuilder setAdditionalPeople(ArrayList<String> additionalPeople) {
        mRankingBuilder.setAdditionalPeople(additionalPeople);
        return this;
    }

    public NotificationEntryBuilder setSnoozeCriteria(
            ArrayList<SnoozeCriterion> snoozeCriteria) {
        mRankingBuilder.setSnoozeCriteria(snoozeCriteria);
        return this;
    }

    public NotificationEntryBuilder setCanShowBadge(boolean canShowBadge) {
        mRankingBuilder.setCanShowBadge(canShowBadge);
        return this;
    }

    public NotificationEntryBuilder setSuspended(boolean suspended) {
        mRankingBuilder.setSuspended(suspended);
        return this;
    }

    public NotificationEntryBuilder setLastAudiblyAlertedMs(long lastAudiblyAlertedMs) {
        mRankingBuilder.setLastAudiblyAlertedMs(lastAudiblyAlertedMs);
        return this;
    }

    public NotificationEntryBuilder setNoisy(boolean noisy) {
        mRankingBuilder.setNoisy(noisy);
        return this;
    }

    public NotificationEntryBuilder setCanBubble(boolean canBubble) {
        mRankingBuilder.setCanBubble(canBubble);
        return this;
    }

    public NotificationEntryBuilder setImportance(@NotificationManager.Importance int importance) {
        mRankingBuilder.setImportance(importance);
        return this;
    }

    public NotificationEntryBuilder setUserSentiment(int userSentiment) {
        mRankingBuilder.setUserSentiment(userSentiment);
        return this;
    }

    public NotificationEntryBuilder setChannel(NotificationChannel channel) {
        mRankingBuilder.setChannel(channel);
        return this;
    }

    public NotificationEntryBuilder setSmartActions(
            ArrayList<Notification.Action> smartActions) {
        mRankingBuilder.setSmartActions(smartActions);
        return this;
    }

    public NotificationEntryBuilder setSmartActions(Notification.Action... smartActions) {
        mRankingBuilder.setSmartActions(smartActions);
        return this;
    }

    public NotificationEntryBuilder setSmartReplies(ArrayList<CharSequence> smartReplies) {
        mRankingBuilder.setSmartReplies(smartReplies);
        return this;
    }

    public NotificationEntryBuilder setSmartReplies(CharSequence... smartReplies) {
        mRankingBuilder.setSmartReplies(smartReplies);
        return this;
    }

    public NotificationEntryBuilder setShortcutInfo(ShortcutInfo shortcutInfo) {
        mRankingBuilder.setShortcutInfo(shortcutInfo);
        return this;
    }

    public NotificationEntryBuilder setRankingAdjustment(int rankingAdjustment) {
        mRankingBuilder.setRankingAdjustment(rankingAdjustment);
        return this;
    }
}