Passed
Push — master ( 1a9d89...1da59b )
by Olivier
02:36
created

InternalSession.modify_subscription()   A

Complexity

Conditions 1

Size

Total Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 1.125

Importance

Changes 0
Metric Value
cc 1
c 0
b 0
f 0
dl 0
loc 2
ccs 1
cts 2
cp 0.5
crap 1.125
rs 10
1
"""
2
Internal server implementing opcu-ua interface.
3
Can be used on server side or to implement binary/https opc-ua servers
4
"""
5
6 1
from datetime import datetime, timedelta
7 1
from copy import copy, deepcopy
8 1
import os
9 1
import logging
10 1
from threading import Lock
11 1
from enum import Enum
12 1
try:
13 1
    from urllib.parse import urlparse
14
except ImportError:
15
    from urlparse import urlparse
16
17
18 1
from opcua import ua
19 1
from opcua.common import utils
20 1
from opcua.common.callback import (CallbackType, ServerItemCallback,
21
                                   CallbackDispatcher)
22 1
from opcua.common.node import Node
23 1
from opcua.server.history import HistoryManager
24 1
from opcua.server.address_space import AddressSpace
25 1
from opcua.server.address_space import AttributeService
26 1
from opcua.server.address_space import ViewService
27 1
from opcua.server.address_space import NodeManagementService
28 1
from opcua.server.address_space import MethodService
29 1
from opcua.server.subscription_service import SubscriptionService
30 1
from opcua.server.standard_address_space import standard_address_space
31 1
from opcua.server.users import User
32
#from opcua.common import xmlimporter
33
34
35 1
class SessionState(Enum):
36 1
    Created = 0
37 1
    Activated = 1
38 1
    Closed = 2
39
40
41 1
class ServerDesc(object):
42 1
    def __init__(self, serv, cap=None):
43 1
        self.Server = serv
44 1
        self.Capabilities = cap
45
46
47 1
class InternalServer(object):
48
49 1
    def __init__(self, shelffile=None):
50 1
        self.logger = logging.getLogger(__name__)
51
52 1
        self.server_callback_dispatcher = CallbackDispatcher()
53
54 1
        self.endpoints = []
55 1
        self._channel_id_counter = 5
56 1
        self.allow_remote_admin = True
57 1
        self.disabled_clock = False  # for debugging we may want to disable clock that writes too much in log
58 1
        self._known_servers = {}  # used if we are a discovery server
59
60 1
        self.aspace = AddressSpace()
61 1
        self.attribute_service = AttributeService(self.aspace)
62 1
        self.view_service = ViewService(self.aspace)
63 1
        self.method_service = MethodService(self.aspace)
64 1
        self.node_mgt_service = NodeManagementService(self.aspace)
65
66 1
        self.load_standard_address_space(shelffile)
67
68 1
        self.loop = utils.ThreadLoop()
69 1
        self.asyncio_transports = []
70 1
        self.subscription_service = SubscriptionService(self.loop, self.aspace)
71
72 1
        self.history_manager = HistoryManager(self)
73
74
        # create a session to use on server side
75 1
        self.isession = InternalSession(self, self.aspace, self.subscription_service, "Internal", user=User.Admin)
76
77 1
        self.current_time_node = Node(self.isession, ua.NodeId(ua.ObjectIds.Server_ServerStatus_CurrentTime))
78 1
        self._address_space_fixes()
79 1
        self.setup_nodes()
80
81 1
    def setup_nodes(self):
82
        """
83
        Set up some nodes as defined by spec
84
        """
85 1
        uries = ["http://opcfoundation.org/UA/"]
86 1
        ns_node = Node(self.isession, ua.NodeId(ua.ObjectIds.Server_NamespaceArray))
87 1
        ns_node.set_value(uries)
88
89 1
    def load_standard_address_space(self, shelffile=None):
90 1
        if shelffile is not None and os.path.isfile(shelffile):
91
            # import address space from shelf
92
            self.aspace.load_aspace_shelf(shelffile)
93
        else:
94
            # import address space from code generated from xml
95 1
            standard_address_space.fill_address_space(self.node_mgt_service)
96
            # import address space directly from xml, this has performance impact so disabled
97
            # importer = xmlimporter.XmlImporter(self.node_mgt_service)
98
            # importer.import_xml("/path/to/python-opcua/schemas/Opc.Ua.NodeSet2.xml", self)
99
100
            # if a cache file was supplied a shelve of the standard address space can now be built for next start up
101 1
            if shelffile:
102
                self.aspace.make_aspace_shelf(shelffile)
103
104 1
    def _address_space_fixes(self):
105
        """
106
        Looks like the xml definition of address space has some error. This is a good place to fix them
107
        """
108
109 1
        it = ua.AddReferencesItem()
110 1
        it.SourceNodeId = ua.NodeId(ua.ObjectIds.BaseObjectType)
111 1
        it.ReferenceTypeId = ua.NodeId(ua.ObjectIds.Organizes)
112 1
        it.IsForward = False
113 1
        it.TargetNodeId = ua.NodeId(ua.ObjectIds.ObjectTypesFolder)
114 1
        it.TargetNodeClass = ua.NodeClass.Object
115
116 1
        results = self.isession.add_references([it])
117
 
118 1
    def load_address_space(self, path):
119
        """
120
        Load address space from path
121
        """
122
        self.aspace.load(path)
123
124 1
    def dump_address_space(self, path):
125
        """
126
        Dump current address space to path
127
        """
128
        self.aspace.dump(path)
129
130 1
    def start(self):
131 1
        self.logger.info("starting internal server")
132 1
        for edp in self.endpoints:
133 1
            self._known_servers[edp.Server.ApplicationUri] = ServerDesc(edp.Server)
134 1
        self.loop.start()
135 1
        Node(self.isession, ua.NodeId(ua.ObjectIds.Server_ServerStatus_State)).set_value(0, ua.VariantType.Int32)
136 1
        Node(self.isession, ua.NodeId(ua.ObjectIds.Server_ServerStatus_StartTime)).set_value(datetime.utcnow())
137 1
        if not self.disabled_clock:
138 1
            self._set_current_time()
139
140 1
    def stop(self):
141 1
        self.logger.info("stopping internal server")
142 1
        self.isession.close_session()
143 1
        self.loop.stop()
144 1
        self.history_manager.stop()
145
146 1
    def _set_current_time(self):
147 1
        self.current_time_node.set_value(datetime.utcnow())
148 1
        self.loop.call_later(1, self._set_current_time)
149
150 1
    def get_new_channel_id(self):
151 1
        self._channel_id_counter += 1
152 1
        return self._channel_id_counter
153
154 1
    def add_endpoint(self, endpoint):
155 1
        self.endpoints.append(endpoint)
156
157 1
    def get_endpoints(self, params=None, sockname=None):
158 1
        self.logger.info("get endpoint")
159 1
        if sockname:
160
            # return to client the ip address it has access to
161 1
            edps = []
162 1
            for edp in self.endpoints:
163 1
                edp1 = copy(edp)
164 1
                url = urlparse(edp1.EndpointUrl)
165 1
                url = url._replace(netloc=sockname[0] + ":" + str(sockname[1]))
166 1
                edp1.EndpointUrl = url.geturl()
167 1
                edps.append(edp1)
168 1
            return edps
169 1
        return self.endpoints[:]
170
171 1
    def find_servers(self, params):
172 1
        if not params.ServerUris:
173 1
            return [desc.Server for desc in self._known_servers.values()]
174 1
        servers = []
175 1
        for serv in self._known_servers.values():
176 1
            serv_uri = serv.Server.ApplicationUri.split(":")
177 1
            for uri in params.ServerUris:
178 1
                uri = uri.split(":")
179 1
                if serv_uri[:len(uri)] == uri:
180 1
                    servers.append(serv.Server)
181 1
                    break
182 1
        return servers
183
184 1
    def register_server(self, server, conf=None):
185 1
        appdesc = ua.ApplicationDescription()
186 1
        appdesc.ApplicationUri = server.ServerUri
187 1
        appdesc.ProductUri = server.ProductUri
188
        # FIXME: select name from client locale
189 1
        appdesc.ApplicationName = server.ServerNames[0]
190 1
        appdesc.ApplicationType = server.ServerType
191 1
        appdesc.DiscoveryUrls = server.DiscoveryUrls
192
        # FIXME: select discovery uri using reachability from client network
193 1
        appdesc.GatewayServerUri = server.GatewayServerUri
194 1
        self._known_servers[server.ServerUri] = ServerDesc(appdesc, conf)
195
196 1
    def register_server2(self, params):
197
        return self.register_server(params.Server, params.DiscoveryConfiguration)
198
199 1
    def create_session(self, name, user=User.Anonymous, external=False):
200 1
        return InternalSession(self, self.aspace, self.subscription_service, name, user=user, external=external)
201
202 1
    def enable_history_data_change(self, node, period=timedelta(days=7), count=0):
203
        """
204
        Set attribute Historizing of node to True and start storing data for history
205
        """
206 1
        node.set_attribute(ua.AttributeIds.Historizing, ua.DataValue(True))
207 1
        node.set_attr_bit(ua.AttributeIds.AccessLevel, ua.AccessLevel.HistoryRead)
208 1
        node.set_attr_bit(ua.AttributeIds.UserAccessLevel, ua.AccessLevel.HistoryRead)
209 1
        self.history_manager.historize_data_change(node, period, count)
210
211 1
    def disable_history_data_change(self, node):
212
        """
213
        Set attribute Historizing of node to False and stop storing data for history
214
        """
215 1
        node.set_attribute(ua.AttributeIds.Historizing, ua.DataValue(False))
216 1
        node.unset_attr_bit(ua.AttributeIds.AccessLevel, ua.AccessLevel.HistoryRead)
217 1
        node.unset_attr_bit(ua.AttributeIds.UserAccessLevel, ua.AccessLevel.HistoryRead)
218 1
        self.history_manager.dehistorize(node)
219
220 1
    def enable_history_event(self, source, period=timedelta(days=7), count=0):
221
        """
222
        Set attribute History Read of object events to True and start storing data for history
223
        """
224 1
        event_notifier = source.get_event_notifier()
225 1
        if ua.EventNotifier.SubscribeToEvents not in event_notifier:
226
            raise ua.UaError("Node does not generate events", event_notifier)
227
228 1
        if ua.EventNotifier.HistoryRead not in event_notifier:
229 1
            event_notifier.add(ua.EventNotifier.HistoryRead)
230 1
            source.set_event_notifier(event_notifier)
231
232 1
        self.history_manager.historize_event(source, period, count)
233
234 1
    def disable_history_event(self, source):
235
        """
236
        Set attribute History Read of node to False and stop storing data for history
237
        """
238 1
        source.unset_attr_bit(ua.AttributeIds.EventNotifier, ua.EventNotifier.HistoryRead)
239 1
        self.history_manager.dehistorize(source)
240
241 1
    def subscribe_server_callback(self, event, handle):
242
        """
243
        Create a subscription from event to handle
244
        """
245
        self.server_callback_dispatcher.addListener(event, handle)
246
247 1
    def unsubscribe_server_callback(self, event, handle):
248
        """
249
        Remove a subscription from event to handle
250
        """
251
        self.server_callback_dispatcher.removeListener(event, handle)
252
253
254 1
class InternalSession(object):
255 1
    _counter = 10
256 1
    _auth_counter = 1000
257
258 1
    def __init__(self, internal_server, aspace, submgr, name, user=User.Anonymous, external=False):
259 1
        self.logger = logging.getLogger(__name__)
260 1
        self.iserver = internal_server
261 1
        self.external = external  # define if session is external, we need to copy some objects if it is internal
262 1
        self.aspace = aspace
263 1
        self.subscription_service = submgr
264 1
        self.name = name
265 1
        self.user = user
266 1
        self.nonce = None
267 1
        self.state = SessionState.Created
268 1
        self.session_id = ua.NodeId(self._counter)
269 1
        InternalSession._counter += 1
270 1
        self.authentication_token = ua.NodeId(self._auth_counter)
271 1
        InternalSession._auth_counter += 1
272 1
        self.subscriptions = []
273 1
        self.logger.info("Created internal session %s", self.name)
274 1
        self._lock = Lock()
275
276 1
    def __str__(self):
277
        return "InternalSession(name:{0}, user:{1}, id:{2}, auth_token:{3})".format(
278
            self.name, self.user, self.session_id, self.authentication_token)
279
280 1
    def get_endpoints(self, params=None, sockname=None):
281 1
        return self.iserver.get_endpoints(params, sockname)
282
283 1
    def create_session(self, params, sockname=None):
284 1
        self.logger.info("Create session request")
285
286 1
        result = ua.CreateSessionResult()
287 1
        result.SessionId = self.session_id
288 1
        result.AuthenticationToken = self.authentication_token
289 1
        result.RevisedSessionTimeout = params.RequestedSessionTimeout
290 1
        result.MaxRequestMessageSize = 65536
291 1
        self.nonce = utils.create_nonce(32)
292 1
        result.ServerNonce = self.nonce
293 1
        result.ServerEndpoints = self.get_endpoints(sockname=sockname)
294
295 1
        return result
296
297 1
    def close_session(self, delete_subs=True):
298 1
        self.logger.info("close session %s with subscriptions %s", self, self.subscriptions)
299 1
        self.state = SessionState.Closed
300 1
        self.delete_subscriptions(self.subscriptions[:])
301
302 1
    def activate_session(self, params):
303 1
        self.logger.info("activate session")
304 1
        result = ua.ActivateSessionResult()
305 1
        if self.state != SessionState.Created:
306
            raise utils.ServiceError(ua.StatusCodes.BadSessionIdInvalid)
307 1
        self.nonce = utils.create_nonce(32)
308 1
        result.ServerNonce = self.nonce
309 1
        for _ in params.ClientSoftwareCertificates:
310
            result.Results.append(ua.StatusCode())
311 1
        self.state = SessionState.Activated
312 1
        id_token = params.UserIdentityToken
313 1
        if isinstance(id_token, ua.UserNameIdentityToken):
314 1
            if self.iserver.allow_remote_admin and id_token.UserName in ("admin", "Admin"):
315 1
                self.user = User.Admin
316 1
        self.logger.info("Activated internal session %s for user %s", self.name, self.user)
317 1
        return result
318
319 1
    def read(self, params):
320 1
        results = self.iserver.attribute_service.read(params)
321 1
        return results
322
323 1
    def history_read(self, params):
324 1
        return self.iserver.history_manager.read_history(params)
325
326 1
    def write(self, params):
327 1
        return self.iserver.attribute_service.write(params, self.user)
328
329 1
    def browse(self, params):
330 1
        return self.iserver.view_service.browse(params)
331
332 1
    def translate_browsepaths_to_nodeids(self, params):
333 1
        return self.iserver.view_service.translate_browsepaths_to_nodeids(params)
334
335 1
    def add_nodes(self, params):
336 1
        return self.iserver.node_mgt_service.add_nodes(params, self.user)
337
338 1
    def delete_nodes(self, params):
339 1
        return self.iserver.node_mgt_service.delete_nodes(params, self.user)
340
341 1
    def add_references(self, params):
342 1
        return self.iserver.node_mgt_service.add_references(params, self.user)
343
344 1
    def delete_references(self, params):
345 1
        return self.iserver.node_mgt_service.delete_references(params, self.user)
346
347 1
    def add_method_callback(self, methodid, callback):
348 1
        return self.aspace.add_method_callback(methodid, callback)
349
350 1
    def call(self, params):
351 1
        return self.iserver.method_service.call(params)
352
353 1
    def create_subscription(self, params, callback):
354 1
        result = self.subscription_service.create_subscription(params, callback)
355 1
        with self._lock:
356 1
            self.subscriptions.append(result.SubscriptionId)
357 1
        return result
358
359 1
    def modify_subscription(self, params, callback):
360
        return self.subscription_service.modify_subscription(params, callback)
361
362 1
    def create_monitored_items(self, params):
363 1
        subscription_result = self.subscription_service.create_monitored_items(params)
364 1
        self.iserver.server_callback_dispatcher.dispatch(
365
            CallbackType.ItemSubscriptionCreated, ServerItemCallback(params, subscription_result))
366 1
        return subscription_result
367
368 1
    def modify_monitored_items(self, params):
369
        subscription_result = self.subscription_service.modify_monitored_items(params)
370
        self.iserver.server_callback_dispatcher.dispatch(
371
            CallbackType.ItemSubscriptionModified, ServerItemCallback(params, subscription_result))
372
        return subscription_result
373
374 1
    def republish(self, params):
375
        return self.subscription_service.republish(params)
376
377 1
    def delete_subscriptions(self, ids):
378 1
        for i in ids:
379 1
            with self._lock:
380 1
                if i in self.subscriptions:
381 1
                    self.subscriptions.remove(i)
382 1
        return self.subscription_service.delete_subscriptions(ids)
383
384 1
    def delete_monitored_items(self, params):
385 1
        subscription_result = self.subscription_service.delete_monitored_items(params)
386 1
        self.iserver.server_callback_dispatcher.dispatch(
387
            CallbackType.ItemSubscriptionDeleted, ServerItemCallback(params, subscription_result))
388 1
        return subscription_result
389
390 1
    def publish(self, acks=None):
391 1
        if acks is None:
392 1
            acks = []
393
        return self.subscription_service.publish(acks)
394