ua_services_attribute.c 53 KB

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