blob: b615885596eee273fb6ea9336fcfef48958d9f47 [file] [log] [blame]
/*
* 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.bubbles;
import static android.os.AsyncTask.Status.FINISHED;
import static android.view.Display.INVALID_DISPLAY;
import static com.android.internal.annotations.VisibleForTesting.Visibility.PRIVATE;
import android.annotation.DimenRes;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.app.Notification;
import android.app.PendingIntent;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.content.pm.ShortcutInfo;
import android.content.res.Resources;
import android.graphics.Bitmap;
import android.graphics.Path;
import android.graphics.drawable.Drawable;
import android.graphics.drawable.Icon;
import android.os.UserHandle;
import android.provider.Settings;
import android.util.Log;
import com.android.internal.annotations.VisibleForTesting;
import com.android.internal.logging.InstanceId;
import com.android.systemui.shared.system.SysUiStatsLog;
import com.android.systemui.statusbar.notification.collection.NotificationEntry;
import java.io.FileDescriptor;
import java.io.PrintWriter;
import java.util.Objects;
/**
* Encapsulates the data and UI elements of a bubble.
*/
class Bubble implements BubbleViewProvider {
private static final String TAG = "Bubble";
private final String mKey;
private long mLastUpdated;
private long mLastAccessed;
@Nullable
private BubbleController.NotificationSuppressionChangedListener mSuppressionListener;
/** Whether the bubble should show a dot for the notification indicating updated content. */
private boolean mShowBubbleUpdateDot = true;
/** Whether flyout text should be suppressed, regardless of any other flags or state. */
private boolean mSuppressFlyout;
// Items that are typically loaded later
private String mAppName;
private ShortcutInfo mShortcutInfo;
private String mMetadataShortcutId;
private BadgedImageView mIconView;
private BubbleExpandedView mExpandedView;
private BubbleViewInfoTask mInflationTask;
private boolean mInflateSynchronously;
private boolean mPendingIntentCanceled;
private boolean mIsImportantConversation;
/**
* Presentational info about the flyout.
*/
public static class FlyoutMessage {
@Nullable public Icon senderIcon;
@Nullable public Drawable senderAvatar;
@Nullable public CharSequence senderName;
@Nullable public CharSequence message;
@Nullable public boolean isGroupChat;
}
private FlyoutMessage mFlyoutMessage;
private Drawable mBadgedAppIcon;
private Bitmap mBadgedImage;
private int mDotColor;
private Path mDotPath;
private int mFlags;
@NonNull
private UserHandle mUser;
@NonNull
private String mPackageName;
@Nullable
private String mTitle;
@Nullable
private Icon mIcon;
private boolean mIsBubble;
private boolean mIsVisuallyInterruptive;
private boolean mIsClearable;
private boolean mShouldSuppressNotificationDot;
private boolean mShouldSuppressNotificationList;
private boolean mShouldSuppressPeek;
private int mDesiredHeight;
@DimenRes
private int mDesiredHeightResId;
/** for logging **/
@Nullable
private InstanceId mInstanceId;
@Nullable
private String mChannelId;
private int mNotificationId;
private int mAppUid = -1;
@Nullable
private PendingIntent mIntent;
@Nullable
private PendingIntent mDeleteIntent;
/**
* Create a bubble with limited information based on given {@link ShortcutInfo}.
* Note: Currently this is only being used when the bubble is persisted to disk.
*/
Bubble(@NonNull final String key, @NonNull final ShortcutInfo shortcutInfo,
final int desiredHeight, final int desiredHeightResId, @Nullable final String title) {
Objects.requireNonNull(key);
Objects.requireNonNull(shortcutInfo);
mShortcutInfo = shortcutInfo;
mKey = key;
mFlags = 0;
mUser = shortcutInfo.getUserHandle();
mPackageName = shortcutInfo.getPackage();
mIcon = shortcutInfo.getIcon();
mDesiredHeight = desiredHeight;
mDesiredHeightResId = desiredHeightResId;
mTitle = title;
mShowBubbleUpdateDot = false;
}
/** Used in tests when no UI is required. */
@VisibleForTesting(visibility = PRIVATE)
Bubble(@NonNull final NotificationEntry e,
@Nullable final BubbleController.NotificationSuppressionChangedListener listener) {
Objects.requireNonNull(e);
mKey = e.getKey();
mSuppressionListener = listener;
setEntry(e);
}
@Override
public String getKey() {
return mKey;
}
public UserHandle getUser() {
return mUser;
}
@NonNull
public String getPackageName() {
return mPackageName;
}
@Override
public Bitmap getBadgedImage() {
return mBadgedImage;
}
public Drawable getBadgedAppIcon() {
return mBadgedAppIcon;
}
@Override
public int getDotColor() {
return mDotColor;
}
@Override
public Path getDotPath() {
return mDotPath;
}
@Nullable
public String getAppName() {
return mAppName;
}
@Nullable
public ShortcutInfo getShortcutInfo() {
return mShortcutInfo;
}
@Nullable
@Override
public BadgedImageView getIconView() {
return mIconView;
}
@Override
@Nullable
public BubbleExpandedView getExpandedView() {
return mExpandedView;
}
@Nullable
public String getTitle() {
return mTitle;
}
String getMetadataShortcutId() {
return mMetadataShortcutId;
}
boolean hasMetadataShortcutId() {
return (mMetadataShortcutId != null && !mMetadataShortcutId.isEmpty());
}
/**
* Call when the views should be removed, ensure this is called to clean up ActivityView
* content.
*/
void cleanupViews() {
if (mExpandedView != null) {
mExpandedView.cleanUpExpandedState();
mExpandedView = null;
}
mIconView = null;
}
void setPendingIntentCanceled() {
mPendingIntentCanceled = true;
}
boolean getPendingIntentCanceled() {
return mPendingIntentCanceled;
}
/**
* Sets whether to perform inflation on the same thread as the caller. This method should only
* be used in tests, not in production.
*/
@VisibleForTesting
void setInflateSynchronously(boolean inflateSynchronously) {
mInflateSynchronously = inflateSynchronously;
}
/**
* Starts a task to inflate & load any necessary information to display a bubble.
*
* @param callback the callback to notify one the bubble is ready to be displayed.
* @param context the context for the bubble.
* @param stackView the stackView the bubble is eventually added to.
* @param iconFactory the iconfactory use to create badged images for the bubble.
*/
void inflate(BubbleViewInfoTask.Callback callback,
Context context,
BubbleStackView stackView,
BubbleIconFactory iconFactory,
boolean skipInflation) {
if (isBubbleLoading()) {
mInflationTask.cancel(true /* mayInterruptIfRunning */);
}
mInflationTask = new BubbleViewInfoTask(this,
context,
stackView,
iconFactory,
skipInflation,
callback);
if (mInflateSynchronously) {
mInflationTask.onPostExecute(mInflationTask.doInBackground());
} else {
mInflationTask.execute();
}
}
private boolean isBubbleLoading() {
return mInflationTask != null && mInflationTask.getStatus() != FINISHED;
}
boolean isInflated() {
return mIconView != null && mExpandedView != null;
}
void stopInflation() {
if (mInflationTask == null) {
return;
}
mInflationTask.cancel(true /* mayInterruptIfRunning */);
cleanupViews();
}
void setViewInfo(BubbleViewInfoTask.BubbleViewInfo info) {
if (!isInflated()) {
mIconView = info.imageView;
mExpandedView = info.expandedView;
}
mShortcutInfo = info.shortcutInfo;
mAppName = info.appName;
mFlyoutMessage = info.flyoutMessage;
mBadgedAppIcon = info.badgedAppIcon;
mBadgedImage = info.badgedBubbleImage;
mDotColor = info.dotColor;
mDotPath = info.dotPath;
if (mExpandedView != null) {
mExpandedView.update(this /* bubble */);
}
if (mIconView != null) {
mIconView.setRenderedBubble(this /* bubble */);
}
}
/**
* Set visibility of bubble in the expanded state.
*
* @param visibility {@code true} if the expanded bubble should be visible on the screen.
*
* Note that this contents visibility doesn't affect visibility at {@link android.view.View},
* and setting {@code false} actually means rendering the expanded view in transparent.
*/
@Override
public void setContentVisibility(boolean visibility) {
if (mExpandedView != null) {
mExpandedView.setContentVisibility(visibility);
}
}
/**
* Sets the entry associated with this bubble.
*/
void setEntry(@NonNull final NotificationEntry entry) {
Objects.requireNonNull(entry);
Objects.requireNonNull(entry.getSbn());
mLastUpdated = entry.getSbn().getPostTime();
mIsBubble = entry.getSbn().getNotification().isBubbleNotification();
mPackageName = entry.getSbn().getPackageName();
mUser = entry.getSbn().getUser();
mTitle = getTitle(entry);
mIsClearable = entry.isClearable();
mShouldSuppressNotificationDot = entry.shouldSuppressNotificationDot();
mShouldSuppressNotificationList = entry.shouldSuppressNotificationList();
mShouldSuppressPeek = entry.shouldSuppressPeek();
mChannelId = entry.getSbn().getNotification().getChannelId();
mNotificationId = entry.getSbn().getId();
mAppUid = entry.getSbn().getUid();
mInstanceId = entry.getSbn().getInstanceId();
mFlyoutMessage = BubbleViewInfoTask.extractFlyoutMessage(entry);
mShortcutInfo = (entry.getRanking() != null ? entry.getRanking().getShortcutInfo() : null);
mMetadataShortcutId = (entry.getBubbleMetadata() != null
? entry.getBubbleMetadata().getShortcutId() : null);
if (entry.getRanking() != null) {
mIsVisuallyInterruptive = entry.getRanking().visuallyInterruptive();
}
if (entry.getBubbleMetadata() != null) {
mFlags = entry.getBubbleMetadata().getFlags();
mDesiredHeight = entry.getBubbleMetadata().getDesiredHeight();
mDesiredHeightResId = entry.getBubbleMetadata().getDesiredHeightResId();
mIcon = entry.getBubbleMetadata().getIcon();
mIntent = entry.getBubbleMetadata().getIntent();
mDeleteIntent = entry.getBubbleMetadata().getDeleteIntent();
}
mIsImportantConversation =
entry.getChannel() == null ? false : entry.getChannel().isImportantConversation();
}
@Nullable
Icon getIcon() {
return mIcon;
}
boolean isVisuallyInterruptive() {
return mIsVisuallyInterruptive;
}
/**
* @return the last time this bubble was updated or accessed, whichever is most recent.
*/
long getLastActivity() {
return Math.max(mLastUpdated, mLastAccessed);
}
/**
* @return if the bubble was ever expanded
*/
boolean getWasAccessed() {
return mLastAccessed != 0L;
}
/**
* @return the display id of the virtual display on which bubble contents is drawn.
*/
@Override
public int getDisplayId() {
return mExpandedView != null ? mExpandedView.getVirtualDisplayId() : INVALID_DISPLAY;
}
public InstanceId getInstanceId() {
return mInstanceId;
}
@Nullable
public String getChannelId() {
return mChannelId;
}
public int getNotificationId() {
return mNotificationId;
}
/**
* Should be invoked whenever a Bubble is accessed (selected while expanded).
*/
void markAsAccessedAt(long lastAccessedMillis) {
mLastAccessed = lastAccessedMillis;
setSuppressNotification(true);
setShowDot(false /* show */);
}
/**
* Should be invoked whenever a Bubble is promoted from overflow.
*/
void markUpdatedAt(long lastAccessedMillis) {
mLastUpdated = lastAccessedMillis;
}
/**
* Whether this notification should be shown in the shade.
*/
boolean showInShade() {
return !shouldSuppressNotification() || !mIsClearable;
}
/**
* Whether this notification conversation is important.
*/
boolean isImportantConversation() {
return mIsImportantConversation;
}
/**
* Sets whether this notification should be suppressed in the shade.
*/
void setSuppressNotification(boolean suppressNotification) {
boolean prevShowInShade = showInShade();
if (suppressNotification) {
mFlags |= Notification.BubbleMetadata.FLAG_SUPPRESS_NOTIFICATION;
} else {
mFlags &= ~Notification.BubbleMetadata.FLAG_SUPPRESS_NOTIFICATION;
}
if (showInShade() != prevShowInShade && mSuppressionListener != null) {
mSuppressionListener.onBubbleNotificationSuppressionChange(this);
}
}
/**
* Sets whether the bubble for this notification should show a dot indicating updated content.
*/
void setShowDot(boolean showDot) {
mShowBubbleUpdateDot = showDot;
if (mIconView != null) {
mIconView.updateDotVisibility(true /* animate */);
}
}
/**
* Whether the bubble for this notification should show a dot indicating updated content.
*/
@Override
public boolean showDot() {
return mShowBubbleUpdateDot
&& !mShouldSuppressNotificationDot
&& !shouldSuppressNotification();
}
/**
* Whether the flyout for the bubble should be shown.
*/
boolean showFlyout() {
return !mSuppressFlyout && !mShouldSuppressPeek
&& !shouldSuppressNotification()
&& !mShouldSuppressNotificationList;
}
/**
* Set whether the flyout text for the bubble should be shown when an update is received.
*
* @param suppressFlyout whether the flyout text is shown
*/
void setSuppressFlyout(boolean suppressFlyout) {
mSuppressFlyout = suppressFlyout;
}
FlyoutMessage getFlyoutMessage() {
return mFlyoutMessage;
}
int getRawDesiredHeight() {
return mDesiredHeight;
}
int getRawDesiredHeightResId() {
return mDesiredHeightResId;
}
float getDesiredHeight(Context context) {
boolean useRes = mDesiredHeightResId != 0;
if (useRes) {
return getDimenForPackageUser(context, mDesiredHeightResId, mPackageName,
mUser.getIdentifier());
} else {
return mDesiredHeight * context.getResources().getDisplayMetrics().density;
}
}
String getDesiredHeightString() {
boolean useRes = mDesiredHeightResId != 0;
if (useRes) {
return String.valueOf(mDesiredHeightResId);
} else {
return String.valueOf(mDesiredHeight);
}
}
@Nullable
PendingIntent getBubbleIntent() {
return mIntent;
}
@Nullable
PendingIntent getDeleteIntent() {
return mDeleteIntent;
}
Intent getSettingsIntent(final Context context) {
final Intent intent = new Intent(Settings.ACTION_APP_NOTIFICATION_BUBBLE_SETTINGS);
intent.putExtra(Settings.EXTRA_APP_PACKAGE, getPackageName());
final int uid = getUid(context);
if (uid != -1) {
intent.putExtra(Settings.EXTRA_APP_UID, uid);
}
intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
return intent;
}
public int getAppUid() {
return mAppUid;
}
private int getUid(final Context context) {
if (mAppUid != -1) return mAppUid;
final PackageManager pm = context.getPackageManager();
if (pm == null) return -1;
try {
final ApplicationInfo info = pm.getApplicationInfo(mShortcutInfo.getPackage(), 0);
return info.uid;
} catch (PackageManager.NameNotFoundException e) {
Log.e(TAG, "cannot find uid", e);
}
return -1;
}
private int getDimenForPackageUser(Context context, int resId, String pkg, int userId) {
PackageManager pm = context.getPackageManager();
Resources r;
if (pkg != null) {
try {
if (userId == UserHandle.USER_ALL) {
userId = UserHandle.USER_SYSTEM;
}
r = pm.getResourcesForApplicationAsUser(pkg, userId);
return r.getDimensionPixelSize(resId);
} catch (PackageManager.NameNotFoundException ex) {
// Uninstalled, don't care
} catch (Resources.NotFoundException e) {
// Invalid res id, return 0 and user our default
Log.e(TAG, "Couldn't find desired height res id", e);
}
}
return 0;
}
private boolean shouldSuppressNotification() {
return isEnabled(Notification.BubbleMetadata.FLAG_SUPPRESS_NOTIFICATION);
}
public boolean shouldAutoExpand() {
return isEnabled(Notification.BubbleMetadata.FLAG_AUTO_EXPAND_BUBBLE);
}
void setShouldAutoExpand(boolean shouldAutoExpand) {
if (shouldAutoExpand) {
enable(Notification.BubbleMetadata.FLAG_AUTO_EXPAND_BUBBLE);
} else {
disable(Notification.BubbleMetadata.FLAG_AUTO_EXPAND_BUBBLE);
}
}
public void setIsBubble(final boolean isBubble) {
mIsBubble = isBubble;
}
public boolean isBubble() {
return mIsBubble;
}
public void enable(int option) {
mFlags |= option;
}
public void disable(int option) {
mFlags &= ~option;
}
public boolean isEnabled(int option) {
return (mFlags & option) != 0;
}
@Override
public String toString() {
return "Bubble{" + mKey + '}';
}
/**
* Description of current bubble state.
*/
public void dump(
@NonNull FileDescriptor fd, @NonNull PrintWriter pw, @NonNull String[] args) {
pw.print("key: "); pw.println(mKey);
pw.print(" showInShade: "); pw.println(showInShade());
pw.print(" showDot: "); pw.println(showDot());
pw.print(" showFlyout: "); pw.println(showFlyout());
pw.print(" desiredHeight: "); pw.println(getDesiredHeightString());
pw.print(" suppressNotif: "); pw.println(shouldSuppressNotification());
pw.print(" autoExpand: "); pw.println(shouldAutoExpand());
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Bubble)) return false;
Bubble bubble = (Bubble) o;
return Objects.equals(mKey, bubble.mKey);
}
@Override
public int hashCode() {
return Objects.hash(mKey);
}
@Override
public void logUIEvent(int bubbleCount, int action, float normalX, float normalY, int index) {
SysUiStatsLog.write(SysUiStatsLog.BUBBLE_UI_CHANGED,
mPackageName,
mChannelId,
mNotificationId,
index,
bubbleCount,
action,
normalX,
normalY,
showInShade(),
false /* isOngoing (unused) */,
false /* isAppForeground (unused) */);
}
@Nullable
private static String getTitle(@NonNull final NotificationEntry e) {
final CharSequence titleCharSeq = e.getSbn().getNotification().extras.getCharSequence(
Notification.EXTRA_TITLE);
return titleCharSeq == null ? null : titleCharSeq.toString();
}
}