app/assets/javascripts/index/directions.js

   1 //= require_self
   2 //= require_tree ./directions
   3 //= require qs/dist/qs
   4
   5 OSM.Directions = function (map) {
   6   var awaitingRoute; // true if we've asked the engine for a route and are waiting to hear back
   7   var chosenEngine;
   8
   9   var popup = L.popup({ autoPanPadding: [100, 100] });
  10
  11   var polyline = L.polyline([], {
  12     color: "#03f",
  13     opacity: 0.3,
  14     weight: 10
  15   });
  16
  17   var highlight = L.polyline([], {
  18     color: "#ff0",
  19     opacity: 0.5,
  20     weight: 12
  21   });
  22
  23   var endpointDragCallback = function (dragging) {
  24     if (map.hasLayer(polyline)) {
  25       getRoute(false, !dragging);
  26     }
  27   };
  28   var endpointGeocodeCallback = function () {
  29     getRoute(true, true);
  30   };
  31
  32   var endpoints = [
  33     Endpoint($("input[name='route_from']"), OSM.MARKER_GREEN, endpointDragCallback, endpointGeocodeCallback),
  34     Endpoint($("input[name='route_to']"), OSM.MARKER_RED, endpointDragCallback, endpointGeocodeCallback)
  35   ];
  36
  37   var expiry = new Date();
  38   expiry.setYear(expiry.getFullYear() + 10);
  39
  40   var engines = OSM.Directions.engines;
  41
  42   engines.sort(function (a, b) {
  43     var localised_a = I18n.t("javascripts.directions.engines." + a.id),
  44         localised_b = I18n.t("javascripts.directions.engines." + b.id);
  45     return localised_a.localeCompare(localised_b);
  46   });
  47
  48   var select = $("select.routing_engines");
  49
  50   engines.forEach(function (engine, i) {
  51     select.append("<option value='" + i + "'>" + I18n.t("javascripts.directions.engines." + engine.id) + "</option>");
  52   });
  53
  54   function Endpoint(input, iconUrl, dragCallback, geocodeCallback) {
  55     var endpoint = {};
  56
  57     endpoint.marker = L.marker([0, 0], {
  58       icon: L.icon({
  59         iconUrl: iconUrl,
  60         iconSize: [25, 41],
  61         iconAnchor: [12, 41],
  62         popupAnchor: [1, -34],
  63         shadowUrl: OSM.MARKER_SHADOW,
  64         shadowSize: [41, 41]
  65       }),
  66       draggable: true,
  67       autoPan: true
  68     });
  69
  70     endpoint.marker.on("drag dragend", function (e) {
  71       var dragging = (e.type === "drag");
  72       if (dragging && !chosenEngine.draggable) return;
  73       if (dragging && awaitingRoute) return;
  74       endpoint.setLatLng(e.target.getLatLng());
  75       dragCallback(dragging);
  76     });
  77
  78     input.on("keydown", function () {
  79       input.removeClass("is-invalid");
  80     });
  81
  82     input.on("change", function (e) {
  83       // make text the same in both text boxes
  84       var value = e.target.value;
  85       endpoint.setValue(value);
  86     });
  87
  88     endpoint.setValue = function (value, latlng) {
  89       endpoint.value = value;
  90       delete endpoint.latlng;
  91       input.removeClass("is-invalid");
  92       input.val(value);
  93
  94       if (latlng) {
  95         endpoint.setLatLng(latlng);
  96       } else {
  97         endpoint.getGeocode();
  98       }
  99     };
 100
 101     endpoint.getGeocode = function () {
 102       // if no one has entered a value yet, then we can't geocode, so don't
 103       // even try.
 104       if (!endpoint.value) {
 105         return;
 106       }
 107
 108       endpoint.awaitingGeocode = true;
 109
 110       var viewbox = map.getBounds().toBBoxString(); // <sw lon>,<sw lat>,<ne lon>,<ne lat>
 111
 112       $.getJSON(OSM.NOMINATIM_URL + "search?q=" + encodeURIComponent(endpoint.value) + "&format=json&viewbox=" + viewbox, function (json) {
 113         endpoint.awaitingGeocode = false;
 114         endpoint.hasGeocode = true;
 115         if (json.length === 0) {
 116           input.addClass("is-invalid");
 117           alert(I18n.t("javascripts.directions.errors.no_place", { place: endpoint.value }));
 118           return;
 119         }
 120
 121         endpoint.setLatLng(L.latLng(json[0]));
 122
 123         input.val(json[0].display_name);
 124
 125         geocodeCallback();
 126       });
 127     };
 128
 129     endpoint.setLatLng = function (ll) {
 130       var precision = OSM.zoomPrecision(map.getZoom());
 131       input.val(ll.lat.toFixed(precision) + ", " + ll.lng.toFixed(precision));
 132       endpoint.hasGeocode = true;
 133       endpoint.latlng = ll;
 134       endpoint.marker
 135         .setLatLng(ll)
 136         .addTo(map);
 137     };
 138
 139     return endpoint;
 140   }
 141
 142   $(".directions_form .reverse_directions").on("click", function () {
 143     var coordFrom = endpoints[0].latlng,
 144         coordTo = endpoints[1].latlng,
 145         routeFrom = "",
 146         routeTo = "";
 147     if (coordFrom) {
 148       routeFrom = coordFrom.lat + "," + coordFrom.lng;
 149     }
 150     if (coordTo) {
 151       routeTo = coordTo.lat + "," + coordTo.lng;
 152     }
 153
 154     OSM.router.route("/directions?" + Qs.stringify({
 155       from: $("#route_to").val(),
 156       to: $("#route_from").val(),
 157       route: routeTo + ";" + routeFrom
 158     }));
 159   });
 160
 161   $(".directions_form .btn-close").on("click", function (e) {
 162     e.preventDefault();
 163     var route_from = endpoints[0].value;
 164     if (route_from) {
 165       OSM.router.route("/?query=" + encodeURIComponent(route_from) + OSM.formatHash(map));
 166     } else {
 167       OSM.router.route("/" + OSM.formatHash(map));
 168     }
 169   });
 170
 171   function formatDistance(m) {
 172     if (m < 1000) {
 173       return I18n.t("javascripts.directions.distance_m", { distance: Math.round(m) });
 174     } else if (m < 10000) {
 175       return I18n.t("javascripts.directions.distance_km", { distance: (m / 1000.0).toFixed(1) });
 176     } else {
 177       return I18n.t("javascripts.directions.distance_km", { distance: Math.round(m / 1000) });
 178     }
 179   }
 180
 181   function formatHeight(m) {
 182     return I18n.t("javascripts.directions.distance_m", { distance: Math.round(m) });
 183   }
 184
 185   function formatTime(s) {
 186     var m = Math.round(s / 60);
 187     var h = Math.floor(m / 60);
 188     m -= h * 60;
 189     return h + ":" + (m < 10 ? "0" : "") + m;
 190   }
 191
 192   function findEngine(id) {
 193     return engines.findIndex(function (engine) {
 194       return engine.id === id;
 195     });
 196   }
 197
 198   function setEngine(index) {
 199     chosenEngine = engines[index];
 200     select.val(index);
 201   }
 202
 203   function getRoute(fitRoute, reportErrors) {
 204     // Cancel any route that is already in progress
 205     if (awaitingRoute) awaitingRoute.abort();
 206
 207     // go fetch geocodes for any endpoints which have not already
 208     // been geocoded.
 209     for (var ep_i = 0; ep_i < 2; ++ep_i) {
 210       var endpoint = endpoints[ep_i];
 211       if (!endpoint.hasGeocode && !endpoint.awaitingGeocode) {
 212         endpoint.getGeocode();
 213       }
 214     }
 215     if (endpoints[0].awaitingGeocode || endpoints[1].awaitingGeocode) {
 216       return;
 217     }
 218
 219     var o = endpoints[0].latlng,
 220         d = endpoints[1].latlng;
 221
 222     if (!o || !d) return;
 223     $("header").addClass("closed");
 224
 225     var precision = OSM.zoomPrecision(map.getZoom());
 226
 227     OSM.router.replace("/directions?" + Qs.stringify({
 228       engine: chosenEngine.id,
 229       route: o.lat.toFixed(precision) + "," + o.lng.toFixed(precision) + ";" +
 230              d.lat.toFixed(precision) + "," + d.lng.toFixed(precision)
 231     }));
 232
 233     // copy loading item to sidebar and display it. we copy it, rather than
 234     // just using it in-place and replacing it in case it has to be used
 235     // again.
 236     $("#sidebar_content").html($(".directions_form .loader_copy").html());
 237     map.setSidebarOverlaid(false);
 238
 239     awaitingRoute = chosenEngine.getRoute([o, d], function (err, route) {
 240       awaitingRoute = null;
 241
 242       if (err) {
 243         map.removeLayer(polyline);
 244
 245         if (reportErrors) {
 246           $("#sidebar_content").html("<div class=\"alert alert-danger\">" + I18n.t("javascripts.directions.errors.no_route") + "</div>");
 247         }
 248
 249         return;
 250       }
 251
 252       polyline
 253         .setLatLngs(route.line)
 254         .addTo(map);
 255
 256       if (fitRoute) {
 257         map.fitBounds(polyline.getBounds().pad(0.05));
 258       }
 259
 260       var distanceText = $("<p>").append(
 261         I18n.t("javascripts.directions.distance") + ": " + formatDistance(route.distance) + ". " +
 262         I18n.t("javascripts.directions.time") + ": " + formatTime(route.time) + ".");
 263       if (typeof route.ascend !== "undefined" && typeof route.descend !== "undefined") {
 264         distanceText.append(
 265           $("<br>"),
 266           I18n.t("javascripts.directions.ascend") + ": " + formatHeight(route.ascend) + ". " +
 267           I18n.t("javascripts.directions.descend") + ": " + formatHeight(route.descend) + ".");
 268       }
 269
 270       var turnByTurnTable = $("<table class='table table-hover table-sm mb-3'>")
 271         .append($("<tbody>"));
 272       var directionsCloseButton = $("<button type='button' class='btn-close'>")
 273         .attr("aria-label", I18n.t("javascripts.close"));
 274
 275       $("#sidebar_content")
 276         .empty()
 277         .append(
 278           $("<div class='d-flex'>").append(
 279             $("<h2 class='flex-grow-1 text-break'>")
 280               .text(I18n.t("javascripts.directions.directions")),
 281             $("<div>").append(directionsCloseButton)),
 282           distanceText,
 283           turnByTurnTable
 284         );
 285
 286       // Add each row
 287       route.steps.forEach(function (step) {
 288         var ll = step[0],
 289             direction = step[1],
 290             instruction = step[2],
 291             dist = step[3],
 292             lineseg = step[4];
 293
 294         if (dist < 5) {
 295           dist = "";
 296         } else if (dist < 200) {
 297           dist = String(Math.round(dist / 10) * 10) + "m";
 298         } else if (dist < 1500) {
 299           dist = String(Math.round(dist / 100) * 100) + "m";
 300         } else if (dist < 5000) {
 301           dist = String(Math.round(dist / 100) / 10) + "km";
 302         } else {
 303           dist = String(Math.round(dist / 1000)) + "km";
 304         }
 305
 306         var row = $("<tr class='turn'/>");
 307         row.append("<td class='border-0'><div class='direction i" + direction + "'/></td> ");
 308         row.append("<td>" + instruction);
 309         row.append("<td class='distance text-body-secondary text-end'>" + dist);
 310
 311         row.on("click", function () {
 312           popup
 313             .setLatLng(ll)
 314             .setContent("<p>" + instruction + "</p>")
 315             .openOn(map);
 316         });
 317
 318         row.hover(function () {
 319           highlight
 320             .setLatLngs(lineseg)
 321             .addTo(map);
 322         }, function () {
 323           map.removeLayer(highlight);
 324         });
 325
 326         turnByTurnTable.append(row);
 327       });
 328
 329       $("#sidebar_content").append("<p class=\"text-center\">" +
 330         I18n.t("javascripts.directions.instructions.courtesy", { link: chosenEngine.creditline }) +
 331         "</p>");
 332
 333       directionsCloseButton.on("click", function () {
 334         map.removeLayer(polyline);
 335         $("#sidebar_content").html("");
 336         map.setSidebarOverlaid(true);
 337         // TODO: collapse width of sidebar back to previous
 338       });
 339     });
 340   }
 341
 342   var chosenEngineIndex = findEngine("fossgis_osrm_car");
 343   if (Cookies.get("_osm_directions_engine")) {
 344     chosenEngineIndex = findEngine(Cookies.get("_osm_directions_engine"));
 345   }
 346   setEngine(chosenEngineIndex);
 347
 348   select.on("change", function (e) {
 349     chosenEngine = engines[e.target.selectedIndex];
 350     Cookies.set("_osm_directions_engine", chosenEngine.id, { secure: true, expires: expiry, path: "/", samesite: "lax" });
 351     getRoute(true, true);
 352   });
 353
 354   $(".directions_form").on("submit", function (e) {
 355     e.preventDefault();
 356     getRoute(true, true);
 357   });
 358
 359   $(".routing_marker_column img").on("dragstart", function (e) {
 360     var dt = e.originalEvent.dataTransfer;
 361     dt.effectAllowed = "move";
 362     var dragData = { type: $(this).data("type") };
 363     dt.setData("text", JSON.stringify(dragData));
 364     if (dt.setDragImage) {
 365       var img = $("<img>").attr("src", $(e.originalEvent.target).attr("src"));
 366       dt.setDragImage(img.get(0), 12, 21);
 367     }
 368   });
 369
 370   var page = {};
 371
 372   page.pushstate = page.popstate = function () {
 373     $(".search_form").hide();
 374     $(".directions_form").show();
 375
 376     $("#map").on("dragend dragover", function (e) {
 377       e.preventDefault();
 378     });
 379
 380     $("#map").on("drop", function (e) {
 381       e.preventDefault();
 382       var oe = e.originalEvent;
 383       var dragData = JSON.parse(oe.dataTransfer.getData("text"));
 384       var type = dragData.type;
 385       var pt = L.DomEvent.getMousePosition(oe, map.getContainer()); // co-ordinates of the mouse pointer at present
 386       pt.y += 20;
 387       var ll = map.containerPointToLatLng(pt);
 388       endpoints[type === "from" ? 0 : 1].setLatLng(ll);
 389       getRoute(true, true);
 390     });
 391
 392     var params = Qs.parse(location.search.substring(1)),
 393         route = (params.route || "").split(";"),
 394         from = route[0] && L.latLng(route[0].split(",")),
 395         to = route[1] && L.latLng(route[1].split(","));
 396
 397     if (params.engine) {
 398       var engineIndex = findEngine(params.engine);
 399
 400       if (engineIndex >= 0) {
 401         setEngine(engineIndex);
 402       }
 403     }
 404
 405     endpoints[0].setValue(params.from || "", from);
 406     endpoints[1].setValue(params.to || "", to);
 407
 408     map.setSidebarOverlaid(!from || !to);
 409
 410     getRoute(true, true);
 411   };
 412
 413   page.load = function () {
 414     page.pushstate();
 415   };
 416
 417   page.unload = function () {
 418     $(".search_form").show();
 419     $(".directions_form").hide();
 420     $("#map").off("dragend dragover drop");
 421
 422     map
 423       .removeLayer(popup)
 424       .removeLayer(polyline)
 425       .removeLayer(endpoints[0].marker)
 426       .removeLayer(endpoints[1].marker);
 427   };
 428
 429   return page;
 430 };
 431
 432 OSM.Directions.engines = [];
 433
 434 OSM.Directions.addEngine = function (engine, supportsHTTPS) {
 435   if (document.location.protocol === "http:" || supportsHTTPS) {
 436     OSM.Directions.engines.push(engine);
 437   }
 438 };