1 from __future__ import with_statement
4 from sfa.util.xrn import get_authority
5 from sfa.util.plxrn import hrn_to_pl_slicename, hostname_to_urn
6 from sfa.util.faults import *
7 from xmlbuilder import XMLBuilder
10 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']
35 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']
52 auth = self.network.api.hrn
53 login_base = self.get_site().idtag
54 self.urn = hostname_to_urn(auth, login_base, self.hostname)
56 def get_primary_iface(self):
57 for id in self.iface_ids:
58 iface = self.network.lookupIface(id)
64 return self.network.lookupSite(self.site_id)
67 self.sliver = Sliver(self)
70 slice = self.network.slice
71 if self.whitelist and not self.sliver:
72 if not slice or slice.id not in self.whitelist:
75 with xml.node(id = self.idtag):
80 iface = self.get_primary_iface()
84 self.sliver.toxml(xml)
88 def __init__(self, network, site):
89 self.network = network
90 self.id = site['site_id']
91 self.node_ids = site['node_ids']
93 self.name = site['abbreviated_name']
94 self.tag = site['login_base']
95 self.idtag = site['login_base']
96 self.public = site['is_public']
97 self.enabled = site['enabled']
99 self.whitelist = False
101 def get_sitenodes(self):
103 for i in self.node_ids:
104 n.append(self.network.lookupNode(i))
107 def toxml(self, xml):
108 if not (self.public and self.enabled and self.node_ids):
110 with xml.site(id = self.idtag):
113 for node in self.get_sitenodes():
118 def __init__(self, network, hrn, slice):
120 self.network = network
121 self.id = slice['slice_id']
122 self.name = slice['name']
123 self.peer_id = slice['peer_id']
124 self.node_ids = set(slice['node_ids'])
125 self.slice_tag_ids = slice['slice_tag_ids']
128 Use with tags that can have more than one instance
130 def get_multi_tag(self, tagname, node = None):
132 for i in self.slice_tag_ids:
134 tag = self.network.lookupSliceTag(i)
135 if tag.tagname == tagname:
137 if node.id == tag.node_id:
139 elif not tag.node_id:
141 except InvalidRSpec, e:
142 # As they're not needed, we ignore some tag types from
143 # GetSliceTags call. See Slicetag.ignore_tags
148 Use with tags that have only one instance
150 def get_tag(self, tagname, node = None):
151 for i in self.slice_tag_ids:
153 tag = self.network.lookupSliceTag(i)
154 if tag.tagname == tagname:
156 if node.id == tag.node_id:
158 elif not tag.node_id:
160 except InvalidRSpec, e:
161 # As they're not needed, we ignore some tag types from
162 # GetSliceTags call. See Slicetag.ignore_tags
168 for id in self.node_ids:
169 if id in self.network.nodes:
170 n.append(self.network.nodes[id])
173 # Add a new slice tag
174 def add_tag(self, tagname, value, node = None, role = "user"):
175 tt = self.network.lookupTagType(tagname)
176 if not tt.permit_update(role):
177 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
179 tag.initialize(tagname, value, node, self.network)
180 self.network.tags[tag.id] = tag
181 self.slice_tag_ids.append(tag.id)
184 # Update a slice tag if it exists, else add it
185 def update_tag(self, tagname, value, node = None, role = "user"):
186 tag = self.get_tag(tagname, node)
187 if tag and tag.value == value:
190 tt = self.network.lookupTagType(tagname)
191 if not tt.permit_update(role):
192 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
197 tag = self.add_tag(tagname, value, node, role)
200 def update_multi_tag(self, tagname, value, node = None, role = "user"):
201 tags = self.get_multi_tag(tagname, node)
203 if tag and tag.value == value:
206 tag = self.add_tag(tagname, value, node, role)
209 def tags_to_xml(self, xml, node = None):
210 tagtypes = self.network.getTagTypes()
214 tags = self.get_multi_tag(tt.tagname, node)
216 if not tag.was_deleted(): ### Debugging
217 xml << (tag.tagname, tag.value)
219 tag = self.get_tag(tt.tagname, node)
221 if not tag.was_deleted(): ### Debugging
222 xml << (tag.tagname, tag.value)
224 def toxml(self, xml):
225 with xml.sliver_defaults:
226 self.tags_to_xml(xml)
231 filter_fields = ['slice_tag_id','slice_id','tagname','value','node_id','category']
232 ignore_tags = ['hmac','ssh_key']
233 def __init__(self, tag = None):
236 self.id = tag['slice_tag_id']
237 self.slice_id = tag['slice_id']
238 self.tagname = tag['tagname']
239 self.value = tag['value']
240 self.node_id = tag['node_id']
241 self.category = tag['category']
244 # Create a new slicetag that will be written to the DB later
245 def initialize(self, tagname, value, node, network):
246 tt = network.lookupTagType(tagname)
247 self.id = Slicetag.newid
249 self.slice_id = network.slice.id
250 self.tagname = tagname
253 self.node_id = node.id
256 self.category = tt.category
259 def change(self, value):
260 if self.value != value:
262 self.status = "change"
264 self.status = "updated"
266 # Mark a tag as deleted
268 self.status = "delete"
273 def was_changed(self):
274 return (self.status == "change")
276 def was_deleted(self):
277 return (self.status == "delete")
279 def was_updated(self):
280 return (self.status != None)
282 def write(self, api):
284 api.plshell.AddSliceTag(api.plauth, self.slice_id,
285 self.tagname, self.value, self.node_id)
286 elif self.was_changed():
287 api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
288 elif self.was_deleted():
289 api.plshell.DeleteSliceTag(api.plauth, self.id)
293 ignore_tags = ['hmac','ssh_key']
294 def __init__(self, tagtype):
295 self.id = tagtype['tag_type_id']
296 self.category = tagtype['category']
297 self.tagname = tagtype['tagname']
298 self.roles = tagtype['roles']
300 self.in_rspec = False
301 if self.category == 'slice/rspec':
303 if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
306 def permit_update(self, role):
307 if role in self.roles:
314 A Network is a compound object consisting of:
315 * a dictionary mapping site IDs to Site objects
316 * a dictionary mapping node IDs to Node objects
317 * a dictionary mapping interface IDs to Iface objects
319 def __init__(self, api, type = "SFA"):
322 self.sites = self.get_sites(api)
323 self.nodes = self.get_nodes(api)
324 self.ifaces = self.get_ifaces(api)
325 self.tags = self.get_slice_tags(api)
326 self.tagtypes = self.get_tag_types(api)
331 self.sitemap[site.idtag] = site.id
333 def lookupSiteIdtag(self, name):
334 """ Lookup site id from name """
337 val = self.sitemap[name]
339 raise InvalidRSpec("site name '%s' not found" % name)
342 def lookupSite(self, id):
343 """ Lookup site based on id or idtag value """
345 if isinstance(id, basestring):
346 id = self.lookupSiteIdtag(id)
350 self.api.logger.error("Invalid RSpec: site ID %s not found" % id )
351 raise InvalidRSpec("site ID %s not found" % id)
357 sites.append(self.sites[s])
360 def lookupNode(self, id):
361 """ Lookup node based on id or idtag value """
363 if isinstance(id, basestring):
364 id = int(id.lstrip('n'))
368 raise InvalidRSpec("node ID %s not found" % id)
374 nodes.append(self.nodes[n])
377 def lookupIface(self, id):
378 """ Lookup iface based on id or idtag value """
380 if isinstance(id, basestring):
381 id = int(id.lstrip('i'))
383 val = self.ifaces[id]
385 raise InvalidRSpec("interface ID %s not found" % id)
390 for i in self.ifaces:
391 ifaces.append(self.ifaces[i])
394 def nodesWithSlivers(self):
402 def lookupSliceTag(self, id):
407 raise InvalidRSpec("slicetag ID %s not found" % id)
410 def getSliceTags(self):
413 tags.append(self.tags[t])
416 def lookupTagType(self, name):
419 val = self.tagtypes[name]
421 raise InvalidRSpec("tag %s not found" % name)
424 def getTagTypes(self):
426 for t in self.tagtypes:
427 tags.append(self.tagtypes[t])
430 def __process_attributes(self, element, node=None):
432 Process the elements under <sliver_defaults> or <sliver>
437 tagtypes = self.getTagTypes()
441 for e in element.iterfind("./" + tt.tagname):
442 self.slice.update_multi_tag(tt.tagname, e.text, node)
444 e = element.find("./" + tt.tagname)
446 self.slice.update_tag(tt.tagname, e.text, node)
448 def addRSpec(self, xml, schema=None):
450 Annotate the objects in the Network with information from the RSpec
453 tree = etree.parse(StringIO(xml))
454 except etree.XMLSyntaxError:
455 message = str(sys.exc_info()[1])
456 raise InvalidRSpec(message)
458 # Filter out stuff that's not for us
459 rspec = tree.getroot()
460 for network in rspec.iterfind("./network"):
461 if network.get("name") != self.api.hrn:
462 rspec.remove(network)
463 for request in rspec.iterfind("./request"):
464 if request.get("name") != self.api.hrn:
465 rspec.remove(request)
468 # Validate the incoming request against the RelaxNG schema
469 relaxng_doc = etree.parse(schema)
470 relaxng = etree.RelaxNG(relaxng_doc)
472 if not relaxng(tree):
473 error = relaxng.error_log.last_error
474 message = "%s (line %s)" % (error.message, error.line)
475 raise InvalidRSpec(message)
479 defaults = rspec.find(".//sliver_defaults")
480 self.__process_attributes(defaults)
482 # Find slivers under node elements
483 for sliver in rspec.iterfind("./network/site/node/sliver"):
484 elem = sliver.getparent()
486 node = self.lookupNode(elem.get("id"))
488 # Don't worry about nodes from other aggregates
492 self.__process_attributes(sliver, node)
494 # Find slivers that specify nodeid
495 for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
497 node = self.lookupNode(sliver.get("nodeid"))
499 # Don't worry about nodes from other aggregates
503 self.__process_attributes(sliver, node)
509 Annotate the objects in the Network with information from the slice
513 raise InvalidRSpec("no slice associated with network")
515 for node in slice.get_nodes():
518 def updateSliceTags(self):
520 Write any slice tags that have been added or modified back to the DB
522 for tag in self.getSliceTags():
523 if tag.category == 'slice/rspec' and not tag.was_updated():
524 tt = self.lookupTagType(tag.tagname)
525 if tt.permit_update("user"):
528 # Update slice tags in database
529 for tag in self.getSliceTags():
530 if tag.slice_id == self.slice.id:
535 Produce XML directly from the topology specification.
537 xml = XMLBuilder(format = True, tab_step = " ")
538 with xml.RSpec(type=self.type):
540 element = xml.network(name=self.api.hrn, slice=self.slice.hrn)
542 element = xml.network(name=self.api.hrn)
546 self.slice.toxml(xml)
547 for site in self.getSites():
550 header = '<?xml version="1.0"?>\n'
551 return header + str(xml)
553 def get_sites(self, api):
555 Create a dictionary of site objects keyed by site ID
558 for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
559 t = site['site_id'], Site(self, site)
564 def get_nodes(self, api):
566 Create a dictionary of node objects keyed by node ID
569 for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
571 nodeObj = Node(self, node)
572 if nodeObj.site != None:
573 t = node['node_id'], nodeObj
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])