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