ua_services_attribute.c 50 KB

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