Update FCM build to pass FCM message to the push receiver

Author: Jawnnypoo

fcm/README.md

@@ -11,12 +11,54 @@ Add dependency to the application level `build.gradle` file.
 dependencies {
     implementation 'com.parse:parse-android:latest.version.here'
     implementation 'com.parse:parse-android-fcm:latest.version.here'
+
+    implementation 'com.google.firebase:firebase-messaging:12.0.1'
 }
 ```
-Then, follow Google's docs for [setting up an FCM app](https://firebase.google.com/docs/cloud-messaging/android/client).
+Then, follow Google's docs for [setting up an Firebase app](https://firebase.google.com/docs/cloud-messaging/android/client). Although the steps are different for setting up FCM with Parse, it is also a good idea to read over the [Firebase FCM Setup](https://firebase.google.com/docs/cloud-messaging/android/client).
+
+You will then need to register some things in your manifest, specifically:
+```xml
+<service
+    android:name="com.parse.fcm.ParseFirebaseInstanceIdService"
+    android:exported="true">
+    <intent-filter>
+        <action android:name="com.google.firebase.INSTANCE_ID_EVENT" />
+    </intent-filter>
+</service>
+```
+where `MyFirebaseInstanceIdService` is your own custom class which extends `ParseFirebaseInstanceIdService`.
+
+Additional, you will register:
+
+```xml
+<service
+    android:name=".MyFirebaseMessagingService">
+    <intent-filter>
+        <action android:name="com.google.firebase.MESSAGING_EVENT"/>
+    </intent-filter>
+</service>
+```
+where `MyFirebaseMessagingService` extends `ParseFirebaseMessagingService`
+
+After these services are registered in the Manifest, you then need to register your push broadcast receiver:
+```xml
+<receiver
+    android:name="com.parse.ParsePushBroadcastReceiver"
+    android:exported="false">
+    <intent-filter>
+        <action android:name="com.parse.push.intent.RECEIVE" />
+        <action android:name="com.parse.push.intent.DELETE" />
+        <action android:name="com.parse.push.intent.OPEN" />
+    </intent-filter>
+</receiver>
+```
+
+## Custom Notifications
+If you need to customize the notification that is sent out from a push, you can do so easily by extending `ParsePushBroadcastReceiver` with your own class and registering it instead in the Manifest.
 
-## Note
-If you need access to the FCM token, instead of creating a service that extends `FirebaseInstanceIdService`, extend `ParseFirebaseInstanceIDService` to assure the token still gets saved properly within Parse.
+## Instance ID Service
+If you need to store the FCM token elsewhere outside of Parse, you can create your own implementation of the `FirebaseInstanceIdService`, just make sure you are either extending `ParseFirebaseInstanceIdService` or are calling `ParseFCM.scheduleTokenUpload(getApplicationContext());` in the `onTokenRefresh` method.
 
 ## License
     Copyright (c) 2015-present, Parse, LLC.

fcm/build.gradle

@@ -23,7 +23,8 @@ android {
 }
 
 dependencies {
-    compileOnly project(':Parse')
+    //TODO figure out how to make this local
+    api 'com.parse:parse-android:1.16.7'
     api 'com.google.firebase:firebase-messaging:12.0.1'
     api 'com.firebase:firebase-jobdispatcher:0.8.5'
 }

…/java/com/parse/ParseFCMParseAccess.java …m/parse/InternalParseFCMParseAccess.javafcm/src/main/java/com/parse/ParseFCMParseAccess.java renamed to fcm/src/main/java/com/parse/InternalParseFCMParseAccess.java fcm/src/main/java/com/parse/ParseFCMParseAccess.java renamed to fcm/src/main/java/com/parse/InternalParseFCMParseAccess.java

@@ -11,7 +11,7 @@
 /**
  * shhh don't talk about this
  */
-public class ParseFCMParseAccess {
+public class InternalParseFCMParseAccess {
 
     private static final String TAG = "ParseFCM";
 

…/fcm/ParseFirebaseInstanceIDService.java …rc/main/java/com/parse/fcm/ParseFCM.javafcm/src/main/java/com/parse/fcm/ParseFirebaseInstanceIDService.java renamed to fcm/src/main/java/com/parse/fcm/ParseFCM.java fcm/src/main/java/com/parse/fcm/ParseFirebaseInstanceIDService.java renamed to fcm/src/main/java/com/parse/fcm/ParseFCM.java

@@ -8,27 +8,18 @@
  */
 package com.parse.fcm;
 
-import android.support.annotation.CallSuper;
+import android.content.Context;
 
 import com.firebase.jobdispatcher.Constraint;
 import com.firebase.jobdispatcher.FirebaseJobDispatcher;
 import com.firebase.jobdispatcher.GooglePlayDriver;
 import com.firebase.jobdispatcher.Job;
 import com.firebase.jobdispatcher.RetryStrategy;
-import com.google.firebase.iid.FirebaseInstanceIdService;
-import com.parse.ParseInstallation;
 
-/**
- * Assures the {@link ParseInstallation#getDeviceToken()} stays up to date. If you need to do custom things with the token, make sure you extend this
- * class and call super.
- */
-public class ParseFirebaseInstanceIDService extends FirebaseInstanceIdService {
+public class ParseFCM {
 
-    @CallSuper
-    @Override
-    public void onTokenRefresh() {
-        super.onTokenRefresh();
-        FirebaseJobDispatcher dispatcher = new FirebaseJobDispatcher(new GooglePlayDriver(getApplicationContext()));
+    public static void scheduleTokenUpload(Context context) {
+        FirebaseJobDispatcher dispatcher = new FirebaseJobDispatcher(new GooglePlayDriver(context.getApplicationContext()));
         Job job = dispatcher.newJobBuilder()
                 .setRecurring(false)
                 .setReplaceCurrent(true)

fcm/src/main/java/com/parse/fcm/ParseFirebaseInstanceIdService.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+package com.parse.fcm;
+
+import android.support.annotation.CallSuper;
+
+import com.google.firebase.iid.FirebaseInstanceIdService;
+import com.parse.ParseInstallation;
+
+/**
+ * Assures the {@link ParseInstallation#getDeviceToken()} stays up to date. If you need to do custom things with the token, make sure you extend this
+ * class and call super.
+ */
+public class ParseFirebaseInstanceIdService extends FirebaseInstanceIdService {
+
+    @CallSuper
+    @Override
+    public void onTokenRefresh() {
+        super.onTokenRefresh();
+        ParseFCM.scheduleTokenUpload(getApplicationContext());
+    }
+}

fcm/src/main/java/com/parse/fcm/ParseFirebaseJobService.java

@@ -11,31 +11,31 @@
 import com.firebase.jobdispatcher.JobParameters;
 import com.firebase.jobdispatcher.JobService;
 import com.google.firebase.iid.FirebaseInstanceId;
+import com.parse.InternalParseFCMParseAccess;
 import com.parse.ParseException;
 import com.parse.ParseInstallation;
 import com.parse.SaveCallback;
-import com.parse.ParseFCMParseAccess;
 
 /**
- * Handles saving the FCM token to the {@link ParseInstallation}
+ * Handles saving the FCM token to the {@link ParseInstallation} in the background
  */
 public class ParseFirebaseJobService extends JobService {
 
     @Override
     public boolean onStartJob(final JobParameters job) {
-        ParseFCMParseAccess.logVerbose("Updating FCM token");
+        InternalParseFCMParseAccess.logVerbose("Updating FCM token");
         ParseInstallation installation = ParseInstallation.getCurrentInstallation();
         String token = FirebaseInstanceId.getInstance().getToken();
         if (installation != null && token != null) {
-            ParseFCMParseAccess.setToken(installation, token);
+            InternalParseFCMParseAccess.setToken(installation, token);
             installation.saveInBackground(new SaveCallback() {
                 @Override
                 public void done(ParseException e) {
                     if (e == null) {
-                        ParseFCMParseAccess.logVerbose("FCM token saved to installation");
+                        InternalParseFCMParseAccess.logVerbose("FCM token saved to installation");
                         jobFinished(job, false);
                     } else {
-                        ParseFCMParseAccess.logError("FCM token upload failed", e);
+                        InternalParseFCMParseAccess.logError("FCM token upload failed", e);
                         jobFinished(job, true);
                     }
                 }

fcm/src/main/java/com/parse/fcm/ParseFirebaseMessagingService.java

@@ -0,0 +1,37 @@
+package com.parse.fcm;
+
+import android.content.Intent;
+import android.os.Bundle;
+
+import com.google.firebase.messaging.FirebaseMessagingService;
+import com.google.firebase.messaging.RemoteMessage;
+import com.parse.InternalParseFCMParseAccess;
+import com.parse.ParsePushBroadcastReceiver;
+
+public class ParseFirebaseMessagingService extends FirebaseMessagingService {
+
+    @Override
+    public void onMessageReceived(RemoteMessage remoteMessage) {
+        super.onMessageReceived(remoteMessage);
+        InternalParseFCMParseAccess.logVerbose("onMessageReceived");
+        //example of json data:
+        //{"alert":"this is to everyone","sound":"default","title":"Everyone","content-available":1}
+        String channel = remoteMessage.getData().get("channel");
+        String data = remoteMessage.getData().get("data");
+        Bundle extras = new Bundle();
+        extras.putString(ParsePushBroadcastReceiver.KEY_PUSH_CHANNEL, channel);
+        if (data == null) {
+            extras.putString(ParsePushBroadcastReceiver.KEY_PUSH_DATA, "{}");
+        } else {
+            extras.putString(ParsePushBroadcastReceiver.KEY_PUSH_DATA, data);
+        }
+
+        Intent intent = new Intent(ParsePushBroadcastReceiver.ACTION_PUSH_RECEIVE);
+        intent.putExtras(extras);
+
+        // Set the package name to keep this intent within the given package.
+        intent.setPackage(getApplicationContext().getPackageName());
+        getApplicationContext().sendBroadcast(intent);
+
+    }
+}