ua_services_attribute.c 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249
  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. #include "ua_server_internal.h"
  5. #include "ua_services.h"
  6. #ifdef UA_ENABLE_NONSTANDARD_STATELESS
  7. #include "ua_types_encoding_binary.h"
  8. #endif
  9. /* Force cast from const data for zero-copy reading. The storage type is set to
  10. nodelete. So the value is not deleted. Use with care! */
  11. static void
  12. forceVariantSetScalar(UA_Variant *v, const void *p, const UA_DataType *t) {
  13. UA_Variant_init(v);
  14. v->type = t;
  15. v->data = (void*)(uintptr_t)p;
  16. v->storageType = UA_VARIANT_DATA_NODELETE;
  17. }
  18. static UA_UInt32
  19. getUserWriteMask(UA_Server *server, const UA_Session *session,
  20. const UA_Node *node) {
  21. if(session == &adminSession)
  22. return 0xFFFFFFFF; /* the local admin user has all rights */
  23. return node->writeMask &
  24. server->config.accessControl.getUserRightsMask(&session->sessionId,
  25. session->sessionHandle,
  26. &node->nodeId);
  27. }
  28. static UA_Byte
  29. getUserAccessLevel(UA_Server *server, const UA_Session *session,
  30. const UA_VariableNode *node) {
  31. if(session == &adminSession)
  32. return 0xFF; /* the local admin user has all rights */
  33. return node->accessLevel &
  34. server->config.accessControl.getUserAccessLevel(&session->sessionId,
  35. session->sessionHandle,
  36. &node->nodeId);
  37. }
  38. static UA_Boolean
  39. getUserExecutable(UA_Server *server, const UA_Session *session,
  40. const UA_MethodNode *node) {
  41. if(session == &adminSession)
  42. return true; /* the local admin user has all rights */
  43. return node->executable &
  44. server->config.accessControl.getUserExecutable(&session->sessionId,
  45. session->sessionHandle,
  46. &node->nodeId);
  47. }
  48. /*****************/
  49. /* Type Checking */
  50. /*****************/
  51. enum type_equivalence {
  52. TYPE_EQUIVALENCE_NONE,
  53. TYPE_EQUIVALENCE_ENUM,
  54. TYPE_EQUIVALENCE_OPAQUE
  55. };
  56. static enum type_equivalence
  57. typeEquivalence(const UA_DataType *t) {
  58. if(t->membersSize != 1 || !t->members[0].namespaceZero)
  59. return TYPE_EQUIVALENCE_NONE;
  60. if(t->members[0].memberTypeIndex == UA_TYPES_INT32)
  61. return TYPE_EQUIVALENCE_ENUM;
  62. if(t->members[0].memberTypeIndex == UA_TYPES_BYTE && t->members[0].isArray)
  63. return TYPE_EQUIVALENCE_OPAQUE;
  64. return TYPE_EQUIVALENCE_NONE;
  65. }
  66. UA_Boolean
  67. compatibleDataType(UA_Server *server, const UA_NodeId *dataType,
  68. const UA_NodeId *constraintDataType) {
  69. const UA_NodeId subtypeId = UA_NODEID_NUMERIC(0, UA_NS0ID_HASSUBTYPE);
  70. /* Do not allow empty datatypes */
  71. if(UA_NodeId_isNull(dataType))
  72. return false;
  73. /* No constraint (TODO: use variant instead) */
  74. if(UA_NodeId_isNull(constraintDataType))
  75. return true;
  76. /* Variant allows any subtype */
  77. if(UA_NodeId_equal(constraintDataType, &UA_TYPES[UA_TYPES_VARIANT].typeId))
  78. return true;
  79. /* Enum allows Int32 (only) */
  80. UA_NodeId enumNodeId = UA_NODEID_NUMERIC(0, UA_NS0ID_ENUMERATION);
  81. if (isNodeInTree(server->nodestore, constraintDataType, &enumNodeId, &subtypeId, 1)) {
  82. return UA_NodeId_equal(dataType, &UA_TYPES[UA_TYPES_INT32].typeId);
  83. }
  84. return isNodeInTree(server->nodestore, dataType, constraintDataType, &subtypeId, 1);
  85. }
  86. /* Test whether a valurank and the given arraydimensions are compatible. zero
  87. * array dimensions indicate a scalar */
  88. UA_StatusCode
  89. compatibleValueRankArrayDimensions(UA_Int32 valueRank, size_t arrayDimensionsSize) {
  90. switch(valueRank) {
  91. case -3: /* the value can be a scalar or a one dimensional array */
  92. if(arrayDimensionsSize > 1)
  93. return UA_STATUSCODE_BADTYPEMISMATCH;
  94. break;
  95. case -2: /* the value can be a scalar or an array with any number of dimensions */
  96. break;
  97. case -1: /* the value is a scalar */
  98. if(arrayDimensionsSize > 0)
  99. return UA_STATUSCODE_BADTYPEMISMATCH;
  100. break;
  101. case 0: /* the value is an array with one or more dimensions */
  102. if(arrayDimensionsSize < 1)
  103. return UA_STATUSCODE_BADTYPEMISMATCH;
  104. break;
  105. default: /* >= 1: the value is an array with the specified number of dimensions */
  106. if(valueRank < 0)
  107. return UA_STATUSCODE_BADTYPEMISMATCH;
  108. /* Must hold if the array has a defined length. Null arrays (length -1)
  109. * need to be caught before. */
  110. if(arrayDimensionsSize != (size_t)valueRank)
  111. return UA_STATUSCODE_BADTYPEMISMATCH;
  112. }
  113. return UA_STATUSCODE_GOOD;
  114. }
  115. UA_StatusCode
  116. compatibleValueRanks(UA_Int32 valueRank, UA_Int32 constraintValueRank) {
  117. /* Check if the valuerank of the variabletype allows the change. */
  118. switch(constraintValueRank) {
  119. case -3: /* the value can be a scalar or a one dimensional array */
  120. if(valueRank != -1 && valueRank != 1)
  121. return UA_STATUSCODE_BADTYPEMISMATCH;
  122. break;
  123. case -2: /* the value can be a scalar or an array with any number of dimensions */
  124. break;
  125. case -1: /* the value is a scalar */
  126. if(valueRank != -1)
  127. return UA_STATUSCODE_BADTYPEMISMATCH;
  128. break;
  129. case 0: /* the value is an array with one or more dimensions */
  130. if(valueRank < 0)
  131. return UA_STATUSCODE_BADTYPEMISMATCH;
  132. break;
  133. default: /* >= 1: the value is an array with the specified number of dimensions */
  134. if(valueRank != constraintValueRank)
  135. return UA_STATUSCODE_BADTYPEMISMATCH;
  136. break;
  137. }
  138. return UA_STATUSCODE_GOOD;
  139. }
  140. /* Check if the valuerank allows for the value dimension */
  141. static UA_StatusCode
  142. compatibleValueRankValue(UA_Int32 valueRank, const UA_Variant *value) {
  143. /* empty arrays (-1) always match */
  144. if(value->data == NULL)
  145. return UA_STATUSCODE_GOOD;
  146. size_t arrayDims = value->arrayDimensionsSize;
  147. if(!UA_Variant_isScalar(value))
  148. arrayDims = 1; /* array but no arraydimensions -> implicit array dimension 1 */
  149. return compatibleValueRankArrayDimensions(valueRank, arrayDims);
  150. }
  151. UA_StatusCode
  152. compatibleArrayDimensions(size_t constraintArrayDimensionsSize,
  153. const UA_UInt32 *constraintArrayDimensions,
  154. size_t testArrayDimensionsSize,
  155. const UA_UInt32 *testArrayDimensions) {
  156. /* No array dimensions defined -> everything is permitted if the value rank fits */
  157. if(constraintArrayDimensionsSize == 0)
  158. return UA_STATUSCODE_GOOD;
  159. /* Dimension count must match */
  160. if(testArrayDimensionsSize != constraintArrayDimensionsSize)
  161. return UA_STATUSCODE_BADTYPEMISMATCH;
  162. /* Dimension lengths must match; zero in the constraint is a wildcard */
  163. for(size_t i = 0; i < constraintArrayDimensionsSize; ++i) {
  164. if(constraintArrayDimensions[i] != testArrayDimensions[i] &&
  165. constraintArrayDimensions[i] != 0)
  166. return UA_STATUSCODE_BADTYPEMISMATCH;
  167. }
  168. return UA_STATUSCODE_GOOD;
  169. }
  170. /* Returns the pointer to a datavalue with a possibly transformed type to match
  171. the description */
  172. static const UA_Variant *
  173. convertToMatchingValue(UA_Server *server, const UA_Variant *value,
  174. const UA_NodeId *targetDataTypeId, UA_Variant *editableValue) {
  175. const UA_DataType *targetDataType = UA_findDataType(targetDataTypeId);
  176. if(!targetDataType)
  177. return NULL;
  178. /* A string is written to a byte array. the valuerank and array dimensions
  179. * are checked later */
  180. if(targetDataType == &UA_TYPES[UA_TYPES_BYTE] &&
  181. value->type == &UA_TYPES[UA_TYPES_BYTESTRING] &&
  182. UA_Variant_isScalar(value)) {
  183. UA_ByteString *str = (UA_ByteString*)value->data;
  184. editableValue->storageType = UA_VARIANT_DATA_NODELETE;
  185. editableValue->type = &UA_TYPES[UA_TYPES_BYTE];
  186. editableValue->arrayLength = str->length;
  187. editableValue->data = str->data;
  188. return editableValue;
  189. }
  190. /* An enum was sent as an int32, or an opaque type as a bytestring. This
  191. * is detected with the typeIndex indicating the "true" datatype. */
  192. enum type_equivalence te1 = typeEquivalence(targetDataType);
  193. enum type_equivalence te2 = typeEquivalence(value->type);
  194. if(te1 != TYPE_EQUIVALENCE_NONE && te1 == te2) {
  195. *editableValue = *value;
  196. editableValue->storageType = UA_VARIANT_DATA_NODELETE;
  197. editableValue->type = targetDataType;
  198. return editableValue;
  199. }
  200. /* No more possible equivalencies */
  201. return NULL;
  202. }
  203. /* Test whether the value matches a variable definition given by
  204. * - datatype
  205. * - valueranke
  206. * - array dimensions.
  207. * Sometimes it can be necessary to transform the content of the value, e.g.
  208. * byte array to bytestring or uint32 to some enum. If editableValue is non-NULL,
  209. * we try to create a matching variant that points to the original data. */
  210. UA_StatusCode
  211. typeCheckValue(UA_Server *server, const UA_NodeId *targetDataTypeId,
  212. UA_Int32 targetValueRank, size_t targetArrayDimensionsSize,
  213. const UA_UInt32 *targetArrayDimensions, const UA_Variant *value,
  214. const UA_NumericRange *range, UA_Variant *editableValue) {
  215. /* Empty variant is only allowed for BaseDataType */
  216. if(!value->type) {
  217. if(UA_NodeId_equal(targetDataTypeId, &UA_TYPES[UA_TYPES_VARIANT].typeId) ||
  218. UA_NodeId_equal(targetDataTypeId, &UA_NODEID_NULL))
  219. return UA_STATUSCODE_GOOD;
  220. UA_LOG_INFO(server->config.logger, UA_LOGCATEGORY_SERVER,
  221. "Only Variables with data type BaseDataType may contain "
  222. "a null (empty) value");
  223. return UA_STATUSCODE_BADTYPEMISMATCH;
  224. }
  225. /* Has the value a subtype of the required type? BaseDataType (Variant) can
  226. * be anything... */
  227. if(!compatibleDataType(server, &value->type->typeId, targetDataTypeId)) {
  228. /* Convert to a matching value if possible */
  229. if(!editableValue)
  230. return UA_STATUSCODE_BADTYPEMISMATCH;
  231. value = convertToMatchingValue(server, value, targetDataTypeId, editableValue);
  232. if(!value)
  233. return UA_STATUSCODE_BADTYPEMISMATCH;
  234. }
  235. /* Array dimensions are checked later when writing the range */
  236. if(range)
  237. return UA_STATUSCODE_GOOD;
  238. size_t valueArrayDimensionsSize = value->arrayDimensionsSize;
  239. UA_UInt32 *valueArrayDimensions = value->arrayDimensions;
  240. UA_UInt32 tempArrayDimensions;
  241. if(valueArrayDimensions == 0 && !UA_Variant_isScalar(value)) {
  242. valueArrayDimensionsSize = 1;
  243. tempArrayDimensions = (UA_UInt32)value->arrayLength;
  244. valueArrayDimensions = &tempArrayDimensions;
  245. }
  246. /* See if the array dimensions match. When arrayDimensions are defined, they
  247. * already match the valuerank. */
  248. if(targetArrayDimensionsSize > 0)
  249. return compatibleArrayDimensions(targetArrayDimensionsSize, targetArrayDimensions,
  250. valueArrayDimensionsSize, valueArrayDimensions);
  251. /* Check if the valuerank allows for the value dimension */
  252. return compatibleValueRankValue(targetValueRank, value);
  253. }
  254. /*****************************/
  255. /* ArrayDimensions Attribute */
  256. /*****************************/
  257. static UA_StatusCode
  258. readArrayDimensionsAttribute(const UA_VariableNode *vn, UA_DataValue *v) {
  259. UA_Variant_setArray(&v->value, vn->arrayDimensions,
  260. vn->arrayDimensionsSize, &UA_TYPES[UA_TYPES_UINT32]);
  261. v->value.storageType = UA_VARIANT_DATA_NODELETE;
  262. v->hasValue = true;
  263. return UA_STATUSCODE_GOOD;
  264. }
  265. static UA_StatusCode
  266. writeArrayDimensionsAttribute(UA_Server *server, UA_VariableNode *node,
  267. size_t arrayDimensionsSize, UA_UInt32 *arrayDimensions) {
  268. /* If this is a variabletype, there must be no instances or subtypes of it
  269. * when we do the change */
  270. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  271. UA_Node_hasSubTypeOrInstances((const UA_Node*)node))
  272. return UA_STATUSCODE_BADINTERNALERROR;
  273. /* Check that the array dimensions match with the valuerank */
  274. UA_StatusCode retval = compatibleValueRankArrayDimensions(node->valueRank, arrayDimensionsSize);
  275. if(retval != UA_STATUSCODE_GOOD) {
  276. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  277. "The current value rank does not match the new array dimensions");
  278. return retval;
  279. }
  280. /* Get the VariableType */
  281. const UA_VariableTypeNode *vt = getVariableNodeType(server, (UA_VariableNode*)node);
  282. if(!vt)
  283. return UA_STATUSCODE_BADINTERNALERROR;
  284. /* Check if the array dimensions match with the wildcards in the
  285. * variabletype (dimension length 0) */
  286. if(vt->arrayDimensions) {
  287. retval = compatibleArrayDimensions(vt->arrayDimensionsSize, vt->arrayDimensions,
  288. arrayDimensionsSize, arrayDimensions);
  289. if(retval != UA_STATUSCODE_GOOD) {
  290. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  291. "Array dimensions in the variable type do not match");
  292. return retval;
  293. }
  294. }
  295. /* Check if the current value is compatible with the array dimensions */
  296. UA_DataValue value;
  297. UA_DataValue_init(&value);
  298. retval = readValueAttribute(server, node, &value);
  299. if(retval != UA_STATUSCODE_GOOD)
  300. return retval;
  301. if(value.hasValue) {
  302. retval = compatibleArrayDimensions(arrayDimensionsSize, arrayDimensions,
  303. value.value.arrayDimensionsSize,
  304. value.value.arrayDimensions);
  305. UA_DataValue_deleteMembers(&value);
  306. if(retval != UA_STATUSCODE_GOOD) {
  307. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  308. "Array dimensions in the current value do not match");
  309. return retval;
  310. }
  311. }
  312. /* Ok, apply */
  313. UA_UInt32 *oldArrayDimensions = node->arrayDimensions;
  314. retval = UA_Array_copy(arrayDimensions, arrayDimensionsSize,
  315. (void**)&node->arrayDimensions, &UA_TYPES[UA_TYPES_UINT32]);
  316. if(retval != UA_STATUSCODE_GOOD)
  317. return retval;
  318. UA_free(oldArrayDimensions);
  319. node->arrayDimensionsSize = arrayDimensionsSize;
  320. return UA_STATUSCODE_GOOD;
  321. }
  322. /***********************/
  323. /* ValueRank Attribute */
  324. /***********************/
  325. static UA_StatusCode
  326. writeValueRankAttributeWithVT(UA_Server *server, UA_VariableNode *node,
  327. UA_Int32 valueRank) {
  328. const UA_VariableTypeNode *vt = getVariableNodeType(server, node);
  329. if(!vt)
  330. return UA_STATUSCODE_BADINTERNALERROR;
  331. return writeValueRankAttribute(server, node, valueRank, vt->valueRank);
  332. }
  333. UA_StatusCode
  334. writeValueRankAttribute(UA_Server *server, UA_VariableNode *node, UA_Int32 valueRank,
  335. UA_Int32 constraintValueRank) {
  336. /* If this is a variabletype, there must be no instances or subtypes of it
  337. when we do the change */
  338. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  339. UA_Node_hasSubTypeOrInstances((const UA_Node*)node))
  340. return UA_STATUSCODE_BADINTERNALERROR;
  341. /* Check if the valuerank of the variabletype allows the change. */
  342. UA_StatusCode retval = compatibleValueRanks(valueRank, constraintValueRank);
  343. if(retval != UA_STATUSCODE_GOOD)
  344. return retval;
  345. /* Check if the new valuerank is compatible with the array dimensions. Use
  346. * the read service to handle data sources. */
  347. size_t arrayDims = node->arrayDimensionsSize;
  348. if(arrayDims == 0) {
  349. /* the value could be an array with no arrayDimensions defined.
  350. dimensions zero indicate a scalar for compatibleValueRankArrayDimensions. */
  351. UA_DataValue value;
  352. UA_DataValue_init(&value);
  353. retval = readValueAttribute(server, node, &value);
  354. if(retval != UA_STATUSCODE_GOOD)
  355. return retval;
  356. if(!value.hasValue || !value.value.type) {
  357. /* no value -> apply */
  358. node->valueRank = valueRank;
  359. return UA_STATUSCODE_GOOD;
  360. }
  361. if(!UA_Variant_isScalar(&value.value))
  362. arrayDims = 1;
  363. UA_DataValue_deleteMembers(&value);
  364. }
  365. retval = compatibleValueRankArrayDimensions(valueRank, arrayDims);
  366. if(retval != UA_STATUSCODE_GOOD)
  367. return retval;
  368. /* All good, apply the change */
  369. node->valueRank = valueRank;
  370. return UA_STATUSCODE_GOOD;
  371. }
  372. /**********************/
  373. /* DataType Attribute */
  374. /**********************/
  375. static UA_StatusCode
  376. writeDataTypeAttribute(UA_Server *server, UA_VariableNode *node,
  377. const UA_NodeId *dataType, const UA_NodeId *constraintDataType) {
  378. /* If this is a variabletype, there must be no instances or subtypes of it
  379. when we do the change */
  380. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  381. UA_Node_hasSubTypeOrInstances((const UA_Node*)node))
  382. return UA_STATUSCODE_BADINTERNALERROR;
  383. /* Does the new type match the constraints of the variabletype? */
  384. if(!compatibleDataType(server, dataType, constraintDataType))
  385. return UA_STATUSCODE_BADTYPEMISMATCH;
  386. /* Check if the current value would match the new type */
  387. UA_DataValue value;
  388. UA_DataValue_init(&value);
  389. UA_StatusCode retval = readValueAttribute(server, node, &value);
  390. if(retval != UA_STATUSCODE_GOOD)
  391. return retval;
  392. if(value.hasValue) {
  393. retval = typeCheckValue(server, dataType, node->valueRank,
  394. node->arrayDimensionsSize, node->arrayDimensions,
  395. &value.value, NULL, NULL);
  396. UA_DataValue_deleteMembers(&value);
  397. if(retval != UA_STATUSCODE_GOOD) {
  398. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  399. "The current value does not match the new data type");
  400. return retval;
  401. }
  402. }
  403. /* Replace the datatype nodeid */
  404. UA_NodeId dtCopy = node->dataType;
  405. retval = UA_NodeId_copy(dataType, &node->dataType);
  406. if(retval != UA_STATUSCODE_GOOD) {
  407. node->dataType = dtCopy;
  408. return retval;
  409. }
  410. UA_NodeId_deleteMembers(&dtCopy);
  411. return UA_STATUSCODE_GOOD;
  412. }
  413. static UA_StatusCode
  414. writeDataTypeAttributeWithVT(UA_Server *server, UA_VariableNode *node,
  415. const UA_NodeId *dataType) {
  416. const UA_VariableTypeNode *vt = getVariableNodeType(server, node);
  417. if(!vt)
  418. return UA_STATUSCODE_BADINTERNALERROR;
  419. return writeDataTypeAttribute(server, node, dataType, &vt->dataType);
  420. }
  421. /*******************/
  422. /* Value Attribute */
  423. /*******************/
  424. static UA_StatusCode
  425. readValueAttributeFromNode(UA_Server *server, const UA_VariableNode *vn, UA_DataValue *v,
  426. UA_NumericRange *rangeptr) {
  427. if(vn->value.data.callback.onRead) {
  428. UA_RCU_UNLOCK();
  429. vn->value.data.callback.onRead(vn->value.data.callback.handle,
  430. vn->nodeId, &vn->value.data.value.value, rangeptr);
  431. UA_RCU_LOCK();
  432. #ifdef UA_ENABLE_MULTITHREADING
  433. /* Reopen the node to see the changes (multithreading only) */
  434. vn = (const UA_VariableNode*)UA_NodeStore_get(server->nodestore, &vn->nodeId);
  435. #endif
  436. }
  437. if(rangeptr)
  438. return UA_Variant_copyRange(&vn->value.data.value.value, &v->value, *rangeptr);
  439. *v = vn->value.data.value;
  440. v->value.storageType = UA_VARIANT_DATA_NODELETE;
  441. return UA_STATUSCODE_GOOD;
  442. }
  443. static UA_StatusCode
  444. readValueAttributeFromDataSource(const UA_VariableNode *vn, UA_DataValue *v,
  445. UA_TimestampsToReturn timestamps,
  446. UA_NumericRange *rangeptr) {
  447. if(!vn->value.dataSource.read)
  448. return UA_STATUSCODE_BADINTERNALERROR;
  449. UA_Boolean sourceTimeStamp = (timestamps == UA_TIMESTAMPSTORETURN_SOURCE ||
  450. timestamps == UA_TIMESTAMPSTORETURN_BOTH);
  451. UA_RCU_UNLOCK();
  452. UA_StatusCode retval =
  453. vn->value.dataSource.read(vn->value.dataSource.handle, vn->nodeId,
  454. sourceTimeStamp, rangeptr, v);
  455. UA_RCU_LOCK();
  456. return retval;
  457. }
  458. static UA_StatusCode
  459. readValueAttributeComplete(UA_Server *server, const UA_VariableNode *vn,
  460. UA_TimestampsToReturn timestamps, const UA_String *indexRange,
  461. UA_DataValue *v) {
  462. /* Compute the index range */
  463. UA_NumericRange range;
  464. UA_NumericRange *rangeptr = NULL;
  465. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  466. if(indexRange && indexRange->length > 0) {
  467. retval = UA_NumericRange_parseFromString(&range, indexRange);
  468. if(retval != UA_STATUSCODE_GOOD)
  469. return retval;
  470. rangeptr = &range;
  471. }
  472. /* Read the value */
  473. if(vn->valueSource == UA_VALUESOURCE_DATA)
  474. retval = readValueAttributeFromNode(server, vn, v, rangeptr);
  475. else
  476. retval = readValueAttributeFromDataSource(vn, v, timestamps, rangeptr);
  477. /* Clean up */
  478. if(rangeptr)
  479. UA_free(range.dimensions);
  480. return retval;
  481. }
  482. UA_StatusCode
  483. readValueAttribute(UA_Server *server, const UA_VariableNode *vn, UA_DataValue *v) {
  484. return readValueAttributeComplete(server, vn, UA_TIMESTAMPSTORETURN_NEITHER, NULL, v);
  485. }
  486. static UA_StatusCode
  487. writeValueAttributeWithoutRange(UA_VariableNode *node, const UA_DataValue *value) {
  488. UA_DataValue old_value = node->value.data.value; /* keep the pointers for restoring */
  489. UA_StatusCode retval = UA_DataValue_copy(value, &node->value.data.value);
  490. if(retval == UA_STATUSCODE_GOOD)
  491. UA_DataValue_deleteMembers(&old_value);
  492. else
  493. node->value.data.value = old_value;
  494. return retval;
  495. }
  496. static UA_StatusCode
  497. writeValueAttributeWithRange(UA_VariableNode *node, const UA_DataValue *value,
  498. const UA_NumericRange *rangeptr) {
  499. /* Value on both sides? */
  500. if(value->status != node->value.data.value.status ||
  501. !value->hasValue || !node->value.data.value.hasValue)
  502. return UA_STATUSCODE_BADINDEXRANGEINVALID;
  503. /* Make scalar a one-entry array for range matching */
  504. UA_Variant editableValue;
  505. const UA_Variant *v = &value->value;
  506. if(UA_Variant_isScalar(&value->value)) {
  507. editableValue = value->value;
  508. editableValue.arrayLength = 1;
  509. v = &editableValue;
  510. }
  511. /* Write the value */
  512. UA_StatusCode retval = UA_Variant_setRangeCopy(&node->value.data.value.value,
  513. v->data, v->arrayLength, *rangeptr);
  514. if(retval != UA_STATUSCODE_GOOD)
  515. return retval;
  516. /* Write the status and timestamps */
  517. node->value.data.value.hasStatus = value->hasStatus;
  518. node->value.data.value.status = value->status;
  519. node->value.data.value.hasSourceTimestamp = value->hasSourceTimestamp;
  520. node->value.data.value.sourceTimestamp = value->sourceTimestamp;
  521. node->value.data.value.hasSourcePicoseconds = value->hasSourcePicoseconds;
  522. node->value.data.value.sourcePicoseconds = value->sourcePicoseconds;
  523. return UA_STATUSCODE_GOOD;
  524. }
  525. static UA_StatusCode
  526. writeValueAttribute(UA_Server *server, UA_VariableNode *node,
  527. const UA_DataValue *value, const UA_String *indexRange) {
  528. /* Parse the range */
  529. UA_NumericRange range;
  530. UA_NumericRange *rangeptr = NULL;
  531. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  532. if(indexRange && indexRange->length > 0) {
  533. retval = UA_NumericRange_parseFromString(&range, indexRange);
  534. if(retval != UA_STATUSCODE_GOOD)
  535. return retval;
  536. rangeptr = &range;
  537. }
  538. /* Copy the value into an editable "container" where e.g. the datatype can
  539. * be adjusted. The data itself is not written into. */
  540. UA_DataValue editableValue = *value;
  541. editableValue.value.storageType = UA_VARIANT_DATA_NODELETE;
  542. /* Type checking. May change the type of editableValue */
  543. if(value->hasValue) {
  544. retval = typeCheckValue(server, &node->dataType, node->valueRank,
  545. node->arrayDimensionsSize, node->arrayDimensions,
  546. &value->value, rangeptr, &editableValue.value);
  547. if(retval != UA_STATUSCODE_GOOD) {
  548. if(rangeptr)
  549. UA_free(range.dimensions);
  550. return retval;
  551. }
  552. }
  553. /* Set the source timestamp if there is none */
  554. if(!editableValue.hasSourceTimestamp) {
  555. editableValue.sourceTimestamp = UA_DateTime_now();
  556. editableValue.hasSourceTimestamp = true;
  557. }
  558. /* Ok, do it */
  559. if(node->valueSource == UA_VALUESOURCE_DATA) {
  560. if(!rangeptr)
  561. retval = writeValueAttributeWithoutRange(node, &editableValue);
  562. else
  563. retval = writeValueAttributeWithRange(node, &editableValue, rangeptr);
  564. /* Callback after writing */
  565. if(retval == UA_STATUSCODE_GOOD && node->value.data.callback.onWrite) {
  566. const UA_VariableNode *writtenNode;
  567. #ifdef UA_ENABLE_MULTITHREADING
  568. /* Reopen the node to see the changes (multithreading only) */
  569. writtenNode = (const UA_VariableNode*)UA_NodeStore_get(server->nodestore, &node->nodeId);
  570. #else
  571. writtenNode = node; /* The node is written in-situ (TODO: this might
  572. change with the nodestore plugin approach) */
  573. #endif
  574. UA_RCU_UNLOCK();
  575. writtenNode->value.data.callback.onWrite(writtenNode->value.data.callback.handle,
  576. writtenNode->nodeId,
  577. &writtenNode->value.data.value.value, rangeptr);
  578. UA_RCU_LOCK();
  579. }
  580. } else {
  581. if(node->value.dataSource.write) {
  582. UA_RCU_UNLOCK();
  583. retval = node->value.dataSource.write(node->value.dataSource.handle,
  584. node->nodeId, &editableValue.value, rangeptr);
  585. UA_RCU_LOCK();
  586. } else {
  587. retval = UA_STATUSCODE_BADWRITENOTSUPPORTED;
  588. }
  589. }
  590. /* Clean up */
  591. if(rangeptr)
  592. UA_free(range.dimensions);
  593. return retval;
  594. }
  595. /************************/
  596. /* IsAbstract Attribute */
  597. /************************/
  598. static UA_StatusCode
  599. readIsAbstractAttribute(const UA_Node *node, UA_Variant *v) {
  600. const UA_Boolean *isAbstract;
  601. switch(node->nodeClass) {
  602. case UA_NODECLASS_REFERENCETYPE:
  603. isAbstract = &((const UA_ReferenceTypeNode*)node)->isAbstract;
  604. break;
  605. case UA_NODECLASS_OBJECTTYPE:
  606. isAbstract = &((const UA_ObjectTypeNode*)node)->isAbstract;
  607. break;
  608. case UA_NODECLASS_VARIABLETYPE:
  609. isAbstract = &((const UA_VariableTypeNode*)node)->isAbstract;
  610. break;
  611. case UA_NODECLASS_DATATYPE:
  612. isAbstract = &((const UA_DataTypeNode*)node)->isAbstract;
  613. break;
  614. default:
  615. return UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  616. }
  617. forceVariantSetScalar(v, isAbstract, &UA_TYPES[UA_TYPES_BOOLEAN]);
  618. return UA_STATUSCODE_GOOD;
  619. }
  620. static UA_StatusCode
  621. writeIsAbstractAttribute(UA_Node *node, UA_Boolean value) {
  622. switch(node->nodeClass) {
  623. case UA_NODECLASS_OBJECTTYPE:
  624. ((UA_ObjectTypeNode*)node)->isAbstract = value;
  625. break;
  626. case UA_NODECLASS_REFERENCETYPE:
  627. ((UA_ReferenceTypeNode*)node)->isAbstract = value;
  628. break;
  629. case UA_NODECLASS_VARIABLETYPE:
  630. ((UA_VariableTypeNode*)node)->isAbstract = value;
  631. break;
  632. case UA_NODECLASS_DATATYPE:
  633. ((UA_DataTypeNode*)node)->isAbstract = value;
  634. break;
  635. default:
  636. return UA_STATUSCODE_BADNODECLASSINVALID;
  637. }
  638. return UA_STATUSCODE_GOOD;
  639. }
  640. /****************/
  641. /* Read Service */
  642. /****************/
  643. static const UA_String binEncoding = {sizeof("Default Binary")-1, (UA_Byte*)"Default Binary"};
  644. /* static const UA_String xmlEncoding = {sizeof("Default Xml")-1, (UA_Byte*)"Default Xml"}; */
  645. #define CHECK_NODECLASS(CLASS) \
  646. if(!(node->nodeClass & (CLASS))) { \
  647. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID; \
  648. break; \
  649. }
  650. void Service_Read_single(UA_Server *server, UA_Session *session,
  651. const UA_TimestampsToReturn timestamps,
  652. const UA_ReadValueId *id, UA_DataValue *v) {
  653. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  654. "Read the attribute %i", id->attributeId);
  655. /* XML encoding is not supported */
  656. if(id->dataEncoding.name.length > 0 &&
  657. !UA_String_equal(&binEncoding, &id->dataEncoding.name)) {
  658. v->hasStatus = true;
  659. v->status = UA_STATUSCODE_BADDATAENCODINGUNSUPPORTED;
  660. return;
  661. }
  662. /* Index range for an attribute other than value */
  663. if(id->indexRange.length > 0 && id->attributeId != UA_ATTRIBUTEID_VALUE) {
  664. v->hasStatus = true;
  665. v->status = UA_STATUSCODE_BADINDEXRANGENODATA;
  666. return;
  667. }
  668. /* Get the node */
  669. const UA_Node *node = UA_NodeStore_get(server->nodestore, &id->nodeId);
  670. if(!node) {
  671. v->hasStatus = true;
  672. v->status = UA_STATUSCODE_BADNODEIDUNKNOWN;
  673. return;
  674. }
  675. /* Read the attribute */
  676. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  677. switch(id->attributeId) {
  678. case UA_ATTRIBUTEID_NODEID:
  679. forceVariantSetScalar(&v->value, &node->nodeId, &UA_TYPES[UA_TYPES_NODEID]);
  680. break;
  681. case UA_ATTRIBUTEID_NODECLASS:
  682. forceVariantSetScalar(&v->value, &node->nodeClass, &UA_TYPES[UA_TYPES_NODECLASS]);
  683. break;
  684. case UA_ATTRIBUTEID_BROWSENAME:
  685. forceVariantSetScalar(&v->value, &node->browseName, &UA_TYPES[UA_TYPES_QUALIFIEDNAME]);
  686. break;
  687. case UA_ATTRIBUTEID_DISPLAYNAME:
  688. forceVariantSetScalar(&v->value, &node->displayName, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  689. break;
  690. case UA_ATTRIBUTEID_DESCRIPTION:
  691. forceVariantSetScalar(&v->value, &node->description, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  692. break;
  693. case UA_ATTRIBUTEID_WRITEMASK:
  694. forceVariantSetScalar(&v->value, &node->writeMask, &UA_TYPES[UA_TYPES_UINT32]);
  695. break;
  696. case UA_ATTRIBUTEID_USERWRITEMASK: {
  697. UA_UInt32 userWriteMask = getUserWriteMask(server, session, node);
  698. UA_Variant_setScalarCopy(&v->value, &userWriteMask, &UA_TYPES[UA_TYPES_UINT32]);
  699. break; }
  700. case UA_ATTRIBUTEID_ISABSTRACT:
  701. retval = readIsAbstractAttribute(node, &v->value);
  702. break;
  703. case UA_ATTRIBUTEID_SYMMETRIC:
  704. CHECK_NODECLASS(UA_NODECLASS_REFERENCETYPE);
  705. forceVariantSetScalar(&v->value, &((const UA_ReferenceTypeNode*)node)->symmetric,
  706. &UA_TYPES[UA_TYPES_BOOLEAN]);
  707. break;
  708. case UA_ATTRIBUTEID_INVERSENAME:
  709. CHECK_NODECLASS(UA_NODECLASS_REFERENCETYPE);
  710. forceVariantSetScalar(&v->value, &((const UA_ReferenceTypeNode*)node)->inverseName,
  711. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  712. break;
  713. case UA_ATTRIBUTEID_CONTAINSNOLOOPS:
  714. CHECK_NODECLASS(UA_NODECLASS_VIEW);
  715. forceVariantSetScalar(&v->value, &((const UA_ViewNode*)node)->containsNoLoops,
  716. &UA_TYPES[UA_TYPES_BOOLEAN]);
  717. break;
  718. case UA_ATTRIBUTEID_EVENTNOTIFIER:
  719. CHECK_NODECLASS(UA_NODECLASS_VIEW | UA_NODECLASS_OBJECT);
  720. forceVariantSetScalar(&v->value, &((const UA_ViewNode*)node)->eventNotifier,
  721. &UA_TYPES[UA_TYPES_BYTE]);
  722. break;
  723. case UA_ATTRIBUTEID_VALUE: {
  724. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  725. UA_Byte userAccessLevel = getUserAccessLevel(server, session, (const UA_VariableNode*)node);
  726. if(!(userAccessLevel & (UA_ACCESSLEVELMASK_READ))) {
  727. retval = UA_STATUSCODE_BADUSERACCESSDENIED;
  728. break;
  729. }
  730. retval = readValueAttributeComplete(server, (const UA_VariableNode*)node,
  731. timestamps, &id->indexRange, v);
  732. break;
  733. }
  734. case UA_ATTRIBUTEID_DATATYPE:
  735. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  736. forceVariantSetScalar(&v->value, &((const UA_VariableTypeNode*)node)->dataType,
  737. &UA_TYPES[UA_TYPES_NODEID]);
  738. break;
  739. case UA_ATTRIBUTEID_VALUERANK:
  740. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  741. forceVariantSetScalar(&v->value, &((const UA_VariableTypeNode*)node)->valueRank,
  742. &UA_TYPES[UA_TYPES_INT32]);
  743. break;
  744. case UA_ATTRIBUTEID_ARRAYDIMENSIONS:
  745. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  746. retval = readArrayDimensionsAttribute((const UA_VariableNode*)node, v);
  747. break;
  748. case UA_ATTRIBUTEID_ACCESSLEVEL:
  749. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  750. forceVariantSetScalar(&v->value, &((const UA_VariableNode*)node)->accessLevel,
  751. &UA_TYPES[UA_TYPES_BYTE]);
  752. break;
  753. case UA_ATTRIBUTEID_USERACCESSLEVEL: {
  754. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  755. UA_Byte userAccessLevel = getUserAccessLevel(server, session, (const UA_VariableNode*)node);
  756. UA_Variant_setScalarCopy(&v->value, &userAccessLevel, &UA_TYPES[UA_TYPES_BYTE]);
  757. break; }
  758. case UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL:
  759. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  760. forceVariantSetScalar(&v->value, &((const UA_VariableNode*)node)->minimumSamplingInterval,
  761. &UA_TYPES[UA_TYPES_DOUBLE]);
  762. break;
  763. case UA_ATTRIBUTEID_HISTORIZING:
  764. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  765. forceVariantSetScalar(&v->value, &((const UA_VariableNode*)node)->historizing,
  766. &UA_TYPES[UA_TYPES_BOOLEAN]);
  767. break;
  768. case UA_ATTRIBUTEID_EXECUTABLE:
  769. CHECK_NODECLASS(UA_NODECLASS_METHOD);
  770. forceVariantSetScalar(&v->value, &((const UA_MethodNode*)node)->executable,
  771. &UA_TYPES[UA_TYPES_BOOLEAN]);
  772. break;
  773. case UA_ATTRIBUTEID_USEREXECUTABLE: {
  774. CHECK_NODECLASS(UA_NODECLASS_METHOD);
  775. UA_Boolean userExecutable = getUserExecutable(server, session, (const UA_MethodNode*)node);
  776. UA_Variant_setScalarCopy(&v->value, &userExecutable, &UA_TYPES[UA_TYPES_BOOLEAN]);
  777. break; }
  778. default:
  779. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  780. }
  781. /* Return error code when reading has failed */
  782. if(retval != UA_STATUSCODE_GOOD) {
  783. v->hasStatus = true;
  784. v->status = retval;
  785. return;
  786. }
  787. v->hasValue = true;
  788. /* Create server timestamp */
  789. if(timestamps == UA_TIMESTAMPSTORETURN_SERVER ||
  790. timestamps == UA_TIMESTAMPSTORETURN_BOTH) {
  791. v->serverTimestamp = UA_DateTime_now();
  792. v->hasServerTimestamp = true;
  793. }
  794. /* Handle source time stamp */
  795. if(id->attributeId == UA_ATTRIBUTEID_VALUE) {
  796. if (timestamps == UA_TIMESTAMPSTORETURN_SERVER ||
  797. timestamps == UA_TIMESTAMPSTORETURN_NEITHER) {
  798. v->hasSourceTimestamp = false;
  799. v->hasSourcePicoseconds = false;
  800. } else if(!v->hasSourceTimestamp) {
  801. v->sourceTimestamp = UA_DateTime_now();
  802. v->hasSourceTimestamp = true;
  803. }
  804. }
  805. }
  806. void Service_Read(UA_Server *server, UA_Session *session,
  807. const UA_ReadRequest *request, UA_ReadResponse *response) {
  808. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing ReadRequest");
  809. if(request->nodesToReadSize <= 0) {
  810. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  811. return;
  812. }
  813. /* check if the timestampstoreturn is valid */
  814. if(request->timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  815. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  816. return;
  817. }
  818. size_t size = request->nodesToReadSize;
  819. response->results = (UA_DataValue *)UA_Array_new(size, &UA_TYPES[UA_TYPES_DATAVALUE]);
  820. if(!response->results) {
  821. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  822. return;
  823. }
  824. response->resultsSize = size;
  825. if(request->maxAge < 0) {
  826. response->responseHeader.serviceResult = UA_STATUSCODE_BADMAXAGEINVALID;
  827. return;
  828. }
  829. for(size_t i = 0;i < size;++i) {
  830. Service_Read_single(server, session, request->timestampsToReturn,
  831. &request->nodesToRead[i], &response->results[i]);
  832. }
  833. #ifdef UA_ENABLE_NONSTANDARD_STATELESS
  834. /* Add an expiry header for caching */
  835. if(session->sessionId.namespaceIndex == 0 &&
  836. session->sessionId.identifierType == UA_NODEIDTYPE_NUMERIC &&
  837. session->sessionId.identifier.numeric == 0){
  838. UA_ExtensionObject additionalHeader;
  839. UA_ExtensionObject_init(&additionalHeader);
  840. additionalHeader.encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
  841. additionalHeader.content.encoded.typeId =UA_TYPES[UA_TYPES_VARIANT].typeId;
  842. UA_Variant variant;
  843. UA_Variant_init(&variant);
  844. UA_DateTime* expireArray = NULL;
  845. expireArray = UA_Array_new(request->nodesToReadSize,
  846. &UA_TYPES[UA_TYPES_DATETIME]);
  847. variant.data = expireArray;
  848. /* expires in 20 seconds */
  849. for(UA_UInt32 i = 0;i < response->resultsSize;++i) {
  850. expireArray[i] = UA_DateTime_now() + 20 * 100 * 1000 * 1000;
  851. }
  852. UA_Variant_setArray(&variant, expireArray, request->nodesToReadSize,
  853. &UA_TYPES[UA_TYPES_DATETIME]);
  854. size_t offset = 0;
  855. UA_ByteString str;
  856. size_t strlength = UA_calcSizeBinary(&variant, &UA_TYPES[UA_TYPES_VARIANT]);
  857. UA_ByteString_allocBuffer(&str, strlength);
  858. /* No chunking callback for the encoding */
  859. UA_StatusCode retval = UA_encodeBinary(&variant, &UA_TYPES[UA_TYPES_VARIANT],
  860. NULL, NULL, &str, &offset);
  861. UA_Array_delete(expireArray, request->nodesToReadSize, &UA_TYPES[UA_TYPES_DATETIME]);
  862. if(retval == UA_STATUSCODE_GOOD){
  863. additionalHeader.content.encoded.body.data = str.data;
  864. additionalHeader.content.encoded.body.length = offset;
  865. response->responseHeader.additionalHeader = additionalHeader;
  866. }
  867. }
  868. #endif
  869. }
  870. /* Exposes the Read service to local users */
  871. UA_DataValue
  872. UA_Server_read(UA_Server *server, const UA_ReadValueId *item,
  873. UA_TimestampsToReturn timestamps) {
  874. UA_DataValue dv;
  875. UA_DataValue_init(&dv);
  876. UA_RCU_LOCK();
  877. Service_Read_single(server, &adminSession, timestamps, item, &dv);
  878. UA_RCU_UNLOCK();
  879. return dv;
  880. }
  881. /* Used in inline functions exposing the Read service with more syntactic sugar
  882. * for individual attributes */
  883. UA_StatusCode
  884. __UA_Server_read(UA_Server *server, const UA_NodeId *nodeId,
  885. const UA_AttributeId attributeId, void *v) {
  886. /* Call the read service */
  887. UA_ReadValueId item;
  888. UA_ReadValueId_init(&item);
  889. item.nodeId = *nodeId;
  890. item.attributeId = attributeId;
  891. UA_DataValue dv = UA_Server_read(server, &item, UA_TIMESTAMPSTORETURN_NEITHER);
  892. /* Check the return value */
  893. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  894. if(dv.hasStatus)
  895. retval = dv.hasStatus;
  896. else if(!dv.hasValue)
  897. retval = UA_STATUSCODE_BADUNEXPECTEDERROR;
  898. if(retval != UA_STATUSCODE_GOOD) {
  899. UA_DataValue_deleteMembers(&dv);
  900. return retval;
  901. }
  902. /* Prepare the result */
  903. if(attributeId == UA_ATTRIBUTEID_VALUE ||
  904. attributeId == UA_ATTRIBUTEID_ARRAYDIMENSIONS) {
  905. /* Return the entire variant */
  906. if(dv.value.storageType == UA_VARIANT_DATA_NODELETE) {
  907. retval = UA_Variant_copy(&dv.value,(UA_Variant *) v);
  908. } else {
  909. /* storageType is UA_VARIANT_DATA. Copy the entire variant
  910. * (including pointers and all) */
  911. memcpy(v, &dv.value, sizeof(UA_Variant));
  912. }
  913. } else {
  914. /* Return the variant content only */
  915. if(dv.value.storageType == UA_VARIANT_DATA_NODELETE) {
  916. retval = UA_copy(dv.value.data, v, dv.value.type);
  917. } else {
  918. /* storageType is UA_VARIANT_DATA. Copy the content of the type
  919. * (including pointers and all) */
  920. memcpy(v, dv.value.data, dv.value.type->memSize);
  921. /* Delete the "carrier" in the variant */
  922. UA_free(dv.value.data);
  923. }
  924. }
  925. return retval;
  926. }
  927. /*****************/
  928. /* Write Service */
  929. /*****************/
  930. #define CHECK_DATATYPE_SCALAR(EXP_DT) \
  931. if(!wvalue->value.hasValue || \
  932. &UA_TYPES[UA_TYPES_##EXP_DT] != wvalue->value.value.type || \
  933. !UA_Variant_isScalar(&wvalue->value.value)) { \
  934. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  935. break; \
  936. }
  937. #define CHECK_DATATYPE_ARRAY(EXP_DT) \
  938. if(!wvalue->value.hasValue || \
  939. &UA_TYPES[UA_TYPES_##EXP_DT] != wvalue->value.value.type || \
  940. UA_Variant_isScalar(&wvalue->value.value)) { \
  941. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  942. break; \
  943. }
  944. #define CHECK_NODECLASS_WRITE(CLASS) \
  945. if((node->nodeClass & (CLASS)) == 0) { \
  946. retval = UA_STATUSCODE_BADNODECLASSINVALID; \
  947. break; \
  948. }
  949. #define CHECK_USERWRITEMASK(mask) \
  950. if(!(userWriteMask & (mask))) { \
  951. retval = UA_STATUSCODE_BADUSERACCESSDENIED; \
  952. break; \
  953. }
  954. /* This function implements the main part of the write service and operates on a
  955. copy of the node (not in single-threaded mode). */
  956. static UA_StatusCode
  957. copyAttributeIntoNode(UA_Server *server, UA_Session *session,
  958. UA_Node *node, const UA_WriteValue *wvalue) {
  959. const void *value = wvalue->value.value.data;
  960. UA_UInt32 userWriteMask = getUserWriteMask(server, session, node);
  961. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  962. switch(wvalue->attributeId) {
  963. case UA_ATTRIBUTEID_NODEID:
  964. case UA_ATTRIBUTEID_NODECLASS:
  965. case UA_ATTRIBUTEID_USERWRITEMASK:
  966. case UA_ATTRIBUTEID_USERACCESSLEVEL:
  967. case UA_ATTRIBUTEID_USEREXECUTABLE:
  968. retval = UA_STATUSCODE_BADWRITENOTSUPPORTED;
  969. break;
  970. case UA_ATTRIBUTEID_BROWSENAME:
  971. CHECK_USERWRITEMASK(UA_WRITEMASK_BROWSENAME);
  972. CHECK_DATATYPE_SCALAR(QUALIFIEDNAME);
  973. UA_QualifiedName_deleteMembers(&node->browseName);
  974. UA_QualifiedName_copy((const UA_QualifiedName *)value, &node->browseName);
  975. break;
  976. case UA_ATTRIBUTEID_DISPLAYNAME:
  977. CHECK_USERWRITEMASK(UA_WRITEMASK_DISPLAYNAME);
  978. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  979. UA_LocalizedText_deleteMembers(&node->displayName);
  980. UA_LocalizedText_copy((const UA_LocalizedText *)value, &node->displayName);
  981. break;
  982. case UA_ATTRIBUTEID_DESCRIPTION:
  983. CHECK_USERWRITEMASK(UA_WRITEMASK_DESCRIPTION);
  984. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  985. UA_LocalizedText_deleteMembers(&node->description);
  986. UA_LocalizedText_copy((const UA_LocalizedText *)value, &node->description);
  987. break;
  988. case UA_ATTRIBUTEID_WRITEMASK:
  989. CHECK_USERWRITEMASK(UA_WRITEMASK_WRITEMASK);
  990. CHECK_DATATYPE_SCALAR(UINT32);
  991. node->writeMask = *(const UA_UInt32*)value;
  992. break;
  993. case UA_ATTRIBUTEID_ISABSTRACT:
  994. CHECK_USERWRITEMASK(UA_WRITEMASK_ISABSTRACT);
  995. CHECK_DATATYPE_SCALAR(BOOLEAN);
  996. retval = writeIsAbstractAttribute(node, *(const UA_Boolean*)value);
  997. break;
  998. case UA_ATTRIBUTEID_SYMMETRIC:
  999. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  1000. CHECK_USERWRITEMASK(UA_WRITEMASK_SYMMETRIC);
  1001. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1002. ((UA_ReferenceTypeNode*)node)->symmetric = *(const UA_Boolean*)value;
  1003. break;
  1004. case UA_ATTRIBUTEID_INVERSENAME:
  1005. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  1006. CHECK_USERWRITEMASK(UA_WRITEMASK_INVERSENAME);
  1007. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  1008. UA_LocalizedText_deleteMembers(&((UA_ReferenceTypeNode*)node)->inverseName);
  1009. UA_LocalizedText_copy((const UA_LocalizedText *)value, &((UA_ReferenceTypeNode*)node)->inverseName);
  1010. break;
  1011. case UA_ATTRIBUTEID_CONTAINSNOLOOPS:
  1012. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW);
  1013. CHECK_USERWRITEMASK(UA_WRITEMASK_CONTAINSNOLOOPS);
  1014. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1015. ((UA_ViewNode*)node)->containsNoLoops = *(const UA_Boolean*)value;
  1016. break;
  1017. case UA_ATTRIBUTEID_EVENTNOTIFIER:
  1018. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW | UA_NODECLASS_OBJECT);
  1019. CHECK_USERWRITEMASK(UA_WRITEMASK_EVENTNOTIFIER);
  1020. CHECK_DATATYPE_SCALAR(BYTE);
  1021. ((UA_ViewNode*)node)->eventNotifier = *(const UA_Byte*)value;
  1022. break;
  1023. case UA_ATTRIBUTEID_VALUE:
  1024. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1025. if(node->nodeClass == UA_NODECLASS_VARIABLE) {
  1026. /* The access to a value variable is granted via the AccessLevel Byte */
  1027. UA_Byte userAccessLevel = getUserAccessLevel(server, session, (const UA_VariableNode*)node);
  1028. if(!(userAccessLevel & (UA_ACCESSLEVELMASK_WRITE))) {
  1029. retval = UA_STATUSCODE_BADUSERACCESSDENIED;
  1030. break;
  1031. }
  1032. } else { /* UA_NODECLASS_VARIABLETYPE */
  1033. CHECK_USERWRITEMASK(UA_WRITEMASK_VALUEFORVARIABLETYPE);
  1034. }
  1035. retval = writeValueAttribute(server, (UA_VariableNode*)node,
  1036. &wvalue->value, &wvalue->indexRange);
  1037. break;
  1038. case UA_ATTRIBUTEID_DATATYPE:
  1039. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1040. CHECK_USERWRITEMASK(UA_WRITEMASK_DATATYPE);
  1041. CHECK_DATATYPE_SCALAR(NODEID);
  1042. retval = writeDataTypeAttributeWithVT(server, (UA_VariableNode*)node, (const UA_NodeId*)value);
  1043. break;
  1044. case UA_ATTRIBUTEID_VALUERANK:
  1045. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1046. CHECK_USERWRITEMASK(UA_WRITEMASK_VALUERANK);
  1047. CHECK_DATATYPE_SCALAR(INT32);
  1048. retval = writeValueRankAttributeWithVT(server, (UA_VariableNode*)node, *(const UA_Int32*)value);
  1049. break;
  1050. case UA_ATTRIBUTEID_ARRAYDIMENSIONS:
  1051. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1052. CHECK_USERWRITEMASK(UA_WRITEMASK_ARRRAYDIMENSIONS);
  1053. CHECK_DATATYPE_ARRAY(UINT32);
  1054. retval = writeArrayDimensionsAttribute(server, (UA_VariableNode*)node,
  1055. wvalue->value.value.arrayLength,
  1056. (UA_UInt32 *)wvalue->value.value.data);
  1057. break;
  1058. case UA_ATTRIBUTEID_ACCESSLEVEL:
  1059. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1060. CHECK_USERWRITEMASK(UA_WRITEMASK_ACCESSLEVEL);
  1061. CHECK_DATATYPE_SCALAR(BYTE);
  1062. ((UA_VariableNode*)node)->accessLevel = *(const UA_Byte*)value;
  1063. break;
  1064. case UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL:
  1065. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1066. CHECK_USERWRITEMASK(UA_WRITEMASK_MINIMUMSAMPLINGINTERVAL);
  1067. CHECK_DATATYPE_SCALAR(DOUBLE);
  1068. ((UA_VariableNode*)node)->minimumSamplingInterval = *(const UA_Double*)value;
  1069. break;
  1070. case UA_ATTRIBUTEID_HISTORIZING:
  1071. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1072. CHECK_USERWRITEMASK(UA_WRITEMASK_HISTORIZING);
  1073. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1074. ((UA_VariableNode*)node)->historizing = *(const UA_Boolean*)value;
  1075. break;
  1076. case UA_ATTRIBUTEID_EXECUTABLE:
  1077. CHECK_NODECLASS_WRITE(UA_NODECLASS_METHOD);
  1078. CHECK_USERWRITEMASK(UA_WRITEMASK_EXECUTABLE);
  1079. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1080. ((UA_MethodNode*)node)->executable = *(const UA_Boolean*)value;
  1081. break;
  1082. default:
  1083. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  1084. break;
  1085. }
  1086. if(retval != UA_STATUSCODE_GOOD)
  1087. UA_LOG_INFO_SESSION(server->config.logger, session,
  1088. "WriteRequest returned status code %s",
  1089. UA_StatusCode_name(retval));
  1090. return retval;
  1091. }
  1092. void
  1093. Service_Write(UA_Server *server, UA_Session *session,
  1094. const UA_WriteRequest *request, UA_WriteResponse *response) {
  1095. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing WriteRequest");
  1096. if(request->nodesToWriteSize <= 0) {
  1097. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  1098. return;
  1099. }
  1100. response->results = (UA_StatusCode *)UA_Array_new(request->nodesToWriteSize,
  1101. &UA_TYPES[UA_TYPES_STATUSCODE]);
  1102. if(!response->results) {
  1103. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  1104. return;
  1105. }
  1106. response->resultsSize = request->nodesToWriteSize;
  1107. for(size_t i = 0; i < request->nodesToWriteSize; ++i)
  1108. response->results[i] = UA_Server_editNode(server, session, &request->nodesToWrite[i].nodeId,
  1109. (UA_EditNodeCallback)copyAttributeIntoNode,
  1110. &request->nodesToWrite[i]);
  1111. }
  1112. UA_StatusCode
  1113. UA_Server_write(UA_Server *server, const UA_WriteValue *value) {
  1114. UA_StatusCode retval =
  1115. UA_Server_editNode(server, &adminSession, &value->nodeId,
  1116. (UA_EditNodeCallback)copyAttributeIntoNode, value);
  1117. return retval;
  1118. }
  1119. /* Convenience function to be wrapped into inline functions */
  1120. UA_StatusCode
  1121. __UA_Server_write(UA_Server *server, const UA_NodeId *nodeId,
  1122. const UA_AttributeId attributeId,
  1123. const UA_DataType *attr_type,
  1124. const void *attr) {
  1125. UA_WriteValue wvalue;
  1126. UA_WriteValue_init(&wvalue);
  1127. wvalue.nodeId = *nodeId;
  1128. wvalue.attributeId = attributeId;
  1129. wvalue.value.hasValue = true;
  1130. if(attr_type != &UA_TYPES[UA_TYPES_VARIANT]) {
  1131. /* hacked cast. the target WriteValue is used as const anyway */
  1132. UA_Variant_setScalar(&wvalue.value.value, (void*)(uintptr_t)attr, attr_type);
  1133. } else {
  1134. wvalue.value.value = *(const UA_Variant*)attr;
  1135. }
  1136. return UA_Server_write(server, &wvalue);
  1137. }