app/assets/javascripts/index/directions.js

   1 //= require ./directions-endpoint
   2 //= require_self
   3 //= require_tree ./directions
   4 //= require qs/dist/qs
   5
   6 OSM.Directions = function (map) {
   7   var routeRequest = null; // jqXHR object of an ongoing route request or null
   8   var chosenEngine;
   9
  10   var popup = L.popup({ autoPanPadding: [100, 100] });
  11
  12   var polyline = L.polyline([], {
  13     color: "#03f",
  14     opacity: 0.3,
  15     weight: 10
  16   });
  17
  18   var highlight = L.polyline([], {
  19     color: "#ff0",
  20     opacity: 0.5,
  21     weight: 12
  22   });
  23
  24   var endpointDragCallback = function (dragging) {
  25     if (!map.hasLayer(polyline)) return;
  26     if (dragging && !chosenEngine.draggable) return;
  27     if (dragging && routeRequest) return;
  28
  29     getRoute(false, !dragging);
  30   };
  31   var endpointChangeCallback = function () {
  32     getRoute(true, true);
  33   };
  34
  35   var endpoints = [
  36     OSM.DirectionsEndpoint(map, $("input[name='route_from']"), OSM.MARKER_GREEN, endpointDragCallback, endpointChangeCallback),
  37     OSM.DirectionsEndpoint(map, $("input[name='route_to']"), OSM.MARKER_RED, endpointDragCallback, endpointChangeCallback)
  38   ];
  39
  40   var expiry = new Date();
  41   expiry.setYear(expiry.getFullYear() + 10);
  42
  43   var engines = OSM.Directions.engines;
  44
  45   engines.sort(function (a, b) {
  46     var localised_a = I18n.t("javascripts.directions.engines." + a.id),
  47         localised_b = I18n.t("javascripts.directions.engines." + b.id);
  48     return localised_a.localeCompare(localised_b);
  49   });
  50
  51   var select = $("select.routing_engines");
  52
  53   engines.forEach(function (engine, i) {
  54     select.append("<option value='" + i + "'>" + I18n.t("javascripts.directions.engines." + engine.id) + "</option>");
  55   });
  56
  57   $(".directions_form .reverse_directions").on("click", function () {
  58     var coordFrom = endpoints[0].latlng,
  59         coordTo = endpoints[1].latlng,
  60         routeFrom = "",
  61         routeTo = "";
  62     if (coordFrom) {
  63       routeFrom = coordFrom.lat + "," + coordFrom.lng;
  64     }
  65     if (coordTo) {
  66       routeTo = coordTo.lat + "," + coordTo.lng;
  67     }
  68
  69     OSM.router.route("/directions?" + Qs.stringify({
  70       from: $("#route_to").val(),
  71       to: $("#route_from").val(),
  72       route: routeTo + ";" + routeFrom
  73     }));
  74   });
  75
  76   $(".directions_form .btn-close").on("click", function (e) {
  77     e.preventDefault();
  78     $(".search_form input[name='query']").val(endpoints[0].value);
  79     OSM.router.route("/" + OSM.formatHash(map));
  80   });
  81
  82   function formatDistance(m) {
  83     if (m < 1000) {
  84       return I18n.t("javascripts.directions.distance_m", { distance: Math.round(m) });
  85     } else if (m < 10000) {
  86       return I18n.t("javascripts.directions.distance_km", { distance: (m / 1000.0).toFixed(1) });
  87     } else {
  88       return I18n.t("javascripts.directions.distance_km", { distance: Math.round(m / 1000) });
  89     }
  90   }
  91
  92   function formatHeight(m) {
  93     return I18n.t("javascripts.directions.distance_m", { distance: Math.round(m) });
  94   }
  95
  96   function formatTime(s) {
  97     var m = Math.round(s / 60);
  98     var h = Math.floor(m / 60);
  99     m -= h * 60;
 100     return h + ":" + (m < 10 ? "0" : "") + m;
 101   }
 102
 103   function findEngine(id) {
 104     return engines.findIndex(function (engine) {
 105       return engine.id === id;
 106     });
 107   }
 108
 109   function setEngine(index) {
 110     chosenEngine = engines[index];
 111     select.val(index);
 112   }
 113
 114   function getRoute(fitRoute, reportErrors) {
 115     // Cancel any route that is already in progress
 116     if (routeRequest) routeRequest.abort();
 117
 118     var o = endpoints[0].latlng,
 119         d = endpoints[1].latlng;
 120
 121     if (!o || !d) return;
 122     $("header").addClass("closed");
 123
 124     var precision = OSM.zoomPrecision(map.getZoom());
 125
 126     OSM.router.replace("/directions?" + Qs.stringify({
 127       engine: chosenEngine.id,
 128       route: o.lat.toFixed(precision) + "," + o.lng.toFixed(precision) + ";" +
 129              d.lat.toFixed(precision) + "," + d.lng.toFixed(precision)
 130     }));
 131
 132     // copy loading item to sidebar and display it. we copy it, rather than
 133     // just using it in-place and replacing it in case it has to be used
 134     // again.
 135     $("#sidebar_content").html($(".directions_form .loader_copy").html());
 136     map.setSidebarOverlaid(false);
 137
 138     routeRequest = chosenEngine.getRoute([o, d], function (err, route) {
 139       routeRequest = null;
 140
 141       if (err) {
 142         map.removeLayer(polyline);
 143
 144         if (reportErrors) {
 145           $("#sidebar_content").html("<div class=\"alert alert-danger\">" + I18n.t("javascripts.directions.errors.no_route") + "</div>");
 146         }
 147
 148         return;
 149       }
 150
 151       polyline
 152         .setLatLngs(route.line)
 153         .addTo(map);
 154
 155       if (fitRoute) {
 156         map.fitBounds(polyline.getBounds().pad(0.05));
 157       }
 158
 159       var distanceText = $("<p>").append(
 160         I18n.t("javascripts.directions.distance") + ": " + formatDistance(route.distance) + ". " +
 161         I18n.t("javascripts.directions.time") + ": " + formatTime(route.time) + ".");
 162       if (typeof route.ascend !== "undefined" && typeof route.descend !== "undefined") {
 163         distanceText.append(
 164           $("<br>"),
 165           I18n.t("javascripts.directions.ascend") + ": " + formatHeight(route.ascend) + ". " +
 166           I18n.t("javascripts.directions.descend") + ": " + formatHeight(route.descend) + ".");
 167       }
 168
 169       var turnByTurnTable = $("<table class='table table-hover table-sm mb-3'>")
 170         .append($("<tbody>"));
 171       var directionsCloseButton = $("<button type='button' class='btn-close'>")
 172         .attr("aria-label", I18n.t("javascripts.close"));
 173
 174       $("#sidebar_content")
 175         .empty()
 176         .append(
 177           $("<div class='d-flex'>").append(
 178             $("<h2 class='flex-grow-1 text-break'>")
 179               .text(I18n.t("javascripts.directions.directions")),
 180             $("<div>").append(directionsCloseButton)),
 181           distanceText,
 182           turnByTurnTable
 183         );
 184
 185       // Add each row
 186       route.steps.forEach(function (step) {
 187         var ll = step[0],
 188             direction = step[1],
 189             instruction = step[2],
 190             dist = step[3],
 191             lineseg = step[4];
 192
 193         if (dist < 5) {
 194           dist = "";
 195         } else if (dist < 200) {
 196           dist = String(Math.round(dist / 10) * 10) + "m";
 197         } else if (dist < 1500) {
 198           dist = String(Math.round(dist / 100) * 100) + "m";
 199         } else if (dist < 5000) {
 200           dist = String(Math.round(dist / 100) / 10) + "km";
 201         } else {
 202           dist = String(Math.round(dist / 1000)) + "km";
 203         }
 204
 205         var row = $("<tr class='turn'/>");
 206         row.append("<td class='border-0'><div class='direction i" + direction + "'/></td> ");
 207         row.append("<td>" + instruction);
 208         row.append("<td class='distance text-body-secondary text-end'>" + dist);
 209
 210         row.on("click", function () {
 211           popup
 212             .setLatLng(ll)
 213             .setContent("<p>" + instruction + "</p>")
 214             .openOn(map);
 215         });
 216
 217         row.hover(function () {
 218           highlight
 219             .setLatLngs(lineseg)
 220             .addTo(map);
 221         }, function () {
 222           map.removeLayer(highlight);
 223         });
 224
 225         turnByTurnTable.append(row);
 226       });
 227
 228       $("#sidebar_content").append("<p class=\"text-center\">" +
 229         I18n.t("javascripts.directions.instructions.courtesy", { link: chosenEngine.creditline }) +
 230         "</p>");
 231
 232       directionsCloseButton.on("click", function () {
 233         map.removeLayer(polyline);
 234         $("#sidebar_content").html("");
 235         map.setSidebarOverlaid(true);
 236         // TODO: collapse width of sidebar back to previous
 237       });
 238     });
 239   }
 240
 241   var chosenEngineIndex = findEngine("fossgis_osrm_car");
 242   if (Cookies.get("_osm_directions_engine")) {
 243     chosenEngineIndex = findEngine(Cookies.get("_osm_directions_engine"));
 244   }
 245   setEngine(chosenEngineIndex);
 246
 247   select.on("change", function (e) {
 248     chosenEngine = engines[e.target.selectedIndex];
 249     Cookies.set("_osm_directions_engine", chosenEngine.id, { secure: true, expires: expiry, path: "/", samesite: "lax" });
 250     getRoute(true, true);
 251   });
 252
 253   $(".directions_form").on("submit", function (e) {
 254     e.preventDefault();
 255     getRoute(true, true);
 256   });
 257
 258   $(".routing_marker_column img").on("dragstart", function (e) {
 259     var dt = e.originalEvent.dataTransfer;
 260     dt.effectAllowed = "move";
 261     var dragData = { type: $(this).data("type") };
 262     dt.setData("text", JSON.stringify(dragData));
 263     if (dt.setDragImage) {
 264       var img = $("<img>").attr("src", $(e.originalEvent.target).attr("src"));
 265       dt.setDragImage(img.get(0), 12, 21);
 266     }
 267   });
 268
 269   var page = {};
 270
 271   page.pushstate = page.popstate = function () {
 272     $(".search_form").hide();
 273     $(".directions_form").show();
 274
 275     $("#map").on("dragend dragover", function (e) {
 276       e.preventDefault();
 277     });
 278
 279     $("#map").on("drop", function (e) {
 280       e.preventDefault();
 281       var oe = e.originalEvent;
 282       var dragData = JSON.parse(oe.dataTransfer.getData("text"));
 283       var type = dragData.type;
 284       var pt = L.DomEvent.getMousePosition(oe, map.getContainer()); // co-ordinates of the mouse pointer at present
 285       pt.y += 20;
 286       var ll = map.containerPointToLatLng(pt);
 287       var precision = OSM.zoomPrecision(map.getZoom());
 288       var value = ll.lat.toFixed(precision) + ", " + ll.lng.toFixed(precision);
 289       endpoints[type === "from" ? 0 : 1].setValue(value, ll);
 290     });
 291
 292     endpoints[0].enable();
 293     endpoints[1].enable();
 294
 295     var params = Qs.parse(location.search.substring(1)),
 296         route = (params.route || "").split(";"),
 297         from = route[0] && L.latLng(route[0].split(",")),
 298         to = route[1] && L.latLng(route[1].split(","));
 299
 300     if (params.engine) {
 301       var engineIndex = findEngine(params.engine);
 302
 303       if (engineIndex >= 0) {
 304         setEngine(engineIndex);
 305       }
 306     }
 307
 308     endpoints[0].setValue(params.from || "", from);
 309     endpoints[1].setValue(params.to || "", to);
 310
 311     map.setSidebarOverlaid(!from || !to);
 312   };
 313
 314   page.load = function () {
 315     page.pushstate();
 316   };
 317
 318   page.unload = function () {
 319     $(".search_form").show();
 320     $(".directions_form").hide();
 321     $("#map").off("dragend dragover drop");
 322
 323     endpoints[0].disable();
 324     endpoints[1].disable();
 325
 326     map
 327       .removeLayer(popup)
 328       .removeLayer(polyline);
 329   };
 330
 331   return page;
 332 };
 333
 334 OSM.Directions.engines = [];
 335
 336 OSM.Directions.addEngine = function (engine, supportsHTTPS) {
 337   if (document.location.protocol === "http:" || supportsHTTPS) {
 338     OSM.Directions.engines.push(engine);
 339   }
 340 };