ua_services_attribute.c 50 KB

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