From 979327ec82fb03ef945d3695ee9d74fc80b785fa Mon Sep 17 00:00:00 2001
From: DennisSchiefer <shiin@gmx.de>
Date: Mon, 14 May 2012 12:18:04 +0100
Subject: [PATCH] refactored code for history routes

---
 WebContent/base/Backup.OSRM.HistoryRoutes.js | 178 -------------------
 WebContent/base/OSRM.HistoryRoutes.js        |  69 +++----
 WebContent/base/OSRM.Via.js                  |  10 +-
 WebContent/routing/OSRM.Routing.js           |  14 +-
 4 files changed, 38 insertions(+), 233 deletions(-)
 delete mode 100644 WebContent/base/Backup.OSRM.HistoryRoutes.js

diff --git a/WebContent/base/Backup.OSRM.HistoryRoutes.js b/WebContent/base/Backup.OSRM.HistoryRoutes.js
deleted file mode 100644
index 0a89d8caa..000000000
--- a/WebContent/base/Backup.OSRM.HistoryRoutes.js
+++ /dev/null
@@ -1,178 +0,0 @@
-/*
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU AFFERO General Public License as published by
-the Free Software Foundation; either version 3 of the License, or
-any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-or see http://www.gnu.org/licenses/agpl.txt.
-*/
-
-// OSRM route management (handles drawing of route geometry - current route, old route, unnamed route, highlight unnamed streets) 
-// [this holds the route geometry]
-
-
-OSRM.HistoryRoute = function() {
-	// how to draw history routes and how many
-	this._history_styles = [{dashed:false, color:'#FFFFFF', opacity:0.5, weight:5},
-	                        {dashed:false, color:'#0000DD', opacity:0.45, weight:5},
-	                        {dashed:false, color:'#0000BB', opacity:0.40, weight:5},
-	                        {dashed:false, color:'#000099', opacity:0.35, weight:5},
-	                        {dashed:false, color:'#000077', opacity:0.30, weight:5},
-	                        {dashed:false, color:'#000055', opacity:0.25, weight:5},
-	                        {dashed:false, color:'#000033', opacity:0.20, weight:5},
-	                        {dashed:false, color:'#000011', opacity:0.15, weight:5},
-	                        {dashed:false, color:'#FF0000', opacity:0.50, weight:5}	                              
-	                        ];
-	this._history_routes = this._history_styles.length;
-	
-	// actual history data
-	this._history_route = [];
-	this._history_data = [];
-	for(var i=0, size=this._history_routes; i<size; i++) {
-		this._history_route.push( new OSRM.SimpleRoute("current" , {dashed:false} ) );
-		this._history_data[i] = [];
-	}
-	
-	// helper functions bound to this
-	this._initiate_redrawHistory = OSRM.bind(this, this._getRoute_RedrawHistory);
-	this._callback_redrawHistory = OSRM.bind(this, this._showRoute_RedrawHistory);
-};
-OSRM.extend( OSRM.HistoryRoute,{
-	activate: function() {
-		this.storeHistoryRoute = this._storeHistoryRoute;
-		this.fetchHistoryRoute = this._fetchHistoryRoute;
-		this.showHistoryRoutes = this._showHistoryRoutes;
-		this.clearHistoryRoutes = this._clearHistoryRoutes;
-		OSRM.G.map.on('zoomend', this._initiate_redrawHistory );
-		
-		this.storeHistoryRoute();
-	},
-	deactivate: function() {
-		this.clearHistoryRoutes();
-		
-		this.storeHistoryRoute = this.empty;
-		this.fetchHistoryRoute = this.empty;
-		this.showHistoryRoutes = this.empty;
-		this.clearHistoryRoutes = this.empty;
-		OSRM.G.map.off('zoomend', this._initiate_redrawHistory );
-	},
-	
-	// empty function
-	empty: function() {},
-	storeHistoryRoute: function() {},
-	fetchHistoryRoute: function() {},
-	showHistoryRoutes: function() {},
-	clearHistoryRoutes: function() {},
-	
-	// qctual functions
-	_storeHistoryRoute: function() {
-		var route = OSRM.G.route;
-		
-		if(route.isShown() && route.isRoute()) {
-			console.log("store");			
-			// store new route and positions in staging spot
-			this._history_route[0].setPositions( route.getPositions() );
-			this._history_data[0] = [];
-			var markers = OSRM.G.markers.route;
-			for(var i=0,size=markers.length; i<size; i++) {
-				var position = {
-						lat:markers[i].getLat(),
-						lng:markers[i].getLng(),
-						hint:markers[i].hint
-				};
-				this._history_data[0].push(position);
-			}
-			this._history_data[0].checksum = OSRM.G.markers.checksum;
-		}
-	},
-	_showHistoryRoutes: function() {
-		console.log("show");
-		for(var i=1,size=this._history_routes; i<size; i++) {
-			this._history_route[i].setStyle( this._history_styles[i] );
-			this._history_route[i].show();
-		}
-	},
-	_clearHistoryRoutes: function() {
-		for(var i=0,size=this._history_routes; i<size; i++) {
-			this._history_route[i].hide();
-			this._history_route[i].setPositions( [] );
-			this._history_data[i] = [];
-		}
-	},
-	_fetchHistoryRoute: function() {
-		if( this._history_data[0].length == 0)
-			return;
-		if( this._equalRoute() )
-			return;
-		console.log("fetch");
-		// move route and positions
-		for(var i=this._history_routes-1; i>0; i--) {
-			this._history_route[i].setPositions( this._history_route[i-1].getPositions() );
-			this._history_data[i] = this._history_data[i-1];
-		}
-		// reset staging spot
-		this._history_route[0].setPositions( [] );
-		this._history_data[0] = [];
-	},
-	_equalRoute: function() {
-		var lhs = OSRM.G.markers.route;
-		var rhs = this._history_data[0];
-		for(var i=0,size=Math.min(rhs.length,lhs.length); i<size; i++) {
-			if( lhs[i].getLat() != rhs[i].lat || lhs[i].getLng() != rhs[i].lng) {
-				console.log("different routes");
-				return false;
-			}
-		}
-		console.log("same routes");
-		return true;
-//	 	OSRM.G.markers.route[0].setPosition( positions[0] );
-//	 	OSRM.G.markers.route[OSRM.G.markers.route.length-1].setPosition( positions[positions.length-1] );
-//	 	for(var i=0; i<OSRM.G.via_points.length; i++)
-//			OSRM.G.markers.route[i+1].setPosition( new L.LatLng(OSRM.G.via_points[i][0], OSRM.G.via_points[i][1]) );		
-	},
-	
-	// redraw
-	_showRoute_RedrawHistory: function(response, history_id) {
-		if(!response)
-			return;
-		
-		var positions = OSRM.RoutingGeometry._decode(response.route_geometry, 5);
-		this._history_route[history_id].setPositions(positions);
-		this._updateHints(response, history_id);
-	},
-	_getRoute_RedrawHistory: function() {
-		for(var i=0,size=this._history_routes; i<size; i++)
-			if( this._history_data[i].length > 0 ) {
-				OSRM.JSONP.clear('history'+i);
-				OSRM.JSONP.call(this._buildCall(i)+'&instructions=false', this._callback_redrawHistory, OSRM.JSONP.empty, OSRM.DEFAULTS.JSONP_TIMEOUT, 'history'+i, i);
-			}
-	},
-	_buildCall: function(history_id) {
-		var source = OSRM.DEFAULTS.HOST_ROUTING_URL;
-		source += '?z=' + OSRM.G.map.getZoom() + '&output=json&jsonp=%jsonp&geomformat=cmp';
-		var data = this._history_data[history_id];
-		if(data.checksum)
-			source += '&checksum=' + data.checksum;
-		for(var i=0,size=data.length; i<size; i++) {
-			source += '&loc='  + data[i].lat.toFixed(6) + ',' + data[i].lng.toFixed(6);
-			if( data[i].hint)
-				source += '&hint=' + data[i].hint;
-		}
-		return source;
-	},
-	_updateHints: function(response, history_id) {
-		var data = this._history_data[history_id];
-		data.checksum = response.hint_data.checksum;
-		var hint_locations = response.hint_data.locations;
-		for(var i=0; i<hint_locations.length; i++)
-			data[i].hint = hint_locations[i];		
-	}
-});
\ No newline at end of file
diff --git a/WebContent/base/OSRM.HistoryRoutes.js b/WebContent/base/OSRM.HistoryRoutes.js
index 606f0ed9c..cf4b663fe 100644
--- a/WebContent/base/OSRM.HistoryRoutes.js
+++ b/WebContent/base/OSRM.HistoryRoutes.js
@@ -78,35 +78,28 @@ OSRM.extend( OSRM.HistoryRoute,{
 	// actual functions
 	_storeHistoryRoute: function() {
 		var route = OSRM.G.route;
-		if(route.isShown() && route.isRoute()) {
-			// store current route in staging spot
-			this._history[0].route.setPositions( route.getPositions() );
-			this._history[0].checksum = OSRM.G.markers.checksum;
-			this._history[0].markers = [];
+		if( !route.isShown() || !route.isRoute() )
+			return;
+			
+		// store current route in staging spot
+		var hint_data = OSRM.G.response.hint_data;
+		this._history[0].route.setPositions( route.getPositions() );
+		this._history[0].checksum = hint_data.checksum;
+		this._history[0].markers = [];
 
-			var route = this._currentRoute();
-			for(var i=0,size=OSRM.G.response.hint_data.locations.length; i<size; i++) {
-				var position = {
-						lat:route[i].lat,
-						lng:route[i].lng,
-						//hint:OSRM.G.response.hint_data.locations[i]
-				};
-				this._history[0].markers.push(position);
-			}
-		
-			console.log("store", this._history[0].markers);
+		var markers = this._getCurrentMarkers();
+		for(var i=0,size=markers.length; i<size; i++) {
+			var position = { lat:markers[i].lat, lng:markers[i].lng, hint:hint_data.locations[i] };
+			this._history[0].markers.push(position);
 		}
 	},
 	_fetchHistoryRoute: function() {
-		var route = this._currentRoute();
-		if( OSRM.G.route.isShown() && this._equalRoute(this._history[0].markers, route) ) {
-			console.log("fetch failed 1");
+		if( this._history[0].markers.length == 0 )
 			return;
-		}
-		if( this._equalRoute(this._history[1].markers, this._history[0].markers) ) {
-			console.log("fetch failed 2");
+		if( OSRM.G.route.isShown() && this._equalMarkers(this._history[0].markers, this._getCurrentMarkers()) )
 			return;
-		}
+		if( this._equalMarkers(this._history[0].markers, this._history[1].markers) )
+			return;		
 
 		// move all routes down one position
 		for(var i=this._history_length-1; i>0; i--) {
@@ -118,18 +111,15 @@ OSRM.extend( OSRM.HistoryRoute,{
 		this._history[0].route.setPositions( [] );
 		this._history[0].markers = [];
 		this._history[0].checksum = null;
-		
-		console.log("fetch", this._history[1].markers);		
 	},	
 	_showHistoryRoutes: function() {
-		console.log("show");
 		for(var i=1,size=this._history_length; i<size; i++) {
 			this._history[i].route.setStyle( this._history_styles[i] );
 			this._history[i].route.show();
+			OSRM.G.route.hideOldRoute();
 		}
 	},
 	_clearHistoryRoutes: function() {
-		console.log("clear");
 		for(var i=0,size=this._history_length; i<size; i++) {
 			this._history[i].route.hide();
 			this._history[i].route.setPositions( [] );
@@ -138,36 +128,29 @@ OSRM.extend( OSRM.HistoryRoute,{
 		}
 	},
 	
-	//get current route
-	_currentRoute: function() {
+	// get positions of current markers (note: data of jsonp response used, as not all data structures updated!)
+	_getCurrentMarkers: function() {
 		var route = [];
 		
 		var positions = OSRM.G.route.getPositions();
 		if(positions.length == 0)
 			return route;
+		
 		route.push( {lat: positions[0].lat, lng: positions[0].lng });
 		for(var i=0; i<OSRM.G.response.via_points.length; i++)
 			route.push( {lat:OSRM.G.response.via_points[i][0], lng:OSRM.G.response.via_points[i][1]} );
 		route.push( {lat: positions[positions.length-1].lat, lng: positions[positions.length-1].lng });
-		
 		return route;
 	},
 	
-	// check if routes are the same
-	_equalRoute: function(lhs, rhs) {
-		console.log("lhs",lhs);
-		console.log("rhs",rhs);
-		if(lhs.length == 0) {
-			console.log("different routes");
+	// check if two routes are equivalent by checking their markers
+	_equalMarkers: function(lhs, rhs) {
+		if(lhs.length != rhs.length)
 			return false;
-		}
-		for(var i=0,size=Math.min(rhs.length,lhs.length); i<size; i++) {
-			if( lhs[i].lat != rhs[i].lat || lhs[i].lng != rhs[i].lng) {
-				console.log("different routes");
+		for(var i=0,size=lhs.length; i<size; i++) {
+			if( lhs[i].lat != rhs[i].lat || lhs[i].lng != rhs[i].lng)
 				return false;
-			}
 		}
-		console.log("same routes");
 		return true;
 	},
 	
@@ -178,7 +161,7 @@ OSRM.extend( OSRM.HistoryRoute,{
 		
 		var positions = OSRM.RoutingGeometry._decode(response.route_geometry, 5);
 		this._history[history_id].route.setPositions(positions);
-		//this._updateHints(response, history_id);
+		this._updateHints(response, history_id);
 	},
 	_getRoute_RedrawHistory: function() {
 		for(var i=0,size=this._history_length; i<size; i++)
diff --git a/WebContent/base/OSRM.Via.js b/WebContent/base/OSRM.Via.js
index 9775d3b3d..8aa963fe2 100644
--- a/WebContent/base/OSRM.Via.js
+++ b/WebContent/base/OSRM.Via.js
@@ -18,9 +18,6 @@ or see http://www.gnu.org/licenses/agpl.txt.
 // OSRM via marker routines
 // [find correct position for a via marker]
 
-// store location of via points returned by server
-OSRM.GLOBALS.via_points = [];
-
 
 OSRM.Via = {
 		
@@ -49,10 +46,11 @@ findViaIndex: function( new_via_position ) {
 	var nearest_index = OSRM.Via._findNearestRouteSegment( new_via_position );
 
 	// find correct index to insert new via node
-	var new_via_index = OSRM.G.via_points.length;
+	var via_points = OSRM.G.response.via_points;
+	var new_via_index = via_points.length;
 	var via_index = Array();
-	for(var i=0; i<OSRM.G.via_points.length; i++) {
-		via_index[i] = OSRM.Via._findNearestRouteSegment( new L.LatLng(OSRM.G.via_points[i][0], OSRM.G.via_points[i][1]) );
+	for(var i=0; i<via_points.length; i++) {
+		via_index[i] = OSRM.Via._findNearestRouteSegment( new L.LatLng(via_points[i][0], via_points[i][1]) );
 		if(via_index[i] > nearest_index) {
 			new_via_index = i;
 			break;
diff --git a/WebContent/routing/OSRM.Routing.js b/WebContent/routing/OSRM.Routing.js
index a3318922c..9c3bd8ff8 100644
--- a/WebContent/routing/OSRM.Routing.js
+++ b/WebContent/routing/OSRM.Routing.js
@@ -58,7 +58,6 @@ showRoute: function(response) {
 		return;
 	
 	OSRM.G.response = response;	// needed for printing & history routes!
-	OSRM.G.via_points = response.via_points.slice(0);
 	if(response.status == 207) {
 		OSRM.RoutingGeometry.showNA();
 		OSRM.RoutingNoNames.showNA();
@@ -95,6 +94,7 @@ showRoute_Redraw: function(response) {
 	if(!response)
 		return;
 	
+	//OSRM.G.response = response;	// not needed, even harmful as important information is not stored!
 	if(response.status != 207) {
 		OSRM.RoutingGeometry.show(response);
 		OSRM.RoutingNoNames.show(response);
@@ -171,11 +171,13 @@ _updateHints: function(response) {
 // snap all markers to the received route
 _snapRoute: function() {
 	var positions = OSRM.G.route.getPositions();
- 	
- 	OSRM.G.markers.route[0].setPosition( positions[0] );
- 	OSRM.G.markers.route[OSRM.G.markers.route.length-1].setPosition( positions[positions.length-1] );
- 	for(var i=0; i<OSRM.G.via_points.length; i++)
-		OSRM.G.markers.route[i+1].setPosition( new L.LatLng(OSRM.G.via_points[i][0], OSRM.G.via_points[i][1]) );
+	var markers = OSRM.G.markers.route;
+	var via_points = OSRM.G.response.via_points;
+	
+ 	markers[0].setPosition( positions[0] );
+ 	markers[markers.length-1].setPosition( positions[positions.length-1] );
+ 	for(var i=0; i<via_points.length; i++)
+ 		markers[i+1].setPosition( new L.LatLng(via_points[i][0], via_points[i][1]) );
 
  	OSRM.Geocoder.updateAddress(OSRM.C.SOURCE_LABEL);
  	OSRM.Geocoder.updateAddress(OSRM.C.TARGET_LABEL);