Changed channel payload format for backwards compatibility

* Change channel payload to use existing fields for better backwards compatibility.
* Added init check to required Android Support compat revision 26.0.0 if running on and targeting O.

Author: jkasten2

OneSignalSDK/onesignal/src/main/java/com/onesignal/GenerateNotification.java

@@ -45,7 +45,6 @@
 import android.app.AlertDialog;
 import android.app.Notification;
 import android.app.PendingIntent;
-import android.content.ContentResolver;
 import android.content.ContentValues;
 import android.content.Context;
 import android.content.DialogInterface;
@@ -212,7 +211,7 @@ private static OneSignalNotificationBuilder getBaseOneSignalNotificationBuilder(
 
       NotificationCompat.Builder notifBuilder;
       try {
-         String channelId = NotificationChannelManager.createNotificationChannel(currentContext, notifJob.jsonPayload);
+         String channelId = NotificationChannelManager.createNotificationChannel(currentContext, gcmBundle);
          // Will throw if app is using 26.0.0-beta1 or older of the support library.
          notifBuilder = new NotificationCompat.Builder(currentContext, channelId);
       } catch(Throwable t) {
@@ -242,8 +241,20 @@ private static OneSignalNotificationBuilder getBaseOneSignalNotificationBuilder(
       } catch (Throwable t) {} // Can throw if an old android support lib is used.
 
       int notificationDefaults = 0;
-      if (OneSignal.getVibrate(currentContext))
-         notificationDefaults = Notification.DEFAULT_VIBRATE;
+      
+      if (OneSignal.getVibrate(currentContext)) {
+         if (gcmBundle.optBoolean("vib", true))
+            notificationDefaults = Notification.DEFAULT_VIBRATE;
+         if (gcmBundle.has("vib_pt")) {
+            JSONArray json_vib_array = gcmBundle.optJSONArray("vib_pt");
+            long[] long_array = new long[json_vib_array.length()];
+            for (int i = 0; i < json_vib_array.length(); i++)
+               long_array[i] = json_vib_array.optLong(i);
+   
+            notificationDefaults = Notification.DEFAULT_VIBRATE;
+            notifBuilder.setVibrate(long_array);
+         }
+      }
 
       if (gcmBundle.has("ledc")) {
          try {
@@ -252,11 +263,12 @@ private static OneSignalNotificationBuilder getBaseOneSignalNotificationBuilder(
          } catch (Throwable t) {
             notificationDefaults |= Notification.DEFAULT_LIGHTS;
          } // Can throw if an old android support lib is used or parse error.
-      } else
+      }
+      else
          notificationDefaults |= Notification.DEFAULT_LIGHTS;
 
       try {
-         int visibility = Notification.VISIBILITY_PUBLIC;
+         int visibility = NotificationCompat.VISIBILITY_PUBLIC;
          if (gcmBundle.has("vis"))
             visibility = Integer.parseInt(gcmBundle.optString("vis"));
          notifBuilder.setVisibility(visibility);
@@ -281,9 +293,9 @@ private static OneSignalNotificationBuilder getBaseOneSignalNotificationBuilder(
       }
 
       notifBuilder.setDefaults(notificationDefaults);
-
-      if (gcmBundle.optInt("pri", 0) > 9)
-         notifBuilder.setPriority(NotificationCompat.PRIORITY_MAX);
+   
+      int payload_priority = gcmBundle.optInt("pri", 6);
+      notifBuilder.setPriority(osPriorityToAndroidPriority(payload_priority));
 
       oneSignalNotificationBuilder.compatBuilder = notifBuilder;
       return oneSignalNotificationBuilder;
@@ -939,4 +951,17 @@ private static void addAlertButtons(Context context, JSONObject gcmBundle, List<
          OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Failed to parse buttons for alert dialog.", t);
       }
    }
+   
+   private static int osPriorityToAndroidPriority(int priority) {
+      if (priority > 9)
+         return NotificationCompat.PRIORITY_MAX;
+      if (priority > 7)
+         return NotificationCompat.PRIORITY_HIGH;
+      if (priority > 5)
+         return NotificationCompat.PRIORITY_DEFAULT;
+      if (priority > 3)
+         return NotificationCompat.PRIORITY_LOW;
+      
+      return NotificationCompat.PRIORITY_MIN;
+   }
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/NotificationChannelManager.java

@@ -35,6 +35,7 @@
 import android.net.Uri;
 import android.os.Build;
 import android.support.annotation.RequiresApi;
+import android.support.v4.app.NotificationManagerCompat;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -80,62 +81,67 @@ static String createNotificationChannel(Context context, JSONObject jsonPayload)
          return createDefaultChannel(notificationManager);
 
       try {
-         return createChannel(context, notificationManager, jsonPayload.optJSONObject("chnl"));
+         return createChannel(context, notificationManager, jsonPayload);
       } catch (JSONException e) {
          OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Could not create notification channel due to JSON payload error!", e);
       }
 
       return DEFAULT_CHANNEL_ID;
    }
 
+   // Language dependent fields will be passed localized
    @RequiresApi(api = Build.VERSION_CODES.O)
-   private static String createChannel(Context context, NotificationManager notificationManager, JSONObject channelPayload) throws JSONException {
+   private static String createChannel(Context context, NotificationManager notificationManager, JSONObject payload) throws JSONException {
+      JSONObject channelPayload = payload.optJSONObject("chnl");
+      
       String channel_id = channelPayload.optString("id", DEFAULT_CHANNEL_ID);
       // Ensure we don't try to use the system reserved id
       if (channel_id.equals(NotificationChannel.DEFAULT_CHANNEL_ID))
          channel_id = DEFAULT_CHANNEL_ID;
-
-      int importance = channelPayload.optInt("imp", NotificationManager.IMPORTANCE_DEFAULT);
+      
       String channel_name = channelPayload.optString("nm", "Miscellaneous");
-
+   
+      int importance = priorityToImportance(payload.optInt("pri", 6));
       NotificationChannel channel = new NotificationChannel(channel_id, channel_name, importance);
 
-      if (channelPayload.has("grp")) {
-         String group_id = channelPayload.optString("grp");
+      if (channelPayload.has("grp_id")) {
+         String group_id = channelPayload.optString("grp_id");
          CharSequence group_name = channelPayload.optString("grp_nm");
          notificationManager.createNotificationChannelGroup(new NotificationChannelGroup(group_id, group_name));
          channel.setGroup(group_id);
       }
 
-      channel.enableLights(channelPayload.optBoolean("lght", true));
-      if (channelPayload.has("ledc")) {
-         BigInteger ledColor = new BigInteger(channelPayload.optString("ledc"), 16);
+      channel.enableLights(payload.optBoolean("led", true));
+      if (payload.has("ledc")) {
+         BigInteger ledColor = new BigInteger(payload.optString("ledc"), 16);
          channel.setLightColor(ledColor.intValue());
       }
 
-      channel.enableVibration(channelPayload.optBoolean("vib", true));
-      if (channelPayload.has("vib_pt")) {
-         JSONArray json_vib_array = channelPayload.optJSONArray("vib_pt");
+      channel.enableVibration(payload.optBoolean("vib", true));
+      if (payload.has("vib_pt")) {
+         JSONArray json_vib_array = payload.optJSONArray("vib_pt");
          long[] long_array = new long[json_vib_array.length()];
          for (int i = 0; i < json_vib_array.length(); i++)
             long_array[i] = json_vib_array.optLong(i);
          channel.setVibrationPattern(long_array);
       }
 
-      if (channelPayload.has("snd_nm")) {
+      if (payload.has("sound")) {
          // Sound will only play if Importance is set to High or Urgent
-         Uri uri = OSUtils.getSoundUri(context, channelPayload.optString("snd_nm", null));
-         if (uri!= null)
+         String sound = payload.optString("sound", null);
+         Uri uri = OSUtils.getSoundUri(context, sound);
+         if (uri != null)
             channel.setSound(uri, null);
+         else if ("null".equals(sound) || "nil".equals(sound))
+            channel.setSound(null, null);
+         // null = None for a sound.
       }
-      else if (!channelPayload.optBoolean("snd", true))
-         channel.setSound(null, null);
       // Setting sound to null makes it 'None' in the Settings.
       // Otherwise not calling setSound makes it the default notification sound.
 
-      channel.setLockscreenVisibility(channelPayload.optInt("lck", Notification.VISIBILITY_PUBLIC));
-      channel.setShowBadge(channelPayload.optBoolean("bdg", true));
-      channel.setBypassDnd(channelPayload.optBoolean("bdnd", false));
+      channel.setLockscreenVisibility(payload.optInt("vis", Notification.VISIBILITY_PUBLIC));
+      channel.setShowBadge(payload.optBoolean("bdg", true));
+      channel.setBypassDnd(payload.optBoolean("bdnd", false));
 
       notificationManager.createNotificationChannel(channel);
       return channel_id;
@@ -184,4 +190,19 @@ static void processChannelList(Context context, JSONObject payload) {
             notificationManager.deleteNotificationChannel(id);
       }
    }
+   
+   private static int priorityToImportance(int priority) {
+      if (priority > 9)
+         return NotificationManagerCompat.IMPORTANCE_MAX;
+      if (priority > 7)
+         return NotificationManagerCompat.IMPORTANCE_HIGH;
+      if (priority > 5)
+         return NotificationManagerCompat.IMPORTANCE_DEFAULT;
+      if (priority > 3)
+         return NotificationManagerCompat.IMPORTANCE_LOW;
+      if (priority > 1)
+         return NotificationManagerCompat.IMPORTANCE_MIN;
+      
+      return NotificationManagerCompat.IMPORTANCE_NONE;
+   }
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSUtils.java

@@ -1,7 +1,7 @@
 /**
  * Modified MIT License
  *
- * Copyright 2016 OneSignal
+ * Copyright 2017 OneSignal
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -35,6 +35,7 @@
 import android.net.ConnectivityManager;
 import android.net.NetworkInfo;
 import android.net.Uri;
+import android.os.Build;
 import android.os.Bundle;
 import android.os.Handler;
 import android.os.Looper;
@@ -49,7 +50,7 @@ class OSUtils {
 
    static final int UNINITIALIZABLE_STATUS = -999;
 
-   int initializationChecker(int deviceType, String oneSignalAppId) {
+   int initializationChecker(Context context, int deviceType, String oneSignalAppId) {
       int subscribableStatus = 1;
 
       try {
@@ -85,12 +86,20 @@ int initializationChecker(int deviceType, String oneSignalAppId) {
          try {
             Class.forName("android.support.v4.content.WakefulBroadcastReceiver");
             Class.forName("android.support.v4.app.NotificationManagerCompat");
+            
+            // If running on Android O and targeting O we need version 26.0.0 for
+            //   the new compat NotificationCompat.Builder constructor.
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O
+                && getTargetSdkVersion(context) >= Build.VERSION_CODES.O) {
+               // Class was added in 26.0.0-beta2
+               Class.forName("android.support.v4.app.JobIntentService");
+            }
          } catch (ClassNotFoundException e) {
-            OneSignal.Log(OneSignal.LOG_LEVEL.FATAL, "The included Android Support Library v4 is to old or incomplete. Please update your project's android-support-v4.jar to the latest revision.", e);
+            OneSignal.Log(OneSignal.LOG_LEVEL.FATAL, "The included Android Support Library is to old or incomplete. Please update to the 26.0.0 revision or newer.", e);
             subscribableStatus = -5;
          }
       } catch (ClassNotFoundException e) {
-         OneSignal.Log(OneSignal.LOG_LEVEL.FATAL, "Could not find the Android Support Library v4. Please make sure android-support-v4.jar has been correctly added to your project.", e);
+         OneSignal.Log(OneSignal.LOG_LEVEL.FATAL, "Could not find the Android Support Library. Please make sure it has been correctly added to your project.", e);
          subscribableStatus = -3;
       }
 
@@ -195,6 +204,18 @@ static void runOnMainUIThread(Runnable runnable) {
       }
    }
 
+   static int getTargetSdkVersion(Context context) {
+      String packageName = context.getPackageName();
+      PackageManager packageManager = context.getPackageManager();
+      try {
+         ApplicationInfo applicationInfo = packageManager.getApplicationInfo(packageName, 0);
+         return applicationInfo.targetSdkVersion;
+      } catch (PackageManager.NameNotFoundException e) {
+         e.printStackTrace();
+      }
+      
+      return Build.VERSION_CODES.ICE_CREAM_SANDWICH_MR1;
+   }
 
    static boolean isValidResourceName(String name) {
       return (name != null && !name.matches("^[0-9]"));

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java

@@ -25,22 +25,6 @@
  * THE SOFTWARE.
  */
 
-
-
-// TODO: Android O branch todo
-// 1. Add Android O channel methods
-//   a. Set default channel id.
-//   b. Set all available options with a single object.
-//      - Create in a generic way that can be used by wrapper SDK such as Unity
-//  2. GCM broadcast receiver can no longer start the GcmIntentService when app is swiped away.
-//    - Service may need to be started differently or all work must be done from the receiver directly then.
-//  3. filterOtherGCMReceivers no long works.
-//   - Google Play services is no longer starting the broadcast receiver as an order broadcast
-//  4. Fix bug where restored notifications are vibrating and playing the sound again.
-//   - This is due to the channel now being in control of these settings.
-//   - Fixed cold restarts of the app. App updates and reboots still notify again.
-
-
 package com.onesignal;
 
 import java.io.PrintWriter;
@@ -363,7 +347,7 @@ public static void init(Context context, String googleProjectNumber, String oneS
 
       osUtils = new OSUtils();
       deviceType = osUtils.getDeviceType();
-      subscribableStatus = osUtils.initializationChecker(deviceType, oneSignalAppId);
+      subscribableStatus = osUtils.initializationChecker(context, deviceType, oneSignalAppId);
       if (subscribableStatus == OSUtils.UNINITIALIZABLE_STATUS)
          return;
 

OneSignalSDK/unittest/src/test/java/com/test/onesignal/GenerateNotificationRunner.java

@@ -902,7 +902,6 @@ private static Bundle getBundleWithAllOptionsSet() {
 
       bundle.putString("title", "Test H");
       bundle.putString("alert", "Test B");
-      bundle.putString("bgn", "1");
       bundle.putString("vis", "0");
       bundle.putString("bgac", "FF0000FF");
       bundle.putString("from", "703322744261");

OneSignalSDK/unittest/src/test/java/com/test/onesignal/NotificationChannelManagerRunner.java

@@ -99,17 +99,18 @@ public void createNotificationChannelWithALlOptionsl() throws Exception {
 
       chnl.put("id", "test_id");
       chnl.put("nm", "Test Name");
-      chnl.put("grp", "grp_id");
+      chnl.put("grp_id", "grp_id");
       chnl.put("grp_nm", "Group Name");
-      chnl.put("imp", NotificationManager.IMPORTANCE_MAX);
-      chnl.put("lght", false);
-      chnl.put("ledc", "FFFF0000");
-      chnl.put("vib", false);
-      chnl.put("vib_pt", new JSONArray("[1,2,3,4]"));
-      chnl.put("snd_nm", "notification");
-      chnl.put("lck", Notification.VISIBILITY_SECRET);
-      chnl.put("bdg", true);
-      chnl.put("bdnd", true);
+   
+      payload.put("pri", 10);
+      payload.put("led", false);
+      payload.put("ledc", "FFFF0000");
+      payload.put("vib", false);
+      payload.put("vib_pt", new JSONArray("[1,2,3,4]"));
+      payload.put("sound", "notification");
+      payload.put("vis", Notification.VISIBILITY_SECRET);
+      payload.put("bdg", true);
+      payload.put("bdnd", true);
 
       payload.put("chnl", chnl);
 
@@ -172,8 +173,10 @@ public void processPayloadCreatingNewChannel() throws Exception {
 
       JSONArray channelList = new JSONArray();
       JSONObject channelItem = new JSONObject();
-      
-      channelItem.put("id", "OS_id1");
+      JSONObject channelItemChnl = new JSONObject();
+   
+      channelItemChnl.put("id", "OS_id1");
+      channelItem.put("chnl", channelItemChnl);
 
       channelList.put(channelItem);
       JSONObject payload = new JSONObject();
@@ -197,8 +200,10 @@ JSONObject createBasicChannelListPayload() throws JSONException {
 
       JSONArray channelList = new JSONArray();
       JSONObject channelItem = new JSONObject();
+      JSONObject channelItemChnl = new JSONObject();
 
-      channelItem.put("id", "OS_id1");
+      channelItemChnl.put("id", "OS_id1");
+      channelItem.put("chnl", channelItemChnl);
 
       channelList.put(channelItem);
       JSONObject payload = new JSONObject();