ua_services_attribute.c 51 KB

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