feat(manifest): adding component check when setting up gcm

Author: milos1290

AndroidSDK/src/com/leanplum/LeanplumCloudMessagingProvider.java

@@ -35,24 +35,49 @@
 abstract class LeanplumCloudMessagingProvider {
   private static String registrationId;
 
+  static String getCurrentRegistrationId() {
+    return registrationId;
+  }
+
+  /**
+   * Sends the registration ID to the server over HTTP.
+   */
+  private static void sendRegistrationIdToBackend(String registrationId) {
+    Leanplum.setRegistrationId(registrationId);
+  }
+
   /**
    * Registration app for Cloud Messaging.
    *
    * @return String - registration id for app.
    */
   public abstract String getRegistrationId();
 
+  /**
+   * Whether Messaging Provider is initialized correctly.
+   *
+   * @return True if provider is initialized, false otherwise.
+   */
   public abstract boolean isInitialized();
 
+  /**
+   * Whether app manifest is setup correctly. This will be checked only in DEBUG builds.
+   *
+   * @return True if manifest is setup, false otherwise.
+   */
+  public abstract boolean isManifestSetup();
+
   /**
    * Unregister from cloud messaging.
    */
   public abstract void unregister();
 
-  static String getCurrentRegistrationId() {
-    return registrationId;
-  }
-
+  /**
+   * Callback should be invoked when Registration ID is received from provider.
+   *
+   * @param context The application context.
+   * @param registrationId Registration Id.
+   */
   void onRegistrationIdReceived(Context context, String registrationId) {
     if (registrationId == null) {
       Log.w("Registration ID is undefined.");
@@ -69,17 +94,10 @@ void onRegistrationIdReceived(Context context, String registrationId) {
     }
   }
 
-  /**
-   * Sends the registration ID to the server over HTTP.
-   */
-  private static void sendRegistrationIdToBackend(String registrationId) {
-    Leanplum.setRegistrationId(registrationId);
-  }
-
   /**
    * Stores the registration ID in the application's {@code SharedPreferences}.
    *
-   * @param context application's context.
+   * @param context The application context.
    */
   public void storePreferences(Context context) {
     Log.v("Saving the registration ID in the shared preferences.");

AndroidSDK/src/com/leanplum/LeanplumFcmProvider.java

@@ -39,9 +39,13 @@ public boolean isInitialized() {
     return true;
   }
 
-  /**
-   * Unregister from FCM.
-   */
+  @Override
+  public boolean isManifestSetup() {
+    // Firebase can only be setup through gradle, so we don't have to check manually
+    // whether manifest is properly setup.
+    return true;
+  }
+
   public void unregister() {
     try {
       FirebaseInstanceId.getInstance().deleteInstanceId();

AndroidSDK/src/com/leanplum/LeanplumGcmProvider.java

@@ -111,13 +111,60 @@ public boolean isInitialized() {
     return senderIds != null || getCurrentRegistrationId() != null;
   }
 
-  /**
-   * Unregister from GCM.
-   */
+  @Override
+  public boolean isManifestSetup() {
+    Context context = Leanplum.getContext();
+    if (context == null) {
+      return false;
+    }
+    // We don't want to check if manifest is setup in Release build.
+    if (!BuildConfig.DEBUG) {
+      return true;
+    }
+    try {
+      boolean hasPermissions = LeanplumManifestHelper.checkPermission(LeanplumManifestHelper.RECEIVE_PERMISSION, false, true)
+          && (LeanplumManifestHelper.checkPermission(context.getPackageName() + ".gcm.permission.C2D_MESSAGE", true, false)
+          || LeanplumManifestHelper.checkPermission(context.getPackageName() + ".permission.C2D_MESSAGE", true, true));
+
+      boolean hasGcmReceiver = LeanplumManifestHelper.checkComponent(
+          LeanplumManifestHelper.ApplicationComponent.RECEIVER, LeanplumManifestHelper.GCM_RECEIVER,
+          true, LeanplumManifestHelper.SEND_PERMISSION, Arrays.asList(LeanplumManifestHelper.RECEIVE_ACTION,
+              LeanplumManifestHelper.REGISTRATION_ACTION), context.getPackageName());
+      boolean hasPushReceiver = LeanplumManifestHelper.checkComponent(LeanplumManifestHelper.ApplicationComponent.RECEIVER,
+          LeanplumPushReceiver.class.getName(), false, null,
+          Collections.singletonList(LeanplumManifestHelper.PUSH_LISTENER_SERVICE_FILTER), null);
+
+      boolean hasReceivers = hasGcmReceiver && hasPushReceiver;
+
+      boolean hasPushListenerService = LeanplumManifestHelper.checkComponent(
+          LeanplumManifestHelper.ApplicationComponent.SERVICE,
+          LeanplumPushListenerService.class.getName(), false, null,
+          Collections.singletonList(LeanplumManifestHelper.RECEIVE_ACTION), null);
+      boolean hasInstanceIdService = LeanplumManifestHelper.checkComponent(
+          LeanplumManifestHelper.ApplicationComponent.SERVICE,
+          LeanplumPushInstanceIDService.class.getName(), false, null,
+          Collections.singletonList(LeanplumManifestHelper.INSTANCE_ID_ACTION), null);
+      boolean hasRegistrationService = LeanplumManifestHelper.checkComponent(
+          LeanplumManifestHelper.ApplicationComponent.SERVICE,
+          LeanplumPushRegistrationService.class.getName(), false, null, null, null);
+
+      boolean hasServices = hasPushListenerService && hasInstanceIdService && hasRegistrationService;
+
+      if (hasPermissions && hasReceivers && hasServices) {
+        Log.i("Google Cloud Messaging is setup correctly.");
+        return true;
+      }
+    } catch (Throwable t) {
+      Util.handleException(t);
+    }
+    Log.i("Failed to setup Google Cloud Messaging, check your manifest configuration.");
+    return false;
+  }
+
   public void unregister() {
     try {
       InstanceID.getInstance(Leanplum.getContext()).deleteInstanceID();
-      Log.i("Application was unregistred from GCM.");
+      Log.i("Application was unregistered from GCM.");
     } catch (Exception e) {
       Log.e("Failed to unregister from GCM.");
     }

AndroidSDK/src/com/leanplum/LeanplumManualProvider.java

@@ -41,7 +41,11 @@ public boolean isInitialized() {
     return true;
   }
 
-  public void unregister() {
+  @Override
+  public boolean isManifestSetup() {
+    return true;
+  }
 
+  public void unregister() {
   }
 }

AndroidSDK/src/com/leanplum/LeanplumPushService.java

@@ -675,7 +675,7 @@ private static void initPushService() {
       }
       provider = new LeanplumGcmProvider();
     }
-    if (!provider.isInitialized()) {
+    if (!provider.isInitialized() || !provider.isManifestSetup()) {
       return;
     }
     if (hasAppIDChanged(Request.appId())) {