Split directions engine select into modes and providers

[rails.git] / app / assets / javascripts / index / directions.js

diff --git a/app/assets/javascripts/index/directions.js b/app/assets/javascripts/index/directions.js
index 18f5b0b943238636d170d2a357b839b0000e2c99..07d39974db5b30aa9cce132cd7ff49b5b52837d4 100644 (file)
--- a/app/assets/javascripts/index/directions.js
+++ b/app/assets/javascripts/index/directions.js
@@ -1,63 +1,53 @@
 //= require ./directions-endpoint
 //= require_self
 //= require_tree ./directions
 //= require ./directions-endpoint
 //= require_self
 //= require_tree ./directions

-//= require qs/dist/qs

 
 OSM.Directions = function (map) {
 
 OSM.Directions = function (map) {

-  var routeRequest = null; // jqXHR object of an ongoing route request or null
-  var chosenEngine;
+  let controller = null; // the AbortController for the current route request if a route request is in progress
+  let chosenEngine;

 
 

-  var popup = L.popup({ autoPanPadding: [100, 100] });
+  const popup = L.popup({ autoPanPadding: [100, 100] });

 
 

-  var polyline = L.polyline([], {
+  const polyline = L.polyline([], {

     color: "#03f",
     opacity: 0.3,
     weight: 10
   });
 
     color: "#03f",
     opacity: 0.3,
     weight: 10
   });
 

-  var highlight = L.polyline([], {
+  const highlight = L.polyline([], {

     color: "#ff0",
     opacity: 0.5,
     weight: 12
   });
 
     color: "#ff0",
     opacity: 0.5,
     weight: 12
   });
 

-  var endpointDragCallback = function (dragging) {
+  const endpointDragCallback = function (dragging) {

     if (!map.hasLayer(polyline)) return;
     if (dragging && !chosenEngine.draggable) return;
     if (!map.hasLayer(polyline)) return;
     if (dragging && !chosenEngine.draggable) return;

-    if (dragging && routeRequest) return;
+    if (dragging && controller) return;

 
     getRoute(false, !dragging);
   };
 
     getRoute(false, !dragging);
   };

-  var endpointChangeCallback = function () {
+  const endpointChangeCallback = function () {

     getRoute(true, true);
   };
 
     getRoute(true, true);
   };
 

-  var endpoints = [
+  const endpoints = [

     OSM.DirectionsEndpoint(map, $("input[name='route_from']"), OSM.MARKER_GREEN, endpointDragCallback, endpointChangeCallback),
     OSM.DirectionsEndpoint(map, $("input[name='route_to']"), OSM.MARKER_RED, endpointDragCallback, endpointChangeCallback)
   ];
 
     OSM.DirectionsEndpoint(map, $("input[name='route_from']"), OSM.MARKER_GREEN, endpointDragCallback, endpointChangeCallback),
     OSM.DirectionsEndpoint(map, $("input[name='route_to']"), OSM.MARKER_RED, endpointDragCallback, endpointChangeCallback)
   ];
 

-  var expiry = new Date();
-  expiry.setYear(expiry.getFullYear() + 10);
-
-  var engines = OSM.Directions.engines;
+  let downloadURL = null;

 
 

-  engines.sort(function (a, b) {
-    var localised_a = I18n.t("javascripts.directions.engines." + a.id),
-        localised_b = I18n.t("javascripts.directions.engines." + b.id);
-    return localised_a.localeCompare(localised_b);
-  });
+  const expiry = new Date();
+  expiry.setYear(expiry.getFullYear() + 10);

 
 

-  var select = $("select.routing_engines");
-
-  engines.forEach(function (engine, i) {
-    select.append("<option value='" + i + "'>" + I18n.t("javascripts.directions.engines." + engine.id) + "</option>");
-  });
+  const modeGroup = $(".routing_modes");
+  const select = $("select.routing_engines");

 
   $(".directions_form .reverse_directions").on("click", function () {
 
   $(".directions_form .reverse_directions").on("click", function () {

-    var coordFrom = endpoints[0].latlng,
-        coordTo = endpoints[1].latlng,
-        routeFrom = "",
+    const coordFrom = endpoints[0].latlng,
+          coordTo = endpoints[1].latlng;
+    let routeFrom = "",

         routeTo = "";
     if (coordFrom) {
       routeFrom = coordFrom.lat + "," + coordFrom.lng;
         routeTo = "";
     if (coordFrom) {
       routeFrom = coordFrom.lat + "," + coordFrom.lng;


@@ -65,29 +55,25 @@ OSM.Directions = function (map) {
     if (coordTo) {
       routeTo = coordTo.lat + "," + coordTo.lng;
     }
     if (coordTo) {
       routeTo = coordTo.lat + "," + coordTo.lng;
     }

+    endpoints[0].swapCachedReverseGeocodes(endpoints[1]);

 
 

-    OSM.router.route("/directions?" + Qs.stringify({
-      from: $("#route_to").val(),
-      to: $("#route_from").val(),
+    OSM.router.route("/directions?" + new URLSearchParams({

       route: routeTo + ";" + routeFrom
     }));
   });
 
   $(".directions_form .btn-close").on("click", function (e) {
     e.preventDefault();
       route: routeTo + ";" + routeFrom
     }));
   });
 
   $(".directions_form .btn-close").on("click", function (e) {
     e.preventDefault();

-    $(".describe_location").toggle(!endpoints[0].value);
-    $(".search_form input[name='query']").val(endpoints[0].value);
+    $(".describe_location").toggle(!endpoints[1].value);
+    $(".search_form input[name='query']").val(endpoints[1].value);

     OSM.router.route("/" + OSM.formatHash(map));
   });
 
   function formatDistance(m) {
     OSM.router.route("/" + OSM.formatHash(map));
   });
 
   function formatDistance(m) {

-    if (m < 1000) {
-      return I18n.t("javascripts.directions.distance_m", { distance: Math.round(m) });
-    } else if (m < 10000) {
-      return I18n.t("javascripts.directions.distance_km", { distance: (m / 1000.0).toFixed(1) });
-    } else {
-      return I18n.t("javascripts.directions.distance_km", { distance: Math.round(m / 1000) });
-    }
+    const unitTemplate = "javascripts.directions.distance_";
+    if (m < 1000) return I18n.t(unitTemplate + "m", { distance: Math.round(m) });
+    if (m < 10000) return I18n.t(unitTemplate + "km", { distance: (m / 1000.0).toFixed(1) });
+    return I18n.t(unitTemplate + "km", { distance: Math.round(m / 1000) });

   }
 
   function formatHeight(m) {
   }
 
   function formatHeight(m) {


@@ -95,39 +81,53 @@ OSM.Directions = function (map) {
   }
 
   function formatTime(s) {
   }
 
   function formatTime(s) {

-    var m = Math.round(s / 60);
-    var h = Math.floor(m / 60);
+    let m = Math.round(s / 60);
+    const h = Math.floor(m / 60);

     m -= h * 60;
     return h + ":" + (m < 10 ? "0" : "") + m;
   }
 
     m -= h * 60;
     return h + ":" + (m < 10 ? "0" : "") + m;
   }
 

-  function findEngine(id) {
-    return engines.findIndex(function (engine) {
-      return engine.id === id;
-    });
-  }
+  function setEngine(id) {
+    const engines = OSM.Directions.engines;
+    const desired = engines.find(engine => engine.id === id);
+    if (!desired || (chosenEngine && chosenEngine.id === id)) return;
+    chosenEngine = desired;
+
+    const modes = engines
+      .filter(engine => engine.provider === chosenEngine.provider)
+      .map(engine => engine.mode);
+    modeGroup
+      .find("input[id]")
+      .prop("disabled", function () {
+        return !modes.includes(this.id);
+      })
+      .prop("checked", function () {
+        return this.id === chosenEngine.mode;
+      });

 
 

-  function setEngine(index) {
-    chosenEngine = engines[index];
-    select.val(index);
+    const providers = engines
+      .filter(engine => engine.mode === chosenEngine.mode)
+      .map(engine => engine.provider);
+    select
+      .find("option[value]")
+      .prop("disabled", function () {
+        return !providers.includes(this.value);
+      });
+    select.val(chosenEngine.provider);

   }
 
   function getRoute(fitRoute, reportErrors) {
     // Cancel any route that is already in progress
   }
 
   function getRoute(fitRoute, reportErrors) {
     // Cancel any route that is already in progress

-    if (routeRequest) routeRequest.abort();
+    if (controller) controller.abort();

 
 

-    var o = endpoints[0].latlng,
-        d = endpoints[1].latlng;
+    const points = endpoints.map(p => p.latlng);

 
 

-    if (!o || !d) return;
+    if (!points[0] || !points[1]) return;

     $("header").addClass("closed");
 
     $("header").addClass("closed");
 

-    var precision = OSM.zoomPrecision(map.getZoom());
-
-    OSM.router.replace("/directions?" + Qs.stringify({
+    OSM.router.replace("/directions?" + new URLSearchParams({

       engine: chosenEngine.id,
       engine: chosenEngine.id,

-      route: o.lat.toFixed(precision) + "," + o.lng.toFixed(precision) + ";" +
-             d.lat.toFixed(precision) + "," + d.lng.toFixed(precision)
+      route: points.map(p => OSM.cropLocation(p, map.getZoom()).join()).join(";")

     }));
 
     // copy loading item to sidebar and display it. we copy it, rather than
     }));
 
     // copy loading item to sidebar and display it. we copy it, rather than


@@ -135,20 +135,8 @@ OSM.Directions = function (map) {
     // again.
     $("#sidebar_content").html($(".directions_form .loader_copy").html());
     map.setSidebarOverlaid(false);
     // again.
     $("#sidebar_content").html($(".directions_form .loader_copy").html());
     map.setSidebarOverlaid(false);

-
-    routeRequest = chosenEngine.getRoute([o, d], function (err, route) {
-      routeRequest = null;
-
-      if (err) {
-        map.removeLayer(polyline);
-
-        if (reportErrors) {
-          $("#sidebar_content").html("<div class=\"alert alert-danger\">" + I18n.t("javascripts.directions.errors.no_route") + "</div>");
-        }
-
-        return;
-      }
-
+    controller = new AbortController();
+    chosenEngine.getRoute(points, controller.signal).then(function (route) {

       polyline
         .setLatLngs(route.line)
         .addTo(map);
       polyline
         .setLatLngs(route.line)
         .addTo(map);


@@ -157,7 +145,7 @@ OSM.Directions = function (map) {
         map.fitBounds(polyline.getBounds().pad(0.05));
       }
 
         map.fitBounds(polyline.getBounds().pad(0.05));
       }
 

-      var distanceText = $("<p>").append(
+      const distanceText = $("<p>").append(

         I18n.t("javascripts.directions.distance") + ": " + formatDistance(route.distance) + ". " +
         I18n.t("javascripts.directions.time") + ": " + formatTime(route.time) + ".");
       if (typeof route.ascend !== "undefined" && typeof route.descend !== "undefined") {
         I18n.t("javascripts.directions.distance") + ": " + formatDistance(route.distance) + ". " +
         I18n.t("javascripts.directions.time") + ": " + formatTime(route.time) + ".");
       if (typeof route.ascend !== "undefined" && typeof route.descend !== "undefined") {


@@ -167,9 +155,9 @@ OSM.Directions = function (map) {
           I18n.t("javascripts.directions.descend") + ": " + formatHeight(route.descend) + ".");
       }
 
           I18n.t("javascripts.directions.descend") + ": " + formatHeight(route.descend) + ".");
       }
 

-      var turnByTurnTable = $("<table class='table table-hover table-sm mb-3'>")
+      const turnByTurnTable = $("<table class='table table-hover table-sm mb-3'>")

         .append($("<tbody>"));
         .append($("<tbody>"));

-      var directionsCloseButton = $("<button type='button' class='btn-close'>")
+      const directionsCloseButton = $("<button type='button' class='btn-close'>")

         .attr("aria-label", I18n.t("javascripts.close"));
 
       $("#sidebar_content")
         .attr("aria-label", I18n.t("javascripts.close"));
 
       $("#sidebar_content")


@@ -185,28 +173,12 @@ OSM.Directions = function (map) {
 
       // Add each row
       route.steps.forEach(function (step) {
 
       // Add each row
       route.steps.forEach(function (step) {

-        var ll = step[0],
-            direction = step[1],
-            instruction = step[2],
-            dist = step[3],
-            lineseg = step[4];
-
-        if (dist < 5) {
-          dist = "";
-        } else if (dist < 200) {
-          dist = String(Math.round(dist / 10) * 10) + "m";
-        } else if (dist < 1500) {
-          dist = String(Math.round(dist / 100) * 100) + "m";
-        } else if (dist < 5000) {
-          dist = String(Math.round(dist / 100) / 10) + "km";
-        } else {
-          dist = String(Math.round(dist / 1000)) + "km";
-        }
-
-        var row = $("<tr class='turn'/>");
+        const [ll, direction, instruction, dist, lineseg] = step;
+
+        const row = $("<tr class='turn'/>");

         row.append("<td class='border-0'><div class='direction i" + direction + "'/></td> ");
         row.append("<td>" + instruction);
         row.append("<td class='border-0'><div class='direction i" + direction + "'/></td> ");
         row.append("<td>" + instruction);

-        row.append("<td class='distance text-body-secondary text-end'>" + dist);
+        row.append("<td class='distance text-body-secondary text-end'>" + getDistText(dist));

 
         row.on("click", function () {
           popup
 
         row.on("click", function () {
           popup


@@ -226,6 +198,16 @@ OSM.Directions = function (map) {
         turnByTurnTable.append(row);
       });
 
         turnByTurnTable.append(row);
       });
 

+      const blob = new Blob([JSON.stringify(polyline.toGeoJSON())], { type: "application/json" });
+      URL.revokeObjectURL(downloadURL);
+      downloadURL = URL.createObjectURL(blob);
+
+      $("#sidebar_content").append(`<p class="text-center"><a href="${downloadURL}" download="${
+        I18n.t("javascripts.directions.filename")
+      }">${
+        I18n.t("javascripts.directions.download")
+      }</a></p>`);
+

       $("#sidebar_content").append("<p class=\"text-center\">" +
         I18n.t("javascripts.directions.instructions.courtesy", { link: chosenEngine.creditline }) +
         "</p>");
       $("#sidebar_content").append("<p class=\"text-center\">" +
         I18n.t("javascripts.directions.instructions.courtesy", { link: chosenEngine.creditline }) +
         "</p>");


@@ -233,20 +215,39 @@ OSM.Directions = function (map) {
       directionsCloseButton.on("click", function () {
         map.removeLayer(polyline);
         $("#sidebar_content").html("");
       directionsCloseButton.on("click", function () {
         map.removeLayer(polyline);
         $("#sidebar_content").html("");

+        popup.close();

         map.setSidebarOverlaid(true);
         // TODO: collapse width of sidebar back to previous
       });
         map.setSidebarOverlaid(true);
         // TODO: collapse width of sidebar back to previous
       });

+    }).catch(function () {
+      map.removeLayer(polyline);
+      if (reportErrors) {
+        $("#sidebar_content").html("<div class=\"alert alert-danger\">" + I18n.t("javascripts.directions.errors.no_route") + "</div>");
+      }
+    }).finally(function () {
+      controller = null;

     });
     });

-  }

 
 

-  var chosenEngineIndex = findEngine("fossgis_osrm_car");
-  if (Cookies.get("_osm_directions_engine")) {
-    chosenEngineIndex = findEngine(Cookies.get("_osm_directions_engine"));
+    function getDistText(dist) {
+      if (dist < 5) return "";
+      if (dist < 200) return String(Math.round(dist / 10) * 10) + "m";
+      if (dist < 1500) return String(Math.round(dist / 100) * 100) + "m";
+      if (dist < 5000) return String(Math.round(dist / 100) / 10) + "km";
+      return String(Math.round(dist / 1000)) + "km";
+    }

   }
   }

-  setEngine(chosenEngineIndex);
+
+  setEngine("fossgis_osrm_car");
+  setEngine(Cookies.get("_osm_directions_engine"));
+
+  modeGroup.on("change", "input[name='modes']", function (e) {
+    setEngine(chosenEngine.provider + "_" + e.target.id);
+    Cookies.set("_osm_directions_engine", chosenEngine.id, { secure: true, expires: expiry, path: "/", samesite: "lax" });
+    getRoute(true, true);
+  });

 
   select.on("change", function (e) {
 
   select.on("change", function (e) {

-    chosenEngine = engines[e.target.selectedIndex];
+    setEngine(e.target.selectedOptions[0].value + "_" + chosenEngine.mode);

     Cookies.set("_osm_directions_engine", chosenEngine.id, { secure: true, expires: expiry, path: "/", samesite: "lax" });
     getRoute(true, true);
   });
     Cookies.set("_osm_directions_engine", chosenEngine.id, { secure: true, expires: expiry, path: "/", samesite: "lax" });
     getRoute(true, true);
   });


@@ -257,17 +258,17 @@ OSM.Directions = function (map) {
   });
 
   $(".routing_marker_column img").on("dragstart", function (e) {
   });
 
   $(".routing_marker_column img").on("dragstart", function (e) {

-    var dt = e.originalEvent.dataTransfer;
+    const dt = e.originalEvent.dataTransfer;

     dt.effectAllowed = "move";
     dt.effectAllowed = "move";

-    var dragData = { type: $(this).data("type") };
+    const dragData = { type: $(this).data("type") };

     dt.setData("text", JSON.stringify(dragData));
     if (dt.setDragImage) {
     dt.setData("text", JSON.stringify(dragData));
     if (dt.setDragImage) {

-      var img = $("<img>").attr("src", $(e.originalEvent.target).attr("src"));
+      const img = $("<img>").attr("src", $(e.originalEvent.target).attr("src"));

       dt.setDragImage(img.get(0), 12, 21);
     }
   });
 
       dt.setDragImage(img.get(0), 12, 21);
     }
   });
 

-  var page = {};
+  const page = {};

 
   page.pushstate = page.popstate = function () {
     $(".search_form").hide();
 
   page.pushstate = page.popstate = function () {
     $(".search_form").hide();


@@ -279,33 +280,26 @@ OSM.Directions = function (map) {
 
     $("#map").on("drop", function (e) {
       e.preventDefault();
 
     $("#map").on("drop", function (e) {
       e.preventDefault();

-      var oe = e.originalEvent;
-      var dragData = JSON.parse(oe.dataTransfer.getData("text"));
-      var type = dragData.type;
-      var pt = L.DomEvent.getMousePosition(oe, map.getContainer()); // co-ordinates of the mouse pointer at present
+      const oe = e.originalEvent;
+      const dragData = JSON.parse(oe.dataTransfer.getData("text"));
+      const type = dragData.type;
+      const pt = L.DomEvent.getMousePosition(oe, map.getContainer()); // co-ordinates of the mouse pointer at present

       pt.y += 20;
       pt.y += 20;

-      var ll = map.containerPointToLatLng(pt);
-      var precision = OSM.zoomPrecision(map.getZoom());
-      var value = ll.lat.toFixed(precision) + ", " + ll.lng.toFixed(precision);
-      endpoints[type === "from" ? 0 : 1].setValue(value);
+      const ll = map.containerPointToLatLng(pt);
+      const llWithPrecision = OSM.cropLocation(ll, map.getZoom());
+      endpoints[type === "from" ? 0 : 1].setValue(llWithPrecision.join(", "));

     });
 
     endpoints[0].enable();
     endpoints[1].enable();
 
     });
 
     endpoints[0].enable();
     endpoints[1].enable();
 

-    var params = Qs.parse(location.search.substring(1)),
-        route = (params.route || "").split(";");
-
-    if (params.engine) {
-      var engineIndex = findEngine(params.engine);
+    const params = new URLSearchParams(location.search),
+          route = (params.get("route") || "").split(";");

 
 

-      if (engineIndex >= 0) {
-        setEngine(engineIndex);
-      }
-    }
+    if (params.has("engine")) setEngine(params.get("engine"));

 
 

-    endpoints[0].setValue(params.from || route[0] || "");
-    endpoints[1].setValue(params.to || route[1] || "");
+    endpoints[0].setValue(params.get("from") || route[0] || "");
+    endpoints[1].setValue(params.get("to") || route[1] || "");

 
     map.setSidebarOverlaid(!endpoints[0].latlng || !endpoints[1].latlng);
   };
 
     map.setSidebarOverlaid(!endpoints[0].latlng || !endpoints[1].latlng);
   };


@@ -334,6 +328,7 @@ OSM.Directions.engines = [];
 
 OSM.Directions.addEngine = function (engine, supportsHTTPS) {
   if (document.location.protocol === "http:" || supportsHTTPS) {
 
 OSM.Directions.addEngine = function (engine, supportsHTTPS) {
   if (document.location.protocol === "http:" || supportsHTTPS) {

+    engine.id = engine.provider + "_" + engine.mode;

     OSM.Directions.engines.push(engine);
   }
 };
     OSM.Directions.engines.push(engine);
   }
 };