feat(notification): LP-5014 Add support 2 lines text at BigPictureStyle pus n… (#104)

Enuviel · web-flow · commit f447f871cf65 · 2017-10-13T13:15:41.000-07:00
* feat(notification): Add support 2 lines text at BigPictureStyle pus notification.

* bump support library from 14.0.0 to 22.0.0
diff --git a/AndroidSDK/build.gradle b/AndroidSDK/build.gradle
@@ -17,9 +17,9 @@ allprojects {
 dependencies {
     // Compile dependencies will be added as dependency in pom file.
     //noinspection GradleDynamicVersion
-    compile "com.android.support:support-v4:[14.0.0,${SUPPORT_LIBRARY_VERSION}]"
+    compile "com.android.support:support-v4:[22.0.0,${SUPPORT_LIBRARY_VERSION}]"
     //noinspection GradleDynamicVersion
-    compile "com.android.support:appcompat-v7:[14.0.0,${SUPPORT_LIBRARY_VERSION}]"
+    compile "com.android.support:appcompat-v7:[22.0.0,${SUPPORT_LIBRARY_VERSION}]"
 
     // Provided dependencies are optional dependencies and will not show up in pom file.
     provided('com.google.android.gms:play-services-gcm:[8.3.0,)') {
diff --git a/AndroidSDK/src/com/leanplum/Leanplum.java b/AndroidSDK/src/com/leanplum/Leanplum.java
@@ -821,7 +821,7 @@ public void onResponse(boolean success) {
                   public void run() {
                     try {
                       NotificationCompat.Builder builder =
-                          LeanplumNotificationHelper.getDefaultNotificationBuilder(context,
+                          LeanplumNotificationHelper.getDefaultCompatNotificationBuilder(context,
                               BuildUtil.isNotificationChannelSupported(context));
                       if (builder == null) {
                         return;
diff --git a/AndroidSDK/src/com/leanplum/LeanplumNotificationHelper.java b/AndroidSDK/src/com/leanplum/LeanplumNotificationHelper.java
@@ -20,11 +20,19 @@
  */
 package com.leanplum;
 
+import android.app.Notification;
+import android.app.PendingIntent;
 import android.content.Context;
+import android.content.res.Resources;
+import android.graphics.Bitmap;
+import android.os.Build;
 import android.os.Bundle;
 import android.support.v4.app.NotificationCompat;
 import android.text.TextUtils;
+import android.util.TypedValue;
+import android.widget.RemoteViews;
 
+import com.leanplum.internal.Constants;
 import com.leanplum.internal.JsonConverter;
 import com.leanplum.internal.Log;
 import com.leanplum.utils.BuildUtil;
@@ -37,6 +45,10 @@
  * @author Anna Orlova
  */
 class LeanplumNotificationHelper {
+
+  private static final int BIGPICTURE_TEXT_TOP_PADDING = -14;
+  private static final int BIGPICTURE_TEXT_SIZE = 14;
+
   /**
    * If notification channels are supported this method will try to create
    * NotificationCompat.Builder with default notification channel if default channel id is provided.
@@ -49,7 +61,7 @@ class LeanplumNotificationHelper {
    */
   // NotificationCompat.Builder(Context context) constructor was deprecated in API level 26.
   @SuppressWarnings("deprecation")
-  static NotificationCompat.Builder getDefaultNotificationBuilder(Context context,
+  static NotificationCompat.Builder getDefaultCompatNotificationBuilder(Context context,
       boolean isNotificationChannelSupported) {
     if (!isNotificationChannelSupported) {
       return new NotificationCompat.Builder(context);
@@ -63,6 +75,32 @@ static NotificationCompat.Builder getDefaultNotificationBuilder(Context context,
     }
   }
 
+  /**
+   * If notification channels are supported this method will try to create
+   * Notification.Builder with default notification channel if default channel id is provided.
+   * If notification channels not supported this method will return Notification.Builder for
+   * context.
+   *
+   * @param context The application context.
+   * @param isNotificationChannelSupported True if notification channels are supported.
+   * @return Notification.Builder for provided context or null.
+   */
+  // Notification.Builder(Context context) constructor was deprecated in API level 26.
+  @SuppressWarnings("deprecation")
+  private static Notification.Builder getDefaultNotificationBuilder(Context context,
+      boolean isNotificationChannelSupported) {
+    if (!isNotificationChannelSupported) {
+      return new Notification.Builder(context);
+    }
+    String channelId = LeanplumNotificationChannel.getDefaultNotificationChannelId(context);
+    if (!TextUtils.isEmpty(channelId)) {
+      return new Notification.Builder(context, channelId);
+    } else {
+      Log.w("Failed to post notification, there are no notification channels configured.");
+      return null;
+    }
+  }
+
   /**
    * If notification channels are supported this method will try to create a channel with
    * information from the message if it doesn't exist and return NotificationCompat.Builder for this
@@ -76,7 +114,7 @@ static NotificationCompat.Builder getDefaultNotificationBuilder(Context context,
    */
   // NotificationCompat.Builder(Context context) constructor was deprecated in API level 26.
   @SuppressWarnings("deprecation")
-  static NotificationCompat.Builder getNotificationBuilder(Context context, Bundle message) {
+  static NotificationCompat.Builder getNotificationCompatBuilder(Context context, Bundle message) {
     NotificationCompat.Builder builder = null;
     // If we are targeting API 26, try to find supplied channel to post notification.
     if (BuildUtil.isNotificationChannelSupported(context)) {
@@ -94,7 +132,7 @@ static NotificationCompat.Builder getNotificationBuilder(Context context, Bundle
           }
         } else {
           // If channel isn't supplied, try to look up for default channel.
-          builder = LeanplumNotificationHelper.getDefaultNotificationBuilder(context, true);
+          builder = LeanplumNotificationHelper.getDefaultCompatNotificationBuilder(context, true);
         }
       } catch (Exception e) {
         Log.e("Failed to post notification to specified channel.");
@@ -104,4 +142,111 @@ static NotificationCompat.Builder getNotificationBuilder(Context context, Bundle
     }
     return builder;
   }
+
+  /**
+   * If notification channels are supported this method will try to create a channel with
+   * information from the message if it doesn't exist and return Notification.Builder for this
+   * channel. In the case where no channel information inside the message, we will try to get a
+   * channel with default channel id. If notification channels not supported this method will return
+   * Notification.Builder for context.
+   *
+   * @param context The application context.
+   * @param message Push notification Bundle.
+   * @return Notification.Builder or null.
+   */
+  static Notification.Builder getNotificationBuilder(Context context, Bundle message) {
+    Notification.Builder builder = null;
+    // If we are targeting API 26, try to find supplied channel to post notification.
+    if (BuildUtil.isNotificationChannelSupported(context)) {
+      try {
+        String channel = message.getString("lp_channel");
+        if (!TextUtils.isEmpty(channel)) {
+          // Create channel if it doesn't exist and post notification to that channel.
+          Map<String, Object> channelDetails = JsonConverter.fromJson(channel);
+          String channelId = LeanplumNotificationChannel.createNotificationChannel(context,
+              channelDetails);
+          if (!TextUtils.isEmpty(channelId)) {
+            builder = new Notification.Builder(context, channelId);
+          } else {
+            Log.w("Failed to post notification to specified channel.");
+          }
+        } else {
+          // If channel isn't supplied, try to look up for default channel.
+          builder = LeanplumNotificationHelper.getDefaultNotificationBuilder(context, true);
+        }
+      } catch (Exception e) {
+        Log.e("Failed to post notification to specified channel.");
+      }
+    } else {
+      builder = new Notification.Builder(context);
+    }
+    return builder;
+  }
+
+  /**
+   * Gets Notification.Builder with 2 lines at BigPictureStyle notification text.
+   *
+   * @param context The application context.
+   * @param message Push notification Bundle.
+   * @param contentIntent PendingIntent.
+   * @param title String with title for push notification.
+   * @param messageText String with text for push notification.
+   * @param bigPicture Bitmap for BigPictureStyle notification.
+   * @return Notification.Builder or null.
+   */
+  static Notification.Builder getNotificationBuilder(Context context, Bundle message,
+      PendingIntent contentIntent, String title, final String messageText, Bitmap bigPicture) {
+    if (Build.VERSION.SDK_INT < 16) {
+      return null;
+    }
+    Notification.Builder notificationBuilder =
+        getNotificationBuilder(context, message);
+    notificationBuilder.setSmallIcon(context.getApplicationInfo().icon)
+        .setContentTitle(title)
+        .setContentText(messageText);
+    Notification.BigPictureStyle bigPictureStyle = new Notification.BigPictureStyle() {
+      @Override
+      protected RemoteViews getStandardView(int layoutId) {
+        RemoteViews remoteViews = super.getStandardView(layoutId);
+        // Modifications of stanxdard push RemoteView.
+        try {
+          int id = Resources.getSystem().getIdentifier("text", "id", "android");
+          remoteViews.setBoolean(id, "setSingleLine", false);
+          remoteViews.setInt(id, "setLines", 2);
+          if (Build.VERSION.SDK_INT < 23) {
+            // Make text smaller.
+            remoteViews.setViewPadding(id, 0, BIGPICTURE_TEXT_TOP_PADDING, 0, 0);
+            remoteViews.setTextViewTextSize(id, TypedValue.COMPLEX_UNIT_SP, BIGPICTURE_TEXT_SIZE);
+          }
+        } catch (Throwable throwable) {
+          Log.e("Cannot modify push notification layout.");
+        }
+        return remoteViews;
+      }
+    };
+
+    bigPictureStyle.bigPicture(bigPicture)
+        .setBigContentTitle(title)
+        .setSummaryText(message.getString(Constants.Keys.PUSH_MESSAGE_TEXT));
+    notificationBuilder.setStyle(bigPictureStyle);
+
+    if (Build.VERSION.SDK_INT >= 24) {
+      // By default we cannot reach getStandardView method on API>=24. I we call
+      // createBigContentView, Android will call getStandardView method and we can get
+      // modified RemoteView.
+      try {
+        RemoteViews remoteView = notificationBuilder.createBigContentView();
+        if (remoteView != null) {
+          // We need to set received RemoteView as a custom big content view.
+          notificationBuilder.setCustomBigContentView(remoteView);
+        }
+      } catch (Throwable t) {
+        Log.e("Cannot modify push notification layout.", t);
+      }
+    }
+
+    notificationBuilder.setAutoCancel(true);
+    notificationBuilder.setContentIntent(contentIntent);
+    return notificationBuilder;
+  }
 }
diff --git a/AndroidSDK/src/com/leanplum/LeanplumPushService.java b/AndroidSDK/src/com/leanplum/LeanplumPushService.java
@@ -50,6 +50,7 @@
 import com.leanplum.internal.Util;
 import com.leanplum.internal.VarCache;
 import com.leanplum.utils.BitmapUtil;
+import com.leanplum.utils.BuildUtil;
 import com.leanplum.utils.SharedPreferencesUtil;
 
 import org.json.JSONException;
@@ -104,6 +105,7 @@ public class LeanplumPushService {
   private static final String OPEN_URL = "Open URL";
   private static final String URL = "URL";
   private static final String OPEN_ACTION = "Open";
+  private static final int MAX_ONE_LINE_TEXT_LENGTH = 37;
   private static Class<? extends Activity> callbackClass;
   private static LeanplumCloudMessagingProvider provider;
   private static boolean isFirebaseEnabled = false;
@@ -299,7 +301,7 @@ static void handleNotification(final Context context, final Bundle message) {
   /**
    * Put the message into a notification and post it.
    */
-  private static void showNotification(Context context, Bundle message) {
+  private static void showNotification(Context context, final Bundle message) {
     if (context == null || message == null) {
       return;
     }
@@ -318,28 +320,35 @@ private static void showNotification(Context context, Bundle message) {
     if (message.getString("title") != null) {
       title = message.getString("title");
     }
-    final NotificationCompat.Builder builder =
-        LeanplumNotificationHelper.getNotificationBuilder(context, message);
+    final NotificationCompat.Builder notificationCompatBuilder =
+        LeanplumNotificationHelper.getNotificationCompatBuilder(context, message);
 
-    if (builder == null) {
+    if (notificationCompatBuilder == null) {
       return;
     }
-
-    builder.setSmallIcon(context.getApplicationInfo().icon)
+    final String messageText = message.getString(Keys.PUSH_MESSAGE_TEXT);
+    notificationCompatBuilder.setSmallIcon(context.getApplicationInfo().icon)
         .setContentTitle(title)
         .setStyle(new NotificationCompat.BigTextStyle()
-            .bigText(message.getString(Keys.PUSH_MESSAGE_TEXT)))
-        .setContentText(message.getString(Keys.PUSH_MESSAGE_TEXT));
+            .bigText(messageText))
+        .setContentText(messageText);
 
     String imageUrl = message.getString(Keys.PUSH_MESSAGE_IMAGE_URL);
+    Notification.Builder notificationBuilder = null;
     // BigPictureStyle support requires API 16 and higher.
     if (!TextUtils.isEmpty(imageUrl) && Build.VERSION.SDK_INT >= 16) {
       Bitmap bigPicture = BitmapUtil.getScaledBitmap(context, imageUrl);
       if (bigPicture != null) {
-        builder.setStyle(new NotificationCompat.BigPictureStyle()
-            .bigPicture(bigPicture)
-            .setBigContentTitle(title)
-            .setSummaryText(message.getString(Keys.PUSH_MESSAGE_TEXT)));
+        if ((messageText != null && messageText.length() < MAX_ONE_LINE_TEXT_LENGTH) ||
+            customizer != null) {
+          notificationCompatBuilder.setStyle(new NotificationCompat.BigPictureStyle()
+              .bigPicture(bigPicture)
+              .setBigContentTitle(title)
+              .setSummaryText(messageText));
+        } else {
+          notificationBuilder = LeanplumNotificationHelper.getNotificationBuilder(context, message, contentIntent, title,
+              messageText, bigPicture);
+        }
       } else {
         Log.w(String.format("Image download failed for push notification with big picture. " +
             "No image will be included with the push notification. Image URL: %s.", imageUrl));
@@ -349,16 +358,16 @@ private static void showNotification(Context context, Bundle message) {
     // Try to put a notification on top of the notification area. This method was deprecated in API
     // level 26. For API level 26 and above we must use setImportance(int) for each notification
     // channel, not for each notification message.
-    if (Build.VERSION.SDK_INT >= 16 && Build.VERSION.SDK_INT < 26) {
+    if (Build.VERSION.SDK_INT >= 16 && !BuildUtil.isNotificationChannelSupported(context)) {
       //noinspection deprecation
-      builder.setPriority(Notification.PRIORITY_MAX);
+      notificationCompatBuilder.setPriority(Notification.PRIORITY_MAX);
     }
-    builder.setAutoCancel(true);
-    builder.setContentIntent(contentIntent);
+    notificationCompatBuilder.setAutoCancel(true);
+    notificationCompatBuilder.setContentIntent(contentIntent);
 
     if (LeanplumPushService.customizer != null) {
       try {
-        LeanplumPushService.customizer.customize(builder, message);
+        LeanplumPushService.customizer.customize(notificationCompatBuilder, message);
       } catch (Throwable t) {
         Log.e("Unable to customize push notification: ", Log.getStackTraceString(t));
         return;
@@ -385,16 +394,25 @@ private static void showNotification(Context context, Bundle message) {
     try {
       // Check if we have a chained message, and if it exists in var cache.
       if (ActionContext.shouldForceContentUpdateForChainedMessage(
-              JsonConverter.fromJson(message.getString(Keys.PUSH_MESSAGE_ACTION)))) {
+          JsonConverter.fromJson(message.getString(Keys.PUSH_MESSAGE_ACTION)))) {
         final int currentNotificationId = notificationId;
+        final Notification.Builder currentNotificationBuilder = notificationBuilder;
         Leanplum.forceContentUpdate(new VariablesChangedCallback() {
           @Override
           public void variablesChanged() {
-            notificationManager.notify(currentNotificationId, builder.build());
+            if (currentNotificationBuilder != null) {
+              notificationManager.notify(currentNotificationId, currentNotificationBuilder.build());
+            } else {
+              notificationManager.notify(currentNotificationId, notificationCompatBuilder.build());
+            }
           }
         });
       } else {
-        notificationManager.notify(notificationId, builder.build());
+        if (notificationBuilder != null) {
+          notificationManager.notify(notificationId, notificationBuilder.build());
+        } else {
+          notificationManager.notify(notificationId, notificationCompatBuilder.build());
+        }
       }
     } catch (NullPointerException e) {
       Log.e("Unable to show push notification.", e);
