Referral Notifications - Background Sync

app/assets/locales/android_translatable_strings.txt

@@ -2,6 +2,7 @@ option.yes=YES
 option.no=NO
 option.cancel=CANCEL
 dialog.ok=OK
+dialog.do.not.show=Don't show again
 
 updates.found=Updates found! Downloading new resource ${0} done of ${1}
 updates.success=App is up to date
@@ -970,6 +971,13 @@ tts.speak.failed=Couldn't speak now. Please try again!
 file.oversize.error.title=File Too Large
 file.oversize.error.message=Selected file exceeds the file size limit of 15 MB. Please select a file whose size is less than 15 MB.
 
+background.sync.pending.form.entry.title=Pending Sync
+background.sync.pending.form.entry.detail=There are new cases available but the Sync can't run while a form is open. A Sync will be triggered upon form submission!
+background.sync.logout.attempt.during.sync=Can't log out while a Sync is underway!
+background.sync.user.sync.attempt.during.sync=Can't trigger a Sync while another is underway!
+background.sync.form.entry.attempt.during.sync=A Form can't be open while a Sync is underway!
+background.sync.fail=Background sync failed. Please try to trigger a normal Sync
+
 android.package.name.org.commcare.dalvik.reminders=CommCare Reminders
 android.package.name.callout.commcare.org.sendussd=Commcare USSD
 android.package.name.org.commcare.dalvik.abha=CommCare ABHA

app/res/layout/custom_alert_dialog.xml

@@ -50,6 +50,17 @@
                     android:textColor="@color/cc_attention_negative_text"
                     android:textAppearance="@style/TextAppearance.AppCompat.Medium"/>
 
+                <CheckBox
+                    android:id="@+id/dialog_checkbox"
+                    android:layout_width="wrap_content"
+                    android:layout_height="wrap_content"
+                    android:layout_below="@id/emphasized_message"
+                    android:focusable="true"
+                    android:visibility="gone"
+                    android:textSize="@dimen/font_size_dp_large"
+                    android:layout_marginTop="@dimen/standard_spacer_double">
+                </CheckBox>
+
             </RelativeLayout>
 
         </ScrollView>

app/src/org/commcare/CommCareApplication.java

@@ -196,6 +196,8 @@ public class CommCareApplication extends MultiDexApplication {
     private boolean invalidateCacheOnRestore;
     private CommCareNoficationManager noficationManager;
 
+    private boolean backgroundSyncSafe;
+
     @Override
     public void onCreate() {
         super.onCreate();
@@ -291,6 +293,14 @@ private void logFirstCommCareRun() {
         }
     }
 
+    public void setBackgroundSyncSafe(boolean backgroundSyncSafe){
+        this.backgroundSyncSafe = backgroundSyncSafe;
+    }
+
+    public boolean isBackgroundSyncSafe(){
+        return this.backgroundSyncSafe;
+    }
+
     // Whether user is running CommCare for the first time after installation
     public static boolean isFirstRunAfterInstall() {
         SharedPreferences preferences =

app/src/org/commcare/activities/CommCareActivity.java

@@ -1,12 +1,14 @@
 package org.commcare.activities;
 
+
+import static org.commcare.preferences.HiddenPreferences.isBackgroundSyncEnabled;
 import static org.commcare.preferences.HiddenPreferences.isFlagSecureEnabled;
+import static org.commcare.sync.ExternalDataUpdateHelper.COMMCARE_DATA_UPDATE_ACTION;
 
-import android.annotation.TargetApi;
 import android.content.Context;
 import android.content.DialogInterface;
+import android.content.IntentFilter;
 import android.graphics.Rect;
-import android.os.Build;
 import android.os.Bundle;
 import android.text.Spannable;
 import android.util.DisplayMetrics;
@@ -32,6 +34,8 @@
 import org.commcare.interfaces.WithUIController;
 import org.commcare.logic.DetailCalloutListenerDefaultImpl;
 import org.commcare.preferences.LocalePreferences;
+import org.commcare.services.DataSyncCompleteBroadcastReceiver;
+import org.commcare.services.FCMMessageData;
 import org.commcare.session.CommCareSession;
 import org.commcare.session.SessionFrame;
 import org.commcare.session.SessionInstanceBuilder;
@@ -125,6 +129,7 @@ public abstract class CommCareActivity<R> extends AppCompatActivity
     private ContainerFragment<Bundle> managedUiState;
     private boolean isMainScreenBlocked;
 
+    private DataSyncCompleteBroadcastReceiver dataSyncCompleteBroadcastReceiver;
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
@@ -292,6 +297,18 @@ private void showPendingUserMessage() {
     protected void onResume() {
         super.onResume();
         AudioController.INSTANCE.playPreviousAudio();
+
+        CommCareApplication.instance().setBackgroundSyncSafe(true);
+
+        if (shouldListenToSyncComplete() && isBackgroundSyncEnabled()) {
+            dataSyncCompleteBroadcastReceiver = new DataSyncCompleteBroadcastReceiver();
+            registerReceiver(dataSyncCompleteBroadcastReceiver, new IntentFilter(COMMCARE_DATA_UPDATE_ACTION));
+        }
+    }
+
+    // Activities that needs to restart after sync should override this to return true
+    public boolean shouldListenToSyncComplete() {
+        return false;
     }
 
     @Override
@@ -315,6 +332,10 @@ protected void onPause() {
 
         areFragmentsPaused = true;
         AudioController.INSTANCE.systemInducedPause();
+
+        if (dataSyncCompleteBroadcastReceiver != null) {
+            unregisterReceiver(dataSyncCompleteBroadcastReceiver);
+        }
     }
 
     @Override
@@ -702,6 +723,9 @@ public boolean aTaskInProgress() {
         return stateHolder != null && stateHolder.isCurrentTaskRunning();
     }
 
+    // Dummy method, should be implemented by each Activity that is not safe for a background sync
+    public void alertPendingSync(FCMMessageData fcmMessageData) {}
+
     /**
      * Interface to perform additional setup code when adding an ActionBar
      */

app/src/org/commcare/activities/CommcareListActivity.java

@@ -7,6 +7,7 @@
 import android.widget.ListAdapter;
 import android.widget.ListView;
 
+import org.commcare.CommCareApplication;
 import org.commcare.dalvik.R;
 
 /**
@@ -35,6 +36,13 @@ protected void onCreate(Bundle savedInstanceState) {
         mListView.setOnItemClickListener(mOnClickListener);
     }
 
+    @Override
+    protected void onResume() {
+        super.onResume();
+
+        CommCareApplication.instance().setBackgroundSyncSafe(true);
+    }
+
     public int getLayoutResource() {
         return R.layout.activity_commcare_list;
     }

app/src/org/commcare/activities/DispatchActivity.java

@@ -13,13 +13,17 @@
 import org.commcare.android.database.global.models.ApplicationRecord;
 import org.commcare.android.database.user.models.SessionStateDescriptor;
 import org.commcare.dalvik.R;
+import org.commcare.models.AndroidSessionWrapper;
 import org.commcare.preferences.DeveloperPreferences;
 import org.commcare.recovery.measures.ExecuteRecoveryMeasuresActivity;
 import org.commcare.recovery.measures.RecoveryMeasuresHelper;
+import org.commcare.session.CommCareSession;
+import org.commcare.suite.model.StackFrameStep;
 import org.commcare.utils.AndroidShortcuts;
 import org.commcare.utils.CommCareLifecycleUtils;
 import org.commcare.utils.MultipleAppsUtil;
 import org.commcare.utils.SessionUnavailableException;
+import org.javarosa.core.model.condition.EvaluationContext;
 import org.javarosa.core.services.locale.Localization;
 
 import java.util.ArrayList;
@@ -47,7 +51,7 @@ public class DispatchActivity extends AppCompatActivity {
     public static final String WAS_SHORTCUT_LAUNCH = "launch_from_shortcut";
     public static final String START_FROM_LOGIN = "process_successful_login";
     public static final String EXECUTE_RECOVERY_MEASURES = "execute_recovery_measures";
-
+    public static final String SESSION_REBUILD_REQUEST = "session_rebuild_request";
     private static final int LOGIN_USER = 0;
     private static final int HOME_SCREEN = 1;
     public static final int INIT_APP = 2;
@@ -76,7 +80,7 @@ public class DispatchActivity extends AppCompatActivity {
     private boolean waitingForActivityResultFromLogin;
 
     boolean alreadyCheckedForAppFilesChange;
-
+    static final String REBUILD_SESSION = "rebuild_session";
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
@@ -193,7 +197,8 @@ private void dispatch() {
                         !shortcutExtraWasConsumed) {
                     // CommCare was launched from a shortcut
                     handleShortcutLaunch();
-                } else {
+                }
+                else {
                     launchHomeScreen();
                 }
             } catch (SessionUnavailableException sue) {

app/src/org/commcare/activities/EntityDetailActivity.java

@@ -144,6 +144,11 @@ public void onCreateSessionSafe(Bundle savedInstanceState) {
         isFinalSwipeActionEnabled = DeveloperPreferences.isDetailTabSwipeActionEnabled();
     }
 
+    @Override
+    public boolean shouldListenToSyncComplete() {
+        return true;
+    }
+
     @Override
     public Pair<Detail, TreeReference> requestEntityContext() {
         return mEntityContext;

app/src/org/commcare/activities/EntitySelectActivity.java

@@ -1,5 +1,8 @@
 package org.commcare.activities;
 
+import static org.commcare.activities.HomeScreenBaseActivity.RESULT_RESTART;
+
+import androidx.appcompat.app.AppCompatActivity;
 import android.content.Intent;
 import android.content.pm.ActivityInfo;
 import android.content.res.Configuration;
@@ -302,6 +305,11 @@ private void setupLandscapeDualPaneView() {
         message.setText(Localization.get("select.placeholder.message", new String[]{Localization.get("cchq.case")}));
     }
 
+    @Override
+    public boolean shouldListenToSyncComplete() {
+        return true;
+    }
+
     private void restoreExistingSelection(boolean isOrientationChange) {
         // Restore detail screen for selection from landscape mode as we move into portrait mode.
         if (isOrientationChange) {
@@ -569,6 +577,9 @@ public void onActivityResultSessionSafe(int requestCode, int resultCode, Intent
                 if (resultCode == RESULT_OK && !mViewMode) {
                     // create intent for return and store path
                     returnWithResult(intent);
+                } else if (resultCode == RESULT_RESTART) {
+                    this.setResult(RESULT_RESTART, intent);
+                    this.finish();
                 } else {
                     //Did we enter the detail from mapping mode? If so, go back to that
                     if (mResultIsMap) {

app/src/org/commcare/activities/FormAndDataSyncer.java

@@ -192,7 +192,8 @@ private <I extends CommCareActivity & PullTaskResultReceiver> void syncData(
             DataPullRequester dataPullRequester, boolean blockRemoteKeyManagement) {
 
         DataPullTask<PullTaskResultReceiver> dataPullTask = new DataPullTask<PullTaskResultReceiver>(
-                username, password, userId, server, activity, dataPullRequester, blockRemoteKeyManagement) {
+                username, password, userId, server, activity, dataPullRequester,
+                blockRemoteKeyManagement, false) {
 
             @Override
             protected void deliverResult(PullTaskResultReceiver receiver,

app/src/org/commcare/activities/FormEntryActivity.java

@@ -57,6 +57,9 @@
 import org.commcare.models.AndroidSessionWrapper;
 import org.commcare.models.FormRecordProcessor;
 import org.commcare.models.database.SqlStorage;
+import org.commcare.preferences.HiddenPreferences;
+import org.commcare.services.FCMMessageData;
+import org.commcare.services.PendingSyncAlertBroadcastReceiver;
 import org.commcare.tasks.FormLoaderTask;
 import org.commcare.tasks.SaveToDiskTask;
 import org.commcare.tts.TextToSpeechCallback;
@@ -102,6 +105,7 @@
 import androidx.core.app.ActivityCompat;
 
 import static org.commcare.android.database.user.models.FormRecord.QuarantineReason_LOCAL_PROCESSING_ERROR;
+import static org.commcare.sync.FirebaseMessagingDataSyncer.PENGING_SYNC_ALERT_ACTION;
 
 /**
  * Displays questions, animates transitions between
@@ -171,6 +175,9 @@ public class FormEntryActivity extends SaveSessionCommCareActivity<FormEntryActi
 
     private boolean fullFormProfilingEnabled = false;
     private EvaluationTraceReporter traceReporter;
+
+    private PendingSyncAlertBroadcastReceiver pendingSyncAlertBroadcastReceiver = new PendingSyncAlertBroadcastReceiver();
+
     private TextToSpeechCallback mTTSCallback = new TextToSpeechCallback() {
         @Override
         public void initFailed() {
@@ -878,6 +885,8 @@ protected void onPause() {
             PollSensorController.INSTANCE.stopLocationPolling();
         }
         TextToSpeechConverter.INSTANCE.stop();
+
+        unregisterReceiver(pendingSyncAlertBroadcastReceiver);
     }
 
     private void saveInlineVideoState() {
@@ -925,6 +934,12 @@ public void onResumeSessionSafe() {
         restorePriorStates();
 
         reportVideoUsageIfAny();
+
+        IntentFilter intentFilter = new IntentFilter(PENGING_SYNC_ALERT_ACTION);
+        registerReceiver(pendingSyncAlertBroadcastReceiver, intentFilter);
+
+        // Flag that a background sync shouldn't be triggered when this activity is in the foreground
+        CommCareApplication.instance().setBackgroundSyncSafe(false);
     }
 
     private void reportVideoUsageIfAny() {
@@ -1499,6 +1514,25 @@ public void onRequestPermissionsResult(int requestCode,
         }
     }
 
+    @Override
+    public void alertPendingSync(FCMMessageData fcmMessageData) {
+        if (!HiddenPreferences.isPendingSyncRequest(fcmMessageData.getUsername())) {
+            HiddenPreferences.setPendingSyncRequest(fcmMessageData);
+
+            if (!HiddenPreferences.isPendingSyncDialogDisabled()) {
+                StandardAlertDialog dialog = StandardAlertDialog.getBasicAlertDialogWithDisablingCheckbox(this,
+                        Localization.get("background.sync.pending.form.entry.title"),
+                        Localization.get("background.sync.pending.form.entry.detail"), (buttonView, isChecked) -> {
+                            HiddenPreferences.setPendingSyncDialogDisabled(isChecked);
+                        });
+                dialog.setPositiveButton(Localization.get("dialog.ok"), (dialog1, which) -> {
+                    dialog1.dismiss();
+                });
+                showAlertDialog(dialog);
+            }
+        }
+    }
+
 
     public static class FormQueryException extends Exception {
         public FormQueryException(String msg) {

app/src/org/commcare/activities/HomeButtons.java

@@ -4,12 +4,14 @@
 import android.content.Intent;
 import android.text.Spannable;
 import android.view.View;
+import android.widget.Toast;
 
 import org.commcare.adapters.HomeCardDisplayData;
 import org.commcare.adapters.SquareButtonViewHolder;
 import org.commcare.dalvik.R;
 import org.commcare.google.services.analytics.AnalyticsParamValue;
 import org.commcare.google.services.analytics.FirebaseAnalyticsUtil;
+import org.commcare.services.CommCareSessionService;
 import org.commcare.utils.SessionUnavailableException;
 import org.commcare.utils.StorageUtils;
 import org.commcare.utils.SyncDetailCalculations;
@@ -110,6 +112,10 @@ private static View.OnClickListener getViewOldFormsListener(final StandardHomeAc
 
     private static View.OnClickListener getSyncButtonListener(final StandardHomeActivity activity) {
         return v -> {
+            if (CommCareSessionService.sessionAliveLock.isLocked()) {
+                Toast.makeText(activity, Localization.get("background.sync.user.sync.attempt.during.sync"), Toast.LENGTH_LONG).show();
+                return;
+            }
             reportButtonClick(AnalyticsParamValue.SYNC_BUTTON);
             activity.syncButtonPressed();
         };