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 94f9bb1f018f05ca6894cede85f4cdab7b76bfee..07d39974db5b30aa9cce132cd7ff49b5b52837d4 100644 (file)
--- a/app/assets/javascripts/index/directions.js
+++ b/app/assets/javascripts/index/directions.js
@@ -1,255 +1,186 @@
+//= require ./directions-endpoint

 //= require_self
 //= require_tree ./directions
 
 OSM.Directions = function (map) {
 //= require_self
 //= require_tree ./directions
 
 OSM.Directions = function (map) {

-  var awaitingGeocode; // true if the user has requested a route, but we're waiting on a geocode result
-  var awaitingRoute;   // true if we've asked the engine for a route and are waiting to hear back
-  var dragging;        // true if the user is dragging a start/end point
-  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();
+  const popup = L.popup({ autoPanPadding: [100, 100] });

 
 

-  var polyline = L.polyline([], {
-    color: '#03f',
+  const polyline = L.polyline([], {
+    color: "#03f",

     opacity: 0.3,
     weight: 10
   });
 
     opacity: 0.3,
     weight: 10
   });
 

-  var highlight = L.polyline([], {
-    color: '#ff0',
+  const highlight = L.polyline([], {
+    color: "#ff0",

     opacity: 0.5,
     weight: 12
   });
 
     opacity: 0.5,
     weight: 12
   });
 

-  var endpoints = [
-    Endpoint($("input[name='route_from']"), OSM.MARKER_GREEN),
-    Endpoint($("input[name='route_to']"), OSM.MARKER_RED)
-  ];
-
-  var expiry = new Date();
-  expiry.setYear(expiry.getFullYear() + 10);
-
-  function Endpoint(input, iconUrl) {
-    var endpoint = {};
-
-    endpoint.marker = L.marker([0, 0], {
-      icon: L.icon({
-        iconUrl: iconUrl,
-        iconSize: [25, 41],
-        iconAnchor: [12, 41],
-        popupAnchor: [1, -34],
-        shadowUrl: OSM.MARKER_SHADOW,
-        shadowSize: [41, 41]
-      }),
-      draggable: true
-    });
-
-    endpoint.marker.on('drag dragend', function (e) {
-      dragging = (e.type === 'drag');
-      if (dragging && !chosenEngine.draggable) return;
-      if (dragging && awaitingRoute) return;
-      endpoint.setLatLng(e.target.getLatLng());
-      if (map.hasLayer(polyline)) {
-        getRoute();
-      }
-    });
+  const endpointDragCallback = function (dragging) {
+    if (!map.hasLayer(polyline)) return;
+    if (dragging && !chosenEngine.draggable) return;
+    if (dragging && controller) return;

 
 

-    input.on("change", function (e) {
-      // make text the same in both text boxes
-      var value = e.target.value;
-      endpoint.setValue(value);
-    });
-
-    endpoint.setValue = function(value) {
-      endpoint.value = value;
-      delete endpoint.latlng;
-      input.val(value);
-      endpoint.getGeocode();
-    };
-
-    endpoint.getGeocode = function() {
-      // if no one has entered a value yet, then we can't geocode, so don't
-      // even try.
-      if (!endpoint.value) {
-        return;
-      }
+    getRoute(false, !dragging);
+  };
+  const endpointChangeCallback = function () {
+    getRoute(true, true);
+  };

 
 

-      endpoint.awaitingGeocode = true;
+  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)
+  ];

 
 

-      $.getJSON(OSM.NOMINATIM_URL + 'search?q=' + encodeURIComponent(endpoint.value) + '&format=json', function (json) {
-        endpoint.awaitingGeocode = false;
-        endpoint.hasGeocode = true;
-        if (json.length === 0) {
-          alert(I18n.t('javascripts.directions.errors.no_place'));
-          return;
-        }
+  let downloadURL = null;

 
 

-        input.val(json[0].display_name);
+  const expiry = new Date();
+  expiry.setYear(expiry.getFullYear() + 10);

 
 

-        endpoint.latlng = L.latLng(json[0]);
-        endpoint.marker
-          .setLatLng(endpoint.latlng)
-          .addTo(map);
+  const modeGroup = $(".routing_modes");
+  const select = $("select.routing_engines");

 
 

-        if (awaitingGeocode) {
-          awaitingGeocode = false;
-          getRoute();
-        }
-      });
-    };
-
-    endpoint.setLatLng = function (ll) {
-      var precision = OSM.zoomPrecision(map.getZoom());
-      input.val(ll.lat.toFixed(precision) + ", " + ll.lng.toFixed(precision));
-      endpoint.hasGeocode = true;
-      endpoint.latlng = ll;
-      endpoint.marker
-        .setLatLng(ll)
-        .addTo(map);
-    };
+  $(".directions_form .reverse_directions").on("click", function () {
+    const coordFrom = endpoints[0].latlng,
+          coordTo = endpoints[1].latlng;
+    let routeFrom = "",
+        routeTo = "";
+    if (coordFrom) {
+      routeFrom = coordFrom.lat + "," + coordFrom.lng;
+    }
+    if (coordTo) {
+      routeTo = coordTo.lat + "," + coordTo.lng;
+    }
+    endpoints[0].swapCachedReverseGeocodes(endpoints[1]);

 
 

-    return endpoint;
-  }
+    OSM.router.route("/directions?" + new URLSearchParams({
+      route: routeTo + ";" + routeFrom
+    }));
+  });

 
 

-  $(".directions_form .close").on("click", function(e) {
+  $(".directions_form .btn-close").on("click", function (e) {

     e.preventDefault();
     e.preventDefault();

-    var route_from = endpoints[0].value;
-    if (route_from) {
-      OSM.router.route("/?query=" + encodeURIComponent(route_from) + OSM.formatHash(map));
-    } else {
-      OSM.router.route("/" + OSM.formatHash(map));
-    }
+    $(".describe_location").toggle(!endpoints[1].value);
+    $(".search_form input[name='query']").val(endpoints[1].value);
+    OSM.router.route("/" + OSM.formatHash(map));

   });
 
   function formatDistance(m) {
   });
 
   function formatDistance(m) {

-    if (m < 1000) {
-      return Math.round(m) + "m";
-    } else if (m < 10000) {
-      return (m / 1000.0).toFixed(1) + "km";
-    } else {
-      return Math.round(m / 1000) + "km";
-    }
+    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) {
+    return I18n.t("javascripts.directions.distance_m", { distance: Math.round(m) });

   }
 
   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;
     m -= h * 60;

-    return h + ":" + (m < 10 ? '0' : '') + m;
+    return h + ":" + (m < 10 ? "0" : "") + m;

   }
 
   function setEngine(id) {
   }
 
   function setEngine(id) {

-    engines.forEach(function(engine, i) {
-      if (engine.id === id) {
-        chosenEngine = engine;
-        select.val(i);
-      }
-    });
+    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;
+      });
+
+    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() {
+  function getRoute(fitRoute, reportErrors) {

     // Cancel any route that is already in progress
     // Cancel any route that is already in progress

-    if (awaitingRoute) awaitingRoute.abort();
-
-    // go fetch geocodes for any endpoints which have not already
-    // been geocoded.
-    for (var ep_i = 0; ep_i < 2; ++ep_i) {
-      var endpoint = endpoints[ep_i];
-      if (!endpoint.hasGeocode && !endpoint.awaitingGeocode) {
-        endpoint.getGeocode();
-        awaitingGeocode = true;
-      }
-    }
-    if (endpoints[0].awaitingGeocode || endpoints[1].awaitingGeocode) {
-      awaitingGeocode = true;
-      return;
-    }
+    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?" + querystring.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
     // just using it in-place and replacing it in case it has to be used
     // again.
     }));
 
     // copy loading item to sidebar and display it. we copy it, rather than
     // just using it in-place and replacing it in case it has to be used
     // again.

-    $('#sidebar_content').html($('.directions_form .loader_copy').html());
+    $("#sidebar_content").html($(".directions_form .loader_copy").html());

     map.setSidebarOverlaid(false);
     map.setSidebarOverlaid(false);

-
-    awaitingRoute = chosenEngine.getRoute([o, d], function (err, route) {
-      awaitingRoute = null;
-
-      if (err) {
-        map.removeLayer(polyline);
-
-        if (!dragging) {
-          $('#sidebar_content').html('<p class="search_results_error">' + I18n.t('javascripts.directions.errors.no_route') + '</p>');
-        }
-
-        return;
-      }
-
+    controller = new AbortController();
+    chosenEngine.getRoute(points, controller.signal).then(function (route) {

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

-      if (!dragging) {
+      if (fitRoute) {

         map.fitBounds(polyline.getBounds().pad(0.05));
       }
 
         map.fitBounds(polyline.getBounds().pad(0.05));
       }
 

-      var html = '<h2><a class="geolink" href="#">' +
-        '<span class="icon close"></span></a>' + I18n.t('javascripts.directions.directions') +
-        '</h2><p id="routing_summary">' +
-        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') {
-        html += '<br />' +
-          I18n.t('javascripts.directions.ascend') + ': ' + Math.round(route.ascend) + 'm. ' +
-          I18n.t('javascripts.directions.descend') + ': ' + Math.round(route.descend) +'m.';
+      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") {
+        distanceText.append(
+          $("<br>"),
+          I18n.t("javascripts.directions.ascend") + ": " + formatHeight(route.ascend) + ". " +
+          I18n.t("javascripts.directions.descend") + ": " + formatHeight(route.descend) + ".");

       }
       }

-      html += '</p><table id="turnbyturn" />';

 
 

-      $('#sidebar_content')
-        .html(html);
+      const turnByTurnTable = $("<table class='table table-hover table-sm mb-3'>")
+        .append($("<tbody>"));
+      const directionsCloseButton = $("<button type='button' class='btn-close'>")
+        .attr("aria-label", I18n.t("javascripts.close"));
+
+      $("#sidebar_content")
+        .empty()
+        .append(
+          $("<div class='d-flex'>").append(
+            $("<h2 class='flex-grow-1 text-break'>")
+              .text(I18n.t("javascripts.directions.directions")),
+            $("<div>").append(directionsCloseButton)),
+          distanceText,
+          turnByTurnTable
+        );

 
       // Add each row
 
       // Add each row

-      var cumulative = 0;

       route.steps.forEach(function (step) {
       route.steps.forEach(function (step) {

-        var ll        = step[0],
-          direction   = step[1],
-          instruction = step[2],
-          dist        = step[3],
-          lineseg     = step[4];
-
-        cumulative += dist;
-
-        if (dist < 5) {
-          dist = "";
-        } else if (dist < 200) {
-          dist = Math.round(dist / 10) * 10 + "m";
-        } else if (dist < 1500) {
-          dist = Math.round(dist / 100) * 100 + "m";
-        } else if (dist < 5000) {
-          dist = Math.round(dist / 100) / 10 + "km";
-        } else {
-          dist = Math.round(dist / 1000) + "km";
-        }
-
-        var row = $("<tr class='turn'/>");
-        row.append("<td><div class='direction i" + direction + "'/></td> ");
-        row.append("<td class='instruction'>" + instruction);
-        row.append("<td class='distance'>" + dist);
-
-        row.on('click', function () {
+        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='distance text-body-secondary text-end'>" + getDistText(dist));
+
+        row.on("click", function () {

           popup
             .setLatLng(ll)
             .setContent("<p>" + instruction + "</p>")
           popup
             .setLatLng(ll)
             .setContent("<p>" + instruction + "</p>")


@@ -264,124 +195,130 @@ OSM.Directions = function (map) {
           map.removeLayer(highlight);
         });
 
           map.removeLayer(highlight);
         });
 

-        $('#turnbyturn').append(row);
+        turnByTurnTable.append(row);

       });
 
       });
 

-      $('#sidebar_content').append('<p id="routing_credit">' +
-        I18n.t('javascripts.directions.instructions.courtesy', {link: chosenEngine.creditline}) +
-        '</p>');
+      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 a.geolink').on('click', function(e) {
-        e.preventDefault();
+      $("#sidebar_content").append("<p class=\"text-center\">" +
+        I18n.t("javascripts.directions.instructions.courtesy", { link: chosenEngine.creditline }) +
+        "</p>");
+
+      directionsCloseButton.on("click", function () {

         map.removeLayer(polyline);
         map.removeLayer(polyline);

-        $('#sidebar_content').html('');
+        $("#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 engines = OSM.Directions.engines;

 
 

-  engines.sort(function (a, b) {
-    a = I18n.t('javascripts.directions.engines.' + a.id);
-    b = I18n.t('javascripts.directions.engines.' + b.id);
-    return a.localeCompare(b);
-  });
+    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";
+    }
+  }

 
 

-  var select = $('select.routing_engines');
+  setEngine("fossgis_osrm_car");
+  setEngine(Cookies.get("_osm_directions_engine"));

 
 

-  engines.forEach(function(engine, i) {
-    select.append("<option value='" + i + "'>" + I18n.t('javascripts.directions.engines.' + engine.id) + "</option>");
+  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);

   });
 
   });
 

-  var chosenEngineId = $.cookie('_osm_directions_engine');
-  if(!chosenEngineId) {
-    chosenEngineId = 'osrm_car';
-  }
-  setEngine(chosenEngineId);
-

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

-    chosenEngine = engines[e.target.selectedIndex];
-    $.cookie('_osm_directions_engine', chosenEngine.id, { expires: expiry, path: '/' });
-    if (map.hasLayer(polyline)) {
-      getRoute();
-    }
+    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);

   });
 
   });
 

-  $(".directions_form").on("submit", function(e) {
+  $(".directions_form").on("submit", function (e) {

     e.preventDefault();
     e.preventDefault();

-    getRoute();
+    getRoute(true, true);

   });
 
   });
 

-  $(".routing_marker").on('dragstart', function (e) {
-    var dt = e.originalEvent.dataTransfer;
-    dt.effectAllowed = 'move';
-    var dragData = { type: $(this).data('type') };
-    dt.setData('text', JSON.stringify(dragData));
+  $(".routing_marker_column img").on("dragstart", function (e) {
+    const dt = e.originalEvent.dataTransfer;
+    dt.effectAllowed = "move";
+    const dragData = { type: $(this).data("type") };
+    dt.setData("text", JSON.stringify(dragData));

     if (dt.setDragImage) {
     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() {
+  page.pushstate = page.popstate = function () {

     $(".search_form").hide();
     $(".directions_form").show();
 
     $(".search_form").hide();
     $(".directions_form").show();
 

-    $("#map").on('dragend dragover', function (e) {
+    $("#map").on("dragend dragover", function (e) {

       e.preventDefault();
     });
 
       e.preventDefault();
     });
 

-    $("#map").on('drop', function (e) {
+    $("#map").on("drop", function (e) {

       e.preventDefault();
       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);
-      endpoints[type === 'from' ? 0 : 1].setLatLng(ll);
-      getRoute();
+      const ll = map.containerPointToLatLng(pt);
+      const llWithPrecision = OSM.cropLocation(ll, map.getZoom());
+      endpoints[type === "from" ? 0 : 1].setValue(llWithPrecision.join(", "));

     });
 
     });
 

-    var params = querystring.parse(location.search.substring(1)),
-      route = (params.route || '').split(';');
+    endpoints[0].enable();
+    endpoints[1].enable();

 
 

-    if (params.engine) {
-      setEngine(params.engine);
-    }
+    const params = new URLSearchParams(location.search),
+          route = (params.get("route") || "").split(";");

 
 

-    endpoints[0].setValue(params.from || "");
-    endpoints[1].setValue(params.to || "");
+    if (params.has("engine")) setEngine(params.get("engine"));

 
 

-    var o = route[0] && L.latLng(route[0].split(',')),
-        d = route[1] && L.latLng(route[1].split(','));
+    endpoints[0].setValue(params.get("from") || route[0] || "");
+    endpoints[1].setValue(params.get("to") || route[1] || "");

 
 

-    if (o) endpoints[0].setLatLng(o);
-    if (d) endpoints[1].setLatLng(d);
-
-    map.setSidebarOverlaid(!o || !d);
-
-    getRoute();
+    map.setSidebarOverlaid(!endpoints[0].latlng || !endpoints[1].latlng);

   };
 
   };
 

-  page.load = function() {
+  page.load = function () {

     page.pushstate();
   };
 
     page.pushstate();
   };
 

-  page.unload = function() {
+  page.unload = function () {

     $(".search_form").show();
     $(".directions_form").hide();
     $(".search_form").show();
     $(".directions_form").hide();

-    $("#map").off('dragend dragover drop');
+    $("#map").off("dragend dragover drop");
+
+    endpoints[0].disable();
+    endpoints[1].disable();

 
     map
       .removeLayer(popup)
 
     map
       .removeLayer(popup)

-      .removeLayer(polyline)
-      .removeLayer(endpoints[0].marker)
-      .removeLayer(endpoints[1].marker);
+      .removeLayer(polyline);

   };
 
   return page;
   };
 
   return page;


@@ -391,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);
   }
 };