1 from __future__ import with_statement
4 from sfa.util.namespace import *
5 from sfa.util.faults import *
6 from xmlbuilder import XMLBuilder
9 from StringIO import StringIO
13 def __init__(self, node):
15 self.network = node.network
16 self.slice = node.network.slice
20 self.slice.tags_to_xml(xml, self.node)
24 def __init__(self, network, iface):
25 self.network = network
26 self.id = iface['interface_id']
27 self.idtag = "i%s" % self.id
28 self.ipv4 = iface['ip']
29 self.bwlimit = iface['bwlimit']
30 self.hostname = iface['hostname']
31 self.primary = iface['is_primary']
34 Just print out bwlimit right now
38 with xml.bw_limit(units="kbps"):
39 xml << str(self.bwlimit / 1000)
43 def __init__(self, network, node):
44 self.network = network
45 self.id = node['node_id']
46 self.idtag = "n%s" % self.id
47 self.hostname = node['hostname']
48 self.site_id = node['site_id']
49 self.iface_ids = node['interface_ids']
51 self.whitelist = node['slice_ids_whitelist']
53 def get_primary_iface(self):
54 for id in self.iface_ids:
55 iface = self.network.lookupIface(id)
61 return self.network.lookupSite(self.site_id)
64 self.sliver = Sliver(self)
67 slice = self.network.slice
68 if self.whitelist and not self.sliver:
69 if not slice or slice.id not in self.whitelist:
72 with xml.node(id = self.idtag):
75 iface = self.get_primary_iface()
79 self.sliver.toxml(xml)
83 def __init__(self, network, site):
84 self.network = network
85 self.id = site['site_id']
86 self.idtag = "s%s" % self.id
87 self.node_ids = site['node_ids']
89 self.name = site['abbreviated_name']
90 self.tag = site['login_base']
91 self.public = site['is_public']
92 self.enabled = site['enabled']
94 self.whitelist = False
96 def get_sitenodes(self):
98 for i in self.node_ids:
99 n.append(self.network.lookupNode(i))
102 def toxml(self, xml):
103 if not (self.public and self.enabled and self.node_ids):
105 with xml.site(id = self.idtag):
108 for node in self.get_sitenodes():
113 def __init__(self, network, hrn, slice):
115 self.network = network
116 self.id = slice['slice_id']
117 self.name = slice['name']
118 self.peer_id = slice['peer_id']
119 self.node_ids = set(slice['node_ids'])
120 self.slice_tag_ids = slice['slice_tag_ids']
123 Use with tags that can have more than one instance
125 def get_multi_tag(self, tagname, node = None):
127 for i in self.slice_tag_ids:
128 tag = self.network.lookupSliceTag(i)
129 if tag.tagname == tagname:
130 if not (node and node.id != tag.node_id):
135 Use with tags that have only one instance
137 def get_tag(self, tagname, node = None):
138 for i in self.slice_tag_ids:
139 tag = self.network.lookupSliceTag(i)
140 if tag.tagname == tagname:
141 if (not node) or (node.id == tag.node_id):
147 for id in self.node_ids:
148 if id in self.network.nodes:
149 n.append(self.network.nodes[id])
152 # Add a new slice tag
153 def add_tag(self, tagname, value, node = None, role_id = 40):
154 tt = self.network.lookupTagType(tagname)
155 if not tt.permit_update(role_id):
156 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
158 tag.initialize(tagname, value, node, self.network)
159 self.network.tags[tag.id] = tag
160 self.slice_tag_ids.append(tag.id)
163 # Update a slice tag if it exists, else add it
164 def update_tag(self, tagname, value, node = None, role_id = 40):
165 tag = self.get_tag(tagname, node)
167 if not tag.permit_update(role_id, value):
168 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
171 tag = self.add_tag(tagname, value, node, role_id)
174 def update_multi_tag(self, tagname, value, node = None, role_id = 40):
175 tags = self.get_multi_tag(tagname, node)
177 if tag and tag.value == value:
180 tag = self.add_tag(tagname, value, node, role_id)
183 def tags_to_xml(self, xml, node = None):
184 tagtypes = self.network.getTagTypes()
188 tags = self.get_multi_tag(tt.tagname, node)
190 if not tag.was_deleted(): ### Debugging
191 xml << (tag.tagname, tag.value)
193 tag = self.get_tag(tt.tagname, node)
195 if not tag.was_deleted(): ### Debugging
196 xml << (tag.tagname, tag.value)
198 def toxml(self, xml):
199 with xml.sliver_defaults:
200 self.tags_to_xml(xml)
205 def __init__(self, tag = None):
208 self.id = tag['slice_tag_id']
209 self.slice_id = tag['slice_id']
210 self.tagname = tag['tagname']
211 self.value = tag['value']
212 self.node_id = tag['node_id']
213 self.category = tag['category']
214 self.min_role_id = tag['min_role_id']
217 # Create a new slicetag that will be written to the DB later
218 def initialize(self, tagname, value, node, network):
219 tt = network.lookupTagType(tagname)
220 self.id = Slicetag.newid
222 self.slice_id = network.slice.id
223 self.tagname = tagname
226 self.node_id = node.id
229 self.category = tt.category
230 self.min_role_id = tt.min_role_id
233 def permit_update(self, role_id, value = None):
234 if value and self.value == value:
236 if role_id > self.min_role_id:
240 def change(self, value):
241 if self.value != value:
243 self.status = "change"
245 self.status = "updated"
247 # Mark a tag as deleted
249 self.status = "delete"
254 def was_changed(self):
255 return (self.status == "change")
257 def was_deleted(self):
258 return (self.status == "delete")
260 def was_updated(self):
261 return (self.status != None)
263 def write(self, api):
265 api.plshell.AddSliceTag(api.plauth, self.slice_id,
266 self.tagname, self.value, self.node_id)
267 elif self.was_changed():
268 api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
269 elif self.was_deleted():
270 api.plshell.DeleteSliceTag(api.plauth, self.id)
274 def __init__(self, tagtype):
275 self.id = tagtype['tag_type_id']
276 self.category = tagtype['category']
277 self.tagname = tagtype['tagname']
278 self.min_role_id = tagtype['min_role_id']
280 self.in_rspec = False
281 if self.category == 'slice/rspec':
283 if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
286 def permit_update(self, role_id):
287 if role_id > self.min_role_id:
294 A Network is a compound object consisting of:
295 * a dictionary mapping site IDs to Site objects
296 * a dictionary mapping node IDs to Node objects
297 * a dictionary mapping interface IDs to Iface objects
299 def __init__(self, api, type = "SFA"):
302 self.sites = self.get_sites(api)
303 self.nodes = self.get_nodes(api)
304 self.ifaces = self.get_ifaces(api)
305 self.tags = self.get_slice_tags(api)
306 self.tagtypes = self.get_tag_types(api)
309 def lookupSite(self, id):
310 """ Lookup site based on id or idtag value """
312 if isinstance(id, basestring):
313 id = int(id.lstrip('s'))
317 raise InvalidRSpec("site ID %s not found" % id)
323 sites.append(self.sites[s])
326 def lookupNode(self, id):
327 """ Lookup node based on id or idtag value """
329 if isinstance(id, basestring):
330 id = int(id.lstrip('n'))
334 raise InvalidRSpec("node ID %s not found" % id)
340 nodes.append(self.nodes[n])
343 def lookupIface(self, id):
344 """ Lookup iface based on id or idtag value """
346 if isinstance(id, basestring):
347 id = int(id.lstrip('i'))
349 val = self.ifaces[id]
351 raise InvalidRSpec("interface ID %s not found" % id)
356 for i in self.ifaces:
357 ifaces.append(self.ifaces[i])
360 def nodesWithSlivers(self):
368 def lookupSliceTag(self, id):
373 raise InvalidRSpec("slicetag ID %s not found" % id)
376 def getSliceTags(self):
379 tags.append(self.tags[t])
382 def lookupTagType(self, name):
385 val = self.tagtypes[name]
387 raise InvalidRSpec("tag %s not found" % name)
390 def getTagTypes(self):
392 for t in self.tagtypes:
393 tags.append(self.tagtypes[t])
396 def __process_attributes(self, element, node=None):
398 Process the elements under <sliver_defaults> or <sliver>
403 tagtypes = self.getTagTypes()
407 for e in element.iterfind("./" + tt.tagname):
408 self.slice.update_multi_tag(tt.tagname, e.text, node)
410 e = element.find("./" + tt.tagname)
412 self.slice.update_tag(tt.tagname, e.text, node)
414 def addRSpec(self, xml, schema=None):
416 Annotate the objects in the Network with information from the RSpec
419 tree = etree.parse(StringIO(xml))
420 except etree.XMLSyntaxError:
421 message = str(sys.exc_info()[1])
422 raise InvalidRSpec(message)
424 # Filter out stuff that's not for us
425 rspec = tree.getroot()
426 for network in rspec.iterfind("./network"):
427 if network.get("name") != self.api.hrn:
428 rspec.remove(network)
429 for request in rspec.iterfind("./request"):
430 if request.get("name") != self.api.hrn:
431 rspec.remove(request)
434 # Validate the incoming request against the RelaxNG schema
435 relaxng_doc = etree.parse(schema)
436 relaxng = etree.RelaxNG(relaxng_doc)
438 if not relaxng(tree):
439 error = relaxng.error_log.last_error
440 message = "%s (line %s)" % (error.message, error.line)
441 raise InvalidRSpec(message)
445 defaults = rspec.find(".//sliver_defaults")
446 self.__process_attributes(defaults)
448 # Find slivers under node elements
449 for sliver in rspec.iterfind("./network/site/node/sliver"):
450 elem = sliver.getparent()
452 node = self.lookupNode(elem.get("id"))
454 # Don't worry about nodes from other aggregates
458 self.__process_attributes(sliver, node)
460 # Find slivers that specify nodeid
461 for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
463 node = self.lookupNode(sliver.get("nodeid"))
465 # Don't worry about nodes from other aggregates
469 self.__process_attributes(sliver, node)
475 Annotate the objects in the Network with information from the slice
479 raise InvalidRSpec("no slice associated with network")
481 for node in slice.get_nodes():
484 def updateSliceTags(self):
486 Write any slice tags that have been added or modified back to the DB
488 for tag in self.getSliceTags():
489 if tag.category == 'slice/rspec' and not tag.was_updated() and tag.permit_update(None, 40):
490 # The user wants to delete this tag
493 # Update slice tags in database
494 for tag in self.getSliceTags():
495 if tag.slice_id == self.slice.id:
500 Produce XML directly from the topology specification.
502 xml = XMLBuilder(format = True, tab_step = " ")
503 with xml.RSpec(type=self.type):
505 element = xml.network(name=self.api.hrn, slice=self.slice.hrn)
507 element = xml.network(name=self.api.hrn)
511 self.slice.toxml(xml)
512 for site in self.getSites():
515 header = '<?xml version="1.0"?>\n'
516 return header + str(xml)
518 def get_sites(self, api):
520 Create a dictionary of site objects keyed by site ID
523 for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
524 t = site['site_id'], Site(self, site)
529 def get_nodes(self, api):
531 Create a dictionary of node objects keyed by node ID
534 for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
535 t = node['node_id'], Node(self, node)
539 def get_ifaces(self, api):
541 Create a dictionary of node objects keyed by node ID
544 for iface in api.plshell.GetInterfaces(api.plauth):
545 t = iface['interface_id'], Iface(self, iface)
549 def get_slice_tags(self, api):
551 Create a dictionary of slicetag objects keyed by slice tag ID
554 for tag in api.plshell.GetSliceTags(api.plauth):
555 t = tag['slice_tag_id'], Slicetag(tag)
559 def get_tag_types(self, api):
561 Create a list of tagtype obects keyed by tag name
564 for tag in api.plshell.GetTagTypes(api.plauth):
565 t = tag['tagname'], TagType(tag)
569 def get_slice(self, api, hrn):
571 Return a Slice object for a single slice
573 slicename = hrn_to_pl_slicename(hrn)
574 slice = api.plshell.GetSlices(api.plauth, [slicename])
576 self.slice = Slice(self, slicename, slice[0])