Add distance/time summary
[rails.git] / app / assets / javascripts / routing.js.erb
index f496262d2aac30aab377ecdcf8a5d8e0b8085f15..42373ef9d7ec740e738a6a0b4738ad17de2f0881 100644 (file)
@@ -6,31 +6,13 @@
        https://github.com/apmon/openstreetmap-website/compare/routing2
        https://github.com/apmon/openstreetmap-website/blob/9755c3ae0a8d0684d43760f91dc864ff42d8477a/app/views/routing/start.js.erb
 
        https://github.com/apmon/openstreetmap-website/compare/routing2
        https://github.com/apmon/openstreetmap-website/blob/9755c3ae0a8d0684d43760f91dc864ff42d8477a/app/views/routing/start.js.erb
 
-       *** draggable start/end markers
-       *** click each part
        *** translation (including all alerts and presentation)
        *** export GPX
        *** URL history (or do we consciously not want to support that?)
        *** translation (including all alerts and presentation)
        *** export GPX
        *** URL history (or do we consciously not want to support that?)
+       *** add YOURS engine
 */
 
 */
 
-var TURN_INSTRUCTIONS=["",
-       "Continue on ",                         // 1
-       "Slight right onto ",           // 2
-       "Turn right onto ",                     // 3
-       "Sharp right onto ",            // 4
-       "U-turn along ",                        // 5
-       "Sharp left onto ",                     // 6
-       "Turn left onto ",                      // 7
-       "Slight left onto ",            // 8
-       "(via point) ",                         // 9
-       "Follow ",                                      // 10
-       "At roundabout take ",          // 11
-       "Leave roundabout - ",          // 12
-       "Stay on roundabout - ",        // 13
-       "Start at end of ",                     // 14
-       "Reach destination",            // 15
-       "Go against one-way on ",       // 16
-       "End of one-way on "]           // 17
+var TURN_INSTRUCTIONS=[]
 
 var ROUTING_POLYLINE={
        color: '#03f',
 
 var ROUTING_POLYLINE={
        color: '#03f',
@@ -39,16 +21,67 @@ var ROUTING_POLYLINE={
 };
 
 
 };
 
 
+OSM.RoutingEngines={
+       list: []
+       // common functions and constants, e.g. OSRM parser, can go here
+};
+
 OSM.Routing=function(map,name,jqSearch) {
        var r={};
 OSM.Routing=function(map,name,jqSearch) {
        var r={};
+
+    TURN_INSTRUCTIONS=["",
+       I18n.t('javascripts.directions.instructions.continue_on'),                              // 1
+       I18n.t('javascripts.directions.instructions.slight_right'),             // 2
+       I18n.t('javascripts.directions.instructions.turn_right'),                       // 3
+       I18n.t('javascripts.directions.instructions.sharp_right'),              // 4
+       I18n.t('javascripts.directions.instructions.uturn'),                    // 5
+       I18n.t('javascripts.directions.instructions.sharp_left'),                       // 6
+       I18n.t('javascripts.directions.instructions.turn_left'),                        // 7
+       I18n.t('javascripts.directions.instructions.slight_left'),              // 8
+       I18n.t('javascripts.directions.instructions.via_point'),                                // 9
+       I18n.t('javascripts.directions.instructions.follow'),                                   // 10
+       I18n.t('javascripts.directions.instructions.roundabout'),               // 11
+       I18n.t('javascripts.directions.instructions.leave_roundabout'),         // 12
+       I18n.t('javascripts.directions.instructions.stay_roundabout'),  // 13
+       I18n.t('javascripts.directions.instructions.start'),                    // 14
+       I18n.t('javascripts.directions.instructions.destination'),              // 15
+       I18n.t('javascripts.directions.instructions.against_oneway'),   // 16
+       I18n.t('javascripts.directions.instructions.end_oneway')]               // 17
+
        r.map=map;                              // Leaflet map
        r.name=name;                    // global variable name of this instance (needed for JSONP)
        r.jqSearch=jqSearch;    // JQuery object for search panel
 
        r.map=map;                              // Leaflet map
        r.name=name;                    // global variable name of this instance (needed for JSONP)
        r.jqSearch=jqSearch;    // JQuery object for search panel
 
-       r.route_from=null;
-       r.route_to=null;
-       r.viaPoints=[];
-       r.polyline=null;
+       r.route_from=null;              // null=unset, false=awaiting response, [lat,lon]=geocoded
+       r.route_to=null;                //  |
+       r.awaitingGeocode=false;// true if the user has requested a route, but we're waiting on a geocode result
+       r.awaitingRoute=false;  // true if we've asked the engine for a route and are waiting to hear back
+       r.dragging=false;               // true if the user is dragging a start/end point
+       r.viaPoints=[];                 // not yet used
+
+       r.polyline=null;                // Leaflet polyline object
+       r.popup=null;                   // Leaflet popup object
+       r.marker_from=null;             // Leaflet from marker
+       r.marker_to=null;               // Leaflet to marker
+
+       r.chosenEngine=null;    // currently selected routing engine
+
+       var icon_from = L.icon({
+               iconUrl: <%= asset_path('marker-green.png').to_json %>,
+               iconSize: [25, 41],
+               iconAnchor: [12, 41],
+               popupAnchor: [1, -34],
+               shadowUrl: <%= asset_path('images/marker-shadow.png').to_json %>,
+               shadowSize: [41, 41]
+       });
+       var icon_to = L.icon({
+               iconUrl: <%= asset_path('marker-red.png').to_json %>,
+               iconSize: [25, 41],
+               iconAnchor: [12, 41],
+               popupAnchor: [1, -34],
+               shadowUrl: <%= asset_path('images/marker-shadow.png').to_json %>,
+               shadowSize: [41, 41]
+       });
 
        // Geocoding
 
 
        // Geocoding
 
@@ -59,28 +92,88 @@ OSM.Routing=function(map,name,jqSearch) {
                var querystring = '<%= NOMINATIM_URL %>search?q=' + encodeURIComponent(v) + '&format=json';
                // *** &accept-language=<%#= request.user_preferred_languages.join(',') %>
                // *** prefer current viewport
                var querystring = '<%= NOMINATIM_URL %>search?q=' + encodeURIComponent(v) + '&format=json';
                // *** &accept-language=<%#= request.user_preferred_languages.join(',') %>
                // *** prefer current viewport
+               r[field.id]=false;
                $.getJSON(querystring, function(json) { _this._gotGeocode(json,field); });
        };
        
        r._gotGeocode=function(json,field) {
                if (json.length==0) {
                $.getJSON(querystring, function(json) { _this._gotGeocode(json,field); });
        };
        
        r._gotGeocode=function(json,field) {
                if (json.length==0) {
-                       alert("Sorry, couldn't find that place.");      // *** internationalise
+                       alert(I18n.t('javascripts.directions.errors.no_place'));
                        r[field.id]=null;
                        return;
                }
                field.value=json[0].display_name;
                var lat=Number(json[0].lat), lon=Number(json[0].lon);
                r[field.id]=[lat,lon];
                        r[field.id]=null;
                        return;
                }
                field.value=json[0].display_name;
                var lat=Number(json[0].lat), lon=Number(json[0].lon);
                r[field.id]=[lat,lon];
-               // ** update markers
+               r.updateMarker(field.id);
+               if (r.awaitingGeocode) {
+                       r.awaitingGeocode=false;
+                       r.requestRoute(true, true);
+               }
+       };
+
+       // Drag and drop markers
+       
+       r.handleDrop=function(e) {
+               var oe=e.originalEvent;
+               var id=oe.dataTransfer.getData('id');
+               var pt=L.DomEvent.getMousePosition(oe,map.getContainer());      // co-ordinates of the mouse pointer at present
+               pt.x+=Number(oe.dataTransfer.getData('offsetX'));
+               pt.y+=Number(oe.dataTransfer.getData('offsetY'));
+               var ll=map.containerPointToLatLng(pt);
+               r.createMarker(ll,id);
+               r.setNumericInput(ll,id);
+               r.requestRoute(true, false);
+               // update to/from field
+       };
+       r.createMarker=function(latlng,id) {
+               if (r[id]) r.map.removeLayer(r[id]);
+               r[id]=L.marker(latlng, {
+                       icon: id=='marker_from' ? icon_from : icon_to,
+                       draggable: true,
+                       name: id
+               }).addTo(r.map);
+               r[id].on('drag',r.markerDragged);
+               r[id].on('dragend',r.markerDragged);
+       };
+       // Update marker from geocoded route input
+       r.updateMarker=function(id) {
+               var m=id.replace('route','marker');
+               if (!r[m]) { r.createMarker(r[id],m); return; }
+               var ll=r[m].getLatLng();
+               if (ll.lat!=r[id][0] || ll.lng!=r[id][1]) {
+                       r.createMarker(r[id],m);
+               }
+       };
+       // Marker has been dragged
+       r.markerDragged=function(e) {
+               r.dragging=(e.type=='drag');    // true for drag, false for dragend
+               if (r.dragging && !r.chosenEngine.draggable) return;
+               if (r.dragging && r.awaitingRoute) return;
+               r.setNumericInput(e.target.getLatLng(), e.target.options.name);
+               r.requestRoute(!r.dragging, false);
        };
        };
+       // Set a route input field to a numeric value
+       r.setNumericInput=function(ll,id) {
+               var routeid=id.replace('marker','route');
+               r[routeid]=[ll.lat,ll.lng];
+               $("[name="+routeid+"]:visible").val(Math.round(ll.lat*10000)/10000+" "+Math.round(ll.lng*10000)/10000);
+       }
        
        // Route-fetching UI
 
        
        // Route-fetching UI
 
-       r.requestRoute=function() {
+       r.requestRoute=function(isFinal, updateZoom) {
                if (r.route_from && r.route_to) {
                if (r.route_from && r.route_to) {
-                       var chosen=jqSearch.find('select.routing_engines :selected').val();
-                       r.engines[chosen].getRoute(true,[r.route_from,r.route_to]);
+                       $(".query_wrapper.routing .spinner").show();
+                       r.awaitingRoute=true;
+                       r.chosenEngine.getRoute(isFinal,[r.route_from,r.route_to]);
+                       if(updateZoom){
+                               r.map.fitBounds(L.latLngBounds([r.route_from, r.route_to]).pad(0.05));
+                       }
                        // then, when the route has been fetched, it'll call the engine's gotRoute function
                        // then, when the route has been fetched, it'll call the engine's gotRoute function
+               } else if (r.route_from==false || r.route_to==false) {
+                       // we're waiting for a Nominatim response before we can request a route
+                       r.awaitingGeocode=true;
                }
        };
 
                }
        };
 
@@ -88,30 +181,30 @@ OSM.Routing=function(map,name,jqSearch) {
        r.setPolyline=function(line) {
                if (r.polyline) map.removeLayer(r.polyline);
                r.polyline=L.polyline(line, ROUTING_POLYLINE).addTo(r.map);
        r.setPolyline=function(line) {
                if (r.polyline) map.removeLayer(r.polyline);
                r.polyline=L.polyline(line, ROUTING_POLYLINE).addTo(r.map);
-               r.map.fitBounds(r.polyline.getBounds());
+               // r.map.fitBounds(r.polyline.getBounds());
+               // *** ^^^ we only want to do this for geocode-originated routes
        };
 
        };
 
-       // Take an array of directions and write it out
-       // (we use OSRM's route_instructions format)
-       // *** translations?
-       r.setItinerary=function(steps) {
+       // Take directions and write them out
+       // data = { steps: array of [latlng, sprite number, instruction text, distance in metres] }
+       // sprite numbers equate to OSRM's route_instructions turn values
+       r.setItinerary=function(data) {
                // Create base table
                $("#content").removeClass("overlay-sidebar");
                $('#sidebar_content').empty();
                // Create base table
                $("#content").removeClass("overlay-sidebar");
                $('#sidebar_content').empty();
-               var html='<h2><a class="geolink" href="#" onclick="$(~.close_directions~).click();return false;"><span class="icon close"></span></a>Directions</h2>'.replace(/~/g,"'");
-               html+="<table id='turnbyturn' />";
-        $('#sidebar_content').html(html);
+               var html=('<h2><a class="geolink" href="#" onclick="$(~.close_directions~).click();return false;">' +
+                         '<span class="icon close"></span></a>' + I18n.t('javascripts.directions.directions') + 
+                         '</h2><p id="routing_summary">' + 
+                         I18n.t('javascripts.directions.distance') + ': ' + r.formatDistance(data.distance)+ '. ' +
+                         I18n.t('javascripts.directions.time'    ) + ': ' + r.formatTime(data.time) + '.</p>' +
+                         '<table id="turnbyturn" />').replace(/~/g,"'");
+               $('#sidebar_content').html(html);
                // Add each row
                // Add each row
-               for (var i=0; i<steps.length; i++) {
-                       var step=steps[i];
-                       var instCodes=step[0].split('-');
-                       // Assemble instruction text
-                       var instText="<b>"+(i+1)+".</b> ";
-                       instText+=TURN_INSTRUCTIONS[instCodes[0]];
-                       if (instCodes[1]) { instText+="exit "+instCodes[1]+" "; }
-                       if (instCodes[0]!=15) { instText+=step[1] ? "<b>"+step[1]+"</b>" : "(unnamed)"; }
+               var cumulative=0;
+               for (var i=0; i<data.steps.length; i++) {
+                       var step=data.steps[i];
                        // Distance
                        // Distance
-                       var dist=step[2];
+                       var dist=step[3];
                        if (dist<5) { dist=""; }
                        else if (dist<200) { dist=Math.round(dist/10)*10+"m"; }
                        else if (dist<1500) { dist=Math.round(dist/100)*100+"m"; }
                        if (dist<5) { dist=""; }
                        else if (dist<200) { dist=Math.round(dist/10)*10+"m"; }
                        else if (dist<1500) { dist=Math.round(dist/100)*100+"m"; }
@@ -119,79 +212,94 @@ OSM.Routing=function(map,name,jqSearch) {
                        else { dist=Math.round(dist/1000)+"km"; }
                        // Add to table
                        var row=$("<tr class='turn'/>");
                        else { dist=Math.round(dist/1000)+"km"; }
                        // Add to table
                        var row=$("<tr class='turn'/>");
-                       row.append("<td class='direction i"+instCodes[0]+"'> ");
-                       row.append("<td class='instruction'>"+instText);
+                       row.append("<td class='direction i"+step[1]+"'> ");
+                       row.append("<td class='instruction'>"+step[2]);
                        row.append("<td class='distance'>"+dist);
                        row.append("<td class='distance'>"+dist);
-                       with ({n: i}) { row.on('click',function(e) { r.clickTurn(n); });
-                       }
+                       with ({ num: i, ll: step[0] }) {
+                               row.on('click',function(e) { r.clickTurn(num, ll); });
+                       };
                        $('#turnbyturn').append(row);
                        $('#turnbyturn').append(row);
+                       cumulative+=step[3];
                }
                }
+               $('#sidebar_content').append('<p id="routing_credit">' + r.chosenEngine.creditline + '</p>');
+
        };
        };
-       r.clickTurn=function(num) {
-               console.log("clicked turn",num);
+       r.clickTurn=function(num,latlng) {
+               r.popup=L.popup().setLatLng(latlng).setContent("<p>"+(num+1)+"</p>").openOn(r.map);
+       };
+       r.formatDistance=function(m) {
+               if      (m < 1000 ) { return Math.round(m) + "m"; }
+               else if (m < 10000) { return (m/1000.0).toFixed(1) + "km"; }
+               else                { return Math.round(m / 1000)  + "km"; }
+       };
+       r.formatTime=function(s) {
+               var d=new Date(s*1000); var h=d.getHours(); var m=d.getMinutes();
+               return h+":"+(m<10 ? '0' : '')+m;
        };
        };
-
 
        // Close all routing UI
        
        r.close=function() {
                $("#content").addClass("overlay-sidebar");
 
        // Close all routing UI
        
        r.close=function() {
                $("#content").addClass("overlay-sidebar");
-               if (r.polyline) map.removeLayer(r.polyline);
+               r.route_from=r.route_to=null;
+               $(".query_wrapper.routing input").val("");
+               var remove=['polyline','popup','marker_from','marker_to'];
+               for (var i=0; i<remove.length; i++) {
+                       if (r[remove[i]]) { map.removeLayer(r[remove[i]]); r[remove[i]]=null; }
+               }
        };
 
        };
 
-       // Add engines
-       
-       r.engines=[];
-       r.addEngine=function(engine) {
-               // Save engine
-               var i=r.engines.length;
-               engine.subscript=i;
-               r['engine'+i]=engine;
-               r.engines.push(engine);
-
-               // Add generic JSONP function
-               engine.requestJSONP=function(url) {
-                       var script = document.createElement('script');
-                       script.src = url+"&jsonp="+r.name+".engine"+this.subscript+".gotRoute";
-                       // OSRM doesn't like non-alphanumeric, otherwise we could just do OSM.routing.engines["+engine.subscript+"].gotRoute
-                       document.body.appendChild(script); 
-               };
-
-               // Populate dropdown
-               var select=jqSearch.find('select.routing_engines');
-               select.append("<option value='"+i+"'>"+engine.name+"</option>");
-       };
+       // Routing engine handling
 
 
-       // OSRM car engine
-       // *** this should all be shared from an OSRM library somewhere
-       // *** need to clear hints at some point
-
-       r.addEngine({
-               name: 'Car (OSRM)',
-               draggable: true,
-               _hints: {},
-               getRoute: function(final,points) {
-                       var url="http://router.project-osrm.org/viaroute?z=14&output=json";
-                       for (var i=0; i<points.length; i++) {
-                               var pair=points[i].join(',');
-                               url+="&loc="+pair;
-                               if (this._hints[pair]) url+= "&hint="+this._hints[pair];
-                       }
-                       if (final) url+="&instructions=true";
-                       this.requestJSONP(url);
-               },
-               gotRoute: function(data) {
-                       if (data.status==207) {
-                               alert("Couldn't find route between those two places");
-                               return false;
+       // Add all engines
+       var list=OSM.RoutingEngines.list;
+       list.sort(function(a,b) { return I18n.t(a.name)>I18n.t(b.name); });
+       var select=r.jqSearch.find('select.routing_engines');
+       for (var i=0; i<list.length; i++) {
+               // Set up JSONP callback
+               with ({num: i}) {
+                       list[num].requestJSONP=function(url) {
+                               var script = document.createElement('script');
+                               script.src = url+r.name+".gotRoute"+num;
+                               document.body.appendChild(script); 
+                       };
+                       list[num].requestCORS=function(url) {
+                               $.ajax({ url: url, method: "GET", data: {}, dataType: 'json', success: r['gotRoute'+num] });
+                       };
+                       r['gotRoute'+num]=function(data) { 
+                               r.awaitingRoute=false;
+                               $(".query_wrapper.routing .spinner").hide();
+                               if (!list[num].gotRoute(r,data)) {
+                                       // No route found
+                                       if (r.polyline) {
+                                               map.removeLayer(r.polyline);
+                                               r.polyline=null;
+                                       }
+                                       if (!r.dragging) { alert(I18n.t('javascripts.directions.errors.no_route')); }
+                               }
+                       };
+               }
+               select.append("<option value='"+i+"'>"+I18n.t(list[i].name)+"</option>");
+       }
+       r.engines=list;
+       r.chosenEngine=list[0]; // default to first engine
+
+       // Choose an engine on dropdown change
+       r.selectEngine=function(e) {
+               r.chosenEngine=r.engines[e.target.selectedIndex];
+               if (r.polyline){ // and if a route is currently showing, must also refresh, else confusion
+                       r.requestRoute(true, false);
+               }
+       };
+       // Choose an engine by name
+       r.chooseEngine=function(name) {
+               for (var i=0; i<r.engines.length; i++) {
+                       if (r.engines[i].name==name) {
+                               r.chosenEngine=r.engines[i];
+                               r.jqSearch.find('select.routing_engines').val(i);
                        }
                        }
-                       // *** store hints
-                       var line=L.PolylineUtil.decode(data.route_geometry);
-                       for (i=0; i<line.length; i++) { line[i].lat/=10; line[i].lng/=10; }
-                       r.setPolyline(line);
-                       r.setItinerary(data.route_instructions);
                }
                }
-       });
+       };
 
        return r;
 };
 
        return r;
 };