Added advanced query support in Nearby (commons-app#4714)

* Added feature for advanced query options in Nearby

* Fix unit-tests coverage

* wip-tests

* Added log to identify if the nearby request is via an advanced query

* Rolledback test-dependency updates

* Fix tests

* build fix

* Added basic tests for relevant method in OkHttpJsonApiClient & NearbyController

* Added NearbyParentFragmentPresenter Tests

* Added AdvancedQueryFragment Unit Tests

* Added more tests for NearbyParentFragmentPresenter

* Reset ContributionsFragment with Upstream

* Overload method loadNearbyPlaces for CustomQuery

* Added more tests

* Added more tests

* Fixed tests for NearbyParentFragmentPresenter

Author: ashishkumar468

app/src/main/java/fr/free/nrw/commons/location/LocationServiceManager.java

@@ -268,6 +268,7 @@ public enum LocationChangeType{
         LOCATION_NOT_CHANGED,
         PERMISSION_JUST_GRANTED,
         MAP_UPDATED,
-        SEARCH_CUSTOM_AREA
+        SEARCH_CUSTOM_AREA,
+        CUSTOM_QUERY
     }
 }

app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java

@@ -7,6 +7,7 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.gson.Gson;
+import fr.free.nrw.commons.auth.SessionManager;
 import fr.free.nrw.commons.campaigns.CampaignResponseDTO;
 import fr.free.nrw.commons.explore.depictions.DepictsClient;
 import fr.free.nrw.commons.location.LatLng;
@@ -265,14 +266,27 @@ public Single<FeedbackResponse> getAchievements(String userName) {
         });
     }
 
+    /**
+     * Make API Call to get Nearby Places
+     *
+     * @param cur                     Search lat long
+     * @param language                Language
+     * @param radius                  Search Radius
+     * @param shouldQueryForMonuments : Should we query for monuments
+     * @return
+     * @throws Exception
+     */
     @Nullable
     public List<Place> getNearbyPlaces(final LatLng cur, final String language, final double radius,
-        final boolean shouldQueryForMonuments)
+        final boolean shouldQueryForMonuments, final String customQuery)
         throws Exception {
 
         Timber.d("Fetching nearby items at radius %s", radius);
+        Timber.d("CUSTOM_SPARQL%s", String.valueOf(customQuery != null));
         final String wikidataQuery;
-        if (!shouldQueryForMonuments) {
+        if (customQuery != null) {
+            wikidataQuery = customQuery;
+        } else if (!shouldQueryForMonuments) {
             wikidataQuery = FileUtils.readFromResource("/queries/nearby_query.rq");
         } else {
             wikidataQuery = FileUtils.readFromResource("/queries/nearby_query_monuments.rq");
@@ -313,6 +327,23 @@ public List<Place> getNearbyPlaces(final LatLng cur, final String language, fina
         throw new Exception(response.message());
     }
 
+    /**
+     * Make API Call to get Nearby Places Implementation does not expects a custom query
+     *
+     * @param cur                     Search lat long
+     * @param language                Language
+     * @param radius                  Search Radius
+     * @param shouldQueryForMonuments : Should we query for monuments
+     * @return
+     * @throws Exception
+     */
+    @Nullable
+    public List<Place> getNearbyPlaces(final LatLng cur, final String language, final double radius,
+        final boolean shouldQueryForMonuments)
+        throws Exception {
+        return getNearbyPlaces(cur, language, radius, shouldQueryForMonuments, null);
+    }
+
     /**
      * Get the QIDs of all Wikidata items that are subclasses of the given Wikidata item. Example:
      * bridge -> suspended bridge, aqueduct, etc

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

@@ -5,6 +5,7 @@
 import android.graphics.Bitmap;
 
 import androidx.annotation.MainThread;
+import androidx.annotation.Nullable;
 import androidx.vectordrawable.graphics.drawable.VectorDrawableCompat;
 
 import com.mapbox.mapboxsdk.annotations.IconFactory;
@@ -54,12 +55,13 @@ public NearbyController(NearbyPlaces nearbyPlaces) {
      * @param curLatLng current location for user
      * @param searchLatLng the location user wants to search around
      * @param returnClosestResult if this search is done to find closest result or all results
+     * @param customQuery if this search is done via an advanced query
      * @return NearbyPlacesInfo a variable holds Place list without distance information
      * and boundary coordinates of current Place List
      */
     public NearbyPlacesInfo loadAttractionsFromLocation(final LatLng curLatLng, final LatLng searchLatLng,
         final boolean returnClosestResult, final boolean checkingAroundCurrentLocation,
-        final boolean shouldQueryForMonuments) throws Exception {
+        final boolean shouldQueryForMonuments, @Nullable final String customQuery) throws Exception {
 
         Timber.d("Loading attractions near %s", searchLatLng);
         NearbyPlacesInfo nearbyPlacesInfo = new NearbyPlacesInfo();
@@ -70,7 +72,7 @@ public NearbyPlacesInfo loadAttractionsFromLocation(final LatLng curLatLng, fina
         }
         List<Place> places = nearbyPlaces
             .radiusExpander(searchLatLng, Locale.getDefault().getLanguage(), returnClosestResult,
-                shouldQueryForMonuments);
+                shouldQueryForMonuments, customQuery);
 
         if (null != places && places.size() > 0) {
             LatLng[] boundaryCoordinates = {places.get(0).location,   // south
@@ -128,10 +130,27 @@ public NearbyPlacesInfo loadAttractionsFromLocation(final LatLng curLatLng, fina
             return nearbyPlacesInfo;
         }
         else {
-            return null;
+            return nearbyPlacesInfo;
         }
     }
 
+    /**
+     * Prepares Place list to make their distance information update later.
+     *
+     * @param curLatLng           current location for user
+     * @param searchLatLng        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(final LatLng curLatLng,
+        final LatLng searchLatLng,
+        final boolean returnClosestResult, final boolean checkingAroundCurrentLocation,
+        final boolean shouldQueryForMonuments) throws Exception {
+        return loadAttractionsFromLocation(curLatLng, searchLatLng, returnClosestResult,
+            checkingAroundCurrentLocation, shouldQueryForMonuments, null);
+    }
+
     /**
      * Loads attractions from location for list view, we need to return Place data type.
      *

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

@@ -1,5 +1,6 @@
 package fr.free.nrw.commons.nearby;
 
+import androidx.annotation.Nullable;
 import java.io.IOException;
 import java.util.Collections;
 import java.util.List;
@@ -38,10 +39,12 @@ public NearbyPlaces(OkHttpJsonApiClient okHttpJsonApiClient) {
      * @param curLatLng coordinates of search location
      * @param lang user's language
      * @param returnClosestResult true if only the nearest point is desired
+     * @param customQuery
      * @return list of places obtained
      */
-    List<Place> radiusExpander(final LatLng curLatLng, final String lang, final boolean returnClosestResult
-        , final boolean shouldQueryForMonuments) throws Exception {
+    List<Place> radiusExpander(final LatLng curLatLng, final String lang,
+        final boolean returnClosestResult
+        , final boolean shouldQueryForMonuments, @Nullable final String customQuery) throws Exception {
 
         final int minResults;
         final double maxRadius;
@@ -62,13 +65,12 @@ List<Place> radiusExpander(final LatLng curLatLng, final String lang, final bool
 
             // Increase the radius gradually to find a satisfactory number of nearby places
             while (radius <= maxRadius) {
-                places = getFromWikidataQuery(curLatLng, lang, radius, shouldQueryForMonuments);
+                places = getFromWikidataQuery(curLatLng, lang, radius, shouldQueryForMonuments, customQuery);
                 Timber.d("%d results at radius: %f", places.size(), radius);
                 if (places.size() >= minResults) {
                     break;
-                } else {
-                    radius *= RADIUS_MULTIPLIER;
                 }
+                radius *= RADIUS_MULTIPLIER;
             }
         // make sure we will be able to send at least one request next time
         if (radius > maxRadius) {
@@ -83,11 +85,14 @@ List<Place> radiusExpander(final LatLng curLatLng, final String lang, final bool
      * @param lang user's language
      * @param radius radius for search, as determined by radiusExpander()
      * @param shouldQueryForMonuments should the query include properites for monuments
+     * @param customQuery
      * @return list of places obtained
      * @throws IOException if query fails
      */
     public List<Place> getFromWikidataQuery(final LatLng cur, final String lang,
-        final double radius, final boolean shouldQueryForMonuments) throws Exception {
-        return okHttpJsonApiClient.getNearbyPlaces(cur, lang, radius, shouldQueryForMonuments);
+        final double radius, final boolean shouldQueryForMonuments,
+        @Nullable final String customQuery) throws Exception {
+        return okHttpJsonApiClient
+            .getNearbyPlaces(cur, lang, radius, shouldQueryForMonuments, customQuery);
     }
 }

app/src/main/java/fr/free/nrw/commons/nearby/contract/NearbyParentFragmentContract.java

@@ -2,13 +2,14 @@
 
 import android.content.Context;
 
+import androidx.annotation.Nullable;
 import com.mapbox.mapboxsdk.annotations.Marker;
 
+import fr.free.nrw.commons.location.LocationServiceManager.LocationChangeType;
 import java.util.List;
 
 import fr.free.nrw.commons.kvstore.JsonKvStore;
 import fr.free.nrw.commons.location.LatLng;
-import fr.free.nrw.commons.location.LocationServiceManager;
 import fr.free.nrw.commons.nearby.Label;
 import fr.free.nrw.commons.nearby.NearbyBaseMarker;
 import fr.free.nrw.commons.nearby.Place;
@@ -19,6 +20,7 @@ interface View {
         boolean isNetworkConnectionEstablished();
         void listOptionMenuItemClicked();
         void populatePlaces(LatLng curlatLng);
+        void populatePlaces(LatLng curlatLng, String customQuery);
         boolean isListBottomSheetExpanded();
         void checkPermissionsAndPerformAction();
         void displayLoginSkippedWarning();
@@ -62,7 +64,7 @@ interface View {
 
         LatLng getCameraTarget();
 
-        void centerMapToPlace(Place placeToCenter);
+        void centerMapToPlace(@Nullable Place placeToCenter);
 
         void updateListFragment(List<Place> placeList);
 
@@ -72,14 +74,20 @@ interface View {
 
         boolean isCurrentLocationMarkerVisible();
         void setProjectorLatLngBounds();
+
+        boolean isAdvancedQueryFragmentVisible();
+
+        void showHideAdvancedQueryFragment(boolean shouldShow);
+
+        void centerMapToPosition(@Nullable LatLng searchLatLng);
     }
 
     interface NearbyListView {
         void updateListFragment(List<Place> placeList);
     }
 
     interface UserActions {
-        void updateMapAndList(LocationServiceManager.LocationChangeType locationChangeType);
+        void updateMapAndList(LocationChangeType locationChangeType);
         void lockUnlockNearby(boolean isNearbyLocked);
 
         void attachView(View view);
@@ -96,5 +104,7 @@ interface UserActions {
 
         void searchViewGainedFocus();
         void setCheckboxUnknown();
+
+        void setAdvancedQuery(String query);
     }
 }

app/src/main/java/fr/free/nrw/commons/nearby/fragments/AdvanceQueryFragment.kt

@@ -0,0 +1,70 @@
+package fr.free.nrw.commons.nearby.fragments
+
+import android.content.Context.INPUT_METHOD_SERVICE
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import android.view.inputmethod.InputMethodManager
+import androidx.appcompat.widget.AppCompatButton
+import androidx.appcompat.widget.AppCompatEditText
+import androidx.fragment.app.Fragment
+import fr.free.nrw.commons.R
+import kotlinx.android.synthetic.main.fragment_advance_query.*
+
+class AdvanceQueryFragment : Fragment() {
+
+    lateinit var originalQuery: String
+    lateinit var callback: Callback
+    lateinit var etQuery: AppCompatEditText
+    lateinit var btnApply: AppCompatButton
+    lateinit var btnReset: AppCompatButton
+    override fun onCreateView(
+        inflater: LayoutInflater,
+        container: ViewGroup?,
+        savedInstanceState: Bundle?
+    ): View? {
+        val view = inflater.inflate(R.layout.fragment_advance_query, container, false)
+        originalQuery = arguments?.getString("query")!!
+        setHasOptionsMenu(false)
+        return view
+    }
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+        etQuery = view.findViewById(R.id.et_query)
+        btnApply = view.findViewById(R.id.btn_apply)
+        btnReset = view.findViewById(R.id.btn_reset)
+
+        etQuery.setText(originalQuery)
+        btnReset.setOnClickListener {
+            btnReset.post {
+                etQuery.setText(originalQuery)
+                etQuery.clearFocus()
+                hideKeyBoard()
+                callback.reset()
+            }
+        }
+
+        btnApply.setOnClickListener {
+            btnApply.post {
+                etQuery.clearFocus()
+                hideKeyBoard()
+                callback.apply(etQuery.text.toString())
+                callback.close()
+            }
+        }
+    }
+
+    fun hideKeyBoard() {
+        val inputMethodManager =
+            context?.getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager?
+        inputMethodManager?.hideSoftInputFromWindow(view?.windowToken, 0)
+    }
+
+    interface Callback {
+        fun reset()
+        fun apply(query: String)
+        fun close()
+    }
+}