Search this area (commons-app#2051)

* Recognize user is moving on the map and show a button

* Use variable from strings xml instead of hardcoded string

* Change search this area button location in xml file

* Add location util file to convert mapbox LatLng to commons Latlng and viceversa

* Populate places around searched area

* Update narby map according to new points came from searched area

* Add searchThisAreaMode boolean to stop nearby map updated when we try to search nearby areas.

* Lock auto nearby operations during serch this area mode, with a more modular method and decrease code repetition

* Add an if clausse to prevent multiple refresh view calls, while map is moving

* Disable map gestures during search this area operation, re-eable them on operation is done

* Add progress bar during search this area operation

* Make sure you locked the map during search nearby map process

* Implement recenter map view button

* Fix logic problem and make sure you refreshed the view on coming back to previous position

* Use custom refresh method instead

* Use latest updated location from location manager isntead

* Update ListFragment accordingly too

* Do not update camera target according to bottom sheet status or do not follow users location with camera, if search this area mode is on

* Add javadocs, sorry forgotten previously

* Remove unused method

* Threat both or search this area and regular search in same way

* Make sure distances are correct

* Seperate cutom location updates and current location updates from each other to continue other operations

* Remove all logs, and make sure search this are button is not visible for no reason while around of current location is already loaded

* Notify load attractions from location method about search status, current location of custom location

* Make sure we calculate searched area and display search this area button when we are out of 3/4 of total searched area

Author: neslihanturan

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

@@ -622,7 +622,7 @@ private void updateClosestNearbyCardViewInfo() {
         curLatLng = locationManager.getLastLocation();
 
         placesDisposable = Observable.fromCallable(() -> nearbyController
-                .loadAttractionsFromLocation(curLatLng, true)) // thanks to boolean, it will only return closest result
+                .loadAttractionsFromLocation(curLatLng, curLatLng, true, false)) // thanks to boolean, it will only return closest result
                 .subscribeOn(Schedulers.io())
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(this::updateNearbyNotification,

app/src/main/java/fr/free/nrw/commons/nearby/NearbyController.java

@@ -5,6 +5,7 @@
 import android.content.res.Resources;
 import android.graphics.Bitmap;
 import android.support.graphics.drawable.VectorDrawableCompat;
+import android.util.Log;
 
 import com.mapbox.mapboxsdk.annotations.IconFactory;
 
@@ -31,6 +32,8 @@ public class NearbyController {
     private static final int MAX_RESULTS = 1000;
     private final NearbyPlaces nearbyPlaces;
     private final SharedPreferences prefs;
+    public static double searchedRadius = 10.0; //in kilometers
+    public static LatLng currentLocation;
 
     @Inject
     public NearbyController(NearbyPlaces nearbyPlaces,
@@ -44,18 +47,21 @@ public NearbyController(NearbyPlaces nearbyPlaces,
      * Prepares Place list to make their distance information update later.
      *
      * @param curLatLng current location for user
+     * @param latLangToSearchAround the location user wants to search around
+     * @param returnClosestResult if this search is done to find closest result or all results
      * @return NearbyPlacesInfo a variable holds Place list without distance information
      * and boundary coordinates of current Place List
      */
-    public NearbyPlacesInfo loadAttractionsFromLocation(LatLng curLatLng, boolean returnClosestResult) throws IOException {
-        Timber.d("Loading attractions near %s", curLatLng);
+    public NearbyPlacesInfo loadAttractionsFromLocation(LatLng curLatLng, LatLng latLangToSearchAround, boolean returnClosestResult, boolean checkingAroundCurrentLocation) throws IOException {
+
+        Timber.d("Loading attractions near %s", latLangToSearchAround);
         NearbyPlacesInfo nearbyPlacesInfo = new NearbyPlacesInfo();
 
-        if (curLatLng == null) {
+        if (latLangToSearchAround == null) {
             Timber.d("Loading attractions neari, but curLatLng is null");
             return null;
         }
-        List<Place> places = nearbyPlaces.getFromWikidataQuery(curLatLng, Locale.getDefault().getLanguage(), returnClosestResult);
+        List<Place> places = nearbyPlaces.getFromWikidataQuery(latLangToSearchAround, Locale.getDefault().getLanguage(), returnClosestResult);
 
         if (null != places && places.size() > 0) {
             LatLng[] boundaryCoordinates = {places.get(0).location,   // south
@@ -93,6 +99,11 @@ public NearbyPlacesInfo loadAttractionsFromLocation(LatLng curLatLng, boolean re
             }
             nearbyPlacesInfo.placeList = places;
             nearbyPlacesInfo.boundaryCoordinates = boundaryCoordinates;
+            if (!returnClosestResult && checkingAroundCurrentLocation) {
+                // Do not update searched radius, if controller is used for nearby card notification
+                searchedRadius = nearbyPlaces.radius;
+                currentLocation = curLatLng;
+            }
             return nearbyPlacesInfo;
         }
         else {

app/src/main/java/fr/free/nrw/commons/nearby/NearbyFragment.java

@@ -14,6 +14,7 @@
 import android.support.design.widget.Snackbar;
 import android.support.v4.app.FragmentTransaction;
 import android.support.v7.app.AlertDialog;
+import android.util.Log;
 import android.view.LayoutInflater;
 
 import android.view.View;
@@ -64,8 +65,6 @@ public class NearbyFragment extends CommonsDaggerSupportFragment
     LinearLayout bottomSheetDetails;
     @BindView(R.id.transparentView)
     View transparentView;
-    @BindView(R.id.fab_recenter)
-    View fabRecenter;
 
     @Inject
     LocationServiceManager locationManager;
@@ -87,16 +86,19 @@ public class NearbyFragment extends CommonsDaggerSupportFragment
 
     private LatLng curLatLng;
     private Disposable placesDisposable;
+    private Disposable placesDisposableCustom;
     private boolean lockNearbyView; //Determines if the nearby places needs to be refreshed
     public View view;
     private Snackbar snackbar;
 
     private LatLng lastKnownLocation;
+    private LatLng customLatLng;
 
     private final String NETWORK_INTENT_ACTION = "android.net.conn.CONNECTIVITY_CHANGE";
     private BroadcastReceiver broadcastReceiver;
 
     private boolean onOrientationChanged = false;
+    private boolean populateForCurrentLocation = false;
 
     @Override
     public void onCreate(@Nullable Bundle savedInstanceState) {
@@ -216,32 +218,35 @@ public void prepareViewsForSheetPosition(int bottomSheetState) {
 
     @Override
     public void onLocationChangedSignificantly(LatLng latLng) {
-        refreshView(LOCATION_SIGNIFICANTLY_CHANGED);
+            refreshView(LOCATION_SIGNIFICANTLY_CHANGED);
     }
 
     @Override
     public void onLocationChangedSlightly(LatLng latLng) {
-        refreshView(LOCATION_SLIGHTLY_CHANGED);
+            refreshView(LOCATION_SLIGHTLY_CHANGED);
     }
 
 
     @Override
     public void onLocationChangedMedium(LatLng latLng) {
         // For nearby map actions, there are no differences between 500 meter location change (aka medium change) and slight change
-        refreshView(LOCATION_SLIGHTLY_CHANGED);
+            refreshView(LOCATION_SLIGHTLY_CHANGED);
     }
 
     @Override
     public void onWikidataEditSuccessful() {
-        refreshView(MAP_UPDATED);
+        // Do not refresh nearby map if we are checking other areas with search this area button
+        if (!nearbyMapFragment.searchThisAreaModeOn) {
+            refreshView(MAP_UPDATED);
+        }
     }
 
     /**
      * This method should be the single point to load/refresh nearby places
      *
      * @param locationChangeType defines if location shanged significantly or slightly
      */
-    private void refreshView(LocationServiceManager.LocationChangeType locationChangeType) {
+    public void refreshView(LocationServiceManager.LocationChangeType locationChangeType) {
         Timber.d("Refreshing nearby places");
         if (lockNearbyView) {
             return;
@@ -257,9 +262,11 @@ private void refreshView(LocationServiceManager.LocationChangeType locationChang
 
         if (curLatLng != null && curLatLng.equals(lastLocation)
                 && !locationChangeType.equals(MAP_UPDATED)) { //refresh view only if location has changed
+            // Two exceptional cases to refresh nearby map manually.
             if (!onOrientationChanged) {
                 return;
             }
+
         }
         curLatLng = lastLocation;
 
@@ -292,7 +299,7 @@ private void refreshView(LocationServiceManager.LocationChangeType locationChang
             bundle.putString("CurLatLng", gsonCurLatLng);
 
             placesDisposable = Observable.fromCallable(() -> nearbyController
-                    .loadAttractionsFromLocation(curLatLng, false))
+                    .loadAttractionsFromLocation(curLatLng, curLatLng, false, true))
                     .subscribeOn(Schedulers.io())
                     .observeOn(AndroidSchedulers.mainThread())
                     .subscribe(this::populatePlaces,
@@ -301,14 +308,70 @@ private void refreshView(LocationServiceManager.LocationChangeType locationChang
                                 showErrorMessage(getString(R.string.error_fetching_nearby_places));
                                 progressBar.setVisibility(View.GONE);
                             });
+
         } else if (locationChangeType
                 .equals(LOCATION_SLIGHTLY_CHANGED)) {
             Gson gson = new GsonBuilder()
                     .registerTypeAdapter(Uri.class, new UriSerializer())
                     .create();
             String gsonCurLatLng = gson.toJson(curLatLng);
             bundle.putString("CurLatLng", gsonCurLatLng);
-            updateMapFragment(true);
+            updateMapFragment(false,true, null, null);
+        }
+
+        if (nearbyMapFragment != null) {
+            nearbyMapFragment.searchThisAreaButton.setVisibility(View.GONE);
+        }
+    }
+
+    /**
+     * This method should be used with "Search this are button". This method will search nearby
+     * points around any custom location (target location when user clicked on search this area)
+     * button. It populates places for custom location.
+     * @param customLatLng Custom area which we will search around
+     */
+    public void refreshViewForCustomLocation(LatLng customLatLng, boolean refreshForCurrentLocation) {
+
+        if (customLatLng == null) {
+            // If null, return
+            return;
+        }
+
+        populateForCurrentLocation = refreshForCurrentLocation;
+        this.customLatLng = customLatLng;
+        placesDisposableCustom = Observable.fromCallable(() -> nearbyController
+                .loadAttractionsFromLocation(curLatLng, customLatLng, false, populateForCurrentLocation))
+                .subscribeOn(Schedulers.io())
+                .observeOn(AndroidSchedulers.mainThread())
+                .subscribe(this::populatePlacesFromCustomLocation,
+                        throwable -> {
+                            Timber.d(throwable);
+                            showErrorMessage(getString(R.string.error_fetching_nearby_places));
+                        });
+
+        if (nearbyMapFragment != null) {
+            nearbyMapFragment.searchThisAreaButton.setVisibility(View.GONE);
+        }
+    }
+
+    /**
+     * Populates places for custom location, should be used for finding nearby places around a
+     * location where you are not at.
+     * @param nearbyPlacesInfo This variable has place list information and distances.
+     */
+    private void populatePlacesFromCustomLocation(NearbyController.NearbyPlacesInfo nearbyPlacesInfo) {
+        //NearbyMapFragment nearbyMapFragment = getMapFragment();
+        if (nearbyMapFragment != null) {
+            nearbyMapFragment.searchThisAreaButtonProgressBar.setVisibility(View.GONE);
+        }
+
+        if (nearbyMapFragment != null && curLatLng != null) {
+            if (!populateForCurrentLocation) {
+                nearbyMapFragment.updateMapSignificantlyForCustomLocation(customLatLng, nearbyPlacesInfo.placeList);
+            } else {
+                updateMapFragment(true,true, customLatLng, nearbyPlacesInfo);
+            }
+            updateListFragmentForCustomLocation(nearbyPlacesInfo.placeList);
         }
     }
 
@@ -342,7 +405,7 @@ private void populatePlaces(NearbyController.NearbyPlacesInfo nearbyPlacesInfo)
         } else {
             // There are fragments, just update the map and list
             Timber.d("Map fragment already exists, just update the map and list");
-            updateMapFragment(false);
+            updateMapFragment(false,false, null, null);
             updateListFragment();
         }
     }
@@ -364,7 +427,11 @@ private void lockNearbyView(boolean lock) {
         }
     }
 
-    private void updateMapFragment(boolean isSlightUpdate) {
+    private void updateMapFragment(boolean updateViaButton, boolean isSlightUpdate, @Nullable LatLng customLatLng, @Nullable NearbyController.NearbyPlacesInfo nearbyPlacesInfo) {
+
+        if (nearbyMapFragment.searchThisAreaModeOn) {
+            return;
+        }
         /*
         Significant update means updating nearby place markers. Slightly update means only
         updating current location marker and camera target.
@@ -380,14 +447,14 @@ private void updateMapFragment(boolean isSlightUpdate) {
              * If we are close to nearby places boundaries, we need a significant update to
              * get new nearby places. Check order is south, north, west, east
              * */
-            if (nearbyMapFragment.boundaryCoordinates != null
+            if (nearbyMapFragment.boundaryCoordinates != null && !nearbyMapFragment.searchThisAreaModeOn
                     && (curLatLng.getLatitude() <= nearbyMapFragment.boundaryCoordinates[0].getLatitude()
                     || curLatLng.getLatitude() >= nearbyMapFragment.boundaryCoordinates[1].getLatitude()
                     || curLatLng.getLongitude() <= nearbyMapFragment.boundaryCoordinates[2].getLongitude()
                     || curLatLng.getLongitude() >= nearbyMapFragment.boundaryCoordinates[3].getLongitude())) {
                 // populate places
                 placesDisposable = Observable.fromCallable(() -> nearbyController
-                        .loadAttractionsFromLocation(curLatLng, false))
+                        .loadAttractionsFromLocation(curLatLng, curLatLng, false, updateViaButton))
                         .subscribeOn(Schedulers.io())
                         .observeOn(AndroidSchedulers.mainThread())
                         .subscribe(this::populatePlaces,
@@ -397,11 +464,16 @@ private void updateMapFragment(boolean isSlightUpdate) {
                                     progressBar.setVisibility(View.GONE);
                                 });
                 nearbyMapFragment.setBundleForUpdtes(bundle);
-                nearbyMapFragment.updateMapSignificantly();
+                nearbyMapFragment.updateMapSignificantlyForCurrentLocation();
                 updateListFragment();
                 return;
             }
 
+            if (updateViaButton) {
+                nearbyMapFragment.updateMapSignificantlyForCustomLocation(customLatLng, nearbyPlacesInfo.placeList);
+                return;
+            }
+
             /*
             If this is the map update just after orientation change, then it is not a slight update
             anymore. We want to significantly update map after each orientation change
@@ -416,7 +488,7 @@ private void updateMapFragment(boolean isSlightUpdate) {
                 nearbyMapFragment.updateMapSlightly();
             } else {
                 nearbyMapFragment.setBundleForUpdtes(bundle);
-                nearbyMapFragment.updateMapSignificantly();
+                nearbyMapFragment.updateMapSignificantlyForCurrentLocation();
                 updateListFragment();
             }
         } else {
@@ -433,6 +505,15 @@ private void updateListFragment() {
         nearbyListFragment.updateNearbyListSignificantly();
     }
 
+    /**
+     * Updates nearby list for custom location, will be used with search this area method. When you
+     * want to search for a place where you are not at.
+     * @param placeList List of places around your manually chosen target location from map.
+     */
+    private void updateListFragmentForCustomLocation(List<Place> placeList) {
+        nearbyListFragment.updateNearbyListSignificantlyForCustomLocation(placeList);
+    }
+
     /**
      * Calls fragment for map view.
      */
@@ -650,6 +731,9 @@ public void onDestroy() {
         if (placesDisposable != null) {
             placesDisposable.dispose();
         }
+        if (placesDisposableCustom != null) {
+            placesDisposableCustom.dispose();
+        }
     }
 
     @Override

app/src/main/java/fr/free/nrw/commons/nearby/NearbyListFragment.java

@@ -98,6 +98,19 @@ public void updateNearbyListSignificantly() {
         }
     }
 
+    /**
+     * While nearby updates for current location held with bundle, automatically, custom updates are
+     * done by calling this methods, triddered by search this are button input from user.
+     * @param placeList
+     */
+    public void updateNearbyListSignificantlyForCustomLocation(List<Place> placeList) {
+        try {
+            adapterFactory.updateAdapterData(placeList, (RVRendererAdapter<Place>) recyclerView.getAdapter());
+        } catch (NullPointerException e) {
+            Timber.e("Null pointer exception from calling recyclerView.getAdapter()");
+        }
+    }
+
     private List<Place> getPlaceListFromBundle(Bundle bundle) {
         List<Place> placeList = Collections.emptyList();