cleanup
[sfa.git] / sfa / rspecs / versions / sfav1.py
1 from copy import deepcopy
2 from lxml import etree
3
4 from sfa.util.sfalogging import logger
5 from sfa.util.xrn import hrn_to_urn, urn_to_hrn
6 from sfa.util.plxrn import PlXrn
7
8 from sfa.rspecs.baseversion import BaseVersion
9 from sfa.rspecs.elements.element import Element
10 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
11 from sfa.rspecs.elements.versions.sfav1Node import SFAv1Node
12
13 class SFAv1(BaseVersion):
14     enabled = True
15     type = 'SFA'
16     content_type = '*'
17     version = '1'
18     schema = None
19     namespace = None
20     extensions = {}
21     namespaces = None
22     template = '<RSpec type="%s"></RSpec>' % type
23
24     # Network 
25     def get_networks(self):
26         return Element.get_elements(self.xml, '//network', Element)
27
28     def add_network(self, network):
29         network_tags = self.xml.xpath('//network[@name="%s"]' % network)
30         if not network_tags:
31             network_tag = etree.SubElement(self.xml.root, 'network', name=network)
32         else:
33             network_tag = network_tags[0]
34         return network_tag
35
36
37     # Nodes
38     
39     def get_nodes(self, filter=None):
40         return SFAv1Node.get_nodes(self.xml, filter)
41
42     def get_nodes_with_slivers(self):
43         return SFAv1Node.get_nodes_with_slivers(self.xml)
44
45     def add_nodes(self, nodes, network = None, no_dupes=False):
46         SFAv1Node.add_nodes(self.xml, nodes)
47
48     def merge_node(self, source_node_tag, network, no_dupes=False):
49         if no_dupes and self.get_node_element(node['hostname']):
50             # node already exists
51             return
52
53         network_tag = self.add_network(network)
54         network_tag.append(deepcopy(source_node_tag))
55
56     # Slivers
57     
58     def attributes_list(self, elem):
59         # convert a list of attribute tags into list of tuples
60         # (tagname, text_value)
61         opts = []
62         if elem is not None:
63             for e in elem:
64                 opts.append((e.tag, str(e.text).strip()))
65         return opts
66
67     def get_default_sliver_attributes(self, network=None):
68         if network:
69             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
70         else:
71             defaults = self.xml.xpath("//sliver_defaults")
72         if not defaults: return []
73         return self.attributes_list_thierry(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         slivers = node.xpath('./sliver')
79         if not slivers: return []
80         return self.attributes_list_thierry(slivers[0])
81
82     def get_slice_attributes(self, network=None):
83         slice_attributes = []
84         nodes_with_slivers = self.get_nodes_with_slivers(network)
85         for default_attribute in self.get_default_sliver_attributes(network):
86             attribute = {'name': str(default_attribute[0]), 
87                          'value': str(default_attribute[1]), 
88                          'node_id': None}
89             slice_attributes.append(attribute)
90         for node in nodes_with_slivers:
91             nodename=node.get('component_name')
92             sliver_attributes = self.get_sliver_attributes(nodename, network)
93             for sliver_attribute in sliver_attributes:
94                 attribute = {'name': str(sliver_attribute[0]), 'value': str(sliver_attribute[1]), 'node_id': node}
95                 slice_attributes.append(attribute)
96         return slice_attributes
97
98     def add_slivers(self, hostnames, attributes=[], sliver_urn=None, append=False):
99         # add slice name to network tag
100         network_tags = self.xml.xpath('//network')
101         if network_tags:
102             network_tag = network_tags[0]
103             network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
104         
105         # add slivers
106         sliver = {'name':sliver_urn,
107                   'pl_tags': attributes}
108         for hostname in hostnames:
109             if sliver_urn:
110                 sliver['name'] = sliver_urn
111             node_elems = self.get_nodes({'component_id': '*%s*' % hostname})
112             if not node_elems: 
113                 continue
114             node_elem = node_elems[0]
115             SFAv1Sliver.add_slivers(node_elem, sliver)   
116
117         # remove all nodes without slivers
118         if not append:
119             for node_elem in self.get_nodes():
120                 if not node['slivers']:
121                     parent = node.getparent()
122                     parent.remove(node_elem)
123
124
125     def remove_slivers(self, slivers, network=None, no_dupes=False):
126         SFAv1Node.remove_slivers(self.xml, slivers)
127
128     def add_default_sliver_attribute(self, name, value, network=None):
129         if network:
130             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
131         else:
132             defaults = self.xml.xpath("//sliver_defaults" % network)
133         if not defaults :
134             network_tag = self.xml.xpath("//network[@name='%s']" % network)
135             if isinstance(network_tag, list):
136                 network_tag = network_tag[0]
137             defaults = self.xml.add_element('sliver_defaults', attrs={}, parent=network_tag)
138         elif isinstance(defaults, list):
139             defaults = defaults[0]
140         self.xml.add_attribute(defaults, name, value)
141
142     def add_sliver_attribute(self, hostname, name, value, network=None):
143         node = self.get_node_element(hostname, network)
144         sliver = node.find("sliver")
145         self.xml.add_attribute(sliver, name, value)
146
147     def remove_default_sliver_attribute(self, name, value, network=None):
148         if network:
149             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
150         else:
151             defaults = self.xml.xpath("//sliver_defaults" % network)
152         self.xml.remove_attribute(defaults, name, value)
153
154     def remove_sliver_attribute(self, hostname, name, value, network=None):
155         node = self.get_node_element(hostname, network)
156         sliver = node.find("sliver")
157         self.xml.remove_attribute(sliver, name, value)
158
159     # Links
160
161     def get_links(self, network=None):
162         return PGv2Link.get_links(self.xml)
163
164     def get_link_requests(self):
165         return PGv2Link.get_link_requests(self.xml) 
166
167     def add_links(self, links):
168         networks = self.get_networks()
169         if len(networks) > 0:
170             xml = networks[0]
171         else:
172             xml = self.xml
173         PGv2Link.add_links(xml, links)
174
175     def add_link_requests(self, links):
176         PGv2Link.add_link_requests(self.xml, links)
177
178     # utility
179
180     def merge(self, in_rspec):
181         """
182         Merge contents for specified rspec with current rspec
183         """
184
185         from sfa.rspecs.rspec import RSpec
186         if isinstance(in_rspec, RSpec):
187             rspec = in_rspec
188         else:
189             rspec = RSpec(in_rspec)
190         if rspec.version.type.lower() == 'protogeni':
191             from sfa.rspecs.rspec_converter import RSpecConverter
192             in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
193             rspec = RSpec(in_rspec)
194
195         # just copy over all networks
196         current_networks = self.get_networks()
197         networks = rspec.version.get_networks()
198         for network in networks:
199             current_network = network.get('name')
200             if current_network and current_network not in current_networks:
201                 self.xml.append(network.element)
202                 current_networks.append(current_network)
203
204 if __name__ == '__main__':
205     from sfa.rspecs.rspec import RSpec
206     from sfa.rspecs.rspec_elements import *
207     r = RSpec('/tmp/resources.rspec')
208     r.load_rspec_elements(SFAv1.elements)
209     print r.get(RSpecElements.NODE)