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