New ctrl + key support, new help screen and bug solved in route 'path finding'

New function Vtracert::ctrlUnicode(c) that returns the unicode representation of ctrl+letter.
New function Vtracert.help() that display an help screen
New path finding for routes, now they take the shorter horizontal direction (added a new propertie VtraceMap.scaledWidth updated by VtraceMap.genXlimits() to perfom this)
Various small code refactor and comments

tracer.py

@@ -47,6 +47,7 @@ class Tracer:
 		
 		
 		self.prev = None
+		self.prevLonLat = None
 		
 		self.selected = [] #selected hop
 		
@@ -68,6 +69,7 @@ class Tracer:
 	def progressStatus(self):
 		self.vtr.drawStatus("Traceroute in progress : ...", self.vtr.font['status'],self.vtr.col['trace_progress'])
 		pass
+		
 	
 	## Generator that yield ips from a running traceroute
 	# @param The host to traceroute to
@@ -85,7 +87,6 @@ class Tracer:
 		#Update status bar
 		self.progressStatus()
 		self.vtr.flip()
-		yield self.src
 		
 		#Run traceroute process
 		p = Popen(['traceroute', dest_name], stdout=PIPE)
@@ -96,8 +97,17 @@ class Tracer:
 		ml = self.regetip.match(line)
 		if ml != None:
 			dest_ip = ml.group(1)
+			
+			(dlon,dlat) = self.ip2coord(dest_ip)
+			(x,y) = self.vtr.trmap.latlon2ortho(dlon, dlat)
+
+			pygame.gfxdraw.circle(self.vtr.surf['trace'],x,y,3,self.vtr.col['trace_end'])
+			
 		else:
 			dest_ip = None
+			
+		self.vtr.flip()
+		yield self.src
 		
 		#Reading traceroute output
 		while True:
@@ -155,11 +165,10 @@ class Tracer:
 		self.ips.append(ip)
 		
 		if ip != None:
-			#gir = self.gi.record_by_name(ip)
-			gir = self.gi.record_by_addr(ip)
-			if gir != None:
+			lonlat = self.ip2coord(ip)
+			if lonlat != None:
 				#print gir['latitude'], gir['longitude']
-				self.pts.append( ( gir['longitude'], gir['latitude']) )
+				self.pts.append(lonlat)
 			else:
 				nopts = True
 		else:
@@ -169,6 +178,14 @@ class Tracer:
 			self.pts.append(None)
 		pass
 	
+	## Get geoip info for ip
+	# @param ip to localisate
+	def ip2coord(self,ip):
+		gir = self.gi.record_by_addr(ip)
+		if gir != None:
+			return ( gir['longitude'], gir['latitude'])
+		return None
+	
 	## Populate data by running a traceroute
 	# @param dest_name The host
 	def trace(self,dest_name):
@@ -212,7 +229,7 @@ class Tracer:
 	# @param (lon,lat) Hop coordinates
 	# @param selected A boolean
 	# @return The coordinates of the hop on the screen as (x,y)
-	def drawNext(self, (lon, lat), selected = False):
+	def drawNext(self, (lon, lat), selected = False, last = False):
 		
 		if not selected :
 			#If not selected draw a circle
@@ -227,10 +244,50 @@ class Tracer:
 			cdrawfun(self.vtr.surf['trace'],x,y,3,self.vtr.col['trace_init'])
 		else:
 			#A new hop
-			cdrawfun(self.vtr.surf['trace'], x,y,5,self.vtr.col['trace_hop'])
+			
+			if last:
+				cdrawfun(self.vtr.surf['trace'], x,y,3,self.vtr.col['trace_hop'])
+			else:
+				cdrawfun(self.vtr.surf['trace'], x,y,5,self.vtr.col['trace_hop'])
+			
 			(px,py) = self.prev
-			pygame.gfxdraw.line(self.vtr.surf['trace'], px,py,x,y, self.vtr.col['trace_trace'])
+			
+			#Trying to find a symetric closer from the new hop
+			dw = self.vtr.trmap.scaledWidth
+			spx1 = px - dw # x prev symetric 1
+			spx2 = px + dw # x prev symetric 2
+			
+			(plon,_) = self.prevLonLat
+
+			splon1 = plon - 360 # prev lon symetric 1
+			splon2 = plon + 360 # prev lon symetric 2
+			
+			sd1 = abs(lon-splon1)
+			sd2 = abs(lon-splon2)
+			
+			
+			if sd1 < sd2:
+				spx = spx1
+				sx = x + dw
+				sd = sd1
+			else:
+				spx = spx2
+				sx = x - dw
+				sd = sd2
+			
+			d = abs(lon-plon)
+			
+			#drawLine = Tracer.drawArcLine
+			drawLine = pygame.gfxdraw.line
+			
+			if sd > d:
+				drawLine(self.vtr.surf['trace'], px,py,x,y, self.vtr.col['trace_trace'])
+			else:
+				#symetric is closer
+				drawLine(self.vtr.surf['trace'], spx,py,x,y, self.vtr.col['trace_trace'])
+				drawLine(self.vtr.surf['trace'], px,py,sx,y, self.vtr.col['trace_trace'])
 		
+		self.prevLonLat = (lon,lat)
 		self.prev = (x,y)
 		
 		return (x,y)
@@ -245,7 +302,7 @@ class Tracer:
 		for i,pt in enumerate(self.pts):
 			
 			if pt != None:
-				dcoord = self.drawNext(pt, (i in self.selected) )
+				dcoord = self.drawNext(pt, (i in self.selected), (i == len(self.pts)-1) )
 				self.coords.append(dcoord)
 				
 				if delay > 0:

vtracemap.py

@@ -66,6 +66,7 @@ class TraceMap(object):
 		self.lonlat = TraceMap.lonlatFromFile(self.vtr.mapfile)
 		
 		self.xlimits = None
+		self.scaledWidth = 0 #Store the screen width if we will display all the map
 		self.lonlatminmax = (lonmin,lonmax,latmin,latmax)
 		self.xlimits = self.genXlimits(lonmin,lonmax,latmin,latmax)
 		
@@ -208,6 +209,7 @@ class TraceMap(object):
 			y1 = yl
 			y2 = ys
 		
+		self.scaledWidth = int(self.vtr.width * (float(self.vtr.width * 707) / (x2-x1)))
 		self.xlimits = (x2-x1,x1,y2-y1,y1)
 		return self.xlimits
 	

vtracert.py

@@ -17,6 +17,33 @@
 #        You should have received a copy of the GNU General Public License
 #        along with pyMapTraceroute.  If not, see <http://www.gnu.org/licenses/>.
 #
+control_summary = [
+"+----------------------+----------------------------------+",
+"|                Controls summary                         |",
+"+----------------------+----------------------------------+",
+"+----------------------+----------------------------------+",
+"| ^h, ?                |  display this help               |",
+"+----------------------+----------------------------------+",
+"| esc, ^q              |  exit the programm or this help  |",
+"+----------------------+----------------------------------+",
+"+----------------------+----------------------------------+",
+"| [a-zA-Z0-9\.]        |  Host input                      |",
+"+----------------------+----------------------------------+",
+"| mid-mouse btn        |  paste clipboard into host input |",
+"+----------------------+----------------------------------+",
+"| enter                |  validate host input and         |",
+"|                      |  run traceroute                  |",
+"+----------------------+----------------------------------+",
+"| ^c                   |  clear host input                |",
+"+----------------------+----------------------------------+",
+"+----------------------+----------------------------------+",
+"| mouse scroll, +, -   : zoom in/out                      |",
+"+----------------------+----------------------------------+",
+"| arrow keys           : move on the map                  |",
+"+----------------------+----------------------------------+",
+"| left mouse btn press : select hops on the map           |",
+"+----------------------+----------------------------------+"
+]
 
 import websocket
 import random
@@ -41,7 +68,7 @@ class Vtracert:
 	# @param fonts Override default font type and size its a dict of tuple (fontType, fontSize), valid keys are : prompt, status
 	# @param promptText The prompt when reading the host to traceroute
 	# @param defaultInput Default host to traceroute
-	def __init__(self, mapdatfile, width = 1024, height = 768, cols = dict(), fonts = dict(), promptText = "Type the ip or hostname to traceroute :    %s_", defaultInput = "gnu.org"):
+	def __init__(self, mapdatfile, width = 1024, height = 768, cols = dict(), fonts = dict(), promptText = "Enter an ip or an hostname and press enter to traceroute :    %s_", defaultInput = "gnu.org"):
 		
 		pygame.init() #Pygame init
 		
@@ -51,6 +78,7 @@ class Vtracert:
 		self.height = height
 		#Colors
 		self.col = dict()
+		self.col['alpha'] = pygame.Color(0,0,0,0)
 		self.col['bg'] = pygame.Color(0,0,0)
 		self.col['map'] = pygame.Color(15,8,63)
 		self.col['prompt'] = pygame.Color(200,200,200)
@@ -58,11 +86,15 @@ class Vtracert:
 		self.col['cur_status'] = self.col['status']
 		self.col['cur_statusline'] = self.col['status']
 		self.col['trace_init'] = pygame.Color(0,0xf0,0)
+		self.col['trace_end'] = pygame.Color(0xee,0x33,0xee)
 		self.col['trace_hop'] = pygame.Color(0xf0,0xf0,0)
 		self.col['trace_trace'] = pygame.Color(0xf0,0,0)
 		self.col['trace_txt'] = pygame.Color(200, 200, 200, 125)
 		self.col['trace_txtsel'] = self.col['trace_hop']
 		self.col['trace_progress'] = pygame.Color(0,0xf0,0)
+		self.col['help_txt'] =  pygame.Color(200,200,200)
+		self.col['help_title'] = pygame.Color(120,30,230)
+		self.col['help_bg'] = pygame.Color(0,0,0)
 		for n, c in cols:
 			self.col[n] = pygame.Color(c)
 		#Fonts
@@ -71,13 +103,18 @@ class Vtracert:
 		self.font['status'] = pygame.font.Font(None,20)
 		self.font['cur_status'] = self.col['status']
 		self.font['trace_txt'] = pygame.font.Font(None,20)
+		
+		self.font['help_title'] = pygame.font.Font(None,48)
+		self.font['help_title'].set_underline(True);
+		self.font['help_title'].set_bold(True);
+		
+		self.font['help'] = pygame.font.SysFont('monospace', 16)
 		for n, (ft,fs) in fonts:
 			self.font[n] = pygame.font.Font(ft,fs)
 		#Prompt options
 		self.promptText = promptText
 		self.inputText = defaultInput
-		
-		
+		self.inputText = '1.202.15.14'
 		
 		#Event filtering
 		pygame.event.set_allowed(None)
@@ -91,19 +128,25 @@ class Vtracert:
 		self.surf['tracetxt'] = pygame.Surface((width, height),pygame.HWSURFACE | pygame.SRCALPHA)
 		self.surf['status'] = None
 		
+		for s in self.surf:
+			if self.surf[s] != None:
+				self.surf[s].fill(self.col['alpha'])
+		
+		self.help(0)
 		self.drawStatus('Loading...');
 		pygame.display.flip()
 		
-		
 		#Clipboard handling module initialisation
 		pygame.scrap.init()
 		
 		#Keyboard vars
 		self.caps = False
+		self.ctrl = False
 		
 		#Map info
 		self.trmap = vtracemap.TraceMap(self)
 		self.tracer = tracer.Tracer(self)
+		
 	
 	## Color accessor
 	# @param cname Color name
@@ -139,6 +182,96 @@ class Vtracert:
 			dopt[cname] = v
 		return dopt[cname]
 	
+	## Return the unicode representation of the combiation of ctrl+a letter key
+	@classmethod
+	def ctrlUnicode(classo, c):
+		return unicode(chr(ord(c.lower())-ord('a')+1))
+		pass
+	
+	##Display an help on the screen and wait for an KEYDOWN or QUIT event
+	def help(self, ttl = None):
+		scr = self.surf['screen']
+		helpTxts = [ 
+			"Vtraceroute help",
+			"",
+			"Vtraceroute is a traceroute program ( more info : man traceroute )",
+			"that displays hops on a map using geoipLookup.",
+			"",
+			"Controls summary :",
+			"",
+			"^h, ?                : display this help",
+			"esc, ^q              : exit the programm or this help",
+			"",
+			"[a-zA-Z0-9\.]        : Host input",
+			"mid-mouse btn        : paste clipboard into host input",
+			"enter                : validate host input and",
+			"                       run traceroute",
+			"^c                   : clear host input",
+			"",
+			"",
+			"mouse scroll, +, -   : zoom in/out",
+			"arrow keys           : move on the map",
+			"left mouse btn press : select hops on the map",
+			"","","",
+			"Press any key or mouse button to exit this help"
+		]
+		
+		tFont = self.font['help_title']
+		hFont = self.font['help']
+		hCol = self.col['help_txt']
+		tCol = self.col['help_title']
+		
+		ty = 50
+		lspacing = 3
+		hy = ty + tFont.get_linesize() + lspacing
+		hx = 40
+		
+		#Fill screen
+		scr.fill(self.col['help_bg'])
+		
+		#Print title
+		titleTxt = helpTxts.pop(0)
+		tsurf = tFont.render(titleTxt,1,tCol)
+		
+		tsc = tsurf.get_rect()
+		tsc.centerx = self.width/2 #center the title
+		tsc.y = ty
+		
+		scr.blit(tsurf,tsc)
+		
+		#Print help text
+		for line in helpTxts:
+			
+			if len(line) > 0:
+				tsurf = hFont.render(line,1,hCol)
+				scr.blit(tsurf,(hx, hy))
+			
+			hy += hFont.get_linesize()
+			hy += lspacing
+			#pygame.display.flip();time.sleep(0.05);
+		
+		pygame.display.flip()
+		
+		if ttl == None:
+			wait = True
+			while wait:
+				evts = pygame.event.get()
+				for evt in evts:
+					if evt.type in (pygame.QUIT, pygame.KEYDOWN, pygame.MOUSEBUTTONUP):
+						wait = False
+						break;
+		else:
+			time.sleep(ttl)
+		pass
+	
+	"""
+	## Return True 
+	# @c1 unicode1
+	# @c2 unicode2
+	def isCtrlUnicode(self, c, cu):
+		return (self.ctrl and Vtracert.ctrlUnicode(c) == cu)
+	"""
+	
 	## Blit a surface on the screen surface
 	# @param sname The surface name
 	# @param pos A tuple (x,y) for the blit position
@@ -146,15 +279,22 @@ class Vtracert:
 	def blitScreen(self, sname, pos = (0,0) ):
 		return self.surf['screen'].blit(self.surf[sname], pos)
 	
+	## Draw the map again and call Vtracert::flip()
+	# Call Vtracert::fillScreen()
+	# @see Vtracert::fillScreen(), Vtracert::flip()
 	def mapRedraw(self):
 		self.fillScreen()
 		self.trmap.draw()
 		self.flip()
 	
+	## Fill the screen with the 'bg' color
 	def fillScreen(self):
 		self.surf['screen'].fill(self.col['bg'])
 		pass
 	
+	## Blit all the surface is the right order but don't call pygame.display.flip()
+	# The status bar horizontal ruler is a draw and not a blit
+	# @see Vtracert::flip()
 	def blit(self):
 		self.blitScreen('map')
 		self.blitScreen('status')
@@ -164,6 +304,7 @@ class Vtracert:
 		pass
 	
 	## Blit all surface and flip display
+	# @see Vtracert::blit()
 	def flip(self, fill = True):
 		if fill:
 			self.fillScreen()
@@ -199,7 +340,7 @@ class Vtracert:
 		
 		self.surf['status'] = font.render(statusText, antialiasing, col)
 		
-		#self.blitScreen('status')
+		self.blitScreen('status')
 		
 		if line:
 			self.drawStatusLine()
@@ -218,20 +359,33 @@ class Vtracert:
 	def keyupEvt(self, evt):
 		if evt.key == 303 or evt.key == 304: #caps release
 			self.caps = False
-			print "Caps released"
+		elif evt.key == 305 or evt.key == 306: #ctrl release
+			self.ctrl = False
 		pass
 	
 	## Handles a KEYDOWN event
 	# @param evt Event
 	def keydownEvt(self, evt):
 		ccode = evt.key
-					
+		
+		c2u = Vtracert.ctrlUnicode
+		
 		allowedChar = range(ord('a'),ord('z')+1) 
 		allowedChar += range(ord('A'),ord('Z')+1)
 		allowedChar += range(ord('0'),ord('9')+1)
 		allowedChar += [ord('.'),ord('\b'),ord('\r'),ord('\n')]
 		
 		allowedChar = [ chr(cc) for cc in allowedChar ]
+		ctrlChar = [	c2u('q'), #^q
+						c2u('h'), #^h
+						c2u('n'), #^n
+						c2u('c'), #^n
+						'?',
+						u'\x1b' #escape button
+					]
+		
+		#print evt
+		#print self.ctrl
 		
 		if ccode in [273,274,275,276]: #Arrow keys
 			if ccode == 273:
@@ -244,17 +398,43 @@ class Vtracert:
 				d = 'left'
 			
 			self.trmap.zoom( (None, None), d)
+			self.tracer.drawTrace(0)
+			self.flip()
+			pygame.event.clear(pygame.MOUSEBUTTONUP)
 			
 		elif ccode == 303 or ccode == 304: #caps
-			caps = True
-		elif evt.unicode in allowedChar:
+			self.caps = True
+		elif evt.key == 305 or evt.key == 306: #ctrl release
+			self.ctrl = True
+		elif self.ctrl or cc in ctrlChar: # ctrl + key handle
 			
+			cc = evt.unicode
+			if cc == u'\x1b' or cc == c2u('q'): #quit (esc or ^q)
+				pygame.event.post(pygame.event.Event(pygame.QUIT))
+			elif cc == c2u('h') or cc == '?': #help ^h ? ^?
+				print "Help !!!!!!!!"
+				self.help()
+				self.flip()
+			elif cc == c2u('c'):
+				self.inputText = ''
+				self.drawPrompt()
+			elif cc == c2u('n'):
+				for cname in self.col:
+					c = self.col[cname]
+					c.r = 255 - c.r
+					c.g = 255 - c.g
+					c.b = 255 - c.b
+					self.col[cname] = c
+				self.mapRedraw()
+				
+		elif evt.unicode in allowedChar:
 			
-			cinput = evt.unicode
-			if cinput == '\b':
+			cc = evt.unicode
+				
+			if cc == '\b': #backspace
 				if len(self.inputText) > 0:
 					self.inputText = self.inputText[:-1]
-			elif cinput == '\r' or cinput == '\n':
+			elif cc == '\r' or cc == '\n':
 				print "OK, tracerouting %s ..."%self.inputText
 				dest = self.inputText
 				self.inputText = ""
@@ -266,7 +446,7 @@ class Vtracert:
 				self.flip()
 				
 			else:
-				self.inputText += cinput
+				self.inputText += cc
 			
 			self.drawPrompt()
 		pass
@@ -282,8 +462,9 @@ class Vtracert:
 				zoom = False
 				
 			self.trmap.zoom(evt.pos,zoom)
-			self.tracer.drawTrace()
+			self.tracer.drawTrace(0)
 			self.blit()
+			pygame.event.clear(pygame.MOUSEBUTTONUP)
 		#end scrollzoom
 		
 		elif evt.button == 1:
@@ -302,6 +483,7 @@ class Vtracert:
 			types = pygame.scrap.get_types()
 			for t in types:
 				print t,pygame.scrap.get(t)
+		
 		pass
 	
 	
@@ -312,23 +494,32 @@ class Vtracert:
 		self.mapRedraw();
 		self.flip()
 		
+		#Display small onetime help text
+		htext = self.font['status'].render("Type ^h or ? for help.",1, self.col['status'])
+		self.surf['screen'].blit(htext, (5, self.font['status'].get_linesize()+2))
+		pygame.display.flip()
+		
 		again = True
 		
 		while again:
+			"""
 			evts = pygame.event.get()
 			if len(evts) > 0:
 				
 				for evt in evts:
-					if evt.type == pygame.QUIT:
-						again = False
-						break
-					elif evt.type == pygame.KEYUP:
-						self.keyupEvt(evt)
-					elif evt.type == pygame.KEYDOWN:
-						self.keydownEvt(evt)
-					elif evt.type == pygame.MOUSEBUTTONUP: 
-						self.mouseboutonupEvt(evt)
-					
-					self.drawPrompt();
-					self.flip()
+			"""
+			evt = pygame.event.wait()
+			if evt != pygame.NOEVENT:
+				if evt.type == pygame.QUIT:
+					again = False
+					break
+				elif evt.type == pygame.KEYUP:
+					self.keyupEvt(evt)
+				elif evt.type == pygame.KEYDOWN:
+					self.keydownEvt(evt)
+				elif evt.type == pygame.MOUSEBUTTONUP: 
+					self.mouseboutonupEvt(evt)
+				
+				self.drawPrompt();
+				self.flip()