ua_services_attribute.c 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772
  1. #include "ua_server_internal.h"
  2. #include "ua_services.h"
  3. /******************/
  4. /* Read Attribute */
  5. /******************/
  6. static size_t
  7. readNumber(UA_Byte *buf, size_t buflen, UA_UInt32 *number) {
  8. UA_UInt32 n = 0;
  9. size_t progress = 0;
  10. /* read numbers until the end or a non-number character appears */
  11. while(progress < buflen) {
  12. UA_Byte c = buf[progress];
  13. if('0' > c || '9' < c)
  14. break;
  15. n = (n*10) + (UA_UInt32)(c-'0');
  16. progress++;
  17. }
  18. *number = n;
  19. return progress;
  20. }
  21. static size_t
  22. readDimension(UA_Byte *buf, size_t buflen, struct UA_NumericRangeDimension *dim) {
  23. size_t progress = readNumber(buf, buflen, &dim->min);
  24. if(progress == 0)
  25. return 0;
  26. if(buflen <= progress + 1 || buf[progress] != ':') {
  27. dim->max = dim->min;
  28. return progress;
  29. }
  30. progress++;
  31. size_t progress2 = readNumber(&buf[progress], buflen - progress, &dim->max);
  32. if(progress2 == 0)
  33. return 0;
  34. /* invalid range */
  35. if(dim->min >= dim->max)
  36. return 0;
  37. return progress + progress2;
  38. }
  39. #ifndef UA_BUILD_UNIT_TESTS
  40. static
  41. #endif
  42. UA_StatusCode parse_numericrange(const UA_String *str, UA_NumericRange *range) {
  43. size_t idx = 0;
  44. size_t dimensionsMax = 0;
  45. struct UA_NumericRangeDimension *dimensions = NULL;
  46. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  47. size_t pos = 0;
  48. while(true) {
  49. /* alloc dimensions */
  50. if(idx >= dimensionsMax) {
  51. struct UA_NumericRangeDimension *newds;
  52. newds = UA_realloc(dimensions, sizeof(struct UA_NumericRangeDimension) * (dimensionsMax + 2));
  53. if(!newds) {
  54. retval = UA_STATUSCODE_BADOUTOFMEMORY;
  55. break;
  56. }
  57. dimensions = newds;
  58. dimensionsMax = dimensionsMax + 2;
  59. }
  60. /* read the dimension */
  61. size_t progress = readDimension(&str->data[pos], str->length - pos, &dimensions[idx]);
  62. if(progress == 0) {
  63. retval = UA_STATUSCODE_BADINDEXRANGEINVALID;
  64. break;
  65. }
  66. pos += progress;
  67. idx++;
  68. /* loop into the next dimension */
  69. if(pos >= str->length)
  70. break;
  71. if(str->data[pos] != ',') {
  72. retval = UA_STATUSCODE_BADINDEXRANGEINVALID;
  73. break;
  74. }
  75. pos++;
  76. }
  77. if(retval == UA_STATUSCODE_GOOD && idx > 0) {
  78. range->dimensions = dimensions;
  79. range->dimensionsSize = idx;
  80. } else
  81. UA_free(dimensions);
  82. return retval;
  83. }
  84. #define CHECK_NODECLASS(CLASS) \
  85. if(!(node->nodeClass & (CLASS))) { \
  86. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID; \
  87. break; \
  88. }
  89. static void handleServerTimestamps(UA_TimestampsToReturn timestamps, UA_DataValue* v) {
  90. if(v && (timestamps == UA_TIMESTAMPSTORETURN_SERVER || timestamps == UA_TIMESTAMPSTORETURN_BOTH)) {
  91. v->hasServerTimestamp = true;
  92. v->serverTimestamp = UA_DateTime_now();
  93. }
  94. }
  95. static void handleSourceTimestamps(UA_TimestampsToReturn timestamps, UA_DataValue* v) {
  96. if(timestamps == UA_TIMESTAMPSTORETURN_SOURCE || timestamps == UA_TIMESTAMPSTORETURN_BOTH) {
  97. v->hasSourceTimestamp = true;
  98. v->sourceTimestamp = UA_DateTime_now();
  99. }
  100. }
  101. /* force cast for zero-copy reading. ensure that the variant is never written into. */
  102. static void forceVariantSetScalar(UA_Variant *v, const void *p, const UA_DataType *t) {
  103. UA_Variant_init(v);
  104. v->type = t;
  105. v->data = (void*)(uintptr_t)p;
  106. v->storageType = UA_VARIANT_DATA_NODELETE;
  107. }
  108. static UA_StatusCode
  109. getVariableNodeValue(UA_Server *server, UA_Session *session, const UA_VariableNode *vn,
  110. const UA_TimestampsToReturn timestamps, const UA_ReadValueId *id, UA_DataValue *v) {
  111. UA_NumericRange range;
  112. UA_NumericRange *rangeptr = NULL;
  113. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  114. if(id->indexRange.length > 0) {
  115. retval = parse_numericrange(&id->indexRange, &range);
  116. if(retval != UA_STATUSCODE_GOOD)
  117. return retval;
  118. rangeptr = &range;
  119. }
  120. if(vn->valueSource == UA_VALUESOURCE_VARIANT) {
  121. if(vn->value.variant.callback.onRead)
  122. vn->value.variant.callback.onRead(vn->value.variant.callback.handle, vn->nodeId,
  123. &v->value, rangeptr);
  124. if(!rangeptr) {
  125. v->value = vn->value.variant.value;
  126. v->value.storageType = UA_VARIANT_DATA_NODELETE;
  127. } else
  128. retval = UA_Variant_copyRange(&vn->value.variant.value, &v->value, range);
  129. if(retval == UA_STATUSCODE_GOOD)
  130. handleSourceTimestamps(timestamps, v);
  131. } else {
  132. if(!vn->value.dataSource.read) {
  133. UA_LOG_DEBUG_SESSION(server->config.logger, session, "DataSource cannot be read in ReadRequest");
  134. retval = UA_STATUSCODE_BADINTERNALERROR;
  135. } else {
  136. UA_Boolean sourceTimeStamp = (timestamps == UA_TIMESTAMPSTORETURN_SOURCE ||
  137. timestamps == UA_TIMESTAMPSTORETURN_BOTH);
  138. retval = vn->value.dataSource.read(vn->value.dataSource.handle, vn->nodeId,
  139. sourceTimeStamp, rangeptr, v);
  140. }
  141. }
  142. if(rangeptr)
  143. UA_free(range.dimensions);
  144. return retval;
  145. }
  146. static UA_StatusCode
  147. getVariableNodeDataType(UA_Server *server, UA_Session *session,
  148. const UA_VariableNode *vn, UA_DataValue *v) {
  149. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  150. if(vn->valueSource == UA_VALUESOURCE_VARIANT) {
  151. if(vn->value.variant.value.type) {
  152. forceVariantSetScalar(&v->value, &vn->value.variant.value.type->typeId, &UA_TYPES[UA_TYPES_NODEID]);
  153. } else {
  154. UA_NodeId nullid;
  155. UA_NodeId_init(&nullid);
  156. UA_Variant_setScalarCopy(&v->value, &nullid, &UA_TYPES[UA_TYPES_NODEID]);
  157. }
  158. } else {
  159. /* Read from the datasource to see the data type */
  160. if(!vn->value.dataSource.read) {
  161. UA_LOG_DEBUG_SESSION(server->config.logger, session, "DataSource cannot be read in ReadRequest");
  162. return UA_STATUSCODE_BADINTERNALERROR;
  163. }
  164. UA_DataValue val;
  165. UA_DataValue_init(&val);
  166. val.hasValue = false; // always assume we are not given a value by userspace
  167. retval = vn->value.dataSource.read(vn->value.dataSource.handle, vn->nodeId, false, NULL, &val);
  168. if(retval != UA_STATUSCODE_GOOD)
  169. return retval;
  170. if(val.hasValue && val.value.type)
  171. retval = UA_Variant_setScalarCopy(&v->value, &val.value.type->typeId, &UA_TYPES[UA_TYPES_NODEID]);
  172. UA_DataValue_deleteMembers(&val);
  173. }
  174. return retval;
  175. }
  176. static UA_StatusCode
  177. getVariableNodeArrayDimensions(UA_Server *server, UA_Session *session,
  178. const UA_VariableNode *vn, UA_DataValue *v) {
  179. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  180. if(vn->valueSource == UA_VALUESOURCE_VARIANT) {
  181. UA_Variant_setArray(&v->value, vn->value.variant.value.arrayDimensions,
  182. vn->value.variant.value.arrayDimensionsSize, &UA_TYPES[UA_TYPES_INT32]);
  183. v->value.storageType = UA_VARIANT_DATA_NODELETE;
  184. } else {
  185. if(!vn->value.dataSource.read) {
  186. UA_LOG_DEBUG_SESSION(server->config.logger, session, "DataSource cannot be read in ReadRequest");
  187. return UA_STATUSCODE_BADINTERNALERROR;
  188. }
  189. /* Read the datasource to see the array dimensions */
  190. UA_DataValue val;
  191. UA_DataValue_init(&val);
  192. retval = vn->value.dataSource.read(vn->value.dataSource.handle, vn->nodeId, false, NULL, &val);
  193. if(retval != UA_STATUSCODE_GOOD)
  194. return retval;
  195. retval = UA_Variant_setArrayCopy(&v->value, val.value.arrayDimensions,
  196. val.value.arrayDimensionsSize, &UA_TYPES[UA_TYPES_INT32]);
  197. UA_DataValue_deleteMembers(&val);
  198. }
  199. return retval;
  200. }
  201. static const UA_String binEncoding = {sizeof("DefaultBinary")-1, (UA_Byte*)"DefaultBinary"};
  202. /* clang complains about unused variables */
  203. // static const UA_String xmlEncoding = {sizeof("DefaultXml")-1, (UA_Byte*)"DefaultXml"};
  204. /* Reads a single attribute from a node in the nodestore */
  205. void Service_Read_single(UA_Server *server, UA_Session *session,
  206. const UA_TimestampsToReturn timestamps,
  207. const UA_ReadValueId *id, UA_DataValue *v) {
  208. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Read the attribute %i", id->attributeId);
  209. if(id->dataEncoding.name.length > 0 &&
  210. !UA_String_equal(&binEncoding, &id->dataEncoding.name)) {
  211. v->hasStatus = true;
  212. v->status = UA_STATUSCODE_BADDATAENCODINGUNSUPPORTED;
  213. return;
  214. }
  215. /* index range for a non-value */
  216. if(id->indexRange.length > 0 && id->attributeId != UA_ATTRIBUTEID_VALUE){
  217. v->hasStatus = true;
  218. v->status = UA_STATUSCODE_BADINDEXRANGENODATA;
  219. return;
  220. }
  221. UA_Node const *node = UA_NodeStore_get(server->nodestore, &id->nodeId);
  222. if(!node) {
  223. v->hasStatus = true;
  224. v->status = UA_STATUSCODE_BADNODEIDUNKNOWN;
  225. return;
  226. }
  227. /* When setting the value fails in the switch, we get an error code and set hasValue to false */
  228. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  229. v->hasValue = true;
  230. switch(id->attributeId) {
  231. case UA_ATTRIBUTEID_NODEID:
  232. forceVariantSetScalar(&v->value, &node->nodeId, &UA_TYPES[UA_TYPES_NODEID]);
  233. break;
  234. case UA_ATTRIBUTEID_NODECLASS:
  235. forceVariantSetScalar(&v->value, &node->nodeClass, &UA_TYPES[UA_TYPES_NODECLASS]);
  236. break;
  237. case UA_ATTRIBUTEID_BROWSENAME:
  238. forceVariantSetScalar(&v->value, &node->browseName, &UA_TYPES[UA_TYPES_QUALIFIEDNAME]);
  239. break;
  240. case UA_ATTRIBUTEID_DISPLAYNAME:
  241. forceVariantSetScalar(&v->value, &node->displayName, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  242. break;
  243. case UA_ATTRIBUTEID_DESCRIPTION:
  244. forceVariantSetScalar(&v->value, &node->description, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  245. break;
  246. case UA_ATTRIBUTEID_WRITEMASK:
  247. forceVariantSetScalar(&v->value, &node->writeMask, &UA_TYPES[UA_TYPES_UINT32]);
  248. break;
  249. case UA_ATTRIBUTEID_USERWRITEMASK:
  250. forceVariantSetScalar(&v->value, &node->userWriteMask, &UA_TYPES[UA_TYPES_UINT32]);
  251. break;
  252. case UA_ATTRIBUTEID_ISABSTRACT:
  253. CHECK_NODECLASS(UA_NODECLASS_REFERENCETYPE | UA_NODECLASS_OBJECTTYPE |
  254. UA_NODECLASS_VARIABLETYPE | UA_NODECLASS_DATATYPE);
  255. forceVariantSetScalar(&v->value, &((const UA_ReferenceTypeNode*)node)->isAbstract,
  256. &UA_TYPES[UA_TYPES_BOOLEAN]);
  257. break;
  258. case UA_ATTRIBUTEID_SYMMETRIC:
  259. CHECK_NODECLASS(UA_NODECLASS_REFERENCETYPE);
  260. forceVariantSetScalar(&v->value, &((const UA_ReferenceTypeNode*)node)->symmetric,
  261. &UA_TYPES[UA_TYPES_BOOLEAN]);
  262. break;
  263. case UA_ATTRIBUTEID_INVERSENAME:
  264. CHECK_NODECLASS(UA_NODECLASS_REFERENCETYPE);
  265. forceVariantSetScalar(&v->value, &((const UA_ReferenceTypeNode*)node)->inverseName,
  266. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  267. break;
  268. case UA_ATTRIBUTEID_CONTAINSNOLOOPS:
  269. CHECK_NODECLASS(UA_NODECLASS_VIEW);
  270. forceVariantSetScalar(&v->value, &((const UA_ViewNode*)node)->containsNoLoops,
  271. &UA_TYPES[UA_TYPES_BOOLEAN]);
  272. break;
  273. case UA_ATTRIBUTEID_EVENTNOTIFIER:
  274. CHECK_NODECLASS(UA_NODECLASS_VIEW | UA_NODECLASS_OBJECT);
  275. forceVariantSetScalar(&v->value, &((const UA_ViewNode*)node)->eventNotifier,
  276. &UA_TYPES[UA_TYPES_BYTE]);
  277. break;
  278. case UA_ATTRIBUTEID_VALUE:
  279. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  280. retval = getVariableNodeValue(server, session, (const UA_VariableNode*)node, timestamps, id, v);
  281. break;
  282. case UA_ATTRIBUTEID_DATATYPE:
  283. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  284. retval = getVariableNodeDataType(server, session, (const UA_VariableNode*)node, v);
  285. break;
  286. case UA_ATTRIBUTEID_VALUERANK:
  287. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  288. forceVariantSetScalar(&v->value, &((const UA_VariableTypeNode*)node)->valueRank,
  289. &UA_TYPES[UA_TYPES_INT32]);
  290. break;
  291. case UA_ATTRIBUTEID_ARRAYDIMENSIONS:
  292. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  293. retval = getVariableNodeArrayDimensions(server, session, (const UA_VariableNode*)node, v);
  294. break;
  295. case UA_ATTRIBUTEID_ACCESSLEVEL:
  296. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  297. forceVariantSetScalar(&v->value, &((const UA_VariableNode*)node)->accessLevel,
  298. &UA_TYPES[UA_TYPES_BYTE]);
  299. break;
  300. case UA_ATTRIBUTEID_USERACCESSLEVEL:
  301. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  302. forceVariantSetScalar(&v->value, &((const UA_VariableNode*)node)->userAccessLevel,
  303. &UA_TYPES[UA_TYPES_BYTE]);
  304. break;
  305. case UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL:
  306. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  307. forceVariantSetScalar(&v->value, &((const UA_VariableNode*)node)->minimumSamplingInterval,
  308. &UA_TYPES[UA_TYPES_DOUBLE]);
  309. break;
  310. case UA_ATTRIBUTEID_HISTORIZING:
  311. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  312. forceVariantSetScalar(&v->value, &((const UA_VariableNode*)node)->historizing,
  313. &UA_TYPES[UA_TYPES_BOOLEAN]);
  314. break;
  315. case UA_ATTRIBUTEID_EXECUTABLE:
  316. CHECK_NODECLASS(UA_NODECLASS_METHOD);
  317. forceVariantSetScalar(&v->value, &((const UA_MethodNode*)node)->executable,
  318. &UA_TYPES[UA_TYPES_BOOLEAN]);
  319. break;
  320. case UA_ATTRIBUTEID_USEREXECUTABLE:
  321. CHECK_NODECLASS(UA_NODECLASS_METHOD);
  322. forceVariantSetScalar(&v->value, &((const UA_MethodNode*)node)->userExecutable,
  323. &UA_TYPES[UA_TYPES_BOOLEAN]);
  324. break;
  325. default:
  326. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  327. break;
  328. }
  329. if(retval != UA_STATUSCODE_GOOD) {
  330. v->hasValue = false;
  331. v->hasStatus = true;
  332. v->status = retval;
  333. }
  334. // Todo: what if the timestamp from the datasource are already present?
  335. handleServerTimestamps(timestamps, v);
  336. }
  337. void Service_Read(UA_Server *server, UA_Session *session,
  338. const UA_ReadRequest *request, UA_ReadResponse *response) {
  339. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing ReadRequest");
  340. if(request->nodesToReadSize <= 0) {
  341. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  342. return;
  343. }
  344. /* check if the timestampstoreturn is valid */
  345. if(request->timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  346. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  347. return;
  348. }
  349. size_t size = request->nodesToReadSize;
  350. response->results = UA_Array_new(size, &UA_TYPES[UA_TYPES_DATAVALUE]);
  351. if(!response->results) {
  352. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  353. return;
  354. }
  355. response->resultsSize = size;
  356. if(request->maxAge < 0) {
  357. response->responseHeader.serviceResult = UA_STATUSCODE_BADMAXAGEINVALID;
  358. return;
  359. }
  360. #ifdef UA_ENABLE_EXTERNAL_NAMESPACES
  361. UA_Boolean isExternal[size];
  362. UA_UInt32 indices[size];
  363. memset(isExternal, false, sizeof(UA_Boolean) * size);
  364. for(size_t j = 0;j<server->externalNamespacesSize;j++) {
  365. size_t indexSize = 0;
  366. for(size_t i = 0;i < size;i++) {
  367. if(request->nodesToRead[i].nodeId.namespaceIndex != server->externalNamespaces[j].index)
  368. continue;
  369. isExternal[i] = true;
  370. indices[indexSize] = (UA_UInt32)i;
  371. indexSize++;
  372. }
  373. if(indexSize == 0)
  374. continue;
  375. UA_ExternalNodeStore *ens = &server->externalNamespaces[j].externalNodeStore;
  376. ens->readNodes(ens->ensHandle, &request->requestHeader, request->nodesToRead,
  377. indices, (UA_UInt32)indexSize, response->results, false, response->diagnosticInfos);
  378. }
  379. #endif
  380. for(size_t i = 0;i < size;i++) {
  381. #ifdef UA_ENABLE_EXTERNAL_NAMESPACES
  382. if(!isExternal[i])
  383. #endif
  384. Service_Read_single(server, session, request->timestampsToReturn,
  385. &request->nodesToRead[i], &response->results[i]);
  386. }
  387. #ifdef UA_ENABLE_NONSTANDARD_STATELESS
  388. /* Add an expiry header for caching */
  389. if(session->sessionId.namespaceIndex == 0 &&
  390. session->sessionId.identifierType == UA_NODEIDTYPE_NUMERIC &&
  391. session->sessionId.identifier.numeric == 0){
  392. UA_ExtensionObject additionalHeader;
  393. UA_ExtensionObject_init(&additionalHeader);
  394. additionalHeader.encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
  395. additionalHeader.content.encoded.typeId =UA_TYPES[UA_TYPES_VARIANT].typeId;
  396. UA_Variant variant;
  397. UA_Variant_init(&variant);
  398. UA_DateTime* expireArray = NULL;
  399. expireArray = UA_Array_new(request->nodesToReadSize, &UA_TYPES[UA_TYPES_DATETIME]);
  400. variant.data = expireArray;
  401. /* expires in 20 seconds */
  402. for(UA_UInt32 i = 0;i < response->resultsSize;i++) {
  403. expireArray[i] = UA_DateTime_now() + 20 * 100 * 1000 * 1000;
  404. }
  405. UA_Variant_setArray(&variant, expireArray, request->nodesToReadSize, &UA_TYPES[UA_TYPES_DATETIME]);
  406. size_t offset = 0;
  407. UA_ByteString str;
  408. UA_ByteString_allocBuffer(&str, UA_calcSizeBinary(&variant, &UA_TYPES[UA_TYPES_VARIANT]));
  409. /* No chunking callback for the encoding */
  410. UA_StatusCode retval = UA_encodeBinary(&variant, &UA_TYPES[UA_TYPES_VARIANT], NULL, NULL, &str, &offset);
  411. UA_Array_delete(expireArray, request->nodesToReadSize, &UA_TYPES[UA_TYPES_DATETIME]);
  412. if(retval == UA_STATUSCODE_GOOD){
  413. additionalHeader.content.encoded.body.data = str.data;
  414. additionalHeader.content.encoded.body.length = offset;
  415. response->responseHeader.additionalHeader = additionalHeader;
  416. }
  417. }
  418. #endif
  419. }
  420. /*******************/
  421. /* Write Attribute */
  422. /*******************/
  423. UA_StatusCode UA_Server_editNode(UA_Server *server, UA_Session *session, const UA_NodeId *nodeId,
  424. UA_EditNodeCallback callback, const void *data) {
  425. UA_StatusCode retval;
  426. do {
  427. #ifndef UA_ENABLE_MULTITHREADING
  428. const UA_Node *node = UA_NodeStore_get(server->nodestore, nodeId);
  429. if(!node)
  430. return UA_STATUSCODE_BADNODEIDUNKNOWN;
  431. UA_Node *editNode = (UA_Node*)(uintptr_t)node; // dirty cast. use only here.
  432. retval = callback(server, session, editNode, data);
  433. return retval;
  434. #else
  435. UA_Node *copy = UA_NodeStore_getCopy(server->nodestore, nodeId);
  436. if(!copy)
  437. return UA_STATUSCODE_BADOUTOFMEMORY;
  438. retval = callback(server, session, copy, data);
  439. if(retval != UA_STATUSCODE_GOOD) {
  440. UA_NodeStore_deleteNode(copy);
  441. return retval;
  442. }
  443. retval = UA_NodeStore_replace(server->nodestore, copy);
  444. #endif
  445. } while(retval != UA_STATUSCODE_GOOD);
  446. return UA_STATUSCODE_GOOD;
  447. }
  448. #define CHECK_DATATYPE(EXP_DT) \
  449. if(!wvalue->value.hasValue || \
  450. &UA_TYPES[UA_TYPES_##EXP_DT] != wvalue->value.value.type || \
  451. !UA_Variant_isScalar(&wvalue->value.value)) { \
  452. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  453. break; \
  454. }
  455. #define CHECK_NODECLASS_WRITE(CLASS) \
  456. if((node->nodeClass & (CLASS)) == 0) { \
  457. retval = UA_STATUSCODE_BADNODECLASSINVALID; \
  458. break; \
  459. }
  460. static UA_StatusCode
  461. Service_Write_single_ValueDataSource(UA_Server *server, UA_Session *session, const UA_VariableNode *node,
  462. const UA_WriteValue *wvalue) {
  463. UA_assert(wvalue->attributeId == UA_ATTRIBUTEID_VALUE);
  464. UA_assert(node->nodeClass == UA_NODECLASS_VARIABLE || node->nodeClass == UA_NODECLASS_VARIABLETYPE);
  465. UA_assert(node->valueSource == UA_VALUESOURCE_DATASOURCE);
  466. if(node->value.dataSource.write == NULL)
  467. return UA_STATUSCODE_BADWRITENOTSUPPORTED;
  468. UA_StatusCode retval;
  469. if(wvalue->indexRange.length <= 0) {
  470. retval = node->value.dataSource.write(node->value.dataSource.handle, node->nodeId,
  471. &wvalue->value.value, NULL);
  472. } else {
  473. UA_NumericRange range;
  474. retval = parse_numericrange(&wvalue->indexRange, &range);
  475. if(retval != UA_STATUSCODE_GOOD)
  476. return retval;
  477. retval = node->value.dataSource.write(node->value.dataSource.handle, node->nodeId,
  478. &wvalue->value.value, &range);
  479. UA_free(range.dimensions);
  480. }
  481. return retval;
  482. }
  483. enum type_equivalence {
  484. TYPE_EQUIVALENCE_NONE,
  485. TYPE_EQUIVALENCE_ENUM,
  486. TYPE_EQUIVALENCE_OPAQUE
  487. };
  488. static enum type_equivalence typeEquivalence(const UA_DataType *t) {
  489. if(t->membersSize != 1 || !t->members[0].namespaceZero)
  490. return TYPE_EQUIVALENCE_NONE;
  491. if(t->members[0].memberTypeIndex == UA_TYPES_INT32)
  492. return TYPE_EQUIVALENCE_ENUM;
  493. if(t->members[0].memberTypeIndex == UA_TYPES_BYTE && t->members[0].isArray)
  494. return TYPE_EQUIVALENCE_OPAQUE;
  495. return TYPE_EQUIVALENCE_NONE;
  496. }
  497. static UA_StatusCode
  498. CopyValueIntoNode(UA_VariableNode *node, const UA_WriteValue *wvalue) {
  499. UA_assert(wvalue->attributeId == UA_ATTRIBUTEID_VALUE);
  500. UA_assert(node->nodeClass == UA_NODECLASS_VARIABLE || node->nodeClass == UA_NODECLASS_VARIABLETYPE);
  501. UA_assert(node->valueSource == UA_VALUESOURCE_VARIANT);
  502. UA_Variant *oldV = &node->value.variant.value;
  503. /* Don't run NodeId_equal on a NULL pointer (happens if the variable never
  504. held a variant) */
  505. if(!oldV->type)
  506. return UA_STATUSCODE_BADINTERNALERROR;
  507. /* Parse the range */
  508. UA_NumericRange range;
  509. UA_NumericRange *rangeptr = NULL;
  510. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  511. if(wvalue->indexRange.length > 0) {
  512. retval = parse_numericrange(&wvalue->indexRange, &range);
  513. if(retval != UA_STATUSCODE_GOOD)
  514. return retval;
  515. rangeptr = &range;
  516. }
  517. /* The nodeid on the wire may be != the nodeid in the node: opaque types,
  518. enums and bytestrings. nodeV contains the correct type definition. */
  519. const UA_Variant *newV = &wvalue->value.value;
  520. UA_Variant cast_v;
  521. if(!UA_NodeId_equal(&oldV->type->typeId, &newV->type->typeId)) {
  522. cast_v = wvalue->value.value;
  523. newV = &cast_v;
  524. enum type_equivalence te1 = typeEquivalence(oldV->type);
  525. enum type_equivalence te2 = typeEquivalence(newV->type);
  526. if(te1 != TYPE_EQUIVALENCE_NONE && te1 == te2) {
  527. /* An enum was sent as an int32, or an opaque type as a bytestring. This is
  528. detected with the typeIndex indicated the "true" datatype. */
  529. cast_v.type = oldV->type;
  530. } else if(oldV->type == &UA_TYPES[UA_TYPES_BYTE] && !UA_Variant_isScalar(oldV) &&
  531. newV->type == &UA_TYPES[UA_TYPES_BYTESTRING] && UA_Variant_isScalar(newV)) {
  532. /* a string is written to a byte array */
  533. UA_ByteString *str = (UA_ByteString*) newV->data;
  534. cast_v.arrayLength = str->length;
  535. cast_v.data = str->data;
  536. cast_v.type = &UA_TYPES[UA_TYPES_BYTE];
  537. } else {
  538. if(rangeptr)
  539. UA_free(range.dimensions);
  540. return UA_STATUSCODE_BADTYPEMISMATCH;
  541. }
  542. }
  543. if(!rangeptr) {
  544. UA_Variant_deleteMembers(&node->value.variant.value);
  545. UA_Variant_copy(newV, &node->value.variant.value);
  546. } else
  547. retval = UA_Variant_setRangeCopy(&node->value.variant.value, newV->data, newV->arrayLength, range);
  548. if(node->value.variant.callback.onWrite)
  549. node->value.variant.callback.onWrite(node->value.variant.callback.handle, node->nodeId,
  550. &node->value.variant.value, rangeptr);
  551. if(rangeptr)
  552. UA_free(range.dimensions);
  553. return retval;
  554. }
  555. static UA_StatusCode
  556. CopyAttributeIntoNode(UA_Server *server, UA_Session *session,
  557. UA_Node *node, const UA_WriteValue *wvalue) {
  558. if(!wvalue->value.hasValue)
  559. return UA_STATUSCODE_BADTYPEMISMATCH;
  560. void *value = wvalue->value.value.data;
  561. void *target = NULL;
  562. const UA_DataType *attr_type = NULL;
  563. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  564. switch(wvalue->attributeId) {
  565. case UA_ATTRIBUTEID_NODEID:
  566. case UA_ATTRIBUTEID_NODECLASS:
  567. case UA_ATTRIBUTEID_DATATYPE:
  568. retval = UA_STATUSCODE_BADWRITENOTSUPPORTED;
  569. break;
  570. case UA_ATTRIBUTEID_BROWSENAME:
  571. CHECK_DATATYPE(QUALIFIEDNAME);
  572. target = &node->browseName;
  573. attr_type = &UA_TYPES[UA_TYPES_QUALIFIEDNAME];
  574. break;
  575. case UA_ATTRIBUTEID_DISPLAYNAME:
  576. CHECK_DATATYPE(LOCALIZEDTEXT);
  577. target = &node->displayName;
  578. attr_type = &UA_TYPES[UA_TYPES_LOCALIZEDTEXT];
  579. break;
  580. case UA_ATTRIBUTEID_DESCRIPTION:
  581. CHECK_DATATYPE(LOCALIZEDTEXT);
  582. target = &node->description;
  583. attr_type = &UA_TYPES[UA_TYPES_LOCALIZEDTEXT];
  584. break;
  585. case UA_ATTRIBUTEID_WRITEMASK:
  586. CHECK_DATATYPE(UINT32);
  587. node->writeMask = *(UA_UInt32*)value;
  588. break;
  589. case UA_ATTRIBUTEID_USERWRITEMASK:
  590. CHECK_DATATYPE(UINT32);
  591. node->userWriteMask = *(UA_UInt32*)value;
  592. break;
  593. case UA_ATTRIBUTEID_ISABSTRACT:
  594. CHECK_NODECLASS_WRITE(UA_NODECLASS_OBJECTTYPE | UA_NODECLASS_REFERENCETYPE |
  595. UA_NODECLASS_VARIABLETYPE | UA_NODECLASS_DATATYPE);
  596. CHECK_DATATYPE(BOOLEAN);
  597. ((UA_ObjectTypeNode*)node)->isAbstract = *(UA_Boolean*)value;
  598. break;
  599. case UA_ATTRIBUTEID_SYMMETRIC:
  600. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  601. CHECK_DATATYPE(BOOLEAN);
  602. ((UA_ReferenceTypeNode*)node)->symmetric = *(UA_Boolean*)value;
  603. break;
  604. case UA_ATTRIBUTEID_INVERSENAME:
  605. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  606. CHECK_DATATYPE(LOCALIZEDTEXT);
  607. target = &((UA_ReferenceTypeNode*)node)->inverseName;
  608. attr_type = &UA_TYPES[UA_TYPES_LOCALIZEDTEXT];
  609. break;
  610. case UA_ATTRIBUTEID_CONTAINSNOLOOPS:
  611. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW);
  612. CHECK_DATATYPE(BOOLEAN);
  613. ((UA_ViewNode*)node)->containsNoLoops = *(UA_Boolean*)value;
  614. break;
  615. case UA_ATTRIBUTEID_EVENTNOTIFIER:
  616. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW | UA_NODECLASS_OBJECT);
  617. CHECK_DATATYPE(BYTE);
  618. ((UA_ViewNode*)node)->eventNotifier = *(UA_Byte*)value;
  619. break;
  620. case UA_ATTRIBUTEID_VALUE:
  621. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  622. if(((const UA_VariableNode*)node)->valueSource == UA_VALUESOURCE_VARIANT)
  623. retval = CopyValueIntoNode((UA_VariableNode*)node, wvalue);
  624. else
  625. retval = Service_Write_single_ValueDataSource(server, session, (const UA_VariableNode*)node, wvalue);
  626. break;
  627. case UA_ATTRIBUTEID_ACCESSLEVEL:
  628. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  629. CHECK_DATATYPE(BYTE);
  630. ((UA_VariableNode*)node)->accessLevel = *(UA_Byte*)value;
  631. break;
  632. case UA_ATTRIBUTEID_USERACCESSLEVEL:
  633. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  634. CHECK_DATATYPE(BYTE);
  635. ((UA_VariableNode*)node)->userAccessLevel = *(UA_Byte*)value;
  636. break;
  637. case UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL:
  638. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  639. CHECK_DATATYPE(DOUBLE);
  640. ((UA_VariableNode*)node)->minimumSamplingInterval = *(UA_Double*)value;
  641. break;
  642. case UA_ATTRIBUTEID_HISTORIZING:
  643. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  644. CHECK_DATATYPE(BOOLEAN);
  645. ((UA_VariableNode*)node)->historizing = *(UA_Boolean*)value;
  646. break;
  647. case UA_ATTRIBUTEID_EXECUTABLE:
  648. CHECK_NODECLASS_WRITE(UA_NODECLASS_METHOD);
  649. CHECK_DATATYPE(BOOLEAN);
  650. ((UA_MethodNode*)node)->executable = *(UA_Boolean*)value;
  651. break;
  652. case UA_ATTRIBUTEID_USEREXECUTABLE:
  653. CHECK_NODECLASS_WRITE(UA_NODECLASS_METHOD);
  654. CHECK_DATATYPE(BOOLEAN);
  655. ((UA_MethodNode*)node)->userExecutable = *(UA_Boolean*)value;
  656. break;
  657. default:
  658. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  659. break;
  660. }
  661. if(attr_type) {
  662. UA_deleteMembers(target, attr_type);
  663. retval = UA_copy(value, target, attr_type);
  664. }
  665. return retval;
  666. }
  667. UA_StatusCode Service_Write_single(UA_Server *server, UA_Session *session, const UA_WriteValue *wvalue) {
  668. return UA_Server_editNode(server, session, &wvalue->nodeId, (UA_EditNodeCallback)CopyAttributeIntoNode, wvalue);
  669. }
  670. void Service_Write(UA_Server *server, UA_Session *session, const UA_WriteRequest *request,
  671. UA_WriteResponse *response) {
  672. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing WriteRequest");
  673. if(request->nodesToWriteSize <= 0) {
  674. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  675. return;
  676. }
  677. response->results = UA_Array_new(request->nodesToWriteSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  678. if(!response->results) {
  679. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  680. return;
  681. }
  682. #ifdef UA_ENABLE_EXTERNAL_NAMESPACES
  683. UA_Boolean isExternal[request->nodesToWriteSize];
  684. UA_UInt32 indices[request->nodesToWriteSize];
  685. memset(isExternal, false, sizeof(UA_Boolean)*request->nodesToWriteSize);
  686. for(size_t j = 0; j < server->externalNamespacesSize; j++) {
  687. UA_UInt32 indexSize = 0;
  688. for(size_t i = 0; i < request->nodesToWriteSize; i++) {
  689. if(request->nodesToWrite[i].nodeId.namespaceIndex !=
  690. server->externalNamespaces[j].index)
  691. continue;
  692. isExternal[i] = true;
  693. indices[indexSize] = (UA_UInt32)i;
  694. indexSize++;
  695. }
  696. if(indexSize == 0)
  697. continue;
  698. UA_ExternalNodeStore *ens = &server->externalNamespaces[j].externalNodeStore;
  699. ens->writeNodes(ens->ensHandle, &request->requestHeader, request->nodesToWrite,
  700. indices, indexSize, response->results, response->diagnosticInfos);
  701. }
  702. #endif
  703. response->resultsSize = request->nodesToWriteSize;
  704. for(size_t i = 0;i < request->nodesToWriteSize;i++) {
  705. #ifdef UA_ENABLE_EXTERNAL_NAMESPACES
  706. if(!isExternal[i])
  707. #endif
  708. response->results[i] = Service_Write_single(server, session, &request->nodesToWrite[i]);
  709. }
  710. }