Use profiles in web UI / graphhopper maps (graphhopper#2023)

Co-authored-by: Peter <[email protected]>

Author: easbar

reader-gtfs/src/main/resources/assets/pt/data/Query.js

@@ -18,7 +18,7 @@ const CreateQuery = (baseUrl, search) => {
     }
     url.searchParams.set("pt.limit_solutions", search.limitSolutions);
     url.searchParams.set("locale", "en-US");
-    url.searchParams.set("vehicle", "pt");
+    url.searchParams.set("profile", "pt");
     url.searchParams.set("pt.profile", true);
     return url.toString();
 };

web-bundle/src/main/java/com/graphhopper/http/PtRedirectFilter.java

@@ -29,17 +29,24 @@ public class PtRedirectFilter implements ContainerRequestFilter {
     public void filter(ContainerRequestContext requestContext) {
         if (shouldRedirect(requestContext)) {
             if (requestContext.getUriInfo().getPath().equals("route")) {
-                URI forwardURI = requestContext.getUriInfo().getRequestUriBuilder().replacePath("/route-pt").replaceQueryParam("vehicle").build();
+                URI forwardURI = requestContext.getUriInfo().getRequestUriBuilder().replacePath("/route-pt")
+                        .replaceQueryParam("vehicle")
+                        .replaceQueryParam("profile")
+                        .build();
                 requestContext.setRequestUri(forwardURI);
             } else if (requestContext.getUriInfo().getPath().equals("isochrone")) {
-                URI forwardURI = requestContext.getUriInfo().getRequestUriBuilder().replacePath("/isochrone-pt").replaceQueryParam("vehicle").build();
+                URI forwardURI = requestContext.getUriInfo().getRequestUriBuilder().replacePath("/isochrone-pt")
+                        .replaceQueryParam("vehicle")
+                        .replaceQueryParam("profile")
+                        .build();
                 requestContext.setRequestUri(forwardURI);
             }
         }
     }
 
     private boolean shouldRedirect(ContainerRequestContext requestContext) {
         String maybeVehicle = requestContext.getUriInfo().getQueryParameters().getFirst("vehicle");
-        return maybeVehicle != null && maybeVehicle.equals("pt");
+        String maybeProfile = requestContext.getUriInfo().getQueryParameters().getFirst("profile");
+        return "pt".equals(maybeVehicle) || "pt".equals(maybeProfile);
     }
 }

web-bundle/src/main/java/com/graphhopper/resources/InfoResource.java

@@ -19,6 +19,7 @@
 
 import com.graphhopper.GraphHopper;
 import com.graphhopper.GraphHopperConfig;
+import com.graphhopper.config.ProfileConfig;
 import com.graphhopper.routing.profiles.*;
 import com.graphhopper.storage.GraphHopperStorage;
 import com.graphhopper.util.Constants;
@@ -51,16 +52,25 @@ public InfoResource(GraphHopperConfig config, GraphHopper graphHopper, @Named("h
     }
 
     public static class Info {
-        public static class PerVehicle {
-            public boolean elevation;
-            public boolean turn_costs;
+        public static class ProfileData {
+            public ProfileData() {
+            }
+
+            public ProfileData(String profileName, String vehicle) {
+                this.profileName = profileName;
+                this.vehicle = vehicle;
+            }
+
+            public String profileName;
+            public String vehicle;
         }
 
         public BBox bbox;
+        public final List<ProfileData> profiles = new ArrayList<>();
         public List<String> supported_vehicles;
-        public Map<String, List<Object>> encoded_values;
-        public final Map<String, PerVehicle> features = new HashMap<>();
         public String version = Constants.VERSION;
+        public boolean elevation;
+        public Map<String, List<Object>> encoded_values;
         public String import_date;
         public String data_date;
         public String prepare_ch_date;
@@ -72,20 +82,19 @@ public Info getInfo() {
         final Info info = new Info();
         // use bbox always without elevation (for backward compatibility)
         info.bbox = new BBox(storage.getBounds().minLon, storage.getBounds().maxLon, storage.getBounds().minLat, storage.getBounds().maxLat);
+        for (ProfileConfig p : config.getProfiles()) {
+            Info.ProfileData profileData = new Info.ProfileData(p.getName(), p.getVehicle());
+            info.profiles.add(profileData);
+        }
+        if (config.has("gtfs.file"))
+            info.profiles.add(new Info.ProfileData("pt", "pt"));
+
+        info.elevation = hasElevation;
         List<String> encoderNames = Arrays.asList(storage.getEncodingManager().toString().split(","));
         info.supported_vehicles = new ArrayList<>(encoderNames);
         if (config.has("gtfs.file")) {
             info.supported_vehicles.add("pt");
         }
-        for (String encoderName : encoderNames) {
-            Info.PerVehicle perVehicleJson = new Info.PerVehicle();
-            perVehicleJson.elevation = hasElevation;
-            perVehicleJson.turn_costs = storage.getEncodingManager().getEncoder(encoderName).supportsTurnCosts();
-            info.features.put(encoderName, perVehicleJson);
-        }
-        if (config.has("gtfs.file")) {
-            info.features.put("pt", new InfoResource.Info.PerVehicle());
-        }
         info.import_date = storage.getProperties().get("datareader.import.date");
         info.data_date = storage.getProperties().get("datareader.data.date");
         info.prepare_ch_date = storage.getProperties().get("prepare.ch.date");

web/src/main/resources/assets/css/style.css

@@ -299,7 +299,7 @@ td img.pic {
     vertical-align: middle;
 }
 
-.selectvehicle {
+.selectprofile {
     background-color: #bbb;
     -moz-border-radius: 0px;
     -webkit-border-radius: 0px;

web/src/main/resources/assets/index.html

@@ -46,7 +46,7 @@
                 </div>
 
         <div id="options">
-                    <span id="vehicles">
+                    <span id="profiles">
 
                     </span>
         </div>
@@ -61,7 +61,7 @@
             <input id="searchButton" type="submit" value="Search">
         </form>
         <div id="flex-input-link" class="left" style="cursor: pointer"><small>flex</small></div>
-        <div id="export-link" class="left"><a href="/maps"><img src='img/link.png'></a></div>
+        <div id="export-link" class="left"><a href="/maps/"><img src='img/link.png'></a></div>
         <div id="gpxExportButton"><a href=""><img alt="gpx" src='img/gpx.png'></a></div>
         <div id="flex-input" style="display: none">
             <textarea id="flex-input-text" name="Text1" cols="34" rows="10"></textarea>

web/src/main/resources/assets/js/graphhopper/GHRequest.js

@@ -32,12 +32,12 @@ var GHRequest = function (host, api_key) {
     this.route = new GHRoute(new GHInput(), new GHInput());
     this.from = this.route.first();
     this.to = this.route.last();
-    this.features = {};
+    this.profiles = []
 
     this.do_zoom = true;
     this.useMiles = false;
     this.dataType = "json";
-    this.api_params = {"locale": "en", "vehicle": "car", "weighting": "fastest", "key": api_key, "pt": {}};
+    this.api_params = {"locale": "en", "key": api_key, "pt": {}};
 
     // register events
     this.route.addListener('route.add', function (evt) {
@@ -78,7 +78,8 @@ GHRequest.prototype.init = function (params) {
     if ('use_miles' in params)
         this.useMiles = params.use_miles;
 
-    this.initVehicle(this.api_params.vehicle);
+    if (!this.api_params.profile)
+        this.api_params.profile = this.profiles[0].profile_name
 
     if (params.q) {
         var qStr = params.q;
@@ -118,34 +119,56 @@ GHRequest.prototype.getEarliestDepartureTime = function () {
     return undefined;
 };
 
-GHRequest.prototype.initVehicle = function (vehicle) {
-    this.api_params.vehicle = vehicle;
-    if(this.api_params.elevation !== false) {
-        var featureSet = this.features[vehicle];
-        this.api_params.elevation = featureSet && featureSet.elevation;
-    }
-    this.hasTCSupport();
+GHRequest.prototype.setProfile = function (profileName) {
+    this.api_params.profile = profileName;
+};
+
+GHRequest.prototype.getProfile = function () {
+    return this.api_params.profile;
 };
 
-GHRequest.prototype.hasTCSupport = function() {
-   if(this.api_params.turn_costs !== false) {
-      var featureSet = this.features[this.api_params.vehicle];
-      this.api_params.turn_costs = featureSet && featureSet.turn_costs;
-   }
+GHRequest.prototype.setElevation = function (elevation) {
+    this.api_params.elevation = elevation;
 };
 
 GHRequest.prototype.hasElevation = function () {
     return this.api_params.elevation === true;
 };
 
 GHRequest.prototype.getVehicle = function () {
-    return this.api_params.vehicle;
+    var profileName = this.api_params.profile;
+    var profile = this.profiles.find(function(p) { return p.profile_name === profileName; });
+    if (!profile)
+        return "";
+    else
+        return profile.vehicle;
 };
 
 GHRequest.prototype.isPublicTransit = function () {
-    return this.getVehicle() === "pt";
+    // legacy support: we might have set vehicle=pt instead of pt
+    return this.getProfile() === "pt" || this.getVehicle() === "pt";;
 };
 
+GHRequest.prototype.removeProfileParameterIfLegacyRequest = function() {
+     // we still allow using legacy parameters to support older urls pasted from somewhere, but when they are used
+     // we may not add the profile parameter to the url
+     if (
+            this.api_params["vehicle"] ||
+            this.api_params["weighting"] ||
+            this.api_params["turn_costs"] ||
+            this.api_params["edge_based"]
+        ) {
+            delete this.api_params.profile;
+        }
+}
+
+GHRequest.prototype.removeLegacyParameters = function() {
+     delete this.api_params["vehicle"];
+     delete this.api_params["weighting"];
+     delete this.api_params["turn_costs"];
+     delete this.api_params["edge_based"];
+}
+
 GHRequest.prototype.createGeocodeURL = function (host, prevIndex) {
     var tmpHost = this.host;
     if (host)
@@ -232,6 +255,10 @@ GHRequest.prototype.doRequest = function (url, callback) {
     $.ajax({
         timeout: 30000,
         url: url,
+        beforeSend: function(request) {
+            request.setRequestHeader("gh-client", "web-ui")
+            request.setRequestHeader("gh-client-version", "1.0")
+        },
         success: function (json) {
             if (json.paths) {
                 for (var i = 0; i < json.paths.length; i++) {