Merge pull request #3495 from dimagi/copyLocationImprovements

[Hotfix] Discard stale locations based on an App Setting

Author: shubham1g5

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

@@ -1,5 +1,9 @@
 package org.commcare.activities;
 
+import static org.commcare.location.CommCareLocationControllerKt.DEFAULT_TIME_THRESHOLD;
+import static org.commcare.location.CommCareLocationControllerKt.isLocationFresh;
+import static org.commcare.location.CommCareLocationControllerKt.logStaleLocationSaved;
+
 import android.Manifest;
 import android.content.DialogInterface;
 import android.content.Intent;
@@ -27,6 +31,7 @@
 import org.commcare.views.dialogs.CommCareAlertDialog;
 import org.commcare.views.dialogs.DialogCreationHelpers;
 import org.commcare.views.dialogs.GeoProgressDialog;
+import org.javarosa.core.services.Logger;
 import org.javarosa.core.services.locale.Localization;
 import org.jetbrains.annotations.NotNull;
 
@@ -182,6 +187,7 @@ private void setupLocationDialog() {
 
     private void returnLocation() {
         if (location != null) {
+            logStaleLocationSaved(location);
             Intent i = new Intent();
             i.putExtra(FormEntryConstants.LOCATION_RESULT, GeoUtils.locationToString(location));
             setResult(RESULT_OK, i);

app/src/org/commcare/android/javarosa/PollSensorAction.java

@@ -1,5 +1,9 @@
 package org.commcare.android.javarosa;
 
+import static org.commcare.location.CommCareLocationControllerKt.DEFAULT_TIME_THRESHOLD;
+import static org.commcare.location.CommCareLocationControllerKt.isLocationFresh;
+import static org.commcare.location.CommCareLocationControllerKt.logStaleLocationSaved;
+
 import android.content.Context;
 import android.content.Intent;
 import android.location.Location;
@@ -14,6 +18,7 @@
 import org.javarosa.core.model.data.IAnswerData;
 import org.javarosa.core.model.instance.AbstractTreeElement;
 import org.javarosa.core.model.instance.TreeReference;
+import org.javarosa.core.services.Logger;
 import org.javarosa.core.util.externalizable.DeserializationException;
 import org.javarosa.core.util.externalizable.ExtUtil;
 import org.javarosa.core.util.externalizable.ExtWrapNullable;
@@ -64,6 +69,7 @@ public TreeReference processAction(FormDef model, TreeReference contextRef) {
 
     void updateReference(Location location) {
         if (target != null) {
+            logStaleLocationSaved(location);
             String result = GeoUtils.locationToString(location);
             TreeReference qualifiedReference = contextRef == null ? target : target.contextualize(contextRef);
             EvaluationContext context = new EvaluationContext(formDef.getEvaluationContext(), qualifiedReference);

app/src/org/commcare/location/CommCareFusedLocationController.kt

@@ -1,5 +1,6 @@
 package org.commcare.location
 
+import android.annotation.SuppressLint
 import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
@@ -12,7 +13,10 @@ import com.google.android.gms.location.LocationRequest
 import com.google.android.gms.location.LocationResult
 import com.google.android.gms.location.LocationServices
 import com.google.android.gms.location.LocationSettingsRequest
+import com.google.android.gms.location.Priority
+import org.commcare.util.LogTypes
 import org.commcare.utils.GeoUtils.locationServicesEnabledGlobally
+import org.javarosa.core.services.Logger
 
 /**
  * @author $|-|!˅@M
@@ -25,15 +29,18 @@ class CommCareFusedLocationController(
     private val settingsClient = LocationServices.getSettingsClient(mContext!!)
     private val mLocationServiceChangeReceiver = LocationChangeReceiverBroadcast()
     private val mLocationRequest =
-        LocationRequest.create().apply {
-            priority = LocationRequest.PRIORITY_HIGH_ACCURACY
-            interval = LOCATION_UPDATE_INTERVAL
-        }
+        LocationRequest
+            .Builder(Priority.PRIORITY_HIGH_ACCURACY, LOCATION_UPDATE_INTERVAL)
+            .build()
     private var mCurrentLocation: Location? = null
     private val mLocationCallback =
         object : LocationCallback() {
             override fun onLocationResult(result: LocationResult) {
-                result ?: return
+                result.lastLocation ?: return
+                Logger.log(LogTypes.TYPE_MAINTENANCE, "Received location update")
+                if (shouldDiscardLocation(result.lastLocation!!)) {
+                    return
+                }
                 mCurrentLocation = result.lastLocation
                 mListener?.onLocationResult(mCurrentLocation!!)
             }
@@ -43,6 +50,7 @@ class CommCareFusedLocationController(
         const val LOCATION_UPDATE_INTERVAL = 5000L
     }
 
+    @SuppressLint("MissingPermission")
     private fun requestUpdates() {
         if (isLocationPermissionGranted(mContext)) {
             mFusedLocationClient.requestLocationUpdates(mLocationRequest, mLocationCallback, null)

app/src/org/commcare/location/CommCareLocationController.kt

@@ -6,6 +6,8 @@ import android.content.pm.PackageManager
 import android.location.Location
 import androidx.core.content.ContextCompat
 import org.commcare.CommCareApplication
+import org.commcare.preferences.HiddenPreferences
+import org.javarosa.core.services.Logger
 
 /**
  * @author $|-|!˅@M
@@ -17,8 +19,34 @@ interface CommCareLocationController {
     fun destroy()
 }
 
-fun CommCareLocationController.isLocationPermissionGranted(mContext: Context?): Boolean {
+const val DEFAULT_TIME_THRESHOLD = 2 * 60 * 1000L // 2 minutes in milliseconds
+
+fun isLocationPermissionGranted(mContext: Context?): Boolean {
     val context = mContext ?: CommCareApplication.instance()
     return ContextCompat.checkSelfPermission(context, Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED &&
             ContextCompat.checkSelfPermission(context, Manifest.permission.ACCESS_COARSE_LOCATION) == PackageManager.PERMISSION_GRANTED
 }
+
+fun isLocationFresh(location: Location, maxAgeMs: Long = DEFAULT_TIME_THRESHOLD): Boolean {
+    return System.currentTimeMillis() - location.time <= maxAgeMs
+}
+
+fun shouldDiscardLocation(location: Location): Boolean {
+    if(!isLocationFresh(location)) {
+        Logger.exception("Received a stale location", getStaleLocationException(location))
+        return HiddenPreferences.shouldDiscardStaleLocations()
+    }
+    return false
+}
+
+fun getStaleLocationException(location: Location): Throwable =
+    Exception(
+        "Stale location with accuracy ${location.accuracy}" +
+            " with time ${location.time}" + " and current device time ${System.currentTimeMillis()}"
+    )
+
+fun logStaleLocationSaved(location: Location) {
+    if (!isLocationFresh(location, DEFAULT_TIME_THRESHOLD)) {
+        Logger.exception("Stale location saved in GPS capture", getStaleLocationException(location))
+    }
+}

app/src/org/commcare/location/CommCareProviderLocationController.kt

@@ -9,8 +9,9 @@ import android.location.LocationListener
 import android.location.LocationManager
 import android.os.Build
 import android.os.Bundle
-import androidx.annotation.RequiresApi
+import org.commcare.util.LogTypes
 import org.commcare.utils.GeoUtils
+import org.javarosa.core.services.Logger
 
 /**
  * @author $|-|!˅@M
@@ -25,7 +26,10 @@ class CommCareProviderLocationController(private var mContext: Context?,
     private var mLocationRequestStarted = false
     private val mLocationListener = object: LocationListener {
         override fun onLocationChanged(location: Location) {
-            location ?: return
+            Logger.log(LogTypes.TYPE_MAINTENANCE, "Received location update")
+            if (shouldDiscardLocation(location)) {
+                return
+            }
             mCurrentLocation = location
             mListener?.onLocationResult(mCurrentLocation!!)
         }
@@ -105,4 +109,4 @@ class CommCareProviderLocationController(private var mContext: Context?,
         }
     }
 
-}
+}

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

@@ -110,6 +110,7 @@ public class HiddenPreferences {
     private static final String ENABLE_BACKGROUND_SYNC = "cc-enable-background-sync";
 
     private static final String ENABLE_CUSTOM_MAP_MARKER = "cc-enable-custom-map-marker";
+    private static final String DISCARD_STALE_LOCATIONS = "cc-discard-stale-locations";
 
     /**
      * The domain name in the application profile file comes in the <domain>.commcarehq.org form,
@@ -670,4 +671,10 @@ public static void clearInterruptedFormState() {
                 .remove(INTERRUPTED_FORM_INDEX + currentUserId)
                 .apply();
     }
+
+    public static boolean shouldDiscardStaleLocations() {
+        SharedPreferences properties = CommCareApplication.instance().getCurrentApp().getAppPreferences();
+        return properties.getString(DISCARD_STALE_LOCATIONS, PrefValues.NO).equals(PrefValues.YES);
+    }
+
 }