Completed
Pull Request — master (#327)
by Olivier
03:38
created

XmlImporter.import_xml()   F

Complexity

Conditions 9

Size

Total Lines 37

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 20
CRAP Score 12.6176

Importance

Changes 3
Bugs 1 Features 0
Metric Value
cc 9
dl 0
loc 37
ccs 20
cts 31
cp 0.6452
crap 12.6176
rs 3
c 3
b 1
f 0
1
"""G
2
add node defined in XML to address space
3
format is the one from opc-ua specification
4
"""
5 1
import logging
6
import sys
7
8 1
from opcua import ua
9 1
from opcua.common import xmlparser
10
11
12 1
def to_python(val, obj, attname):
13
    if isinstance(obj, ua.NodeId) and attname == "Identifier":
14 1
        raise RuntimeError("Error we should parse a NodeId here")
15 1
        return ua.NodeId.from_string(val)
16 1
    else:
17 1
        return xmlparser.ua_type_to_python(val, obj.ua_types[attname])
18
19 1
20 1
class XmlImporter(object):
21 1
22 1
    def __init__(self, server):
23 1
        self.logger = logging.getLogger(__name__)
24 1
        self.parser = None
25 1
        self.server = server
26
        self.namespaces = {}
27 1
        self.aliases = {}
28 1
29
    def _map_namespaces(self, namespaces_uris):
30
        """
31
        creates a mapping between the namespaces in the xml file and in the server.
32
        if not present the namespace is registered.
33
        """
34
        print("original ns", self.server.get_namespace_array())
35
        print("xml ns", namespaces_uris)
36
        namespaces = {}
37
        for ns_index, ns_uri in enumerate(namespaces_uris):
38
            ns_server_index = self.server.register_namespace(ns_uri)
39
            namespaces[ns_index + 1] = (ns_server_index, ns_uri)
40 1
        print("new ns", self.server.get_namespace_array())
41 1
        print(namespaces)
42 1
        return namespaces
43 1
44 1
    def _map_aliases(self, aliases):
45 1
        """
46 1
        maps the import aliases to the correct namespaces        
47 1
        """
48 1
        aliases_mapped = {}
49 1
        for alias, node_id in aliases.items():
50 1
            aliases_mapped[alias] = self._migrate_ns(self.to_nodeid(node_id))
51 1
        return aliases_mapped
52
53 1
    def import_xml(self, xmlpath):
54 1
        """
55
        import xml and return added nodes
56 1
        """
57
        self.logger.info("Importing XML file %s", xmlpath)
58
        self.parser = xmlparser.XMLParser(xmlpath)
59 1
60
        dnodes = self.parser.get_node_datas()
61 1
        dnodes = self.make_objects(dnodes)
62 1
63 1
        self.namespaces = self._map_namespaces(self.parser.get_used_namespaces())
64
        self.aliases = self._map_aliases(self.parser.get_aliases())
65
66 1
        nodes_parsed = self._sort_nodes_by_parentid(dnodes)
67
68 1
        nodes = []
69
        for nodedata in nodes_parsed:  # self.parser:
70 1
            if nodedata.nodetype == 'UAObject':
71 1
                node = self.add_object(nodedata)
72 1
            elif nodedata.nodetype == 'UAObjectType':
73 1
                node = self.add_object_type(nodedata)
74 1
            elif nodedata.nodetype == 'UAVariable':
75 1
                node = self.add_variable(nodedata)
76 1
            elif nodedata.nodetype == 'UAVariableType':
77 1
                node = self.add_variable_type(nodedata)
78 1
            elif nodedata.nodetype == 'UAReferenceType':
79 1
                node = self.add_reference_type(nodedata)
80
            elif nodedata.nodetype == 'UADataType':
81 1
                node = self.add_datatype(nodedata)
82
            elif nodedata.nodetype == 'UAMethod':
83
                node = self.add_method(nodedata)
84
            else:
85
                self.logger.warning("Not implemented node type: %s ", nodedata.nodetype)
86
                continue
87
            print("ADDED", node)
88
            nodes.append(node)
89
        return nodes
90
    
91
    def make_objects(self, node_datas):
92 1
        new_nodes = []
93 1
        for ndata in node_datas:
94 1
            ndata.nodeid = ua.NodeId.from_string(ndata.nodeid)
95 1
            ndata.browsename = ua.QualifiedName.from_string(ndata.browsename)
96
            if ndata.parent:
97 1
                ndata.parent = ua.NodeId.from_string(ndata.parent)
98 1
            if ndata.parentlink:
99
                ndata.parentlink = self.to_nodeid(ndata.parentlink)
100 1
            if ndata.typedef:
101 1
                ndata.typedef = self.to_nodeid(ndata.typedef)
102 1
            new_nodes.append(ndata)
103 1
        return new_nodes
104 1
105
    def _migrate_ns(self, nodeid):
106 1
        """
107
        Check if the index of nodeid or browsename  given in the xml model file
108 1
        must be converted to a already existing namespace id based on the files
109
        namespace uri
110 1
111
        :returns: NodeId (str)
112 1
        """
113 1
        if nodeid.NamespaceIndex in self.namespaces:
114 1
            nodeid.NamespaceIndex = self.namespaces[nodeid.NamespaceIndex][0]
115
        return nodeid
116 1
117
    def _get_node(self, obj):
118
        node = ua.AddNodesItem()
119
        node.RequestedNewNodeId = self._migrate_ns(obj.nodeid)
120
        print("\nADDING", node.RequestedNewNodeId, node.RequestedNewNodeId.Identifier)
121
        node.BrowseName = self._migrate_ns(obj.browsename)
122
        node.NodeClass = getattr(ua.NodeClass, obj.nodetype[2:])
123
        if obj.parent:
124
            node.ParentNodeId = self._migrate_ns(obj.parent)
125
        if obj.parentlink:
126
            node.ReferenceTypeId = self._migrate_ns(obj.parentlink)
127
        if obj.typedef:
128
            node.TypeDefinition = self._migrate_ns(obj.typedef)
129
        return node
130
131
    def to_nodeid(self, nodeid):
132
        if isinstance(nodeid, ua.NodeId):
133
            return nodeid
134
        elif not nodeid:
135 1
            return ua.NodeId(ua.ObjectIds.String)
136
        elif "=" in nodeid:
137
            return ua.NodeId.from_string(nodeid)
138
        elif hasattr(ua.ObjectIds, nodeid):
139
            return ua.NodeId(getattr(ua.ObjectIds, nodeid))
140
        else:
141
            if nodeid in self.aliases:
142
                return self.aliases[nodeid]
143
            else:
144
                return ua.NodeId(getattr(ua.ObjectIds, nodeid))
145
146 View Code Duplication
    def add_object(self, obj):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
147
        node = self._get_node(obj)
148
        attrs = ua.ObjectAttributes()
149
        if obj.desc:
150
            attrs.Description = ua.LocalizedText(obj.desc)
151
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
152
        attrs.EventNotifier = obj.eventnotifier
153 1
        node.NodeAttributes = attrs
154
        res = self.server.iserver.isession.add_nodes([node])
155
        self._add_refs(obj)
156
        res[0].StatusCode.check()
157
        return res[0].AddedNodeId
158
159 View Code Duplication
    def add_object_type(self, obj):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
160
        node = self._get_node(obj)
161
        attrs = ua.ObjectTypeAttributes()
162
        if obj.desc:
163
            attrs.Description = ua.LocalizedText(obj.desc)
164
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
165
        attrs.IsAbstract = obj.abstract
166
        node.NodeAttributes = attrs
167
        res = self.server.iserver.isession.add_nodes([node])
168
        self._add_refs(obj)
169 1
        res[0].StatusCode.check()
170
        return res[0].AddedNodeId
171
172
    def add_variable(self, obj):
173
        node = self._get_node(obj)
174
        attrs = ua.VariableAttributes()
175
        if obj.desc:
176
            attrs.Description = ua.LocalizedText(obj.desc)
177
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
178
        attrs.DataType = self.to_nodeid(obj.datatype)
179
        print("VAL", obj.value)
180
        if obj.value is not None:
181 1
            attrs.Value = self._add_variable_value(obj,)
182 1
        if obj.rank:
183 1
            attrs.ValueRank = obj.rank
184
        if obj.accesslevel:
185
            attrs.AccessLevel = obj.accesslevel
186
        if obj.useraccesslevel:
187
            attrs.UserAccessLevel = obj.useraccesslevel
188
        if obj.minsample:
189
            attrs.MinimumSamplingInterval = obj.minsample
190
        if obj.dimensions:
191
            attrs.ArrayDimensions = obj.dimensions
192
        node.NodeAttributes = attrs
193
        res = self.server.iserver.isession.add_nodes([node])
194
        self._add_refs(obj)
195
        res[0].StatusCode.check()
196
        return res[0].AddedNodeId
197
198
    def _make_ext_obj(sefl, obj):
199
        ext = getattr(ua, obj.objname)()
200
        for name, val in obj.body:
201
            if type(val) is str:
202
                raise Exception("Error val should a dict", name, val)
203
            else:
204
                for attname, v in val:
205
                    # tow possible values:
206
                    # either we get value directly
207
                    # or a dict if it s an object or a list
208
                    if type(v) is str:
209
                        setattr(ext, attname, to_python(v, ext, attname))
210
                    else:
211
                        # so we habve either an object or a list...
212
                        obj2 = getattr(ext, attname)
213
                        if isinstance(obj2, ua.NodeId):
214
                            for attname2, v2 in v:
215
                                if attname2 == "Identifier":
216
                                    obj2 = ua.NodeId.from_string(v2)
217
                                    setattr(ext, attname, obj2)
218
                                    break
219
                        elif not isinstance(obj2, ua.NodeId) and not hasattr(obj2, "ua_types"):
220
                            # we probably have a list
221
                            my_list = []
222
                            for vtype, v2 in v:
223
                                my_list.append(xmlparser.ua_type_to_python(v2, vtype))
224
                            setattr(ext, attname, my_list)
225
                        else:
226
                            for attname2, v2 in v:
227
                                setattr(obj2, attname2, to_python(v2, obj2, attname2))
228
                            setattr(ext, attname, obj2)
229
        return ext
230
231
    def _add_variable_value(self, obj):
232
        """
233
        Returns the value for a Variable based on the objects valuetype. 
234
        """
235
        print("KKKKKKKKKKKKKKKKKK", obj, obj.valuetype)
236
        if obj.valuetype == 'ListOfExtensionObject':
237
            values = []
238
            for ext in obj.value:
239
                extobj = self._make_ext_obj(ext)
240
                values.append(extobj)
241
            return values
242
        elif obj.valuetype.startswith("ListOf"):
243
            vtype = obj.valuetype[6:]
244
            if hasattr(ua.ua_binary.Primitives, vtype):
245
                return ua.Variant(obj.value, getattr(ua.VariantType, vtype))
246
            else:
247
                return [getattr(ua, vtype)(v) for v in obj.value]
248
        elif obj.valuetype == 'ExtensionObject':
249
            extobj = self._make_ext_obj(obj.value)
250
            return ua.Variant(extobj, getattr(ua.VariantType, obj.valuetype))
251
        else:
252
            return ua.Variant(obj.value, getattr(ua.VariantType, obj.valuetype))
253
254 View Code Duplication
    def add_variable_type(self, obj):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
255
        node = self._get_node(obj)
256
        attrs = ua.VariableTypeAttributes()
257
        if obj.desc:
258
            attrs.Description = ua.LocalizedText(obj.desc)
259
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
260
        attrs.DataType = self.to_nodeid(obj.datatype)
261
        if obj.value and len(obj.value) == 1:
262
            attrs.Value = obj.value[0]
263
        if obj.rank:
264
            attrs.ValueRank = obj.rank
265
        if obj.abstract:
266
            attrs.IsAbstract = obj.abstract
267
        if obj.dimensions:
268
            attrs.ArrayDimensions = obj.dimensions
269
        node.NodeAttributes = attrs
270
        res = self.server.iserver.isession.add_nodes([node])
271
        self._add_refs(obj)
272
        res[0].StatusCode.check()
273
        return res[0].AddedNodeId
274
275 View Code Duplication
    def add_method(self, obj):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
276
        node = self._get_node(obj)
277
        attrs = ua.MethodAttributes()
278
        if obj.desc:
279
            attrs.Description = ua.LocalizedText(obj.desc)
280
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
281
        if obj.accesslevel:
282
            attrs.AccessLevel = obj.accesslevel
283
        if obj.useraccesslevel:
284
            attrs.UserAccessLevel = obj.useraccesslevel
285
        if obj.minsample:
286
            attrs.MinimumSamplingInterval = obj.minsample
287
        if obj.dimensions:
288
            attrs.ArrayDimensions = obj.dimensions
289
        node.NodeAttributes = attrs
290
        res = self.server.iserver.isession.add_nodes([node])
291
        self._add_refs(obj)
292
        res[0].StatusCode.check()
293
        return res[0].AddedNodeId
294
295
    def add_reference_type(self, obj):
296
        node = self._get_node(obj)
297
        attrs = ua.ReferenceTypeAttributes()
298
        if obj.desc:
299
            attrs.Description = ua.LocalizedText(obj.desc)
300
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
301
        if obj. inversename:
302
            attrs.InverseName = ua.LocalizedText(obj.inversename)
303
        if obj.abstract:
304
            attrs.IsAbstract = obj.abstract
305
        if obj.symmetric:
306
            attrs.Symmetric = obj.symmetric
307
        node.NodeAttributes = attrs
308
        res = self.server.iserver.isession.add_nodes([node])
309
        self._add_refs(obj)
310
        res[0].StatusCode.check()
311
        return res[0].AddedNodeId
312
313 View Code Duplication
    def add_datatype(self, obj):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
314
        node = self._get_node(obj)
315
        attrs = ua.DataTypeAttributes()
316
        if obj.desc:
317
            attrs.Description = ua.LocalizedText(obj.desc)
318
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
319
        if obj.abstract:
320
            attrs.IsAbstract = obj.abstract
321
        node.NodeAttributes = attrs
322
        res = self.server.iserver.isession.add_nodes([node])
323
        self._add_refs(obj)
324
        res[0].StatusCode.check()
325
        return res[0].AddedNodeId
326
327
    def _add_refs(self, obj):
328
        if not obj.refs:
329
            return
330
        refs = []
331
        for data in obj.refs:
332
            ref = ua.AddReferencesItem()
333
            ref.IsForward = True
334
            ref.ReferenceTypeId = self.to_nodeid(data.reftype)
335
            ref.SourceNodeId = self._migrate_ns(obj.nodeid)
336
            ref.TargetNodeClass = ua.NodeClass.DataType
337
            ref.TargetNodeId = self._migrate_ns(self.to_nodeid(data.target))
338
            refs.append(ref)
339
        self.server.iserver.isession.add_references(refs)
340
341
    def _sort_nodes_by_parentid(self, ndatas):
342
        """
343
        Sort the list of nodes according theire parent node in order to respect
344
        the depency between nodes.
345
346
        :param nodes: list of NodeDataObjects
347
        :returns: list of sorted nodes
348
        """
349
        _ndatas = list(ndatas)
350
        # list of node ids that are already sorted / inserted
351
        sorted_nodes_ids = []
352
        # list of sorted nodes (i.e. XML Elements)
353
        sorted_ndatas = []
354
        all_node_ids = [data.nodeid for data in ndatas]
355
        # list of namespace indexes that are relevant for this import
356
        # we can only respect ordering nodes for namespaces indexes that
357
        # are defined in the xml file itself. Thus we assume that all other
358
        # references namespaces are already known to the server and should
359
        # not create any dependency problems (like "NodeNotFound")
360
        relevant_namespaces = [str(ns) for ns in self.namespaces.keys()]
361
        while len(_ndatas) > 0:
362
            pop_nodes = []
363
            print(_ndatas)
364
            for ndata in _ndatas:
365
                # Insert nodes that
366
                #   (1) have no parent / parent_ns is None (e.g. namespace 0)
367
                #   (2) ns is not in list of relevant namespaces
368
                if ndata.nodeid.NamespaceIndex not in relevant_namespaces or \
369
                        ndata.parent is None or \
370
                        ndata.parent not in all_node_ids:
371
                    sorted_ndatas.append(ndata)
372
                    sorted_nodes_ids.append(ndata.nodeid)
373
                    pop_nodes.append(ndata)
374
                else:
375
                    # Check if the nodes parent is already in the list of
376
                    # inserted nodes
377
                    if ndata.parent in sorted_nodes_ids:
378
                        sorted_ndatas.append(ndata)
379
                        sorted_nodes_ids.append(ndata.nodeid)
380
                        pop_nodes.append(ndata)
381
382
            # Remove inserted nodes from the list
383
            for ndata in pop_nodes:
384
                _ndatas.pop(_ndatas.index(ndata))
385
        print("SORTD", sorted_ndatas)
386
        return sorted_ndatas
387