graphical information added to boxes and testbed descriptions
[nepi.git] / src / nepi / util / parser / _xml.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 from nepi.core.attributes import Attribute
5 from nepi.util.parser.base import ExperimentData, ExperimentParser
6 from xml.dom import minidom
7
8 class XmlExperimentParser(ExperimentParser):
9     def to_xml(self, experiment_description):
10         data = self.to_data(experiment_description)
11         doc = minidom.Document()        
12         exp_tag = doc.createElement("experiment")
13         testbeds_tag = doc.createElement("testbeds")
14         exp_tag.appendChild(testbeds_tag)
15
16         elements_tags = dict()
17         for guid in data.guids:
18             if data.is_testbed_data(guid):
19                 elements_tag = self.testbed_data_to_xml(doc, testbeds_tag, guid, data)
20                 elements_tags[guid] = elements_tag
21             else:
22                 self.box_data_to_xml(doc, elements_tags, guid, data)
23         doc.appendChild(exp_tag)
24         xml = doc.toprettyxml(indent="    ", encoding="UTF-8")
25         return xml
26
27     def testbed_data_to_xml(self, doc, parent_tag, guid, data):
28         testbed_tag = doc.createElement("testbed") 
29         testbed_tag.setAttribute("guid", str(guid))
30         (testbed_id, testbed_version) = data.get_testbed_data(guid)
31         testbed_tag.setAttribute("testbed_id", str(testbed_id))
32         testbed_tag.setAttribute("testbed_version", str(testbed_version))
33         parent_tag.appendChild(testbed_tag)
34         self.graphical_info_data_to_xml(doc, testbed_tag, guid, data)
35         self.attributes_data_to_xml(doc, testbed_tag, guid, data)
36         elements_tag = doc.createElement("elements")
37         testbed_tag.appendChild(elements_tag)
38         return elements_tag
39
40     def box_data_to_xml(self, doc, elements_tags, guid, data):
41         (testbed_guid, factory_id) = data.get_box_data(guid)
42         element_tag = doc.createElement("element")
43         parent_tag = elements_tags[testbed_guid]
44         parent_tag.appendChild(element_tag)
45         element_tag.setAttribute("factory_id", factory_id)
46         element_tag.setAttribute("guid", str(guid))
47         self.graphical_info_data_to_xml(doc, element_tag, guid, data)
48         self.factory_attributes_data_to_xml(doc, element_tag, guid, data)
49         self.attributes_data_to_xml(doc, element_tag, guid, data)
50         self.traces_data_to_xml(doc, element_tag, guid, data)
51         self.addresses_data_to_xml(doc, element_tag, guid, data)
52         self.routes_data_to_xml(doc, element_tag, guid, data)
53         self.connections_data_to_xml(doc, element_tag, guid, data)
54
55     def graphical_info_data_to_xml(self, doc, parent_tag, guid, data):
56         graphical_info_tag = doc.createElement("graphical_info") 
57         parent_tag.appendChild(graphical_info_tag)
58         (x, y, width, height, label) = data.get_graphical_info_data(guid)
59         graphical_info_tag.setAttribute("x", str(x))
60         graphical_info_tag.setAttribute("y", str(y))
61         graphical_info_tag.setAttribute("width", str(width))
62         graphical_info_tag.setAttribute("height", str(height))
63         graphical_info_tag.setAttribute("label", str(label))
64
65     def factory_attributes_data_to_xml(self, doc, parent_tag, guid, data):
66         factory_attributes_tag = doc.createElement("factory_attributes")
67         parent_tag.appendChild(factory_attributes_tag)
68         for (name, value) in data.get_factory_attribute_data(guid):
69             factory_attribute_tag = doc.createElement("factory_attribute") 
70             factory_attributes_tag.appendChild(factory_attribute_tag)
71             factory_attribute_tag.setAttribute("name", name)
72             factory_attribute_tag.setAttribute("value", str(value))
73             factory_attribute_tag.setAttribute("type", self.type_to_standard(value))
74
75     def attributes_data_to_xml(self, doc, parent_tag, guid, data):
76         attributes_tag = doc.createElement("attributes") 
77         parent_tag.appendChild(attributes_tag)
78         for name, value in data.get_attribute_data(guid):
79             attribute_tag = doc.createElement("attribute") 
80             attributes_tag.appendChild(attribute_tag)
81             attribute_tag.setAttribute("name", name)
82             attribute_tag.setAttribute("value", str(value))
83             attribute_tag.setAttribute("type", self.type_to_standard(value))
84
85     def traces_data_to_xml(self, doc, parent_tag, guid, data):
86         traces_tag = doc.createElement("traces") 
87         parent_tag.appendChild(traces_tag)
88         for name in data.get_trace_data(guid):
89             trace_tag = doc.createElement("trace") 
90             traces_tag.appendChild(trace_tag)
91             trace_tag.setAttribute("name", name)
92
93     def addresses_data_to_xml(self, doc, parent_tag, guid, data):
94         addresses_tag = doc.createElement("addresses") 
95         parent_tag.appendChild(addresses_tag)
96         for (autoconfigure, address, family, netprefix, broadcast) \
97                 in data.get_address_data(guid):
98             address_tag = doc.createElement("address") 
99             addresses_tag.appendChild(address_tag)
100             if autoconfigure:
101                 address_tag.setAttribute("AutoConfigure", str(autoconf))
102             if address:
103                 address_tag.setAttribute("Address", str(address))
104             if family:
105                 address_tag.setAttribute("Family", str(family))
106             if netprefix:
107                 address_tag.setAttribute("NetPrefix", str(netprefix))
108             if broadcast:
109                 address_tag.setAttribute("Broadcast", str(broadcast))
110
111     def routes_data_to_xml(self, doc, parent_tag, guid, data):
112         routes_tag = doc.createElement("routes") 
113         parent_tag.appendChild(routes_tag)
114         for (family, destination, netprefix, nexthop, interface) \
115                 in data.get_route_data(guid):
116             route_tag = doc.createElement("route") 
117             routes_tag.appendChild(route_tag)
118             route_tag.setAttribute("Family", str(family))
119             route_tag.setAttribute("Destination", str(destination))
120             route_tag.setAttribute("NetPrefix", str(netprefix))
121             route_tag.setAttribute("NextHop", str(nexthop))
122             route_tag.setAttribute("Interface", str(interface))
123
124     def connections_data_to_xml(self, doc, parent_tag, guid, data):
125         connections_tag = doc.createElement("connections") 
126         parent_tag.appendChild(connections_tag)
127         for (connector_type_name, other_guid, other_connector_type_name) \
128                 in data.get_connection_data(guid):
129                 connection_tag = doc.createElement("connection") 
130                 connections_tag.appendChild(connection_tag)
131                 connection_tag.setAttribute("connector", connector_type_name)
132                 connection_tag.setAttribute("other_guid", str(other_guid))
133                 connection_tag.setAttribute("other_connector",
134                         other_connector_type_name)
135
136     def from_xml(self, experiment_description, xml):
137         data = ExperimentData()
138         doc = minidom.parseString(xml)
139         testbeds_tag = doc.getElementsByTagName("testbeds")[0] 
140         testbed_tag_list = testbeds_tag.getElementsByTagName("testbed")
141         for testbed_tag in testbed_tag_list:
142             if testbed_tag.nodeType == doc.ELEMENT_NODE:
143                 testbed_guid = int(testbed_tag.getAttribute("guid"))
144                 self.testbed_data_from_xml(testbed_tag, data)
145                 elements_tag = testbed_tag.getElementsByTagName("elements")[0] 
146                 element_tag_list = elements_tag.getElementsByTagName("element")
147                 for element_tag in element_tag_list:
148                     if element_tag.nodeType == doc.ELEMENT_NODE:
149                         self.box_data_from_xml(element_tag, testbed_guid, data)
150         self.from_data(experiment_description, data)
151
152     def testbed_data_from_xml(self, tag, data):
153         testbed_guid = int(tag.getAttribute("guid"))
154         testbed_id = str(tag.getAttribute("testbed_id"))
155         testbed_version = str(tag.getAttribute("testbed_version"))
156         data.add_testbed_data(testbed_guid, testbed_id, testbed_version)
157         self.graphical_info_data_from_xml(tag, testbed_guid, data)
158         self.attributes_data_from_xml(tag, testbed_guid, data)
159
160     def box_data_from_xml(self, tag, testbed_guid, data):
161         guid = int(tag.getAttribute("guid"))
162         factory_id = str(tag.getAttribute("factory_id"))
163         data.add_box_data(guid, testbed_guid, factory_id)
164         self.graphical_info_data_from_xml(tag, guid, data)
165         self.factory_attributes_data_from_xml(tag, guid, data)
166         self.attributes_data_from_xml(tag, guid, data)
167         self.traces_data_from_xml(tag, guid, data)
168         self.addresses_data_from_xml(tag, guid, data)
169         self.routes_data_from_xml(tag, guid, data)
170         self.connections_data_from_xml(tag, guid, data)
171
172     def graphical_info_data_from_xml(self, tag, guid, data):
173         graphical_info_tag_list = tag.getElementsByTagName(
174                 "graphical_info")
175         if len(graphical_info_tag_list) == 0:
176             return
177
178         graphical_info_tag = graphical_info_tag_list[0]
179         if graphical_info_tag.nodeType == tag.ELEMENT_NODE:
180             x = int(graphical_info_tag.getAttribute("x"))
181             y = int(graphical_info_tag.getAttribute("y"))
182             width = int(graphical_info_tag.getAttribute("width"))
183             height = int(graphical_info_tag.getAttribute("height"))
184             label = str(graphical_info_tag.getAttribute("label"))
185             data.add_graphical_info_data(guid, x, y, width, height, label)
186
187     def factory_attributes_data_from_xml(self, tag, guid, data):
188         factory_attributes_tag_list = tag.getElementsByTagName(
189                 "factory_attributes")
190         if len(factory_attributes_tag_list) == 0:
191             return
192
193         factory_attribute_tag_list = factory_attributes_tag_list[0].\
194                 getElementsByTagName("factory_attribute")
195         for factory_attribute_tag in factory_attribute_tag_list:
196              if factory_attribute_tag.nodeType == tag.ELEMENT_NODE:
197                 name = str(factory_attribute_tag.getAttribute("name"))
198                 value = factory_attribute_tag.getAttribute("value")
199                 std_type = factory_attribute_tag.getAttribute("type")
200                 value = self.type_from_standard(std_type, value)
201                 data.add_factory_attribute_data(guid, name, value)
202
203     def attributes_data_from_xml(self, tag, guid, data):
204         attributes_tag_list= tag.getElementsByTagName("attributes")
205         if len(attributes_tag_list) == 0:
206             return
207
208         attribute_tag_list = attributes_tag_list[0].\
209                 getElementsByTagName("attribute")
210         for attribute_tag in attribute_tag_list:
211              if attribute_tag.nodeType == tag.ELEMENT_NODE:
212                 name = str(attribute_tag.getAttribute("name"))
213                 value = attribute_tag.getAttribute("value")
214                 std_type = attribute_tag.getAttribute("type")
215                 value = self.type_from_standard(std_type, value)
216                 data.add_attribute_data(guid, name, value)
217
218     def traces_data_from_xml(self, tag, guid, data):
219         traces_tag_list = tag.getElementsByTagName("traces")
220         if len(traces_tag_list) == 0:
221             return
222
223         trace_tag_list = traces_tag_list[0].getElementsByTagName(
224                 "trace")
225         for trace_tag in trace_tag_list:
226              if trace_tag.nodeType == tag.ELEMENT_NODE:
227                 name = str(trace_tag.getAttribute("name"))
228                 data.add_trace_data(guid, name)
229
230     def addresses_data_from_xml(self, tag, guid, data):
231         addresses_tag_list = tag.getElementsByTagName("addresses")
232         if len(addresses_tag_list) == 0:
233             return
234
235         address_tag_list = addresses_tag_list[0].\
236                 getElementsByTagName("address")
237         for address_tag in address_tag_list:
238             if address_tag.nodeType == tag.ELEMENT_NODE:
239                 autoconf = bool(address_tag.getAttribute("AutoConfigure")) \
240                        if address_tag.hasAttribute("AutoConfigure") else None
241                 address = str(address_tag.getAttribute("Address")) \
242                        if address_tag.hasAttribute("Address") else None
243                 family = int(address_tag.getAttribute("Family")) \
244                        if address_tag.hasAttribute("Family") else None
245                 netprefix = int(address_tag.getAttribute("NetPrefix")) \
246                        if address_tag.hasAttribute("NetPrefix") else None
247                 broadcast = str(address_tag.getAttribute("Broadcast")) \
248                        if address_tag.hasAttribute("Broadcast") else None
249                 data.add_address_data(guid, autoconf, address, family, 
250                     netprefix, broadcast)
251
252     def routes_data_from_xml(self, tag, guid, data):
253         routes_tag_list = tag.getElementsByTagName("routes")
254         if len(routes_tag_list) == 0:
255             return
256
257         route_tag_list = routes_tag_list[0].getElementsByTagName("route")
258         for route_tag in route_tag_list:
259             if route_tag.nodeType == tag.ELEMENT_NODE:
260                 family = int(route_tag.getAttribute("Family"))
261                 destination = str(route_tag.getAttribute("Destination"))
262                 netprefix = int(route_tag.getAttribute("NetPrefix"))
263                 nexthop = str(route_tag.getAttribute("NextHop"))
264                 interface = str(route_tag.getAttribute("Interface"))
265                 data.add_route_data(guid, family, destination, netprefix, 
266                         nexthop, interface)
267
268     def connections_data_from_xml(self, tag, guid, data):
269         connections_tag_list = tag.getElementsByTagName("connections")
270         if len(connections_tag_list) == 0:
271             return
272
273         connection_tag_list = connections_tag_list[0].getElementsByTagName(
274                 "connection")
275         for connection_tag in connection_tag_list:
276              if connection_tag.nodeType == tag.ELEMENT_NODE:
277                  connector_type_name = str(connection_tag.getAttribute(
278                      "connector"))
279                  other_connector_type_name = str(connection_tag.getAttribute(
280                          "other_connector"))
281                  other_guid = int(connection_tag.getAttribute("other_guid"))
282                  data.add_connection_data(guid, connector_type_name, 
283                          other_guid, other_connector_type_name)
284
285     def type_to_standard(self, value):
286         if type(value) == str:
287             return Attribute.STRING
288         if type(value) == bool:
289             return Attribute.BOOL
290         if type(value) == int:
291             return Attribute.INTEGER
292         if type(value) == float:
293             return Attribute.DOUBLE
294     
295     def type_from_standard(self, type, value):
296         if type == Attribute.STRING:
297             return str(value)
298         if type == Attribute.BOOL:
299             return bool(value)
300         if type == Attribute.INTEGER:
301             return int(value)
302         if type == Attribute.DOUBLE:
303             return float(value)
304