]> git.openstreetmap.org Git - rails.git/blobdiff - app/assets/javascripts/index/directions/osrm.js
renamed fossgis engine
[rails.git] / app / assets / javascripts / index / directions / osrm.js
index 2ee9da12b1d78dbce1f057d9f706e5d4fa374692..280e66a80f0b1ffe175b5ba46f0d4e65a5c2b84d 100644 (file)
-// OSRM car engine
+// OSRM engine
 // Doesn't yet support hints
 
-function OSRMEngine() {
-  var previousPoints, hintData;
+function OSRMEngine(id, vehicleType) {
+  var cachedHints = [];
 
   return {
-    id: "osrm_car",
-    creditline: '<a href="http://project-osrm.org/" target="_blank">OSRM</a>',
+    id: id,
+    creditline: "<a href=\"https://routing.openstreetmap.de/about.html\" target=\"_blank\">OSRM (FOSSGIS)</a>",
     draggable: true,
 
-    getRoute: function (points, callback) {
-      var TURN_INSTRUCTIONS = [
-        "",
-        'javascripts.directions.instructions.continue',         // 1
-        'javascripts.directions.instructions.slight_right',     // 2
-        'javascripts.directions.instructions.turn_right',       // 3
-        'javascripts.directions.instructions.sharp_right',      // 4
-        'javascripts.directions.instructions.uturn',            // 5
-        'javascripts.directions.instructions.sharp_left',       // 6
-        'javascripts.directions.instructions.turn_left',        // 7
-        'javascripts.directions.instructions.slight_left',      // 8
-        'javascripts.directions.instructions.via_point',        // 9
-        'javascripts.directions.instructions.follow',           // 10
-        'javascripts.directions.instructions.roundabout',       // 11
-        'javascripts.directions.instructions.leave_roundabout', // 12
-        'javascripts.directions.instructions.stay_roundabout',  // 13
-        'javascripts.directions.instructions.start',            // 14
-        'javascripts.directions.instructions.destination',      // 15
-        'javascripts.directions.instructions.against_oneway',   // 16
-        'javascripts.directions.instructions.end_oneway',       // 17
-        'javascripts.directions.instructions.ferry'             // 18
-      ];
+    _transformSteps: function (input_steps, line) {
+      var INSTRUCTION_TEMPLATE = {
+        "continue": "javascripts.directions.instructions.continue",
+        "merge right": "javascripts.directions.instructions.merge_right",
+        "merge left": "javascripts.directions.instructions.merge_left",
+        "off ramp right": "javascripts.directions.instructions.offramp_right",
+        "off ramp left": "javascripts.directions.instructions.offramp_left",
+        "on ramp right": "javascripts.directions.instructions.onramp_right",
+        "on ramp left": "javascripts.directions.instructions.onramp_left",
+        "fork right": "javascripts.directions.instructions.fork_right",
+        "fork left": "javascripts.directions.instructions.fork_left",
+        "end of road right": "javascripts.directions.instructions.endofroad_right",
+        "end of road left": "javascripts.directions.instructions.endofroad_left",
+        "turn straight": "javascripts.directions.instructions.continue",
+        "turn slight right": "javascripts.directions.instructions.slight_right",
+        "turn right": "javascripts.directions.instructions.turn_right",
+        "turn sharp right": "javascripts.directions.instructions.sharp_right",
+        "turn uturn": "javascripts.directions.instructions.uturn",
+        "turn sharp left": "javascripts.directions.instructions.sharp_left",
+        "turn left": "javascripts.directions.instructions.turn_left",
+        "turn slight left": "javascripts.directions.instructions.slight_left",
+        "roundabout": "javascripts.directions.instructions.roundabout",
+        "rotary": "javascripts.directions.instructions.roundabout",
+        "exit roundabout": "javascripts.directions.instructions.exit_roundabout",
+        "exit rotary": "javascripts.directions.instructions.exit_roundabout",
+        "depart": "javascripts.directions.instructions.start",
+        "arrive": "javascripts.directions.instructions.destination"
+      };
+      var ICON_MAP = {
+        "continue": 0,
+        "merge right": 21,
+        "merge left": 20,
+        "off ramp right": 24,
+        "off ramp left": 25,
+        "on ramp right": 2,
+        "on ramp left": 6,
+        "fork right": 18,
+        "fork left": 19,
+        "end of road right": 22,
+        "end of road left": 23,
+        "turn straight": 0,
+        "turn slight right": 1,
+        "turn right": 2,
+        "turn sharp right": 3,
+        "turn uturn": 4,
+        "turn slight left": 5,
+        "turn left": 6,
+        "turn sharp left": 7,
+        "roundabout": 10,
+        "rotary": 10,
+        "exit roundabout": 10,
+        "exit rotary": 10,
+        "depart": 8,
+        "arrive": 14
+      };
+      var numToWord = function (num) {
+        return ["first", "second", "third", "fourth", "fifth", "sixth", "seventh", "eighth", "ninth", "tenth"][num - 1];
+      };
+      var transformed_steps = input_steps.map(function (step, idx) {
+        var maneuver_id;
+
+        // special case handling
+        switch (step.maneuver.type) {
+          case "on ramp":
+          case "off ramp":
+          case "merge":
+          case "end of road":
+          case "fork":
+            maneuver_id = step.maneuver.type + " " + (step.maneuver.modifier.indexOf("left") >= 0 ? "left" : "right");
+            break;
+          case "depart":
+          case "arrive":
+          case "roundabout":
+          case "rotary":
+          case "exit roundabout":
+          case "exit rotary":
+            maneuver_id = step.maneuver.type;
+            break;
+          case "roundabout turn":
+          case "turn":
+            maneuver_id = "turn " + step.maneuver.modifier;
+            break;
+          // for unknown types the fallback is turn
+          default:
+            maneuver_id = "turn " + step.maneuver.modifier;
+            break;
+        }
+        var template = INSTRUCTION_TEMPLATE[maneuver_id];
+
+        // convert lat,lng pairs to LatLng objects
+        var step_geometry = L.PolylineUtil.decode(step.geometry, { precision: 5 }).map(function (a) { return L.latLng(a); });
+        // append step_geometry on line
+        Array.prototype.push.apply(line, step_geometry);
 
+        var instText = "<b>" + (idx + 1) + ".</b> ";
+        var destinations = "<b>" + step.destinations + "</b>";
+        var namedRoad = true;
+        var name;
+
+        if (step.name && step.ref) {
+          name = "<b>" + step.name + " (" + step.ref + ")</b>";
+        } else if (step.name) {
+          name = "<b>" + step.name + "</b>";
+        } else if (step.ref) {
+          name = "<b>" + step.ref + "</b>";
+        } else {
+          name = I18n.t("javascripts.directions.instructions.unnamed");
+          namedRoad = false;
+        }
+
+        if (step.maneuver.type.match(/^exit (rotary|roundabout)$/)) {
+          instText += I18n.t(template, { name: name });
+        } else if (step.maneuver.type.match(/^(rotary|roundabout)$/)) {
+          if (step.maneuver.exit) {
+            if (step.maneuver.exit <= 10) {
+              instText += I18n.t(template + "_with_exit_ordinal", { exit: I18n.t("javascripts.directions.instructions.exit_counts." + numToWord(step.maneuver.exit)), name: name });
+            } else {
+              instText += I18n.t(template + "_with_exit", { exit: step.maneuver.exit, name: name });
+            }
+          } else {
+            instText += I18n.t(template + "_without_exit", { name: name });
+          }
+        } else if (step.maneuver.type.match(/^(on ramp|off ramp)$/)) {
+          var params = {};
+          if (step.exits && step.maneuver.type.match(/^(off ramp)$/)) params.exit = step.exits;
+          if (step.destinations) params.directions = destinations;
+          if (namedRoad) params.directions = name;
+          if (Object.keys(params).length > 0) {
+            template = template + "_with_" + Object.keys(params).join("_");
+          }
+          instText += I18n.t(template, params);
+        } else {
+          instText += I18n.t(template + "_without_exit", { name: name });
+        }
+        return [[step.maneuver.location[1], step.maneuver.location[0]], ICON_MAP[maneuver_id], instText, step.distance, step_geometry];
+      });
+
+      return transformed_steps;
+    },
+
+    getRoute: function (points, callback) {
       var params = [
-        { name: "z", value: "14" },
-        { name: "output", value: "json" },
-        { name: "instructions", value: true }
+        { name: "overview", value: "false" },
+        { name: "geometries", value: "polyline" },
+        { name: "steps", value: true }
       ];
 
-      for (var i = 0; i < points.length; i++) {
-        params.push({ name: "loc", value: points[i].lat + "," + points[i].lng });
 
-        if (hintData && previousPoints && previousPoints[i].equals(points[i])) {
-          params.push({ name: "hint", value: hintData.locations[i] });
-        }
+      if (cachedHints.length === points.length) {
+        params.push({ name: "hints", value: cachedHints.join(";") });
+      } else {
+        // invalidate cache
+        cachedHints = [];
       }
 
-      if (hintData && hintData.checksum) {
-        params.push({ name: "checksum", value: hintData.checksum });
-      }
+      var encoded_coords = points.map(function (p) {
+        return p.lng + "," + p.lat;
+      }).join(";");
+
+      var req_url = OSM.FOSSGIS_OSRM_URL + "routed-" + vehicleType + "/route/v1/driving/" + encoded_coords;
+
+      var onResponse = function (data) {
+        if (data.code !== "Ok") {
+          return callback(true);
+        }
+
+        cachedHints = data.waypoints.map(function (wp) {
+          return wp.hint;
+        });
+
+        var line = [];
+        var transformLeg = function (leg) {
+          return this._transformSteps(leg.steps, line);
+        };
+
+        var steps = [].concat.apply([], data.routes[0].legs.map(transformLeg.bind(this)));
+
+        callback(false, {
+          line: line,
+          steps: steps,
+          distance: data.routes[0].distance,
+          time: data.routes[0].duration
+        });
+      };
 
       return $.ajax({
-        url: document.location.protocol + OSM.OSRM_URL,
+        url: req_url,
         data: params,
         dataType: "json",
-        success: function (data) {
-          if (data.status === 207)
-            return callback(true);
-
-          previousPoints = points;
-          hintData = data.hint_data;
-
-          var line = L.PolylineUtil.decode(data.route_geometry, {
-            precision: 6
-          });
-
-          var steps = [];
-          for (i = 0; i < data.route_instructions.length; i++) {
-            var s = data.route_instructions[i];
-            var linesegend;
-            var instCodes = s[0].split('-');
-            if (s[8] === 2) {
-              /* indicates a ferry in car routing mode, see https://github.com/Project-OSRM/osrm-backend/blob/6cbbd1e5a1b441eb27055f56956e1bac14832a58/profiles/car.lua#L151 */
-              instCodes = ["18"];
-            }
-            var instText = "<b>" + (i + 1) + ".</b> ";
-            var name = s[1] ? "<b>" + s[1] + "</b>" : I18n.t('javascripts.directions.instructions.unnamed');
-            if (instCodes[0] === "11" && instCodes[1]) {
-              instText += I18n.t(TURN_INSTRUCTIONS[instCodes[0]] + '_with_exit', { exit: instCodes[1], name: name } );
-            } else {
-              instText += I18n.t(TURN_INSTRUCTIONS[instCodes[0]] + '_without_exit', { name: name });
-            }
-            if ((i + 1) < data.route_instructions.length) {
-              linesegend = data.route_instructions[i + 1][3] + 1;
-            } else {
-              linesegend = s[3] + 1;
-            }
-            steps.push([line[s[3]], instCodes[0], instText, s[2], line.slice(s[3], linesegend)]);
-          }
-
-          callback(false, {
-            line: line,
-            steps: steps,
-            distance: data.route_summary.total_distance,
-            time: data.route_summary.total_time
-          });
-        },
+        success: onResponse.bind(this),
         error: function () {
           callback(true);
         }
@@ -104,4 +207,6 @@ function OSRMEngine() {
   };
 }
 
-OSM.Directions.addEngine(new OSRMEngine(), true);
+OSM.Directions.addEngine(new OSRMEngine("fossgis_osrm_car", "car"), true);
+OSM.Directions.addEngine(new OSRMEngine("fossgis_osrm_bike", "bike"), true);
+OSM.Directions.addEngine(new OSRMEngine("fossgis_osrm_foot", "foot"), true);