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.xrn import get_authority
11 from sfa.util.plxrn import hrn_to_pl_slicename, hostname_to_urn
14 def __init__(self, node):
16 self.network = node.network
17 self.slice = node.network.slice
21 self.slice.tags_to_xml(xml, self.node)
25 def __init__(self, network, iface):
26 self.network = network
27 self.id = iface['interface_id']
28 self.idtag = "i%s" % self.id
29 self.ipv4 = iface['ip']
30 self.bwlimit = iface['bwlimit']
31 self.hostname = iface['hostname']
32 self.primary = iface['is_primary']
36 Just print out bwlimit right now
39 with xml.bw_limit(units="kbps"):
40 xml << str(self.bwlimit / 1000)
44 def __init__(self, network, node):
45 self.network = network
46 self.id = node['node_id']
47 self.idtag = "n%s" % self.id
48 self.hostname = node['hostname']
49 self.site_id = node['site_id']
50 self.iface_ids = node['interface_ids']
52 self.whitelist = node['slice_ids_whitelist']
53 auth = self.network.api.hrn
54 login_base = self.get_site().idtag
55 self.urn = hostname_to_urn(auth, login_base, self.hostname)
57 def get_primary_iface(self):
58 for id in self.iface_ids:
59 iface = self.network.lookupIface(id)
65 return self.network.lookupSite(self.site_id)
68 self.sliver = Sliver(self)
71 slice = self.network.slice
72 if self.whitelist and not self.sliver:
73 if not slice or slice.id not in self.whitelist:
76 with xml.node(id = self.idtag):
81 iface = self.get_primary_iface()
85 self.sliver.toxml(xml)
89 def __init__(self, network, site):
90 self.network = network
91 self.id = site['site_id']
92 self.node_ids = site['node_ids']
94 self.name = site['abbreviated_name']
95 self.tag = site['login_base']
96 self.idtag = site['login_base']
97 self.public = site['is_public']
98 self.enabled = site['enabled']
100 self.whitelist = False
102 def get_sitenodes(self):
104 for i in self.node_ids:
105 n.append(self.network.lookupNode(i))
108 def toxml(self, xml):
109 if not (self.public and self.enabled and self.node_ids):
111 with xml.site(id = self.idtag):
114 for node in self.get_sitenodes():
119 def __init__(self, network, hrn, slice):
121 self.network = network
122 self.id = slice['slice_id']
123 self.name = slice['name']
124 self.peer_id = slice['peer_id']
125 self.node_ids = set(slice['node_ids'])
126 self.slice_tag_ids = slice['slice_tag_ids']
129 Use with tags that can have more than one instance
131 def get_multi_tag(self, tagname, node = None):
133 for i in self.slice_tag_ids:
135 tag = self.network.lookupSliceTag(i)
136 if tag.tagname == tagname:
138 if node.id == tag.node_id:
140 elif not tag.node_id:
142 except InvalidRSpec, e:
143 # As they're not needed, we ignore some tag types from
144 # GetSliceTags call. See Slicetag.ignore_tags
149 Use with tags that have only one instance
151 def get_tag(self, tagname, node = None):
152 for i in self.slice_tag_ids:
154 tag = self.network.lookupSliceTag(i)
155 if tag.tagname == tagname:
157 if node.id == tag.node_id:
159 elif not tag.node_id:
161 except InvalidRSpec, e:
162 # As they're not needed, we ignore some tag types from
163 # GetSliceTags call. See Slicetag.ignore_tags
169 for id in self.node_ids:
170 if id in self.network.nodes:
171 n.append(self.network.nodes[id])
174 # Add a new slice tag
175 def add_tag(self, tagname, value, node = None, role = "user"):
176 tt = self.network.lookupTagType(tagname)
177 if not tt.permit_update(role):
178 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
180 tag.initialize(tagname, value, node, self.network)
181 self.network.tags[tag.id] = tag
182 self.slice_tag_ids.append(tag.id)
185 # Update a slice tag if it exists, else add it
186 def update_tag(self, tagname, value, node = None, role = "user"):
187 tag = self.get_tag(tagname, node)
188 if tag and tag.value == value:
191 tt = self.network.lookupTagType(tagname)
192 if not tt.permit_update(role):
193 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
198 tag = self.add_tag(tagname, value, node, role)
201 def update_multi_tag(self, tagname, value, node = None, role = "user"):
202 tags = self.get_multi_tag(tagname, node)
204 if tag and tag.value == value:
207 tag = self.add_tag(tagname, value, node, role)
210 def tags_to_xml(self, xml, node = None):
211 tagtypes = self.network.getTagTypes()
215 tags = self.get_multi_tag(tt.tagname, node)
217 if not tag.was_deleted(): ### Debugging
218 xml << (tag.tagname, tag.value)
220 tag = self.get_tag(tt.tagname, node)
222 if not tag.was_deleted(): ### Debugging
223 xml << (tag.tagname, tag.value)
225 def toxml(self, xml):
226 with xml.sliver_defaults:
227 self.tags_to_xml(xml)
232 filter_fields = ['slice_tag_id','slice_id','tagname','value','node_id','category']
233 ignore_tags = ['hmac','ssh_key']
234 def __init__(self, tag = None):
237 self.id = tag['slice_tag_id']
238 self.slice_id = tag['slice_id']
239 self.tagname = tag['tagname']
240 self.value = tag['value']
241 self.node_id = tag['node_id']
242 self.category = tag['category']
245 # Create a new slicetag that will be written to the DB later
246 def initialize(self, tagname, value, node, network):
247 tt = network.lookupTagType(tagname)
248 self.id = Slicetag.newid
250 self.slice_id = network.slice.id
251 self.tagname = tagname
254 self.node_id = node.id
257 self.category = tt.category
260 def change(self, value):
261 if self.value != value:
263 self.status = "change"
265 self.status = "updated"
267 # Mark a tag as deleted
269 self.status = "delete"
274 def was_changed(self):
275 return (self.status == "change")
277 def was_deleted(self):
278 return (self.status == "delete")
280 def was_updated(self):
281 return (self.status != None)
283 def write(self, api):
285 api.plshell.AddSliceTag(api.plauth, self.slice_id,
286 self.tagname, self.value, self.node_id)
287 elif self.was_changed():
288 api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
289 elif self.was_deleted():
290 api.plshell.DeleteSliceTag(api.plauth, self.id)
294 ignore_tags = ['hmac','ssh_key']
295 def __init__(self, tagtype):
296 self.id = tagtype['tag_type_id']
297 self.category = tagtype['category']
298 self.tagname = tagtype['tagname']
299 self.roles = tagtype['roles']
301 self.in_rspec = False
302 if self.category == 'slice/rspec':
304 if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
307 def permit_update(self, role):
308 if role in self.roles:
315 A Network is a compound object consisting of:
316 * a dictionary mapping site IDs to Site objects
317 * a dictionary mapping node IDs to Node objects
318 * a dictionary mapping interface IDs to Iface objects
320 def __init__(self, api, type = "SFA"):
323 self.sites = self.get_sites(api)
324 self.nodes = self.get_nodes(api)
325 self.ifaces = self.get_ifaces(api)
326 self.tags = self.get_slice_tags(api)
327 self.tagtypes = self.get_tag_types(api)
332 self.sitemap[site.idtag] = site.id
334 def lookupSiteIdtag(self, name):
335 """ Lookup site id from name """
338 val = self.sitemap[name]
340 raise InvalidRSpec("site name '%s' not found" % name)
343 def lookupSite(self, id):
344 """ Lookup site based on id or idtag value """
346 if isinstance(id, basestring):
347 id = self.lookupSiteIdtag(id)
351 self.api.logger.error("Invalid RSpec: site ID %s not found" % id )
352 raise InvalidRSpec("site ID %s not found" % id)
358 sites.append(self.sites[s])
361 def lookupNode(self, id):
362 """ Lookup node based on id or idtag value """
364 if isinstance(id, basestring):
365 id = int(id.lstrip('n'))
369 raise InvalidRSpec("node ID %s not found" % id)
375 nodes.append(self.nodes[n])
378 def lookupIface(self, id):
379 """ Lookup iface based on id or idtag value """
381 if isinstance(id, basestring):
382 id = int(id.lstrip('i'))
384 val = self.ifaces[id]
386 raise InvalidRSpec("interface ID %s not found" % id)
391 for i in self.ifaces:
392 ifaces.append(self.ifaces[i])
395 def nodesWithSlivers(self):
403 def lookupSliceTag(self, id):
408 raise InvalidRSpec("slicetag ID %s not found" % id)
411 def getSliceTags(self):
414 tags.append(self.tags[t])
417 def lookupTagType(self, name):
420 val = self.tagtypes[name]
422 raise InvalidRSpec("tag %s not found" % name)
425 def getTagTypes(self):
427 for t in self.tagtypes:
428 tags.append(self.tagtypes[t])
431 def __process_attributes(self, element, node=None):
433 Process the elements under <sliver_defaults> or <sliver>
438 tagtypes = self.getTagTypes()
442 for e in element.iterfind("./" + tt.tagname):
443 self.slice.update_multi_tag(tt.tagname, e.text, node)
445 e = element.find("./" + tt.tagname)
447 self.slice.update_tag(tt.tagname, e.text, node)
449 def addRSpec(self, xml, schema=None):
451 Annotate the objects in the Network with information from the RSpec
454 tree = etree.parse(StringIO(xml))
455 except etree.XMLSyntaxError:
456 message = str(sys.exc_info()[1])
457 raise InvalidRSpec(message)
459 # Filter out stuff that's not for us
460 rspec = tree.getroot()
461 for network in rspec.iterfind("./network"):
462 if network.get("name") != self.api.hrn:
463 rspec.remove(network)
464 for request in rspec.iterfind("./request"):
465 if request.get("name") != self.api.hrn:
466 rspec.remove(request)
469 # Validate the incoming request against the RelaxNG schema
470 relaxng_doc = etree.parse(schema)
471 relaxng = etree.RelaxNG(relaxng_doc)
473 if not relaxng(tree):
474 error = relaxng.error_log.last_error
475 message = "%s (line %s)" % (error.message, error.line)
476 self.api.logger.error("failed to validate rspec %r"%message)
477 self.api.logger.debug("---------- XML input BEG")
478 self.api.logger.debug(xml)
479 self.api.logger.debug("---------- XML input END")
480 raise InvalidRSpec(message)
484 defaults = rspec.find(".//sliver_defaults")
485 self.__process_attributes(defaults)
487 # Find slivers under node elements
488 for sliver in rspec.iterfind("./network/site/node/sliver"):
489 elem = sliver.getparent()
491 node = self.lookupNode(elem.get("id"))
493 # Don't worry about nodes from other aggregates
497 self.__process_attributes(sliver, node)
499 # Find slivers that specify nodeid
500 for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
502 node = self.lookupNode(sliver.get("nodeid"))
504 # Don't worry about nodes from other aggregates
508 self.__process_attributes(sliver, node)
514 Annotate the objects in the Network with information from the slice
518 raise InvalidRSpec("no slice associated with network")
520 for node in slice.get_nodes():
523 def updateSliceTags(self):
525 Write any slice tags that have been added or modified back to the DB
527 for tag in self.getSliceTags():
528 if tag.category == 'slice/rspec' and not tag.was_updated():
529 tt = self.lookupTagType(tag.tagname)
530 if tt.permit_update("user"):
533 # Update slice tags in database
534 for tag in self.getSliceTags():
535 if tag.slice_id == self.slice.id:
540 Produce XML directly from the topology specification.
542 xml = XMLBuilder(format = True, tab_step = " ")
543 with xml.RSpec(type=self.type):
545 element = xml.network(name=self.api.hrn, slice=self.slice.hrn)
547 element = xml.network(name=self.api.hrn)
551 self.slice.toxml(xml)
552 for site in self.getSites():
555 header = '<?xml version="1.0"?>\n'
556 return header + str(xml)
558 def get_sites(self, api):
560 Create a dictionary of site objects keyed by site ID
563 for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
564 t = site['site_id'], Site(self, site)
569 def get_nodes(self, api):
571 Create a dictionary of node objects keyed by node ID
574 for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
576 t = node['node_id'], Node(self, node)
579 self.api.logger.error("Failed to add node %s (%s) to RSpec" % (node['hostname'], node['node_id']))
583 def get_ifaces(self, api):
585 Create a dictionary of node objects keyed by node ID
588 for iface in api.plshell.GetInterfaces(api.plauth):
589 t = iface['interface_id'], Iface(self, iface)
593 def get_slice_tags(self, api):
595 Create a dictionary of slicetag objects keyed by slice tag ID
598 for tag in api.plshell.GetSliceTags(api.plauth, {'~tagname':Slicetag.ignore_tags}, Slicetag.filter_fields):
599 t = tag['slice_tag_id'], Slicetag(tag)
603 def get_tag_types(self, api):
605 Create a list of tagtype obects keyed by tag name
608 for tag in api.plshell.GetTagTypes(api.plauth, {'~tagname':TagType.ignore_tags}):
609 t = tag['tagname'], TagType(tag)
613 def get_slice(self, api, hrn):
615 Return a Slice object for a single slice
617 slicename = hrn_to_pl_slicename(hrn)
618 slice = api.plshell.GetSlices(api.plauth, [slicename])
620 self.slice = Slice(self, slicename, slice[0])