java/com/android/dialer/notification/DialerNotificationManager.java

/*
 * Copyright (C) 2017 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.dialer.notification;

import android.app.Notification;
import android.app.NotificationManager;
import android.content.Context;
import android.service.notification.StatusBarNotification;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.v4.os.BuildCompat;
import android.text.TextUtils;
import android.util.Pair;
import com.android.dialer.common.Assert;
import com.android.dialer.common.LogUtil;
import java.util.HashSet;
import java.util.Set;

/**
 * Wrapper around the notification manager APIs. The wrapper ensures that channels are set and that
 * notifications are limited to 10 per group.
 */
public final class DialerNotificationManager {

  private static final Set<StatusBarNotification> throttledNotificationSet = new HashSet<>();

  public static void notify(@NonNull Context context, int id, @NonNull Notification notification) {
    Assert.isNotNull(context);
    Assert.isNotNull(notification);
    throw Assert.createUnsupportedOperationFailException("all notifications must have tags");
  }

  public static void notify(
      @NonNull Context context, @NonNull String tag, int id, @NonNull Notification notification) {
    Assert.isNotNull(context);
    Assert.isNotNull(notification);
    Assert.checkArgument(!TextUtils.isEmpty(tag));

    if (BuildCompat.isAtLeastO()) {
      Assert.checkArgument(!TextUtils.isEmpty(notification.getChannelId()));
    }

    getNotificationManager(context).notify(tag, id, notification);
    throttledNotificationSet.addAll(NotificationThrottler.throttle(context, notification));
  }

  public static void cancel(@NonNull Context context, int id) {
    Assert.isNotNull(context);
    throw Assert.createUnsupportedOperationFailException(
        "notification IDs are not unique across the app, a tag must be specified");
  }

  public static void cancel(@NonNull Context context, @NonNull String tag, int id) {
    Assert.isNotNull(context);
    Assert.checkArgument(!TextUtils.isEmpty(tag));

    NotificationManager notificationManager = getNotificationManager(context);
    StatusBarNotification[] notifications = notificationManager.getActiveNotifications();

    String groupKey = findGroupKey(notifications, tag, id);
    if (!TextUtils.isEmpty(groupKey)) {
      Pair<StatusBarNotification, Integer> groupSummaryAndCount =
          getGroupSummaryAndCount(notifications, groupKey);
      if (groupSummaryAndCount.first != null && groupSummaryAndCount.second <= 1) {
        LogUtil.i(
            "DialerNotificationManager.cancel",
            "last notification in group (%s) removed, also removing group summary",
            groupKey);
        notificationManager.cancel(
            groupSummaryAndCount.first.getTag(), groupSummaryAndCount.first.getId());
      }
    }

    notificationManager.cancel(tag, id);
  }

  public static void cancelAll(Context context, String prefix) {
    NotificationManager notificationManager = getNotificationManager(context);
    StatusBarNotification[] notifications = notificationManager.getActiveNotifications();
    for (StatusBarNotification notification : notifications) {
      if (notification.getTag() != null && notification.getTag().startsWith(prefix)) {
        notificationManager.cancel(notification.getTag(), notification.getId());
      }
    }
  }

  public static StatusBarNotification[] getActiveNotifications(@NonNull Context context) {
    Assert.isNotNull(context);
    return getNotificationManager(context).getActiveNotifications();
  }

  @Nullable
  private static String findGroupKey(
      @NonNull StatusBarNotification[] notifications, @NonNull String tag, int id) {
    for (StatusBarNotification notification : notifications) {
      if (TextUtils.equals(tag, notification.getTag()) && id == notification.getId()) {
        return notification.getNotification().getGroup();
      }
    }
    return null;
  }

  @NonNull
  private static Pair<StatusBarNotification, Integer> getGroupSummaryAndCount(
      @NonNull StatusBarNotification[] notifications, @NonNull String groupKey) {
    StatusBarNotification groupSummaryNotification = null;
    int groupCount = 0;
    for (StatusBarNotification notification : notifications) {
      if (TextUtils.equals(groupKey, notification.getNotification().getGroup())) {
        if ((notification.getNotification().flags & Notification.FLAG_GROUP_SUMMARY) != 0) {
          groupSummaryNotification = notification;
        } else {
          groupCount++;
        }
      }
    }
    return new Pair<>(groupSummaryNotification, groupCount);
  }

  @NonNull
  private static NotificationManager getNotificationManager(@NonNull Context context) {
    return context.getSystemService(NotificationManager.class);
  }

  public static Set<StatusBarNotification> getThrottledNotificationSet() {
    return throttledNotificationSet;
  }

  private DialerNotificationManager() {}
}