1 from __future__ import with_statement
5 from StringIO import StringIO
7 from xmlbuilder import XMLBuilder
9 from sfa.util.faults import *
10 #from sfa.util.sfalogging import sfa_logger
11 from sfa.util.xrn import get_authority
12 from sfa.util.plxrn import hrn_to_pl_slicename, hostname_to_urn
15 def __init__(self, node):
17 self.network = node.network
18 self.slice = node.network.slice
22 self.slice.tags_to_xml(xml, self.node)
26 def __init__(self, network, iface):
27 self.network = network
28 self.id = iface['interface_id']
29 self.idtag = "i%s" % self.id
30 self.ipv4 = iface['ip']
31 self.bwlimit = iface['bwlimit']
32 self.hostname = iface['hostname']
33 self.primary = iface['is_primary']
37 Just print out bwlimit right now
40 with xml.bw_limit(units="kbps"):
41 xml << str(self.bwlimit / 1000)
45 def __init__(self, network, node):
46 self.network = network
47 self.id = node['node_id']
48 self.idtag = "n%s" % self.id
49 self.hostname = node['hostname']
50 self.site_id = node['site_id']
51 self.iface_ids = node['interface_ids']
53 self.whitelist = node['slice_ids_whitelist']
54 auth = self.network.api.hrn
55 login_base = self.get_site().idtag
56 self.urn = hostname_to_urn(auth, login_base, self.hostname)
58 def get_primary_iface(self):
59 for id in self.iface_ids:
60 iface = self.network.lookupIface(id)
66 return self.network.lookupSite(self.site_id)
69 self.sliver = Sliver(self)
72 slice = self.network.slice
73 if self.whitelist and not self.sliver:
74 if not slice or slice.id not in self.whitelist:
77 with xml.node(id = self.idtag):
82 iface = self.get_primary_iface()
86 self.sliver.toxml(xml)
90 def __init__(self, network, site):
91 self.network = network
92 self.id = site['site_id']
93 self.node_ids = site['node_ids']
95 self.name = site['abbreviated_name']
96 self.tag = site['login_base']
97 self.idtag = site['login_base']
98 self.public = site['is_public']
99 self.enabled = site['enabled']
101 self.whitelist = False
103 def get_sitenodes(self):
105 for i in self.node_ids:
106 n.append(self.network.lookupNode(i))
109 def toxml(self, xml):
110 if not (self.public and self.enabled and self.node_ids):
112 with xml.site(id = self.idtag):
115 for node in self.get_sitenodes():
120 def __init__(self, network, hrn, slice):
122 self.network = network
123 self.id = slice['slice_id']
124 self.name = slice['name']
125 self.peer_id = slice['peer_id']
126 self.node_ids = set(slice['node_ids'])
127 self.slice_tag_ids = slice['slice_tag_ids']
130 Use with tags that can have more than one instance
132 def get_multi_tag(self, tagname, node = None):
134 for i in self.slice_tag_ids:
136 tag = self.network.lookupSliceTag(i)
137 if tag.tagname == tagname:
139 if node.id == tag.node_id:
141 elif not tag.node_id:
143 except InvalidRSpec, e:
144 # As they're not needed, we ignore some tag types from
145 # GetSliceTags call. See Slicetag.ignore_tags
150 Use with tags that have only one instance
152 def get_tag(self, tagname, node = None):
153 for i in self.slice_tag_ids:
155 tag = self.network.lookupSliceTag(i)
156 if tag.tagname == tagname:
158 if node.id == tag.node_id:
160 elif not tag.node_id:
162 except InvalidRSpec, e:
163 # As they're not needed, we ignore some tag types from
164 # GetSliceTags call. See Slicetag.ignore_tags
170 for id in self.node_ids:
171 if id in self.network.nodes:
172 n.append(self.network.nodes[id])
175 # Add a new slice tag
176 def add_tag(self, tagname, value, node = None, role = "user"):
177 tt = self.network.lookupTagType(tagname)
178 if not tt.permit_update(role):
179 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
181 tag.initialize(tagname, value, node, self.network)
182 self.network.tags[tag.id] = tag
183 self.slice_tag_ids.append(tag.id)
186 # Update a slice tag if it exists, else add it
187 def update_tag(self, tagname, value, node = None, role = "user"):
188 tag = self.get_tag(tagname, node)
189 if tag and tag.value == value:
192 tt = self.network.lookupTagType(tagname)
193 if not tt.permit_update(role):
194 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
199 tag = self.add_tag(tagname, value, node, role)
202 def update_multi_tag(self, tagname, value, node = None, role = "user"):
203 tags = self.get_multi_tag(tagname, node)
205 if tag and tag.value == value:
208 tag = self.add_tag(tagname, value, node, role)
211 def tags_to_xml(self, xml, node = None):
212 tagtypes = self.network.getTagTypes()
216 tags = self.get_multi_tag(tt.tagname, node)
218 if not tag.was_deleted(): ### Debugging
219 xml << (tag.tagname, tag.value)
221 tag = self.get_tag(tt.tagname, node)
223 if not tag.was_deleted(): ### Debugging
224 xml << (tag.tagname, tag.value)
226 def toxml(self, xml):
227 with xml.sliver_defaults:
228 self.tags_to_xml(xml)
233 filter_fields = ['slice_tag_id','slice_id','tagname','value','node_id','category']
234 ignore_tags = ['hmac','ssh_key']
235 def __init__(self, tag = None):
238 self.id = tag['slice_tag_id']
239 self.slice_id = tag['slice_id']
240 self.tagname = tag['tagname']
241 self.value = tag['value']
242 self.node_id = tag['node_id']
243 self.category = tag['category']
246 # Create a new slicetag that will be written to the DB later
247 def initialize(self, tagname, value, node, network):
248 tt = network.lookupTagType(tagname)
249 self.id = Slicetag.newid
251 self.slice_id = network.slice.id
252 self.tagname = tagname
255 self.node_id = node.id
258 self.category = tt.category
261 def change(self, value):
262 if self.value != value:
264 self.status = "change"
266 self.status = "updated"
268 # Mark a tag as deleted
270 self.status = "delete"
275 def was_changed(self):
276 return (self.status == "change")
278 def was_deleted(self):
279 return (self.status == "delete")
281 def was_updated(self):
282 return (self.status != None)
284 def write(self, api):
286 api.plshell.AddSliceTag(api.plauth, self.slice_id,
287 self.tagname, self.value, self.node_id)
288 elif self.was_changed():
289 api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
290 elif self.was_deleted():
291 api.plshell.DeleteSliceTag(api.plauth, self.id)
295 ignore_tags = ['hmac','ssh_key']
296 def __init__(self, tagtype):
297 self.id = tagtype['tag_type_id']
298 self.category = tagtype['category']
299 self.tagname = tagtype['tagname']
300 self.roles = tagtype['roles']
302 self.in_rspec = False
303 if self.category == 'slice/rspec':
305 if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
308 def permit_update(self, role):
309 if role in self.roles:
316 A Network is a compound object consisting of:
317 * a dictionary mapping site IDs to Site objects
318 * a dictionary mapping node IDs to Node objects
319 * a dictionary mapping interface IDs to Iface objects
321 def __init__(self, api, type = "SFA"):
324 self.sites = self.get_sites(api)
325 self.nodes = self.get_nodes(api)
326 self.ifaces = self.get_ifaces(api)
327 self.tags = self.get_slice_tags(api)
328 self.tagtypes = self.get_tag_types(api)
333 self.sitemap[site.idtag] = site.id
335 def lookupSiteIdtag(self, name):
336 """ Lookup site id from name """
339 val = self.sitemap[name]
341 raise InvalidRSpec("site name '%s' not found" % name)
344 def lookupSite(self, id):
345 """ Lookup site based on id or idtag value """
347 if isinstance(id, basestring):
348 id = self.lookupSiteIdtag(id)
352 self.api.logger.error("Invalid RSpec: site ID %s not found" % id )
353 raise InvalidRSpec("site ID %s not found" % id)
359 sites.append(self.sites[s])
362 def lookupNode(self, id):
363 """ Lookup node based on id or idtag value """
365 if isinstance(id, basestring):
366 id = int(id.lstrip('n'))
370 raise InvalidRSpec("node ID %s not found" % id)
376 nodes.append(self.nodes[n])
379 def lookupIface(self, id):
380 """ Lookup iface based on id or idtag value """
382 if isinstance(id, basestring):
383 id = int(id.lstrip('i'))
385 val = self.ifaces[id]
387 raise InvalidRSpec("interface ID %s not found" % id)
392 for i in self.ifaces:
393 ifaces.append(self.ifaces[i])
396 def nodesWithSlivers(self):
404 def lookupSliceTag(self, id):
409 raise InvalidRSpec("slicetag ID %s not found" % id)
412 def getSliceTags(self):
415 tags.append(self.tags[t])
418 def lookupTagType(self, name):
421 val = self.tagtypes[name]
423 raise InvalidRSpec("tag %s not found" % name)
426 def getTagTypes(self):
428 for t in self.tagtypes:
429 tags.append(self.tagtypes[t])
432 def __process_attributes(self, element, node=None):
434 Process the elements under <sliver_defaults> or <sliver>
439 tagtypes = self.getTagTypes()
443 for e in element.iterfind("./" + tt.tagname):
444 self.slice.update_multi_tag(tt.tagname, e.text, node)
446 e = element.find("./" + tt.tagname)
448 self.slice.update_tag(tt.tagname, e.text, node)
450 def addRSpec(self, xml, schema=None):
452 Annotate the objects in the Network with information from the RSpec
455 tree = etree.parse(StringIO(xml))
456 except etree.XMLSyntaxError:
457 message = str(sys.exc_info()[1])
458 raise InvalidRSpec(message)
460 # Filter out stuff that's not for us
461 rspec = tree.getroot()
462 for network in rspec.iterfind("./network"):
463 if network.get("name") != self.api.hrn:
464 rspec.remove(network)
465 for request in rspec.iterfind("./request"):
466 if request.get("name") != self.api.hrn:
467 rspec.remove(request)
470 # Validate the incoming request against the RelaxNG schema
471 relaxng_doc = etree.parse(schema)
472 relaxng = etree.RelaxNG(relaxng_doc)
474 if not relaxng(tree):
475 error = relaxng.error_log.last_error
476 message = "%s (line %s)" % (error.message, error.line)
477 raise InvalidRSpec(message)
481 defaults = rspec.find(".//sliver_defaults")
482 self.__process_attributes(defaults)
484 # Find slivers under node elements
485 for sliver in rspec.iterfind("./network/site/node/sliver"):
486 elem = sliver.getparent()
488 node = self.lookupNode(elem.get("id"))
490 # Don't worry about nodes from other aggregates
494 self.__process_attributes(sliver, node)
496 # Find slivers that specify nodeid
497 for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
499 node = self.lookupNode(sliver.get("nodeid"))
501 # Don't worry about nodes from other aggregates
505 self.__process_attributes(sliver, node)
511 Annotate the objects in the Network with information from the slice
515 raise InvalidRSpec("no slice associated with network")
517 for node in slice.get_nodes():
520 def updateSliceTags(self):
522 Write any slice tags that have been added or modified back to the DB
524 for tag in self.getSliceTags():
525 if tag.category == 'slice/rspec' and not tag.was_updated():
526 tt = self.lookupTagType(tag.tagname)
527 if tt.permit_update("user"):
530 # Update slice tags in database
531 for tag in self.getSliceTags():
532 if tag.slice_id == self.slice.id:
537 Produce XML directly from the topology specification.
539 xml = XMLBuilder(format = True, tab_step = " ")
540 with xml.RSpec(type=self.type):
542 element = xml.network(name=self.api.hrn, slice=self.slice.hrn)
544 element = xml.network(name=self.api.hrn)
548 self.slice.toxml(xml)
549 for site in self.getSites():
552 header = '<?xml version="1.0"?>\n'
553 return header + str(xml)
555 def get_sites(self, api):
557 Create a dictionary of site objects keyed by site ID
560 for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
561 t = site['site_id'], Site(self, site)
566 def get_nodes(self, api):
568 Create a dictionary of node objects keyed by node ID
571 for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
573 t = node['node_id'], Node(self, node)
576 self.api.logger.error("Failed to add node %s (%s) to RSpec" % (node['hostname'], node['node_id']))
580 def get_ifaces(self, api):
582 Create a dictionary of node objects keyed by node ID
585 for iface in api.plshell.GetInterfaces(api.plauth):
586 t = iface['interface_id'], Iface(self, iface)
590 def get_slice_tags(self, api):
592 Create a dictionary of slicetag objects keyed by slice tag ID
595 for tag in api.plshell.GetSliceTags(api.plauth, {'~tagname':Slicetag.ignore_tags}, Slicetag.filter_fields):
596 t = tag['slice_tag_id'], Slicetag(tag)
600 def get_tag_types(self, api):
602 Create a list of tagtype obects keyed by tag name
605 for tag in api.plshell.GetTagTypes(api.plauth, {'~tagname':TagType.ignore_tags}):
606 t = tag['tagname'], TagType(tag)
610 def get_slice(self, api, hrn):
612 Return a Slice object for a single slice
614 slicename = hrn_to_pl_slicename(hrn)
615 slice = api.plshell.GetSlices(api.plauth, [slicename])
617 self.slice = Slice(self, slicename, slice[0])