ua_services_subscription.c 37 KB

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