Merge pull request #221 from OneSignal/filtering_other_gcm_receivers

Added filterOtherGCMReceivers method

Author: jkasten2

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

@@ -48,8 +48,10 @@ public ADMMessageHandler() {
    @Override
    protected void onMessage(Intent intent) {
       Bundle bundle = intent.getExtras();
-
-      if (NotificationBundleProcessor.processBundle(this, bundle))
+   
+      NotificationBundleProcessor.ProcessedBundleResult processedResult = NotificationBundleProcessor.processBundle(this, bundle);
+   
+      if (processedResult.processed())
          return;
 
       NotificationGenerationJob notifJob = new NotificationGenerationJob(this);

OneSignalSDK/onesignal/src/main/java/com/onesignal/GcmBroadcastReceiver.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
@@ -33,15 +33,17 @@
 import android.content.Intent;
 import android.os.Bundle;
 import android.support.v4.content.WakefulBroadcastReceiver;
+import com.onesignal.NotificationBundleProcessor.ProcessedBundleResult;
 
 public class GcmBroadcastReceiver extends WakefulBroadcastReceiver {
 
-   private static final String GCM_RECEIVE = "com.google.android.c2dm.intent.RECEIVE";
+   private static final String GCM_RECEIVE_ACTION = "com.google.android.c2dm.intent.RECEIVE";
    private static final String GCM_TYPE = "gcm";
+   private static final String MESSAGE_TYPE_EXTRA_KEY = "message_type";
 
    private static boolean isGcmMessage(Intent intent) {
-      if (GCM_RECEIVE.equals(intent.getAction())) {
-         String messageType = intent.getStringExtra("message_type");
+      if (GCM_RECEIVE_ACTION.equals(intent.getAction())) {
+         String messageType = intent.getStringExtra(MESSAGE_TYPE_EXTRA_KEY);
          return (messageType == null || GCM_TYPE.equals(messageType));
       }
       return false;
@@ -55,25 +57,53 @@ public void onReceive(Context context, Intent intent) {
       Bundle bundle = intent.getExtras();
       if (bundle == null || "google.com/iid".equals(bundle.getString("from")))
          return;
-
-      processOrderBroadcast(context, intent, bundle);
+   
+      ProcessedBundleResult processedResult = processOrderBroadcast(context, intent, bundle);
+      
+      // Null means this isn't a GCM / FCM message.
+      if (processedResult == null) {
+         setResultCode(Activity.RESULT_OK);
+         return;
+      }
+      
+      // Prevent other GCM receivers from firing if;
+      //   This is a duplicated GCM message
+      //   OR app developer setup a extender service to handle the notification.
+      if (processedResult.isDup || processedResult.hasExtenderService) {
+         // Abort to prevent other GCM receivers from process this Intent.
+         abortBroadcast();
+         return;
+      }
+   
+      // Prevent other GCM receivers from firing if;
+      //   This is a OneSignal payload
+      //   AND the setting is enabled to allow filtering in this case.
+      if (processedResult.isOneSignalPayload &&
+          OneSignal.getFilterOtherGCMReceivers(context)) {
+         
+         abortBroadcast();
+         return;
+      }
 
       setResultCode(Activity.RESULT_OK);
    }
-
-   private static void processOrderBroadcast(Context context, Intent intent, Bundle bundle) {
+   
+   private static ProcessedBundleResult processOrderBroadcast(Context context, Intent intent, Bundle bundle) {
       if (!isGcmMessage(intent))
-         return;
-
+         return null;
+      
+      ProcessedBundleResult processedResult = NotificationBundleProcessor.processBundle(context, bundle);
+   
       // Return if the notification will NOT be handled by normal GcmIntentService display flow.
-      if (NotificationBundleProcessor.processBundle(context, bundle))
-         return;
+      if (processedResult.processed())
+         return processedResult;
 
       Intent intentForService = new Intent();
       intentForService.putExtra("json_payload", NotificationBundleProcessor.bundleAsJSONObject(bundle).toString());
       intentForService.setComponent(new ComponentName(context.getPackageName(),
-                                    GcmIntentService.class.getName()));
+                                                      GcmIntentService.class.getName()));
       startWakefulService(context, intentForService);
+      
+      return processedResult;
    }
-
 }

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

@@ -354,27 +354,35 @@ private static void processCollapseKey(NotificationGenerationJob notifJob) {
    }
 
    // Return true to count the payload as processed.
-   static boolean processBundle(Context context, final Bundle bundle) {
+   static ProcessedBundleResult processBundle(Context context, final Bundle bundle) {
+      ProcessedBundleResult result = new ProcessedBundleResult();
+      
       // Not a OneSignal GCM message
       if (OneSignal.getNotificationIdFromGCMBundle(bundle) == null)
-         return true;
+         return result;
+      result.isOneSignalPayload = true;
 
       prepareBundle(bundle);
-
+      
+      // NotificationExtenderService still makes additional checks such as notValidOrDuplicated
       Intent overrideIntent = NotificationExtenderService.getIntent(context);
       if (overrideIntent != null) {
          overrideIntent.putExtra("json_payload", bundleAsJSONObject(bundle).toString());
          WakefulBroadcastReceiver.startWakefulService(context, overrideIntent);
-         return true;
+         result.hasExtenderService = true;
+         return result;
       }
+   
+      // We already ran a getNotificationIdFromGCMBundle == null check above so this will only be true for dups
+      result.isDup = OneSignal.notValidOrDuplicated(context, bundleAsJSONObject(bundle));
+      if (result.isDup)
+         return result;
 
-      boolean display = shouldDisplay(bundle.getString("alert") != null
-                                   && !"".equals(bundle.getString("alert")));
+      String alert = bundle.getString("alert");
+      boolean display = shouldDisplay(alert != null && !"".equals(alert));
 
       // Save as a opened notification to prevent duplicates.
       if (!display) {
-         if (OneSignal.notValidOrDuplicated(context, bundleAsJSONObject(bundle)))
-            return true;
          saveNotification(context, bundle, true, -1);
          // Current thread is meant to be short lived.
          //    Make a new thread to do our OneSignal work on.
@@ -384,8 +392,8 @@ public void run() {
             }
          }, "OS_PROC_BUNDLE").start();
       }
-
-      return !display;
+      
+      return result;
    }
 
    static boolean shouldDisplay(boolean hasBody) {
@@ -402,4 +410,15 @@ static JSONArray newJsonArray(JSONObject jsonObject) {
       jsonArray.put(jsonObject);
       return jsonArray;
    }
+   
+   
+   static class ProcessedBundleResult {
+      boolean isOneSignalPayload;
+      boolean hasExtenderService;
+      boolean isDup;
+      
+      boolean processed() {
+         return !isOneSignalPayload || hasExtenderService || isDup;
+      }
+   }
 }

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

@@ -106,6 +106,7 @@ public static class Builder {
       boolean mDisableGmsMissingPrompt;
       // Default true in 4.0.0 release.
       boolean mUnsubscribeWhenNotificationsAreDisabled;
+      boolean mFilterOtherGCMReceivers;
 
       // Exists to make wrapper SDKs simpler so they don't need to store their own variable before
       //  calling startInit().init()
@@ -154,6 +155,11 @@ public Builder unsubscribeWhenNotificationsAreDisabled(boolean set) {
          mUnsubscribeWhenNotificationsAreDisabled = set;
          return this;
       }
+      
+      public Builder filterOtherGCMReceivers(boolean set) {
+         mFilterOtherGCMReceivers = set;
+         return this;
+      }
 
       public void init() {
          OneSignal.init(this);
@@ -359,6 +365,8 @@ public static void init(Context context, String googleProjectNumber, String oneS
       foreground = contextIsActivity;
       appId = oneSignalAppId;
       appContext = context.getApplicationContext();
+   
+      saveFilterOtherGCMReceivers(mInitBuilder.mFilterOtherGCMReceivers);
 
       if (contextIsActivity) {
          ActivityLifecycleHandler.curActivity = (Activity) context;
@@ -372,7 +380,7 @@ public static void init(Context context, String googleProjectNumber, String oneS
 
       OneSignalStateSynchronizer.initUserState(appContext);
 
-      if (android.os.Build.VERSION.SDK_INT > Build.VERSION_CODES.HONEYCOMB_MR2)
+      if (Build.VERSION.SDK_INT > Build.VERSION_CODES.HONEYCOMB_MR2)
          ((Application)appContext).registerActivityLifecycleCallbacks(new ActivityLifecycleListener());
       else
          ActivityLifecycleListenerCompat.startListener();
@@ -1250,7 +1258,21 @@ static void saveUserId(String inUserId) {
       editor.putString("GT_PLAYER_ID", userId);
       editor.commit();
    }
-
+   
+   static boolean getFilterOtherGCMReceivers(Context context) {
+      SharedPreferences prefs = getGcmPreferences(context);
+      return prefs.getBoolean("OS_FILTER_OTHER_GCM_RECEIVERS", false);
+   }
+   
+   static void saveFilterOtherGCMReceivers(boolean set) {
+      if (appContext == null)
+         return;
+      final SharedPreferences prefs = getGcmPreferences(appContext);
+      SharedPreferences.Editor editor = prefs.edit();
+      editor.putBoolean("OS_FILTER_OTHER_GCM_RECEIVERS", set);
+      editor.commit();
+   }
+   
    static void updateUserIdDependents(String userId) {
       saveUserId(userId);
       fireIdsAvailableCallback();

OneSignalSDK/onesignal/src/release/AndroidManifest.xml

@@ -6,12 +6,14 @@
 
     <application>
         <meta-data android:name="onesignal_app_id" android:value="${onesignal_app_id}" />
+        <!-- Deprecated - Pulled from OneSignal dashboard. -->
         <meta-data android:name="onesignal_google_project_number" android:value="str:${onesignal_google_project_number}" />
 
         <receiver
             android:name="com.onesignal.GcmBroadcastReceiver"
             android:permission="com.google.android.c2dm.permission.SEND" >
-            <intent-filter>
+            <!-- High priority so OneSignal payloads can be filtered from other GCM receivers if filterOtherGCMReceivers is enabled. -->
+            <intent-filter android:priority="999" >
                 <action android:name="com.google.android.c2dm.intent.RECEIVE" />
                 <category android:name="${applicationId}" />
             </intent-filter>

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

@@ -70,7 +70,8 @@ public static void NotificationBundleProcessor_ProcessFromGCMIntentService_NoWra
    }
 
    public static boolean GcmBroadcastReceiver_processBundle(Context context, Bundle bundle) {
-      return NotificationBundleProcessor.processBundle(context, bundle);
+      NotificationBundleProcessor.ProcessedBundleResult processedResult = NotificationBundleProcessor.processBundle(context, bundle);
+      return processedResult.processed();
    }
 
    public static int NotificationBundleProcessor_Process(Context context, boolean restoring, JSONObject jsonPayload, NotificationExtenderService.OverrideSettings overrideSettings) {

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

@@ -0,0 +1,52 @@
+/**
+ * Modified MIT License
+ *
+ * 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
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.onesignal;
+
+import android.content.BroadcastReceiver;
+
+import org.robolectric.annotation.Implements;
+
+@Implements(BroadcastReceiver.class)
+public class ShadowGcmBroadcastReceiver {
+   
+   public static boolean calledAbortBroadcast;
+   public static Integer lastResultCode;
+   
+   public static void resetStatics() {
+      calledAbortBroadcast = false;
+      lastResultCode = null;
+   }
+   
+   public void abortBroadcast() {
+      calledAbortBroadcast = true;
+   }
+   
+   public void setResultCode(int code) {
+      lastResultCode = code;
+   }
+}

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

@@ -50,6 +50,7 @@
 import com.onesignal.OneSignalDbHelper;
 import com.onesignal.OneSignalPackagePrivateHelper;
 import com.onesignal.ShadowBadgeCountUpdater;
+import com.onesignal.ShadowGcmBroadcastReceiver;
 import com.onesignal.ShadowNotificationManagerCompat;
 import com.onesignal.ShadowNotificationRestorer;
 import com.onesignal.ShadowOneSignal;
@@ -600,6 +601,7 @@ public void shouldCorrectlyDisplaySummaryWithMixedInAppAlertsAndNotifications()
 
 
    @Test
+   @Config(shadows = {ShadowGcmBroadcastReceiver.class})
    public void shouldSetButtonsCorrectly() throws Exception {
       Intent intentGcm = new Intent();
       intentGcm.setAction("com.google.android.c2dm.intent.RECEIVE");
@@ -609,10 +611,7 @@ public void shouldSetButtonsCorrectly() throws Exception {
       intentGcm.putExtras(bundle);
 
       GcmBroadcastReceiver gcmBroadcastReceiver = new GcmBroadcastReceiver();
-      try {
-         gcmBroadcastReceiver.onReceive(blankActivity, intentGcm);
-      } // setResultCode throws this error due to onReceive not designed to be called manually.
-      catch (java.lang.IllegalStateException e) {}
+      gcmBroadcastReceiver.onReceive(blankActivity, intentGcm);
 
       Intent intent = Shadows.shadowOf(blankActivity).getNextStartedService();
       Assert.assertEquals("com.onesignal.GcmIntentService", intent.getComponent().getClassName());
@@ -624,7 +623,29 @@ public void shouldSetButtonsCorrectly() throws Exception {
       JSONObject additionalData = new JSONObject((customJson.getString("a")));
       Assert.assertEquals("id1", additionalData.getJSONArray("actionButtons").getJSONObject(0).getString("id"));
    }
-
+   
+   @Test
+   @Config(shadows = {ShadowGcmBroadcastReceiver.class})
+   public void shouldPreventOtherGCMReceiversWhenSettingEnabled() throws Exception {
+      OneSignal.setInFocusDisplaying(OneSignal.OSInFocusDisplayOption.InAppAlert);
+      OneSignal.startInit(blankActivity).filterOtherGCMReceivers(true).init();
+      threadAndTaskWait();
+      
+      
+      Intent intentGcm = new Intent();
+      intentGcm.setAction("com.google.android.c2dm.intent.RECEIVE");
+      intentGcm.putExtra("message_type", "gcm");
+      Bundle bundle = getBaseNotifBundle();
+      bundle.putString("o", "[{\"n\": \"text1\", \"i\": \"id1\"}]");
+      intentGcm.putExtras(bundle);
+      
+      GcmBroadcastReceiver gcmBroadcastReceiver = new GcmBroadcastReceiver();
+      gcmBroadcastReceiver.onReceive(blankActivity, intentGcm);
+      
+      Assert.assertNull(ShadowGcmBroadcastReceiver.lastResultCode);
+      Assert.assertTrue(ShadowGcmBroadcastReceiver.calledAbortBroadcast);
+   }
+   
    private OSNotification lastNotificationReceived;
    @Test
    public void shouldStillFireReceivedHandlerWhenNotificationExtenderServiceIsUsed() throws Exception {
@@ -680,7 +701,7 @@ public void shouldFireNotificationExtenderService() throws Exception {
       RuntimeEnvironment.getRobolectricPackageManager().addResolveInfoForIntent(serviceIntent, resolveInfo);
 
       boolean ret = OneSignalPackagePrivateHelper.GcmBroadcastReceiver_processBundle(blankActivity, bundle);
-      Assert.assertEquals(true, ret);
+      Assert.assertTrue(ret);
 
       Intent intent = Shadows.shadowOf(blankActivity).getNextStartedService();
       Assert.assertEquals("com.onesignal.NotificationExtender", intent.getAction());