ua_services_subscription.c 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  4. *
  5. * Copyright 2014-2017 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  6. * Copyright 2016-2017 (c) Florian Palm
  7. * Copyright 2015 (c) Chris Iatrou
  8. * Copyright 2015-2016 (c) Sten Grüner
  9. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  10. * Copyright 2017 (c) Stefan Profanter, fortiss GmbH
  11. * Copyright 2018 (c) Ari Breitkreuz, fortiss GmbH
  12. * Copyright 2017 (c) Mattias Bornhager
  13. * Copyright 2017 (c) Henrik Norrman
  14. * Copyright 2017-2018 (c) Thomas Stalder, Blue Time Concept SA
  15. */
  16. #include "ua_server_internal.h"
  17. #include "ua_services.h"
  18. #include "ua_subscription.h"
  19. #ifdef UA_ENABLE_SUBSCRIPTIONS /* conditional compilation */
  20. #define UA_BOUNDEDVALUE_SETWBOUNDS(BOUNDS, SRC, DST) { \
  21. if(SRC > BOUNDS.max) DST = BOUNDS.max; \
  22. else if(SRC < BOUNDS.min) DST = BOUNDS.min; \
  23. else DST = SRC; \
  24. }
  25. static void
  26. setSubscriptionSettings(UA_Server *server, UA_Subscription *subscription,
  27. UA_Double requestedPublishingInterval,
  28. UA_UInt32 requestedLifetimeCount,
  29. UA_UInt32 requestedMaxKeepAliveCount,
  30. UA_UInt32 maxNotificationsPerPublish, UA_Byte priority) {
  31. /* deregister the callback if required */
  32. UA_StatusCode retval = Subscription_unregisterPublishCallback(server, subscription);
  33. if(retval != UA_STATUSCODE_GOOD)
  34. UA_LOG_DEBUG_SESSION(server->config.logger, subscription->session,
  35. "Subscription %u | Could not unregister publish callback with error code %s",
  36. subscription->subscriptionId, UA_StatusCode_name(retval));
  37. /* re-parameterize the subscription */
  38. subscription->publishingInterval = requestedPublishingInterval;
  39. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.publishingIntervalLimits,
  40. requestedPublishingInterval, subscription->publishingInterval);
  41. /* check for nan*/
  42. if(requestedPublishingInterval != requestedPublishingInterval)
  43. subscription->publishingInterval = server->config.publishingIntervalLimits.min;
  44. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.keepAliveCountLimits,
  45. requestedMaxKeepAliveCount, subscription->maxKeepAliveCount);
  46. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.lifeTimeCountLimits,
  47. requestedLifetimeCount, subscription->lifeTimeCount);
  48. if(subscription->lifeTimeCount < 3 * subscription->maxKeepAliveCount)
  49. subscription->lifeTimeCount = 3 * subscription->maxKeepAliveCount;
  50. subscription->notificationsPerPublish = maxNotificationsPerPublish;
  51. if(maxNotificationsPerPublish == 0 ||
  52. maxNotificationsPerPublish > server->config.maxNotificationsPerPublish)
  53. subscription->notificationsPerPublish = server->config.maxNotificationsPerPublish;
  54. subscription->priority = priority;
  55. retval = Subscription_registerPublishCallback(server, subscription);
  56. if(retval != UA_STATUSCODE_GOOD)
  57. UA_LOG_DEBUG_SESSION(server->config.logger, subscription->session,
  58. "Subscription %u | Could not register publish callback with error code %s",
  59. subscription->subscriptionId, UA_StatusCode_name(retval));
  60. }
  61. void
  62. Service_CreateSubscription(UA_Server *server, UA_Session *session,
  63. const UA_CreateSubscriptionRequest *request,
  64. UA_CreateSubscriptionResponse *response) {
  65. /* Check limits for the number of subscriptions */
  66. if((server->config.maxSubscriptionsPerSession != 0) &&
  67. (session->numSubscriptions >= server->config.maxSubscriptionsPerSession)) {
  68. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYSUBSCRIPTIONS;
  69. return;
  70. }
  71. /* Create the subscription */
  72. UA_Subscription *newSubscription = UA_Subscription_new(session, response->subscriptionId);
  73. if(!newSubscription) {
  74. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  75. "Processing CreateSubscriptionRequest failed");
  76. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  77. return;
  78. }
  79. UA_Session_addSubscription(session, newSubscription); /* Also assigns the subscription id */
  80. /* Set the subscription parameters */
  81. newSubscription->publishingEnabled = request->publishingEnabled;
  82. setSubscriptionSettings(server, newSubscription, request->requestedPublishingInterval,
  83. request->requestedLifetimeCount, request->requestedMaxKeepAliveCount,
  84. request->maxNotificationsPerPublish, request->priority);
  85. newSubscription->currentKeepAliveCount = newSubscription->maxKeepAliveCount; /* set settings first */
  86. /* Prepare the response */
  87. response->subscriptionId = newSubscription->subscriptionId;
  88. response->revisedPublishingInterval = newSubscription->publishingInterval;
  89. response->revisedLifetimeCount = newSubscription->lifeTimeCount;
  90. response->revisedMaxKeepAliveCount = newSubscription->maxKeepAliveCount;
  91. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  92. "CreateSubscriptionRequest: Created Subscription %u "
  93. "with a publishing interval of %f ms", response->subscriptionId,
  94. newSubscription->publishingInterval);
  95. }
  96. void
  97. Service_ModifySubscription(UA_Server *server, UA_Session *session,
  98. const UA_ModifySubscriptionRequest *request,
  99. UA_ModifySubscriptionResponse *response) {
  100. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing ModifySubscriptionRequest");
  101. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  102. if(!sub) {
  103. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  104. return;
  105. }
  106. setSubscriptionSettings(server, sub, request->requestedPublishingInterval,
  107. request->requestedLifetimeCount, request->requestedMaxKeepAliveCount,
  108. request->maxNotificationsPerPublish, request->priority);
  109. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  110. response->revisedPublishingInterval = sub->publishingInterval;
  111. response->revisedLifetimeCount = sub->lifeTimeCount;
  112. response->revisedMaxKeepAliveCount = sub->maxKeepAliveCount;
  113. }
  114. static void
  115. Operation_SetPublishingMode(UA_Server *Server, UA_Session *session,
  116. UA_Boolean *publishingEnabled, UA_UInt32 *subscriptionId,
  117. UA_StatusCode *result) {
  118. UA_Subscription *sub = UA_Session_getSubscriptionById(session, *subscriptionId);
  119. if(!sub) {
  120. *result = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  121. return;
  122. }
  123. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  124. sub->publishingEnabled = *publishingEnabled; /* Set the publishing mode */
  125. }
  126. void
  127. Service_SetPublishingMode(UA_Server *server, UA_Session *session,
  128. const UA_SetPublishingModeRequest *request,
  129. UA_SetPublishingModeResponse *response) {
  130. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing SetPublishingModeRequest");
  131. UA_Boolean publishingEnabled = request->publishingEnabled; /* request is const */
  132. response->responseHeader.serviceResult =
  133. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_SetPublishingMode,
  134. &publishingEnabled,
  135. &request->subscriptionIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  136. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  137. }
  138. static UA_StatusCode
  139. setMonitoredItemSettings(UA_Server *server, UA_MonitoredItem *mon,
  140. UA_MonitoringMode monitoringMode,
  141. const UA_MonitoringParameters *params,
  142. // This parameter is optional and used only if mon->lastValue is not set yet.
  143. // Then numeric type will be detected from this value. Set null as defaut.
  144. const UA_DataType* dataType) {
  145. /* Filter */
  146. if(params->filter.encoding != UA_EXTENSIONOBJECT_DECODED) {
  147. UA_DataChangeFilter_init(&(mon->filter.dataChangeFilter));
  148. mon->filter.dataChangeFilter.trigger = UA_DATACHANGETRIGGER_STATUSVALUE;
  149. } else if(params->filter.content.decoded.type == &UA_TYPES[UA_TYPES_DATACHANGEFILTER]) {
  150. UA_DataChangeFilter *filter = (UA_DataChangeFilter *)params->filter.content.decoded.data;
  151. // TODO implement EURange to support UA_DEADBANDTYPE_PERCENT
  152. if (filter->deadbandType == UA_DEADBANDTYPE_PERCENT) {
  153. return UA_STATUSCODE_BADMONITOREDITEMFILTERUNSUPPORTED;
  154. }
  155. if (UA_Variant_isEmpty(&mon->lastValue)) {
  156. if (!dataType || !isDataTypeNumeric(dataType))
  157. return UA_STATUSCODE_BADFILTERNOTALLOWED;
  158. } else
  159. if (!isDataTypeNumeric(mon->lastValue.type)) {
  160. return UA_STATUSCODE_BADFILTERNOTALLOWED;
  161. }
  162. UA_DataChangeFilter_copy(filter, &(mon->filter.dataChangeFilter));
  163. #ifdef UA_ENABLE_SUBSCRIPTIONS_EVENTS
  164. } else if (params->filter.content.decoded.type == &UA_TYPES[UA_TYPES_EVENTFILTER]) {
  165. UA_EventFilter_copy((UA_EventFilter *)params->filter.content.decoded.data,
  166. &mon->filter.eventFilter);
  167. #endif
  168. } else {
  169. return UA_STATUSCODE_BADMONITOREDITEMFILTERINVALID;
  170. }
  171. UA_MonitoredItem_unregisterSampleCallback(server, mon);
  172. mon->monitoringMode = monitoringMode;
  173. /* ClientHandle */
  174. mon->clientHandle = params->clientHandle;
  175. /* SamplingInterval */
  176. UA_Double samplingInterval = params->samplingInterval;
  177. if(mon->attributeId == UA_ATTRIBUTEID_VALUE) {
  178. mon->monitoredItemType = UA_MONITOREDITEMTYPE_CHANGENOTIFY;
  179. const UA_VariableNode *vn = (const UA_VariableNode *)
  180. UA_Nodestore_get(server, &mon->monitoredNodeId);
  181. if(vn) {
  182. if(vn->nodeClass == UA_NODECLASS_VARIABLE &&
  183. samplingInterval < vn->minimumSamplingInterval)
  184. samplingInterval = vn->minimumSamplingInterval;
  185. UA_Nodestore_release(server, (const UA_Node *)vn);
  186. }
  187. } else if(mon->attributeId == UA_ATTRIBUTEID_EVENTNOTIFIER) {
  188. /* TODO: events should not need a samplinginterval */
  189. samplingInterval = 10000.0f; // 10 seconds to reduce the load
  190. mon->monitoredItemType = UA_MONITOREDITEMTYPE_EVENTNOTIFY;
  191. } else {
  192. mon->monitoredItemType = UA_MONITOREDITEMTYPE_CHANGENOTIFY;
  193. }
  194. mon->samplingInterval = samplingInterval;
  195. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.samplingIntervalLimits,
  196. samplingInterval, mon->samplingInterval);
  197. if(samplingInterval != samplingInterval) /* Check for nan */
  198. mon->samplingInterval = server->config.samplingIntervalLimits.min;
  199. /* QueueSize */
  200. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.queueSizeLimits,
  201. params->queueSize, mon->maxQueueSize);
  202. /* DiscardOldest */
  203. mon->discardOldest = params->discardOldest;
  204. /* Register sample callback if reporting is enabled */
  205. if(monitoringMode == UA_MONITORINGMODE_REPORTING)
  206. UA_MonitoredItem_registerSampleCallback(server, mon);
  207. return UA_STATUSCODE_GOOD;
  208. }
  209. static const UA_String binaryEncoding = {sizeof("Default Binary") - 1, (UA_Byte *)"Default Binary"};
  210. #ifdef UA_ENABLE_SUBSCRIPTIONS_EVENTS
  211. static UA_StatusCode UA_Server_addMonitoredItemToNodeEditNodeCallback(UA_Server *server, UA_Session *session,
  212. UA_Node *node, void *data) {
  213. /* data is the MonitoredItem */
  214. /* SLIST_INSERT_HEAD */
  215. ((UA_MonitoredItem *)data)->next = ((UA_ObjectNode *)node)->monitoredItemQueue;
  216. ((UA_ObjectNode *)node)->monitoredItemQueue = (UA_MonitoredItem *)data;
  217. return UA_STATUSCODE_GOOD;
  218. }
  219. #endif
  220. /* Thread-local variables to pass additional arguments into the operation */
  221. struct createMonContext {
  222. UA_Subscription *sub;
  223. UA_TimestampsToReturn timestampsToReturn;
  224. /* If sub is NULL, use local callbacks */
  225. UA_Server_DataChangeNotificationCallback dataChangeCallback;
  226. void *context;
  227. };
  228. static void
  229. Operation_CreateMonitoredItem(UA_Server *server, UA_Session *session, struct createMonContext *cmc,
  230. const UA_MonitoredItemCreateRequest *request,
  231. UA_MonitoredItemCreateResult *result) {
  232. /* Check available capacity */
  233. if(server->config.maxMonitoredItemsPerSubscription != 0 && cmc->sub &&
  234. cmc->sub->monitoredItemsSize >= server->config.maxMonitoredItemsPerSubscription) {
  235. result->statusCode = UA_STATUSCODE_BADTOOMANYMONITOREDITEMS;
  236. return;
  237. }
  238. /* Make an example read to get errors in the itemToMonitor. Allow return
  239. * codes "good" and "uncertain", as well as a list of statuscodes that might
  240. * be repaired inside the data source. */
  241. UA_DataValue v = UA_Server_readWithSession(server, session, &request->itemToMonitor,
  242. cmc->timestampsToReturn);
  243. if(v.hasStatus && (v.status >> 30) > 1 &&
  244. v.status != UA_STATUSCODE_BADRESOURCEUNAVAILABLE &&
  245. v.status != UA_STATUSCODE_BADCOMMUNICATIONERROR &&
  246. v.status != UA_STATUSCODE_BADWAITINGFORINITIALDATA &&
  247. v.status != UA_STATUSCODE_BADUSERACCESSDENIED &&
  248. v.status != UA_STATUSCODE_BADNOTREADABLE &&
  249. v.status != UA_STATUSCODE_BADINDEXRANGENODATA) {
  250. result->statusCode = v.status;
  251. UA_DataValue_deleteMembers(&v);
  252. return;
  253. }
  254. /* Check if the encoding is supported */
  255. if(request->itemToMonitor.dataEncoding.name.length > 0 &&
  256. (!UA_String_equal(&binaryEncoding, &request->itemToMonitor.dataEncoding.name) ||
  257. request->itemToMonitor.dataEncoding.namespaceIndex != 0)) {
  258. result->statusCode = UA_STATUSCODE_BADDATAENCODINGUNSUPPORTED;
  259. UA_DataValue_deleteMembers(&v);
  260. return;
  261. }
  262. /* Check if the encoding is set for a value */
  263. if(request->itemToMonitor.attributeId != UA_ATTRIBUTEID_VALUE &&
  264. request->itemToMonitor.dataEncoding.name.length > 0) {
  265. result->statusCode = UA_STATUSCODE_BADDATAENCODINGINVALID;
  266. UA_DataValue_deleteMembers(&v);
  267. return;
  268. }
  269. /* Allocate the MonitoredItem */
  270. size_t nmsize = sizeof(UA_MonitoredItem);
  271. if(!cmc->sub)
  272. nmsize = sizeof(UA_LocalMonitoredItem);
  273. UA_MonitoredItem *newMon = (UA_MonitoredItem*)UA_malloc(nmsize);
  274. if(!newMon) {
  275. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  276. UA_DataValue_deleteMembers(&v);
  277. return;
  278. }
  279. /* Initialize the MonitoredItem */
  280. UA_MonitoredItem_init(newMon, cmc->sub);
  281. newMon->monitoredItemType = UA_MONITOREDITEMTYPE_CHANGENOTIFY;
  282. newMon->attributeId = request->itemToMonitor.attributeId;
  283. newMon->timestampsToReturn = cmc->timestampsToReturn;
  284. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  285. retval |= UA_NodeId_copy(&request->itemToMonitor.nodeId, &newMon->monitoredNodeId);
  286. retval |= UA_String_copy(&request->itemToMonitor.indexRange, &newMon->indexRange);
  287. retval |= setMonitoredItemSettings(server, newMon, request->monitoringMode,
  288. &request->requestedParameters, v.value.type);
  289. UA_DataValue_deleteMembers(&v);
  290. if(retval != UA_STATUSCODE_GOOD) {
  291. UA_LOG_INFO_SESSION(server->config.logger, session, "Could not create MonitoredItem "
  292. "with status code %s", UA_StatusCode_name(retval));
  293. result->statusCode = retval;
  294. UA_MonitoredItem_delete(server, newMon);
  295. return;
  296. }
  297. /* Add to the subscriptions or the local MonitoredItems */
  298. if(cmc->sub) {
  299. newMon->monitoredItemId = ++cmc->sub->lastMonitoredItemId;
  300. UA_Subscription_addMonitoredItem(cmc->sub, newMon);
  301. #ifdef UA_ENABLE_SUBSCRIPTIONS_EVENTS
  302. if (newMon->monitoredItemType == UA_MONITOREDITEMTYPE_EVENTNOTIFY) {
  303. /* insert the monitored item into the node's queue */
  304. UA_Server_editNode(server, NULL, &newMon->monitoredNodeId, UA_Server_addMonitoredItemToNodeEditNodeCallback,
  305. newMon);
  306. }
  307. #endif
  308. } else {
  309. //TODO support events for local monitored items
  310. UA_LocalMonitoredItem *localMon = (UA_LocalMonitoredItem*)newMon;
  311. localMon->context = cmc->context;
  312. localMon->callback.dataChangeCallback = cmc->dataChangeCallback;
  313. newMon->monitoredItemId = ++server->lastLocalMonitoredItemId;
  314. LIST_INSERT_HEAD(&server->localMonitoredItems, newMon, listEntry);
  315. }
  316. /* Create the first sample */
  317. if(request->monitoringMode == UA_MONITORINGMODE_REPORTING)
  318. UA_MonitoredItem_sampleCallback(server, newMon);
  319. /* Prepare the response */
  320. result->revisedSamplingInterval = newMon->samplingInterval;
  321. result->revisedQueueSize = newMon->maxQueueSize;
  322. result->monitoredItemId = newMon->monitoredItemId;
  323. }
  324. void
  325. Service_CreateMonitoredItems(UA_Server *server, UA_Session *session,
  326. const UA_CreateMonitoredItemsRequest *request,
  327. UA_CreateMonitoredItemsResponse *response) {
  328. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing CreateMonitoredItemsRequest");
  329. if(server->config.maxMonitoredItemsPerCall != 0 &&
  330. request->itemsToCreateSize > server->config.maxMonitoredItemsPerCall) {
  331. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  332. return;
  333. }
  334. /* Check if the timestampstoreturn is valid */
  335. struct createMonContext cmc;
  336. cmc.timestampsToReturn = request->timestampsToReturn;
  337. if(cmc.timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  338. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  339. return;
  340. }
  341. /* Find the subscription */
  342. cmc.sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  343. if(!cmc.sub) {
  344. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  345. return;
  346. }
  347. /* Reset the subscription lifetime */
  348. cmc.sub->currentLifetimeCount = 0;
  349. response->responseHeader.serviceResult =
  350. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_CreateMonitoredItem, &cmc,
  351. &request->itemsToCreateSize, &UA_TYPES[UA_TYPES_MONITOREDITEMCREATEREQUEST],
  352. &response->resultsSize, &UA_TYPES[UA_TYPES_MONITOREDITEMCREATERESULT]);
  353. }
  354. UA_MonitoredItemCreateResult
  355. UA_Server_createDataChangeMonitoredItem(UA_Server *server,
  356. UA_TimestampsToReturn timestampsToReturn,
  357. const UA_MonitoredItemCreateRequest item,
  358. void *monitoredItemContext,
  359. UA_Server_DataChangeNotificationCallback callback) {
  360. struct createMonContext cmc;
  361. cmc.sub = NULL;
  362. cmc.context = monitoredItemContext;
  363. cmc.dataChangeCallback = callback;
  364. cmc.timestampsToReturn = timestampsToReturn;
  365. UA_MonitoredItemCreateResult result;
  366. UA_MonitoredItemCreateResult_init(&result);
  367. Operation_CreateMonitoredItem(server, &adminSession, &cmc, &item, &result);
  368. return result;
  369. }
  370. static void
  371. Operation_ModifyMonitoredItem(UA_Server *server, UA_Session *session, UA_Subscription *sub,
  372. const UA_MonitoredItemModifyRequest *request,
  373. UA_MonitoredItemModifyResult *result) {
  374. /* Get the MonitoredItem */
  375. UA_MonitoredItem *mon = UA_Subscription_getMonitoredItem(sub, request->monitoredItemId);
  376. if(!mon) {
  377. result->statusCode = UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  378. return;
  379. }
  380. UA_StatusCode retval;
  381. retval = setMonitoredItemSettings(server, mon, mon->monitoringMode, &request->requestedParameters, NULL);
  382. if(retval != UA_STATUSCODE_GOOD) {
  383. result->statusCode = retval;
  384. return;
  385. }
  386. result->revisedSamplingInterval = mon->samplingInterval;
  387. result->revisedQueueSize = mon->maxQueueSize;
  388. /* Remove some notifications if the queue is now too small */
  389. MonitoredItem_ensureQueueSpace(server, mon);
  390. }
  391. void
  392. Service_ModifyMonitoredItems(UA_Server *server, UA_Session *session,
  393. const UA_ModifyMonitoredItemsRequest *request,
  394. UA_ModifyMonitoredItemsResponse *response) {
  395. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing ModifyMonitoredItemsRequest");
  396. if(server->config.maxMonitoredItemsPerCall != 0 &&
  397. request->itemsToModifySize > server->config.maxMonitoredItemsPerCall) {
  398. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  399. return;
  400. }
  401. /* Check if the timestampstoreturn is valid */
  402. if(request->timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  403. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  404. return;
  405. }
  406. /* Get the subscription */
  407. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  408. if(!sub) {
  409. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  410. return;
  411. }
  412. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  413. response->responseHeader.serviceResult =
  414. UA_Server_processServiceOperations(server, session,
  415. (UA_ServiceOperation)Operation_ModifyMonitoredItem, sub,
  416. &request->itemsToModifySize, &UA_TYPES[UA_TYPES_MONITOREDITEMMODIFYREQUEST],
  417. &response->resultsSize, &UA_TYPES[UA_TYPES_MONITOREDITEMMODIFYRESULT]);
  418. }
  419. struct setMonitoringContext {
  420. UA_Subscription *sub;
  421. UA_MonitoringMode monitoringMode;
  422. };
  423. static void
  424. Operation_SetMonitoringMode(UA_Server *server, UA_Session *session,
  425. struct setMonitoringContext *smc,
  426. UA_UInt32 *monitoredItemId, UA_StatusCode *result) {
  427. UA_MonitoredItem *mon = UA_Subscription_getMonitoredItem(smc->sub, *monitoredItemId);
  428. if(!mon) {
  429. *result = UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  430. return;
  431. }
  432. if(mon->monitoredItemType != UA_MONITOREDITEMTYPE_CHANGENOTIFY
  433. && mon->monitoredItemType != UA_MONITOREDITEMTYPE_EVENTNOTIFY) {
  434. *result = UA_STATUSCODE_BADNOTIMPLEMENTED;
  435. return;
  436. }
  437. /* Check if the MonitoringMode is valid or not */
  438. if(smc->monitoringMode > UA_MONITORINGMODE_REPORTING) {
  439. *result = UA_STATUSCODE_BADMONITORINGMODEINVALID;
  440. return;
  441. }
  442. if(mon->monitoringMode == smc->monitoringMode)
  443. return;
  444. mon->monitoringMode = smc->monitoringMode;
  445. if(mon->monitoringMode == UA_MONITORINGMODE_REPORTING) {
  446. UA_MonitoredItem_registerSampleCallback(server, mon);
  447. } else {
  448. UA_MonitoredItem_unregisterSampleCallback(server, mon);
  449. // TODO correctly implement SAMPLING
  450. /* Setting the mode to DISABLED or SAMPLING causes all queued Notifications to be deleted */
  451. UA_Notification *notification, *notification_tmp;
  452. TAILQ_FOREACH_SAFE(notification, &mon->queue, listEntry, notification_tmp) {
  453. UA_Notification_delete(smc->sub, mon, notification);
  454. }
  455. /* Initialize lastSampledValue */
  456. UA_ByteString_deleteMembers(&mon->lastSampledValue);
  457. UA_Variant_deleteMembers(&mon->lastValue);
  458. }
  459. }
  460. void
  461. Service_SetMonitoringMode(UA_Server *server, UA_Session *session,
  462. const UA_SetMonitoringModeRequest *request,
  463. UA_SetMonitoringModeResponse *response) {
  464. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing SetMonitoringMode");
  465. if(server->config.maxMonitoredItemsPerCall != 0 &&
  466. request->monitoredItemIdsSize > server->config.maxMonitoredItemsPerCall) {
  467. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  468. return;
  469. }
  470. /* Get the subscription */
  471. struct setMonitoringContext smc;
  472. smc.sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  473. if(!smc.sub) {
  474. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  475. return;
  476. }
  477. smc.sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  478. smc.monitoringMode = request->monitoringMode;
  479. response->responseHeader.serviceResult =
  480. UA_Server_processServiceOperations(server, session,
  481. (UA_ServiceOperation)Operation_SetMonitoringMode, &smc,
  482. &request->monitoredItemIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  483. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  484. }
  485. /* TODO: Unify with senderror in ua_server_binary.c */
  486. static void
  487. subscriptionSendError(UA_SecureChannel *channel, UA_UInt32 requestHandle,
  488. UA_UInt32 requestId, UA_StatusCode error) {
  489. UA_PublishResponse err_response;
  490. UA_PublishResponse_init(&err_response);
  491. err_response.responseHeader.requestHandle = requestHandle;
  492. err_response.responseHeader.timestamp = UA_DateTime_now();
  493. err_response.responseHeader.serviceResult = error;
  494. UA_SecureChannel_sendSymmetricMessage(channel, requestId, UA_MESSAGETYPE_MSG,
  495. &err_response, &UA_TYPES[UA_TYPES_PUBLISHRESPONSE]);
  496. }
  497. void
  498. Service_Publish(UA_Server *server, UA_Session *session,
  499. const UA_PublishRequest *request, UA_UInt32 requestId) {
  500. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing PublishRequest");
  501. /* Return an error if the session has no subscription */
  502. if(LIST_EMPTY(&session->serverSubscriptions)) {
  503. subscriptionSendError(session->header.channel, request->requestHeader.requestHandle,
  504. requestId, UA_STATUSCODE_BADNOSUBSCRIPTION);
  505. return;
  506. }
  507. /* Handle too many subscriptions to free resources before trying to allocate
  508. * resources for the new publish request. If the limit has been reached the
  509. * oldest publish request shall be responded */
  510. if((server->config.maxPublishReqPerSession != 0) &&
  511. (session->numPublishReq >= server->config.maxPublishReqPerSession)) {
  512. if(!UA_Subscription_reachedPublishReqLimit(server, session)) {
  513. subscriptionSendError(session->header.channel, requestId,
  514. request->requestHeader.requestHandle,
  515. UA_STATUSCODE_BADINTERNALERROR);
  516. return;
  517. }
  518. }
  519. /* Allocate the response to store it in the retransmission queue */
  520. UA_PublishResponseEntry *entry = (UA_PublishResponseEntry *)
  521. UA_malloc(sizeof(UA_PublishResponseEntry));
  522. if(!entry) {
  523. subscriptionSendError(session->header.channel, requestId,
  524. request->requestHeader.requestHandle,
  525. UA_STATUSCODE_BADOUTOFMEMORY);
  526. return;
  527. }
  528. /* Prepare the response */
  529. entry->requestId = requestId;
  530. UA_PublishResponse *response = &entry->response;
  531. UA_PublishResponse_init(response);
  532. response->responseHeader.requestHandle = request->requestHeader.requestHandle;
  533. /* Allocate the results array to acknowledge the acknowledge */
  534. if(request->subscriptionAcknowledgementsSize > 0) {
  535. response->results = (UA_StatusCode *)
  536. UA_Array_new(request->subscriptionAcknowledgementsSize,
  537. &UA_TYPES[UA_TYPES_STATUSCODE]);
  538. if(!response->results) {
  539. UA_free(entry);
  540. subscriptionSendError(session->header.channel, requestId,
  541. request->requestHeader.requestHandle,
  542. UA_STATUSCODE_BADOUTOFMEMORY);
  543. return;
  544. }
  545. response->resultsSize = request->subscriptionAcknowledgementsSize;
  546. }
  547. /* Delete Acknowledged Subscription Messages */
  548. for(size_t i = 0; i < request->subscriptionAcknowledgementsSize; ++i) {
  549. UA_SubscriptionAcknowledgement *ack = &request->subscriptionAcknowledgements[i];
  550. UA_Subscription *sub = UA_Session_getSubscriptionById(session, ack->subscriptionId);
  551. if(!sub) {
  552. response->results[i] = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  553. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  554. "Cannot process acknowledgements subscription %u",
  555. ack->subscriptionId);
  556. continue;
  557. }
  558. /* Remove the acked transmission from the retransmission queue */
  559. response->results[i] = UA_Subscription_removeRetransmissionMessage(sub, ack->sequenceNumber);
  560. }
  561. /* Queue the publish response. It will be dequeued in a repeated publish
  562. * callback. This can also be triggered right now for a late
  563. * subscription. */
  564. UA_Session_queuePublishReq(session, entry, false);
  565. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Queued a publication message");
  566. /* If there are late subscriptions, the new publish request is used to
  567. * answer them immediately. However, a single subscription that generates
  568. * many notifications must not "starve" other late subscriptions. Therefore
  569. * we keep track of the last subscription that got preferential treatment.
  570. * We start searching for late subscriptions **after** the last one. */
  571. UA_Subscription *immediate = NULL;
  572. if(session->lastSeenSubscriptionId > 0) {
  573. LIST_FOREACH(immediate, &session->serverSubscriptions, listEntry) {
  574. if(immediate->subscriptionId == session->lastSeenSubscriptionId) {
  575. immediate = LIST_NEXT(immediate, listEntry);
  576. break;
  577. }
  578. }
  579. }
  580. /* If no entry was found, start at the beginning and don't restart */
  581. UA_Boolean found = false;
  582. if(!immediate)
  583. immediate = LIST_FIRST(&session->serverSubscriptions);
  584. else
  585. found = true;
  586. repeat:
  587. while(immediate) {
  588. if(immediate->state == UA_SUBSCRIPTIONSTATE_LATE) {
  589. session->lastSeenSubscriptionId = immediate->subscriptionId;
  590. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  591. "Subscription %u | Response on a late subscription",
  592. immediate->subscriptionId);
  593. UA_Subscription_publish(server, immediate);
  594. return;
  595. }
  596. immediate = LIST_NEXT(immediate, listEntry);
  597. }
  598. /* Restart at the beginning of the list */
  599. if(found) {
  600. immediate = LIST_FIRST(&session->serverSubscriptions);
  601. found = false;
  602. goto repeat;
  603. }
  604. /* No late subscription this time */
  605. session->lastSeenSubscriptionId = 0;
  606. }
  607. static void
  608. Operation_DeleteSubscription(UA_Server *server, UA_Session *session, void *_,
  609. UA_UInt32 *subscriptionId, UA_StatusCode *result) {
  610. *result = UA_Session_deleteSubscription(server, session, *subscriptionId);
  611. if(*result == UA_STATUSCODE_GOOD) {
  612. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  613. "Subscription %u | Subscription deleted",
  614. *subscriptionId);
  615. } else {
  616. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  617. "Deleting Subscription with Id %u failed with error code %s",
  618. *subscriptionId, UA_StatusCode_name(*result));
  619. }
  620. }
  621. void
  622. Service_DeleteSubscriptions(UA_Server *server, UA_Session *session,
  623. const UA_DeleteSubscriptionsRequest *request,
  624. UA_DeleteSubscriptionsResponse *response) {
  625. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing DeleteSubscriptionsRequest");
  626. response->responseHeader.serviceResult =
  627. UA_Server_processServiceOperations(server, session,
  628. (UA_ServiceOperation)Operation_DeleteSubscription, NULL,
  629. &request->subscriptionIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  630. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  631. /* The session has at least one subscription */
  632. if(LIST_FIRST(&session->serverSubscriptions))
  633. return;
  634. /* Send remaining publish responses if the last subscription was removed */
  635. UA_Subscription_answerPublishRequestsNoSubscription(server, session);
  636. }
  637. static void
  638. Operation_DeleteMonitoredItem(UA_Server *server, UA_Session *session, UA_Subscription *sub,
  639. UA_UInt32 *monitoredItemId, UA_StatusCode *result) {
  640. *result = UA_Subscription_deleteMonitoredItem(server, sub, *monitoredItemId);
  641. }
  642. void
  643. Service_DeleteMonitoredItems(UA_Server *server, UA_Session *session,
  644. const UA_DeleteMonitoredItemsRequest *request,
  645. UA_DeleteMonitoredItemsResponse *response) {
  646. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing DeleteMonitoredItemsRequest");
  647. if(server->config.maxMonitoredItemsPerCall != 0 &&
  648. request->monitoredItemIdsSize > server->config.maxMonitoredItemsPerCall) {
  649. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  650. return;
  651. }
  652. /* Get the subscription */
  653. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  654. if(!sub) {
  655. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  656. return;
  657. }
  658. /* Reset the subscription lifetime */
  659. sub->currentLifetimeCount = 0;
  660. response->responseHeader.serviceResult =
  661. UA_Server_processServiceOperations(server, session,
  662. (UA_ServiceOperation)Operation_DeleteMonitoredItem, sub,
  663. &request->monitoredItemIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  664. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  665. }
  666. UA_StatusCode
  667. UA_Server_deleteMonitoredItem(UA_Server *server, UA_UInt32 monitoredItemId) {
  668. UA_MonitoredItem *mon;
  669. LIST_FOREACH(mon, &server->localMonitoredItems, listEntry) {
  670. if(mon->monitoredItemId != monitoredItemId)
  671. continue;
  672. LIST_REMOVE(mon, listEntry);
  673. UA_MonitoredItem_delete(server, mon);
  674. return UA_STATUSCODE_GOOD;
  675. }
  676. return UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  677. }
  678. void
  679. Service_Republish(UA_Server *server, UA_Session *session, const UA_RepublishRequest *request,
  680. UA_RepublishResponse *response) {
  681. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing RepublishRequest");
  682. /* Get the subscription */
  683. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  684. if(!sub) {
  685. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  686. return;
  687. }
  688. /* Reset the subscription lifetime */
  689. sub->currentLifetimeCount = 0;
  690. /* Find the notification in the retransmission queue */
  691. UA_NotificationMessageEntry *entry;
  692. TAILQ_FOREACH(entry, &sub->retransmissionQueue, listEntry) {
  693. if(entry->message.sequenceNumber == request->retransmitSequenceNumber)
  694. break;
  695. }
  696. if(!entry) {
  697. response->responseHeader.serviceResult = UA_STATUSCODE_BADMESSAGENOTAVAILABLE;
  698. return;
  699. }
  700. response->responseHeader.serviceResult =
  701. UA_NotificationMessage_copy(&entry->message, &response->notificationMessage);
  702. }
  703. #endif /* UA_ENABLE_SUBSCRIPTIONS */