ua_services_attribute.c 34 KB

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