ua_services_attribute.c 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417
  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. UA_StatusCode
  470. UA_Server_readObjectProperty(UA_Server *server, const UA_NodeId objectId,
  471. const UA_QualifiedName propertyName,
  472. UA_Variant *value) {
  473. UA_RelativePathElement rpe;
  474. UA_RelativePathElement_init(&rpe);
  475. rpe.referenceTypeId = UA_NODEID_NUMERIC(0, UA_NS0ID_HASPROPERTY);
  476. rpe.isInverse = false;
  477. rpe.includeSubtypes = false;
  478. rpe.targetName = propertyName;
  479. UA_BrowsePath bp;
  480. UA_BrowsePath_init(&bp);
  481. bp.startingNode = objectId;
  482. bp.relativePath.elementsSize = 1;
  483. bp.relativePath.elements = &rpe;
  484. UA_StatusCode retval;
  485. UA_BrowsePathResult bpr = UA_Server_translateBrowsePathToNodeIds(server, &bp);
  486. if(bpr.statusCode != UA_STATUSCODE_GOOD || bpr.targetsSize < 1) {
  487. retval = bpr.statusCode;
  488. UA_BrowsePathResult_deleteMembers(&bpr);
  489. return retval;
  490. }
  491. retval = UA_Server_readValue(server, bpr.targets[0].targetId.nodeId, value);
  492. UA_BrowsePathResult_deleteMembers(&bpr);
  493. return retval;
  494. }
  495. /*****************/
  496. /* Type Checking */
  497. /*****************/
  498. enum type_equivalence {
  499. TYPE_EQUIVALENCE_NONE,
  500. TYPE_EQUIVALENCE_ENUM,
  501. TYPE_EQUIVALENCE_OPAQUE
  502. };
  503. static enum type_equivalence
  504. typeEquivalence(const UA_DataType *t) {
  505. if(t->membersSize != 1 || !t->members[0].namespaceZero)
  506. return TYPE_EQUIVALENCE_NONE;
  507. if(t->members[0].memberTypeIndex == UA_TYPES_INT32)
  508. return TYPE_EQUIVALENCE_ENUM;
  509. if(t->members[0].memberTypeIndex == UA_TYPES_BYTE && t->members[0].isArray)
  510. return TYPE_EQUIVALENCE_OPAQUE;
  511. return TYPE_EQUIVALENCE_NONE;
  512. }
  513. const UA_NodeId subtypeId = {0, UA_NODEIDTYPE_NUMERIC, {UA_NS0ID_HASSUBTYPE}};
  514. static const UA_NodeId enumNodeId = {0, UA_NODEIDTYPE_NUMERIC, {UA_NS0ID_ENUMERATION}};
  515. UA_Boolean
  516. compatibleDataType(UA_Server *server, const UA_NodeId *dataType,
  517. const UA_NodeId *constraintDataType, UA_Boolean isValue) {
  518. /* Do not allow empty datatypes */
  519. if(UA_NodeId_isNull(dataType))
  520. return false;
  521. /* No constraint (TODO: use variant instead) */
  522. if(UA_NodeId_isNull(constraintDataType))
  523. return true;
  524. /* Same datatypes */
  525. if (UA_NodeId_equal(dataType, constraintDataType))
  526. return true;
  527. /* Variant allows any subtype */
  528. if(UA_NodeId_equal(constraintDataType, &UA_TYPES[UA_TYPES_VARIANT].typeId))
  529. return true;
  530. /* Is the value-type a subtype of the required type? */
  531. if(isNodeInTree(&server->config.nodestore, dataType, constraintDataType, &subtypeId, 1))
  532. return true;
  533. /* Enum allows Int32 (only) */
  534. if(UA_NodeId_equal(dataType, &UA_TYPES[UA_TYPES_INT32].typeId) &&
  535. isNodeInTree(&server->config.nodestore, constraintDataType, &enumNodeId, &subtypeId, 1))
  536. return true;
  537. /* More checks for the data type of real values (variants) */
  538. if(isValue) {
  539. /* If value is a built-in type: The target data type may be a sub type of
  540. * the built-in type. (e.g. UtcTime is sub-type of DateTime and has a
  541. * DateTime value). A type is builtin if its NodeId is in Namespace 0 and
  542. * has a numeric identifier <= 25 (DiagnosticInfo) */
  543. if(dataType->namespaceIndex == 0 &&
  544. dataType->identifierType == UA_NODEIDTYPE_NUMERIC &&
  545. dataType->identifier.numeric <= 25 &&
  546. isNodeInTree(&server->config.nodestore, constraintDataType,
  547. dataType, &subtypeId, 1))
  548. return true;
  549. }
  550. return false;
  551. }
  552. /* Test whether a valurank and the given arraydimensions are compatible. zero
  553. * array dimensions indicate a scalar */
  554. UA_Boolean
  555. compatibleValueRankArrayDimensions(UA_Int32 valueRank, size_t arrayDimensionsSize) {
  556. switch(valueRank) {
  557. case -3: /* the value can be a scalar or a one dimensional array */
  558. if(arrayDimensionsSize > 1)
  559. return false;
  560. break;
  561. case -2: /* the value can be a scalar or an array with any number of dimensions */
  562. break;
  563. case -1: /* the value is a scalar */
  564. if(arrayDimensionsSize > 0)
  565. return false;
  566. break;
  567. case 0: /* the value is an array with one or more dimensions */
  568. if(arrayDimensionsSize < 1)
  569. return false;
  570. break;
  571. default: /* >= 1: the value is an array with the specified number of dimensions */
  572. if(valueRank < (UA_Int32) 0)
  573. return false;
  574. /* Must hold if the array has a defined length. Null arrays (length -1)
  575. * need to be caught before. */
  576. if(arrayDimensionsSize != (size_t)valueRank)
  577. return false;
  578. }
  579. return true;
  580. }
  581. UA_Boolean
  582. compatibleValueRanks(UA_Int32 valueRank, UA_Int32 constraintValueRank) {
  583. /* Check if the valuerank of the variabletype allows the change. */
  584. switch(constraintValueRank) {
  585. case -3: /* the value can be a scalar or a one dimensional array */
  586. if(valueRank != -1 && valueRank != 1)
  587. return false;
  588. break;
  589. case -2: /* the value can be a scalar or an array with any number of dimensions */
  590. break;
  591. case -1: /* the value is a scalar */
  592. if(valueRank != -1)
  593. return false;
  594. break;
  595. case 0: /* the value is an array with one or more dimensions */
  596. if(valueRank < (UA_Int32) 0)
  597. return false;
  598. break;
  599. default: /* >= 1: the value is an array with the specified number of dimensions */
  600. if(valueRank != constraintValueRank)
  601. return false;
  602. break;
  603. }
  604. return true;
  605. }
  606. /* Check if the valuerank allows for the value dimension */
  607. static UA_Boolean
  608. compatibleValueRankValue(UA_Int32 valueRank, const UA_Variant *value) {
  609. /* Empty arrays (-1) always match */
  610. if(!value->data)
  611. return true;
  612. size_t arrayDims = value->arrayDimensionsSize;
  613. if(arrayDims == 0 && !UA_Variant_isScalar(value))
  614. arrayDims = 1; /* array but no arraydimensions -> implicit array dimension 1 */
  615. return compatibleValueRankArrayDimensions(valueRank, arrayDims);
  616. }
  617. UA_Boolean
  618. compatibleArrayDimensions(size_t constraintArrayDimensionsSize,
  619. const UA_UInt32 *constraintArrayDimensions,
  620. size_t testArrayDimensionsSize,
  621. const UA_UInt32 *testArrayDimensions) {
  622. /* No array dimensions defined -> everything is permitted if the value rank fits */
  623. if(constraintArrayDimensionsSize == 0)
  624. return true;
  625. /* Dimension count must match */
  626. if(testArrayDimensionsSize != constraintArrayDimensionsSize)
  627. return false;
  628. /* Dimension lengths must match; zero in the constraint is a wildcard */
  629. for(size_t i = 0; i < constraintArrayDimensionsSize; ++i) {
  630. if(constraintArrayDimensions[i] != testArrayDimensions[i] &&
  631. constraintArrayDimensions[i] != 0)
  632. return false;
  633. }
  634. return true;
  635. }
  636. UA_Boolean
  637. compatibleValueArrayDimensions(const UA_Variant *value, size_t targetArrayDimensionsSize,
  638. const UA_UInt32 *targetArrayDimensions) {
  639. size_t valueArrayDimensionsSize = value->arrayDimensionsSize;
  640. UA_UInt32 *valueArrayDimensions = value->arrayDimensions;
  641. UA_UInt32 tempArrayDimensions;
  642. if(valueArrayDimensions == 0 && !UA_Variant_isScalar(value)) {
  643. valueArrayDimensionsSize = 1;
  644. tempArrayDimensions = (UA_UInt32)value->arrayLength;
  645. valueArrayDimensions = &tempArrayDimensions;
  646. }
  647. return compatibleArrayDimensions(targetArrayDimensionsSize, targetArrayDimensions,
  648. valueArrayDimensionsSize, valueArrayDimensions);
  649. }
  650. UA_Boolean
  651. compatibleValue(UA_Server *server, const UA_NodeId *targetDataTypeId,
  652. UA_Int32 targetValueRank, size_t targetArrayDimensionsSize,
  653. const UA_UInt32 *targetArrayDimensions, const UA_Variant *value,
  654. const UA_NumericRange *range) {
  655. /* Empty value */
  656. if(!value->type) {
  657. /* Empty value is allowed for BaseDataType */
  658. if(UA_NodeId_equal(targetDataTypeId, &UA_TYPES[UA_TYPES_VARIANT].typeId) ||
  659. UA_NodeId_equal(targetDataTypeId, &UA_NODEID_NULL))
  660. return true;
  661. /* Workaround: Allow empty value if the target data type is abstract */
  662. const UA_Node *datatype = UA_Nodestore_get(server, targetDataTypeId);
  663. if(datatype && datatype->nodeClass == UA_NODECLASS_DATATYPE) {
  664. UA_Boolean isAbstract = ((const UA_DataTypeNode*)datatype)->isAbstract;
  665. UA_Nodestore_release(server, datatype);
  666. if(isAbstract)
  667. return true;
  668. }
  669. UA_LOG_INFO(server->config.logger, UA_LOGCATEGORY_SERVER,
  670. "Only Variables with data type BaseDataType may contain "
  671. "a null (empty) value");
  672. return false;
  673. }
  674. /* Has the value a subtype of the required type? BaseDataType (Variant) can
  675. * be anything... */
  676. if(!compatibleDataType(server, &value->type->typeId, targetDataTypeId, true))
  677. return false;
  678. /* Array dimensions are checked later when writing the range */
  679. if(range)
  680. return true;
  681. /* See if the array dimensions match. */
  682. if(!compatibleValueArrayDimensions(value, targetArrayDimensionsSize, targetArrayDimensions))
  683. return false;
  684. /* Check if the valuerank allows for the value dimension */
  685. return compatibleValueRankValue(targetValueRank, value);
  686. }
  687. /*****************/
  688. /* Write Service */
  689. /*****************/
  690. static void
  691. adjustValue(UA_Server *server, UA_Variant *value,
  692. const UA_NodeId *targetDataTypeId) {
  693. const UA_DataType *targetDataType = UA_findDataType(targetDataTypeId);
  694. if(!targetDataType)
  695. return;
  696. /* A string is written to a byte array. the valuerank and array dimensions
  697. * are checked later */
  698. if(targetDataType == &UA_TYPES[UA_TYPES_BYTE] &&
  699. value->type == &UA_TYPES[UA_TYPES_BYTESTRING] &&
  700. UA_Variant_isScalar(value)) {
  701. UA_ByteString *str = (UA_ByteString*)value->data;
  702. value->type = &UA_TYPES[UA_TYPES_BYTE];
  703. value->arrayLength = str->length;
  704. value->data = str->data;
  705. return;
  706. }
  707. /* An enum was sent as an int32, or an opaque type as a bytestring. This
  708. * is detected with the typeIndex indicating the "true" datatype. */
  709. enum type_equivalence te1 = typeEquivalence(targetDataType);
  710. enum type_equivalence te2 = typeEquivalence(value->type);
  711. if(te1 != TYPE_EQUIVALENCE_NONE && te1 == te2) {
  712. value->type = targetDataType;
  713. return;
  714. }
  715. /* No more possible equivalencies */
  716. }
  717. /* Stack layout: ... | node | type */
  718. static UA_StatusCode
  719. writeArrayDimensionsAttribute(UA_Server *server, UA_Session *session,
  720. UA_VariableNode *node, const UA_VariableTypeNode *type,
  721. size_t arrayDimensionsSize, UA_UInt32 *arrayDimensions) {
  722. UA_assert(node != NULL);
  723. UA_assert(type != NULL);
  724. /* If this is a variabletype, there must be no instances or subtypes of it
  725. * when we do the change */
  726. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  727. UA_Node_hasSubTypeOrInstances((UA_Node*)node)) {
  728. UA_LOG_INFO(server->config.logger, UA_LOGCATEGORY_SERVER,
  729. "Cannot change a variable type with existing instances");
  730. return UA_STATUSCODE_BADINTERNALERROR;
  731. }
  732. /* Check that the array dimensions match with the valuerank */
  733. if(!compatibleValueRankArrayDimensions(node->valueRank, arrayDimensionsSize)) {
  734. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  735. "The current value rank does not match the new array dimensions");
  736. return UA_STATUSCODE_BADTYPEMISMATCH;
  737. }
  738. /* Check if the array dimensions match with the wildcards in the
  739. * variabletype (dimension length 0) */
  740. if(type->arrayDimensions &&
  741. !compatibleArrayDimensions(type->arrayDimensionsSize, type->arrayDimensions,
  742. arrayDimensionsSize, arrayDimensions)) {
  743. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  744. "Array dimensions in the variable type do not match");
  745. return UA_STATUSCODE_BADTYPEMISMATCH;
  746. }
  747. /* Check if the current value is compatible with the array dimensions */
  748. UA_DataValue value;
  749. UA_DataValue_init(&value);
  750. UA_StatusCode retval = readValueAttribute(server, session, node, &value);
  751. if(retval != UA_STATUSCODE_GOOD)
  752. return retval;
  753. if(value.hasValue) {
  754. if(!compatibleValueArrayDimensions(&value.value, arrayDimensionsSize, arrayDimensions))
  755. retval = UA_STATUSCODE_BADTYPEMISMATCH;
  756. UA_DataValue_deleteMembers(&value);
  757. if(retval != UA_STATUSCODE_GOOD) {
  758. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  759. "Array dimensions in the current value do not match");
  760. return retval;
  761. }
  762. }
  763. /* Ok, apply */
  764. UA_UInt32 *oldArrayDimensions = node->arrayDimensions;
  765. size_t oldArrayDimensionsSize = node->arrayDimensionsSize;
  766. retval = UA_Array_copy(arrayDimensions, arrayDimensionsSize,
  767. (void**)&node->arrayDimensions,
  768. &UA_TYPES[UA_TYPES_UINT32]);
  769. if(retval != UA_STATUSCODE_GOOD)
  770. return retval;
  771. UA_Array_delete(oldArrayDimensions, oldArrayDimensionsSize, &UA_TYPES[UA_TYPES_UINT32]);
  772. node->arrayDimensionsSize = arrayDimensionsSize;
  773. return UA_STATUSCODE_GOOD;
  774. }
  775. /* Stack layout: ... | node | type */
  776. static UA_StatusCode
  777. writeValueRankAttribute(UA_Server *server, UA_Session *session,
  778. UA_VariableNode *node, const UA_VariableTypeNode *type,
  779. UA_Int32 valueRank) {
  780. UA_assert(node != NULL);
  781. UA_assert(type != NULL);
  782. UA_Int32 constraintValueRank = type->valueRank;
  783. /* If this is a variabletype, there must be no instances or subtypes of it
  784. * when we do the change */
  785. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  786. UA_Node_hasSubTypeOrInstances((const UA_Node*)node))
  787. return UA_STATUSCODE_BADINTERNALERROR;
  788. /* Check if the valuerank of the variabletype allows the change. */
  789. if(!compatibleValueRanks(valueRank, constraintValueRank))
  790. return UA_STATUSCODE_BADTYPEMISMATCH;
  791. /* Check if the new valuerank is compatible with the array dimensions. Use
  792. * the read service to handle data sources. */
  793. size_t arrayDims = node->arrayDimensionsSize;
  794. if(arrayDims == 0) {
  795. /* the value could be an array with no arrayDimensions defined.
  796. dimensions zero indicate a scalar for compatibleValueRankArrayDimensions. */
  797. UA_DataValue value;
  798. UA_DataValue_init(&value);
  799. UA_StatusCode retval = readValueAttribute(server, session, node, &value);
  800. if(retval != UA_STATUSCODE_GOOD)
  801. return retval;
  802. if(!value.hasValue || !value.value.type) {
  803. /* no value -> apply */
  804. node->valueRank = valueRank;
  805. return UA_STATUSCODE_GOOD;
  806. }
  807. if(!UA_Variant_isScalar(&value.value))
  808. arrayDims = 1;
  809. UA_DataValue_deleteMembers(&value);
  810. }
  811. if(!compatibleValueRankArrayDimensions(valueRank, arrayDims))
  812. return UA_STATUSCODE_BADTYPEMISMATCH;
  813. /* All good, apply the change */
  814. node->valueRank = valueRank;
  815. return UA_STATUSCODE_GOOD;
  816. }
  817. static UA_StatusCode
  818. writeDataTypeAttribute(UA_Server *server, UA_Session *session,
  819. UA_VariableNode *node, const UA_VariableTypeNode *type,
  820. const UA_NodeId *dataType) {
  821. UA_assert(node != NULL);
  822. UA_assert(type != NULL);
  823. /* If this is a variabletype, there must be no instances or subtypes of it
  824. when we do the change */
  825. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  826. UA_Node_hasSubTypeOrInstances((const UA_Node*)node))
  827. return UA_STATUSCODE_BADINTERNALERROR;
  828. /* Does the new type match the constraints of the variabletype? */
  829. if(!compatibleDataType(server, dataType, &type->dataType, false))
  830. return UA_STATUSCODE_BADTYPEMISMATCH;
  831. /* Check if the current value would match the new type */
  832. UA_DataValue value;
  833. UA_DataValue_init(&value);
  834. UA_StatusCode retval = readValueAttribute(server, session, node, &value);
  835. if(retval != UA_STATUSCODE_GOOD)
  836. return retval;
  837. if(value.hasValue) {
  838. if(!compatibleValue(server, dataType, node->valueRank,
  839. node->arrayDimensionsSize, node->arrayDimensions,
  840. &value.value, NULL))
  841. retval = UA_STATUSCODE_BADTYPEMISMATCH;
  842. UA_DataValue_deleteMembers(&value);
  843. if(retval != UA_STATUSCODE_GOOD) {
  844. UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
  845. "The current value does not match the new data type");
  846. return retval;
  847. }
  848. }
  849. /* Replace the datatype nodeid */
  850. UA_NodeId dtCopy = node->dataType;
  851. retval = UA_NodeId_copy(dataType, &node->dataType);
  852. if(retval != UA_STATUSCODE_GOOD) {
  853. node->dataType = dtCopy;
  854. return retval;
  855. }
  856. UA_NodeId_deleteMembers(&dtCopy);
  857. return UA_STATUSCODE_GOOD;
  858. }
  859. static UA_StatusCode
  860. writeValueAttributeWithoutRange(UA_VariableNode *node, const UA_DataValue *value) {
  861. UA_DataValue new_value;
  862. UA_StatusCode retval = UA_DataValue_copy(value, &new_value);
  863. if(retval != UA_STATUSCODE_GOOD)
  864. return retval;
  865. UA_DataValue_deleteMembers(&node->value.data.value);
  866. node->value.data.value = new_value;
  867. return UA_STATUSCODE_GOOD;
  868. }
  869. static UA_StatusCode
  870. writeValueAttributeWithRange(UA_VariableNode *node, const UA_DataValue *value,
  871. const UA_NumericRange *rangeptr) {
  872. /* Value on both sides? */
  873. if(value->status != node->value.data.value.status ||
  874. !value->hasValue || !node->value.data.value.hasValue)
  875. return UA_STATUSCODE_BADINDEXRANGEINVALID;
  876. /* Make scalar a one-entry array for range matching */
  877. UA_Variant editableValue;
  878. const UA_Variant *v = &value->value;
  879. if(UA_Variant_isScalar(&value->value)) {
  880. editableValue = value->value;
  881. editableValue.arrayLength = 1;
  882. v = &editableValue;
  883. }
  884. /* Check that the type is an exact match and not only "compatible" */
  885. if(!node->value.data.value.value.type || !v->type ||
  886. !UA_NodeId_equal(&node->value.data.value.value.type->typeId,
  887. &v->type->typeId))
  888. return UA_STATUSCODE_BADTYPEMISMATCH;
  889. /* Write the value */
  890. UA_StatusCode retval = UA_Variant_setRangeCopy(&node->value.data.value.value,
  891. v->data, v->arrayLength, *rangeptr);
  892. if(retval != UA_STATUSCODE_GOOD)
  893. return retval;
  894. /* Write the status and timestamps */
  895. node->value.data.value.hasStatus = value->hasStatus;
  896. node->value.data.value.status = value->status;
  897. node->value.data.value.hasSourceTimestamp = value->hasSourceTimestamp;
  898. node->value.data.value.sourceTimestamp = value->sourceTimestamp;
  899. node->value.data.value.hasSourcePicoseconds = value->hasSourcePicoseconds;
  900. node->value.data.value.sourcePicoseconds = value->sourcePicoseconds;
  901. return UA_STATUSCODE_GOOD;
  902. }
  903. /* Stack layout: ... | node */
  904. static UA_StatusCode
  905. writeValueAttribute(UA_Server *server, UA_Session *session,
  906. UA_VariableNode *node, const UA_DataValue *value,
  907. const UA_String *indexRange) {
  908. UA_assert(node != NULL);
  909. /* Parse the range */
  910. UA_NumericRange range;
  911. UA_NumericRange *rangeptr = NULL;
  912. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  913. if(indexRange && indexRange->length > 0) {
  914. retval = UA_NumericRange_parseFromString(&range, indexRange);
  915. if(retval != UA_STATUSCODE_GOOD)
  916. return retval;
  917. rangeptr = &range;
  918. }
  919. /* Created an editable version. The data is not touched. Only the variant
  920. * "container". */
  921. UA_DataValue adjustedValue = *value;
  922. /* Type checking. May change the type of editableValue */
  923. if(value->hasValue && value->value.type) {
  924. adjustValue(server, &adjustedValue.value, &node->dataType);
  925. /* The value may be an extension object, especially the nodeset compiler
  926. * uses extension objects to write variable values. If value is an
  927. * extension object we check if the current node value is also an
  928. * extension object. */
  929. UA_Boolean compatible;
  930. if(value->value.type->typeId.identifierType == UA_NODEIDTYPE_NUMERIC &&
  931. value->value.type->typeId.identifier.numeric == UA_NS0ID_STRUCTURE) {
  932. const UA_NodeId nodeDataType = UA_NODEID_NUMERIC(0, UA_NS0ID_STRUCTURE);
  933. compatible = compatibleValue(server, &nodeDataType, node->valueRank,
  934. node->arrayDimensionsSize, node->arrayDimensions,
  935. &adjustedValue.value, rangeptr);
  936. } else {
  937. compatible = compatibleValue(server, &node->dataType, node->valueRank,
  938. node->arrayDimensionsSize, node->arrayDimensions,
  939. &adjustedValue.value, rangeptr);
  940. }
  941. if(!compatible) {
  942. if(rangeptr)
  943. UA_free(range.dimensions);
  944. return UA_STATUSCODE_BADTYPEMISMATCH;
  945. }
  946. }
  947. /* Set the source timestamp if there is none */
  948. if(!adjustedValue.hasSourceTimestamp) {
  949. adjustedValue.sourceTimestamp = UA_DateTime_now();
  950. adjustedValue.hasSourceTimestamp = true;
  951. }
  952. /* Ok, do it */
  953. if(node->valueSource == UA_VALUESOURCE_DATA) {
  954. if(!rangeptr)
  955. retval = writeValueAttributeWithoutRange(node, &adjustedValue);
  956. else
  957. retval = writeValueAttributeWithRange(node, &adjustedValue, rangeptr);
  958. /* Callback after writing */
  959. if(retval == UA_STATUSCODE_GOOD && node->value.data.callback.onWrite)
  960. node->value.data.callback.onWrite(server, &session->sessionId,
  961. session->sessionHandle, &node->nodeId,
  962. node->context, rangeptr,
  963. &adjustedValue);
  964. } else {
  965. if(node->value.dataSource.write) {
  966. retval = node->value.dataSource.write(server, &session->sessionId,
  967. session->sessionHandle, &node->nodeId,
  968. node->context, rangeptr, &adjustedValue);
  969. } else {
  970. retval = UA_STATUSCODE_BADWRITENOTSUPPORTED;
  971. }
  972. }
  973. /* Clean up */
  974. if(rangeptr)
  975. UA_free(range.dimensions);
  976. return retval;
  977. }
  978. static UA_StatusCode
  979. writeIsAbstractAttribute(UA_Node *node, UA_Boolean value) {
  980. switch(node->nodeClass) {
  981. case UA_NODECLASS_OBJECTTYPE:
  982. ((UA_ObjectTypeNode*)node)->isAbstract = value;
  983. break;
  984. case UA_NODECLASS_REFERENCETYPE:
  985. ((UA_ReferenceTypeNode*)node)->isAbstract = value;
  986. break;
  987. case UA_NODECLASS_VARIABLETYPE:
  988. ((UA_VariableTypeNode*)node)->isAbstract = value;
  989. break;
  990. case UA_NODECLASS_DATATYPE:
  991. ((UA_DataTypeNode*)node)->isAbstract = value;
  992. break;
  993. default:
  994. return UA_STATUSCODE_BADNODECLASSINVALID;
  995. }
  996. return UA_STATUSCODE_GOOD;
  997. }
  998. /*****************/
  999. /* Write Service */
  1000. /*****************/
  1001. #define CHECK_DATATYPE_SCALAR(EXP_DT) \
  1002. if(!wvalue->value.hasValue || \
  1003. &UA_TYPES[UA_TYPES_##EXP_DT] != wvalue->value.value.type || \
  1004. !UA_Variant_isScalar(&wvalue->value.value)) { \
  1005. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  1006. break; \
  1007. }
  1008. #define CHECK_DATATYPE_ARRAY(EXP_DT) \
  1009. if(!wvalue->value.hasValue || \
  1010. &UA_TYPES[UA_TYPES_##EXP_DT] != wvalue->value.value.type || \
  1011. UA_Variant_isScalar(&wvalue->value.value)) { \
  1012. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  1013. break; \
  1014. }
  1015. #define CHECK_NODECLASS_WRITE(CLASS) \
  1016. if((node->nodeClass & (CLASS)) == 0) { \
  1017. retval = UA_STATUSCODE_BADNODECLASSINVALID; \
  1018. break; \
  1019. }
  1020. #define CHECK_USERWRITEMASK(mask) \
  1021. if(!(userWriteMask & (mask))) { \
  1022. retval = UA_STATUSCODE_BADUSERACCESSDENIED; \
  1023. break; \
  1024. }
  1025. #define GET_NODETYPE \
  1026. type = (const UA_VariableTypeNode*) \
  1027. getNodeType(server, node); \
  1028. if(!type) { \
  1029. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  1030. break; \
  1031. }
  1032. /* This function implements the main part of the write service and operates on a
  1033. copy of the node (not in single-threaded mode). */
  1034. static UA_StatusCode
  1035. copyAttributeIntoNode(UA_Server *server, UA_Session *session,
  1036. UA_Node *node, const UA_WriteValue *wvalue) {
  1037. const void *value = wvalue->value.value.data;
  1038. UA_UInt32 userWriteMask = getUserWriteMask(server, session, node);
  1039. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  1040. const UA_VariableTypeNode *type;
  1041. switch(wvalue->attributeId) {
  1042. case UA_ATTRIBUTEID_NODEID:
  1043. case UA_ATTRIBUTEID_NODECLASS:
  1044. case UA_ATTRIBUTEID_USERWRITEMASK:
  1045. case UA_ATTRIBUTEID_USERACCESSLEVEL:
  1046. case UA_ATTRIBUTEID_USEREXECUTABLE:
  1047. retval = UA_STATUSCODE_BADWRITENOTSUPPORTED;
  1048. break;
  1049. case UA_ATTRIBUTEID_BROWSENAME:
  1050. CHECK_USERWRITEMASK(UA_WRITEMASK_BROWSENAME);
  1051. CHECK_DATATYPE_SCALAR(QUALIFIEDNAME);
  1052. UA_QualifiedName_deleteMembers(&node->browseName);
  1053. UA_QualifiedName_copy((const UA_QualifiedName *)value, &node->browseName);
  1054. break;
  1055. case UA_ATTRIBUTEID_DISPLAYNAME:
  1056. CHECK_USERWRITEMASK(UA_WRITEMASK_DISPLAYNAME);
  1057. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  1058. UA_LocalizedText_deleteMembers(&node->displayName);
  1059. UA_LocalizedText_copy((const UA_LocalizedText *)value, &node->displayName);
  1060. break;
  1061. case UA_ATTRIBUTEID_DESCRIPTION:
  1062. CHECK_USERWRITEMASK(UA_WRITEMASK_DESCRIPTION);
  1063. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  1064. UA_LocalizedText_deleteMembers(&node->description);
  1065. UA_LocalizedText_copy((const UA_LocalizedText *)value, &node->description);
  1066. break;
  1067. case UA_ATTRIBUTEID_WRITEMASK:
  1068. CHECK_USERWRITEMASK(UA_WRITEMASK_WRITEMASK);
  1069. CHECK_DATATYPE_SCALAR(UINT32);
  1070. node->writeMask = *(const UA_UInt32*)value;
  1071. break;
  1072. case UA_ATTRIBUTEID_ISABSTRACT:
  1073. CHECK_USERWRITEMASK(UA_WRITEMASK_ISABSTRACT);
  1074. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1075. retval = writeIsAbstractAttribute(node, *(const UA_Boolean*)value);
  1076. break;
  1077. case UA_ATTRIBUTEID_SYMMETRIC:
  1078. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  1079. CHECK_USERWRITEMASK(UA_WRITEMASK_SYMMETRIC);
  1080. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1081. ((UA_ReferenceTypeNode*)node)->symmetric = *(const UA_Boolean*)value;
  1082. break;
  1083. case UA_ATTRIBUTEID_INVERSENAME:
  1084. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  1085. CHECK_USERWRITEMASK(UA_WRITEMASK_INVERSENAME);
  1086. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  1087. UA_LocalizedText_deleteMembers(&((UA_ReferenceTypeNode*)node)->inverseName);
  1088. UA_LocalizedText_copy((const UA_LocalizedText *)value,
  1089. &((UA_ReferenceTypeNode*)node)->inverseName);
  1090. break;
  1091. case UA_ATTRIBUTEID_CONTAINSNOLOOPS:
  1092. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW);
  1093. CHECK_USERWRITEMASK(UA_WRITEMASK_CONTAINSNOLOOPS);
  1094. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1095. ((UA_ViewNode*)node)->containsNoLoops = *(const UA_Boolean*)value;
  1096. break;
  1097. case UA_ATTRIBUTEID_EVENTNOTIFIER:
  1098. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW | UA_NODECLASS_OBJECT);
  1099. CHECK_USERWRITEMASK(UA_WRITEMASK_EVENTNOTIFIER);
  1100. CHECK_DATATYPE_SCALAR(BYTE);
  1101. ((UA_ViewNode*)node)->eventNotifier = *(const UA_Byte*)value;
  1102. break;
  1103. case UA_ATTRIBUTEID_VALUE:
  1104. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1105. if(node->nodeClass == UA_NODECLASS_VARIABLE) {
  1106. /* The access to a value variable is granted via the AccessLevel
  1107. * and UserAccessLevel attributes */
  1108. UA_Byte accessLevel = getAccessLevel(server, session, (const UA_VariableNode*)node);
  1109. if(!(accessLevel & (UA_ACCESSLEVELMASK_WRITE))) {
  1110. retval = UA_STATUSCODE_BADNOTWRITABLE;
  1111. break;
  1112. }
  1113. accessLevel = getUserAccessLevel(server, session,
  1114. (const UA_VariableNode*)node);
  1115. if(!(accessLevel & (UA_ACCESSLEVELMASK_WRITE))) {
  1116. retval = UA_STATUSCODE_BADUSERACCESSDENIED;
  1117. break;
  1118. }
  1119. } else { /* UA_NODECLASS_VARIABLETYPE */
  1120. CHECK_USERWRITEMASK(UA_WRITEMASK_VALUEFORVARIABLETYPE);
  1121. }
  1122. retval = writeValueAttribute(server, session, (UA_VariableNode*)node,
  1123. &wvalue->value, &wvalue->indexRange);
  1124. break;
  1125. case UA_ATTRIBUTEID_DATATYPE:
  1126. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1127. CHECK_USERWRITEMASK(UA_WRITEMASK_DATATYPE);
  1128. CHECK_DATATYPE_SCALAR(NODEID);
  1129. GET_NODETYPE
  1130. retval = writeDataTypeAttribute(server, session, (UA_VariableNode*)node,
  1131. type, (const UA_NodeId*)value);
  1132. UA_Nodestore_release(server, (const UA_Node*)type);
  1133. break;
  1134. case UA_ATTRIBUTEID_VALUERANK:
  1135. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1136. CHECK_USERWRITEMASK(UA_WRITEMASK_VALUERANK);
  1137. CHECK_DATATYPE_SCALAR(INT32);
  1138. GET_NODETYPE
  1139. retval = writeValueRankAttribute(server, session, (UA_VariableNode*)node,
  1140. type, *(const UA_Int32*)value);
  1141. UA_Nodestore_release(server, (const UA_Node*)type);
  1142. break;
  1143. case UA_ATTRIBUTEID_ARRAYDIMENSIONS:
  1144. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1145. CHECK_USERWRITEMASK(UA_WRITEMASK_ARRRAYDIMENSIONS);
  1146. CHECK_DATATYPE_ARRAY(UINT32);
  1147. GET_NODETYPE
  1148. retval = writeArrayDimensionsAttribute(server, session, (UA_VariableNode*)node,
  1149. type, wvalue->value.value.arrayLength,
  1150. (UA_UInt32 *)wvalue->value.value.data);
  1151. UA_Nodestore_release(server, (const UA_Node*)type);
  1152. break;
  1153. case UA_ATTRIBUTEID_ACCESSLEVEL:
  1154. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1155. CHECK_USERWRITEMASK(UA_WRITEMASK_ACCESSLEVEL);
  1156. CHECK_DATATYPE_SCALAR(BYTE);
  1157. ((UA_VariableNode*)node)->accessLevel = *(const UA_Byte*)value;
  1158. break;
  1159. case UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL:
  1160. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1161. CHECK_USERWRITEMASK(UA_WRITEMASK_MINIMUMSAMPLINGINTERVAL);
  1162. CHECK_DATATYPE_SCALAR(DOUBLE);
  1163. ((UA_VariableNode*)node)->minimumSamplingInterval = *(const UA_Double*)value;
  1164. break;
  1165. case UA_ATTRIBUTEID_HISTORIZING:
  1166. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1167. CHECK_USERWRITEMASK(UA_WRITEMASK_HISTORIZING);
  1168. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1169. ((UA_VariableNode*)node)->historizing = *(const UA_Boolean*)value;
  1170. break;
  1171. case UA_ATTRIBUTEID_EXECUTABLE:
  1172. CHECK_NODECLASS_WRITE(UA_NODECLASS_METHOD);
  1173. CHECK_USERWRITEMASK(UA_WRITEMASK_EXECUTABLE);
  1174. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1175. ((UA_MethodNode*)node)->executable = *(const UA_Boolean*)value;
  1176. break;
  1177. default:
  1178. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  1179. break;
  1180. }
  1181. if(retval != UA_STATUSCODE_GOOD)
  1182. UA_LOG_INFO_SESSION(server->config.logger, session,
  1183. "WriteRequest returned status code %s",
  1184. UA_StatusCode_name(retval));
  1185. return retval;
  1186. }
  1187. static void
  1188. Operation_Write(UA_Server *server, UA_Session *session, void *context,
  1189. UA_WriteValue *wv, UA_StatusCode *result) {
  1190. *result = UA_Server_editNode(server, session, &wv->nodeId,
  1191. (UA_EditNodeCallback)copyAttributeIntoNode, wv);
  1192. }
  1193. void
  1194. Service_Write(UA_Server *server, UA_Session *session,
  1195. const UA_WriteRequest *request,
  1196. UA_WriteResponse *response) {
  1197. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  1198. "Processing WriteRequest");
  1199. if(server->config.maxNodesPerWrite != 0 &&
  1200. request->nodesToWriteSize > server->config.maxNodesPerWrite) {
  1201. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  1202. return;
  1203. }
  1204. response->responseHeader.serviceResult =
  1205. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_Write, NULL,
  1206. &request->nodesToWriteSize, &UA_TYPES[UA_TYPES_WRITEVALUE],
  1207. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  1208. }
  1209. UA_StatusCode
  1210. UA_Server_write(UA_Server *server, const UA_WriteValue *value) {
  1211. UA_StatusCode retval =
  1212. UA_Server_editNode(server, &adminSession, &value->nodeId,
  1213. (UA_EditNodeCallback)copyAttributeIntoNode,
  1214. /* casting away const qualifier because callback uses const anyway */
  1215. (UA_WriteValue *)(uintptr_t)value);
  1216. return retval;
  1217. }
  1218. /* Convenience function to be wrapped into inline functions */
  1219. UA_StatusCode
  1220. __UA_Server_write(UA_Server *server, const UA_NodeId *nodeId,
  1221. const UA_AttributeId attributeId,
  1222. const UA_DataType *attr_type,
  1223. const void *attr) {
  1224. UA_WriteValue wvalue;
  1225. UA_WriteValue_init(&wvalue);
  1226. wvalue.nodeId = *nodeId;
  1227. wvalue.attributeId = attributeId;
  1228. wvalue.value.hasValue = true;
  1229. if(attr_type != &UA_TYPES[UA_TYPES_VARIANT]) {
  1230. /* hacked cast. the target WriteValue is used as const anyway */
  1231. UA_Variant_setScalar(&wvalue.value.value,
  1232. (void*)(uintptr_t)attr, attr_type);
  1233. } else {
  1234. wvalue.value.value = *(const UA_Variant*)attr;
  1235. }
  1236. return UA_Server_write(server, &wvalue);
  1237. }
  1238. UA_StatusCode UA_EXPORT
  1239. UA_Server_writeObjectProperty(UA_Server *server, const UA_NodeId objectId,
  1240. const UA_QualifiedName propertyName,
  1241. const UA_Variant value) {
  1242. UA_RelativePathElement rpe;
  1243. UA_RelativePathElement_init(&rpe);
  1244. rpe.referenceTypeId = UA_NODEID_NUMERIC(0, UA_NS0ID_HASPROPERTY);
  1245. rpe.isInverse = false;
  1246. rpe.includeSubtypes = false;
  1247. rpe.targetName = propertyName;
  1248. UA_BrowsePath bp;
  1249. UA_BrowsePath_init(&bp);
  1250. bp.startingNode = objectId;
  1251. bp.relativePath.elementsSize = 1;
  1252. bp.relativePath.elements = &rpe;
  1253. UA_StatusCode retval;
  1254. UA_BrowsePathResult bpr = UA_Server_translateBrowsePathToNodeIds(server, &bp);
  1255. if(bpr.statusCode != UA_STATUSCODE_GOOD || bpr.targetsSize < 1) {
  1256. retval = bpr.statusCode;
  1257. UA_BrowsePathResult_deleteMembers(&bpr);
  1258. return retval;
  1259. }
  1260. retval = UA_Server_writeValue(server, bpr.targets[0].targetId.nodeId, value);
  1261. UA_BrowsePathResult_deleteMembers(&bpr);
  1262. return retval;
  1263. }
  1264. UA_StatusCode UA_EXPORT
  1265. UA_Server_writeObjectProperty_scalar(UA_Server *server, const UA_NodeId objectId,
  1266. const UA_QualifiedName propertyName,
  1267. const void *value, const UA_DataType *type) {
  1268. UA_Variant var;
  1269. UA_Variant_init(&var);
  1270. UA_Variant_setScalar(&var, (void*)(uintptr_t)value, type);
  1271. return UA_Server_writeObjectProperty(server, objectId, propertyName, var);
  1272. }