Form update notifications

collect_app/build.gradle

@@ -199,6 +199,7 @@ dependencies {
         exclude group: 'org.apache.httpcomponents'
     }
 
+    implementation group: 'com.evernote', name: 'android-job', version: '1.2.5'
     implementation group: 'commons-io', name: 'commons-io', version: '2.5'
     implementation group: 'net.sf.kxml', name: 'kxml2', version: '2.3.0'
     implementation group: 'net.sf.opencsv', name: 'opencsv', version: '2.3'

collect_app/src/main/java/org/odk/collect/android/activities/FormDownloadList.java

@@ -53,6 +53,9 @@
 
 import timber.log.Timber;
 
+import static org.odk.collect.android.utilities.DownloadFormListUtils.DL_AUTH_REQUIRED;
+import static org.odk.collect.android.utilities.DownloadFormListUtils.DL_ERROR_MSG;
+
 /**
  * Responsible for displaying, adding and deleting all the valid forms in the forms directory. One
  * caveat. If the server requires authentication, a dialog will pop up asking when you request the
@@ -76,6 +79,7 @@ public class FormDownloadList extends FormListActivity implements FormListDownlo
     private static final int AUTH_DIALOG = 2;
     private static final int CANCELLATION_DIALOG = 3;
 
+    public static final String DISPLAY_ONLY_UPDATED_FORMS = "displayOnlyUpdatedForms";
     private static final String BUNDLE_SELECTED_COUNT = "selectedcount";
     private static final String BUNDLE_FORM_MAP = "formmap";
     private static final String DIALOG_TITLE = "dialogtitle";
@@ -114,6 +118,7 @@ public class FormDownloadList extends FormListActivity implements FormListDownlo
     private boolean shouldExit;
     private static final String SHOULD_EXIT = "shouldexit";
 
+    private boolean displayOnlyUpdatedForms;
 
     @SuppressWarnings("unchecked")
     @Override
@@ -122,6 +127,10 @@ public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setTitle(getString(R.string.get_forms));
 
+        if (getIntent().getExtras() != null) {
+            displayOnlyUpdatedForms = (boolean) getIntent().getExtras().get(DISPLAY_ONLY_UPDATED_FORMS);
+        }
+
         alertMsg = getString(R.string.please_wait);
 
         downloadButton = findViewById(R.id.add_button);
@@ -579,14 +588,14 @@ public void formListDownloadingComplete(HashMap<String, FormDetails> result) {
             return;
         }
 
-        if (result.containsKey(DownloadFormListTask.DL_AUTH_REQUIRED)) {
+        if (result.containsKey(DL_AUTH_REQUIRED)) {
             // need authorization
             showDialog(AUTH_DIALOG);
-        } else if (result.containsKey(DownloadFormListTask.DL_ERROR_MSG)) {
+        } else if (result.containsKey(DL_ERROR_MSG)) {
             // Download failed
             String dialogMessage =
                     getString(R.string.list_failed_with_error,
-                            result.get(DownloadFormListTask.DL_ERROR_MSG).getErrorStr());
+                            result.get(DL_ERROR_MSG).getErrorStr());
             String dialogTitle = getString(R.string.load_remote_form_error);
             createAlertDialog(dialogTitle, dialogMessage, DO_NOT_EXIT);
         } else {
@@ -599,28 +608,31 @@ public void formListDownloadingComplete(HashMap<String, FormDetails> result) {
             for (int i = 0; i < result.size(); i++) {
                 String formDetailsKey = ids.get(i);
                 FormDetails details = formNamesAndURLs.get(formDetailsKey);
-                HashMap<String, String> item = new HashMap<String, String>();
-                item.put(FORMNAME, details.getFormName());
-                item.put(FORMID_DISPLAY,
-                        ((details.getFormVersion() == null) ? "" : (getString(R.string.version) + " "
-                                + details.getFormVersion() + " ")) + "ID: " + details.getFormID());
-                item.put(FORMDETAIL_KEY, formDetailsKey);
-                item.put(FORM_ID_KEY, details.getFormID());
-                item.put(FORM_VERSION_KEY, details.getFormVersion());
-
-                // Insert the new form in alphabetical order.
-                if (formList.size() == 0) {
-                    formList.add(item);
-                } else {
-                    int j;
-                    for (j = 0; j < formList.size(); j++) {
-                        HashMap<String, String> compareMe = formList.get(j);
-                        String name = compareMe.get(FORMNAME);
-                        if (name.compareTo(formNamesAndURLs.get(ids.get(i)).getFormName()) > 0) {
-                            break;
+
+                if (!displayOnlyUpdatedForms || (details.isNewerFormVersionAvailable() || details.areNewerMediaFilesAvailable())) {
+                    HashMap<String, String> item = new HashMap<String, String>();
+                    item.put(FORMNAME, details.getFormName());
+                    item.put(FORMID_DISPLAY,
+                            ((details.getFormVersion() == null) ? "" : (getString(R.string.version) + " "
+                                    + details.getFormVersion() + " ")) + "ID: " + details.getFormID());
+                    item.put(FORMDETAIL_KEY, formDetailsKey);
+                    item.put(FORM_ID_KEY, details.getFormID());
+                    item.put(FORM_VERSION_KEY, details.getFormVersion());
+
+                    // Insert the new form in alphabetical order.
+                    if (formList.size() == 0) {
+                        formList.add(item);
+                    } else {
+                        int j;
+                        for (j = 0; j < formList.size(); j++) {
+                            HashMap<String, String> compareMe = formList.get(j);
+                            String name = compareMe.get(FORMNAME);
+                            if (name.compareTo(formNamesAndURLs.get(ids.get(i)).getFormName()) > 0) {
+                                break;
+                            }
                         }
+                        formList.add(j, item);
                     }
-                    formList.add(j, item);
                 }
             }
             filteredFormList.addAll(formList);

collect_app/src/main/java/org/odk/collect/android/activities/MainMenuActivity.java

@@ -52,6 +52,7 @@
 import org.odk.collect.android.preferences.PreferenceKeys;
 import org.odk.collect.android.preferences.PreferencesActivity;
 import org.odk.collect.android.provider.InstanceProviderAPI.InstanceColumns;
+import org.odk.collect.android.tasks.ServerPollingJob;
 import org.odk.collect.android.utilities.ApplicationConstants;
 import org.odk.collect.android.utilities.AuthDialogUtility;
 import org.odk.collect.android.utilities.PlayServicesUtil;
@@ -68,6 +69,8 @@
 
 import timber.log.Timber;
 
+import static org.odk.collect.android.preferences.PreferenceKeys.KEY_PERIODIC_FORM_UPDATES_CHECK;
+
 /**
  * Responsible for displaying buttons to launch the major activities. Launches
  * some activities based on returns of others.
@@ -652,6 +655,9 @@ private boolean loadSharedPreferencesFromFile(File src) {
                     prefEdit.putLong(key, (Long) v);
                 } else if (v instanceof String) {
                     prefEdit.putString(key, ((String) v));
+                    if (key.equals(KEY_PERIODIC_FORM_UPDATES_CHECK)) {
+                        ServerPollingJob.schedulePeriodicJob((String) v);
+                    }
                 }
             }
             prefEdit.apply();

collect_app/src/main/java/org/odk/collect/android/application/Collect.java

@@ -30,6 +30,7 @@
 import android.view.View;
 import android.view.inputmethod.InputMethodManager;
 
+import com.evernote.android.job.JobManager;
 import com.google.android.gms.analytics.GoogleAnalytics;
 import com.google.android.gms.analytics.Tracker;
 import com.google.firebase.crash.FirebaseCrash;
@@ -52,6 +53,7 @@
 import org.odk.collect.android.utilities.AuthDialogUtility;
 import org.odk.collect.android.utilities.LocaleHelper;
 import org.odk.collect.android.utilities.PRNGFixes;
+import org.odk.collect.android.utilities.ServerPollingJobCreator;
 import org.opendatakit.httpclientandroidlib.client.CookieStore;
 import org.opendatakit.httpclientandroidlib.client.CredentialsProvider;
 import org.opendatakit.httpclientandroidlib.client.protocol.HttpClientContext;
@@ -266,6 +268,10 @@ public void onCreate() {
 
         reloadSharedPreferences();
 
+        JobManager
+                .create(this)
+                .addJobCreator(new ServerPollingJobCreator());
+
         PRNGFixes.apply();
         AppCompatDelegate.setCompatVectorFromResourcesEnabled(true);
         JodaTimeAndroid.init(this);

collect_app/src/main/java/org/odk/collect/android/database/helpers/FormsDatabaseHelper.java

@@ -40,6 +40,7 @@
 import static org.odk.collect.android.provider.FormsProviderAPI.FormsColumns.JR_FORM_ID;
 import static org.odk.collect.android.provider.FormsProviderAPI.FormsColumns.JR_VERSION;
 import static org.odk.collect.android.provider.FormsProviderAPI.FormsColumns.LANGUAGE;
+import static org.odk.collect.android.provider.FormsProviderAPI.FormsColumns.LAST_DETECTED_FORM_VERSION_HASH;
 import static org.odk.collect.android.provider.FormsProviderAPI.FormsColumns.MD5_HASH;
 import static org.odk.collect.android.provider.FormsProviderAPI.FormsColumns.SUBMISSION_URI;
 
@@ -50,7 +51,7 @@ public class FormsDatabaseHelper extends SQLiteOpenHelper {
     private static final String DATABASE_NAME = "forms.db";
     public static final String FORMS_TABLE_NAME = "forms";
 
-    private static final int DATABASE_VERSION = 5;
+    private static final int DATABASE_VERSION = 6;
 
     // These exist in database versions 2 and 3, but not in 4...
     private static final String TEMP_FORMS_TABLE_NAME = "forms_v4";
@@ -79,9 +80,11 @@ public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
                 success &= upgradeToVersion4(db, oldVersion);
             case 4:
                 success &= upgradeToVersion5(db);
+            case 5:
+                success &= upgradeToVersion6(db);
                 break;
             default:
-                Timber.i("Unknown version " + oldVersion);
+                Timber.i("Unknown version %s", oldVersion);
         }
 
         if (success) {
@@ -276,6 +279,22 @@ private boolean upgradeToVersion5(SQLiteDatabase db) {
         return success;
     }
 
+    private boolean upgradeToVersion6(SQLiteDatabase db) {
+        boolean success = true;
+        try {
+            CustomSQLiteQueryBuilder
+                    .begin(db)
+                    .alter()
+                    .table(FORMS_TABLE_NAME)
+                    .addColumn(LAST_DETECTED_FORM_VERSION_HASH, "text")
+                    .end();
+        } catch (SQLiteException e) {
+            Timber.e(e);
+            success = false;
+        }
+        return success;
+    }
+
     private void createFormsTable(SQLiteDatabase db, String tableName) {
         db.execSQL("CREATE TABLE " + tableName + " ("
                 + _ID + " integer primary key, "
@@ -292,7 +311,8 @@ private void createFormsTable(SQLiteDatabase db, String tableName) {
                 + SUBMISSION_URI + " text, "
                 + BASE64_RSA_PUBLIC_KEY + " text, "
                 + JRCACHE_FILE_PATH + " text not null, "
-                + AUTO_SEND + " text,"
-                + AUTO_DELETE + " text);");
+                + AUTO_SEND + " text, "
+                + AUTO_DELETE + " text, "
+                + LAST_DETECTED_FORM_VERSION_HASH + " text);");
     }
 }

collect_app/src/main/java/org/odk/collect/android/logic/FormDetails.java

@@ -25,6 +25,7 @@ public class FormDetails implements Serializable {
     private String manifestUrl;
     private String formID;
     private String formVersion;
+    private String hash;
     private boolean isNewerFormVersionAvailable;
     private boolean areNewerMediaFilesAvailable;
 
@@ -33,13 +34,14 @@ public FormDetails(String error) {
     }
 
     public FormDetails(String formName, String downloadUrl, String manifestUrl, String formID,
-                       String formVersion, boolean isNewerFormVersionAvailable,
+                       String formVersion, String hash, boolean isNewerFormVersionAvailable,
                        boolean areNewerMediaFilesAvailable) {
         this.formName = formName;
         this.downloadUrl = downloadUrl;
         this.manifestUrl = manifestUrl;
         this.formID = formID;
         this.formVersion = formVersion;
+        this.hash = hash;
         this.isNewerFormVersionAvailable = isNewerFormVersionAvailable;
         this.areNewerMediaFilesAvailable = areNewerMediaFilesAvailable;
     }
@@ -68,6 +70,10 @@ public String getFormVersion() {
         return formVersion;
     }
 
+    public String getHash() {
+        return hash;
+    }
+
     public boolean isNewerFormVersionAvailable() {
         return isNewerFormVersionAvailable;
     }

collect_app/src/main/java/org/odk/collect/android/preferences/AdminKeys.java

@@ -46,6 +46,7 @@ public final class AdminKeys {
     private static final String KEY_SHOW_SPLASH_SCREEN          = "show_splash_screen";
     private static final String KEY_DELETE_AFTER_SEND           = "delete_after_send";
     private static final String KEY_INSTANCE_FORM_SYNC          = "instance_form_sync";
+    private static final String KEY_PERIODIC_FORM_UPDATES_CHECK = "periodic_form_updates_check";
     private static final String KEY_APP_LANGUAGE                = "change_app_language";
 
     private static final String KEY_AUTOSEND                    = "change_autosend";
@@ -79,6 +80,7 @@ public final class AdminKeys {
             ag(KEY_SHOW_SPLASH_SCREEN,         PreferenceKeys.KEY_SPLASH_PATH),
             ag(KEY_DELETE_AFTER_SEND,          PreferenceKeys.KEY_DELETE_AFTER_SEND),
             ag(KEY_INSTANCE_FORM_SYNC,         PreferenceKeys.KEY_INSTANCE_SYNC),
+            ag(KEY_PERIODIC_FORM_UPDATES_CHECK, PreferenceKeys.KEY_PERIODIC_FORM_UPDATES_CHECK),
 
             ag(KEY_AUTOSEND,                   PreferenceKeys.KEY_AUTOSEND),
 
@@ -125,7 +127,8 @@ public final class AdminKeys {
             KEY_CONSTRAINT_BEHAVIOR,
             KEY_HIGH_RESOLUTION,
             KEY_IMAGE_SIZE,
-            KEY_INSTANCE_FORM_SYNC
+            KEY_INSTANCE_FORM_SYNC,
+            KEY_PERIODIC_FORM_UPDATES_CHECK
     );
 
     static Collection<String> userInterfaceKeys = Arrays.asList(