Merge pull request #426 from Iterable/MOB-3970-NEW-SetShowBadge

[MOB-3970] - Notification Badge through Android Manifest

Author: Ayyanchira

iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java

@@ -142,6 +142,7 @@ public final class IterableConstants {
     public static final String INSTANCE_ID_CLASS        = "com.google.android.gms.iid.InstanceID";
     public static final String ICON_FOLDER_IDENTIFIER   = "drawable";
     public static final String NOTIFICATION_ICON_NAME   = "iterable_notification_icon";
+    public static final String NOTIFICAION_BADGING      = "iterable_notification_badging";
     public static final String NOTIFICATION_COLOR       = "iterable_notification_color";
     public static final String NOTIFICATION_CHANNEL_NAME = "iterable_notification_channel_name";
     public static final String DEFAULT_SOUND            = "default";

iterableapi/src/main/java/com/iterable/iterableapi/IterableNotificationHelper.java

@@ -12,6 +12,8 @@
 import android.net.Uri;
 import android.os.Build;
 import android.os.Bundle;
+import android.service.notification.StatusBarNotification;
+
 import androidx.annotation.VisibleForTesting;
 import androidx.core.app.NotificationCompat;
 
@@ -22,6 +24,7 @@
 
 class IterableNotificationHelper {
     private static final String DEFAULT_CHANNEL_NAME = "iterable channel";
+    private static final String NO_BADGE = "_noBadge";
 
     @VisibleForTesting
     static IterableNotificationHelperImpl instance = new IterableNotificationHelperImpl();
@@ -100,7 +103,6 @@ public IterableNotificationBuilder createNotification(Context context, Bundle ex
             String pushImage = null;
             //TODO: When backend supports channels, these strings needs to change (channelName, channelId, channelDescription).
             String channelName = getChannelName(context);
-            String channelId = context.getPackageName();
             String channelDescription = "";
 
             if (!extras.containsKey(IterableConstants.ITERABLE_DATA_KEY)) {
@@ -113,8 +115,9 @@ public IterableNotificationBuilder createNotification(Context context, Bundle ex
                 return null;
             }
 
-            registerChannelIfEmpty(context, channelId, channelName, channelDescription);
-            IterableNotificationBuilder notificationBuilder = new IterableNotificationBuilder(context, context.getPackageName());
+            removeUnusedChannel(context);
+            registerChannelIfEmpty(context, getChannelId(context), channelName, channelDescription);
+            IterableNotificationBuilder notificationBuilder = new IterableNotificationBuilder(context, getChannelId(context));
             JSONObject iterableJson = null;
             title = extras.getString(IterableConstants.ITERABLE_DATA_TITLE, applicationName);
             notificationBody = extras.getString(IterableConstants.ITERABLE_DATA_BODY);
@@ -261,21 +264,79 @@ private void registerChannelIfEmpty(Context context, String channelId, String ch
                 if (existingChannel == null || !existingChannel.getName().equals(channelName)) {
                     IterableLogger.d(IterableNotificationBuilder.TAG, "Creating notification: channelId = " + channelId + " channelName = "
                             + channelName + " channelDescription = " + channelDescription);
-                    mNotificationManager.createNotificationChannel(createNotificationChannel(channelId, channelName, channelDescription));
+                    mNotificationManager.createNotificationChannel(createNotificationChannel(channelId, channelName, channelDescription, context));
                 }
             }
         }
 
-        private NotificationChannel createNotificationChannel(String channelId, String channelName, String channelDescription) {
+        /**
+         * Safely removes unused and old channel if the configuration for notification badge is changed.
+         */
+        private void removeUnusedChannel(Context context) {
+            NotificationManager mNotificationManager = (NotificationManager)
+                    context.getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE);
+
+            if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O
+                    && mNotificationManager != null) {
+                String channelIdToDelete = getOldChannelId(context);
+                NotificationChannel unusedChannel = mNotificationManager.getNotificationChannel(channelIdToDelete);
+                if (unusedChannel != null) {
+                    for (StatusBarNotification activeNotification : mNotificationManager.getActiveNotifications()) {
+                        if (activeNotification.getNotification().getChannelId() == channelIdToDelete) {
+                            IterableLogger.d(IterableNotificationBuilder.TAG, "Not Deleting the channel as there are active notification for old channel");
+                            return;
+                        }
+                    }
+                    mNotificationManager.deleteNotificationChannel(channelIdToDelete);
+                }
+            }
+        }
+
+        private NotificationChannel createNotificationChannel(String channelId, String channelName, String channelDescription, Context context) {
             NotificationChannel notificationChannel = null;
             if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
                 notificationChannel = new NotificationChannel(channelId, channelName, NotificationManager.IMPORTANCE_HIGH);
                 notificationChannel.setDescription(channelDescription);
                 notificationChannel.enableLights(true);
+                notificationChannel.setShowBadge(isNotificationBadgingEnabled(context));
             }
             return notificationChannel;
         }
 
+        private static boolean isNotificationBadgingEnabled(Context context) {
+            try {
+                ApplicationInfo info = context.getPackageManager().getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
+                if (info.metaData != null) {
+                    return info.metaData.getBoolean(IterableConstants.NOTIFICAION_BADGING, true);
+                }
+            } catch (PackageManager.NameNotFoundException e) {
+                IterableLogger.e(IterableNotificationBuilder.TAG, e.getLocalizedMessage() + " Failed to read notification badge settings. Setting to defaults - true");
+            }
+            return true;
+        }
+
+        private String getChannelId(Context context) {
+            return getChannelIdName(context, true);
+        }
+
+        private String getOldChannelId(Context context) {
+            return getChannelIdName(context, false);
+        }
+
+        private String getChannelIdName(Context context, boolean isActive) {
+            String channelId = context.getPackageName();
+            if (isActive) {
+                if (!isNotificationBadgingEnabled(context)) {
+                    channelId = channelId + NO_BADGE;
+                }
+            } else {
+                if (isNotificationBadgingEnabled(context)) {
+                    channelId = channelId + NO_BADGE;
+                }
+            }
+            return channelId;
+        }
+
         private String getChannelName(Context context) {
             String channelName = null;
             try {