Fixes Location related flow of the app #5256 , #5461, #5490 (#5494)

* Resolved merged conflicts

* Resolved merge conflicts and updated workflow

* Updated Location Flow and merged conflicts

* Update flow and merge conflicts

* Fixed LocationPicker's location flow

* Removed redundant code from  LocationPermissionsHelper

* Fixed Explore fragment crashing and incorrect behaviour

* Updated LocationPicker Flow

* Fixed Nearby not working as intended

* Final update to location flow of all maps

* Added the reqested changes and fixed bugs

* Resolved requested change in in-app camera location flow

* Fixed In-app camera location flow

* Resolved conflicts in ContributionsListFragment

* Updated java doc as requested

* Resolved nearby card dialog not being shown

* Optimised LocationPermissionsHelper javadoc

* Made requested changes for preference check

* Added javadoc and requested comment for later reference

* Implemented requested code changes

* Fixed failing test due to changes made during PR

* Added string resource for ExploreMapFragment

* Changed string resource for rationale dialog

* Added standard location flow information in LocationPermissionsHelper

* Added javadoc for doNotAskForLocationPermission

* Removed unused import

* Updated javadoc

* Removed values-yue-hant

* Fix some merge conflict errors

* Fix minor errors due to mergre conflicts

* Fix some refactor errors

* Fixed minor bug due to merging conflicts

* Delete app/src/main/res/values-yue-hant directory

* Final changes to NearbyParentFragment

* Fixes #5686 map coordinates set to image coords

* Removed some redundant code from recenterMap

* Removed one test whose method no longer exists

* Removed unused method from contract of nearby

* Removed redundant method from NearbyParentFragment

* nearby: add a FIXME about the possibly redudant code

---------

Co-authored-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>

Author: ShashwatKedia

app/src/main/java/fr/free/nrw/commons/LocationPicker/LocationPickerActivity.java

@@ -4,12 +4,14 @@
 import static fr.free.nrw.commons.upload.mediaDetails.UploadMediaDetailFragment.LAST_ZOOM;
 import static fr.free.nrw.commons.utils.MapUtils.ZOOM_LEVEL;
 
+import android.Manifest.permission;
 import android.annotation.SuppressLint;
 import android.content.Intent;
 import android.content.pm.PackageManager;
 import android.graphics.Color;
 import android.graphics.Paint;
 import android.graphics.drawable.Drawable;
+import android.location.LocationManager;
 import android.os.Bundle;
 import android.preference.PreferenceManager;
 import android.text.Html;
@@ -21,12 +23,14 @@
 import android.widget.Button;
 import android.widget.ImageView;
 import android.widget.TextView;
+import android.widget.Toast;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.appcompat.app.ActionBar;
 import androidx.appcompat.app.AppCompatActivity;
 import androidx.appcompat.widget.AppCompatTextView;
 import androidx.constraintlayout.widget.ConstraintLayout;
+import androidx.core.app.ActivityCompat;
 import androidx.core.content.ContextCompat;
 import com.google.android.material.floatingactionbutton.FloatingActionButton;
 import fr.free.nrw.commons.CameraPosition;
@@ -39,9 +43,9 @@
 import fr.free.nrw.commons.auth.csrf.InvalidLoginTokenException;
 import fr.free.nrw.commons.coordinates.CoordinateEditHelper;
 import fr.free.nrw.commons.filepicker.Constants;
+import fr.free.nrw.commons.kvstore.BasicKvStore;
 import fr.free.nrw.commons.kvstore.JsonKvStore;
 import fr.free.nrw.commons.location.LocationPermissionsHelper;
-import fr.free.nrw.commons.location.LocationPermissionsHelper.Dialog;
 import fr.free.nrw.commons.location.LocationPermissionsHelper.LocationPermissionCallback;
 import fr.free.nrw.commons.location.LocationServiceManager;
 import fr.free.nrw.commons.theme.BaseActivity;
@@ -135,6 +139,7 @@ public class LocationPickerActivity extends BaseActivity implements
     @Named("default_preferences")
     public
     JsonKvStore applicationKvStore;
+    BasicKvStore store;
     /**
      * isDarkTheme: for keeping a track of the device theme and modifying the map theme accordingly
      */
@@ -145,6 +150,8 @@ public class LocationPickerActivity extends BaseActivity implements
 
     @Inject
     LocationServiceManager locationManager;
+    LocationPermissionsHelper locationPermissionsHelper;
+
     @Inject
     SessionManager sessionManager;
 
@@ -163,6 +170,7 @@ protected void onCreate(@Nullable final Bundle savedInstanceState) {
 
         isDarkTheme = systemThemeUtils.isDeviceInNightMode();
         moveToCurrentLocation = false;
+        store = new BasicKvStore(this, "LocationPermissions");
 
         getWindow().requestFeature(Window.FEATURE_ACTION_BAR);
         final ActionBar actionBar = getSupportActionBar();
@@ -482,19 +490,10 @@ private void removeSelectedLocationMarker() {
      * Center the map at user's current location
      */
     private void requestLocationPermissions() {
-        LocationPermissionsHelper.Dialog locationAccessDialog = new Dialog(
-            R.string.location_permission_title,
-            R.string.upload_map_location_access
-        );
-
-        LocationPermissionsHelper.Dialog locationOffDialog = new Dialog(
-            R.string.ask_to_turn_location_on,
-            R.string.upload_map_location_access
-        );
-        LocationPermissionsHelper locationPermissionsHelper = new LocationPermissionsHelper(
+        locationPermissionsHelper = new LocationPermissionsHelper(
             this, locationManager, this);
-        locationPermissionsHelper.handleLocationPermissions(locationAccessDialog,
-            locationOffDialog);
+        locationPermissionsHelper.requestForLocationAccess(R.string.location_permission_title,
+            R.string.upload_map_location_access);
     }
 
     @Override
@@ -505,7 +504,7 @@ public void onRequestPermissionsResult(final int requestCode,
             && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
             onLocationPermissionGranted();
         } else {
-            onLocationPermissionDenied("");
+            onLocationPermissionDenied(getString(R.string.upload_map_location_access));
         }
         super.onRequestPermissionsResult(requestCode, permissions, grantResults);
     }
@@ -524,21 +523,50 @@ protected void onPause() {
 
     @Override
     public void onLocationPermissionDenied(String toastMessage) {
-        //do nothing
+        if (!ActivityCompat.shouldShowRequestPermissionRationale(this,
+            permission.ACCESS_FINE_LOCATION)) {
+            if (!locationPermissionsHelper.checkLocationPermission(this)) {
+                if (store.getBoolean("isPermissionDenied", false)) {
+                    // means user has denied location permission twice or checked the "Don't show again"
+                    locationPermissionsHelper.showAppSettingsDialog(this,
+                        R.string.upload_map_location_access);
+                } else {
+                    Toast.makeText(getBaseContext(), toastMessage, Toast.LENGTH_LONG).show();
+                }
+                store.putBoolean("isPermissionDenied", true);
+            }
+        } else {
+            Toast.makeText(getBaseContext(), toastMessage, Toast.LENGTH_LONG).show();
+        }
     }
 
     @Override
     public void onLocationPermissionGranted() {
+        if (moveToCurrentLocation || !(activity.equals("MediaActivity"))) {
+            if (locationPermissionsHelper.isLocationAccessToAppsTurnedOn()) {
+                locationManager.requestLocationUpdatesFromProvider(
+                    LocationManager.NETWORK_PROVIDER);
+                locationManager.requestLocationUpdatesFromProvider(LocationManager.GPS_PROVIDER);
+                getLocation();
+            } else {
+                getLocation();
+                locationPermissionsHelper.showLocationOffDialog(this,
+                    R.string.ask_to_turn_location_on_text);
+            }
+        }
+    }
+
+    /**
+     * Gets new location if locations services are on, else gets last location
+     */
+    private void getLocation() {
         fr.free.nrw.commons.location.LatLng currLocation = locationManager.getLastLocation();
         if (currLocation != null) {
             GeoPoint currLocationGeopoint = new GeoPoint(currLocation.getLatitude(),
                 currLocation.getLongitude());
             addLocationMarker(currLocationGeopoint);
-            if (moveToCurrentLocation) {
-                mapView.getController().setCenter(currLocationGeopoint);
-                mapView.getController().animateTo(currLocationGeopoint);
-                moveToCurrentLocation = false;
-            }
+            mapView.getController().setCenter(currLocationGeopoint);
+            mapView.getController().animateTo(currLocationGeopoint);
             markerImage.setTranslationY(0);
         }
     }

app/src/main/java/fr/free/nrw/commons/bookmarks/locations/BookmarkLocationsFragment.java

@@ -45,7 +45,7 @@ public void onActivityResult(Map<String, Boolean> result) {
                 contributionController.locationPermissionCallback.onLocationPermissionGranted();
             } else {
                 if (shouldShowRequestPermissionRationale(permission.ACCESS_FINE_LOCATION)) {
-                    contributionController.handleShowRationaleFlowCameraLocation(getActivity());
+                    contributionController.handleShowRationaleFlowCameraLocation(getActivity(), inAppCameraLocationPermissionLauncher);
                 } else {
                     contributionController.locationPermissionCallback.onLocationPermissionDenied(getActivity().getString(R.string.in_app_camera_location_permission_denied));
                 }

app/src/main/java/fr/free/nrw/commons/contributions/ContributionController.java

@@ -17,7 +17,6 @@
 import fr.free.nrw.commons.kvstore.JsonKvStore;
 import fr.free.nrw.commons.location.LatLng;
 import fr.free.nrw.commons.location.LocationPermissionsHelper;
-import fr.free.nrw.commons.location.LocationPermissionsHelper.Dialog;
 import fr.free.nrw.commons.location.LocationPermissionsHelper.LocationPermissionCallback;
 import fr.free.nrw.commons.location.LocationServiceManager;
 import fr.free.nrw.commons.nearby.Place;
@@ -84,15 +83,6 @@ public void initiateCameraPick(Activity activity,
      */
     private void createDialogsAndHandleLocationPermissions(Activity activity,
         ActivityResultLauncher<String[]> inAppCameraLocationPermissionLauncher) {
-        LocationPermissionsHelper.Dialog locationAccessDialog = new Dialog(
-            R.string.location_permission_title,
-            R.string.in_app_camera_location_permission_rationale
-        );
-
-        LocationPermissionsHelper.Dialog locationOffDialog = new Dialog(
-            R.string.ask_to_turn_location_on,
-            R.string.in_app_camera_needs_location
-        );
         locationPermissionCallback = new LocationPermissionCallback() {
             @Override
             public void onLocationPermissionDenied(String toastMessage) {
@@ -106,7 +96,12 @@ public void onLocationPermissionDenied(String toastMessage) {
 
             @Override
             public void onLocationPermissionGranted() {
-                initiateCameraUpload(activity);
+                if (!locationPermissionsHelper.isLocationAccessToAppsTurnedOn()) {
+                    showLocationOffDialog(activity, R.string.in_app_camera_needs_location,
+                        R.string.in_app_camera_location_unavailable);
+                } else {
+                    initiateCameraUpload(activity);
+                }
             }
         };
 
@@ -115,22 +110,46 @@ public void onLocationPermissionGranted() {
         if (inAppCameraLocationPermissionLauncher != null) {
             inAppCameraLocationPermissionLauncher.launch(
                 new String[]{permission.ACCESS_FINE_LOCATION});
-        } else {
-            locationPermissionsHelper.handleLocationPermissions(locationAccessDialog,
-                locationOffDialog);
         }
 
     }
 
-    public void handleShowRationaleFlowCameraLocation(Activity activity) {
+    /**
+     * Shows a dialog alerting the user about location services being off
+     * and asking them to turn it on
+     * TODO: Add a seperate callback in LocationPermissionsHelper for this.
+     *      Ref: https://github.com/commons-app/apps-android-commons/pull/5494/files#r1510553114
+     *
+     * @param activity Activity reference
+     * @param dialogTextResource Resource id of text to be shown in dialog
+     * @param toastTextResource Resource id of text to be shown in toast
+     */
+    private void showLocationOffDialog(Activity activity, int dialogTextResource,
+        int toastTextResource) {
+        DialogUtil
+            .showAlertDialog(activity,
+                activity.getString(R.string.ask_to_turn_location_on),
+                activity.getString(dialogTextResource),
+                activity.getString(R.string.title_app_shortcut_setting),
+                activity.getString(R.string.cancel),
+                () -> locationPermissionsHelper.openLocationSettings(activity),
+                () -> {
+                    Toast.makeText(activity, activity.getString(toastTextResource),
+                        Toast.LENGTH_LONG).show();
+                    initiateCameraUpload(activity);
+                }
+            );
+    }
+
+    public void handleShowRationaleFlowCameraLocation(Activity activity,
+        ActivityResultLauncher<String[]> inAppCameraLocationPermissionLauncher) {
         DialogUtil.showAlertDialog(activity, activity.getString(R.string.location_permission_title),
             activity.getString(R.string.in_app_camera_location_permission_rationale),
             activity.getString(android.R.string.ok),
             activity.getString(android.R.string.cancel),
             () -> {
-                if (!locationPermissionsHelper.isLocationAccessToAppsTurnedOn()) {
-                    locationPermissionsHelper.showLocationOffDialog(activity);
-                }
+                createDialogsAndHandleLocationPermissions(activity,
+                    inAppCameraLocationPermissionLauncher);
             },
             () -> locationPermissionCallback.onLocationPermissionDenied(
                 activity.getString(R.string.in_app_camera_location_permission_denied)),
@@ -162,6 +181,7 @@ private void askUserToAllowLocationAccess(Activity activity,
                     inAppCameraLocationPermissionLauncher);
             },
             () -> {
+                ViewUtil.showLongToast(activity, R.string.in_app_camera_location_permission_denied);
                 defaultKvStore.putBoolean("inAppCameraLocationPref", false);
                 initiateCameraUpload(activity);
             },

app/src/main/java/fr/free/nrw/commons/contributions/ContributionsFragment.java

@@ -147,21 +147,20 @@ public void onActivityResult(Map<String, Boolean> result) {
                     areAllGranted = areAllGranted && b;
                 }
 
-                if (areAllGranted) {
-                    onLocationPermissionGranted();
+            if (areAllGranted) {
+                onLocationPermissionGranted();
+            } else {
+                if (shouldShowRequestPermissionRationale(Manifest.permission.ACCESS_FINE_LOCATION)
+                    && store.getBoolean("displayLocationPermissionForCardView", true)
+                    && !store.getBoolean("doNotAskForLocationPermission", false)
+                    && (((MainActivity) getActivity()).activeFragment == ActiveFragment.CONTRIBUTIONS)) {
+                    binding.cardViewNearby.permissionType = NearbyNotificationCardView.PermissionType.ENABLE_LOCATION_PERMISSION;
                 } else {
-                    if (shouldShowRequestPermissionRationale(Manifest.permission.ACCESS_FINE_LOCATION)
-                        && store.getBoolean("displayLocationPermissionForCardView", true)
-                        && !store.getBoolean("doNotAskForLocationPermission", false)
-                        && (((MainActivity) getActivity()).activeFragment == ActiveFragment.CONTRIBUTIONS)) {
-                        binding.cardViewNearby.permissionType = NearbyNotificationCardView.PermissionType.ENABLE_LOCATION_PERMISSION;
-                        showNearbyCardPermissionRationale();
-                    } else {
-                        displayYouWontSeeNearbyMessage();
-                    }
+                    displayYouWontSeeNearbyMessage();
                 }
             }
-        });
+        }
+    });
 
     @NonNull
     public static ContributionsFragment newInstance() {
@@ -537,6 +536,7 @@ private void showNearbyCardPermissionRationale() {
     private void displayYouWontSeeNearbyMessage() {
         ViewUtil.showLongToast(getActivity(),
             getResources().getString(R.string.unable_to_display_nearest_place));
+        // Set to true as the user doesn't want the app to ask for location permission anymore
         store.putBoolean("doNotAskForLocationPermission", true);
     }
 

app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java

@@ -98,26 +98,30 @@ public class ContributionsListFragment extends CommonsDaggerSupportFragment impl
     private int contributionsSize;
     private String userName;
 
-    private ActivityResultLauncher<String[]> inAppCameraLocationPermissionLauncher = registerForActivityResult(new ActivityResultContracts.RequestMultiplePermissions(), new ActivityResultCallback<Map<String, Boolean>>() {
-        @Override
-        public void onActivityResult(Map<String, Boolean> result) {
-            boolean areAllGranted = true;
-            for (final boolean b : result.values()) {
-                areAllGranted = areAllGranted && b;
-            }
+    private ActivityResultLauncher<String[]> inAppCameraLocationPermissionLauncher = registerForActivityResult(
+        new ActivityResultContracts.RequestMultiplePermissions(),
+        new ActivityResultCallback<Map<String, Boolean>>() {
+            @Override
+            public void onActivityResult(Map<String, Boolean> result) {
+                boolean areAllGranted = true;
+                for (final boolean b : result.values()) {
+                    areAllGranted = areAllGranted && b;
+                }
 
-            if (areAllGranted) {
-                controller.locationPermissionCallback.onLocationPermissionGranted();
-            } else {
-                if (shouldShowRequestPermissionRationale(permission.ACCESS_FINE_LOCATION)) {
-                    controller.handleShowRationaleFlowCameraLocation(getActivity());
+                if (areAllGranted) {
+                    controller.locationPermissionCallback.onLocationPermissionGranted();
                 } else {
-                    controller.locationPermissionCallback.onLocationPermissionDenied(
-                        getActivity().getString(R.string.in_app_camera_location_permission_denied));
+                    if (shouldShowRequestPermissionRationale(permission.ACCESS_FINE_LOCATION)) {
+                        controller.handleShowRationaleFlowCameraLocation(getActivity(),
+                            inAppCameraLocationPermissionLauncher);
+                    } else {
+                        controller.locationPermissionCallback.onLocationPermissionDenied(
+                            getActivity().getString(
+                                R.string.in_app_camera_location_permission_denied));
+                    }
                 }
             }
-        }
-    });
+        });
 
 
     @Override

app/src/main/java/fr/free/nrw/commons/explore/map/ExploreMapContract.java

@@ -11,11 +11,9 @@ public class ExploreMapContract {
 
     interface View {
         boolean isNetworkConnectionEstablished();
-        void populatePlaces(LatLng currentLatLng);
-        void checkPermissionsAndPerformAction();
-        void recenterMap(LatLng currentLatLng);
-        void showLocationOffDialog();
-        void openLocationSettings();
+        void populatePlaces(LatLng curlatLng);
+        void askForLocationPermission();
+        void recenterMap(LatLng curLatLng);
         void hideBottomDetailsSheet();
         LatLng getMapCenter();
         LatLng getMapFocus();