Completed
Pull Request — master (#330)
by
unknown
04:15
created

XmlImporter._split_node_id()   A

Complexity

Conditions 3

Size

Total Lines 13

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 4.125

Importance

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