feat(notifications): adds ability to customize which activity will be launched

Provides a way to customize next steps when push notification is received.

Author: milos1290

AndroidSDK/src/com/leanplum/LeanplumPushReceiver.java

@@ -24,7 +24,11 @@
 import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
+import android.content.pm.ApplicationInfo;
+import android.content.pm.PackageManager;
+import android.os.Bundle;
 
+import com.leanplum.internal.LeanplumManifestHelper;
 import com.leanplum.internal.Log;
 import com.leanplum.internal.Util;
 
@@ -43,7 +47,20 @@ public void onReceive(Context context, Intent intent) {
         Log.e("Received a null intent.");
         return;
       }
-      LeanplumPushService.openNotification(context, intent.getExtras());
+      // Parse manifest and pull metadata which contains client broadcast receiver class.
+      String receiver = LeanplumManifestHelper.parseNotificationMetadata();
+      // If receiver isn't found we will open up notification with default activity
+      if (receiver == null) {
+        Log.d("Custom broadcast receiver class not set, using default one.");
+        LeanplumPushService.openNotification(context, intent);
+      } else {
+        Log.d("Custom broadcast receiver class found, using it to handle push notifications.");
+        // Forward Intent to a client broadcast receiver.
+        Intent forwardIntent = new Intent();
+        forwardIntent.setClassName(context, receiver);
+        forwardIntent.putExtras(intent.getExtras());
+        context.sendBroadcast(forwardIntent);
+      }
     } catch (Throwable t) {
       Util.handleException(t);
     }

AndroidSDK/src/com/leanplum/LeanplumPushService.java

@@ -71,6 +71,23 @@ public class LeanplumPushService {
    * Leanplum's built-in Google Cloud Messaging sender ID.
    */
   public static final String LEANPLUM_SENDER_ID = "44059457771";
+
+  /**
+   * Action param key contained when Notification Bundle is parsed with {@link
+   * LeanplumPushService#parseNotificationBundle(Bundle)}.
+   */
+  public static final String LEANPLUM_ACTION_PARAM = "lp_action_param";
+  /**
+   * Message title param key contained when Notification Bundle is parsed with {@link
+   * LeanplumPushService#parseNotificationBundle(Bundle)}.
+   */
+  public static final String LEANPLUM_MESSAGE_PARAM = "lp_message_param";
+  /**
+   * Message id param key contained when Notification Bundle is parsed with {@link
+   * LeanplumPushService#parseNotificationBundle(Bundle)}.
+   */
+  public static final String LEANPLUM_MESSAGE_ID = "lp_message_id";
+
   private static final String LEANPLUM_PUSH_FCM_LISTENER_SERVICE_CLASS =
       "com.leanplum.LeanplumPushFcmListenerService";
   private static final String PUSH_FIREBASE_MESSAGING_SERVICE_CLASS =
@@ -349,10 +366,11 @@ private static void showNotification(Context context, Bundle message) {
     notificationManager.notify(notificationId, builder.build());
   }
 
-  static void openNotification(Context context, final Bundle notification) {
+  static void openNotification(Context context, Intent intent) {
     Log.d("Opening push notification action.");
+    // Pre handles push notification.
+    Bundle notification = preHandlePushNotification(context, intent);
     if (notification == null) {
-      Log.i("Received null Bundle.");
       return;
     }
 
@@ -364,24 +382,85 @@ static void openNotification(Context context, final Bundle notification) {
     // Start activity.
     Class<? extends Activity> callbackClass = LeanplumPushService.getCallbackClass();
     boolean shouldStartActivity = true;
-    if (LeanplumActivityHelper.currentActivity != null &&
-        !LeanplumActivityHelper.isActivityPaused) {
+    Activity currentActivity= LeanplumActivityHelper.currentActivity;
+    if (currentActivity != null && !LeanplumActivityHelper.isActivityPaused) {
       if (callbackClass == null) {
         shouldStartActivity = false;
-      } else if (callbackClass.isInstance(LeanplumActivityHelper.currentActivity)) {
+      } else if (callbackClass.isInstance(currentActivity)) {
         shouldStartActivity = false;
       }
     }
 
     if (shouldStartActivity) {
       Intent actionIntent = getActionIntent(context);
       actionIntent.putExtras(notification);
-      actionIntent.addFlags(
-          Intent.FLAG_ACTIVITY_CLEAR_TOP |
-              Intent.FLAG_ACTIVITY_NEW_TASK);
+      actionIntent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_NEW_TASK);
       context.startActivity(actionIntent);
     }
+    // Post handles push notification.
+    postHandlePushNotification(context, intent);
+  }
 
+  /**
+   * Parse notification bundle. Use this method to get parsed bundle to decide next step. Parsed
+   * data will contain {@link LeanplumPushService#LEANPLUM_ACTION_PARAM}, {@link
+   * LeanplumPushService#LEANPLUM_MESSAGE_PARAM} and {@link LeanplumPushService#LEANPLUM_MESSAGE_ID}
+   *
+   * @param notificationBundle Bundle to be parsed.
+   * @return Map containing Actions, Message title and Message Id.
+   */
+  public static Map<String, Object> parseNotificationBundle(Bundle notificationBundle) {
+    try {
+      String notificationActions = notificationBundle.getString(Keys.PUSH_MESSAGE_ACTION);
+      String notificationMessage = notificationBundle.getString(Keys.PUSH_MESSAGE_TEXT);
+      String notificationMessageId = LeanplumPushService.getMessageId(notificationBundle);
+
+      Map<String, Object> arguments = new HashMap<>();
+      arguments.put(LEANPLUM_ACTION_PARAM, JsonConverter.fromJson(notificationActions));
+      arguments.put(LEANPLUM_MESSAGE_PARAM, notificationMessage);
+      arguments.put(LEANPLUM_MESSAGE_ID, notificationMessageId);
+
+      return arguments;
+    } catch (Throwable ignored) {
+      Log.i("Failed to parse notification bundle.");
+    }
+    return null;
+  }
+
+  /**
+   * Must be called before deciding which activity will be opened, to allow Leanplum SDK to track
+   * stats, open events etc.
+   *
+   * @param context Surrounding context.
+   * @param intent Received Intent.
+   * @return Bundle containing push notification data.
+   */
+  public static Bundle preHandlePushNotification(Context context, Intent intent) {
+    if (intent == null) {
+      Log.i("Unable to pre handle push notification, Intent is null.");
+      return null;
+    }
+    Bundle notification = intent.getExtras();
+    if (notification == null) {
+      Log.i("Unable to pre handle push notification, extras are null.");
+      return null;
+    }
+    return notification;
+  }
+
+  /**
+   * Must be called after deciding which activity will be opened, to allow Leanplum SDK to track
+   * stats, open events etc.
+   *
+   * @param context Surrounding context.
+   * @param intent Received Intent.
+   */
+  public static void postHandlePushNotification(Context context, Intent intent) {
+    final Bundle notification = intent.getExtras();
+    if (notification == null) {
+      Log.i("Could not post handle push notification, extras are null.");
+      return;
+    }
     // Perform action.
     LeanplumActivityHelper.queueActionUponActive(new VariablesChangedCallback() {
       @Override
@@ -396,8 +475,8 @@ public void variablesChanged() {
               Map<String, Object> args = new HashMap<>();
               args.put(actionName, JsonConverter.fromJson(
                   notification.getString(Keys.PUSH_MESSAGE_ACTION)));
-              ActionContext context = new ActionContext(
-                  ActionManager.PUSH_NOTIFICATION_ACTION_NAME, args, messageId);
+              ActionContext context = new ActionContext(ActionManager.PUSH_NOTIFICATION_ACTION_NAME,
+                  args, messageId);
               context.preventRealtimeUpdating();
               context.update();
               context.runTrackedActionNamed(actionName);

AndroidSDK/src/com/leanplum/internal/Constants.java

@@ -259,5 +259,6 @@ public static class Messaging {
 
   public static class ClassUtil {
     public static final String UI_INTERFACE_EDITOR = "com.leanplum.uieditor.LeanplumUIEditor";
+    public static final String LEANPLUM_NOTIFICATION_RECEIVER = "LP_NOTIFICATION_RECEIVER";
   }
 }

AndroidSDK/src/com/leanplum/internal/LeanplumManifestHelper.java

@@ -22,7 +22,9 @@
 package com.leanplum.internal;
 
 import android.content.Context;
+import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageManager;
+import android.os.Bundle;
 import android.text.TextUtils;
 
 import com.leanplum.Leanplum;
@@ -518,6 +520,23 @@ public static boolean checkPermission(String permission, boolean definesPermissi
     return true;
   }
 
+  /**
+   * Parses and returns client broadcast receiver class name.
+   *
+   * @return Client broadcast receiver class name.
+   */
+  public static String parseNotificationMetadata() {
+    try {
+      Context context = Leanplum.getContext();
+      ApplicationInfo app = context.getPackageManager().getApplicationInfo(context.getPackageName(),
+          PackageManager.GET_META_DATA);
+      Bundle bundle = app.metaData;
+      return bundle.getString(Constants.ClassUtil.LEANPLUM_NOTIFICATION_RECEIVER);
+    } catch (Throwable ignored) {
+    }
+    return null;
+  }
+
   /**
    * Class with Android manifest data.
    */