nodeset.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. #!/usr/bin/env/python
  2. # -*- coding: utf-8 -*-
  3. ###
  4. ### Author: Chris Iatrou (ichrispa@core-vector.net)
  5. ### Version: rev 13
  6. ###
  7. ### This program was created for educational purposes and has been
  8. ### contributed to the open62541 project by the author. All licensing
  9. ### terms for this source is inherited by the terms and conditions
  10. ### specified for by the open62541 project (see the projects readme
  11. ### file for more information on the LGPL terms and restrictions).
  12. ###
  13. ### This program is not meant to be used in a production environment. The
  14. ### author is not liable for any complications arising due to the use of
  15. ### this program.
  16. ###
  17. from __future__ import print_function
  18. import sys
  19. import xml.dom.minidom as dom
  20. from struct import pack as structpack
  21. from time import struct_time, strftime, strptime, mktime
  22. import logging
  23. import codecs
  24. import re
  25. logger = logging.getLogger(__name__)
  26. from nodes import *
  27. from opaque_type_mapping import opaque_type_mapping
  28. import codecs
  29. ####################
  30. # Helper Functions #
  31. ####################
  32. hassubtype = NodeId("ns=0;i=45")
  33. def getSubTypesOf(nodeset, node, skipNodes=[]):
  34. if node in skipNodes:
  35. return []
  36. re = [node]
  37. for ref in node.references:
  38. if ref.referenceType == hassubtype and ref.isForward:
  39. re = re + getSubTypesOf(nodeset, nodeset.nodes[ref.target], skipNodes=skipNodes)
  40. return re
  41. def extractNamespaces(xmlfile):
  42. # Extract a list of namespaces used. The first namespace is always
  43. # "http://opcfoundation.org/UA/". minidom gobbles up
  44. # <NamespaceUris></NamespaceUris> elements, without a decent way to reliably
  45. # access this dom2 <uri></uri> elements (only attribute xmlns= are accessible
  46. # using minidom). We need them for dereferencing though... This function
  47. # attempts to do just that.
  48. namespaces = ["http://opcfoundation.org/UA/"]
  49. infile = codecs.open(xmlfile.name, encoding='utf-8')
  50. foundURIs = False
  51. nsline = ""
  52. line = infile.readline()
  53. for line in infile:
  54. if "<namespaceuris>" in line.lower():
  55. foundURIs = True
  56. elif "</namespaceuris>" in line.lower():
  57. foundURIs = False
  58. nsline = nsline + line
  59. break
  60. if foundURIs:
  61. nsline = nsline + line
  62. if len(nsline) > 0:
  63. ns = dom.parseString(nsline).getElementsByTagName("NamespaceUris")
  64. for uri in ns[0].childNodes:
  65. if uri.nodeType != uri.ELEMENT_NODE:
  66. continue
  67. if uri.firstChild.data in namespaces:
  68. continue
  69. namespaces.append(uri.firstChild.data)
  70. infile.close()
  71. return namespaces
  72. def buildAliasList(xmlelement):
  73. """Parses the <Alias> XML Element present in must XML NodeSet definitions.
  74. Contents the Alias element are stored in a dictionary for further
  75. dereferencing during pointer linkage (see linkOpenPointer())."""
  76. aliases = {}
  77. for al in xmlelement.childNodes:
  78. if al.nodeType == al.ELEMENT_NODE:
  79. if al.hasAttribute("Alias"):
  80. aliasst = al.getAttribute("Alias")
  81. aliasnd = unicode(al.firstChild.data)
  82. aliases[aliasst] = aliasnd
  83. return aliases
  84. class NodeSet(object):
  85. """ This class handles parsing XML description of namespaces, instantiating
  86. nodes, linking references, graphing the namespace and compiling a binary
  87. representation.
  88. Note that nodes assigned to this class are not restricted to having a
  89. single namespace ID. This class represents the entire physical address
  90. space of the binary representation and all nodes that are to be included
  91. in that segment of memory.
  92. """
  93. def __init__(self):
  94. self.nodes = {}
  95. self.aliases = {}
  96. self.namespaces = ["http://opcfoundation.org/UA/"]
  97. def sanitize(self):
  98. for n in self.nodes.values():
  99. if n.sanitize() == False:
  100. raise Exception("Failed to sanitize node " + str(n))
  101. # Sanitize reference consistency
  102. for n in self.nodes.values():
  103. for ref in n.references:
  104. if not ref.source == n.id:
  105. raise Exception("Reference " + str(ref) + " has an invalid source")
  106. if not ref.referenceType in self.nodes:
  107. raise Exception("Reference " + str(ref) + " has an unknown reference type")
  108. if not ref.target in self.nodes:
  109. raise Exception("Reference " + str(ref) + " has an unknown target")
  110. def addNamespace(self, nsURL):
  111. if not nsURL in self.namespaces:
  112. self.namespaces.append(nsURL)
  113. def createNamespaceMapping(self, orig_namespaces):
  114. """Creates a dict that maps from the nsindex in the original nodeset to the
  115. nsindex in the combined nodeset"""
  116. m = {}
  117. for index, name in enumerate(orig_namespaces):
  118. m[index] = self.namespaces.index(name)
  119. return m
  120. def getNodeByBrowseName(self, idstring):
  121. return next((n for n in self.nodes.values() if idstring == n.browseName.name), None)
  122. def getNodeById(self, namespace, id):
  123. nodeId = NodeId()
  124. nodeId.ns = namespace
  125. nodeId.i = id
  126. return self.nodes[nodeId]
  127. def getRoot(self):
  128. return self.getNodeByBrowseName("Root")
  129. def createNode(self, xmlelement, nsMapping, hidden=False):
  130. ndtype = xmlelement.localName.lower()
  131. if ndtype[:2] == "ua":
  132. ndtype = ndtype[2:]
  133. node = None
  134. if ndtype == 'variable':
  135. node = VariableNode(xmlelement)
  136. if ndtype == 'object':
  137. node = ObjectNode(xmlelement)
  138. if ndtype == 'method':
  139. node = MethodNode(xmlelement)
  140. if ndtype == 'objecttype':
  141. node = ObjectTypeNode(xmlelement)
  142. if ndtype == 'variabletype':
  143. node = VariableTypeNode(xmlelement)
  144. if ndtype == 'methodtype':
  145. node = MethodNode(xmlelement)
  146. if ndtype == 'datatype':
  147. node = DataTypeNode(xmlelement)
  148. if ndtype == 'referencetype':
  149. node = ReferenceTypeNode(xmlelement)
  150. if node == None:
  151. return None
  152. node.hidden = hidden
  153. return node
  154. def hide_node(self, nodeId, hidden=True):
  155. if not nodeId in self.nodes:
  156. return False
  157. node = self.nodes[nodeId]
  158. node.hidden = hidden
  159. return True
  160. def merge_dicts(self, *dict_args):
  161. """
  162. Given any number of dicts, shallow copy and merge into a new dict,
  163. precedence goes to key value pairs in latter dicts.
  164. """
  165. result = {}
  166. for dictionary in dict_args:
  167. result.update(dictionary)
  168. return result
  169. def addNodeSet(self, xmlfile, hidden=False, typesArray="UA_TYPES"):
  170. # Extract NodeSet DOM
  171. fileContent = xmlfile.read()
  172. # Remove BOM since the dom parser cannot handle it on python 3 windows
  173. if fileContent.startswith( codecs.BOM_UTF8 ):
  174. fileContent = fileContent.lstrip( codecs.BOM_UTF8 )
  175. if (sys.version_info >= (3, 0)):
  176. fileContent = fileContent.decode("utf-8")
  177. # Remove the uax namespace from tags. UaModeler adds this namespace to some elements
  178. fileContent = re.sub(r"<([/]?)uax:(\w+)([/]?)>", "<\g<1>\g<2>\g<3>>", fileContent)
  179. nodesets = dom.parseString(fileContent).getElementsByTagName("UANodeSet")
  180. if len(nodesets) == 0 or len(nodesets) > 1:
  181. raise Exception(self, self.originXML + " contains no or more then 1 nodeset")
  182. nodeset = nodesets[0]
  183. # Create the namespace mapping
  184. orig_namespaces = extractNamespaces(xmlfile) # List of namespaces used in the xml file
  185. for ns in orig_namespaces:
  186. self.addNamespace(ns)
  187. nsMapping = self.createNamespaceMapping(orig_namespaces)
  188. # Extract the aliases
  189. for nd in nodeset.childNodes:
  190. if nd.nodeType != nd.ELEMENT_NODE:
  191. continue
  192. ndtype = nd.localName.lower()
  193. if 'aliases' in ndtype:
  194. self.aliases = self.merge_dicts(self.aliases, buildAliasList(nd))
  195. # Instantiate nodes
  196. newnodes = []
  197. for nd in nodeset.childNodes:
  198. if nd.nodeType != nd.ELEMENT_NODE:
  199. continue
  200. node = self.createNode(nd, nsMapping, hidden)
  201. if not node:
  202. continue
  203. node.replaceAliases(self.aliases)
  204. node.replaceNamespaces(nsMapping)
  205. node.typesArray = typesArray
  206. # Add the node the the global dict
  207. if node.id in self.nodes:
  208. raise Exception("XMLElement with duplicate ID " + str(node.id))
  209. self.nodes[node.id] = node
  210. newnodes.append(node)
  211. def getBinaryEncodingIdForNode(self, nodeId):
  212. """
  213. The node should have a 'HasEncoding' forward reference which points to the encoding ids.
  214. These can be XML Encoding or Binary Encoding. Therefore we also need to check if the SymbolicName
  215. of the target node is "DefaultBinary"
  216. """
  217. node = self.nodes[nodeId]
  218. refId = NodeId()
  219. for ref in node.references:
  220. if ref.referenceType.ns == 0 and ref.referenceType.i == 38:
  221. refNode = self.nodes[ref.target]
  222. if refNode.symbolicName.value == "DefaultBinary":
  223. return ref.target
  224. raise Exception("No DefaultBinary encoding defined for node " + str(nodeId))
  225. def buildEncodingRules(self):
  226. """ Calls buildEncoding() for all DataType nodes (opcua_node_dataType_t).
  227. No return value
  228. """
  229. stat = {True: 0, False: 0}
  230. for n in self.nodes.values():
  231. if isinstance(n, DataTypeNode):
  232. n.buildEncoding(self)
  233. stat[n.isEncodable()] = stat[n.isEncodable()] + 1
  234. logger.debug("Type definitions built/passed: " + str(stat))
  235. def allocateVariables(self):
  236. for n in self.nodes.values():
  237. if isinstance(n, VariableNode):
  238. n.allocateValue(self)
  239. def getBaseDataType(self, node):
  240. if node is None:
  241. return None
  242. if node.browseName.name not in opaque_type_mapping:
  243. return node
  244. for ref in node.references:
  245. if ref.isForward:
  246. continue
  247. if ref.referenceType.i == 45:
  248. return self.getBaseDataType(self.nodes[ref.target])
  249. return node
  250. def getDataTypeNode(self, dataType):
  251. if isinstance(dataType, six.string_types):
  252. if not valueIsInternalType(dataType):
  253. logger.error("Not a valid dataType string: " + dataType)
  254. return None
  255. return self.nodes[NodeId(self.aliases[dataType])]
  256. if isinstance(dataType, NodeId):
  257. if dataType.i == 0:
  258. return None
  259. dataTypeNode = self.nodes[dataType]
  260. if not isinstance(dataTypeNode, DataTypeNode):
  261. logger.error("Node id " + str(dataType) + " is not reference a valid dataType.")
  262. return None
  263. if not dataTypeNode.isEncodable():
  264. logger.warn("DataType " + str(dataTypeNode.browseName) + " is not encodable.")
  265. return dataTypeNode
  266. return None
  267. def getRelevantOrderingReferences(self):
  268. relevant_types = getSubTypesOf(self, self.getNodeByBrowseName("HierarchicalReferences"), [])
  269. relevant_types += getSubTypesOf(self, self.getNodeByBrowseName("HasEncoding"), [])
  270. relevant_types += getSubTypesOf(self, self.getNodeByBrowseName("HasTypeDefinition"), [])
  271. return list(map(lambda x: x.id, relevant_types))