ua_services_attribute.c 54 KB

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