ua_services_attribute.c 51 KB

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