fix bug in remove_slivers()
[sfa.git] / sfa / rspecs / sfa_rspec.py
1 #!/usr/bin/python 
2 from lxml import etree
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
9
10 class SfaRSpec(RSpec):
11     xml = None
12     header = '<?xml version="1.0"?>\n'
13     namespaces = {}
14     type = 'sfa'
15     ###################
16     # Parser
17     ###################
18     def get_network_elements(self):
19         return self.xml.xpath('//network', self.namespaces)
20
21     def get_networks(self):
22         return self.xml.xpath('//network[@name]/@name', self.namespaces)
23
24     def get_node_element(self, hostname, network=None):
25         if network:
26             names = self.xml.xpath('//network[@name="%s"]//node/hostname' % network)
27         else:
28             names = self.xml.xpath('//node/hostname')
29         for name in names:
30             if name.text == hostname:
31                 return name.getparent()
32         return None
33  
34     def get_node_elements(self):
35         return self.xml.xpath('//node', self.namespaces)
36
37     def get_nodes(self, network=None):
38         if network == None:
39             nodes = self.xml.xpath('//node/hostname/text()', self.namespaces)
40         else:
41             nodes = self.xml.xpath('//network[@name="%s"]//node/hostname/text()' % network, self.namespaces)
42         return nodes
43
44     def get_nodes_with_slivers(self, network = None):
45         if network:
46             return self.xml.xpath('//network[@name="%s"]//node[sliver]/hostname/text()' % network, self.namespaces)   
47         else:
48             return self.xml.xpath('//node[sliver]/hostname/text()', self.namespaces)
49
50     def get_nodes_without_slivers(self, network=None): 
51         xpath_nodes_without_slivers = '//node[not(sliver)]/hostname/text()'
52         xpath_nodes_without_slivers_in_network = '//network[@name="%s"]//node[not(sliver)]/hostname/text()' 
53         if network:
54             return self.xml.xpath('//network[@name="%s"]//node[not(sliver)]/hostname/text()' % network, self.namespaces)
55         else:
56             return self.xml.xpath('//node[not(sliver)]/hostname/text()', self.namespaces)      
57
58
59     def attributes_list(self, elem):
60         # convert a list of attribute tags into list of tuples
61         # (tagnme, text_value) 
62         opts = []
63         if elem is not None:
64             for e in elem:
65                 opts.append((e.tag, e.text))
66         return opts
67
68     def get_default_sliver_attributes(self, network=None):
69         if network:
70             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network, self.namespaces)        
71         else:
72             defaults = self.xml.xpath("//network/sliver_defaults" % network, self.namespaces)
73         return self.attributes_list(defaults)
74
75     def get_sliver_attributes(self, hostname, network=None):
76         node = self.get_node_element(hostname, network)
77         sliver = node.find("sliver")
78         return self.attributes_list(sliver)
79
80     def get_site_nodes(self, siteid, network=None):
81         if network:
82             nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
83                                     (network, siteid), self.namespaces)
84         else:
85             nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid, self.namespaces)
86         return nodes
87         
88     def get_links(self, network=None):
89         if network: 
90             links = self.xml.xpath('//network[@name="%s"]/link' % network, self.namespaces)
91         else:
92             links = self.xml.xpath('//link')    
93         linklist = []
94         for link in links:
95             (end1, end2) = link.get("endpoints").split()
96             name = link.find("description")
97             linklist.append((name.text,
98                              self.get_site_nodes(end1, network),
99                              self.get_site_nodes(end2, network)))
100         return linklist
101
102     def get_link(self, fromnode, tonode, network=None):
103         fromsite = fromnode.getparent()
104         tosite = tonode.getparent()
105         fromid = fromsite.get("id")
106         toid = tosite.get("id")
107         if network:
108             query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
109         else:
110             query = "//link[@endpoints = '%s %s']"
111
112         results = self.rspec.xpath(query % (fromid, toid))
113         if not results:
114             results = self.rspec.xpath(query % (toid, fromid))
115         return results
116
117     def query_links(self, fromnode, tonode, network=None):
118         return get_link(fromnode, tonode, network)
119
120     def get_vlinks(self, network=None):
121         vlinklist = []
122         if network: 
123             vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network, self.namespaces)
124         else:
125             vlinks = self.xml.xpath("//vlink", self.namespaces) 
126         for vlink in vlinks:
127             endpoints = vlink.get("endpoints")
128             (end1, end2) = endpoints.split()
129             if network: 
130                 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
131                                        (network, end1))[0]
132                 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
133                                        (network, end2))[0]
134             else: 
135                 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
136                 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
137             desc = "%s <--> %s" % (node1, node2)
138             kbps = vlink.find("kbps")
139             vlinklist.append((endpoints, desc, kbps.text))
140         return vlinklist
141
142     def get_vlink(self, endponts, network=None):
143         if network:
144             query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
145         else:
146             query = "//vlink[@endpoints = '%s']" % (network, endpoints)
147         results = self.rspec.xpath(query)
148         return results
149         
150     def query_vlinks(self, endpoints, network=None):
151         return get_vlink(endpoints,network)
152
153     ##################
154     # Builder
155     ##################
156
157     def add_network(self, network):
158         network_tag = etree.SubElement(self.xml, 'network', id=network)     
159
160     def add_nodes(self, nodes, network = None, no_dupes=False):
161         if not isinstance(nodes, list):
162             nodes = [nodes]
163         for node in nodes:
164             if no_dupes and \
165               self.get_node_element(node['hostname']):
166                 # node already exists
167                 continue
168
169             network_tag = self.xml
170             if 'network' in node:
171                 network = node['network']
172                 network_tags = self.xml.xpath('//network[@name="%s"]' % network, self.namespaces)
173                 if not network_tags:
174                     network_tag = etree.SubElement(self.xml, 'network', name=network)
175                 else:
176                     network_tag = network_tags[0]
177                      
178             node_tag = etree.SubElement(network_tag, 'node')
179             if 'network' in node:
180                 node_tag.set('component_manager_uuid', network)
181             if 'urn' in node:
182                 node_tag.set('compinent_uuid', node['urn']) 
183             if 'site_urn' in node:
184                 node_tag.set('site_uuid', node['site_urn'])
185             if 'node_id' in node: 
186                 node_tag.set('node_id', 'n'+str(node['node_id']))
187             if 'hostname' in node:
188                 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
189             if 'bw_unallocated' in node:
190                pass
191             if 'bw_limit' in node:
192                 pass      
193             
194
195     def add_slivers(self, hostnames, network=None, no_dupes=False):
196         if not isinstance(hostnames, list):
197             hostnames = [hostnames]
198
199         nodes_with_slivers = self.get_nodes_with_slivers(network)
200         for hostname in hostnames:
201             if hostname in nodes_with_slivers:
202                 continue
203             node = self.get_node_element(hostname, network)
204             etree.SubElement(node, 'sliver')
205
206     def remove_slivers(self, hostnames, network=None, no_dupes=False):
207         if not isinstance(hostnames, list):
208             hostnames = [hostnames]
209         for hostname in hostnames:
210             node = self.get_node_element(hostname, network)
211             sliver = node.find('sliver')
212             if sliver != None:
213                 node.remove(sliver)                 
214     
215     def add_default_sliver_attribute(self, name, value, network=None):
216         if network:
217             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
218         else:
219             defaults = self.xml.xpath("//sliver_defaults" % network)
220         if defaults is None:
221             defaults = etree.Element("sliver_defaults")
222             network = self.xml.xpath("//network[@name='%s']" % network)
223             network.insert(0, defaults)
224         self.add_attribute(defaults, name, value)
225
226     def add_sliver_attribute(self, hostname, name, value, network=None):
227         node = self.get_node_element(hostname, network)
228         sliver = node.find("sliver")
229         self.add_attribute(sliver, name, value)
230
231     def remove_default_sliver_attribute(self, name, value, network=None):
232         if network:
233             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
234         else:
235             defaults = self.xml.xpath("//sliver_defaults" % network)
236         self.remove_attribute(defaults, name, value)
237
238     def remove_sliver_attribute(self, hostname, name, value, network=None):
239         node = self.get_node_element(hostname, network)
240         sliver = node.find("sliver")
241         self.remove_attribute(sliver, name, value)
242
243     def add_vlink(self, fromhost, tohost, kbps, network=None):
244         fromnode = self.get_node_element(fromhost, network)
245         tonode = self.get_node_element(tohost, network)
246         links = self.get_link(fromnode, tonode, network)
247
248         for link in links:
249             vlink = etree.SubElement(link, "vlink")
250             fromid = fromnode.get("id")
251             toid = tonode.get("id")
252             vlink.set("endpoints", "%s %s" % (fromid, toid))
253             self.add_attribute(vlink, "kbps", kbps)
254
255
256     def remove_vlink(self, endpoints, network=None):
257         vlinks = self.query_vlinks(endpoints, network)
258         for vlink in vlinks:
259             vlink.getparent().remove(vlink)
260
261
262     def merge(self, in_rspec):
263         """
264         Merge contents for specified rspec with current rspec 
265         """
266
267         # just copy over all networks
268         current_networks = self.get_networks()
269         rspec = SfaRSpec(rspec=in_rspec)
270         networks = rspec.get_network_elements()
271         for network in networks:
272             current_network = network.get('name')
273             if not current_network in current_networks:
274                 self.xml.append(network)
275                 current_networks.append(current_network)
276         
277          
278
279 if __name__ == '__main__':
280     rspec = SfaRSpec()
281     nodes = [
282     {'network': 'plc',
283      'hostname': 'node1.planet-lab.org',
284      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
285       'node_id': 1,
286     },
287     {'network': 'plc',
288      'hostname': 'node2.planet-lab.org',
289      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
290       'node_id': 1,
291     },
292     {'network': 'ple',
293      'hostname': 'node1.planet-lab.eu',
294      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
295       'node_id': 1,
296     },
297     ]
298     rspec.add_nodes(nodes)
299     print rspec