Completed
Push — master ( 3b7495...50d717 )
by Olivier
03:30
created

MonitoredItemService._modify_monitored_item()   B

Complexity

Conditions 5

Size

Total Lines 14

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 10.8265

Importance

Changes 3
Bugs 1 Features 0
Metric Value
cc 5
dl 0
loc 14
ccs 5
cts 13
cp 0.3846
crap 10.8265
rs 8.5454
c 3
b 1
f 0
1
"""
2
server side implementation of a subscription object
3
"""
4
5 1
from threading import RLock
6 1
import logging
7 1
import copy
8
9 1
from opcua import ua
10
11
12 1
class MonitoredItemData(object):
13
14 1
    def __init__(self):
15 1
        self.client_handle = None
16 1
        self.callback_handle = None
17 1
        self.monitored_item_id = None
18 1
        self.mode = None
19 1
        self.filter = None  
20 1
        self.where_clause_evaluator = None
21
        self.queue_size = 0
22
23 1
24
class MonitoredItemService(object):
25
26
    """
27
    implement monitoreditem service for 1 subscription
28
    """
29 1
30 1
    def __init__(self, isub, aspace):
31 1
        self.logger = logging.getLogger(__name__ + "." + str(isub.data.SubscriptionId))
32 1
        self.isub = isub
33 1
        self.aspace = aspace
34 1
        self._lock = RLock()
35 1
        self._monitored_items = {}
36 1
        self._monitored_events = {}
37 1
        self._monitored_datachange = {}
38
        self._monitored_item_counter = 111
39 1
40 1
    def delete_all_monitored_items(self):
41
        self.delete_monitored_items([mdata.monitored_item_id for mdata in self._monitored_items.values()])
42 1
43 1
    def create_monitored_items(self, params):
44 1
        results = []
45 1
        for item in params.ItemsToCreate:
46 1
            with self._lock:
47
                if item.ItemToMonitor.AttributeId == ua.AttributeIds.EventNotifier:
48 1
                    result = self._create_events_monitored_item(item)
49
                else:
50
                    result = self._create_data_change_monitored_item(item)
51
            results.append(result)
52
        return results
53
54 1
    def modify_monitored_items(self, params):
55 1
        results = []
56 1
        for item in params.ItemsToModify:
57 1
            results.append(self._modify_monitored_item(item))
58
        return results
59 1
60
    def trigger_datachange(self, handle, nodeid, attr):
61
        self.logger.debug("triggering datachange for handle %s, nodeid %s, and attribute %s", handle, nodeid, attr)
62
        variant = self.aspace.get_attribute_value(nodeid, attr)
63
        self.datachange_callback(handle, variant)
64
65
    def _modify_monitored_item(self, params):
66
        with self._lock:
67
            for mdata in self._monitored_items.values():
68
                result = ua.MonitoredItemModifyResult()
69
                if mdata.monitored_item_id == params.MonitoredItemId:
70
                    result.RevisedSamplingInterval = params.RequestedParameters.SamplingInterval
71
                    result.RevisedQueueSize = params.RequestedParameters.QueueSize
72
                    if params.RequestedParameters.Filter is not None:
73
                        mdata.filter = params.RequestedParameters.Filter
74 1
                    mdata.queue_size = params.RequestedParameters.QueueSize
75 1
                    return result
76 1
            result = ua.MonitoredItemModifyResult()
77 1
            result.StatusCode(ua.StatusCodes.BadMonitoredItemIdInvalid)
78 1
            return result
79 1
80 1
    def _commit_monitored_item(self, result, mdata):
81 1
        if result.StatusCode.is_good():
82
            self._monitored_items[result.MonitoredItemId] = mdata
83 1
            self._monitored_item_counter += 1
84 1
85 1
    def _make_monitored_item_common(self, params):
86 1
        result = ua.MonitoredItemCreateResult()
87 1
        result.RevisedSamplingInterval = self.isub.data.RevisedPublishingInterval
88 1
        result.RevisedQueueSize = params.RequestedParameters.QueueSize
89
        self._monitored_item_counter += 1
90 1
        result.MonitoredItemId = self._monitored_item_counter
91
        self.logger.debug("Creating MonitoredItem with id %s", result.MonitoredItemId)
92 1
93 1
        mdata = MonitoredItemData()
94 1
        mdata.mode = params.MonitoringMode
95 1
        mdata.client_handle = params.RequestedParameters.ClientHandle
96 1
        mdata.monitored_item_id = result.MonitoredItemId
97 1
        mdata.queue_size = params.RequestedParameters.QueueSize
98
        mdata.filter = params.RequestedParameters.Filter
99 1
100 1
        return result, mdata
101 1
102 1
    def _create_events_monitored_item(self, params):
103
        self.logger.info("request to subscribe to events for node %s and attribute %s",
104 1
                         params.ItemToMonitor.NodeId,
105
                         params.ItemToMonitor.AttributeId)
106 1
107 1
        result, mdata = self._make_monitored_item_common(params)
108 1
        ev_notify_byte = self.aspace.get_attribute_value(params.ItemToMonitor.NodeId, ua.AttributeIds.EventNotifier).Value.Value
109 1
        if ev_notify_byte is None or ev_notify_byte & 1 == 0:
110 1
            result.StatusCode = ua.StatusCode(ua.StatusCodes.BadServiceUnsupported)
111 1
            return result
112 1
        # result.FilterResult = ua.EventFilterResult()  # spec says we can ignore if not error
113
        mdata.where_clause_evaluator = WhereClauseEvaluator(self.logger, self.aspace, mdata.filter.WhereClause)
114 1
        self._commit_monitored_item(result, mdata)
115
        if params.ItemToMonitor.NodeId not in self._monitored_events:
116 1
            self._monitored_events[params.ItemToMonitor.NodeId] = []
117 1
        self._monitored_events[params.ItemToMonitor.NodeId].append(result.MonitoredItemId)
118 1
        return result
119
120 1
    def _create_data_change_monitored_item(self, params):
121
        self.logger.info("request to subscribe to datachange for node %s and attribute %s",
122 1
                         params.ItemToMonitor.NodeId,
123 1
                         params.ItemToMonitor.AttributeId)
124 1
125 1
        result, mdata = self._make_monitored_item_common(params)
126 1
        result.FilterResult = params.RequestedParameters.Filter
127 1
        result.StatusCode, handle = self.aspace.add_datachange_callback(params.ItemToMonitor.NodeId, params.ItemToMonitor.AttributeId, self.datachange_callback)
128 1
        self.logger.debug("adding callback return status %s and handle %s", result.StatusCode, handle)
129
        mdata.callback_handle = handle
130 1
        self._commit_monitored_item(result, mdata)
131 1
        if result.StatusCode.is_good():
132 1
            self._monitored_datachange[handle] = result.MonitoredItemId
133 1
            # force data change event generation
134 1
            self.trigger_datachange(handle, params.ItemToMonitor.NodeId, params.ItemToMonitor.AttributeId)
135 1
        return result
136 1
137 1
    def delete_monitored_items(self, ids):
138 1
        self.logger.debug("delete monitored items %s", ids)
139 1
        with self._lock:
140 1
            results = []
141 1
            for mid in ids:
142 1
                results.append(self._delete_monitored_items(mid))
143 1
            return results
144
145 1
    def _delete_monitored_items(self, mid):
146 1
        if mid not in self._monitored_items:
147
            return ua.StatusCode(ua.StatusCodes.BadMonitoredItemIdInvalid)
148
        for k, v in self._monitored_events.items():
149
            if mid in v:
150 1
                v.remove(mid)
151 1
                if not v:
152 1
                    self._monitored_events.pop(k)
153 1
                break
154 1
        for k, v in self._monitored_datachange.items():
155 1
            if v == mid:
156 1
                self.aspace.delete_datachange_callback(k)
157 1
                self._monitored_datachange.pop(k)
158
                break
159 1
        self._monitored_items.pop(mid)
160 1
        return ua.StatusCode()
161 1
162 1
    def datachange_callback(self, handle, value, error=None):
163 1
        if error:
164 1
            self.logger.info("subscription %s: datachange callback called with handle '%s' and erorr '%s'",
165 1
                             self, handle, error)
166 1
            self.trigger_statuschange(error)
167
        else:
168
            self.logger.info("subscription %s: datachange callback called with handle '%s' and value '%s'",
169 1
                             self, handle, value.Value)
170 1
            event = ua.MonitoredItemNotification()
171 1
            with self._lock:
172 1
                mid = self._monitored_datachange[handle]
173 1
                mdata = self._monitored_items[mid]
174 1
                event.ClientHandle = mdata.client_handle
175
                event.Value = value
176 1
                self.isub.enqueue_datachange_event(mid, event, mdata.queue_size)
177 1
178 1
    def trigger_event(self, event):
179 1
        with self._lock:
180 1
            if event.SourceNode not in self._monitored_events:
181
                self.logger.debug("%s has no subscription for events %s from node: %s",
182
                                  self, event, event.SourceNode)
183
                return False
184
            self.logger.debug("%s has subscription for events %s from node: %s",
185
                              self, event, event.SourceNode)
186 1
            mids = self._monitored_events[event.SourceNode]
187 1
            for mid in mids:
188 1
                self._trigger_event(event, mid)
189 1
190
    def _trigger_event(self, event, mid):
191
        if mid not in self._monitored_items:
192 1
            self.logger.debug("Could not find monitored items for id %s for event %s in subscription %s", mid, event, self)
193
            return
194 1
        mdata = self._monitored_items[mid]
195
        if not mdata.where_clause_evaluator.eval(event):
196
            self.logger.info("%s, %s, Event %s does not fit WhereClause, not generating event", self, mid, event)
197
            return
198 1
        fieldlist = ua.EventFieldList()
199
        fieldlist.ClientHandle = mdata.client_handle
200 1
        fieldlist.EventFields = self._get_event_fields(mdata.filter, event)
201 1
        self.isub.enqueue_event(mid, fieldlist, mdata.queue_size)
202 1
203 1
    def _get_event_fields(self, evfilter, event):
204 1
        fields = []
205 1
        for sattr in evfilter.SelectClauses:
206 1
            try:
207 1
                if not sattr.BrowsePath:
208 1
                    val = getattr(event, sattr.Attribute.name)
209 1
                    val = copy.deepcopy(val)
210 1
                    fields.append(ua.Variant(val))
211 1
                else:
212 1
                    name = sattr.BrowsePath[0].Name
213 1
                    val = getattr(event, name)
214 1
                    val = copy.deepcopy(val)
215 1
                    fields.append(ua.Variant(val))
216 1
            except AttributeError:
217 1
                fields.append(ua.Variant())
218
        return fields
219 1
220
    def trigger_statuschange(self, code):
221
        self.isub.enqueue_statuschange(code)
222 1
223 1
224 1
class InternalSubscription(object):
225
226 1
    def __init__(self, subservice, data, addressspace, callback):
227 1
        self.logger = logging.getLogger(__name__)
228 1
        self.aspace = addressspace
229 1
        self.subservice = subservice
230
        self.data = data
231 1
        self.callback = callback
232
        self.monitored_item_srv = MonitoredItemService(self, addressspace)
233 1
        self.task = None
234 1
        self._lock = RLock()
235
        self._triggered_datachanges = {}
236 1
        self._triggered_events = {}
237 1
        self._triggered_statuschanges = []
238 1
        self._notification_seq = 1
239 1
        self._not_acknowledged_results = {}
240 1
        self._startup = True
241
        self._keep_alive_count = 0
242 1
        self._publish_cycles_count = 0
243 1
        self._stopev = False
244 1
245 1
    def __str__(self):
246 1
        return "Subscription(id:{})".format(self.data.SubscriptionId)
247
248
    def start(self):
249 1
        self.logger.debug("starting subscription %s", self.data.SubscriptionId)
250 1
        self._subscription_loop()
251
252 1
    def stop(self):
253 1
        self.logger.debug("stopping subscription %s", self.data.SubscriptionId)
254
        self._stopev = True
255
        self.monitored_item_srv.delete_all_monitored_items()
256
257
    def _subscription_loop(self):
258 1
        #self.logger.debug("%s loop", self)
259 1
        if not self._stopev:
260 1
            self.subservice.loop.call_later(self.data.RevisedPublishingInterval / 1000.0, self._sub_loop)
261 1
262 1
    def _sub_loop(self):
263 1
        if self._stopev:
264 1
            return
265
        self.publish_results()
266 1
        self._subscription_loop()
267 1
268 1
    def has_published_results(self):
269 1
        with self._lock:
270 1
            if self._startup or self._triggered_datachanges or self._triggered_events:
271 1
                return True
272 1
            if self._keep_alive_count > self.data.RevisedMaxKeepAliveCount:
273 1
                self.logger.debug("keep alive count %s is > than max keep alive count %s, sending publish event", self._keep_alive_count, self.data.RevisedMaxKeepAliveCount)
274 1
                return True
275 1
            self._keep_alive_count += 1
276 1
            return False
277 1
278 1
    def publish_results(self):
279 1
        if self._publish_cycles_count > self.data.RevisedLifetimeCount:
280 1
            self.logger.warning("Subscription %s has expired, publish cycle count(%s) > lifetime count (%s)", self, self._publish_cycles_count, self.data.RevisedLifetimeCount)
281
            # FIXME this will never be send since we do not have publish request anyway
282 1
            self.monitored_item_srv.trigger_statuschange(ua.StatusCode(ua.StatusCodes.BadTimeout))
283 1
            self._stopev = True
284 1
        result = None
285 1
        with self._lock:
286 1
            if self.has_published_results():  # FIXME: should we pop a publish request here? or we do not care?
287 1
                self._publish_cycles_count += 1
288 1
                result = self._pop_publish_result()
289
        if result is not None:
290 1
            self.callback(result)
291 1
292 1
    def _pop_publish_result(self):
293 1
        result = ua.PublishResult()
294 1
        result.SubscriptionId = self.data.SubscriptionId
295 1
        self._pop_triggered_datachanges(result)
296 1
        self._pop_triggered_events(result)
297
        self._pop_triggered_statuschanges(result)
298 1
        self._keep_alive_count = 0
299 1
        self._startup = False
300
        result.NotificationMessage.SequenceNumber = self._notification_seq
301
        if len(result.NotificationMessage.NotificationData) != 0:
302
            self._notification_seq += 1
303
            self._not_acknowledged_results[result.NotificationMessage.SequenceNumber] = result
304
        result.MoreNotifications = False
305 1
        result.AvailableSequenceNumbers = list(self._not_acknowledged_results.keys())
306 1
        return result
307 1
308 1
    def _pop_triggered_datachanges(self, result):
309 1
        if self._triggered_datachanges:
310 1
            notif = ua.DataChangeNotification()
311 1
            notif.MonitoredItems = [item for sublist in self._triggered_datachanges.values() for item in sublist]
312
            self._triggered_datachanges = {}
313 1
            self.logger.debug("sending datachanges notification with %s events", len(notif.MonitoredItems))
314
            result.NotificationMessage.NotificationData.append(notif)
315
316
    def _pop_triggered_events(self, result):
317
        if self._triggered_events:
318
            notif = ua.EventNotificationList()
319
            notif.Events = [item for sublist in self._triggered_events.values() for item in sublist]
320
            self._triggered_events = {}
321
            result.NotificationMessage.NotificationData.append(notif)
322
            self.logger.debug("sending event notification with %s events", len(notif.Events))
323 1
324 1
    def _pop_triggered_statuschanges(self, result):
325
        if self._triggered_statuschanges:
326 1
            notif = ua.StatusChangeNotification()
327 1
            notif.Status = self._triggered_statuschanges.pop(0)
328
            result.NotificationMessage.NotificationData.append(notif)
329 1
            self.logger.debug("sending event notification %s", notif.Status)
330
331
    def publish(self, acks):
332 1
        self.logger.info("publish request with acks %s", acks)
333 1
        with self._lock:
334 1
            self._publish_cycles_count = 0
335 1
            for nb in acks:
336 1
                if nb in self._not_acknowledged_results:
337
                    self._not_acknowledged_results.pop(nb)
338
339 1
    def republish(self, nb):
340
        self.logger.info("re-publish request for ack %s in subscription %s", nb, self)
341
        with self._lock:
342
            if nb in self._not_acknowledged_results:
343
                self.logger.info("re-publishing ack %s in subscription %s", nb, self)
344
                return self._not_acknowledged_results[nb].NotificationMessage
345
            else:
346
                self.logger.info("Error request to re-published non existing ack %s in subscription %s", nb, self)
347
                return ua.NotificationMessage()
348
349
    def enqueue_datachange_event(self, mid, eventdata, maxsize):
350
        self._enqueue_event(mid, eventdata, maxsize, self._triggered_datachanges)
351
352
    def enqueue_event(self, mid, eventdata, maxsize):
353
        self._enqueue_event(mid, eventdata, maxsize, self._triggered_events)
354
355
    def enqueue_statuschange(self, code):
356
        self._triggered_statuschanges.append(code)
357
358
    def _enqueue_event(self, mid, eventdata, size, queue):
359
        if mid not in queue:
360
            queue[mid] = [eventdata]
361
            return
362
        if size != 0:
363
            if len(queue[mid]) >= size:
364
                queue[mid].pop(0)
365
        queue[mid].append(eventdata)
366
367
368
class WhereClauseEvaluator(object):
369
    def __init__(self, logger, aspace, whereclause):
370
        self.logger = logger
371
        self.elements = whereclause.Elements
372
        self._aspace = aspace
373
374
    def eval(self, event):
375
        if not self.elements:
376
            return True
377
        # spec says we should only evaluate first element, which may use other elements
378
        try:
379
            res = self._eval_el(0, event)
380
        except Exception as ex:
381
            self.logger.warning("Exception while evaluating WhereClause %s for event %s: %s", self.elements, event, ex)
382
            return False
383
        return res
384
385
    def _eval_el(self, index, event):
386
        el = self.elements[index]
387
        #ops = [self._eval_op(op, event) for op in el.FilterOperands]
388
        ops = el.FilterOperands  # just to make code more readable
389
        if el.FilterOperator == ua.FilterOperator.Equals:
390
            return self._eval_op(ops[0], event) == self._eval_el(ops[1], event)
391
        elif el.FilterOperator == ua.FilterOperator.IsNull:
392
            return self._eval_op(ops[0], event) is None  # FIXME: might be too strict
393
        elif el.FilterOperator == ua.FilterOperator.GreaterThan:
394
            return self._eval_op(ops[0], event) > self._eval_el(ops[1], event)
395
        elif el.FilterOperator == ua.FilterOperator.LessThan:
396
            return self._eval_op(ops[0], event) < self._eval_el(ops[1], event)
397
        elif el.FilterOperator == ua.FilterOperator.GreaterThanOrEqual:
398
            return self._eval_op(ops[0], event) >= self._eval_el(ops[1], event)
399
        elif el.FilterOperator == ua.FilterOperator.LessThanOrEqual:
400
            return self._eval_op(ops[0], event) <= self._eval_el(ops[1], event)
401
        elif el.FilterOperator == ua.FilterOperator.Like:
402
            return self._likeoperator(self._eval_op(ops[0], event), self._eval_el(ops[1], event))
403
        elif el.FilterOperator == ua.FilterOperator.Not:
404
            return not self._eval_op(ops[0], event)
405
        elif el.FilterOperator == ua.FilterOperator.Between:
406
            return self._eval_el(ops[2], event) >= self._eval_op(ops[0], event) >= self._eval_el(ops[1], event)
407
        elif el.FilterOperator == ua.FilterOperator.InList:
408
            return self._eval_op(ops[0], event) in [self._eval_op(op, event) for op in ops[1:]]
409
        elif el.FilterOperator == ua.FilterOperator.And:
410
            self.elements(ops[0].Index)
411
            return self._eval_op(ops[0], event) and self._eval_op(ops[1], event)
412
        elif el.FilterOperator == ua.FilterOperator.Or:
413
            return self._eval_op(ops[0], event) or self._eval_el(ops[1], event)
414
        elif el.FilterOperator == ua.FilterOperator.Cast:
415
            self.logger.warn("Cast operand not implemented, assuming True")
416
            return True
417
        elif el.FilterOperator == ua.FilterOperator.OfType:
418
            self.logger.warn("OfType operand not implemented, assuming True")
419
            return True
420
        else:
421
            # TODO: implement missing operators
422
            print("WhereClause not implemented for element: %s", el)
423
            raise NotImplementedError
424
425
    def _like_operator(self, string, pattern):
426
        raise NotImplementedError
427
428
    def _eval_op(self, op, event):
429
        # seems spec says we should return Null if issues
430
        if type(op) is ua.ElementOperand:
431
            return self._eval_el(op.Index, event)
432
        elif type(op) is ua.AttributeOperand:
433
            if op.BrowsePath:
434
                return getattr(event, op.BrowsePath.Elements[0].TargetName.Name)
435
            else:
436
                return self._aspace.get_attribute_value(event.EventType, op.AttributeId).Value.Value
437
            # FIXME: check, this is probably broken
438
        elif type(op) is ua.SimpleAttributeOperand:
439
            if op.BrowsePath:
440
                # we only support depth of 1
441
                return getattr(event, op.BrowsePath[0].Name)
442
            else:
443
                # TODO: write code for index range.... but doe it make any sense
444
                return self._aspace.get_attribute_value(event.EventType, op.AttributeId).Value.Value
445
        elif type(op) is ua.LiteralOperand:
446
            return op.Value.Value
447
        else:
448
            self.logger.warning("Where clause element % is not of a known type", op)
449
            raise NotImplementedError
450
451
452
453