fixed GraphHopperWeb client for custom parameters, fixes graphhopper#658

Author: Peter

web/src/main/java/com/graphhopper/http/GraphHopperWeb.java

@@ -24,8 +24,11 @@
 import com.graphhopper.util.*;
 import com.graphhopper.util.shapes.GHPoint;
 import java.util.ArrayList;
+import java.util.HashSet;
 
 import java.util.List;
+import java.util.Map.Entry;
+import java.util.Set;
 
 import org.json.JSONArray;
 import org.json.JSONObject;
@@ -46,9 +49,28 @@ public class GraphHopperWeb implements GraphHopperAPI
     private boolean instructions = true;
     private boolean calcPoints = true;
     private boolean elevation = false;
+    private final Set<String> ignoreSet;
 
     public GraphHopperWeb()
     {
+        // some parameters are supported directly via Java API so ignore them when writing the getHints map
+        ignoreSet = new HashSet<String>();
+        ignoreSet.add("calc_points");
+        ignoreSet.add("calcpoints");
+        ignoreSet.add("instructions");
+        ignoreSet.add("elevation");
+        ignoreSet.add("key");
+
+        // some parameters are in the request:
+        ignoreSet.add("algorithm");
+        ignoreSet.add("locale");
+        ignoreSet.add("point");
+        ignoreSet.add("vehicle");
+
+        // some are special and need to be avoided
+        ignoreSet.add("points_encoded");
+        ignoreSet.add("pointsencoded");
+        ignoreSet.add("type");
     }
 
     public void setDownloader( Downloader downloader )
@@ -109,7 +131,6 @@ public GHResponse route( GHRequest request )
                         + "Use calcPoints=false and instructions=false to disable point and instruction calculation");
 
             boolean tmpElevation = request.getHints().getBool("elevation", elevation);
-            String tmpKey = request.getHints().get("key", key);
 
             String url = routeServiceUrl
                     + "?"
@@ -125,12 +146,20 @@ public GHResponse route( GHRequest request )
             if (!request.getVehicle().isEmpty())
                 url += "&vehicle=" + request.getVehicle();
 
-            if (!tmpKey.isEmpty())
-                url += "&key=" + tmpKey;
-            int altMax = request.getHints().getInt("alternative_route.max_num", 0);
-            if (altMax != 0)
+            if (!key.isEmpty())
+                url += "&key=" + key;
+
+            for (Entry<String, String> entry : request.getHints().toMap().entrySet())
             {
-                url += "&alternative_route.max_num=" + altMax;
+                String urlKey = entry.getKey();
+                String urlValue = entry.getValue();
+
+                // use lower case conversion for check only!
+                if (ignoreSet.contains(urlKey.toLowerCase()))
+                    continue;
+
+                if (urlValue != null && !urlValue.isEmpty())
+                    url += "&" + WebHelper.encodeURL(urlKey) + "=" + WebHelper.encodeURL(urlValue);
             }
 
             String str = downloader.downloadAsString(url, true);

web/src/test/java/com/graphhopper/http/GraphHopperWebTest.java

@@ -21,6 +21,7 @@
 import com.graphhopper.GHRequest;
 import com.graphhopper.GHResponse;
 import com.graphhopper.util.Downloader;
+import com.graphhopper.util.Helper;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -58,4 +59,32 @@ public InputStream fetch( HttpURLConnection conn, boolean readErrorStreamNoExcep
         assertEquals("(0,Geradeaus auf A 100,1268.519329705091,65237)", arsp.getInstructions().get(0).toString());
         assertEquals(11, arsp.getInstructions().get(0).getPoints().size());
     }
+
+    @Test
+    public void testCreateURL() throws Exception
+    {
+        Downloader downloader = new Downloader("GraphHopper Test")
+        {
+            @Override
+            public String downloadAsString( String url, boolean readErrorStreamNoException ) throws IOException
+            {
+                assertFalse(url.contains("xy"));
+                assertFalse(url.contains("algo1"));
+                assertTrue(url.contains("alternative_route.max_paths=4"));
+
+                assertEquals("https://graphhopper.com/api/1/route?point=52.0,13.0&point=52.0,14.0&&type=json&instructions=true&points_encoded=true&calc_points=true&algorithm=&locale=en_US&elevation=false&key=blup", url);
+                return Helper.isToString(getClass().getResourceAsStream("test_encoded.json"));
+            }
+        };
+        GraphHopperWeb instance = new GraphHopperWeb();
+        instance.setKey("blup");
+        instance.setDownloader(downloader);
+        GHRequest req = new GHRequest(52, 13, 52, 14);
+
+        // should be ignored, use GraphHopperWeb or GHRequest directly instead
+        req.getHints().put("key", "xy");
+        req.getHints().put("algorithm", "algo1");
+        req.getHints().put("alternative_route.max_paths", "4");
+        instance.route(req);
+    }
 }