Read once and reuse the query file's content

whym · whym · commit 7739085a2cbe · 2017-05-16T22:18:31.000+09:00
diff --git a/app/src/main/assets/queries/nearby_query.rq b/app/src/main/assets/queries/nearby_query.rq
@@ -13,7 +13,7 @@ SELECT
      SERVICE wikibase:around {
        ?item wdt:P625 ?location.
        bd:serviceParam wikibase:center "Point(${LONG} ${LAT})"^^geo:wktLiteral.
-       bd:serviceParam wikibase:radius "${RADIUS}" . # Radius in kilometers.
+       bd:serviceParam wikibase:radius "${RAD}" . # Radius in kilometers.
      }
 
      # ... and without an image.
diff --git a/app/src/main/java/fr/free/nrw/commons/nearby/NearbyController.java b/app/src/main/java/fr/free/nrw/commons/nearby/NearbyController.java
@@ -1,27 +1,24 @@
 package fr.free.nrw.commons.nearby;
 
+import static fr.free.nrw.commons.utils.LengthUtils.computeDistanceBetween;
+import static fr.free.nrw.commons.utils.LengthUtils.formatDistanceBetween;
+
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.preference.PreferenceManager;
-
 import com.mapbox.mapboxsdk.annotations.Icon;
 import com.mapbox.mapboxsdk.annotations.IconFactory;
-
+import fr.free.nrw.commons.R;
+import fr.free.nrw.commons.location.LatLng;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
-
-import fr.free.nrw.commons.R;
-import fr.free.nrw.commons.location.LatLng;
 import timber.log.Timber;
 
-import static fr.free.nrw.commons.utils.LengthUtils.computeDistanceBetween;
-import static fr.free.nrw.commons.utils.LengthUtils.formatDistanceBetween;
-
 
 public class NearbyController {
     private static final int MAX_RESULTS = 1000;
@@ -38,12 +35,10 @@ public static List<Place> loadAttractionsFromLocation(LatLng curLatLng, Context
             return Collections.emptyList();
         }
         SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
+        NearbyPlaces nearbyPlaces = NearbyPlaces.getInstance();
         List<Place> places = prefs.getBoolean("useWikidata", true)
-                ? NearbyPlaces.getInstance().getFromWikidataQuery(
-                context,
-                curLatLng,
-                Locale.getDefault().getLanguage())
-                : NearbyPlaces.getInstance().getFromWikiNeedsPictures();
+                ? nearbyPlaces.getFromWikidataQuery(curLatLng, Locale.getDefault().getLanguage())
+                : nearbyPlaces.getFromWikiNeedsPictures();
         if (curLatLng != null) {
             Timber.d("Sorting places by distance...");
             final Map<Place, Double> distances = new HashMap<>();
diff --git a/app/src/main/java/fr/free/nrw/commons/nearby/NearbyPlaces.java b/app/src/main/java/fr/free/nrw/commons/nearby/NearbyPlaces.java
@@ -3,7 +3,9 @@
 import android.content.Context;
 import android.net.Uri;
 import android.os.StrictMode;
-
+import fr.free.nrw.commons.Utils;
+import fr.free.nrw.commons.location.LatLng;
+import fr.free.nrw.commons.utils.FileUtils;
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
@@ -16,35 +18,51 @@
 import java.util.Locale;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-
-import fr.free.nrw.commons.Utils;
-import fr.free.nrw.commons.location.LatLng;
-import fr.free.nrw.commons.utils.FileUtils;
 import timber.log.Timber;
 
 public class NearbyPlaces {
 
     private static final int MIN_RESULTS = 40;
-    private static final double INITIAL_RADIUS = 1.0; // in kilometer
-    private static final double MAX_RADIUS = 300.0; // in kilometer
+    private static final double INITIAL_RADIUS = 1.0; // in kilometers
+    private static final double MAX_RADIUS = 300.0; // in kilometers
     private static final double RADIUS_MULTIPLIER = 1.618;
-    private static final String WIKIDATA_QUERY_URL = "https://query.wikidata.org/sparql?query=${QUERY}";
+    private static final Uri WIKIDATA_QUERY_URL = Uri.parse("https://query.wikidata.org/sparql");
+    private static final Uri WIKIDATA_QUERY_UI_URL = Uri.parse("https://query.wikidata.org/");
     private static NearbyPlaces singleton;
     private double radius = INITIAL_RADIUS;
     private List<Place> places;
+    private final String wikidataQuery;
+
+    private NearbyPlaces() throws IOException {
+        String query = FileUtils.readFromResource("/assets/queries/nearby_query.rq");
+        wikidataQuery = query;
+        Timber.v(wikidataQuery);
+    }
 
-    private NearbyPlaces(){
+    /**
+     * Get the singleton instance of this class.
+     * The instance is created upon the first invocation of this method, and then reused.
+     *
+     * @return The singleton instance
+     */
+    public static synchronized NearbyPlaces getInstance() {
+        if (singleton == null) {
+            try {
+                singleton = new NearbyPlaces();
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
+        }
+        return singleton;
     }
 
-    List<Place> getFromWikidataQuery(Context context,
-                                     LatLng curLatLng,
-                                     String lang) {
+    List<Place> getFromWikidataQuery(LatLng curLatLng, String lang) {
         List<Place> places = Collections.emptyList();
 
         try {
             // increase the radius gradually to find a satisfactory number of nearby places
             while (radius < MAX_RADIUS) {
-                places = getFromWikidataQuery(context, curLatLng, lang, radius);
+                places = getFromWikidataQuery(curLatLng, lang, radius);
                 Timber.d("%d results at radius: %f", places.size(), radius);
                 if (places.size() >= MIN_RESULTS) {
                     break;
@@ -62,28 +80,24 @@ List<Place> getFromWikidataQuery(Context context,
         return places;
     }
 
-    private List<Place> getFromWikidataQuery(Context context,
-                                             LatLng cur,
+    private List<Place> getFromWikidataQuery(LatLng cur,
                                              String lang,
                                              double radius)
             throws IOException {
         List<Place> places = new ArrayList<>();
 
-        String query = FileUtils.readFromFile(context, "queries/nearby_query.rq")
-                .replace("${RADIUS}", String.format(Locale.ROOT, "%.2f", radius))
+        String query = wikidataQuery
+                .replace("${RAD}", String.format(Locale.ROOT, "%.2f", radius))
                 .replace("${LAT}", String.format(Locale.ROOT, "%.4f", cur.latitude))
                 .replace("${LONG}", String.format(Locale.ROOT, "%.4f", cur.longitude))
                 .replace("${LANG}", lang);
 
-        Timber.d("Wikidata query "+ query);
+        Timber.v("# Wikidata query: \n"+ query);
 
         // format as a URL
-        String url = WIKIDATA_QUERY_URL.replace(
-                "${QUERY}",
-                URLEncoder.encode(query, "utf-8").replace("+", "%20")
-        );
-
-        Timber.d(url);
+        Timber.d(WIKIDATA_QUERY_UI_URL.buildUpon().fragment(query).build().toString());
+        String url = WIKIDATA_QUERY_URL.buildUpon()
+                .appendQueryParameter("query", query).build().toString();
         URLConnection conn = new URL(url).openConnection();
         conn.setRequestProperty("Accept", "text/tab-separated-values");
         BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
@@ -199,17 +213,4 @@ List<Place> getFromWikiNeedsPictures() {
         }
         return places;
     }
-
-    /**
-     * Get the singleton instance of this class.
-     * The instance is created upon the first invocation of this method, and then reused.
-     *
-     * @return The singleton instance
-     */
-    public static synchronized NearbyPlaces getInstance() {
-        if (singleton == null) {
-            singleton = new NearbyPlaces();
-        }
-        return singleton;
-    }
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/utils/FileUtils.java b/app/src/main/java/fr/free/nrw/commons/utils/FileUtils.java
@@ -1,35 +1,34 @@
 package fr.free.nrw.commons.utils;
 
-import android.content.Context;
-
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
 
-import timber.log.Timber;
+import fr.free.nrw.commons.CommonsApplication;
 
 public class FileUtils {
-    public static String readFromFile(Context context, String fileName) {
-        String stringBuilder = "";
+    /**
+     * Read and return the content of a resource file as string.
+     *
+     * @param fileName asset file's path (e.g. "/assets/queries/nearby_query.rq")
+     * @return the content of the file
+     */
+    public static String readFromResource(String fileName) throws IOException {
+        StringBuffer buffer = new StringBuffer();
         BufferedReader reader = null;
         try {
             reader = new BufferedReader(
-                    new InputStreamReader(context.getAssets().open(fileName)));
-            String mLine;
-            while ((mLine = reader.readLine()) != null) {
-                stringBuilder += mLine + "\n";
+                    new InputStreamReader(
+                            CommonsApplication.class.getResourceAsStream(fileName), "UTF-8"));
+            String line;
+            while ((line = reader.readLine()) != null) {
+                buffer.append(line + "\n");
             }
-        } catch (IOException e) {
-            Timber.e("File not found exception", e);
         } finally {
             if (reader != null) {
-                try {
-                    reader.close();
-                } catch (IOException e) {
-                    //log the exception
-                }
+                reader.close();
             }
         }
-        return stringBuilder;
+        return buffer.toString();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ SELECT`
`13`	`13`	`SERVICE wikibase:around {`
`14`	`14`	`?item wdt:P625 ?location.`
`15`	`15`	`bd:serviceParam wikibase:center "Point(${LONG} ${LAT})"^^geo:wktLiteral.`
`16`		`- bd:serviceParam wikibase:radius "${RADIUS}" . # Radius in kilometers.`
	`16`	`+ bd:serviceParam wikibase:radius "${RAD}" . # Radius in kilometers.`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`# ... and without an image.`