Referral Notifications - FCM Push Notifications

app/AndroidManifest.xml

@@ -107,6 +107,11 @@
         android:usesCleartextTraffic="true"
         android:theme="@style/AppBaseTheme">
 
+        <!--TODO: We might want to find a better option to reference the notification channel Id-->
+        <meta-data
+            android:name="com.google.firebase.messaging.default_notification_channel_id"
+            android:value="@string/fcm_default_notification_channel" />
+
         <activity
             android:label="@string/application_name"
             android:exported="true"
@@ -548,6 +553,14 @@
             android:name="com.dimagi.android.zebraprinttool.PrintReceiverActivity"
             tools:node="merge"/>
 
+        <service
+            android:name="org.commcare.services.CommCareFirebaseMessagingService"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="com.google.firebase.MESSAGING_EVENT" />
+            </intent-filter>
+        </service>
+
     </application>
 
 </manifest>

app/build.gradle

@@ -100,6 +100,7 @@ dependencies {
     implementation 'com.jakewharton.rxbinding2:rxbinding:2.0.0'
     implementation 'com.journeyapps:zxing-android-embedded:3.6.0'
     implementation 'com.google.firebase:firebase-analytics:17.5.0'
+    implementation 'com.google.firebase:firebase-messaging:21.1.0'
     implementation 'com.google.firebase:firebase-crashlytics:17.2.1'
     implementation 'androidx.legacy:legacy-support-core-ui:1.0.0'
     implementation 'com.duolingo.open:rtl-viewpager:2.0.0'

app/res/values/strings.xml

@@ -450,4 +450,6 @@
     <string name="dependency_missing_dialog_message_plural" cc:translatable="true">CommCare needs below applications to be installed on your device before you can continue-</string>
     <string name="dependency_missing_dialog_go_to_store" cc:translatable="true">Install from Store</string>
     <string name="dependency_missing_dialog_playstore_not_found" cc:translatable="true">No Play Store found on your device</string>
+    <string name="fcm_notification">FCM Notification</string>
+    <string name="fcm_default_notification_channel">notification-channel-server-communications</string>
 </resources>

app/src/org/commcare/CommCareApplication.java

@@ -28,9 +28,11 @@
 import androidx.work.PeriodicWorkRequest;
 import androidx.work.WorkManager;
 
+import com.google.android.gms.tasks.OnCompleteListener;
 import com.google.common.collect.ArrayListMultimap;
 import com.google.common.collect.Multimap;
 import com.google.firebase.analytics.FirebaseAnalytics;
+import com.google.firebase.messaging.FirebaseMessaging;
 
 import net.sqlcipher.database.SQLiteDatabase;
 import net.sqlcipher.database.SQLiteException;
@@ -250,6 +252,9 @@ public void onCreate() {
 
         LocalePreferences.saveDeviceLocale(Locale.getDefault());
         GraphUtil.setLabelCharacterLimit(getResources().getInteger(R.integer.graph_label_char_limit));
+
+        // Retrieve the current Firebase Cloud Messaging (FCM) registration token^M
+        FirebaseMessaging.getInstance().getToken().addOnCompleteListener(handleFCMTokenRetrieval());
     }
 
     protected void attachISRGCert() {
@@ -954,6 +959,15 @@ public CommCareSessionService getSession() {
         }
     }
 
+    public static boolean isSessionActive() {
+        try {
+            return CommCareApplication.instance().getSession() != null;
+        }
+        catch (SessionUnavailableException e){
+            return false;
+        }
+    }
+
     public UserKeyRecord getRecordForCurrentUser() {
         return getSession().getUserKeyRecord();
     }
@@ -1183,4 +1197,13 @@ public AndroidPackageUtils getAndroidPackageUtils() {
     public boolean isNsdServicesEnabled() {
         return true;
     }
+
+    private OnCompleteListener handleFCMTokenRetrieval(){
+        return (OnCompleteListener<String>) task -> {
+            if (!task.isSuccessful()) {
+                Logger.log(LogTypes.TYPE_FCM, "Fetching FCM registration token failed:" + task.getException());
+                return;
+            }
+        };
+    }
 }

app/src/org/commcare/heartbeat/HeartbeatRequester.java

@@ -1,5 +1,9 @@
 package org.commcare.heartbeat;
 
+
+import static org.commcare.utils.FirebaseMessagingUtil.FCM_TOKEN;
+import static org.commcare.utils.FirebaseMessagingUtil.FCM_TOKEN_TIME;
+
 import android.util.Log;
 
 import org.commcare.CommCareApplication;
@@ -11,6 +15,7 @@
 import org.commcare.preferences.ServerUrls;
 import org.commcare.util.LogTypes;
 import org.commcare.utils.CommCareUtil;
+import org.commcare.utils.FirebaseMessagingUtil;
 import org.commcare.utils.SessionUnavailableException;
 import org.commcare.utils.StorageUtils;
 import org.commcare.utils.SyncDetailCalculations;
@@ -20,7 +25,6 @@
 
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
-import java.util.HashMap;
 import java.util.TimeZone;
 
 import androidx.work.WorkManager;
@@ -64,9 +68,13 @@ public Multimap<String, String> getRequestParams() {
         params.put(CC_VERSION, ReportingUtils.getCommCareVersionString());
         params.put(QUARANTINED_FORMS_PARAM, String.valueOf(StorageUtils.getNumQuarantinedForms()));
         params.put(UNSENT_FORMS_PARAM, String.valueOf(StorageUtils.getNumUnsentForms()));
-        params.put(LAST_SYNC_TIME_PARAM, getISO8601FormattedLastSyncTime());
+        params.put(LAST_SYNC_TIME_PARAM, convertTimeInMsToISO8601(SyncDetailCalculations.getLastSyncTime()));
         params.put(CURRENT_DRIFT, String.valueOf(DriftHelper.getCurrentDrift()));
         params.put(MAX_DRIFT_SINCE_LAST_HEARTBEAT, String.valueOf(DriftHelper.getMaxDriftSinceLastHeartbeat()));
+        //TODO: Encode the FCM registration token
+        params.put(FCM_TOKEN, FirebaseMessagingUtil.getFCMToken());
+        // TODO: Convert the Date to ISO 8601 format
+        params.put(FCM_TOKEN_TIME, convertTimeInMsToISO8601(FirebaseMessagingUtil.getFCMTokenTime()));
         return params;
     }
 
@@ -75,14 +83,14 @@ public AuthInfo getAuth() {
         return new AuthInfo.CurrentAuth();
     }
 
-    private static String getISO8601FormattedLastSyncTime() {
-        long lastSyncTime = SyncDetailCalculations.getLastSyncTime();
-        if (lastSyncTime == 0) {
+    // TODO: Move this method to DateUtils
+    private static String convertTimeInMsToISO8601(long ms) {
+        if (ms == 0) {
             return "";
         } else {
             DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm'Z'");
             df.setTimeZone(TimeZone.getTimeZone("UTC"));
-            return df.format(lastSyncTime);
+            return df.format(ms);
         }
     }
 

app/src/org/commcare/preferences/HiddenPreferences.java

@@ -94,8 +94,9 @@ public class HiddenPreferences {
     private static final String BYPASS_PRE_UPDATE_SYNC = "bypass_pre_update_sync";
     private static final String DISABLE_BACKGROUND_WORK_TIME = "disable-background-work-time";
 
-
     private static final long NO_OF_HOURS_TO_WAIT_TO_RESUME_BACKGROUND_WORK = 36;
+    // This is to be used by CommCareFirebaseMessagingService to schedule a sync after the next Login
+    public final static String PENDING_SYNC_REQUEST_FROM_SERVER = "pending-sync-request-from-server";
 
 
     /**
@@ -551,4 +552,14 @@ public static void markRawMediaCleanUpComplete() {
         CommCareApplication.instance().getCurrentApp().getAppPreferences()
                 .edit().putBoolean(RAW_MEDIA_CLEANUP_COMPLETE, true).apply();
     }
+
+    public static boolean isPendingSyncRequestFromServer() {
+        return PreferenceManager.getDefaultSharedPreferences(CommCareApplication.instance())
+                .getBoolean(PENDING_SYNC_REQUEST_FROM_SERVER, false);
+    }
+    public static void setPendingSyncRequestFromServer(boolean syncNeeded) {
+        PreferenceManager.getDefaultSharedPreferences(CommCareApplication.instance()).edit()
+                .putBoolean(PENDING_SYNC_REQUEST_FROM_SERVER, syncNeeded)
+                .apply();
+    }
 }

app/src/org/commcare/services/CommCareFirebaseMessagingService.java

@@ -0,0 +1,148 @@
+package org.commcare.services;
+
+import android.app.NotificationManager;
+import android.app.PendingIntent;
+import android.content.Intent;
+import android.os.Build;
+
+import androidx.core.app.NotificationCompat;
+
+import com.google.firebase.messaging.FirebaseMessagingService;
+import com.google.firebase.messaging.RemoteMessage;
+
+import org.commcare.CommCareNoficationManager;
+import org.commcare.activities.DispatchActivity;
+import org.commcare.dalvik.R;
+import org.commcare.util.LogTypes;
+import org.commcare.utils.FirebaseMessagingUtil;
+import org.javarosa.core.services.Logger;
+import org.joda.time.DateTime;
+
+import java.util.Map;
+
+/**
+ * This service responds to any events/messages from Firebase Cloud Messaging. The intention is to
+ * offer an entry point for any message from FCM and trigger the necessary steps based on the action
+ * key.
+ */
+public class CommCareFirebaseMessagingService extends FirebaseMessagingService {
+
+    private final static int FCM_NOTIFICATION = R.string.fcm_notification;
+    private enum ActionTypes{
+        SYNC,
+        INVALID
+    }
+
+   /**
+    * Upon receiving a new message from FCM, CommCare needs to:
+    * 1) Trigger the notification if the message contains a Notification object. Note that the
+    *    presence of a Notification object causes the onMessageReceived to not be called when the
+    *    app is in the background, which means that the data object won't be processed from here
+    * 2) Verify if the message contains a data object and trigger the necessary steps according
+    *    to the action it carries
+    *
+    */
+    @Override
+    public void onMessageReceived(RemoteMessage remoteMessage) {
+        Logger.log(LogTypes.TYPE_FCM, "Message received: " + remoteMessage.getMessageId());
+        Map<String, String> payloadData = remoteMessage.getData();
+        RemoteMessage.Notification payloadNotification = remoteMessage.getNotification();
+
+        if (payloadNotification != null) {
+            showNotification(payloadNotification);
+        }
+
+        // Check if the message contains a data object, there is no further action if not
+        if (payloadData.size() == 0){
+            return;
+        }
+
+        FCMMessageData fcmMessageData = new FCMMessageData(payloadData);
+
+        switch(fcmMessageData.action){
+            case SYNC -> {} // trigger sync for fcmMessageData
+            default ->
+                    Logger.log(LogTypes.TYPE_FCM, "Invalid FCM action");
+        }
+    }
+
+    @Override
+    public void onNewToken(String token) {
+        // TODO: Remove the token from the log
+        Logger.log(LogTypes.TYPE_FCM, "New registration token was generated"+token);
+        FirebaseMessagingUtil.updateFCMToken(token);
+    }
+
+
+   /**
+    * This method purpose is to show notifications to the user when the app is in the foreground.
+    * When the app is in the background, FCM is responsible for notifying the user
+    *
+    */
+    private void showNotification(RemoteMessage.Notification notification) {
+        String notificationTitle = notification.getTitle();
+        String notificationText = notification.getBody();
+        NotificationManager mNM = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
+
+        Intent i = new Intent(this, DispatchActivity.class);
+        i.setAction(Intent.ACTION_MAIN);
+        i.addCategory(Intent.CATEGORY_LAUNCHER);
+
+        PendingIntent contentIntent;
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M)
+            contentIntent = PendingIntent.getActivity(this, 0, i, PendingIntent.FLAG_IMMUTABLE);
+        else
+            contentIntent = PendingIntent.getActivity(this, 0, i, 0);
+
+        NotificationCompat.Builder fcmNotification = new NotificationCompat.Builder(this,
+                CommCareNoficationManager.NOTIFICATION_CHANNEL_SERVER_COMMUNICATIONS_ID)
+                .setContentTitle(notificationTitle)
+                .setContentText(notificationText)
+                .setContentIntent(contentIntent)
+                .setSmallIcon(R.drawable.notification)
+                .setPriority(NotificationCompat.PRIORITY_HIGH)
+                .setWhen(System.currentTimeMillis());
+
+        mNM.notify(FCM_NOTIFICATION, fcmNotification.build());
+    }
+
+    /**
+     * This class is to facilitate handling the FCM Message Data object. It should contain all the
+     * necessary checks and transformations
+     */
+    public class FCMMessageData {
+        private ActionTypes action;
+        private String username;
+        private String domain;
+        private DateTime creationTime;
+
+        private FCMMessageData(Map<String, String> payloadData){
+            this.action = getActionType(payloadData.get("action"));
+            this.username = payloadData.get("username");
+            this.domain = payloadData.get("domain");
+            this.creationTime = convertISO8601ToDateTime(payloadData.get("created_at"));
+        }
+
+        private DateTime convertISO8601ToDateTime(String timeInISO8601) {
+            if (timeInISO8601 == null){
+                return null;
+            }
+            return new DateTime(timeInISO8601);
+        }
+
+        private ActionTypes getActionType(String action) {
+            if (action == null) {
+                return ActionTypes.INVALID;
+            }
+
+            switch (action.toUpperCase()) {
+                case "SYNC" -> {
+                    return ActionTypes.SYNC;
+                }
+                default -> {
+                    return ActionTypes.INVALID;
+                }
+            }
+        }
+    }
+}

app/src/org/commcare/utils/FirebaseMessagingUtil.java

@@ -0,0 +1,49 @@
+package org.commcare.utils;
+
+import android.content.SharedPreferences;
+
+import androidx.preference.PreferenceManager;
+
+import org.commcare.CommCareApplication;
+
+public class FirebaseMessagingUtil {
+    public static final String FCM_TOKEN = "fcm_token";
+    public static final String FCM_TOKEN_TIME = "fcm_token_time";
+
+    /**
+     * The domain name in the application profile file comes in the <domain>.commcarehq.org form,
+     * this is standard across the different HQ servers. This constant is to store that suffix and
+     * be used to remove it form the user domain name to match how the domain represented in the backend
+     */
+    public static final String USER_DOMAIN_SERVER_URL_SUFFIX = ".commcarehq.org";
+
+    public static String getFCMToken() {
+        return PreferenceManager
+                .getDefaultSharedPreferences(CommCareApplication.instance())
+                .getString(FCM_TOKEN, null);
+    }
+
+    public static long getFCMTokenTime() {
+        return PreferenceManager
+                .getDefaultSharedPreferences(CommCareApplication.instance())
+                .getLong(FCM_TOKEN_TIME, 0);
+    }
+
+    public static void updateFCMToken(String newToken) {
+        SharedPreferences sharedPreferences = PreferenceManager
+                .getDefaultSharedPreferences(CommCareApplication.instance());
+        sharedPreferences.edit().putString(FCM_TOKEN, newToken).apply();
+        sharedPreferences.edit().putLong(FCM_TOKEN_TIME,System.currentTimeMillis()).apply();
+    }
+
+    public static String removeServerUrlFromUserDomain(String userDomain) {
+        if (userDomain == null){
+            return null;
+        }
+
+        if (userDomain.contains(USER_DOMAIN_SERVER_URL_SUFFIX)){
+            return userDomain.replace(USER_DOMAIN_SERVER_URL_SUFFIX, "");
+        }
+        return userDomain;
+    }
+}