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.node_ids = set(slice['node_ids'])
119 self.slice_tag_ids = slice['slice_tag_ids']
122 Use with tags that can have more than one instance
124 def get_multi_tag(self, tagname, node = None):
126 for i in self.slice_tag_ids:
127 tag = self.network.lookupSliceTag(i)
128 if tag.tagname == tagname:
129 if not (node and node.id != tag.node_id):
134 Use with tags that have only one instance
136 def get_tag(self, tagname, node = None):
137 for i in self.slice_tag_ids:
138 tag = self.network.lookupSliceTag(i)
139 if tag.tagname == tagname:
140 if (not node) or (node.id == tag.node_id):
146 for id in self.node_ids:
147 if id in self.network.nodes:
148 n.append(self.network.nodes[id])
151 # Add a new slice tag
152 def add_tag(self, tagname, value, node = None, role_id = 40):
153 tt = self.network.lookupTagType(tagname)
154 if not tt.permit_update(role_id):
155 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
157 tag.initialize(tagname, value, node, self.network)
158 self.network.tags[tag.id] = tag
159 self.slice_tag_ids.append(tag.id)
162 # Update a slice tag if it exists, else add it
163 def update_tag(self, tagname, value, node = None, role_id = 40):
164 tag = self.get_tag(tagname, node)
166 if not tag.permit_update(role_id, value):
167 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
170 tag = self.add_tag(tagname, value, node, role_id)
173 def update_multi_tag(self, tagname, value, node = None, role_id = 40):
174 tags = self.get_multi_tag(tagname, node)
176 if tag and tag.value == value:
179 tag = self.add_tag(tagname, value, node, role_id)
182 def tags_to_xml(self, xml, node = None):
183 tagtypes = self.network.getTagTypes()
187 tags = self.get_multi_tag(tt.tagname, node)
189 if not tag.was_deleted(): ### Debugging
190 xml << (tag.tagname, tag.value)
192 tag = self.get_tag(tt.tagname, node)
194 if not tag.was_deleted(): ### Debugging
195 xml << (tag.tagname, tag.value)
197 def toxml(self, xml):
198 with xml.sliver_defaults:
199 self.tags_to_xml(xml)
204 def __init__(self, tag = None):
207 self.id = tag['slice_tag_id']
208 self.slice_id = tag['slice_id']
209 self.tagname = tag['tagname']
210 self.value = tag['value']
211 self.node_id = tag['node_id']
212 self.category = tag['category']
213 self.min_role_id = tag['min_role_id']
216 # Create a new slicetag that will be written to the DB later
217 def initialize(self, tagname, value, node, network):
218 tt = network.lookupTagType(tagname)
219 self.id = Slicetag.newid
221 self.slice_id = network.slice.id
222 self.tagname = tagname
225 self.node_id = node.id
228 self.category = tt.category
229 self.min_role_id = tt.min_role_id
232 def permit_update(self, role_id, value = None):
233 if value and self.value == value:
235 if role_id > self.min_role_id:
239 def change(self, value):
240 if self.value != value:
242 self.status = "change"
244 self.status = "updated"
246 # Mark a tag as deleted
248 self.status = "delete"
253 def was_changed(self):
254 return (self.status == "change")
256 def was_deleted(self):
257 return (self.status == "delete")
259 def was_updated(self):
260 return (self.status != None)
262 def write(self, api):
264 api.plshell.AddSliceTag(api.plauth, self.slice_id,
265 self.tagname, self.value, self.node_id)
266 elif self.was_changed():
267 api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
268 elif self.was_deleted():
269 api.plshell.DeleteSliceTag(api.plauth, self.id)
273 def __init__(self, tagtype):
274 self.id = tagtype['tag_type_id']
275 self.category = tagtype['category']
276 self.tagname = tagtype['tagname']
277 self.min_role_id = tagtype['min_role_id']
279 self.in_rspec = False
280 if self.category == 'slice/rspec':
282 if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
285 def permit_update(self, role_id):
286 if role_id > self.min_role_id:
292 A Network is a compound object consisting of:
293 * a dictionary mapping site IDs to Site objects
294 * a dictionary mapping node IDs to Node objects
295 * a dictionary mapping interface IDs to Iface objects
298 def __init__(self, api, type = "PlanetLab"):
301 self.sites = self.get_sites(api)
302 self.nodes = self.get_nodes(api)
303 self.ifaces = self.get_ifaces(api)
304 self.tags = self.get_slice_tags(api)
305 self.tagtypes = self.get_tag_types(api)
308 """ Lookup site based on id or idtag value """
309 def lookupSite(self, id):
311 if isinstance(id, basestring):
312 id = int(id.lstrip('s'))
316 raise InvalidRSpec("site ID %s not found" % id)
322 sites.append(self.sites[s])
325 """ Lookup node based on id or idtag value """
326 def lookupNode(self, id):
328 if isinstance(id, basestring):
329 id = int(id.lstrip('n'))
333 raise InvalidRSpec("node ID %s not found" % id)
339 nodes.append(self.nodes[n])
342 """ Lookup iface based on id or idtag value """
343 def lookupIface(self, id):
345 if isinstance(id, basestring):
346 id = int(id.lstrip('i'))
348 val = self.ifaces[id]
350 raise InvalidRSpec("interface ID %s not found" % id)
355 for i in self.ifaces:
356 ifaces.append(self.ifaces[i])
359 def nodesWithSlivers(self):
367 def lookupSliceTag(self, id):
372 raise InvalidRSpec("slicetag ID %s not found" % id)
375 def getSliceTags(self):
378 tags.append(self.tags[t])
381 def lookupTagType(self, name):
384 val = self.tagtypes[name]
386 raise InvalidRSpec("tag %s not found" % name)
389 def getTagTypes(self):
391 for t in self.tagtypes:
392 tags.append(self.tagtypes[t])
396 Process the elements under <sliver_defaults> or <sliver>
398 def __process_attributes(self, element, node=None):
402 tagtypes = self.getTagTypes()
406 for e in element.iterfind("./" + tt.tagname):
407 self.slice.update_multi_tag(tt.tagname, e.text, node)
409 e = element.find("./" + tt.tagname)
411 self.slice.update_tag(tt.tagname, e.text, node)
414 Annotate the objects in the Network with information from the RSpec
416 def addRSpec(self, xml, schema=None):
418 tree = etree.parse(StringIO(xml))
419 except etree.XMLSyntaxError:
420 message = str(sys.exc_info()[1])
421 raise InvalidRSpec(message)
424 # Validate the incoming request against the RelaxNG schema
425 relaxng_doc = etree.parse(schema)
426 relaxng = etree.RelaxNG(relaxng_doc)
428 if not relaxng(tree):
429 error = relaxng.error_log.last_error
430 message = "%s (line %s)" % (error.message, error.line)
431 raise InvalidRSpec(message)
433 rspec = tree.getroot()
436 defaults = rspec.find("./network/sliver_defaults")
437 self.__process_attributes(defaults)
439 # Find slivers under node elements
440 for sliver in rspec.iterfind("./network/site/node/sliver"):
441 elem = sliver.getparent()
443 node = self.lookupNode(elem.get("id"))
445 # Don't worry about nodes from other aggregates
449 self.__process_attributes(sliver, node)
451 # Find slivers that specify nodeid
452 for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
454 node = self.lookupNode(sliver.get("nodeid"))
456 # Don't worry about nodes from other aggregates
460 self.__process_attributes(sliver, node)
465 Annotate the objects in the Network with information from the slice
470 raise InvalidRSpec("no slice associated with network")
472 for node in slice.get_nodes():
476 Write any slice tags that have been added or modified back to the DB
478 def updateSliceTags(self):
479 for tag in self.getSliceTags():
480 if tag.category == 'slice/rspec' and not tag.was_updated() and tag.permit_update(None, 40):
481 # The user wants to delete this tag
484 # Update slice tags in database
485 for tag in self.getSliceTags():
486 if tag.slice_id == self.slice.id:
490 Produce XML directly from the topology specification.
493 xml = XMLBuilder(format = True, tab_step = " ")
494 with xml.RSpec(type=self.type):
495 name = "Public_" + self.type
497 element = xml.network(name=name, slice=self.slice.hrn)
499 element = xml.network(name=name)
503 self.slice.toxml(xml)
504 for site in self.getSites():
507 header = '<?xml version="1.0"?>\n'
508 return header + str(xml)
511 Create a dictionary of site objects keyed by site ID
513 def get_sites(self, api):
515 for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
516 t = site['site_id'], Site(self, site)
522 Create a dictionary of node objects keyed by node ID
524 def get_nodes(self, api):
526 for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
527 t = node['node_id'], Node(self, node)
532 Create a dictionary of node objects keyed by node ID
534 def get_ifaces(self, api):
536 for iface in api.plshell.GetInterfaces(api.plauth):
537 t = iface['interface_id'], Iface(self, iface)
542 Create a dictionary of slicetag objects keyed by slice tag ID
544 def get_slice_tags(self, api):
546 for tag in api.plshell.GetSliceTags(api.plauth):
547 t = tag['slice_tag_id'], Slicetag(tag)
552 Create a list of tagtype obects keyed by tag name
554 def get_tag_types(self, api):
556 for tag in api.plshell.GetTagTypes(api.plauth):
557 t = tag['tagname'], TagType(tag)
562 Return a Slice object for a single slice
564 def get_slice(self, api, hrn):
565 slicename = hrn_to_pl_slicename(hrn)
566 slice = api.plshell.GetSlices(api.plauth, [slicename])
568 self.slice = Slice(self, slicename, slice[0])