3 from StringIO import StringIO
4 from sfa.rspecs.rspec import RSpec
5 from sfa.util.xrn import *
6 from sfa.util.plxrn import hostname_to_urn
7 from sfa.util.config import Config
8 from sfa.rspecs.rspec_version import RSpecVersion
11 _version = { 'type': 'SFA',
15 sfa_rspec_version = RSpecVersion(_version)
17 class SfaRSpec(RSpec):
19 header = '<?xml version="1.0"?>\n'
20 version = sfa_rspec_version
24 self.xml.set('type', 'SFA')
29 def get_network_elements(self):
30 return self.xml.xpath('//network')
32 def get_networks(self):
33 return self.xml.xpath('//network[@name]/@name')
35 def get_node_element(self, hostname, network=None):
37 names = self.xml.xpath('//network[@name="%s"]//node/hostname' % network)
39 names = self.xml.xpath('//node/hostname')
41 if name.text == hostname:
42 return name.getparent()
45 def get_node_elements(self, network=None):
47 return self.xml.xpath('//network[@name="%s"]//node' % network)
49 return self.xml.xpath('//node')
51 def get_nodes(self, network=None):
53 nodes = self.xml.xpath('//node/hostname/text()')
55 nodes = self.xml.xpath('//network[@name="%s"]//node/hostname/text()' % network)
58 def get_nodes_with_slivers(self, network = None):
60 return self.xml.xpath('//network[@name="%s"]//node[sliver]/hostname/text()' % network)
62 return self.xml.xpath('//node[sliver]/hostname/text()')
64 def get_nodes_without_slivers(self, network=None):
65 xpath_nodes_without_slivers = '//node[not(sliver)]/hostname/text()'
66 xpath_nodes_without_slivers_in_network = '//network[@name="%s"]//node[not(sliver)]/hostname/text()'
68 return self.xml.xpath('//network[@name="%s"]//node[not(sliver)]/hostname/text()' % network)
70 return self.xml.xpath('//node[not(sliver)]/hostname/text()')
73 def attributes_list(self, elem):
74 # convert a list of attribute tags into list of tuples
75 # (tagnme, text_value)
79 opts.append((e.tag, e.text))
82 def get_default_sliver_attributes(self, network=None):
84 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
86 defaults = self.xml.xpath("//network/sliver_defaults" % network)
87 return self.attributes_list(defaults)
89 def get_sliver_attributes(self, hostname, network=None):
90 node = self.get_node_element(hostname, network)
91 sliver = node.find("sliver")
92 return self.attributes_list(sliver)
94 def get_site_nodes(self, siteid, network=None):
96 nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
99 nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid)
102 def get_links(self, network=None):
104 links = self.xml.xpath('//network[@name="%s"]/link' % network)
106 links = self.xml.xpath('//link')
109 (end1, end2) = link.get("endpoints").split()
110 name = link.find("description")
111 linklist.append((name.text,
112 self.get_site_nodes(end1, network),
113 self.get_site_nodes(end2, network)))
116 def get_link(self, fromnode, tonode, network=None):
117 fromsite = fromnode.getparent()
118 tosite = tonode.getparent()
119 fromid = fromsite.get("id")
120 toid = tosite.get("id")
122 query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
124 query = "//link[@endpoints = '%s %s']"
126 results = self.rspec.xpath(query % (fromid, toid))
128 results = self.rspec.xpath(query % (toid, fromid))
131 def query_links(self, fromnode, tonode, network=None):
132 return get_link(fromnode, tonode, network)
134 def get_vlinks(self, network=None):
137 vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network)
139 vlinks = self.xml.xpath("//vlink")
141 endpoints = vlink.get("endpoints")
142 (end1, end2) = endpoints.split()
144 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
146 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
149 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
150 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
151 desc = "%s <--> %s" % (node1, node2)
152 kbps = vlink.find("kbps")
153 vlinklist.append((endpoints, desc, kbps.text))
156 def get_vlink(self, endponts, network=None):
158 query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
160 query = "//vlink[@endpoints = '%s']" % (network, endpoints)
161 results = self.rspec.xpath(query)
164 def query_vlinks(self, endpoints, network=None):
165 return get_vlink(endpoints,network)
171 def add_network(self, network):
172 network_tag = etree.SubElement(self.xml, 'network', id=network)
174 def add_nodes(self, nodes, network = None, no_dupes=False):
175 if not isinstance(nodes, list):
179 self.get_node_element(node['hostname']):
180 # node already exists
183 network_tag = self.xml
184 if 'network' in node:
185 network = node['network']
186 network_tags = self.xml.xpath('//network[@name="%s"]' % network)
188 network_tag = etree.SubElement(self.xml, 'network', name=network)
190 network_tag = network_tags[0]
192 node_tag = etree.SubElement(network_tag, 'node')
193 if 'network' in node:
194 node_tag.set('component_manager_id', network)
196 node_tag.set('component_id', node['urn'])
197 if 'site_urn' in node:
198 node_tag.set('site_id', node['site_urn'])
199 if 'node_id' in node:
200 node_tag.set('node_id', 'n'+str(node['node_id']))
201 if 'hostname' in node:
202 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
203 if 'interfaces' in node:
204 for interface in node['interfaces']:
205 if 'bwlimit' in interface and interface['bwlimit']:
206 bwlimit = etree.SubElement(node_tag, 'bw_limit', units='kbps').text = str(interface['bwlimit']/1000)
208 for tag in node['tags']:
209 # expose this hard wired list of tags, plus the ones that are marked 'sfa' in their category
210 if tag['tagname'] in ['fcdistro', 'arch'] or 'sfa' in tag['category'].split('/'):
211 tag_element = etree.SubElement(node_tag, tag['tagname'], value=tag['value'])
214 longitude = str(node['site']['longitude'])
215 latitude = str(node['site']['latitude'])
216 location = etree.SubElement(node_tag, 'location', country='unknown', \
217 longitude=longitude, latitude=latitude)
219 def add_interfaces(self, interfaces):
222 def add_links(self, links):
225 def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False):
226 slivers = self._process_slivers(slivers)
227 nodes_with_slivers = self.get_nodes_with_slivers(network)
228 for sliver in slivers:
229 if sliver['hostname'] in nodes_with_slivers:
231 node_elem = self.get_node_element(sliver['hostname'], network)
232 sliver_elem = etree.SubElement(node_elem, 'sliver')
234 for tag in sliver['tags']:
235 etree.SubElement(sliver_elem, tag['tagname'], value=tag['value'])
237 def remove_slivers(self, slivers, network=None, no_dupes=False):
238 slivers = self._process_slivers(slivers)
239 for sliver in slivers:
240 node_elem = self.get_node_element(sliver['hostname'], network)
241 sliver_elem = node_elem.find('sliver')
242 if sliver_elem != None:
243 node_elem.remove(sliver_elem)
245 def add_default_sliver_attribute(self, name, value, network=None):
247 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
249 defaults = self.xml.xpath("//sliver_defaults" % network)
251 defaults = etree.Element("sliver_defaults")
252 network = self.xml.xpath("//network[@name='%s']" % network)
253 network.insert(0, defaults)
254 self.add_attribute(defaults, name, value)
256 def add_sliver_attribute(self, hostname, name, value, network=None):
257 node = self.get_node_element(hostname, network)
258 sliver = node.find("sliver")
259 self.add_attribute(sliver, name, value)
261 def remove_default_sliver_attribute(self, name, value, network=None):
263 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
265 defaults = self.xml.xpath("//sliver_defaults" % network)
266 self.remove_attribute(defaults, name, value)
268 def remove_sliver_attribute(self, hostname, name, value, network=None):
269 node = self.get_node_element(hostname, network)
270 sliver = node.find("sliver")
271 self.remove_attribute(sliver, name, value)
273 def add_vlink(self, fromhost, tohost, kbps, network=None):
274 fromnode = self.get_node_element(fromhost, network)
275 tonode = self.get_node_element(tohost, network)
276 links = self.get_link(fromnode, tonode, network)
279 vlink = etree.SubElement(link, "vlink")
280 fromid = fromnode.get("id")
281 toid = tonode.get("id")
282 vlink.set("endpoints", "%s %s" % (fromid, toid))
283 self.add_attribute(vlink, "kbps", kbps)
286 def remove_vlink(self, endpoints, network=None):
287 vlinks = self.query_vlinks(endpoints, network)
289 vlink.getparent().remove(vlink)
292 def merge(self, in_rspec):
294 Merge contents for specified rspec with current rspec
297 # just copy over all networks
298 current_networks = self.get_networks()
299 rspec = SfaRSpec(rspec=in_rspec)
300 networks = rspec.get_network_elements()
301 for network in networks:
302 current_network = network.get('name')
303 if not current_network in current_networks:
304 self.xml.append(network)
305 current_networks.append(current_network)
309 if __name__ == '__main__':
313 'hostname': 'node1.planet-lab.org',
314 'site_urn': 'urn:publicid:IDN+plc+authority+cm',
318 'hostname': 'node2.planet-lab.org',
319 'site_urn': 'urn:publicid:IDN+plc+authority+cm',
323 'hostname': 'node1.planet-lab.eu',
324 'site_urn': 'urn:publicid:IDN+plc+authority+cm',
328 rspec.add_nodes(nodes)