Passed
Push — master ( 51826f...56965b )
by Olivier
04:13
created

XmlImporter.add_variable()   D

Complexity

Conditions 8

Size

Total Lines 24

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 21
CRAP Score 8.125

Importance

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