Made Split to Nearby Query into a fast query for coordinates + a details query for each pin (#5731)

* Splitted the query

* Made changes to the query

* Improvised query

* Improvised query by dividing in the batches

* Fixed failing tests

* Improved batches

* Improved sorting

* Fixes issue caused by search this area button

* Fixed failing tests

* Fixed unnecessary reloads on onResume

* Fixed few pins not loading on changing apps

* Improved zoom level and fixed the pins not loading from the center

* Removed toggle chips and changed pin's color

* Fixed wikidata url

* Fixed unit tests

* Implemented retry with delay of 5000ms

* Fixed exception issue and pins issue

* Added change color icon to pin

* Improved pin clicking

* Removed search this area button

* Implemented caching of places

* Fixed unit test

* Factorized methods

* Changed primary key from location to entity id

* Fixed tests

* Fixed conflicts

* Fixed unit test

* Fixed unit test

* Fixed the bug

* Fixed issue with pin loading on the first launch

* Updated javadocs

* Temporary commit - only for testing

* Replaced Temporary commit

* Temporary commit - Added jcenter

* Made minor changes

* Fixed unit tests

* Fixed unit tests

* Fixed minor bug

Author: kanahia1

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

@@ -46,11 +46,11 @@ public List<Place> getAllBookmarksLocations() {
         ContentProviderClient db = clientProvider.get();
         try {
             cursor = db.query(
-                    BookmarkLocationsContentProvider.BASE_URI,
-                    Table.ALL_FIELDS,
-                    null,
-                    new String[]{},
-                    null);
+                BookmarkLocationsContentProvider.BASE_URI,
+                Table.ALL_FIELDS,
+                null,
+                new String[]{},
+                null);
             while (cursor != null && cursor.moveToNext()) {
                 items.add(fromCursor(cursor));
             }
@@ -126,11 +126,11 @@ public boolean findBookmarkLocation(Place bookmarkLocation) {
         ContentProviderClient db = clientProvider.get();
         try {
             cursor = db.query(
-                    BookmarkLocationsContentProvider.BASE_URI,
-                    Table.ALL_FIELDS,
-                    Table.COLUMN_NAME + "=?",
-                    new String[]{bookmarkLocation.name},
-                    null);
+                BookmarkLocationsContentProvider.BASE_URI,
+                Table.ALL_FIELDS,
+                Table.COLUMN_NAME + "=?",
+                new String[]{bookmarkLocation.name},
+                null);
             if (cursor != null && cursor.moveToFirst()) {
                 return true;
             }
@@ -149,7 +149,7 @@ public boolean findBookmarkLocation(Place bookmarkLocation) {
     @NonNull
     Place fromCursor(final Cursor cursor) {
         final LatLng location = new LatLng(cursor.getDouble(cursor.getColumnIndex(Table.COLUMN_LAT)),
-                cursor.getDouble(cursor.getColumnIndex(Table.COLUMN_LONG)), 1F);
+            cursor.getDouble(cursor.getColumnIndex(Table.COLUMN_LONG)), 1F);
 
         final Sitelinks.Builder builder = new Sitelinks.Builder();
         builder.setWikipediaLink(cursor.getString(cursor.getColumnIndex(Table.COLUMN_WIKIPEDIA_LINK)));
@@ -207,40 +207,40 @@ public static class Table {
 
         // NOTE! KEEP IN SAME ORDER AS THEY ARE DEFINED UP THERE. HELPS HARD CODE COLUMN INDICES.
         public static final String[] ALL_FIELDS = {
-                COLUMN_NAME,
-                COLUMN_LANGUAGE,
-                COLUMN_DESCRIPTION,
-                COLUMN_CATEGORY,
-                COLUMN_LABEL_TEXT,
-                COLUMN_LABEL_ICON,
-                COLUMN_LAT,
-                COLUMN_LONG,
-                COLUMN_IMAGE_URL,
-                COLUMN_WIKIPEDIA_LINK,
-                COLUMN_WIKIDATA_LINK,
-                COLUMN_COMMONS_LINK,
-                COLUMN_PIC,
-                COLUMN_EXISTS,
+            COLUMN_NAME,
+            COLUMN_LANGUAGE,
+            COLUMN_DESCRIPTION,
+            COLUMN_CATEGORY,
+            COLUMN_LABEL_TEXT,
+            COLUMN_LABEL_ICON,
+            COLUMN_LAT,
+            COLUMN_LONG,
+            COLUMN_IMAGE_URL,
+            COLUMN_WIKIPEDIA_LINK,
+            COLUMN_WIKIDATA_LINK,
+            COLUMN_COMMONS_LINK,
+            COLUMN_PIC,
+            COLUMN_EXISTS,
         };
 
         static final String DROP_TABLE_STATEMENT = "DROP TABLE IF EXISTS " + TABLE_NAME;
 
         static final String CREATE_TABLE_STATEMENT = "CREATE TABLE " + TABLE_NAME + " ("
-                + COLUMN_NAME + " STRING PRIMARY KEY,"
-                + COLUMN_LANGUAGE + " STRING,"
-                + COLUMN_DESCRIPTION + " STRING,"
-                + COLUMN_CATEGORY + " STRING,"
-                + COLUMN_LABEL_TEXT + " STRING,"
-                + COLUMN_LABEL_ICON + " INTEGER,"
-                + COLUMN_LAT + " DOUBLE,"
-                + COLUMN_LONG + " DOUBLE,"
-                + COLUMN_IMAGE_URL + " STRING,"
-                + COLUMN_WIKIPEDIA_LINK + " STRING,"
-                + COLUMN_WIKIDATA_LINK + " STRING,"
-                + COLUMN_COMMONS_LINK + " STRING,"
-                + COLUMN_PIC + " STRING,"
-                + COLUMN_EXISTS + " STRING"
-                + ");";
+            + COLUMN_NAME + " STRING PRIMARY KEY,"
+            + COLUMN_LANGUAGE + " STRING,"
+            + COLUMN_DESCRIPTION + " STRING,"
+            + COLUMN_CATEGORY + " STRING,"
+            + COLUMN_LABEL_TEXT + " STRING,"
+            + COLUMN_LABEL_ICON + " INTEGER,"
+            + COLUMN_LAT + " DOUBLE,"
+            + COLUMN_LONG + " DOUBLE,"
+            + COLUMN_IMAGE_URL + " STRING,"
+            + COLUMN_WIKIPEDIA_LINK + " STRING,"
+            + COLUMN_WIKIDATA_LINK + " STRING,"
+            + COLUMN_COMMONS_LINK + " STRING,"
+            + COLUMN_PIC + " STRING,"
+            + COLUMN_EXISTS + " STRING"
+            + ");";
 
         public static void onCreate(SQLiteDatabase db) {
             db.execSQL(CREATE_TABLE_STATEMENT);
@@ -308,4 +308,4 @@ public static void onUpdate(final SQLiteDatabase db, int from, final int to) {
             }
         }
     }
-}
+}

app/src/main/java/fr/free/nrw/commons/db/AppDatabase.kt

@@ -6,6 +6,8 @@ import androidx.room.TypeConverters
 import fr.free.nrw.commons.contributions.Contribution
 import fr.free.nrw.commons.contributions.ContributionDao
 import fr.free.nrw.commons.customselector.database.*
+import fr.free.nrw.commons.nearby.Place
+import fr.free.nrw.commons.nearby.PlaceDao
 import fr.free.nrw.commons.review.ReviewDao
 import fr.free.nrw.commons.review.ReviewEntity
 import fr.free.nrw.commons.upload.depicts.Depicts
@@ -15,10 +17,11 @@ import fr.free.nrw.commons.upload.depicts.DepictsDao
  * The database for accessing the respective DAOs
  *
  */
-@Database(entities = [Contribution::class, Depicts::class, UploadedStatus::class, NotForUploadStatus::class, ReviewEntity::class], version = 16, exportSchema = false)
+@Database(entities = [Contribution::class, Depicts::class, UploadedStatus::class, NotForUploadStatus::class, ReviewEntity::class, Place::class], version = 18, exportSchema = false)
 @TypeConverters(Converters::class)
 abstract class AppDatabase : RoomDatabase() {
     abstract fun contributionDao(): ContributionDao
+    abstract fun PlaceDao(): PlaceDao
     abstract fun DepictsDao(): DepictsDao;
     abstract fun UploadedStatusDao(): UploadedStatusDao;
     abstract fun NotForUploadStatusDao(): NotForUploadStatusDao

app/src/main/java/fr/free/nrw/commons/db/Converters.java

@@ -8,8 +8,10 @@
 import fr.free.nrw.commons.contributions.ChunkInfo;
 import fr.free.nrw.commons.di.ApplicationlessInjection;
 import fr.free.nrw.commons.location.LatLng;
+import fr.free.nrw.commons.nearby.Sitelinks;
 import fr.free.nrw.commons.upload.WikidataPlace;
 import fr.free.nrw.commons.upload.structure.depictions.DepictedItem;
+import java.lang.reflect.Type;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
@@ -134,6 +136,18 @@ public static List<DepictedItem> stringToList(String depictedItems) {
         return readObjectWithTypeToken(depictedItems, new TypeToken<List<DepictedItem>>() {});
     }
 
+    @TypeConverter
+    public static Sitelinks sitelinksFromString(String value) {
+        Type type = new TypeToken<Sitelinks>() {}.getType();
+        return new Gson().fromJson(value, type);
+    }
+
+    @TypeConverter
+    public static String fromSitelinks(Sitelinks sitelinks) {
+        Gson gson = new Gson();
+        return gson.toJson(sitelinks);
+    }
+
     private static String writeObjectToString(Object object) {
         return object == null ? null : getGson().toJson(object);
     }

app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java

@@ -24,6 +24,7 @@
 import fr.free.nrw.commons.db.AppDatabase;
 import fr.free.nrw.commons.kvstore.JsonKvStore;
 import fr.free.nrw.commons.location.LocationServiceManager;
+import fr.free.nrw.commons.nearby.PlaceDao;
 import fr.free.nrw.commons.review.ReviewDao;
 import fr.free.nrw.commons.settings.Prefs;
 import fr.free.nrw.commons.upload.UploadController;
@@ -275,6 +276,11 @@ public ContributionDao providesContributionsDao(AppDatabase appDatabase) {
         return appDatabase.contributionDao();
     }
 
+    @Provides
+    public PlaceDao providesPlaceDao(AppDatabase appDatabase) {
+        return appDatabase.PlaceDao();
+    }
+
     /**
      * Get the reference of DepictsDao class.
      */

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

@@ -397,6 +397,54 @@ public List<Place> getNearbyPlaces(
         throw new Exception(response.message());
     }
 
+    /**
+     * Retrieves a list of places based on the provided list of places and language.
+     *
+     * @param placeList A list of Place objects for which to fetch information.
+     * @param language  The language code to use for the query.
+     * @return A list of Place objects with additional information retrieved from Wikidata, or null
+     * if an error occurs.
+     * @throws IOException If there is an issue with reading the resource file or executing the HTTP
+     *                     request.
+     */
+    @Nullable
+    public List<Place> getPlaces(
+        final List<Place> placeList, final String language) throws IOException {
+        final String wikidataQuery = FileUtils.readFromResource("/queries/query_for_item.rq");
+        String qids = "";
+        for (final Place place : placeList) {
+            qids += "\n" + ("wd:" + place.getWikiDataEntityId());
+        }
+        final String query = wikidataQuery
+            .replace("${ENTITY}", qids)
+            .replace("${LANG}", language);
+        final HttpUrl.Builder urlBuilder = HttpUrl
+            .parse(sparqlQueryUrl)
+            .newBuilder()
+            .addQueryParameter("query", query)
+            .addQueryParameter("format", "json");
+
+        final Request request = new Request.Builder()
+            .url(urlBuilder.build())
+            .build();
+
+        try (Response response = okHttpClient.newCall(request).execute()) {
+            if (response.isSuccessful()) {
+                final String json = response.body().string();
+                final NearbyResponse nearbyResponse = gson.fromJson(json, NearbyResponse.class);
+                final List<NearbyResultItem> bindings = nearbyResponse.getResults().getBindings();
+                final List<Place> places = new ArrayList<>();
+                for (final NearbyResultItem item : bindings) {
+                    final Place placeFromNearbyItem = Place.from(item);
+                    places.add(placeFromNearbyItem);
+                }
+                return places;
+            } else {
+                throw new IOException("Unexpected response code: " + response.code());
+            }
+        }
+    }
+
     /**
      * Make API Call to get Places
      *

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

@@ -131,6 +131,17 @@ public String getPlacesAsGPX(LatLng currentLocation) throws Exception {
         );
     }
 
+    /**
+     * Retrieves a list of places based on the provided list of places and language.
+     *
+     * @param placeList A list of Place objects for which to fetch information.
+     * @return A list of Place objects obtained from the Wikidata query.
+     * @throws Exception If an error occurs during the retrieval process.
+     */
+    public List<Place> getPlaces(List<Place> placeList) throws Exception {
+        return nearbyPlaces.getPlaces(placeList, Locale.getDefault().getLanguage());
+    }
+
     public static LatLng calculateNorthEast(double latitude, double longitude, double distance) {
         double lat1 = Math.toRadians(latitude);
         double deltaLat = distance * 0.008;

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

@@ -120,6 +120,22 @@ public List<Place> getFromWikidataQuery(
                 customQuery);
     }
 
+    /**
+     * Retrieves a list of places based on the provided list of places and language.
+     *
+     * This method fetches place information from a Wikidata query using the specified language.
+     *
+     * @param placeList A list of Place objects for which to fetch information.
+     * @param lang      The language code to use for the query.
+     * @return A list of Place objects obtained from the Wikidata query.
+     * @throws Exception If an error occurs during the retrieval process.
+     */
+    public List<Place> getPlaces(final List<Place> placeList,
+        final String lang) throws Exception {
+        return okHttpJsonApiClient
+            .getPlaces(placeList, lang);
+    }
+
     /**
      * Runs the Wikidata query to retrieve the KML String
      *