app/assets/javascripts/index/directions/osrm.js

   1 // OSRM car engine
   2 // Doesn't yet support hints
   3
   4 function OSRMEngine() {
   5   var cachedHints = [];
   6
   7   return {
   8     id: "osrm_car",
   9     creditline: '<a href="http://project-osrm.org/" target="_blank">OSRM</a>',
  10     draggable: true,
  11
  12     _transformSteps: function(input_steps, line) {
  13       var INSTRUCTION_TEMPLATE = {
  14         'continue': 'javascripts.directions.instructions.continue',
  15         'merge right': 'javascripts.directions.instructions.merge_right',
  16         'merge left': 'javascripts.directions.instructions.merge_left',
  17         'off ramp right': 'javascripts.directions.instructions.offramp_right',
  18         'off ramp left': 'javascripts.directions.instructions.offramp_left',
  19         'on ramp right': 'javascripts.directions.instructions.onramp_right',
  20         'on ramp left': 'javascripts.directions.instructions.onramp_left',
  21         'fork right': 'javascripts.directions.instructions.fork_right',
  22         'fork left': 'javascripts.directions.instructions.fork_left',
  23         'end of road right': 'javascripts.directions.instructions.endofroad_right',
  24         'end of road left': 'javascripts.directions.instructions.endofroad_left',
  25         'turn straight': 'javascripts.directions.instructions.continue',
  26         'turn slight right': 'javascripts.directions.instructions.slight_right',
  27         'turn right': 'javascripts.directions.instructions.turn_right',
  28         'turn sharp right': 'javascripts.directions.instructions.sharp_right',
  29         'turn uturn': 'javascripts.directions.instructions.uturn',
  30         'turn sharp left': 'javascripts.directions.instructions.sharp_left',
  31         'turn left': 'javascripts.directions.instructions.turn_left',
  32         'turn slight left': 'javascripts.directions.instructions.slight_left',
  33         'roundabout': 'javascripts.directions.instructions.roundabout',
  34         'rotary': 'javascripts.directions.instructions.roundabout',
  35         'depart': 'javascripts.directions.instructions.start',
  36         'arrive': 'javascripts.directions.instructions.destination',
  37       };
  38       var ICON_MAP = {
  39         'continue': 0,
  40         'merge right': 21,
  41         'merge left': 20,
  42         'off ramp right': 24,
  43         'off ramp left': 25,
  44         'on ramp right': 2,
  45         'on ramp left': 6,
  46         'fork right': 18,
  47         'fork left': 19,
  48         'end of road right': 22,
  49         'end of road left': 23,
  50         'turn straight': 0,
  51         'turn slight right': 1,
  52         'turn right': 2,
  53         'turn sharp right': 3,
  54         'turn uturn': 4,
  55         'turn slight left': 5,
  56         'turn left': 6,
  57         'turn sharp left': 7,
  58         'roundabout': 10,
  59         'rotary': 10,
  60         'depart': 8,
  61         'arrive': 14
  62       };
  63       var numToWord = function(num) {
  64         return ["first", "second", "third", "fourth", "fifth", "sixth", "seventh", "eighth", "ninth", "tenth"][num-1];
  65       };
  66       var transformed_steps = input_steps.map(function(step, idx) {
  67         var maneuver_id;
  68
  69         // special case handling
  70         switch (step.maneuver.type) {
  71           case 'on ramp':
  72           case 'off ramp':
  73           case 'merge':
  74           case 'end of road':
  75           case 'fork':
  76             maneuver_id = step.maneuver.type + ' ' + (step.maneuver.modifier.indexOf('left') >= 0 ? 'left' : 'right');
  77             break;
  78           case 'depart':
  79           case 'arrive':
  80           case 'roundabout':
  81           case 'rotary':
  82             maneuver_id = step.maneuver.type;
  83             break;
  84           case 'roundabout turn':
  85           case 'turn':
  86             maneuver_id = "turn " + step.maneuver.modifier;
  87             break;
  88           // for unknown types the fallback is turn
  89           default:
  90             maneuver_id = "turn " + step.maneuver.modifier;
  91             break;
  92         }
  93         var template = INSTRUCTION_TEMPLATE[maneuver_id];
  94
  95         // convert lat,lng pairs to LatLng objects
  96         var step_geometry = L.PolylineUtil.decode(step.geometry, { precision: 5 }).map(function(a) { return L.latLng(a); }) ;
  97         // append step_geometry on line
  98         Array.prototype.push.apply(line, step_geometry);
  99
 100         var instText = "<b>" + (idx + 1) + ".</b> ";
 101         var destinations = "<b>" + step.destinations + "</b>";
 102         var namedRoad = true;
 103         var name;
 104
 105         if (step.name && step.ref) {
 106           name = "<b>" + step.name + " (" + step.ref + ")</b>";
 107         } else if (step.name) {
 108           name = "<b>" + step.name + "</b>";
 109         } else if (step.ref) {
 110           name = "<b>" + step.ref + "</b>";
 111         } else {
 112           name = I18n.t('javascripts.directions.instructions.unnamed');
 113           namedRoad = false;
 114         }
 115
 116         if (step.maneuver.type.match(/rotary|roundabout/)) {
 117           if (step.maneuver.exit) {
 118             if (step.maneuver.exit <= 10) {
 119               instText += I18n.t(template + '_with_exit_ordinal', { exit: I18n.t('javascripts.directions.instructions.exit_counts.' + numToWord(step.maneuver.exit)), name: name });
 120             } else {
 121               instText += I18n.t(template + '_with_exit', { exit: step.maneuver.exit, name: name });
 122             }
 123           } else {
 124             instText += I18n.t(template + '_without_exit', { name: name });
 125           }
 126         } else if (step.maneuver.type.match(/on ramp|off ramp/)) {
 127           var params = {};
 128           if (step.exits && step.maneuver.type.match(/off ramp/)) params.exit = step.exits;
 129           if (step.destinations) params.directions = destinations;
 130           if (namedRoad) params.directions = name;
 131           if (Object.keys(params).length > 0) {
 132             template = template + "_with_" + Object.keys(params).join("_");
 133           }
 134           instText += I18n.t(template, params);
 135         } else {
 136           instText += I18n.t(template + '_without_exit', { name: name });
 137         }
 138         return [[step.maneuver.location[1], step.maneuver.location[0]], ICON_MAP[maneuver_id], instText, step.distance, step_geometry];
 139       });
 140
 141       return transformed_steps;
 142     },
 143
 144     getRoute: function (points, callback) {
 145
 146       var params = [
 147         { name: "overview", value: "false" },
 148         { name: "geometries", value: "polyline" },
 149         { name: "steps", value: true }
 150       ];
 151
 152
 153       if (cachedHints.length === points.length) {
 154         params.push({name: "hints", value: cachedHints.join(";")});
 155       } else {
 156         // invalidate cache
 157         cachedHints = [];
 158       }
 159
 160       var encoded_coords = points.map(function(p) {
 161         return p.lng + ',' + p.lat;
 162       }).join(';');
 163
 164       var req_url = OSM.OSRM_URL + encoded_coords;
 165
 166       var onResponse = function (data) {
 167         if (data.code !== 'Ok')
 168           return callback(true);
 169
 170         cachedHints = data.waypoints.map(function(wp) {
 171           return wp.hint;
 172         });
 173
 174         var line = [];
 175         var transformLeg = function (leg) {
 176           return this._transformSteps(leg.steps, line);
 177         };
 178
 179         var steps = [].concat.apply([], data.routes[0].legs.map(transformLeg.bind(this)));
 180
 181         callback(false, {
 182           line: line,
 183           steps: steps,
 184           distance: data.routes[0].distance,
 185           time: data.routes[0].duration
 186         });
 187       };
 188
 189       return $.ajax({
 190         url: req_url,
 191         data: params,
 192         dataType: "json",
 193         success: onResponse.bind(this),
 194         error: function () {
 195           callback(true);
 196         }
 197       });
 198     }
 199   };
 200 }
 201
 202 OSM.Directions.addEngine(new OSRMEngine(), true);