app/assets/javascripts/index/directions.js

   1 //= require ./directions-endpoint
   2 //= require ./directions-route-output
   3 //= require_self
   4 //= require_tree ./directions
   5
   6 OSM.Directions = function (map) {
   7   let controller = null; // the AbortController for the current route request if a route request is in progress
   8   let lastLocation = [];
   9   let chosenEngine;
  10
  11   let sidebarReadyPromise = null;
  12
  13   const routeOutput = OSM.DirectionsRouteOutput(map);
  14
  15   const endpointDragCallback = function (dragging) {
  16     if (!routeOutput.isVisible()) return;
  17     if (dragging && !chosenEngine.draggable) return;
  18     if (dragging && controller) return;
  19
  20     getRoute(false, !dragging);
  21   };
  22   const endpointChangeCallback = function () {
  23     getRoute(true, true);
  24   };
  25
  26   const endpoints = [
  27     OSM.DirectionsEndpoint(map, $("input[name='route_from']"), { icon: "MARKER_GREEN" }, endpointDragCallback, endpointChangeCallback),
  28     OSM.DirectionsEndpoint(map, $("input[name='route_to']"), { icon: "MARKER_RED" }, endpointDragCallback, endpointChangeCallback)
  29   ];
  30
  31   const expiry = new Date();
  32   expiry.setYear(expiry.getFullYear() + 10);
  33
  34   const modeGroup = $(".routing_modes");
  35   const select = $("select.routing_engines");
  36
  37   $(".directions_form .reverse_directions").on("click", function () {
  38     const coordFrom = endpoints[0].latlng,
  39           coordTo = endpoints[1].latlng;
  40     let routeFrom = "",
  41         routeTo = "";
  42     if (coordFrom) {
  43       routeFrom = coordFrom.lat + "," + coordFrom.lng;
  44     }
  45     if (coordTo) {
  46       routeTo = coordTo.lat + "," + coordTo.lng;
  47     }
  48     endpoints[0].swapCachedReverseGeocodes(endpoints[1]);
  49
  50     OSM.router.route("/directions?" + new URLSearchParams({
  51       route: routeTo + ";" + routeFrom
  52     }));
  53   });
  54
  55   $(".directions_form .btn-close").on("click", function (e) {
  56     e.preventDefault();
  57     $(".describe_location").toggle(!endpoints[1].value);
  58     $(".search_form input[name='query']").val(endpoints[1].value);
  59     OSM.router.route("/" + OSM.formatHash(map));
  60   });
  61
  62   function setEngine(id) {
  63     const engines = OSM.Directions.engines;
  64     const desired = engines.find(engine => engine.id === id);
  65     if (!desired || (chosenEngine && chosenEngine.id === id)) return;
  66     chosenEngine = desired;
  67
  68     const modes = engines
  69       .filter(engine => engine.provider === chosenEngine.provider)
  70       .map(engine => engine.mode);
  71     modeGroup
  72       .find("input[id]")
  73       .prop("disabled", function () {
  74         return !modes.includes(this.id);
  75       })
  76       .prop("checked", function () {
  77         return this.id === chosenEngine.mode;
  78       });
  79
  80     const providers = engines
  81       .filter(engine => engine.mode === chosenEngine.mode)
  82       .map(engine => engine.provider);
  83     select
  84       .find("option[value]")
  85       .prop("disabled", function () {
  86         return !providers.includes(this.value);
  87       });
  88     select.val(chosenEngine.provider);
  89   }
  90
  91   function getRoute(fitRoute, reportErrors) {
  92     // Cancel any route that is already in progress
  93     if (controller) controller.abort();
  94
  95     const points = endpoints.map(p => p.latlng);
  96
  97     if (!points[0] || !points[1]) return;
  98     $("header").addClass("closed");
  99
 100     OSM.router.replace("/directions?" + new URLSearchParams({
 101       engine: chosenEngine.id,
 102       route: points.map(p => `${p.lat},${p.lng}`).join(";")
 103     }));
 104
 105     $("#directions_loader").prop("hidden", false);
 106     $("#directions_error").prop("hidden", true).empty();
 107     $("#directions_route").prop("hidden", true);
 108     map.setSidebarOverlaid(false);
 109     controller = new AbortController();
 110     chosenEngine.getRoute(points, controller.signal).then(async function (route) {
 111       await sidebarLoaded();
 112       $("#directions_route").prop("hidden", false);
 113       routeOutput.write(route);
 114       if (fitRoute) {
 115         routeOutput.fit();
 116       }
 117     }).catch(async function () {
 118       await sidebarLoaded();
 119       routeOutput.remove();
 120       if (reportErrors) {
 121         $("#directions_error")
 122           .prop("hidden", false)
 123           .html("<div class=\"alert alert-danger\">" + OSM.i18n.t("javascripts.directions.errors.no_route") + "</div>");
 124       }
 125     }).finally(function () {
 126       $("#directions_loader").prop("hidden", true);
 127       controller = null;
 128     });
 129   }
 130
 131   function closeButtonListener(e) {
 132     e.stopPropagation();
 133     routeOutput.remove();
 134     sidebarReadyPromise = null;
 135     map.setSidebarOverlaid(true);
 136     // TODO: collapse width of sidebar back to previous
 137   }
 138
 139   setEngine("fossgis_osrm_car");
 140   setEngine(Cookies.get("_osm_directions_engine"));
 141
 142   modeGroup.on("change", "input[name='modes']", function (e) {
 143     setEngine(chosenEngine.provider + "_" + e.target.id);
 144     Cookies.set("_osm_directions_engine", chosenEngine.id, { secure: true, expires: expiry, path: "/", samesite: "lax" });
 145     getRoute(true, true);
 146   });
 147
 148   select.on("change", function (e) {
 149     setEngine(e.target.value + "_" + chosenEngine.mode);
 150     Cookies.set("_osm_directions_engine", chosenEngine.id, { secure: true, expires: expiry, path: "/", samesite: "lax" });
 151     getRoute(true, true);
 152   });
 153
 154   $(".directions_form").on("submit", function (e) {
 155     e.preventDefault();
 156     getRoute(true, true);
 157   });
 158
 159   $(".routing_marker_column img").on("dragstart", function (e) {
 160     const dt = e.originalEvent.dataTransfer;
 161     dt.effectAllowed = "move";
 162     const dragData = { type: $(this).data("type") };
 163     dt.setData("text", JSON.stringify(dragData));
 164     if (dt.setDragImage) {
 165       const img = $("<img>").attr("src", $(e.originalEvent.target).attr("src"));
 166       dt.setDragImage(img.get(0), 12, 21);
 167     }
 168   });
 169
 170   function sendstartinglocation({ latlng: { lat, lng } }) {
 171     map.fire("startinglocation", { latlng: [lat, lng] });
 172   }
 173
 174   function startingLocationListener({ latlng }) {
 175     if (endpoints[0].value) return;
 176     endpoints[0].setValue(latlng.join(", "));
 177   }
 178
 179   map.on("locationfound", ({ latlng: { lat, lng } }) =>
 180     lastLocation = [lat, lng]
 181   ).on("locateactivate", () => {
 182     map.once("startinglocation", startingLocationListener);
 183   });
 184
 185   function initializeFromParams() {
 186     const params = new URLSearchParams(location.search),
 187           route = (params.get("route") || "").split(";");
 188
 189     if (params.has("engine")) setEngine(params.get("engine"));
 190
 191     endpoints[0].setValue(params.get("from") || route[0] || lastLocation.join(", "));
 192     endpoints[1].setValue(params.get("to") || route[1] || "");
 193   }
 194
 195   function enableListeners() {
 196     $("#sidebar .sidebar-close-controls button").on("click", closeButtonListener);
 197
 198     $("#map").on("dragend dragover", function (e) {
 199       e.preventDefault();
 200     });
 201
 202     $("#map").on("drop", function (e) {
 203       e.preventDefault();
 204       const oe = e.originalEvent;
 205       const dragData = JSON.parse(oe.dataTransfer.getData("text"));
 206       const type = dragData.type;
 207       const pt = L.DomEvent.getMousePosition(oe, map.getContainer()); // co-ordinates of the mouse pointer at present
 208       pt.y += 20;
 209       const ll = map.containerPointToLatLng(pt);
 210       const llWithPrecision = OSM.cropLocation(ll, map.getZoom());
 211       endpoints[type === "from" ? 0 : 1].setValue(llWithPrecision.join(", "));
 212     });
 213
 214     map.on("locationfound", sendstartinglocation);
 215
 216     endpoints[0].enableListeners();
 217     endpoints[1].enableListeners();
 218   }
 219
 220   const page = {};
 221
 222   function sidebarLoaded() {
 223     if ($("#directions_route").length) {
 224       sidebarReadyPromise = null;
 225       return Promise.resolve();
 226     }
 227     if (sidebarReadyPromise) return sidebarReadyPromise;
 228     sidebarReadyPromise = new Promise(resolve => OSM.loadSidebarContent("/directions", resolve));
 229     return sidebarReadyPromise;
 230   }
 231
 232   page.pushstate = page.popstate = page.load = function () {
 233     initializeFromParams();
 234
 235     $(".search_form").hide();
 236     $(".directions_form").show();
 237
 238     sidebarLoaded().then(enableListeners);
 239
 240     map.setSidebarOverlaid(!endpoints[0].latlng || !endpoints[1].latlng);
 241   };
 242
 243   page.unload = function () {
 244     $(".search_form").show();
 245     $(".directions_form").hide();
 246
 247     $("#sidebar .sidebar-close-controls button").off("click", closeButtonListener);
 248     $("#map").off("dragend dragover drop");
 249     map.off("locationfound", sendstartinglocation);
 250
 251     endpoints[0].disableListeners();
 252     endpoints[1].disableListeners();
 253
 254     endpoints[0].clearValue();
 255     endpoints[1].clearValue();
 256
 257     routeOutput.remove();
 258
 259     sidebarReadyPromise = null;
 260   };
 261
 262   return page;
 263 };
 264
 265 OSM.Directions.engines = [];
 266
 267 OSM.Directions.addEngine = function (engine, supportsHTTPS) {
 268   if (location.protocol === "http:" || supportsHTTPS) {
 269     engine.id = engine.provider + "_" + engine.mode;
 270     OSM.Directions.engines.push(engine);
 271   }
 272 };