|
1
|
|
|
""" |
|
2
|
|
|
from a list of nodes in the address space, build an XML file |
|
3
|
|
|
format is the one from opc-ua specification |
|
4
|
|
|
""" |
|
5
|
|
|
import logging |
|
6
|
|
|
from collections import OrderedDict |
|
7
|
|
|
import xml.etree.ElementTree as Et |
|
8
|
|
|
from xml.dom import minidom |
|
9
|
|
|
|
|
10
|
|
|
from opcua import ua |
|
11
|
|
|
from opcua.ua import object_ids as o_ids |
|
12
|
|
|
|
|
13
|
|
|
|
|
14
|
|
|
class XmlExporter(object): |
|
15
|
|
|
|
|
16
|
|
|
def __init__(self, server): |
|
17
|
|
|
self.logger = logging.getLogger(__name__) |
|
18
|
|
|
self.server = server |
|
19
|
|
|
self.aliases = {} |
|
20
|
|
|
|
|
21
|
|
|
node_set_attributes = OrderedDict() |
|
22
|
|
|
node_set_attributes['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance' |
|
23
|
|
|
node_set_attributes['xmlns:uax'] = 'http://opcfoundation.org/UA/2008/02/Types.xsd' |
|
24
|
|
|
node_set_attributes['xmlns:xsd'] = 'http://www.w3.org/2001/XMLSchema' |
|
25
|
|
|
node_set_attributes['xmlns'] = 'http://opcfoundation.org/UA/2011/03/UANodeSet.xsd' |
|
26
|
|
|
|
|
27
|
|
|
self.etree = Et.ElementTree(Et.Element('UANodeSet', node_set_attributes)) |
|
28
|
|
|
|
|
29
|
|
|
def build_etree(self, node_list, uris=None): |
|
30
|
|
|
""" |
|
31
|
|
|
Create an XML etree object from a list of nodes; custom namespace uris are optional |
|
32
|
|
|
Args: |
|
33
|
|
|
node_list: list of Node objects for export |
|
34
|
|
|
uris: list of namespace uri strings |
|
35
|
|
|
|
|
36
|
|
|
Returns: |
|
37
|
|
|
""" |
|
38
|
|
|
self.logger.info('Building XML etree') |
|
39
|
|
|
|
|
40
|
|
|
# add all nodes in the list to the XML etree |
|
41
|
|
|
for node in node_list: |
|
42
|
|
|
self.node_to_etree(node) |
|
43
|
|
|
|
|
44
|
|
|
# add all required aliases to the XML etree; must be done after nodes are added |
|
45
|
|
|
self._add_alias_els() |
|
46
|
|
|
|
|
47
|
|
|
if uris: |
|
48
|
|
|
# add all namespace uris to the XML etree; must be done after aliases are added |
|
49
|
|
|
self._add_namespace_uri_els(uris) |
|
50
|
|
|
|
|
51
|
|
|
def write_xml(self, xmlpath, pretty=True): |
|
52
|
|
|
""" |
|
53
|
|
|
Write the XML etree in the exporter object to a file |
|
54
|
|
|
Args: |
|
55
|
|
|
xmlpath: string representing the path/file name |
|
56
|
|
|
|
|
57
|
|
|
Returns: |
|
58
|
|
|
""" |
|
59
|
|
|
# try to write the XML etree to a file |
|
60
|
|
|
self.logger.info('Exporting XML file to %s', xmlpath) |
|
61
|
|
|
#from IPython import embed |
|
62
|
|
|
#embed() |
|
63
|
|
|
if pretty: |
|
64
|
|
|
self.etree.write(xmlpath + "-not-pretty.xml", short_empty_elements=False) |
|
65
|
|
|
rough_string = Et.tostring(self.etree.getroot(), 'utf-8') |
|
66
|
|
|
reparsed = minidom.parseString(rough_string) |
|
67
|
|
|
pretty_string = reparsed.toprettyxml(indent=" ") |
|
68
|
|
|
with open(xmlpath, "wt") as f: |
|
69
|
|
|
f.write(pretty_string) |
|
70
|
|
|
else: |
|
71
|
|
|
self.etree.write(xmlpath, short_empty_elements=False) |
|
72
|
|
|
|
|
73
|
|
|
def dump_etree(self): |
|
74
|
|
|
""" |
|
75
|
|
|
Dump etree to console for debugging |
|
76
|
|
|
Returns: |
|
77
|
|
|
""" |
|
78
|
|
|
self.logger.info('Dumping XML etree to console') |
|
79
|
|
|
Et.dump(self.etree) |
|
80
|
|
|
|
|
81
|
|
|
def node_to_etree(self, node): |
|
82
|
|
|
""" |
|
83
|
|
|
Add the necessary XML sub elements to the etree for exporting the node |
|
84
|
|
|
Args: |
|
85
|
|
|
node: Node object which will be added to XML etree |
|
86
|
|
|
|
|
87
|
|
|
Returns: |
|
88
|
|
|
""" |
|
89
|
|
|
node_class = node.get_node_class() |
|
90
|
|
|
print("Exporting: ", node) |
|
91
|
|
|
|
|
92
|
|
|
if node_class is ua.NodeClass.Object: |
|
93
|
|
|
self.add_etree_object(node) |
|
94
|
|
|
elif node_class is ua.NodeClass.ObjectType: |
|
95
|
|
|
self.add_etree_object_type(node) |
|
96
|
|
|
elif node_class is ua.NodeClass.Variable: |
|
97
|
|
|
self.add_etree_variable(node) |
|
98
|
|
|
elif node_class is ua.NodeClass.VariableType: |
|
99
|
|
|
self.add_etree_variable_type(node) |
|
100
|
|
|
elif node_class is ua.NodeClass.ReferenceType: |
|
101
|
|
|
self.add_etree_reference(node) |
|
102
|
|
|
elif node_class is ua.NodeClass.DataType: |
|
103
|
|
|
self.add_etree_datatype(node) |
|
104
|
|
|
elif node_class is ua.NodeClass.Method: |
|
105
|
|
|
self.add_etree_method(node) |
|
106
|
|
|
else: |
|
107
|
|
|
self.logger.info("Exporting node class not implemented: %s ", node_class) |
|
108
|
|
|
|
|
109
|
|
|
def _add_node_common(self, nodetype, node): |
|
110
|
|
|
browsename = node.get_browse_name().to_string() |
|
111
|
|
|
nodeid = node.nodeid.to_string() |
|
112
|
|
|
parent = node.get_parent() |
|
113
|
|
|
displayname = node.get_display_name().Text.decode(encoding='UTF8') |
|
114
|
|
|
desc = node.get_description().Text |
|
115
|
|
|
if desc is None: |
|
116
|
|
|
desc = "" |
|
117
|
|
|
print("NODE COMMON", node, desc) |
|
118
|
|
|
node_el = Et.SubElement(self.etree.getroot(), |
|
119
|
|
|
nodetype, |
|
120
|
|
|
BrowseName=browsename, |
|
121
|
|
|
NodeId=nodeid) |
|
122
|
|
|
if parent is not None: |
|
123
|
|
|
node_el.attrib["ParentNodeId"] = parent.nodeid.to_string() |
|
124
|
|
|
if desc not in (None, ""): |
|
125
|
|
|
node_el.attrib["Description"] = desc |
|
126
|
|
|
disp_el = Et.SubElement(node_el, 'DisplayName', ) |
|
127
|
|
|
disp_el.text = displayname |
|
128
|
|
|
return node_el |
|
129
|
|
|
|
|
130
|
|
|
def add_etree_object(self, obj): |
|
131
|
|
|
""" |
|
132
|
|
|
Add a UA object element to the XML etree |
|
133
|
|
|
""" |
|
134
|
|
|
obj_el = self._add_node_common("UAObject", obj) |
|
135
|
|
|
self._add_ref_els(obj_el, obj) |
|
136
|
|
|
|
|
137
|
|
|
def add_etree_object_type(self, node): |
|
138
|
|
|
""" |
|
139
|
|
|
Add a UA object type element to the XML etree |
|
140
|
|
|
""" |
|
141
|
|
|
obj_el = self._add_node_common("UAObjectType", node) |
|
142
|
|
|
abstract = node.get_attribute(ua.AttributeIds.IsAbstract).Value.Value |
|
143
|
|
|
obj_el.attrib["IsAbstract"] = abstract |
|
144
|
|
|
self._add_ref_els(obj_el, node) |
|
145
|
|
|
|
|
146
|
|
|
def add_variable_common(self, node, el): |
|
147
|
|
|
dtype = node.get_data_type() |
|
148
|
|
|
if dtype.Identifier in o_ids.ObjectIdNames: |
|
149
|
|
|
datatype = o_ids.ObjectIdNames[dtype.Identifier] |
|
150
|
|
|
self.aliases[datatype] = dtype.to_string() |
|
151
|
|
|
else: |
|
152
|
|
|
datatype = dtype.to_string() |
|
153
|
|
|
rank = node.get_value_rank() |
|
154
|
|
|
el.attrib["DataType"] = datatype |
|
155
|
|
|
el.attrib["ValueRank"] = str(rank) |
|
156
|
|
|
variant_to_etree(el, node.get_data_value().Value) |
|
157
|
|
|
|
|
158
|
|
|
def add_etree_variable(self, node): |
|
159
|
|
|
""" |
|
160
|
|
|
Add a UA variable element to the XML etree |
|
161
|
|
|
""" |
|
162
|
|
|
var_el = self._add_node_common("UAVariable", node) |
|
163
|
|
|
self.add_variable_common(node, var_el) |
|
164
|
|
|
|
|
165
|
|
|
accesslevel = node.get_attribute(ua.AttributeIds.AccessLevel).Value.Value |
|
166
|
|
|
useraccesslevel = node.get_attribute(ua.AttributeIds.UserAccessLevel).Value.Value |
|
167
|
|
|
|
|
168
|
|
|
# We only write these values if they are different from defaults |
|
169
|
|
|
# default must of course mange the one in manage_nodes.py |
|
170
|
|
|
# and other OPC UA servers |
|
171
|
|
|
if accesslevel != ua.AccessLevel.CurrentRead.mask: |
|
172
|
|
|
var_el.attrib["AccessLevel"] = str(accesslevel) |
|
173
|
|
|
if useraccesslevel != ua.AccessLevel.CurrentRead.mask: |
|
174
|
|
|
var_el.attrib["UserAccessLevel"] = str(useraccesslevel) |
|
175
|
|
|
self._add_ref_els(var_el, node) |
|
176
|
|
|
|
|
177
|
|
|
def add_etree_variable_type(self, node): |
|
178
|
|
|
""" |
|
179
|
|
|
Add a UA variable type element to the XML etree |
|
180
|
|
|
""" |
|
181
|
|
|
|
|
182
|
|
|
var_el = self._add_node_common("UAVariable", node) |
|
183
|
|
|
self.add_variable_common(node, var_el) |
|
184
|
|
|
|
|
185
|
|
|
abstract = node.get_attribute(ua.AttributeIds.IsAbstract) |
|
186
|
|
|
var_el.attrib["IsAbstract"] = abstract |
|
187
|
|
|
|
|
188
|
|
|
self._add_ref_els(var_el, node) |
|
189
|
|
|
|
|
190
|
|
|
def add_etree_method(self, obj): |
|
191
|
|
|
obj_el = self._add_node_common("UAMethod", obj) |
|
192
|
|
|
self._add_ref_els(obj_el, obj) |
|
193
|
|
|
|
|
194
|
|
|
def add_etree_reference(self, obj): |
|
195
|
|
|
obj_el = self._add_node_common("UAReference", obj) |
|
196
|
|
|
self._add_ref_els(obj_el, obj) |
|
197
|
|
|
|
|
198
|
|
|
def add_etree_datatype(self, obj): |
|
199
|
|
|
""" |
|
200
|
|
|
Add a UA data type element to the XML etree |
|
201
|
|
|
""" |
|
202
|
|
|
obj_el = self._add_node_common("UADataType", obj) |
|
203
|
|
|
self._add_ref_els(obj_el, obj) |
|
204
|
|
|
|
|
205
|
|
|
def _add_namespace_uri_els(self, uris): |
|
206
|
|
|
nuris_el = Et.Element('NamespaceUris') |
|
207
|
|
|
|
|
208
|
|
|
for uri in uris: |
|
209
|
|
|
uri_el = Et.SubElement(nuris_el, 'Uri') |
|
210
|
|
|
uri_el.text = uri |
|
211
|
|
|
|
|
212
|
|
|
self.etree.getroot().insert(0, nuris_el) |
|
213
|
|
|
|
|
214
|
|
|
def _add_alias_els(self): |
|
215
|
|
|
aliases_el = Et.Element('Aliases') |
|
216
|
|
|
|
|
217
|
|
|
for k, v in self.aliases.items(): |
|
218
|
|
|
ref_el = Et.SubElement(aliases_el, 'Alias', Alias=k) |
|
219
|
|
|
ref_el.text = v |
|
220
|
|
|
|
|
221
|
|
|
self.etree.getroot().insert(0, aliases_el) |
|
222
|
|
|
|
|
223
|
|
|
def _add_ref_els(self, parent_el, obj): |
|
224
|
|
|
refs = obj.get_references() |
|
225
|
|
|
refs_el = Et.SubElement(parent_el, 'References') |
|
226
|
|
|
|
|
227
|
|
|
for ref in refs: |
|
228
|
|
|
if ref.ReferenceTypeId.Identifier in o_ids.ObjectIdNames: |
|
229
|
|
|
ref_name = o_ids.ObjectIdNames[ref.ReferenceTypeId.Identifier] |
|
230
|
|
|
else: |
|
231
|
|
|
ref_name = ref.ReferenceTypeId.to_string() |
|
232
|
|
|
ref_forward = str(ref.IsForward).lower() |
|
233
|
|
|
ref_nodeid = ref.NodeId.to_string() |
|
234
|
|
|
ref_el = Et.SubElement(refs_el, 'Reference', IsForward=ref_forward, ReferenceType=ref_name) |
|
235
|
|
|
ref_el.text = ref_nodeid |
|
236
|
|
|
|
|
237
|
|
|
# add any references that gets used to aliases dict; this gets handled later |
|
238
|
|
|
self.aliases[ref_name] = ref_nodeid |
|
239
|
|
|
|
|
240
|
|
|
|
|
241
|
|
|
def variant_to_etree(el, var): |
|
242
|
|
|
val_el = Et.SubElement(el, 'Value') |
|
243
|
|
|
valx_el = Et.SubElement(val_el, var.VariantType.name) |
|
244
|
|
|
valx_el.attrib["xmnls"] = "http://opcfoundation.org/UA/2008/02/Types.xsd" |
|
245
|
|
|
valx_el.text = str(var.Value) |
|
246
|
|
|
|
|
247
|
|
|
|
|
248
|
|
|
|
FreeOpcUa /
python-opcua
