ua_services_subscription.c 31 KB

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