All versions of rspecs need to support "links" and "channels" management methods
[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.rspecs.version import RSpecVersion
7 from sfa.rspecs.elements.element import Element
8 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
9 from sfa.rspecs.elements.versions.sfav1Node import SFAv1Node
10 from sfa.rspecs.elements.versions.sfav1Sliver import SFAv1Sliver
11 from sfa.rspecs.elements.versions.sfav1Lease import SFAv1Lease
12
13 class SFAv1(RSpecVersion):
14     enabled = True
15     type = 'SFA'
16     content_type = '*'
17     version = '1'
18     schema = ''
19     namespace = ''
20     extensions = {}
21     namespaces = None
22     template = '<RSpec type="%s"></RSpec>' % type
23
24     # Network 
25     def get_networks(self):
26         network_elems = self.xml.xpath('//network')
27         networks = [network_elem.get_instance(fields=['name', 'slice']) for \
28                     network_elem in network_elems]
29         return networks    
30
31
32     def add_network(self, network):
33         network_tags = self.xml.xpath('//network[@name="%s"]' % network)
34         if not network_tags:
35             network_tag = self.xml.add_element('network', name=network)
36         else:
37             network_tag = network_tags[0]
38         return network_tag
39
40
41     # Nodes
42     
43     def get_nodes(self, filter=None):
44         return SFAv1Node.get_nodes(self.xml, filter)
45
46     def get_nodes_with_slivers(self):
47         return SFAv1Node.get_nodes_with_slivers(self.xml)
48
49     def add_nodes(self, nodes, network = None, no_dupes=False, rspec_content_type=None):
50         SFAv1Node.add_nodes(self.xml, nodes, rspec_content_type)
51
52     def merge_node(self, source_node_tag, network, no_dupes=False):
53         if no_dupes and self.get_node_element(node['hostname']):
54             # node already exists
55             return
56
57         network_tag = self.add_network(network)
58         network_tag.append(deepcopy(source_node_tag))
59
60     # Slivers
61    
62     def add_slivers(self, hostnames, attributes=[], sliver_urn=None, append=False):
63         # add slice name to network tag
64         network_tags = self.xml.xpath('//network')
65         if network_tags:
66             network_tag = network_tags[0]
67             network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
68
69         # add slivers
70         sliver = {'name':sliver_urn,
71                   'pl_tags': attributes}
72         for hostname in hostnames:
73             if sliver_urn:
74                 sliver['name'] = sliver_urn
75             node_elems = self.get_nodes({'component_id': '*%s*' % hostname})
76             if not node_elems:
77                 continue
78             node_elem = node_elems[0]
79             SFAv1Sliver.add_slivers(node_elem.element, sliver)
80
81         # remove all nodes without slivers
82         if not append:
83             for node_elem in self.get_nodes():
84                 if not node_elem['slivers']:
85                     parent = node_elem.element.getparent()
86                     parent.remove(node_elem.element)
87
88
89     def remove_slivers(self, slivers, network=None, no_dupes=False):
90         SFAv1Node.remove_slivers(self.xml, slivers)
91  
92     def get_slice_attributes(self, network=None):
93         attributes = []
94         nodes_with_slivers = self.get_nodes_with_slivers()
95         for default_attribute in self.get_default_sliver_attributes(network):
96             attribute = default_attribute.copy()
97             attribute['node_id'] = None
98             attributes.append(attribute)
99         for node in nodes_with_slivers:
100             nodename=node['component_name']
101             sliver_attributes = self.get_sliver_attributes(nodename, network)
102             for sliver_attribute in sliver_attributes:
103                 sliver_attribute['node_id'] = nodename
104                 attributes.append(sliver_attribute)
105         return attributes
106
107
108     def add_sliver_attribute(self, component_id, name, value, network=None):
109         nodes = self.get_nodes({'component_id': '*%s*' % component_id})
110         if nodes is not None and isinstance(nodes, list) and len(nodes) > 0:
111             node = nodes[0]
112             slivers = SFAv1Sliver.get_slivers(node)
113             if slivers:
114                 sliver = slivers[0]
115                 SFAv1Sliver.add_sliver_attribute(sliver, name, value)
116         else:
117             # should this be an assert / raise an exception?
118             logger.error("WARNING: failed to find component_id %s" % component_id)
119
120     def get_sliver_attributes(self, component_id, network=None):
121         nodes = self.get_nodes({'component_id': '*%s*' % component_id})
122         attribs = []
123         if nodes is not None and isinstance(nodes, list) and len(nodes) > 0:
124             node = nodes[0]
125             slivers = SFAv1Sliver.get_slivers(node.element)
126             if slivers is not None and isinstance(slivers, list) and len(slivers) > 0:
127                 sliver = slivers[0]
128                 attribs = SFAv1Sliver.get_sliver_attributes(sliver.element)
129         return attribs
130
131     def remove_sliver_attribute(self, component_id, name, value, network=None):
132         attribs = self.get_sliver_attributes(component_id)
133         for attrib in attribs:
134             if attrib['name'] == name and attrib['value'] == value:
135                 #attrib.element.delete()
136                 parent = attrib.element.getparent()
137                 parent.remove(attrib.element)
138
139     def add_default_sliver_attribute(self, name, value, network=None):
140         if network:
141             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
142         else:
143             defaults = self.xml.xpath("//sliver_defaults")
144         if not defaults:
145             if network:
146                 network_tag = self.xml.xpath("//network[@name='%s']" % network)
147             else:
148                 network_tag = self.xml.xpath("//network")    
149             if isinstance(network_tag, list):
150                 network_tag = network_tag[0]
151             defaults = network_tag.add_element('sliver_defaults')
152         elif isinstance(defaults, list):
153             defaults = defaults[0]
154         SFAv1Sliver.add_sliver_attribute(defaults, name, value)
155
156     def get_default_sliver_attributes(self, network=None):
157         if network:
158             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
159         else:
160             defaults = self.xml.xpath("//sliver_defaults")
161         if not defaults: return []
162         return SFAv1Sliver.get_sliver_attributes(defaults[0])
163     
164     def remove_default_sliver_attribute(self, name, value, network=None):
165         attribs = self.get_default_sliver_attributes(network)
166         for attrib in attribs:
167             if attrib['name'] == name and attrib['value'] == value:
168                 #attrib.element.delete()
169                 parent = attrib.element.getparent()
170                 parent.remove(attrib.element)
171
172     # Links
173
174     def get_links(self, network=None):
175         return PGv2Link.get_links(self.xml)
176
177     def get_link_requests(self):
178         return PGv2Link.get_link_requests(self.xml) 
179
180     def add_links(self, links):
181         networks = self.get_networks()
182         if len(networks) > 0:
183             xml = networks[0].element
184         else:
185             xml = self.xml
186         PGv2Link.add_links(xml, links)
187
188     def add_link_requests(self, links):
189         PGv2Link.add_link_requests(self.xml, links)
190
191     # utility
192
193     def merge(self, in_rspec):
194         """
195         Merge contents for specified rspec with current rspec
196         """
197
198         if not in_rspec:
199             return
200
201         from sfa.rspecs.rspec import RSpec
202         if isinstance(in_rspec, RSpec):
203             rspec = in_rspec
204         else:
205             rspec = RSpec(in_rspec)
206         if rspec.version.type.lower() == 'protogeni':
207             from sfa.rspecs.rspec_converter import RSpecConverter
208             in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
209             rspec = RSpec(in_rspec)
210
211         # just copy over all networks
212         current_networks = self.get_networks()
213         networks = rspec.version.get_networks()
214         for network in networks:
215             current_network = network.get('name')
216             if current_network and current_network not in current_networks:
217                 self.xml.append(network.element)
218                 current_networks.append(current_network)
219
220     # Leases
221
222     def get_leases(self, filter=None):
223         return SFAv1Lease.get_leases(self.xml, filter)
224
225     def add_leases(self, leases, network = None, no_dupes=False):
226         SFAv1Lease.add_leases(self.xml, leases)
227
228     # Spectrum
229
230     def get_channels(self, filter=None):
231         return []
232
233     def add_channels(self, channels, network = None, no_dupes=False):
234         pass
235
236 if __name__ == '__main__':
237     from sfa.rspecs.rspec import RSpec
238     from sfa.rspecs.rspec_elements import *
239     r = RSpec('/tmp/resources.rspec')
240     r.load_rspec_elements(SFAv1.elements)
241     print r.get(RSpecElements.NODE)