6 from urlparse import urlparse
11 print 'Warning, could not import pygraphviz, test mode only'
13 from optparse import OptionParser
15 from sfa.client.return_value import ReturnValue
16 from sfa.client.sfi import Sfi
17 from sfa.util.sfalogging import logger, DEBUG
18 from sfa.client.sfaserverproxy import SfaServerProxy
20 def url_hostname_port (url):
23 parsed_url=urlparse(url)
24 # 0(scheme) returns protocol
26 if parsed_url[0]=='https': default_port='443'
27 # 1(netloc) returns the hostname+port part
28 parts=parsed_url[1].split(":")
31 return (url,parts[0],default_port)
33 return (url,parts[0],parts[1])
35 ### a very simple cache mechanism so that successive runs (see make)
36 ### will go *much* faster
37 ### assuming everything is sequential, as simple as it gets
38 ### { url -> (timestamp,version)}
40 # default expiration period is 1h
41 def __init__ (self, filename=None, expires=60*60):
42 # default is to store cache in the same dir as argv[0]
44 filename=os.path.join(os.path.dirname(sys.argv[0]),"sfascan-version-cache.pickle")
45 self.filename=filename
52 infile=file(self.filename,'r')
53 self.url2version=pickle.load(infile)
56 logger.debug("Cannot load version cache, restarting from scratch")
58 logger.debug("loaded version cache with %d entries %s"%(len(self.url2version),self.url2version.keys()))
62 outfile=file(self.filename,'w')
63 pickle.dump(self.url2version,outfile)
66 logger.log_exc ("Cannot save version cache into %s"%self.filename)
69 retcod=os.unlink(self.filename)
70 logger.info("Cleaned up version cache %s, retcod=%d"%(self.filename,retcod))
72 logger.info ("Could not unlink version cache %s"%self.filename)
75 entries=len(self.url2version)
76 print "version cache from file %s has %d entries"%(self.filename,entries)
77 key_values=self.url2version.items()
78 def old_first (kv1,kv2): return int(kv1[1][0]-kv2[1][0])
79 key_values.sort(old_first)
80 for key_value in key_values:
81 (url,tuple) = key_value
82 (timestamp,version) = tuple
83 how_old = time.time()-timestamp
84 if how_old<=self.expires:
85 print url,"-- %d seconds ago"%how_old
87 print "OUTDATED",url,"(%d seconds ago, expires=%d)"%(how_old,self.expires)
89 # turns out we might have trailing slashes or not
90 def normalize (self, url):
93 def set (self,url,version):
94 url=self.normalize(url)
95 self.url2version[url]=( time.time(), version)
97 url=self.normalize(url)
99 (timestamp,version)=self.url2version[url]
100 how_old = time.time()-timestamp
101 if how_old<=self.expires: return version
107 # non-existing hostnames happen...
108 # for better perfs we cache the result of gethostbyname too
111 def __init__ (self,url,mentioned_in=None,verbose=False):
115 key="interface:%s"%url
117 (self._url,self.hostname,self.port)=url_hostname_port(url)
118 # look for ip in the cache
121 (self.hostname, self.ip, self.port) = tuple
123 self.ip=socket.gethostbyname(self.hostname)
125 msg="can't resolve hostname %s\n\tfound in url %s"%(self.hostname,self._url)
127 msg += "\n\t(mentioned at %s)"%mentioned_in
129 self.hostname="unknown"
133 cache.set(key, (self.hostname, self.ip, self.port,) )
137 # mark unknown interfaces as probed to avoid unnecessary attempts
138 if self.hostname=='unknown':
139 # don't really try it
147 # this is used as a key for creating graph nodes and to avoid duplicates
149 return "%s:%s"%(self.ip,self.port)
151 # connect to server and trigger GetVersion
152 def get_version(self):
153 ### if we already know the answer:
156 ### otherwise let's look in the cache file
157 logger.debug("searching in version cache %s"%self.url())
158 cached_version = VersionCache().get(self.url())
159 if cached_version is not None:
160 logger.info("Retrieved version info from cache %s"%self.url())
161 return cached_version
162 ### otherwise let's do the hard work
163 # dummy to meet Sfi's expectations for its 'options' field
166 options=DummyOptions()
167 options.verbose=self.verbose
173 key_file = client.private_key
174 cert_file = client.my_gid
175 logger.debug("using key %s & cert %s"%(key_file,cert_file))
177 logger.info('issuing GetVersion at %s'%url)
178 # setting timeout here seems to get the call to fail - even though the response time is fast
179 #server=SfaServerProxy(url, key_file, cert_file, verbose=self.verbose, timeout=options.timeout)
180 server=SfaServerProxy(url, key_file, cert_file, verbose=self.verbose)
181 self._version=ReturnValue.get_value(server.GetVersion())
183 logger.log_exc("failed to get version")
185 # so that next run from this process will find out
187 # store in version cache so next processes will remember for an hour
189 cache.set(self.url(),self._version)
191 logger.debug("Saved version for url=%s in version cache"%self.url())
196 def multi_lines_label(*lines):
197 result='<<TABLE BORDER="0" CELLBORDER="0"><TR><TD>' + \
198 '</TD></TR><TR><TD>'.join(lines) + \
199 '</TD></TR></TABLE>>'
202 # default is for when we can't determine the type of the service
203 # typically the server is down, or we can't authenticate, or it's too old code
204 shapes = {"registry": "diamond", "slicemgr":"ellipse", "aggregate":"box", 'default':'plaintext'}
205 abbrevs = {"registry": "REG", "slicemgr":"SA", "aggregate":"AM", 'default':'[unknown interface]'}
207 # return a dictionary that translates into the node's attr
208 def get_layout (self):
210 ### retrieve cached GetVersion
211 version=self.get_version()
212 # set the href; xxx would make sense to try and 'guess' the web URL, not the API's one...
213 layout['href']=self.url()
214 ### set html-style label
215 ### see http://www.graphviz.org/doc/info/shapes.html#html
216 # if empty the service is unreachable
221 try: abbrev=Interface.abbrevs[version['interface']]
222 except: abbrev=Interface.abbrevs['default']
224 if 'hrn' in version: label += " %s"%version['hrn']
225 else: label += "[no hrn]"
226 if 'code_tag' in version:
227 label += " %s"%version['code_tag']
228 if 'testbed' in version:
229 label += " (%s)"%version['testbed']
230 layout['label']=Interface.multi_lines_label(self.url(),label)
232 try: shape=Interface.shapes[version['interface']]
233 except: shape=Interface.shapes['default']
234 layout['shape']=shape
235 ### fill color to outline wrongly configured or unreachable bodies
236 # as of sfa-2.0 registry doesn't have 'sfa' not 'geni_api', but have peers
237 # slicemgr and aggregate have 'geni_api' and 'sfa'
238 if 'geni_api' not in version and 'peers' not in version:
239 layout['style']='filled'
240 layout['fillcolor']='gray'
245 # provide the entry points (a list of interfaces)
246 def __init__ (self, left_to_right=False, verbose=False):
248 self.left_to_right=left_to_right
250 def graph (self,entry_points):
251 graph=pygraphviz.AGraph(directed=True)
252 if self.left_to_right:
253 graph.graph_attr['rankdir']='LR'
254 self.scan(entry_points,graph)
257 # scan from the given interfaces as entry points
258 def scan(self,interfaces,graph):
259 if not isinstance(interfaces,list):
260 interfaces=[interfaces]
262 # remember node to interface mapping
264 # add entry points right away using the interface uid's as a key
267 graph.add_node(i.uid())
268 node2interface[graph.get_node(i.uid())]=i
270 # keep on looping until we reach a fixed point
271 # don't worry about abels and shapes that will get fixed later on
273 for interface in to_scan:
274 # performing xmlrpc call
275 logger.info("retrieving/fetching version at interface %s"%interface.url())
276 version=interface.get_version()
278 logger.info("<EMPTY GetVersion(); offline or cannot authenticate>")
280 for (k,v) in version.iteritems():
281 if not isinstance(v,dict):
282 logger.debug("\r\t%s:%s"%(k,v))
285 for (k1,v1) in v.iteritems():
286 logger.debug("\r\t\t%s:%s"%(k1,v1))
287 # proceed with neighbours
288 if 'peers' in version:
289 for (next_name,next_url) in version['peers'].iteritems():
290 next_interface=Interface(next_url,mentioned_in=interface.url())
291 # locate or create node in graph
293 # if found, we're good with this one
294 next_node=graph.get_node(next_interface.uid())
296 # otherwise, let's move on with it
297 graph.add_node(next_interface.uid())
298 next_node=graph.get_node(next_interface.uid())
299 node2interface[next_node]=next_interface
300 to_scan.append(next_interface)
301 graph.add_edge(interface.uid(),next_interface.uid())
302 scanned.append(interface)
303 to_scan.remove(interface)
304 # we've scanned the whole graph, let's get the labels and shapes right
305 for node in graph.nodes():
306 interface=node2interface.get(node,None)
308 for (k,v) in interface.get_layout().iteritems():
311 logger.error("MISSED interface with node %s"%node)
316 default_outfiles=['sfa.png','sfa.svg','sfa.dot']
319 usage="%prog [options] url-entry-point(s)"
320 parser=OptionParser(usage=usage)
321 parser.add_option("-d", "--dir", dest="sfi_dir",
322 help="config & working directory - default is " + Sfi.default_sfi_dir(),
323 metavar="PATH", default=Sfi.default_sfi_dir())
324 parser.add_option("-o","--output",action='append',dest='outfiles',default=[],
325 help="output filenames (cumulative) - defaults are %r"%SfaScan.default_outfiles)
326 parser.add_option("-l","--left-to-right",action="store_true",dest="left_to_right",default=False,
327 help="instead of top-to-bottom")
328 parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0,
329 help="verbose - can be repeated for more verbosity")
330 parser.add_option("-c", "--clean-cache",action='store_true',
331 dest='clean_cache',default=False,
332 help='clean/trash version cache and exit')
333 parser.add_option("-s","--show-cache",action='store_true',
334 dest='show_cache',default=False,
335 help='show/display version cache')
337 (options,args)=parser.parse_args()
338 logger.enable_console()
339 # apply current verbosity to logger
340 logger.setLevelFromOptVerbose(options.verbose)
341 # figure if we need to be verbose for these local classes that only have a bool flag
342 bool_verbose=logger.getBoolVerboseFromOpt(options.verbose)
344 if options.show_cache:
345 VersionCache().show()
347 if options.clean_cache:
348 VersionCache().clean()
354 if not options.outfiles:
355 options.outfiles=SfaScan.default_outfiles
356 scanner=Scanner(left_to_right=options.left_to_right, verbose=bool_verbose)
357 entries = [ Interface(entry,mentioned_in="command line") for entry in args ]
359 g=scanner.graph(entries)
360 logger.info("creating layout")
362 for outfile in options.outfiles:
363 logger.info("drawing in %s"%outfile)
366 # test mode when pygraphviz is not available
369 print "GetVersion at %s returned %s"%(entry.url(),entry.get_version())