ua_services_attribute.c 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757
  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. #ifdef UA_ENABLE_HISTORIZING
  24. #include <open62541/plugin/historydatabase.h>
  25. #endif
  26. /******************/
  27. /* Access Control */
  28. /******************/
  29. static UA_UInt32
  30. getUserWriteMask(UA_Server *server, const UA_Session *session,
  31. const UA_Node *node) {
  32. if(session == &server->adminSession)
  33. return 0xFFFFFFFF; /* the local admin user has all rights */
  34. UA_UInt32 retval = node->writeMask;
  35. UA_UNLOCK(server->serviceMutex);
  36. retval &= server->config.accessControl.getUserRightsMask(server, &server->config.accessControl,
  37. &session->sessionId, session->sessionHandle,
  38. &node->nodeId, node->context);
  39. UA_LOCK(server->serviceMutex);
  40. return retval;
  41. }
  42. static UA_Byte
  43. getAccessLevel(UA_Server *server, const UA_Session *session,
  44. const UA_VariableNode *node) {
  45. if(session == &server->adminSession)
  46. return 0xFF; /* the local admin user has all rights */
  47. return node->accessLevel;
  48. }
  49. static UA_Byte
  50. getUserAccessLevel(UA_Server *server, const UA_Session *session,
  51. const UA_VariableNode *node) {
  52. if(session == &server->adminSession)
  53. return 0xFF; /* the local admin user has all rights */
  54. UA_Byte retval = node->accessLevel;
  55. UA_UNLOCK(server->serviceMutex);
  56. retval &= server->config.accessControl.getUserAccessLevel(server, &server->config.accessControl,
  57. &session->sessionId, session->sessionHandle,
  58. &node->nodeId, node->context);
  59. UA_LOCK(server->serviceMutex);
  60. return retval;
  61. }
  62. static UA_Boolean
  63. getUserExecutable(UA_Server *server, const UA_Session *session,
  64. const UA_MethodNode *node) {
  65. if(session == &server->adminSession)
  66. return true; /* the local admin user has all rights */
  67. UA_Boolean retval = node->executable;
  68. UA_UNLOCK(server->serviceMutex);
  69. retval &= server->config.accessControl.getUserExecutable(server, &server->config.accessControl,
  70. &session->sessionId, session->sessionHandle,
  71. &node->nodeId, node->context);
  72. UA_LOCK(server->serviceMutex);
  73. return retval;
  74. }
  75. /****************/
  76. /* Read Service */
  77. /****************/
  78. static UA_StatusCode
  79. readIsAbstractAttribute(const UA_Node *node, UA_Variant *v) {
  80. const UA_Boolean *isAbstract;
  81. switch(node->nodeClass) {
  82. case UA_NODECLASS_REFERENCETYPE:
  83. isAbstract = &((const UA_ReferenceTypeNode*)node)->isAbstract;
  84. break;
  85. case UA_NODECLASS_OBJECTTYPE:
  86. isAbstract = &((const UA_ObjectTypeNode*)node)->isAbstract;
  87. break;
  88. case UA_NODECLASS_VARIABLETYPE:
  89. isAbstract = &((const UA_VariableTypeNode*)node)->isAbstract;
  90. break;
  91. case UA_NODECLASS_DATATYPE:
  92. isAbstract = &((const UA_DataTypeNode*)node)->isAbstract;
  93. break;
  94. default:
  95. return UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  96. }
  97. return UA_Variant_setScalarCopy(v, isAbstract, &UA_TYPES[UA_TYPES_BOOLEAN]);
  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. /* Update the value by the user callback */
  104. if(vn->value.data.callback.onRead) {
  105. UA_UNLOCK(server->serviceMutex);
  106. vn->value.data.callback.onRead(server, &session->sessionId,
  107. session->sessionHandle, &vn->nodeId,
  108. vn->context, rangeptr, &vn->value.data.value);
  109. UA_LOCK(server->serviceMutex);
  110. vn = (const UA_VariableNode*)UA_NODESTORE_GET(server, &vn->nodeId);
  111. if(!vn)
  112. return UA_STATUSCODE_BADNODEIDUNKNOWN;
  113. }
  114. /* Set the result */
  115. if(rangeptr)
  116. return UA_Variant_copyRange(&vn->value.data.value.value, &v->value, *rangeptr);
  117. UA_StatusCode retval = UA_DataValue_copy(&vn->value.data.value, v);
  118. /* Clean up */
  119. if(vn->value.data.callback.onRead)
  120. UA_NODESTORE_RELEASE(server, (const UA_Node *)vn);
  121. return retval;
  122. }
  123. static UA_StatusCode
  124. readValueAttributeFromDataSource(UA_Server *server, UA_Session *session,
  125. const UA_VariableNode *vn, UA_DataValue *v,
  126. UA_TimestampsToReturn timestamps,
  127. UA_NumericRange *rangeptr) {
  128. if(!vn->value.dataSource.read)
  129. return UA_STATUSCODE_BADINTERNALERROR;
  130. UA_Boolean sourceTimeStamp = (timestamps == UA_TIMESTAMPSTORETURN_SOURCE ||
  131. timestamps == UA_TIMESTAMPSTORETURN_BOTH);
  132. UA_DataValue v2;
  133. UA_DataValue_init(&v2);
  134. UA_UNLOCK(server->serviceMutex);
  135. UA_StatusCode retval = vn->value.dataSource.
  136. read(server, &session->sessionId, session->sessionHandle,
  137. &vn->nodeId, vn->context, sourceTimeStamp, rangeptr, &v2);
  138. UA_LOCK(server->serviceMutex);
  139. if(v2.hasValue && v2.value.storageType == UA_VARIANT_DATA_NODELETE) {
  140. retval = UA_DataValue_copy(&v2, v);
  141. UA_DataValue_clear(&v2);
  142. } else {
  143. *v = v2;
  144. }
  145. return retval;
  146. }
  147. static UA_StatusCode
  148. readValueAttributeComplete(UA_Server *server, UA_Session *session,
  149. const UA_VariableNode *vn, UA_TimestampsToReturn timestamps,
  150. const UA_String *indexRange, UA_DataValue *v) {
  151. /* Compute the index range */
  152. UA_NumericRange range;
  153. UA_NumericRange *rangeptr = NULL;
  154. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  155. if(indexRange && indexRange->length > 0) {
  156. retval = UA_NumericRange_parseFromString(&range, indexRange);
  157. if(retval != UA_STATUSCODE_GOOD)
  158. return retval;
  159. rangeptr = &range;
  160. }
  161. /* Read the value */
  162. if(vn->valueSource == UA_VALUESOURCE_DATA)
  163. retval = readValueAttributeFromNode(server, session, vn, v, rangeptr);
  164. else
  165. retval = readValueAttributeFromDataSource(server, session, vn, v, timestamps, rangeptr);
  166. /* Clean up */
  167. if(rangeptr)
  168. UA_free(range.dimensions);
  169. return retval;
  170. }
  171. UA_StatusCode
  172. readValueAttribute(UA_Server *server, UA_Session *session,
  173. const UA_VariableNode *vn, UA_DataValue *v) {
  174. return readValueAttributeComplete(server, session, vn, UA_TIMESTAMPSTORETURN_NEITHER, NULL, v);
  175. }
  176. static const UA_String binEncoding = {sizeof("Default Binary")-1, (UA_Byte*)"Default Binary"};
  177. static const UA_String xmlEncoding = {sizeof("Default XML")-1, (UA_Byte*)"Default XML"};
  178. static const UA_String jsonEncoding = {sizeof("Default JSON")-1, (UA_Byte*)"Default JSON"};
  179. #define CHECK_NODECLASS(CLASS) \
  180. if(!(node->nodeClass & (CLASS))) { \
  181. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID; \
  182. break; \
  183. }
  184. #ifdef UA_ENABLE_TYPEDESCRIPTION
  185. static const UA_DataType *
  186. findDataType(const UA_Node *node, const UA_DataTypeArray *customTypes) {
  187. for(size_t i = 0; i < UA_TYPES_COUNT; ++i) {
  188. if(UA_NodeId_equal(&UA_TYPES[i].typeId, &node->nodeId)) {
  189. return &UA_TYPES[i];
  190. }
  191. }
  192. // lookup custom type
  193. while(customTypes) {
  194. for(size_t i = 0; i < customTypes->typesSize; ++i) {
  195. if(UA_NodeId_equal(&customTypes->types[i].typeId, &node->nodeId))
  196. return &customTypes->types[i];
  197. }
  198. customTypes = customTypes->next;
  199. }
  200. return NULL;
  201. }
  202. static UA_StatusCode
  203. getStructureDefinition(const UA_DataType *type, UA_StructureDefinition *def) {
  204. def->baseDataType = UA_NODEID_NUMERIC(0, UA_NS0ID_STRUCTURE);
  205. def->defaultEncodingId =
  206. UA_NODEID_NUMERIC(type->typeId.namespaceIndex, type->binaryEncodingId);
  207. def->structureType = UA_STRUCTURETYPE_STRUCTURE;
  208. def->fieldsSize = type->membersSize;
  209. def->fields =
  210. (UA_StructureField *)UA_calloc(def->fieldsSize, sizeof(UA_StructureField));
  211. if(!def->fields) {
  212. return UA_STATUSCODE_BADOUTOFMEMORY;
  213. }
  214. const UA_DataType *typelists[2] = {UA_TYPES, &type[-type->typeIndex]};
  215. for(size_t cnt = 0; cnt < def->fieldsSize; cnt++) {
  216. const UA_DataTypeMember *m = &type->members[cnt];
  217. def->fields[cnt].valueRank = UA_TRUE == m->isArray ? 1 : -1;
  218. def->fields[cnt].arrayDimensions = NULL;
  219. def->fields[cnt].arrayDimensionsSize = 0;
  220. def->fields[cnt].name =
  221. UA_STRING((char *)(uintptr_t)m->memberName);
  222. def->fields[cnt].description.locale = UA_STRING_NULL;
  223. def->fields[cnt].description.text = UA_STRING_NULL;
  224. def->fields[cnt].dataType = typelists[!m->namespaceZero][m->memberTypeIndex].typeId;
  225. def->fields[cnt].maxStringLength = 0;
  226. }
  227. return UA_STATUSCODE_GOOD;
  228. }
  229. #endif
  230. /* Returns a datavalue that may point into the node via the
  231. * UA_VARIANT_DATA_NODELETE tag. Don't access the returned DataValue once the
  232. * node has been released! */
  233. void
  234. ReadWithNode(const UA_Node *node, UA_Server *server, UA_Session *session,
  235. UA_TimestampsToReturn timestampsToReturn,
  236. const UA_ReadValueId *id, UA_DataValue *v) {
  237. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  238. "Read the attribute %i", id->attributeId);
  239. /* Only Binary Encoding is supported */
  240. if(id->dataEncoding.name.length > 0 &&
  241. !UA_String_equal(&binEncoding, &id->dataEncoding.name)) {
  242. if(UA_String_equal(&xmlEncoding, &id->dataEncoding.name) ||
  243. UA_String_equal(&jsonEncoding, &id->dataEncoding.name))
  244. v->status = UA_STATUSCODE_BADDATAENCODINGUNSUPPORTED;
  245. else
  246. v->status = UA_STATUSCODE_BADDATAENCODINGINVALID;
  247. v->hasStatus = true;
  248. return;
  249. }
  250. /* Index range for an attribute other than value */
  251. if(id->indexRange.length > 0 && id->attributeId != UA_ATTRIBUTEID_VALUE) {
  252. v->hasStatus = true;
  253. v->status = UA_STATUSCODE_BADINDEXRANGENODATA;
  254. return;
  255. }
  256. /* Read the attribute */
  257. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  258. switch(id->attributeId) {
  259. case UA_ATTRIBUTEID_NODEID:
  260. retval = UA_Variant_setScalarCopy(&v->value, &node->nodeId, &UA_TYPES[UA_TYPES_NODEID]);
  261. break;
  262. case UA_ATTRIBUTEID_NODECLASS:
  263. retval = UA_Variant_setScalarCopy(&v->value, &node->nodeClass, &UA_TYPES[UA_TYPES_NODECLASS]);
  264. break;
  265. case UA_ATTRIBUTEID_BROWSENAME:
  266. retval = UA_Variant_setScalarCopy(&v->value, &node->browseName, &UA_TYPES[UA_TYPES_QUALIFIEDNAME]);
  267. break;
  268. case UA_ATTRIBUTEID_DISPLAYNAME:
  269. retval = UA_Variant_setScalarCopy(&v->value, &node->displayName, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  270. break;
  271. case UA_ATTRIBUTEID_DESCRIPTION:
  272. retval = UA_Variant_setScalarCopy(&v->value, &node->description, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  273. break;
  274. case UA_ATTRIBUTEID_WRITEMASK:
  275. retval = UA_Variant_setScalarCopy(&v->value, &node->writeMask, &UA_TYPES[UA_TYPES_UINT32]);
  276. break;
  277. case UA_ATTRIBUTEID_USERWRITEMASK: {
  278. UA_UInt32 userWriteMask = getUserWriteMask(server, session, node);
  279. retval = UA_Variant_setScalarCopy(&v->value, &userWriteMask, &UA_TYPES[UA_TYPES_UINT32]);
  280. break; }
  281. case UA_ATTRIBUTEID_ISABSTRACT:
  282. retval = readIsAbstractAttribute(node, &v->value);
  283. break;
  284. case UA_ATTRIBUTEID_SYMMETRIC:
  285. CHECK_NODECLASS(UA_NODECLASS_REFERENCETYPE);
  286. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_ReferenceTypeNode*)node)->symmetric,
  287. &UA_TYPES[UA_TYPES_BOOLEAN]);
  288. break;
  289. case UA_ATTRIBUTEID_INVERSENAME:
  290. CHECK_NODECLASS(UA_NODECLASS_REFERENCETYPE);
  291. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_ReferenceTypeNode*)node)->inverseName,
  292. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]);
  293. break;
  294. case UA_ATTRIBUTEID_CONTAINSNOLOOPS:
  295. CHECK_NODECLASS(UA_NODECLASS_VIEW);
  296. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_ViewNode*)node)->containsNoLoops,
  297. &UA_TYPES[UA_TYPES_BOOLEAN]);
  298. break;
  299. case UA_ATTRIBUTEID_EVENTNOTIFIER:
  300. CHECK_NODECLASS(UA_NODECLASS_VIEW | UA_NODECLASS_OBJECT);
  301. if(node->nodeClass == UA_NODECLASS_VIEW) {
  302. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_ViewNode*)node)->eventNotifier,
  303. &UA_TYPES[UA_TYPES_BYTE]);
  304. }
  305. else{
  306. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_ObjectNode*)node)->eventNotifier,
  307. &UA_TYPES[UA_TYPES_BYTE]);
  308. }
  309. break;
  310. case UA_ATTRIBUTEID_VALUE: {
  311. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  312. /* VariableTypes don't have the AccessLevel concept. Always allow reading the value. */
  313. if(node->nodeClass == UA_NODECLASS_VARIABLE) {
  314. /* The access to a value variable is granted via the AccessLevel
  315. * and UserAccessLevel attributes */
  316. UA_Byte accessLevel = getAccessLevel(server, session, (const UA_VariableNode*)node);
  317. if(!(accessLevel & (UA_ACCESSLEVELMASK_READ))) {
  318. retval = UA_STATUSCODE_BADNOTREADABLE;
  319. break;
  320. }
  321. accessLevel = getUserAccessLevel(server, session,
  322. (const UA_VariableNode*)node);
  323. if(!(accessLevel & (UA_ACCESSLEVELMASK_READ))) {
  324. retval = UA_STATUSCODE_BADUSERACCESSDENIED;
  325. break;
  326. }
  327. }
  328. retval = readValueAttributeComplete(server, session, (const UA_VariableNode*)node,
  329. timestampsToReturn, &id->indexRange, v);
  330. break;
  331. }
  332. case UA_ATTRIBUTEID_DATATYPE:
  333. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  334. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_VariableTypeNode*)node)->dataType,
  335. &UA_TYPES[UA_TYPES_NODEID]);
  336. break;
  337. case UA_ATTRIBUTEID_VALUERANK:
  338. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  339. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_VariableTypeNode*)node)->valueRank,
  340. &UA_TYPES[UA_TYPES_INT32]);
  341. break;
  342. case UA_ATTRIBUTEID_ARRAYDIMENSIONS:
  343. CHECK_NODECLASS(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  344. retval = UA_Variant_setArrayCopy(&v->value, ((const UA_VariableTypeNode*)node)->arrayDimensions,
  345. ((const UA_VariableTypeNode*)node)->arrayDimensionsSize,
  346. &UA_TYPES[UA_TYPES_UINT32]);
  347. break;
  348. case UA_ATTRIBUTEID_ACCESSLEVEL:
  349. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  350. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_VariableNode*)node)->accessLevel,
  351. &UA_TYPES[UA_TYPES_BYTE]);
  352. break;
  353. case UA_ATTRIBUTEID_USERACCESSLEVEL: {
  354. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  355. UA_Byte userAccessLevel = getUserAccessLevel(server, session, (const UA_VariableNode*)node);
  356. retval = UA_Variant_setScalarCopy(&v->value, &userAccessLevel, &UA_TYPES[UA_TYPES_BYTE]);
  357. break; }
  358. case UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL:
  359. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  360. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_VariableNode*)node)->minimumSamplingInterval,
  361. &UA_TYPES[UA_TYPES_DOUBLE]);
  362. break;
  363. case UA_ATTRIBUTEID_HISTORIZING:
  364. CHECK_NODECLASS(UA_NODECLASS_VARIABLE);
  365. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_VariableNode*)node)->historizing,
  366. &UA_TYPES[UA_TYPES_BOOLEAN]);
  367. break;
  368. case UA_ATTRIBUTEID_EXECUTABLE:
  369. CHECK_NODECLASS(UA_NODECLASS_METHOD);
  370. retval = UA_Variant_setScalarCopy(&v->value, &((const UA_MethodNode*)node)->executable,
  371. &UA_TYPES[UA_TYPES_BOOLEAN]);
  372. break;
  373. case UA_ATTRIBUTEID_USEREXECUTABLE: {
  374. CHECK_NODECLASS(UA_NODECLASS_METHOD);
  375. UA_Boolean userExecutable = getUserExecutable(server, session, (const UA_MethodNode*)node);
  376. retval = UA_Variant_setScalarCopy(&v->value, &userExecutable, &UA_TYPES[UA_TYPES_BOOLEAN]);
  377. break; }
  378. case UA_ATTRIBUTEID_DATATYPEDEFINITION: {
  379. CHECK_NODECLASS(UA_NODECLASS_DATATYPE);
  380. #ifdef UA_ENABLE_TYPEDESCRIPTION
  381. const UA_DataType *type = findDataType(node, server->config.customDataTypes);
  382. if(!type) {
  383. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  384. break;
  385. }
  386. if(UA_DATATYPEKIND_STRUCTURE == type->typeKind ||
  387. UA_DATATYPEKIND_OPTSTRUCT == type->typeKind) {
  388. UA_StructureDefinition def;
  389. retval = getStructureDefinition(type, &def);
  390. if(UA_STATUSCODE_GOOD!=retval)
  391. break;
  392. retval = UA_Variant_setScalarCopy(&v->value, &def,
  393. &UA_TYPES[UA_TYPES_STRUCTUREDEFINITION]);
  394. UA_free(def.fields);
  395. break;
  396. }
  397. #endif
  398. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  399. break; }
  400. default:
  401. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  402. }
  403. /* Return error code when reading has failed */
  404. if(retval != UA_STATUSCODE_GOOD) {
  405. v->hasStatus = true;
  406. v->status = retval;
  407. return;
  408. }
  409. v->hasValue = true;
  410. /* Create server timestamp */
  411. if(timestampsToReturn == UA_TIMESTAMPSTORETURN_SERVER ||
  412. timestampsToReturn == UA_TIMESTAMPSTORETURN_BOTH) {
  413. if (!v->hasServerTimestamp) {
  414. v->serverTimestamp = UA_DateTime_now();
  415. v->hasServerTimestamp = true;
  416. }
  417. } else {
  418. /* In case the ServerTimestamp has been set manually */
  419. v->hasServerTimestamp = false;
  420. }
  421. /* Handle source time stamp */
  422. if(id->attributeId == UA_ATTRIBUTEID_VALUE) {
  423. if(timestampsToReturn == UA_TIMESTAMPSTORETURN_SERVER ||
  424. timestampsToReturn == UA_TIMESTAMPSTORETURN_NEITHER) {
  425. v->hasSourceTimestamp = false;
  426. v->hasSourcePicoseconds = false;
  427. } else if(!v->hasSourceTimestamp) {
  428. v->sourceTimestamp = UA_DateTime_now();
  429. v->hasSourceTimestamp = true;
  430. }
  431. }
  432. }
  433. static void
  434. Operation_Read(UA_Server *server, UA_Session *session, UA_ReadRequest *request,
  435. UA_ReadValueId *rvi, UA_DataValue *result) {
  436. /* Get the node */
  437. const UA_Node *node = UA_NODESTORE_GET(server, &rvi->nodeId);
  438. /* Perform the read operation */
  439. if(node) {
  440. ReadWithNode(node, server, session, request->timestampsToReturn, rvi, result);
  441. UA_NODESTORE_RELEASE(server, node);
  442. } else {
  443. result->hasStatus = true;
  444. result->status = UA_STATUSCODE_BADNODEIDUNKNOWN;
  445. }
  446. }
  447. void
  448. Service_Read(UA_Server *server, UA_Session *session,
  449. const UA_ReadRequest *request, UA_ReadResponse *response) {
  450. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing ReadRequest");
  451. UA_LOCK_ASSERT(server->serviceMutex, 1);
  452. /* Check if the timestampstoreturn is valid */
  453. if(request->timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  454. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  455. return;
  456. }
  457. /* Check if maxAge is valid */
  458. if(request->maxAge < 0) {
  459. response->responseHeader.serviceResult = UA_STATUSCODE_BADMAXAGEINVALID;
  460. return;
  461. }
  462. /* Check if there are too many operations */
  463. if(server->config.maxNodesPerRead != 0 &&
  464. request->nodesToReadSize > server->config.maxNodesPerRead) {
  465. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  466. return;
  467. }
  468. UA_LOCK_ASSERT(server->serviceMutex, 1);
  469. response->responseHeader.serviceResult =
  470. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_Read,
  471. request,
  472. &request->nodesToReadSize, &UA_TYPES[UA_TYPES_READVALUEID],
  473. &response->resultsSize, &UA_TYPES[UA_TYPES_DATAVALUE]);
  474. }
  475. UA_DataValue
  476. UA_Server_readWithSession(UA_Server *server, UA_Session *session,
  477. const UA_ReadValueId *item,
  478. UA_TimestampsToReturn timestampsToReturn) {
  479. UA_DataValue dv;
  480. UA_DataValue_init(&dv);
  481. /* Get the node */
  482. const UA_Node *node = UA_NODESTORE_GET(server, &item->nodeId);
  483. if(!node) {
  484. dv.hasStatus = true;
  485. dv.status = UA_STATUSCODE_BADNODEIDUNKNOWN;
  486. return dv;
  487. }
  488. /* Perform the read operation */
  489. ReadWithNode(node, server, session, timestampsToReturn, item, &dv);
  490. /* Release the node and return */
  491. UA_NODESTORE_RELEASE(server, node);
  492. return dv;
  493. }
  494. UA_DataValue
  495. readAttribute(UA_Server *server, const UA_ReadValueId *item,
  496. UA_TimestampsToReturn timestamps) {
  497. UA_LOCK_ASSERT(server->serviceMutex, 1);
  498. return UA_Server_readWithSession(server, &server->adminSession, item, timestamps);
  499. }
  500. UA_StatusCode
  501. readWithReadValue(UA_Server *server, const UA_NodeId *nodeId,
  502. const UA_AttributeId attributeId, void *v) {
  503. UA_LOCK_ASSERT(server->serviceMutex, 1);
  504. /* Call the read service */
  505. UA_ReadValueId item;
  506. UA_ReadValueId_init(&item);
  507. item.nodeId = *nodeId;
  508. item.attributeId = attributeId;
  509. UA_DataValue dv = readAttribute(server, &item, UA_TIMESTAMPSTORETURN_NEITHER);
  510. /* Check the return value */
  511. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  512. if(dv.hasStatus)
  513. retval = dv.status;
  514. else if(!dv.hasValue)
  515. retval = UA_STATUSCODE_BADUNEXPECTEDERROR;
  516. if(retval != UA_STATUSCODE_GOOD) {
  517. UA_DataValue_clear(&dv);
  518. return retval;
  519. }
  520. if(attributeId == UA_ATTRIBUTEID_VALUE ||
  521. attributeId == UA_ATTRIBUTEID_ARRAYDIMENSIONS) {
  522. /* Return the entire variant */
  523. memcpy(v, &dv.value, sizeof(UA_Variant));
  524. } else {
  525. /* Return the variant content only */
  526. memcpy(v, dv.value.data, dv.value.type->memSize);
  527. UA_free(dv.value.data);
  528. }
  529. return retval;
  530. }
  531. /* Exposes the Read service to local users */
  532. UA_DataValue
  533. UA_Server_read(UA_Server *server, const UA_ReadValueId *item,
  534. UA_TimestampsToReturn timestamps) {
  535. UA_LOCK(server->serviceMutex);
  536. UA_DataValue dv = readAttribute(server, item, timestamps);
  537. UA_UNLOCK(server->serviceMutex);
  538. return dv;
  539. }
  540. /* Used in inline functions exposing the Read service with more syntactic sugar
  541. * for individual attributes */
  542. UA_StatusCode
  543. __UA_Server_read(UA_Server *server, const UA_NodeId *nodeId,
  544. const UA_AttributeId attributeId, void *v) {
  545. UA_LOCK(server->serviceMutex);
  546. UA_StatusCode retval = readWithReadValue(server, nodeId, attributeId, v);
  547. UA_UNLOCK(server->serviceMutex);
  548. return retval;
  549. }
  550. UA_StatusCode
  551. UA_Server_readObjectProperty(UA_Server *server, const UA_NodeId objectId,
  552. const UA_QualifiedName propertyName,
  553. UA_Variant *value) {
  554. UA_RelativePathElement rpe;
  555. UA_RelativePathElement_init(&rpe);
  556. rpe.referenceTypeId = UA_NODEID_NUMERIC(0, UA_NS0ID_HASPROPERTY);
  557. rpe.isInverse = false;
  558. rpe.includeSubtypes = false;
  559. rpe.targetName = propertyName;
  560. UA_BrowsePath bp;
  561. UA_BrowsePath_init(&bp);
  562. bp.startingNode = objectId;
  563. bp.relativePath.elementsSize = 1;
  564. bp.relativePath.elements = &rpe;
  565. UA_StatusCode retval;
  566. UA_LOCK(server->serviceMutex);
  567. UA_BrowsePathResult bpr = translateBrowsePathToNodeIds(server, &bp);
  568. if(bpr.statusCode != UA_STATUSCODE_GOOD || bpr.targetsSize < 1) {
  569. retval = bpr.statusCode;
  570. UA_BrowsePathResult_clear(&bpr);
  571. UA_UNLOCK(server->serviceMutex);
  572. return retval;
  573. }
  574. retval = readWithReadValue(server, &bpr.targets[0].targetId.nodeId, UA_ATTRIBUTEID_VALUE, value);
  575. UA_UNLOCK(server->serviceMutex);
  576. UA_BrowsePathResult_clear(&bpr);
  577. return retval;
  578. }
  579. /*****************/
  580. /* Type Checking */
  581. /*****************/
  582. static UA_DataTypeKind
  583. typeEquivalence(const UA_DataType *t) {
  584. UA_DataTypeKind k = (UA_DataTypeKind)t->typeKind;
  585. if(k == UA_DATATYPEKIND_ENUM)
  586. return UA_DATATYPEKIND_INT32;
  587. return k;
  588. }
  589. static const UA_NodeId enumNodeId = {0, UA_NODEIDTYPE_NUMERIC, {UA_NS0ID_ENUMERATION}};
  590. UA_Boolean
  591. compatibleDataType(UA_Server *server, const UA_NodeId *dataType,
  592. const UA_NodeId *constraintDataType, UA_Boolean isValue) {
  593. /* Do not allow empty datatypes */
  594. if(UA_NodeId_isNull(dataType))
  595. return false;
  596. /* No constraint (TODO: use variant instead) */
  597. if(UA_NodeId_isNull(constraintDataType))
  598. return true;
  599. /* Same datatypes */
  600. if (UA_NodeId_equal(dataType, constraintDataType))
  601. return true;
  602. /* Variant allows any subtype */
  603. if(UA_NodeId_equal(constraintDataType, &UA_TYPES[UA_TYPES_VARIANT].typeId))
  604. return true;
  605. /* Is the value-type a subtype of the required type? */
  606. if(isNodeInTree(server, dataType, constraintDataType, &subtypeId, 1))
  607. return true;
  608. /* Enum allows Int32 (only) */
  609. if(UA_NodeId_equal(dataType, &UA_TYPES[UA_TYPES_INT32].typeId) &&
  610. isNodeInTree(server, constraintDataType, &enumNodeId, &subtypeId, 1))
  611. return true;
  612. /* More checks for the data type of real values (variants) */
  613. if(isValue) {
  614. /* If value is a built-in type: The target data type may be a sub type of
  615. * the built-in type. (e.g. UtcTime is sub-type of DateTime and has a
  616. * DateTime value). A type is builtin if its NodeId is in Namespace 0 and
  617. * has a numeric identifier <= 25 (DiagnosticInfo) */
  618. if(dataType->namespaceIndex == 0 &&
  619. dataType->identifierType == UA_NODEIDTYPE_NUMERIC &&
  620. dataType->identifier.numeric <= 25 &&
  621. isNodeInTree(server, constraintDataType,
  622. dataType, &subtypeId, 1))
  623. return true;
  624. }
  625. return false;
  626. }
  627. /* Test whether a ValueRank and the given arraydimensions are compatible.
  628. *
  629. * 5.6.2 Variable NodeClass: If the maximum is unknown the value shall be 0. The
  630. * number of elements shall be equal to the value of the ValueRank Attribute.
  631. * This Attribute shall be null if ValueRank <= 0. */
  632. UA_Boolean
  633. compatibleValueRankArrayDimensions(UA_Server *server, UA_Session *session,
  634. UA_Int32 valueRank, size_t arrayDimensionsSize) {
  635. /* ValueRank invalid */
  636. if(valueRank < UA_VALUERANK_SCALAR_OR_ONE_DIMENSION) {
  637. UA_LOG_INFO_SESSION(&server->config.logger, session,
  638. "The ValueRank is invalid (< -3)");
  639. return false;
  640. }
  641. /* case -3, UA_VALUERANK_SCALAR_OR_ONE_DIMENSION: the value can be a scalar or a one dimensional array */
  642. /* case -2, UA_VALUERANK_ANY: the value can be a scalar or an array with any number of dimensions */
  643. /* case -1, UA_VALUERANK_SCALAR: the value is a scalar */
  644. /* case 0, UA_VALUERANK_ONE_OR_MORE_DIMENSIONS: the value is an array with one or more dimensions */
  645. if(valueRank <= UA_VALUERANK_ONE_OR_MORE_DIMENSIONS) {
  646. if(arrayDimensionsSize > 0) {
  647. UA_LOG_INFO_SESSION(&server->config.logger, session,
  648. "No ArrayDimensions can be defined for a ValueRank <= 0");
  649. return false;
  650. }
  651. return true;
  652. }
  653. /* case >= 1, UA_VALUERANK_ONE_DIMENSION: the value is an array with the specified number of dimensions */
  654. if(arrayDimensionsSize != (size_t)valueRank) {
  655. UA_LOG_INFO_SESSION(&server->config.logger, session,
  656. "The number of ArrayDimensions is not equal to the (positive) ValueRank");
  657. return false;
  658. }
  659. return true;
  660. }
  661. UA_Boolean
  662. compatibleValueRanks(UA_Int32 valueRank, UA_Int32 constraintValueRank) {
  663. /* Check if the valuerank of the variabletype allows the change. */
  664. switch(constraintValueRank) {
  665. case UA_VALUERANK_SCALAR_OR_ONE_DIMENSION: /* the value can be a scalar or a one dimensional array */
  666. if(valueRank != UA_VALUERANK_SCALAR && valueRank != UA_VALUERANK_ONE_DIMENSION)
  667. return false;
  668. break;
  669. case UA_VALUERANK_ANY: /* the value can be a scalar or an array with any number of dimensions */
  670. break;
  671. case UA_VALUERANK_SCALAR: /* the value is a scalar */
  672. if(valueRank != UA_VALUERANK_SCALAR)
  673. return false;
  674. break;
  675. case UA_VALUERANK_ONE_OR_MORE_DIMENSIONS: /* the value is an array with one or more dimensions */
  676. if(valueRank < (UA_Int32) UA_VALUERANK_ONE_OR_MORE_DIMENSIONS)
  677. return false;
  678. break;
  679. default: /* >= 1: the value is an array with the specified number of dimensions */
  680. if(valueRank != constraintValueRank)
  681. return false;
  682. break;
  683. }
  684. return true;
  685. }
  686. /* Check if the ValueRank allows for the value dimension. This is more
  687. * permissive than checking for the ArrayDimensions attribute. Because the value
  688. * can have dimensions if the ValueRank < 0 */
  689. static UA_Boolean
  690. compatibleValueRankValue(UA_Int32 valueRank, const UA_Variant *value) {
  691. /* Invalid ValueRank */
  692. if(valueRank < UA_VALUERANK_SCALAR_OR_ONE_DIMENSION)
  693. return false;
  694. /* Empty arrays (-1) always match */
  695. if(!value->data)
  696. return true;
  697. size_t arrayDims = value->arrayDimensionsSize;
  698. if(arrayDims == 0 && !UA_Variant_isScalar(value))
  699. arrayDims = 1; /* array but no arraydimensions -> implicit array dimension 1 */
  700. /* We cannot simply use compatibleValueRankArrayDimensions since we can have
  701. * defined ArrayDimensions for the value if the ValueRank is -2 */
  702. switch(valueRank) {
  703. case UA_VALUERANK_SCALAR_OR_ONE_DIMENSION: /* The value can be a scalar or a one dimensional array */
  704. return (arrayDims <= 1);
  705. case UA_VALUERANK_ANY: /* The value can be a scalar or an array with any number of dimensions */
  706. return true;
  707. case UA_VALUERANK_SCALAR: /* The value is a scalar */
  708. return (arrayDims == 0);
  709. default:
  710. break;
  711. }
  712. UA_assert(valueRank >= UA_VALUERANK_ONE_OR_MORE_DIMENSIONS);
  713. /* case 0: the value is an array with one or more dimensions */
  714. return (arrayDims == (UA_UInt32)valueRank);
  715. }
  716. UA_Boolean
  717. compatibleArrayDimensions(size_t constraintArrayDimensionsSize,
  718. const UA_UInt32 *constraintArrayDimensions,
  719. size_t testArrayDimensionsSize,
  720. const UA_UInt32 *testArrayDimensions) {
  721. /* No array dimensions defined -> everything is permitted if the value rank fits */
  722. if(constraintArrayDimensionsSize == 0)
  723. return true;
  724. /* Dimension count must match */
  725. if(testArrayDimensionsSize != constraintArrayDimensionsSize)
  726. return false;
  727. /* Dimension lengths must not be larger than the constraint. Zero in the
  728. * constraint indicates a wildcard. */
  729. for(size_t i = 0; i < constraintArrayDimensionsSize; ++i) {
  730. if(constraintArrayDimensions[i] < testArrayDimensions[i] &&
  731. constraintArrayDimensions[i] != 0)
  732. return false;
  733. }
  734. return true;
  735. }
  736. UA_Boolean
  737. compatibleValueArrayDimensions(const UA_Variant *value, size_t targetArrayDimensionsSize,
  738. const UA_UInt32 *targetArrayDimensions) {
  739. size_t valueArrayDimensionsSize = value->arrayDimensionsSize;
  740. UA_UInt32 *valueArrayDimensions = value->arrayDimensions;
  741. UA_UInt32 tempArrayDimensions;
  742. if(!valueArrayDimensions && !UA_Variant_isScalar(value)) {
  743. valueArrayDimensionsSize = 1;
  744. tempArrayDimensions = (UA_UInt32)value->arrayLength;
  745. valueArrayDimensions = &tempArrayDimensions;
  746. }
  747. UA_assert(valueArrayDimensionsSize == 0 || valueArrayDimensions != NULL);
  748. return compatibleArrayDimensions(targetArrayDimensionsSize, targetArrayDimensions,
  749. valueArrayDimensionsSize, valueArrayDimensions);
  750. }
  751. UA_Boolean
  752. compatibleValue(UA_Server *server, UA_Session *session, const UA_NodeId *targetDataTypeId,
  753. UA_Int32 targetValueRank, size_t targetArrayDimensionsSize,
  754. const UA_UInt32 *targetArrayDimensions, const UA_Variant *value,
  755. const UA_NumericRange *range) {
  756. /* Empty value */
  757. if(!value->type) {
  758. /* Empty value is allowed for BaseDataType */
  759. if(UA_NodeId_equal(targetDataTypeId, &UA_TYPES[UA_TYPES_VARIANT].typeId) ||
  760. UA_NodeId_equal(targetDataTypeId, &UA_NODEID_NULL))
  761. return true;
  762. /* Allow empty node values since existing information models may have
  763. * variables with no value, e.g. OldValues - ns=0;i=3024. See also
  764. * #1889, https://github.com/open62541/open62541/pull/1889#issuecomment-403506538 */
  765. if(server->config.relaxEmptyValueConstraint) {
  766. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  767. "Only Variables with data type BaseDataType can contain an "
  768. "empty value. Allow via explicit constraint relaxation.");
  769. return true;
  770. }
  771. UA_LOG_INFO_SESSION(&server->config.logger, session,
  772. "Only Variables with data type BaseDataType can contain an empty value");
  773. return false;
  774. }
  775. /* Has the value a subtype of the required type? BaseDataType (Variant) can
  776. * be anything... */
  777. if(!compatibleDataType(server, &value->type->typeId, targetDataTypeId, true))
  778. return false;
  779. /* Array dimensions are checked later when writing the range */
  780. if(range)
  781. return true;
  782. /* See if the array dimensions match. */
  783. if(!compatibleValueArrayDimensions(value, targetArrayDimensionsSize, targetArrayDimensions))
  784. return false;
  785. /* Check if the valuerank allows for the value dimension */
  786. return compatibleValueRankValue(targetValueRank, value);
  787. }
  788. /*****************/
  789. /* Write Service */
  790. /*****************/
  791. static void
  792. adjustValue(UA_Server *server, UA_Variant *value,
  793. const UA_NodeId *targetDataTypeId) {
  794. const UA_DataType *targetDataType = UA_findDataType(targetDataTypeId);
  795. if(!targetDataType)
  796. return;
  797. /* A string is written to a byte array. the valuerank and array dimensions
  798. * are checked later */
  799. if(targetDataType == &UA_TYPES[UA_TYPES_BYTE] &&
  800. value->type == &UA_TYPES[UA_TYPES_BYTESTRING] &&
  801. UA_Variant_isScalar(value)) {
  802. UA_ByteString *str = (UA_ByteString*)value->data;
  803. value->type = &UA_TYPES[UA_TYPES_BYTE];
  804. value->arrayLength = str->length;
  805. value->data = str->data;
  806. return;
  807. }
  808. /* An enum was sent as an int32, or an opaque type as a bytestring. This
  809. * is detected with the typeIndex indicating the "true" datatype. */
  810. UA_DataTypeKind te1 = typeEquivalence(targetDataType);
  811. UA_DataTypeKind te2 = typeEquivalence(value->type);
  812. if(te1 == te2 && te1 <= UA_DATATYPEKIND_ENUM) {
  813. value->type = targetDataType;
  814. return;
  815. }
  816. /* No more possible equivalencies */
  817. }
  818. static UA_StatusCode
  819. writeArrayDimensionsAttribute(UA_Server *server, UA_Session *session,
  820. UA_VariableNode *node, const UA_VariableTypeNode *type,
  821. size_t arrayDimensionsSize, UA_UInt32 *arrayDimensions) {
  822. UA_assert(node != NULL);
  823. UA_assert(type != NULL);
  824. /* If this is a variabletype, there must be no instances or subtypes of it
  825. * when we do the change */
  826. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  827. UA_Node_hasSubTypeOrInstances((UA_Node*)node)) {
  828. UA_LOG_INFO(&server->config.logger, UA_LOGCATEGORY_SERVER,
  829. "Cannot change a variable type with existing instances");
  830. return UA_STATUSCODE_BADINTERNALERROR;
  831. }
  832. /* Check that the array dimensions match with the valuerank */
  833. if(!compatibleValueRankArrayDimensions(server, session, node->valueRank, arrayDimensionsSize)) {
  834. UA_LOG_DEBUG(&server->config.logger, UA_LOGCATEGORY_SERVER,
  835. "Cannot write the ArrayDimensions. The ValueRank does not match.");
  836. return UA_STATUSCODE_BADTYPEMISMATCH;
  837. }
  838. /* Check if the array dimensions match with the wildcards in the
  839. * variabletype (dimension length 0) */
  840. if(type->arrayDimensions &&
  841. !compatibleArrayDimensions(type->arrayDimensionsSize, type->arrayDimensions,
  842. arrayDimensionsSize, arrayDimensions)) {
  843. UA_LOG_DEBUG(&server->config.logger, UA_LOGCATEGORY_SERVER,
  844. "Array dimensions in the variable type do not match");
  845. return UA_STATUSCODE_BADTYPEMISMATCH;
  846. }
  847. /* Check if the current value is compatible with the array dimensions */
  848. UA_DataValue value;
  849. UA_DataValue_init(&value);
  850. UA_StatusCode retval = readValueAttribute(server, session, node, &value);
  851. if(retval != UA_STATUSCODE_GOOD)
  852. return retval;
  853. if(value.hasValue) {
  854. if(!compatibleValueArrayDimensions(&value.value, arrayDimensionsSize, arrayDimensions))
  855. retval = UA_STATUSCODE_BADTYPEMISMATCH;
  856. UA_DataValue_clear(&value);
  857. if(retval != UA_STATUSCODE_GOOD) {
  858. UA_LOG_DEBUG(&server->config.logger, UA_LOGCATEGORY_SERVER,
  859. "Array dimensions in the current value do not match");
  860. return retval;
  861. }
  862. }
  863. /* Ok, apply */
  864. UA_UInt32 *oldArrayDimensions = node->arrayDimensions;
  865. size_t oldArrayDimensionsSize = node->arrayDimensionsSize;
  866. retval = UA_Array_copy(arrayDimensions, arrayDimensionsSize,
  867. (void**)&node->arrayDimensions,
  868. &UA_TYPES[UA_TYPES_UINT32]);
  869. if(retval != UA_STATUSCODE_GOOD)
  870. return retval;
  871. UA_Array_delete(oldArrayDimensions, oldArrayDimensionsSize, &UA_TYPES[UA_TYPES_UINT32]);
  872. node->arrayDimensionsSize = arrayDimensionsSize;
  873. return UA_STATUSCODE_GOOD;
  874. }
  875. /* Stack layout: ... | node | type */
  876. static UA_StatusCode
  877. writeValueRankAttribute(UA_Server *server, UA_Session *session,
  878. UA_VariableNode *node, const UA_VariableTypeNode *type,
  879. UA_Int32 valueRank) {
  880. UA_assert(node != NULL);
  881. UA_assert(type != NULL);
  882. UA_Int32 constraintValueRank = type->valueRank;
  883. /* If this is a variabletype, there must be no instances or subtypes of it
  884. * when we do the change */
  885. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  886. UA_Node_hasSubTypeOrInstances((const UA_Node*)node))
  887. return UA_STATUSCODE_BADINTERNALERROR;
  888. /* Check if the valuerank of the variabletype allows the change. */
  889. if(!compatibleValueRanks(valueRank, constraintValueRank))
  890. return UA_STATUSCODE_BADTYPEMISMATCH;
  891. /* Check if the new valuerank is compatible with the array dimensions. Use
  892. * the read service to handle data sources. */
  893. size_t arrayDims = node->arrayDimensionsSize;
  894. if(arrayDims == 0) {
  895. /* the value could be an array with no arrayDimensions defined.
  896. dimensions zero indicate a scalar for compatibleValueRankArrayDimensions. */
  897. UA_DataValue value;
  898. UA_DataValue_init(&value);
  899. UA_StatusCode retval = readValueAttribute(server, session, node, &value);
  900. if(retval != UA_STATUSCODE_GOOD)
  901. return retval;
  902. if(!value.hasValue || !value.value.type) {
  903. /* no value -> apply */
  904. node->valueRank = valueRank;
  905. return UA_STATUSCODE_GOOD;
  906. }
  907. if(!UA_Variant_isScalar(&value.value))
  908. arrayDims = 1;
  909. UA_DataValue_clear(&value);
  910. }
  911. if(!compatibleValueRankArrayDimensions(server, session, valueRank, arrayDims))
  912. return UA_STATUSCODE_BADTYPEMISMATCH;
  913. /* All good, apply the change */
  914. node->valueRank = valueRank;
  915. return UA_STATUSCODE_GOOD;
  916. }
  917. static UA_StatusCode
  918. writeDataTypeAttribute(UA_Server *server, UA_Session *session,
  919. UA_VariableNode *node, const UA_VariableTypeNode *type,
  920. const UA_NodeId *dataType) {
  921. UA_assert(node != NULL);
  922. UA_assert(type != NULL);
  923. /* If this is a variabletype, there must be no instances or subtypes of it
  924. when we do the change */
  925. if(node->nodeClass == UA_NODECLASS_VARIABLETYPE &&
  926. UA_Node_hasSubTypeOrInstances((const UA_Node*)node))
  927. return UA_STATUSCODE_BADINTERNALERROR;
  928. /* Does the new type match the constraints of the variabletype? */
  929. if(!compatibleDataType(server, dataType, &type->dataType, false))
  930. return UA_STATUSCODE_BADTYPEMISMATCH;
  931. /* Check if the current value would match the new type */
  932. UA_DataValue value;
  933. UA_DataValue_init(&value);
  934. UA_StatusCode retval = readValueAttribute(server, session, node, &value);
  935. if(retval != UA_STATUSCODE_GOOD)
  936. return retval;
  937. if(value.hasValue) {
  938. if(!compatibleValue(server, session, dataType, node->valueRank,
  939. node->arrayDimensionsSize, node->arrayDimensions,
  940. &value.value, NULL))
  941. retval = UA_STATUSCODE_BADTYPEMISMATCH;
  942. UA_DataValue_clear(&value);
  943. if(retval != UA_STATUSCODE_GOOD) {
  944. UA_LOG_DEBUG(&server->config.logger, UA_LOGCATEGORY_SERVER,
  945. "The current value does not match the new data type");
  946. return retval;
  947. }
  948. }
  949. /* Replace the datatype nodeid */
  950. UA_NodeId dtCopy = node->dataType;
  951. retval = UA_NodeId_copy(dataType, &node->dataType);
  952. if(retval != UA_STATUSCODE_GOOD) {
  953. node->dataType = dtCopy;
  954. return retval;
  955. }
  956. UA_NodeId_clear(&dtCopy);
  957. return UA_STATUSCODE_GOOD;
  958. }
  959. static UA_StatusCode
  960. writeValueAttributeWithoutRange(UA_VariableNode *node, const UA_DataValue *value) {
  961. UA_DataValue new_value;
  962. UA_StatusCode retval = UA_DataValue_copy(value, &new_value);
  963. if(retval != UA_STATUSCODE_GOOD)
  964. return retval;
  965. UA_DataValue_clear(&node->value.data.value);
  966. node->value.data.value = new_value;
  967. return UA_STATUSCODE_GOOD;
  968. }
  969. static UA_StatusCode
  970. writeValueAttributeWithRange(UA_VariableNode *node, const UA_DataValue *value,
  971. const UA_NumericRange *rangeptr) {
  972. /* Value on both sides? */
  973. if(value->status != node->value.data.value.status ||
  974. !value->hasValue || !node->value.data.value.hasValue)
  975. return UA_STATUSCODE_BADINDEXRANGEINVALID;
  976. /* Make scalar a one-entry array for range matching */
  977. UA_Variant editableValue;
  978. const UA_Variant *v = &value->value;
  979. if(UA_Variant_isScalar(&value->value)) {
  980. editableValue = value->value;
  981. editableValue.arrayLength = 1;
  982. v = &editableValue;
  983. }
  984. /* Check that the type is an exact match and not only "compatible" */
  985. if(!node->value.data.value.value.type || !v->type ||
  986. !UA_NodeId_equal(&node->value.data.value.value.type->typeId,
  987. &v->type->typeId))
  988. return UA_STATUSCODE_BADTYPEMISMATCH;
  989. /* Write the value */
  990. UA_StatusCode retval = UA_Variant_setRangeCopy(&node->value.data.value.value,
  991. v->data, v->arrayLength, *rangeptr);
  992. if(retval != UA_STATUSCODE_GOOD)
  993. return retval;
  994. /* Write the status and timestamps */
  995. node->value.data.value.hasStatus = value->hasStatus;
  996. node->value.data.value.status = value->status;
  997. node->value.data.value.hasSourceTimestamp = value->hasSourceTimestamp;
  998. node->value.data.value.sourceTimestamp = value->sourceTimestamp;
  999. node->value.data.value.hasSourcePicoseconds = value->hasSourcePicoseconds;
  1000. node->value.data.value.sourcePicoseconds = value->sourcePicoseconds;
  1001. return UA_STATUSCODE_GOOD;
  1002. }
  1003. /* Stack layout: ... | node */
  1004. static UA_StatusCode
  1005. writeValueAttribute(UA_Server *server, UA_Session *session,
  1006. UA_VariableNode *node, const UA_DataValue *value,
  1007. const UA_String *indexRange) {
  1008. UA_assert(node != NULL);
  1009. /* Parse the range */
  1010. UA_NumericRange range;
  1011. UA_NumericRange *rangeptr = NULL;
  1012. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  1013. if(indexRange && indexRange->length > 0) {
  1014. retval = UA_NumericRange_parseFromString(&range, indexRange);
  1015. if(retval != UA_STATUSCODE_GOOD)
  1016. return retval;
  1017. rangeptr = &range;
  1018. }
  1019. /* Created an editable version. The data is not touched. Only the variant
  1020. * "container". */
  1021. UA_DataValue adjustedValue = *value;
  1022. /* Type checking. May change the type of editableValue */
  1023. if(value->hasValue && value->value.type) {
  1024. adjustValue(server, &adjustedValue.value, &node->dataType);
  1025. /* The value may be an extension object, especially the nodeset compiler
  1026. * uses extension objects to write variable values. If value is an
  1027. * extension object we check if the current node value is also an
  1028. * extension object. */
  1029. const UA_NodeId nodeDataType = UA_NODEID_NUMERIC(0, UA_NS0ID_STRUCTURE);
  1030. const UA_NodeId *nodeDataTypePtr = &node->dataType;
  1031. if(value->value.type->typeId.identifierType == UA_NODEIDTYPE_NUMERIC &&
  1032. value->value.type->typeId.identifier.numeric == UA_NS0ID_STRUCTURE)
  1033. nodeDataTypePtr = &nodeDataType;
  1034. if(!compatibleValue(server, session, nodeDataTypePtr, node->valueRank,
  1035. node->arrayDimensionsSize, node->arrayDimensions,
  1036. &adjustedValue.value, rangeptr)) {
  1037. if(rangeptr)
  1038. UA_free(range.dimensions);
  1039. return UA_STATUSCODE_BADTYPEMISMATCH;
  1040. }
  1041. }
  1042. /* Set the source timestamp if there is none */
  1043. UA_DateTime now = UA_DateTime_now();
  1044. if(!adjustedValue.hasSourceTimestamp) {
  1045. adjustedValue.sourceTimestamp = now;
  1046. adjustedValue.hasSourceTimestamp = true;
  1047. }
  1048. if(!adjustedValue.hasServerTimestamp) {
  1049. adjustedValue.serverTimestamp = now;
  1050. adjustedValue.hasServerTimestamp = true;
  1051. }
  1052. /* Ok, do it */
  1053. if(node->valueSource == UA_VALUESOURCE_DATA) {
  1054. if(!rangeptr)
  1055. retval = writeValueAttributeWithoutRange(node, &adjustedValue);
  1056. else
  1057. retval = writeValueAttributeWithRange(node, &adjustedValue, rangeptr);
  1058. #ifdef UA_ENABLE_HISTORIZING
  1059. /* node is a UA_VariableNode*, but it may also point to a UA_VariableTypeNode */
  1060. /* UA_VariableTypeNode doesn't have the historizing attribute */
  1061. if(retval == UA_STATUSCODE_GOOD && node->nodeClass == UA_NODECLASS_VARIABLE &&
  1062. server->config.historyDatabase.setValue) {
  1063. UA_UNLOCK(server->serviceMutex);
  1064. server->config.historyDatabase.setValue(server, server->config.historyDatabase.context,
  1065. &session->sessionId, session->sessionHandle,
  1066. &node->nodeId, node->historizing, &adjustedValue);
  1067. UA_LOCK(server->serviceMutex);
  1068. }
  1069. #endif
  1070. /* Callback after writing */
  1071. if(retval == UA_STATUSCODE_GOOD && node->value.data.callback.onWrite) {
  1072. UA_UNLOCK(server->serviceMutex)
  1073. node->value.data.callback.onWrite(server, &session->sessionId,
  1074. session->sessionHandle, &node->nodeId,
  1075. node->context, rangeptr,
  1076. &adjustedValue);
  1077. UA_LOCK(server->serviceMutex);
  1078. }
  1079. } else {
  1080. if(node->value.dataSource.write) {
  1081. UA_UNLOCK(server->serviceMutex);
  1082. retval = node->value.dataSource.write(server, &session->sessionId,
  1083. session->sessionHandle, &node->nodeId,
  1084. node->context, rangeptr, &adjustedValue);
  1085. UA_LOCK(server->serviceMutex);
  1086. } else {
  1087. retval = UA_STATUSCODE_BADWRITENOTSUPPORTED;
  1088. }
  1089. }
  1090. /* Clean up */
  1091. if(rangeptr)
  1092. UA_free(range.dimensions);
  1093. return retval;
  1094. }
  1095. static UA_StatusCode
  1096. writeIsAbstractAttribute(UA_Node *node, UA_Boolean value) {
  1097. switch(node->nodeClass) {
  1098. case UA_NODECLASS_OBJECTTYPE:
  1099. ((UA_ObjectTypeNode*)node)->isAbstract = value;
  1100. break;
  1101. case UA_NODECLASS_REFERENCETYPE:
  1102. ((UA_ReferenceTypeNode*)node)->isAbstract = value;
  1103. break;
  1104. case UA_NODECLASS_VARIABLETYPE:
  1105. ((UA_VariableTypeNode*)node)->isAbstract = value;
  1106. break;
  1107. case UA_NODECLASS_DATATYPE:
  1108. ((UA_DataTypeNode*)node)->isAbstract = value;
  1109. break;
  1110. default:
  1111. return UA_STATUSCODE_BADNODECLASSINVALID;
  1112. }
  1113. return UA_STATUSCODE_GOOD;
  1114. }
  1115. /*****************/
  1116. /* Write Service */
  1117. /*****************/
  1118. #define CHECK_DATATYPE_SCALAR(EXP_DT) \
  1119. if(!wvalue->value.hasValue || \
  1120. &UA_TYPES[UA_TYPES_##EXP_DT] != wvalue->value.value.type || \
  1121. !UA_Variant_isScalar(&wvalue->value.value)) { \
  1122. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  1123. break; \
  1124. }
  1125. #define CHECK_DATATYPE_ARRAY(EXP_DT) \
  1126. if(!wvalue->value.hasValue || \
  1127. &UA_TYPES[UA_TYPES_##EXP_DT] != wvalue->value.value.type || \
  1128. UA_Variant_isScalar(&wvalue->value.value)) { \
  1129. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  1130. break; \
  1131. }
  1132. #define CHECK_NODECLASS_WRITE(CLASS) \
  1133. if((node->nodeClass & (CLASS)) == 0) { \
  1134. retval = UA_STATUSCODE_BADNODECLASSINVALID; \
  1135. break; \
  1136. }
  1137. #define CHECK_USERWRITEMASK(mask) \
  1138. if(!(userWriteMask & (mask))) { \
  1139. retval = UA_STATUSCODE_BADUSERACCESSDENIED; \
  1140. break; \
  1141. }
  1142. #define GET_NODETYPE \
  1143. type = (const UA_VariableTypeNode*) \
  1144. getNodeType(server, node); \
  1145. if(!type) { \
  1146. retval = UA_STATUSCODE_BADTYPEMISMATCH; \
  1147. break; \
  1148. }
  1149. /* This function implements the main part of the write service and operates on a
  1150. copy of the node (not in single-threaded mode). */
  1151. static UA_StatusCode
  1152. copyAttributeIntoNode(UA_Server *server, UA_Session *session,
  1153. UA_Node *node, const UA_WriteValue *wvalue) {
  1154. const void *value = wvalue->value.value.data;
  1155. UA_UInt32 userWriteMask = getUserWriteMask(server, session, node);
  1156. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  1157. const UA_VariableTypeNode *type;
  1158. switch(wvalue->attributeId) {
  1159. case UA_ATTRIBUTEID_NODEID:
  1160. case UA_ATTRIBUTEID_NODECLASS:
  1161. case UA_ATTRIBUTEID_USERWRITEMASK:
  1162. case UA_ATTRIBUTEID_USERACCESSLEVEL:
  1163. case UA_ATTRIBUTEID_USEREXECUTABLE:
  1164. retval = UA_STATUSCODE_BADWRITENOTSUPPORTED;
  1165. break;
  1166. case UA_ATTRIBUTEID_BROWSENAME:
  1167. CHECK_USERWRITEMASK(UA_WRITEMASK_BROWSENAME);
  1168. CHECK_DATATYPE_SCALAR(QUALIFIEDNAME);
  1169. UA_QualifiedName_clear(&node->browseName);
  1170. UA_QualifiedName_copy((const UA_QualifiedName *)value, &node->browseName);
  1171. break;
  1172. case UA_ATTRIBUTEID_DISPLAYNAME:
  1173. CHECK_USERWRITEMASK(UA_WRITEMASK_DISPLAYNAME);
  1174. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  1175. UA_LocalizedText_clear(&node->displayName);
  1176. UA_LocalizedText_copy((const UA_LocalizedText *)value, &node->displayName);
  1177. break;
  1178. case UA_ATTRIBUTEID_DESCRIPTION:
  1179. CHECK_USERWRITEMASK(UA_WRITEMASK_DESCRIPTION);
  1180. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  1181. UA_LocalizedText_clear(&node->description);
  1182. UA_LocalizedText_copy((const UA_LocalizedText *)value, &node->description);
  1183. break;
  1184. case UA_ATTRIBUTEID_WRITEMASK:
  1185. CHECK_USERWRITEMASK(UA_WRITEMASK_WRITEMASK);
  1186. CHECK_DATATYPE_SCALAR(UINT32);
  1187. node->writeMask = *(const UA_UInt32*)value;
  1188. break;
  1189. case UA_ATTRIBUTEID_ISABSTRACT:
  1190. CHECK_USERWRITEMASK(UA_WRITEMASK_ISABSTRACT);
  1191. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1192. retval = writeIsAbstractAttribute(node, *(const UA_Boolean*)value);
  1193. break;
  1194. case UA_ATTRIBUTEID_SYMMETRIC:
  1195. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  1196. CHECK_USERWRITEMASK(UA_WRITEMASK_SYMMETRIC);
  1197. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1198. ((UA_ReferenceTypeNode*)node)->symmetric = *(const UA_Boolean*)value;
  1199. break;
  1200. case UA_ATTRIBUTEID_INVERSENAME:
  1201. CHECK_NODECLASS_WRITE(UA_NODECLASS_REFERENCETYPE);
  1202. CHECK_USERWRITEMASK(UA_WRITEMASK_INVERSENAME);
  1203. CHECK_DATATYPE_SCALAR(LOCALIZEDTEXT);
  1204. UA_LocalizedText_clear(&((UA_ReferenceTypeNode*)node)->inverseName);
  1205. UA_LocalizedText_copy((const UA_LocalizedText *)value,
  1206. &((UA_ReferenceTypeNode*)node)->inverseName);
  1207. break;
  1208. case UA_ATTRIBUTEID_CONTAINSNOLOOPS:
  1209. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW);
  1210. CHECK_USERWRITEMASK(UA_WRITEMASK_CONTAINSNOLOOPS);
  1211. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1212. ((UA_ViewNode*)node)->containsNoLoops = *(const UA_Boolean*)value;
  1213. break;
  1214. case UA_ATTRIBUTEID_EVENTNOTIFIER:
  1215. CHECK_NODECLASS_WRITE(UA_NODECLASS_VIEW | UA_NODECLASS_OBJECT);
  1216. CHECK_USERWRITEMASK(UA_WRITEMASK_EVENTNOTIFIER);
  1217. CHECK_DATATYPE_SCALAR(BYTE);
  1218. if(node->nodeClass == UA_NODECLASS_VIEW) {
  1219. ((UA_ViewNode*)node)->eventNotifier = *(const UA_Byte*)value;
  1220. } else {
  1221. ((UA_ObjectNode*)node)->eventNotifier = *(const UA_Byte*)value;
  1222. }
  1223. break;
  1224. case UA_ATTRIBUTEID_VALUE:
  1225. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1226. if(node->nodeClass == UA_NODECLASS_VARIABLE) {
  1227. /* The access to a value variable is granted via the AccessLevel
  1228. * and UserAccessLevel attributes */
  1229. UA_Byte accessLevel = getAccessLevel(server, session, (const UA_VariableNode*)node);
  1230. if(!(accessLevel & (UA_ACCESSLEVELMASK_WRITE))) {
  1231. retval = UA_STATUSCODE_BADNOTWRITABLE;
  1232. break;
  1233. }
  1234. accessLevel = getUserAccessLevel(server, session,
  1235. (const UA_VariableNode*)node);
  1236. if(!(accessLevel & (UA_ACCESSLEVELMASK_WRITE))) {
  1237. retval = UA_STATUSCODE_BADUSERACCESSDENIED;
  1238. break;
  1239. }
  1240. } else { /* UA_NODECLASS_VARIABLETYPE */
  1241. CHECK_USERWRITEMASK(UA_WRITEMASK_VALUEFORVARIABLETYPE);
  1242. }
  1243. retval = writeValueAttribute(server, session, (UA_VariableNode*)node,
  1244. &wvalue->value, &wvalue->indexRange);
  1245. break;
  1246. case UA_ATTRIBUTEID_DATATYPE:
  1247. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1248. CHECK_USERWRITEMASK(UA_WRITEMASK_DATATYPE);
  1249. CHECK_DATATYPE_SCALAR(NODEID);
  1250. GET_NODETYPE
  1251. retval = writeDataTypeAttribute(server, session, (UA_VariableNode*)node,
  1252. type, (const UA_NodeId*)value);
  1253. UA_NODESTORE_RELEASE(server, (const UA_Node*)type);
  1254. break;
  1255. case UA_ATTRIBUTEID_VALUERANK:
  1256. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1257. CHECK_USERWRITEMASK(UA_WRITEMASK_VALUERANK);
  1258. CHECK_DATATYPE_SCALAR(INT32);
  1259. GET_NODETYPE
  1260. retval = writeValueRankAttribute(server, session, (UA_VariableNode*)node,
  1261. type, *(const UA_Int32*)value);
  1262. UA_NODESTORE_RELEASE(server, (const UA_Node*)type);
  1263. break;
  1264. case UA_ATTRIBUTEID_ARRAYDIMENSIONS:
  1265. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE | UA_NODECLASS_VARIABLETYPE);
  1266. CHECK_USERWRITEMASK(UA_WRITEMASK_ARRRAYDIMENSIONS);
  1267. CHECK_DATATYPE_ARRAY(UINT32);
  1268. GET_NODETYPE
  1269. retval = writeArrayDimensionsAttribute(server, session, (UA_VariableNode*)node,
  1270. type, wvalue->value.value.arrayLength,
  1271. (UA_UInt32 *)wvalue->value.value.data);
  1272. UA_NODESTORE_RELEASE(server, (const UA_Node*)type);
  1273. break;
  1274. case UA_ATTRIBUTEID_ACCESSLEVEL:
  1275. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1276. CHECK_USERWRITEMASK(UA_WRITEMASK_ACCESSLEVEL);
  1277. CHECK_DATATYPE_SCALAR(BYTE);
  1278. ((UA_VariableNode*)node)->accessLevel = *(const UA_Byte*)value;
  1279. break;
  1280. case UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL:
  1281. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1282. CHECK_USERWRITEMASK(UA_WRITEMASK_MINIMUMSAMPLINGINTERVAL);
  1283. CHECK_DATATYPE_SCALAR(DOUBLE);
  1284. ((UA_VariableNode*)node)->minimumSamplingInterval = *(const UA_Double*)value;
  1285. break;
  1286. case UA_ATTRIBUTEID_HISTORIZING:
  1287. CHECK_NODECLASS_WRITE(UA_NODECLASS_VARIABLE);
  1288. CHECK_USERWRITEMASK(UA_WRITEMASK_HISTORIZING);
  1289. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1290. ((UA_VariableNode*)node)->historizing = *(const UA_Boolean*)value;
  1291. break;
  1292. case UA_ATTRIBUTEID_EXECUTABLE:
  1293. CHECK_NODECLASS_WRITE(UA_NODECLASS_METHOD);
  1294. CHECK_USERWRITEMASK(UA_WRITEMASK_EXECUTABLE);
  1295. CHECK_DATATYPE_SCALAR(BOOLEAN);
  1296. ((UA_MethodNode*)node)->executable = *(const UA_Boolean*)value;
  1297. break;
  1298. default:
  1299. retval = UA_STATUSCODE_BADATTRIBUTEIDINVALID;
  1300. break;
  1301. }
  1302. if(retval != UA_STATUSCODE_GOOD)
  1303. UA_LOG_INFO_SESSION(&server->config.logger, session,
  1304. "WriteRequest returned status code %s",
  1305. UA_StatusCode_name(retval));
  1306. return retval;
  1307. }
  1308. static void
  1309. Operation_Write(UA_Server *server, UA_Session *session, void *context,
  1310. UA_WriteValue *wv, UA_StatusCode *result) {
  1311. *result = UA_Server_editNode(server, session, &wv->nodeId,
  1312. (UA_EditNodeCallback)copyAttributeIntoNode, wv);
  1313. }
  1314. void
  1315. Service_Write(UA_Server *server, UA_Session *session,
  1316. const UA_WriteRequest *request,
  1317. UA_WriteResponse *response) {
  1318. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  1319. "Processing WriteRequest");
  1320. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1321. if(server->config.maxNodesPerWrite != 0 &&
  1322. request->nodesToWriteSize > server->config.maxNodesPerWrite) {
  1323. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  1324. return;
  1325. }
  1326. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1327. response->responseHeader.serviceResult =
  1328. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_Write, NULL,
  1329. &request->nodesToWriteSize, &UA_TYPES[UA_TYPES_WRITEVALUE],
  1330. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  1331. }
  1332. UA_StatusCode
  1333. writeWithSession(UA_Server *server, UA_Session *session,
  1334. const UA_WriteValue *value) {
  1335. return UA_Server_editNode(server, session, &value->nodeId,
  1336. (UA_EditNodeCallback)copyAttributeIntoNode,
  1337. /* casting away const qualifier because callback uses const anyway */
  1338. (UA_WriteValue *)(uintptr_t)value);
  1339. }
  1340. UA_StatusCode
  1341. writeAttribute(UA_Server *server, const UA_WriteValue *value) {
  1342. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1343. return UA_Server_editNode(server, &server->adminSession, &value->nodeId,
  1344. (UA_EditNodeCallback)copyAttributeIntoNode,
  1345. /* casting away const qualifier because callback uses const anyway */
  1346. (UA_WriteValue *)(uintptr_t)value);
  1347. }
  1348. UA_StatusCode
  1349. UA_Server_write(UA_Server *server, const UA_WriteValue *value) {
  1350. UA_LOCK(server->serviceMutex);
  1351. UA_StatusCode retval = writeAttribute(server, value);
  1352. UA_UNLOCK(server->serviceMutex);
  1353. return retval;
  1354. }
  1355. UA_StatusCode
  1356. writeWithWriteValue(UA_Server *server, const UA_NodeId *nodeId,
  1357. const UA_AttributeId attributeId,
  1358. const UA_DataType *attr_type,
  1359. const void *attr) {
  1360. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1361. UA_WriteValue wvalue;
  1362. UA_WriteValue_init(&wvalue);
  1363. wvalue.nodeId = *nodeId;
  1364. wvalue.attributeId = attributeId;
  1365. wvalue.value.hasValue = true;
  1366. if(attr_type != &UA_TYPES[UA_TYPES_VARIANT]) {
  1367. /* hacked cast. the target WriteValue is used as const anyway */
  1368. UA_Variant_setScalar(&wvalue.value.value,
  1369. (void*)(uintptr_t)attr, attr_type);
  1370. } else {
  1371. wvalue.value.value = *(const UA_Variant*)attr;
  1372. }
  1373. return writeAttribute(server, &wvalue);
  1374. }
  1375. /* Convenience function to be wrapped into inline functions */
  1376. UA_StatusCode
  1377. __UA_Server_write(UA_Server *server, const UA_NodeId *nodeId,
  1378. const UA_AttributeId attributeId,
  1379. const UA_DataType *attr_type,
  1380. const void *attr) {
  1381. UA_LOCK(server->serviceMutex);
  1382. UA_StatusCode retval = writeWithWriteValue(server, nodeId, attributeId, attr_type, attr);
  1383. UA_UNLOCK(server->serviceMutex);
  1384. return retval;
  1385. }
  1386. #ifdef UA_ENABLE_HISTORIZING
  1387. typedef void (*UA_HistoryDatabase_readFunc)(
  1388. UA_Server *server,
  1389. void *hdbContext,
  1390. const UA_NodeId *sessionId,
  1391. void *sessionContext,
  1392. const UA_RequestHeader *requestHeader,
  1393. const void *historyReadDetails,
  1394. UA_TimestampsToReturn timestampsToReturn,
  1395. UA_Boolean releaseContinuationPoints,
  1396. size_t nodesToReadSize,
  1397. const UA_HistoryReadValueId *nodesToRead,
  1398. UA_HistoryReadResponse *response,
  1399. void * const * const historyData);
  1400. void
  1401. Service_HistoryRead(UA_Server *server, UA_Session *session,
  1402. const UA_HistoryReadRequest *request,
  1403. UA_HistoryReadResponse *response) {
  1404. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1405. if(request->historyReadDetails.encoding != UA_EXTENSIONOBJECT_DECODED) {
  1406. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTSUPPORTED;
  1407. return;
  1408. }
  1409. const UA_DataType *historyDataType = &UA_TYPES[UA_TYPES_HISTORYDATA];
  1410. UA_HistoryDatabase_readFunc readHistory = NULL;
  1411. switch (request->historyReadDetails.content.decoded.type->typeIndex) {
  1412. case UA_TYPES_READRAWMODIFIEDDETAILS: {
  1413. UA_ReadRawModifiedDetails * details = (UA_ReadRawModifiedDetails*)
  1414. request->historyReadDetails.content.decoded.data;
  1415. if(!details->isReadModified) {
  1416. readHistory = (UA_HistoryDatabase_readFunc)server->config.historyDatabase.readRaw;
  1417. } else {
  1418. historyDataType = &UA_TYPES[UA_TYPES_HISTORYMODIFIEDDATA];
  1419. readHistory = (UA_HistoryDatabase_readFunc)server->config.historyDatabase.readModified;
  1420. }
  1421. break;
  1422. }
  1423. case UA_TYPES_READPROCESSEDDETAILS:
  1424. readHistory = (UA_HistoryDatabase_readFunc)server->config.historyDatabase.readProcessed;
  1425. break;
  1426. case UA_TYPES_READATTIMEDETAILS:
  1427. readHistory = (UA_HistoryDatabase_readFunc)server->config.historyDatabase.readAtTime;
  1428. break;
  1429. }
  1430. if(!readHistory) {
  1431. /* TODO handle more request->historyReadDetails.content.decoded.type types */
  1432. response->responseHeader.serviceResult = UA_STATUSCODE_BADHISTORYOPERATIONUNSUPPORTED;
  1433. return;
  1434. }
  1435. /* Something to do? */
  1436. if(request->nodesToReadSize == 0) {
  1437. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  1438. return;
  1439. }
  1440. /* Check if there are too many operations */
  1441. if(server->config.maxNodesPerRead != 0 &&
  1442. request->nodesToReadSize > server->config.maxNodesPerRead) {
  1443. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  1444. return;
  1445. }
  1446. /* Allocate a temporary array to forward the result pointers to the
  1447. * backend */
  1448. void ** historyData = (void **)
  1449. UA_calloc(request->nodesToReadSize, sizeof(void*));
  1450. if(!historyData) {
  1451. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  1452. return;
  1453. }
  1454. /* Allocate the results array */
  1455. response->results = (UA_HistoryReadResult*)UA_Array_new(request->nodesToReadSize,
  1456. &UA_TYPES[UA_TYPES_HISTORYREADRESULT]);
  1457. if(!response->results) {
  1458. UA_free(historyData);
  1459. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  1460. return;
  1461. }
  1462. response->resultsSize = request->nodesToReadSize;
  1463. for(size_t i = 0; i < response->resultsSize; ++i) {
  1464. void * data = UA_new(historyDataType);
  1465. response->results[i].historyData.encoding = UA_EXTENSIONOBJECT_DECODED;
  1466. response->results[i].historyData.content.decoded.type = historyDataType;
  1467. response->results[i].historyData.content.decoded.data = data;
  1468. historyData[i] = data;
  1469. }
  1470. UA_UNLOCK(server->serviceMutex);
  1471. readHistory(server, server->config.historyDatabase.context,
  1472. &session->sessionId, session->sessionHandle,
  1473. &request->requestHeader,
  1474. request->historyReadDetails.content.decoded.data,
  1475. request->timestampsToReturn,
  1476. request->releaseContinuationPoints,
  1477. request->nodesToReadSize, request->nodesToRead,
  1478. response, historyData);
  1479. UA_LOCK(server->serviceMutex);
  1480. UA_free(historyData);
  1481. }
  1482. void
  1483. Service_HistoryUpdate(UA_Server *server, UA_Session *session,
  1484. const UA_HistoryUpdateRequest *request,
  1485. UA_HistoryUpdateResponse *response) {
  1486. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1487. response->resultsSize = request->historyUpdateDetailsSize;
  1488. response->results = (UA_HistoryUpdateResult*)UA_Array_new(response->resultsSize, &UA_TYPES[UA_TYPES_HISTORYUPDATERESULT]);
  1489. if (!response->results) {
  1490. response->resultsSize = 0;
  1491. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  1492. return;
  1493. }
  1494. for (size_t i = 0; i < request->historyUpdateDetailsSize; ++i) {
  1495. UA_HistoryUpdateResult_init(&response->results[i]);
  1496. if(request->historyUpdateDetails[i].encoding != UA_EXTENSIONOBJECT_DECODED) {
  1497. response->results[i].statusCode = UA_STATUSCODE_BADNOTSUPPORTED;
  1498. continue;
  1499. }
  1500. if (request->historyUpdateDetails[i].content.decoded.type
  1501. == &UA_TYPES[UA_TYPES_UPDATEDATADETAILS]) {
  1502. if (server->config.historyDatabase.updateData) {
  1503. UA_UNLOCK(server->serviceMutex);
  1504. server->config.historyDatabase.updateData(server,
  1505. server->config.historyDatabase.context,
  1506. &session->sessionId, session->sessionHandle,
  1507. &request->requestHeader,
  1508. (UA_UpdateDataDetails*)request->historyUpdateDetails[i].content.decoded.data,
  1509. &response->results[i]);
  1510. UA_LOCK(server->serviceMutex);
  1511. } else {
  1512. response->results[i].statusCode = UA_STATUSCODE_BADNOTSUPPORTED;
  1513. }
  1514. continue;
  1515. } else
  1516. if (request->historyUpdateDetails[i].content.decoded.type
  1517. == &UA_TYPES[UA_TYPES_DELETERAWMODIFIEDDETAILS]) {
  1518. if (server->config.historyDatabase.deleteRawModified) {
  1519. UA_UNLOCK(server->serviceMutex);
  1520. server->config.historyDatabase.deleteRawModified(server,
  1521. server->config.historyDatabase.context,
  1522. &session->sessionId, session->sessionHandle,
  1523. &request->requestHeader,
  1524. (UA_DeleteRawModifiedDetails*)request->historyUpdateDetails[i].content.decoded.data,
  1525. &response->results[i]);
  1526. UA_LOCK(server->serviceMutex);
  1527. } else {
  1528. response->results[i].statusCode = UA_STATUSCODE_BADNOTSUPPORTED;
  1529. }
  1530. continue;
  1531. } else {
  1532. response->results[i].statusCode = UA_STATUSCODE_BADNOTSUPPORTED;
  1533. continue;
  1534. }
  1535. }
  1536. response->responseHeader.serviceResult = UA_STATUSCODE_GOOD;
  1537. }
  1538. #endif
  1539. UA_StatusCode UA_EXPORT
  1540. UA_Server_writeObjectProperty(UA_Server *server, const UA_NodeId objectId,
  1541. const UA_QualifiedName propertyName,
  1542. const UA_Variant value){
  1543. UA_LOCK(server->serviceMutex);
  1544. UA_StatusCode retVal = writeObjectProperty(server, objectId, propertyName, value);
  1545. UA_UNLOCK(server->serviceMutex);
  1546. return retVal;
  1547. }
  1548. UA_StatusCode
  1549. writeObjectProperty(UA_Server *server, const UA_NodeId objectId,
  1550. const UA_QualifiedName propertyName,
  1551. const UA_Variant value) {
  1552. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1553. UA_RelativePathElement rpe;
  1554. UA_RelativePathElement_init(&rpe);
  1555. rpe.referenceTypeId = UA_NODEID_NUMERIC(0, UA_NS0ID_HASPROPERTY);
  1556. rpe.isInverse = false;
  1557. rpe.includeSubtypes = false;
  1558. rpe.targetName = propertyName;
  1559. UA_BrowsePath bp;
  1560. UA_BrowsePath_init(&bp);
  1561. bp.startingNode = objectId;
  1562. bp.relativePath.elementsSize = 1;
  1563. bp.relativePath.elements = &rpe;
  1564. UA_StatusCode retval;
  1565. UA_BrowsePathResult bpr = translateBrowsePathToNodeIds(server, &bp);
  1566. if(bpr.statusCode != UA_STATUSCODE_GOOD || bpr.targetsSize < 1) {
  1567. retval = bpr.statusCode;
  1568. UA_BrowsePathResult_clear(&bpr);
  1569. return retval;
  1570. }
  1571. retval = writeWithWriteValue(server, &bpr.targets[0].targetId.nodeId,
  1572. UA_ATTRIBUTEID_VALUE, &UA_TYPES[UA_TYPES_VARIANT], &value);
  1573. UA_BrowsePathResult_clear(&bpr);
  1574. return retval;
  1575. }
  1576. UA_StatusCode UA_EXPORT
  1577. UA_Server_writeObjectProperty_scalar(UA_Server *server, const UA_NodeId objectId,
  1578. const UA_QualifiedName propertyName,
  1579. const void *value, const UA_DataType *type) {
  1580. UA_Variant var;
  1581. UA_Variant_init(&var);
  1582. UA_Variant_setScalar(&var, (void*)(uintptr_t)value, type);
  1583. UA_LOCK(server->serviceMutex);
  1584. UA_StatusCode retval = writeObjectProperty(server, objectId, propertyName, var);
  1585. UA_UNLOCK(server->serviceMutex);
  1586. return retval;
  1587. }