Completed
Push — master ( 960975...2f9535 )
by Olivier
06:03
created

XmlImporter._get_node()   A

Complexity

Conditions 4

Size

Total Lines 13

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 13
CRAP Score 4

Importance

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