ua_services_view.c 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247
  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-2019 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  6. * Copyright 2014-2017 (c) Florian Palm
  7. * Copyright 2015-2016 (c) Sten Grüner
  8. * Copyright 2015 (c) LEvertz
  9. * Copyright 2015 (c) Chris Iatrou
  10. * Copyright 2015 (c) Ecosmos
  11. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  12. * Copyright 2017 (c) Stefan Profanter, fortiss GmbH
  13. * Copyright 2016 (c) Lorenz Haas
  14. * Copyright 2017 (c) pschoppe
  15. * Copyright 2017 (c) Julian Grothoff
  16. * Copyright 2017 (c) Henrik Norrman
  17. */
  18. #include "ua_server_internal.h"
  19. #include "ua_services.h"
  20. #include "ziptree.h"
  21. /********************/
  22. /* Browse Recursive */
  23. /********************/
  24. /* A RefTree holds a single array for both the NodeIds encountered during
  25. * recursive browsing and the entries for a tree-structure to check for
  26. * duplicates. Once the (recursive) browse has finished, the tree-structure part
  27. * can be simply cut away. A single realloc operation (with some pointer
  28. * repairing) can be used to increase the capacity of the RefTree.
  29. *
  30. * If an ExpandedNodeId is encountered, it has to be processed right away.
  31. * Remote ExpandedNodeId are not put into the tree, since it is not possible to
  32. * recurse into them anyway.
  33. *
  34. * The layout of the results array is as follows:
  35. *
  36. * | Targets [ExpandedNodeId] | Tree [RefEntry] | */
  37. #define UA_BROWSE_INITIAL_SIZE 16
  38. typedef struct RefEntry {
  39. ZIP_ENTRY(RefEntry) zipfields;
  40. const UA_ExpandedNodeId *target;
  41. UA_UInt32 targetHash; /* Hash of the target nodeid */
  42. } RefEntry;
  43. static enum ZIP_CMP
  44. cmpTarget(const void *a, const void *b) {
  45. const RefEntry *aa = (const RefEntry*)a;
  46. const RefEntry *bb = (const RefEntry*)b;
  47. if(aa->targetHash < bb->targetHash)
  48. return ZIP_CMP_LESS;
  49. if(aa->targetHash > bb->targetHash)
  50. return ZIP_CMP_MORE;
  51. return (enum ZIP_CMP)UA_ExpandedNodeId_order(aa->target, bb->target);
  52. }
  53. ZIP_HEAD(RefHead, RefEntry);
  54. typedef struct RefHead RefHead;
  55. ZIP_PROTTYPE(RefHead, RefEntry, RefEntry)
  56. ZIP_IMPL(RefHead, RefEntry, zipfields, RefEntry, zipfields, cmpTarget)
  57. typedef struct {
  58. UA_ExpandedNodeId *targets;
  59. RefHead head;
  60. size_t capacity; /* available space */
  61. size_t size; /* used space */
  62. } RefTree;
  63. static UA_StatusCode UA_FUNC_ATTR_WARN_UNUSED_RESULT
  64. RefTree_init(RefTree *rt) {
  65. size_t space = (sizeof(UA_ExpandedNodeId) + sizeof(RefEntry)) * UA_BROWSE_INITIAL_SIZE;
  66. rt->targets = (UA_ExpandedNodeId*)UA_malloc(space);
  67. if(!rt->targets)
  68. return UA_STATUSCODE_BADOUTOFMEMORY;
  69. rt->capacity = UA_BROWSE_INITIAL_SIZE;
  70. rt->size = 0;
  71. ZIP_INIT(&rt->head);
  72. return UA_STATUSCODE_GOOD;
  73. }
  74. static void
  75. RefTree_clear(RefTree *rt) {
  76. for(size_t i = 0; i < rt->size; i++)
  77. UA_ExpandedNodeId_clear(&rt->targets[i]);
  78. UA_free(rt->targets);
  79. }
  80. /* Double the capacity of the reftree */
  81. static UA_StatusCode UA_FUNC_ATTR_WARN_UNUSED_RESULT
  82. RefTree_double(RefTree *rt) {
  83. size_t capacity = rt->capacity * 2;
  84. UA_assert(capacity > 0);
  85. size_t space = (sizeof(UA_ExpandedNodeId) + sizeof(RefEntry)) * capacity;
  86. UA_ExpandedNodeId *newTargets = (UA_ExpandedNodeId*)UA_realloc(rt->targets, space);
  87. if(!newTargets)
  88. return UA_STATUSCODE_BADOUTOFMEMORY;
  89. /* Repair the pointers for the realloced array+tree */
  90. uintptr_t arraydiff = (uintptr_t)newTargets - (uintptr_t)rt->targets;
  91. RefEntry *reArray = (RefEntry*)
  92. ((uintptr_t)newTargets + (capacity * sizeof(UA_ExpandedNodeId)));
  93. uintptr_t entrydiff = (uintptr_t)reArray -
  94. ((uintptr_t)rt->targets + (rt->capacity * sizeof(UA_ExpandedNodeId)));
  95. RefEntry *oldReArray = (RefEntry*)
  96. ((uintptr_t)newTargets + (rt->capacity * sizeof(UA_ExpandedNodeId)));
  97. memmove(reArray, oldReArray, rt->size * sizeof(RefEntry));
  98. for(size_t i = 0; i < rt->size; i++) {
  99. if(reArray[i].zipfields.zip_left)
  100. *(uintptr_t*)&reArray[i].zipfields.zip_left += entrydiff;
  101. if(reArray[i].zipfields.zip_right)
  102. *(uintptr_t*)&reArray[i].zipfields.zip_right += entrydiff;
  103. *(uintptr_t*)&reArray[i].target += arraydiff;
  104. }
  105. rt->head.zip_root = (RefEntry*)((uintptr_t)rt->head.zip_root + entrydiff);
  106. rt->capacity = capacity;
  107. rt->targets = newTargets;
  108. return UA_STATUSCODE_GOOD;
  109. }
  110. static UA_StatusCode UA_FUNC_ATTR_WARN_UNUSED_RESULT
  111. RefTree_add(RefTree *rt, const UA_ExpandedNodeId *target) {
  112. UA_StatusCode s = UA_STATUSCODE_GOOD;
  113. if(rt->capacity <= rt->size) {
  114. s = RefTree_double(rt);
  115. if(s != UA_STATUSCODE_GOOD)
  116. return s;
  117. }
  118. s = UA_ExpandedNodeId_copy(target, &rt->targets[rt->size]);
  119. if(s != UA_STATUSCODE_GOOD)
  120. return s;
  121. RefEntry *re = (RefEntry*)((uintptr_t)rt->targets +
  122. (sizeof(UA_ExpandedNodeId) * rt->capacity) +
  123. (sizeof(RefEntry) * rt->size));
  124. re->target = &rt->targets[rt->size];
  125. re->targetHash = UA_ExpandedNodeId_hash(target);
  126. ZIP_INSERT(RefHead, &rt->head, re, ZIP_FFS32(UA_UInt32_random()));
  127. rt->size++;
  128. return UA_STATUSCODE_GOOD;
  129. }
  130. static UA_Boolean
  131. relevantReference(const UA_NodeId *refType, size_t relevantRefsSize,
  132. const UA_NodeId *relevantRefs) {
  133. if(!relevantRefs)
  134. return true;
  135. for(size_t i = 0; i < relevantRefsSize; i++) {
  136. if(UA_NodeId_equal(refType, &relevantRefs[i]))
  137. return true;
  138. }
  139. return false;
  140. }
  141. static UA_StatusCode
  142. addRelevantReferences(UA_Server *server, RefTree *rt, const UA_NodeId *nodeId,
  143. size_t refTypesSize, const UA_NodeId *refTypes,
  144. UA_BrowseDirection browseDirection) {
  145. const UA_Node *node = UA_Nodestore_getNode(server->nsCtx, nodeId);
  146. if(!node)
  147. return UA_STATUSCODE_BADNODEIDUNKNOWN;
  148. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  149. for(size_t i = 0; i < node->referencesSize; i++) {
  150. UA_NodeReferenceKind *rk = &node->references[i];
  151. /* Reference in the right direction? */
  152. if(rk->isInverse && browseDirection == UA_BROWSEDIRECTION_FORWARD)
  153. continue;
  154. if(!rk->isInverse && browseDirection == UA_BROWSEDIRECTION_INVERSE)
  155. continue;
  156. /* Is the reference part of the hierarchy of references we look for? */
  157. if(!relevantReference(&rk->referenceTypeId, refTypesSize, refTypes))
  158. continue;
  159. for(size_t k = 0; k < rk->refTargetsSize; k++) {
  160. retval = RefTree_add(rt, &rk->refTargets[k].target);
  161. if(retval != UA_STATUSCODE_GOOD)
  162. goto cleanup;
  163. }
  164. }
  165. cleanup:
  166. UA_Nodestore_releaseNode(server->nsCtx, node);
  167. return retval;
  168. }
  169. UA_StatusCode
  170. browseRecursive(UA_Server *server,
  171. size_t startNodesSize, const UA_NodeId *startNodes,
  172. size_t refTypesSize, const UA_NodeId *refTypes,
  173. UA_BrowseDirection browseDirection, UA_Boolean includeStartNodes,
  174. size_t *resultsSize, UA_ExpandedNodeId **results) {
  175. RefTree rt;
  176. UA_StatusCode retval = RefTree_init(&rt);
  177. if(retval != UA_STATUSCODE_GOOD)
  178. return retval;
  179. /* Add the start nodes? */
  180. UA_ExpandedNodeId en = UA_EXPANDEDNODEID_NULL;
  181. for(size_t i = 0; i < startNodesSize && retval == UA_STATUSCODE_GOOD; i++) {
  182. if(includeStartNodes) {
  183. en.nodeId = startNodes[i];
  184. retval = RefTree_add(&rt, &en);
  185. } else {
  186. retval = addRelevantReferences(server, &rt, &startNodes[i],
  187. refTypesSize, refTypes, browseDirection);
  188. }
  189. }
  190. if(retval != UA_STATUSCODE_GOOD) {
  191. RefTree_clear(&rt);
  192. return retval;
  193. }
  194. /* Loop over the targets we have so far. This recurses, as new targets are
  195. * added to rt. */
  196. for(size_t i = 0; i < rt.size; i++) {
  197. /* Dont recurse into remote nodes */
  198. if(rt.targets[i].serverIndex > 0)
  199. continue;
  200. if(rt.targets[i].namespaceUri.data != NULL)
  201. continue;
  202. retval = addRelevantReferences(server, &rt, &rt.targets[i].nodeId,
  203. refTypesSize, refTypes, browseDirection);
  204. if(retval != UA_STATUSCODE_GOOD) {
  205. RefTree_clear(&rt);
  206. return retval;
  207. }
  208. }
  209. if(rt.size > 0) {
  210. *results = rt.targets;
  211. *resultsSize = rt.size;
  212. } else {
  213. RefTree_clear(&rt);
  214. }
  215. return UA_STATUSCODE_GOOD;
  216. }
  217. /* Only if IncludeSubtypes is selected */
  218. UA_StatusCode
  219. referenceSubtypes(UA_Server *server, const UA_NodeId *refType,
  220. size_t *refTypesSize, UA_NodeId **refTypes) {
  221. /* Leave refTypes == NULL */
  222. if(UA_NodeId_isNull(refType))
  223. return UA_STATUSCODE_GOOD;
  224. /* Browse recursive for the hierarchy of sub-references */
  225. UA_ExpandedNodeId *rt = NULL;
  226. size_t rtSize = 0;
  227. UA_NodeId hasSubtype = UA_NODEID_NUMERIC(0, UA_NS0ID_HASSUBTYPE);
  228. UA_StatusCode retval = browseRecursive(server, 1, refType, 1, &hasSubtype,
  229. UA_BROWSEDIRECTION_FORWARD, true, &rtSize, &rt);
  230. if(retval != UA_STATUSCODE_GOOD)
  231. return retval;
  232. UA_assert(rtSize > 0);
  233. /* Allocate space (realloc if non-NULL) */
  234. UA_NodeId *newRt = NULL;
  235. if(!*refTypes) {
  236. newRt = (UA_NodeId*)UA_malloc(rtSize * UA_TYPES[UA_TYPES_NODEID].memSize);
  237. } else {
  238. newRt = (UA_NodeId*)UA_realloc(*refTypes, (*refTypesSize + rtSize) *
  239. UA_TYPES[UA_TYPES_NODEID].memSize);
  240. }
  241. if(!newRt) {
  242. UA_Array_delete(rt, rtSize, &UA_TYPES[UA_TYPES_EXPANDEDNODEID]);
  243. return UA_STATUSCODE_BADOUTOFMEMORY;
  244. }
  245. *refTypes = newRt;
  246. /* Move NodeIds */
  247. for(size_t i = 0; i < rtSize; i++) {
  248. (*refTypes)[*refTypesSize + i] = rt[i].nodeId;
  249. UA_NodeId_init(&rt[i].nodeId);
  250. }
  251. *refTypesSize += rtSize;
  252. UA_Array_delete(rt, rtSize, &UA_TYPES[UA_TYPES_EXPANDEDNODEID]);
  253. return UA_STATUSCODE_GOOD;
  254. }
  255. UA_StatusCode
  256. UA_Server_browseRecursive(UA_Server *server, const UA_BrowseDescription *bd,
  257. size_t *resultsSize, UA_ExpandedNodeId **results) {
  258. /* Set the list of relevant reference types */
  259. UA_LOCK(server->serviceMutex);
  260. UA_NodeId *refTypes = NULL;
  261. size_t refTypesSize = 0;
  262. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  263. if(!UA_NodeId_isNull(&bd->referenceTypeId)) {
  264. if(!bd->includeSubtypes) {
  265. refTypes = (UA_NodeId*)(uintptr_t)&bd->referenceTypeId;
  266. refTypesSize = 1;
  267. } else {
  268. retval = referenceSubtypes(server, &bd->referenceTypeId,
  269. &refTypesSize, &refTypes);
  270. if(retval != UA_STATUSCODE_GOOD) {
  271. UA_UNLOCK(server->serviceMutex);
  272. return retval;
  273. }
  274. }
  275. }
  276. /* Browse */
  277. retval = browseRecursive(server, 1, &bd->nodeId, refTypesSize, refTypes,
  278. bd->browseDirection, false, resultsSize, results);
  279. /* Clean up */
  280. if(refTypes && bd->includeSubtypes)
  281. UA_Array_delete(refTypes, refTypesSize, &UA_TYPES[UA_TYPES_NODEID]);
  282. UA_UNLOCK(server->serviceMutex);
  283. return retval;
  284. }
  285. /**********/
  286. /* Browse */
  287. /**********/
  288. typedef struct {
  289. size_t size;
  290. size_t capacity;
  291. UA_ReferenceDescription *descr;
  292. } RefResult;
  293. static UA_StatusCode UA_FUNC_ATTR_WARN_UNUSED_RESULT
  294. RefResult_init(RefResult *rr) {
  295. memset(rr, 0, sizeof(RefResult));
  296. rr->descr = (UA_ReferenceDescription*)
  297. UA_Array_new(UA_BROWSE_INITIAL_SIZE, &UA_TYPES[UA_TYPES_REFERENCEDESCRIPTION]);
  298. if(!rr->descr)
  299. return UA_STATUSCODE_BADOUTOFMEMORY;
  300. rr->capacity = UA_BROWSE_INITIAL_SIZE;
  301. rr->size = 0;
  302. return UA_STATUSCODE_GOOD;
  303. }
  304. static UA_StatusCode UA_FUNC_ATTR_WARN_UNUSED_RESULT
  305. RefResult_double(RefResult *rr) {
  306. size_t newSize = rr->capacity * 2;
  307. UA_ReferenceDescription *rd = (UA_ReferenceDescription*)
  308. UA_realloc(rr->descr, newSize * sizeof(UA_ReferenceDescription));
  309. if(!rd)
  310. return UA_STATUSCODE_BADOUTOFMEMORY;
  311. memset(&rd[rr->size], 0, sizeof(UA_ReferenceDescription) * (newSize - rr->size));
  312. rr->descr = rd;
  313. rr->capacity = newSize;
  314. return UA_STATUSCODE_GOOD;
  315. }
  316. static void
  317. RefResult_clear(RefResult *rr) {
  318. UA_assert(rr->descr != NULL);
  319. for(size_t i = 0; i < rr->size; i++)
  320. UA_ReferenceDescription_clear(&rr->descr[i]);
  321. UA_free(rr->descr);
  322. }
  323. struct ContinuationPoint {
  324. ContinuationPoint *next;
  325. UA_ByteString identifier;
  326. UA_BrowseDescription browseDescription;
  327. UA_UInt32 maxReferences;
  328. size_t relevantReferencesSize;
  329. UA_NodeId *relevantReferences;
  330. /* The last point in the node references? */
  331. size_t referenceKindIndex;
  332. size_t targetIndex;
  333. };
  334. ContinuationPoint *
  335. ContinuationPoint_clear(ContinuationPoint *cp) {
  336. UA_ByteString_clear(&cp->identifier);
  337. UA_BrowseDescription_clear(&cp->browseDescription);
  338. UA_Array_delete(cp->relevantReferences, cp->relevantReferencesSize,
  339. &UA_TYPES[UA_TYPES_NODEID]);
  340. return cp->next;
  341. }
  342. /* Target node on top of the stack */
  343. static UA_StatusCode UA_FUNC_ATTR_WARN_UNUSED_RESULT
  344. addReferenceDescription(UA_Server *server, RefResult *rr, const UA_NodeReferenceKind *ref,
  345. UA_UInt32 mask, const UA_ExpandedNodeId *nodeId, const UA_Node *curr) {
  346. /* Ensure capacity is left */
  347. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  348. if(rr->size >= rr->capacity) {
  349. retval = RefResult_double(rr);
  350. if(retval != UA_STATUSCODE_GOOD)
  351. return retval;
  352. }
  353. UA_ReferenceDescription *descr = &rr->descr[rr->size];
  354. /* Fields without access to the actual node */
  355. retval = UA_ExpandedNodeId_copy(nodeId, &descr->nodeId);
  356. if(mask & UA_BROWSERESULTMASK_REFERENCETYPEID)
  357. retval |= UA_NodeId_copy(&ref->referenceTypeId, &descr->referenceTypeId);
  358. if(mask & UA_BROWSERESULTMASK_ISFORWARD)
  359. descr->isForward = !ref->isInverse;
  360. /* Remote references (ExpandedNodeId) are not further looked up here */
  361. if(!curr) {
  362. UA_ReferenceDescription_clear(descr);
  363. return retval;
  364. }
  365. /* Fields that require the actual node */
  366. if(mask & UA_BROWSERESULTMASK_NODECLASS)
  367. retval |= UA_NodeClass_copy(&curr->nodeClass, &descr->nodeClass);
  368. if(mask & UA_BROWSERESULTMASK_BROWSENAME)
  369. retval |= UA_QualifiedName_copy(&curr->browseName, &descr->browseName);
  370. if(mask & UA_BROWSERESULTMASK_DISPLAYNAME)
  371. retval |= UA_LocalizedText_copy(&curr->displayName, &descr->displayName);
  372. if(mask & UA_BROWSERESULTMASK_TYPEDEFINITION) {
  373. if(curr->nodeClass == UA_NODECLASS_OBJECT ||
  374. curr->nodeClass == UA_NODECLASS_VARIABLE) {
  375. const UA_Node *type = getNodeType(server, curr);
  376. if(type) {
  377. retval |= UA_NodeId_copy(&type->nodeId, &descr->typeDefinition.nodeId);
  378. UA_Nodestore_releaseNode(server->nsCtx, type);
  379. }
  380. }
  381. }
  382. if(retval == UA_STATUSCODE_GOOD)
  383. rr->size++; /* Increase the counter */
  384. else
  385. UA_ReferenceDescription_clear(descr);
  386. return retval;
  387. }
  388. static UA_Boolean
  389. matchClassMask(const UA_Node *node, UA_UInt32 nodeClassMask) {
  390. if(nodeClassMask != UA_NODECLASS_UNSPECIFIED &&
  391. (node->nodeClass & nodeClassMask) == 0)
  392. return false;
  393. return true;
  394. }
  395. /* Returns whether the node / continuationpoint is done */
  396. static UA_StatusCode
  397. browseReferences(UA_Server *server, const UA_Node *node,
  398. ContinuationPoint *cp, RefResult *rr, UA_Boolean *done) {
  399. UA_assert(cp != NULL);
  400. const UA_BrowseDescription *bd= &cp->browseDescription;
  401. size_t referenceKindIndex = cp->referenceKindIndex;
  402. size_t targetIndex = cp->targetIndex;
  403. /* Loop over the node's references */
  404. const UA_Node *target = NULL;
  405. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  406. for(; referenceKindIndex < node->referencesSize; ++referenceKindIndex) {
  407. UA_NodeReferenceKind *rk = &node->references[referenceKindIndex];
  408. /* Reference in the right direction? */
  409. if(rk->isInverse && bd->browseDirection == UA_BROWSEDIRECTION_FORWARD)
  410. continue;
  411. if(!rk->isInverse && bd->browseDirection == UA_BROWSEDIRECTION_INVERSE)
  412. continue;
  413. /* Is the reference part of the hierarchy of references we look for? */
  414. if(!relevantReference(&rk->referenceTypeId, cp->relevantReferencesSize,
  415. cp->relevantReferences))
  416. continue;
  417. /* Loop over the targets */
  418. for(; targetIndex < rk->refTargetsSize; ++targetIndex) {
  419. target = NULL;
  420. /* Get the node if it is not a remote reference */
  421. if(rk->refTargets[targetIndex].target.serverIndex == 0 &&
  422. rk->refTargets[targetIndex].target.namespaceUri.data == NULL) {
  423. target = UA_Nodestore_getNode(server->nsCtx,
  424. &rk->refTargets[targetIndex].target.nodeId);
  425. /* Test if the node class matches */
  426. if(target && !matchClassMask(target, bd->nodeClassMask)) {
  427. if(target)
  428. UA_Nodestore_releaseNode(server->nsCtx, target);
  429. continue;
  430. }
  431. }
  432. /* A match! Did we reach maxrefs? */
  433. if(rr->size >= cp->maxReferences) {
  434. cp->referenceKindIndex = referenceKindIndex;
  435. cp->targetIndex = targetIndex;
  436. if(target)
  437. UA_Nodestore_releaseNode(server->nsCtx, target);
  438. return UA_STATUSCODE_GOOD;
  439. }
  440. /* Copy the node description. Target is on top of the stack */
  441. retval = addReferenceDescription(server, rr, rk, bd->resultMask,
  442. &rk->refTargets[targetIndex].target, target);
  443. UA_Nodestore_releaseNode(server->nsCtx, target);
  444. if(retval != UA_STATUSCODE_GOOD)
  445. return retval;
  446. }
  447. targetIndex = 0; /* Start at index 0 for the next reference kind */
  448. }
  449. /* The node is done */
  450. *done = true;
  451. return UA_STATUSCODE_GOOD;
  452. }
  453. /* Results for a single browsedescription. This is the inner loop for both
  454. * Browse and BrowseNext. The ContinuationPoint contains all the data used.
  455. * Including the BrowseDescription. Returns whether there are remaining
  456. * references. */
  457. static UA_Boolean
  458. browseWithContinuation(UA_Server *server, UA_Session *session,
  459. ContinuationPoint *cp, UA_BrowseResult *result) {
  460. const UA_BrowseDescription *descr = &cp->browseDescription;
  461. /* Is the browsedirection valid? */
  462. if(descr->browseDirection != UA_BROWSEDIRECTION_BOTH &&
  463. descr->browseDirection != UA_BROWSEDIRECTION_FORWARD &&
  464. descr->browseDirection != UA_BROWSEDIRECTION_INVERSE) {
  465. result->statusCode = UA_STATUSCODE_BADBROWSEDIRECTIONINVALID;
  466. return true;
  467. }
  468. /* Is the reference type valid? */
  469. if(!UA_NodeId_isNull(&descr->referenceTypeId)) {
  470. const UA_Node *reftype = UA_Nodestore_getNode(server->nsCtx, &descr->referenceTypeId);
  471. if(!reftype) {
  472. result->statusCode = UA_STATUSCODE_BADREFERENCETYPEIDINVALID;
  473. return true;
  474. }
  475. UA_Boolean isRef = (reftype->nodeClass == UA_NODECLASS_REFERENCETYPE);
  476. UA_Nodestore_releaseNode(server->nsCtx, reftype);
  477. if(!isRef) {
  478. result->statusCode = UA_STATUSCODE_BADREFERENCETYPEIDINVALID;
  479. return true;
  480. }
  481. }
  482. const UA_Node *node = UA_Nodestore_getNode(server->nsCtx, &descr->nodeId);
  483. if(!node) {
  484. result->statusCode = UA_STATUSCODE_BADNODEIDUNKNOWN;
  485. return true;
  486. }
  487. RefResult rr;
  488. result->statusCode = RefResult_init(&rr);
  489. if(result->statusCode != UA_STATUSCODE_GOOD) {
  490. UA_Nodestore_releaseNode(server->nsCtx, node);
  491. return true;
  492. }
  493. /* Browse the references */
  494. UA_Boolean done = false;
  495. result->statusCode = browseReferences(server, node, cp, &rr, &done);
  496. UA_Nodestore_releaseNode(server->nsCtx, node);
  497. if(result->statusCode != UA_STATUSCODE_GOOD) {
  498. RefResult_clear(&rr);
  499. return true;
  500. }
  501. /* Move results */
  502. if(rr.size > 0) {
  503. result->references = rr.descr;
  504. result->referencesSize = rr.size;
  505. } else {
  506. /* No relevant references, return array of length zero */
  507. RefResult_clear(&rr);
  508. result->references = (UA_ReferenceDescription*)UA_EMPTY_ARRAY_SENTINEL;
  509. }
  510. return done;
  511. }
  512. /* Start to browse with no previous cp */
  513. void
  514. Operation_Browse(UA_Server *server, UA_Session *session, const UA_UInt32 *maxrefs,
  515. const UA_BrowseDescription *descr, UA_BrowseResult *result) {
  516. /* Stack-allocate a temporary cp */
  517. UA_STACKARRAY(ContinuationPoint, cp, 1);
  518. memset(cp, 0, sizeof(ContinuationPoint));
  519. cp->maxReferences = *maxrefs;
  520. cp->browseDescription = *descr; /* Shallow copy. Deep-copy later if we persist the cp. */
  521. /* How many references can we return at most? */
  522. if(cp->maxReferences == 0) {
  523. if(server->config.maxReferencesPerNode != 0) {
  524. cp->maxReferences = server->config.maxReferencesPerNode;
  525. } else {
  526. cp->maxReferences = UA_INT32_MAX;
  527. }
  528. } else {
  529. if(server->config.maxReferencesPerNode != 0 &&
  530. cp->maxReferences > server->config.maxReferencesPerNode) {
  531. cp->maxReferences= server->config.maxReferencesPerNode;
  532. }
  533. }
  534. /* Get the list of relevant reference types */
  535. if(!UA_NodeId_isNull(&descr->referenceTypeId)) {
  536. if(!descr->includeSubtypes) {
  537. cp->relevantReferences = (UA_NodeId*)(uintptr_t)&descr->referenceTypeId;
  538. cp->relevantReferencesSize = 1;
  539. } else {
  540. result->statusCode =
  541. referenceSubtypes(server, &descr->referenceTypeId,
  542. &cp->relevantReferencesSize, &cp->relevantReferences);
  543. if(result->statusCode != UA_STATUSCODE_GOOD)
  544. return;
  545. }
  546. }
  547. UA_Boolean done = browseWithContinuation(server, session, cp, result);
  548. /* Exit early if done or an error occurred */
  549. if(done || result->statusCode != UA_STATUSCODE_GOOD) {
  550. if(descr->includeSubtypes)
  551. UA_Array_delete(cp->relevantReferences, cp->relevantReferencesSize,
  552. &UA_TYPES[UA_TYPES_NODEID]);
  553. return;
  554. }
  555. /* Persist the new continuation point */
  556. ContinuationPoint *cp2 = NULL;
  557. UA_Guid *ident = NULL;
  558. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  559. /* Enough space for the continuation point? */
  560. if(session->availableContinuationPoints <= 0) {
  561. retval = UA_STATUSCODE_BADNOCONTINUATIONPOINTS;
  562. goto cleanup;
  563. }
  564. /* Allocate and fill the data structure */
  565. cp2 = (ContinuationPoint*)UA_malloc(sizeof(ContinuationPoint));
  566. if(!cp2) {
  567. retval = UA_STATUSCODE_BADOUTOFMEMORY;
  568. goto cleanup;
  569. }
  570. memset(cp2, 0, sizeof(ContinuationPoint));
  571. cp2->referenceKindIndex = cp->referenceKindIndex;
  572. cp2->targetIndex = cp->targetIndex;
  573. cp2->maxReferences = cp->maxReferences;
  574. if(descr->includeSubtypes) {
  575. cp2->relevantReferences = cp->relevantReferences;
  576. cp2->relevantReferencesSize = cp->relevantReferencesSize;
  577. } else {
  578. retval = UA_Array_copy(cp->relevantReferences, cp->relevantReferencesSize,
  579. (void**)&cp2->relevantReferences, &UA_TYPES[UA_TYPES_NODEID]);
  580. if(retval != UA_STATUSCODE_GOOD)
  581. goto cleanup;
  582. cp2->relevantReferencesSize = cp->relevantReferencesSize;
  583. }
  584. /* Copy the description */
  585. retval = UA_BrowseDescription_copy(descr, &cp2->browseDescription);
  586. if(retval != UA_STATUSCODE_GOOD)
  587. goto cleanup;
  588. /* Create a random bytestring via a Guid */
  589. ident = UA_Guid_new();
  590. if(!ident) {
  591. retval = UA_STATUSCODE_BADOUTOFMEMORY;
  592. goto cleanup;
  593. }
  594. *ident = UA_Guid_random();
  595. cp2->identifier.data = (UA_Byte*)ident;
  596. cp2->identifier.length = sizeof(UA_Guid);
  597. /* Return the cp identifier */
  598. retval = UA_ByteString_copy(&cp2->identifier, &result->continuationPoint);
  599. if(retval != UA_STATUSCODE_GOOD)
  600. goto cleanup;
  601. /* Attach the cp to the session */
  602. cp2->next = session->continuationPoints;
  603. session->continuationPoints = cp2;
  604. --session->availableContinuationPoints;
  605. return;
  606. cleanup:
  607. if(cp2) {
  608. ContinuationPoint_clear(cp2);
  609. UA_free(cp2);
  610. }
  611. UA_BrowseResult_clear(result);
  612. result->statusCode = retval;
  613. }
  614. void Service_Browse(UA_Server *server, UA_Session *session,
  615. const UA_BrowseRequest *request, UA_BrowseResponse *response) {
  616. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing BrowseRequest");
  617. UA_LOCK_ASSERT(server->serviceMutex, 1);
  618. /* Test the number of operations in the request */
  619. if(server->config.maxNodesPerBrowse != 0 &&
  620. request->nodesToBrowseSize > server->config.maxNodesPerBrowse) {
  621. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  622. return;
  623. }
  624. /* No views supported at the moment */
  625. if(!UA_NodeId_isNull(&request->view.viewId)) {
  626. response->responseHeader.serviceResult = UA_STATUSCODE_BADVIEWIDUNKNOWN;
  627. return;
  628. }
  629. response->responseHeader.serviceResult =
  630. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_Browse,
  631. &request->requestedMaxReferencesPerNode,
  632. &request->nodesToBrowseSize, &UA_TYPES[UA_TYPES_BROWSEDESCRIPTION],
  633. &response->resultsSize, &UA_TYPES[UA_TYPES_BROWSERESULT]);
  634. }
  635. UA_BrowseResult
  636. UA_Server_browse(UA_Server *server, UA_UInt32 maxReferences,
  637. const UA_BrowseDescription *bd) {
  638. UA_BrowseResult result;
  639. UA_BrowseResult_init(&result);
  640. UA_LOCK(server->serviceMutex);
  641. Operation_Browse(server, &server->adminSession, &maxReferences, bd, &result);
  642. UA_UNLOCK(server->serviceMutex);
  643. return result;
  644. }
  645. static void
  646. Operation_BrowseNext(UA_Server *server, UA_Session *session,
  647. const UA_Boolean *releaseContinuationPoints,
  648. const UA_ByteString *continuationPoint, UA_BrowseResult *result) {
  649. /* Find the continuation point */
  650. ContinuationPoint **prev = &session->continuationPoints, *cp;
  651. while((cp = *prev)) {
  652. if(UA_ByteString_equal(&cp->identifier, continuationPoint))
  653. break;
  654. prev = &cp->next;
  655. }
  656. if(!cp) {
  657. result->statusCode = UA_STATUSCODE_BADCONTINUATIONPOINTINVALID;
  658. return;
  659. }
  660. /* Remove the cp */
  661. if(*releaseContinuationPoints) {
  662. *prev = ContinuationPoint_clear(cp);
  663. UA_free(cp);
  664. ++session->availableContinuationPoints;
  665. return;
  666. }
  667. /* Continue browsing */
  668. UA_Boolean done = browseWithContinuation(server, session, cp, result);
  669. if(done) {
  670. /* Remove the cp if there are no references left */
  671. *prev = ContinuationPoint_clear(cp);
  672. UA_free(cp);
  673. ++session->availableContinuationPoints;
  674. } else {
  675. /* Return the cp identifier */
  676. UA_StatusCode retval = UA_ByteString_copy(&cp->identifier, &result->continuationPoint);
  677. if(retval != UA_STATUSCODE_GOOD) {
  678. UA_BrowseResult_clear(result);
  679. result->statusCode = retval;
  680. }
  681. }
  682. }
  683. void
  684. Service_BrowseNext(UA_Server *server, UA_Session *session,
  685. const UA_BrowseNextRequest *request,
  686. UA_BrowseNextResponse *response) {
  687. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  688. "Processing BrowseNextRequest");
  689. UA_LOCK_ASSERT(server->serviceMutex, 1);
  690. UA_Boolean releaseContinuationPoints = request->releaseContinuationPoints; /* request is const */
  691. response->responseHeader.serviceResult =
  692. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_BrowseNext,
  693. &releaseContinuationPoints,
  694. &request->continuationPointsSize, &UA_TYPES[UA_TYPES_BYTESTRING],
  695. &response->resultsSize, &UA_TYPES[UA_TYPES_BROWSERESULT]);
  696. }
  697. UA_BrowseResult
  698. UA_Server_browseNext(UA_Server *server, UA_Boolean releaseContinuationPoint,
  699. const UA_ByteString *continuationPoint) {
  700. UA_BrowseResult result;
  701. UA_BrowseResult_init(&result);
  702. UA_LOCK(server->serviceMutex);
  703. Operation_BrowseNext(server, &server->adminSession, &releaseContinuationPoint,
  704. continuationPoint, &result);
  705. UA_UNLOCK(server->serviceMutex);
  706. return result;
  707. }
  708. /***********************/
  709. /* TranslateBrowsePath */
  710. /***********************/
  711. static void
  712. walkBrowsePathElementReferenceTargets(UA_BrowsePathResult *result, size_t *targetsSize,
  713. UA_NodeId **next, size_t *nextSize, size_t *nextCount,
  714. UA_UInt32 elemDepth, const UA_NodeReferenceKind *rk) {
  715. /* Loop over the targets */
  716. for(size_t i = 0; i < rk->refTargetsSize; i++) {
  717. UA_ExpandedNodeId *targetId = &rk->refTargets[i].target;
  718. /* Does the reference point to an external server? Then add to the
  719. * targets with the right path depth. */
  720. if(targetId->serverIndex != 0) {
  721. UA_BrowsePathTarget *tempTargets =
  722. (UA_BrowsePathTarget*)UA_realloc(result->targets,
  723. sizeof(UA_BrowsePathTarget) * (*targetsSize) * 2);
  724. if(!tempTargets) {
  725. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  726. return;
  727. }
  728. result->targets = tempTargets;
  729. (*targetsSize) *= 2;
  730. result->statusCode = UA_ExpandedNodeId_copy(targetId,
  731. &result->targets[result->targetsSize].targetId);
  732. result->targets[result->targetsSize].remainingPathIndex = elemDepth;
  733. continue;
  734. }
  735. /* Can we store the node in the array of candidates for deep-search? */
  736. if(*nextSize <= *nextCount) {
  737. UA_NodeId *tempNext =
  738. (UA_NodeId*)UA_realloc(*next, sizeof(UA_NodeId) * (*nextSize) * 2);
  739. if(!tempNext) {
  740. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  741. return;
  742. }
  743. *next = tempNext;
  744. (*nextSize) *= 2;
  745. }
  746. /* Add the node to the next array for the following path element */
  747. result->statusCode = UA_NodeId_copy(&targetId->nodeId,
  748. &(*next)[*nextCount]);
  749. if(result->statusCode != UA_STATUSCODE_GOOD)
  750. return;
  751. ++(*nextCount);
  752. }
  753. }
  754. static void
  755. walkBrowsePathElement(UA_Server *server, UA_Session *session, UA_UInt32 nodeClassMask,
  756. UA_BrowsePathResult *result, size_t *targetsSize,
  757. const UA_RelativePathElement *elem, UA_UInt32 elemDepth,
  758. const UA_QualifiedName *targetName,
  759. const UA_NodeId *current, const size_t currentCount,
  760. UA_NodeId **next, size_t *nextSize, size_t *nextCount) {
  761. /* Return all references? */
  762. UA_Boolean all_refs = UA_NodeId_isNull(&elem->referenceTypeId);
  763. if(!all_refs) {
  764. const UA_Node *rootRef = UA_Nodestore_getNode(server->nsCtx, &elem->referenceTypeId);
  765. if(!rootRef)
  766. return;
  767. UA_Boolean match = (rootRef->nodeClass == UA_NODECLASS_REFERENCETYPE);
  768. UA_Nodestore_releaseNode(server->nsCtx, rootRef);
  769. if(!match)
  770. return;
  771. }
  772. /* Iterate over all nodes at the current depth-level */
  773. for(size_t i = 0; i < currentCount; ++i) {
  774. /* Get the node */
  775. const UA_Node *node = UA_Nodestore_getNode(server->nsCtx, &current[i]);
  776. if(!node) {
  777. /* If we cannot find the node at depth 0, the starting node does not exist */
  778. if(elemDepth == 0)
  779. result->statusCode = UA_STATUSCODE_BADNODEIDUNKNOWN;
  780. continue;
  781. }
  782. /* Test whether the node fits the class mask */
  783. if(!matchClassMask(node, nodeClassMask)) {
  784. UA_Nodestore_releaseNode(server->nsCtx, node);
  785. continue;
  786. }
  787. /* Test whether the node has the target name required in the previous
  788. * path element */
  789. if(targetName && (targetName->namespaceIndex != node->browseName.namespaceIndex ||
  790. !UA_String_equal(&targetName->name, &node->browseName.name))) {
  791. UA_Nodestore_releaseNode(server->nsCtx, node);
  792. continue;
  793. }
  794. /* Loop over the nodes references */
  795. for(size_t r = 0; r < node->referencesSize &&
  796. result->statusCode == UA_STATUSCODE_GOOD; ++r) {
  797. UA_NodeReferenceKind *rk = &node->references[r];
  798. /* Does the direction of the reference match? */
  799. if(rk->isInverse != elem->isInverse)
  800. continue;
  801. /* Is the node relevant? */
  802. if(!all_refs) {
  803. if(!elem->includeSubtypes && !UA_NodeId_equal(&rk->referenceTypeId, &elem->referenceTypeId))
  804. continue;
  805. if(!isNodeInTree(server->nsCtx, &rk->referenceTypeId, &elem->referenceTypeId, &subtypeId, 1))
  806. continue;
  807. }
  808. /* Walk over the reference targets */
  809. walkBrowsePathElementReferenceTargets(result, targetsSize, next, nextSize,
  810. nextCount, elemDepth, rk);
  811. }
  812. UA_Nodestore_releaseNode(server->nsCtx, node);
  813. }
  814. }
  815. /* This assumes that result->targets has enough room for all currentCount elements */
  816. static void
  817. addBrowsePathTargets(UA_Server *server, UA_Session *session, UA_UInt32 nodeClassMask,
  818. UA_BrowsePathResult *result, const UA_QualifiedName *targetName,
  819. UA_NodeId *current, size_t currentCount) {
  820. for(size_t i = 0; i < currentCount; i++) {
  821. const UA_Node *node = UA_Nodestore_getNode(server->nsCtx, &current[i]);
  822. if(!node) {
  823. UA_NodeId_clear(&current[i]);
  824. continue;
  825. }
  826. /* Test whether the node fits the class mask */
  827. UA_Boolean skip = !matchClassMask(node, nodeClassMask);
  828. /* Test whether the node has the target name required in the
  829. * previous path element */
  830. if(targetName->namespaceIndex != node->browseName.namespaceIndex ||
  831. !UA_String_equal(&targetName->name, &node->browseName.name))
  832. skip = true;
  833. UA_Nodestore_releaseNode(server->nsCtx, node);
  834. if(skip) {
  835. UA_NodeId_clear(&current[i]);
  836. continue;
  837. }
  838. /* Move the nodeid to the target array */
  839. UA_BrowsePathTarget_init(&result->targets[result->targetsSize]);
  840. result->targets[result->targetsSize].targetId.nodeId = current[i];
  841. result->targets[result->targetsSize].remainingPathIndex = UA_UINT32_MAX;
  842. ++result->targetsSize;
  843. }
  844. }
  845. static void
  846. walkBrowsePath(UA_Server *server, UA_Session *session, const UA_BrowsePath *path,
  847. UA_UInt32 nodeClassMask, UA_BrowsePathResult *result, size_t targetsSize,
  848. UA_NodeId **current, size_t *currentSize, size_t *currentCount,
  849. UA_NodeId **next, size_t *nextSize, size_t *nextCount) {
  850. UA_assert(*currentCount == 1);
  851. UA_assert(*nextCount == 0);
  852. /* Points to the targetName of the _previous_ path element */
  853. const UA_QualifiedName *targetName = NULL;
  854. /* Iterate over path elements */
  855. UA_assert(path->relativePath.elementsSize > 0);
  856. for(UA_UInt32 i = 0; i < path->relativePath.elementsSize; ++i) {
  857. walkBrowsePathElement(server, session, nodeClassMask, result, &targetsSize,
  858. &path->relativePath.elements[i], i, targetName,
  859. *current, *currentCount, next, nextSize, nextCount);
  860. /* Clean members of current */
  861. for(size_t j = 0; j < *currentCount; j++)
  862. UA_NodeId_clear(&(*current)[j]);
  863. *currentCount = 0;
  864. /* When no targets are left or an error occurred. None of next's
  865. * elements will be copied to result->targets */
  866. if(*nextCount == 0 || result->statusCode != UA_STATUSCODE_GOOD) {
  867. UA_assert(*currentCount == 0);
  868. UA_assert(*nextCount == 0);
  869. return;
  870. }
  871. /* Exchange current and next for the next depth */
  872. size_t tSize = *currentSize; size_t tCount = *currentCount; UA_NodeId *tT = *current;
  873. *currentSize = *nextSize; *currentCount = *nextCount; *current = *next;
  874. *nextSize = tSize; *nextCount = tCount; *next = tT;
  875. /* Store the target name of the previous path element */
  876. targetName = &path->relativePath.elements[i].targetName;
  877. }
  878. UA_assert(targetName != NULL);
  879. UA_assert(*nextCount == 0);
  880. /* After the last BrowsePathElement, move members from current to the
  881. * result targets */
  882. /* Realloc if more space is needed */
  883. if(targetsSize < result->targetsSize + (*currentCount)) {
  884. UA_BrowsePathTarget *newTargets =
  885. (UA_BrowsePathTarget*)UA_realloc(result->targets, sizeof(UA_BrowsePathTarget) *
  886. (result->targetsSize + (*currentCount)));
  887. if(!newTargets) {
  888. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  889. for(size_t i = 0; i < *currentCount; ++i)
  890. UA_NodeId_clear(&(*current)[i]);
  891. *currentCount = 0;
  892. return;
  893. }
  894. result->targets = newTargets;
  895. }
  896. /* Move the elements of current to the targets */
  897. addBrowsePathTargets(server, session, nodeClassMask, result, targetName, *current, *currentCount);
  898. *currentCount = 0;
  899. }
  900. static void
  901. Operation_TranslateBrowsePathToNodeIds(UA_Server *server, UA_Session *session,
  902. const UA_UInt32 *nodeClassMask, const UA_BrowsePath *path,
  903. UA_BrowsePathResult *result) {
  904. UA_LOCK_ASSERT(server->serviceMutex, 1);
  905. if(path->relativePath.elementsSize <= 0) {
  906. result->statusCode = UA_STATUSCODE_BADNOTHINGTODO;
  907. return;
  908. }
  909. /* RelativePath elements must not have an empty targetName */
  910. for(size_t i = 0; i < path->relativePath.elementsSize; ++i) {
  911. if(UA_QualifiedName_isNull(&path->relativePath.elements[i].targetName)) {
  912. result->statusCode = UA_STATUSCODE_BADBROWSENAMEINVALID;
  913. return;
  914. }
  915. }
  916. /* Allocate memory for the targets */
  917. size_t targetsSize = 10; /* When to realloc; the member count is stored in
  918. * result->targetsSize */
  919. result->targets =
  920. (UA_BrowsePathTarget*)UA_malloc(sizeof(UA_BrowsePathTarget) * targetsSize);
  921. if(!result->targets) {
  922. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  923. return;
  924. }
  925. /* Allocate memory for two temporary arrays. One with the results for the
  926. * previous depth of the path. The other for the new results at the current
  927. * depth. The two arrays alternate as we descend down the tree. */
  928. size_t currentSize = 10; /* When to realloc */
  929. size_t currentCount = 0; /* Current elements */
  930. UA_NodeId *current = (UA_NodeId*)UA_malloc(sizeof(UA_NodeId) * currentSize);
  931. if(!current) {
  932. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  933. UA_free(result->targets);
  934. return;
  935. }
  936. size_t nextSize = 10; /* When to realloc */
  937. size_t nextCount = 0; /* Current elements */
  938. UA_NodeId *next = (UA_NodeId*)UA_malloc(sizeof(UA_NodeId) * nextSize);
  939. if(!next) {
  940. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  941. UA_free(result->targets);
  942. UA_free(current);
  943. return;
  944. }
  945. /* Copy the starting node into current */
  946. result->statusCode = UA_NodeId_copy(&path->startingNode, &current[0]);
  947. if(result->statusCode != UA_STATUSCODE_GOOD) {
  948. UA_free(result->targets);
  949. UA_free(current);
  950. UA_free(next);
  951. return;
  952. }
  953. currentCount = 1;
  954. /* Walk the path elements */
  955. walkBrowsePath(server, session, path, *nodeClassMask, result, targetsSize,
  956. &current, &currentSize, &currentCount,
  957. &next, &nextSize, &nextCount);
  958. UA_assert(currentCount == 0);
  959. UA_assert(nextCount == 0);
  960. /* No results => BadNoMatch status code */
  961. if(result->targetsSize == 0 && result->statusCode == UA_STATUSCODE_GOOD)
  962. result->statusCode = UA_STATUSCODE_BADNOMATCH;
  963. /* Clean up the temporary arrays and the targets */
  964. UA_free(current);
  965. UA_free(next);
  966. if(result->statusCode != UA_STATUSCODE_GOOD) {
  967. for(size_t i = 0; i < result->targetsSize; ++i)
  968. UA_BrowsePathTarget_clear(&result->targets[i]);
  969. UA_free(result->targets);
  970. result->targets = NULL;
  971. result->targetsSize = 0;
  972. }
  973. }
  974. UA_BrowsePathResult
  975. translateBrowsePathToNodeIds(UA_Server *server,
  976. const UA_BrowsePath *browsePath) {
  977. UA_LOCK_ASSERT(server->serviceMutex, 1);
  978. UA_BrowsePathResult result;
  979. UA_BrowsePathResult_init(&result);
  980. UA_UInt32 nodeClassMask = 0; /* All node classes */
  981. Operation_TranslateBrowsePathToNodeIds(server, &server->adminSession, &nodeClassMask,
  982. browsePath, &result);
  983. return result;
  984. }
  985. UA_BrowsePathResult
  986. UA_Server_translateBrowsePathToNodeIds(UA_Server *server,
  987. const UA_BrowsePath *browsePath) {
  988. UA_LOCK(server->serviceMutex);
  989. UA_BrowsePathResult result = translateBrowsePathToNodeIds(server, browsePath);
  990. UA_UNLOCK(server->serviceMutex);
  991. return result;
  992. }
  993. void
  994. Service_TranslateBrowsePathsToNodeIds(UA_Server *server, UA_Session *session,
  995. const UA_TranslateBrowsePathsToNodeIdsRequest *request,
  996. UA_TranslateBrowsePathsToNodeIdsResponse *response) {
  997. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  998. "Processing TranslateBrowsePathsToNodeIdsRequest");
  999. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1000. /* Test the number of operations in the request */
  1001. if(server->config.maxNodesPerTranslateBrowsePathsToNodeIds != 0 &&
  1002. request->browsePathsSize > server->config.maxNodesPerTranslateBrowsePathsToNodeIds) {
  1003. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  1004. return;
  1005. }
  1006. UA_UInt32 nodeClassMask = 0; /* All node classes */
  1007. response->responseHeader.serviceResult =
  1008. UA_Server_processServiceOperations(server, session,
  1009. (UA_ServiceOperation)Operation_TranslateBrowsePathToNodeIds,
  1010. &nodeClassMask,
  1011. &request->browsePathsSize, &UA_TYPES[UA_TYPES_BROWSEPATH],
  1012. &response->resultsSize, &UA_TYPES[UA_TYPES_BROWSEPATHRESULT]);
  1013. }
  1014. UA_BrowsePathResult
  1015. browseSimplifiedBrowsePath(UA_Server *server, const UA_NodeId origin,
  1016. size_t browsePathSize, const UA_QualifiedName *browsePath) {
  1017. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1018. /* Construct the BrowsePath */
  1019. UA_BrowsePath bp;
  1020. UA_BrowsePath_init(&bp);
  1021. bp.startingNode = origin;
  1022. UA_STACKARRAY(UA_RelativePathElement, rpe, browsePathSize);
  1023. memset(rpe, 0, sizeof(UA_RelativePathElement) * browsePathSize);
  1024. for(size_t j = 0; j < browsePathSize; j++) {
  1025. rpe[j].referenceTypeId = UA_NODEID_NUMERIC(0, UA_NS0ID_HIERARCHICALREFERENCES);
  1026. rpe[j].includeSubtypes = true;
  1027. rpe[j].targetName = browsePath[j];
  1028. }
  1029. bp.relativePath.elements = rpe;
  1030. bp.relativePath.elementsSize = browsePathSize;
  1031. /* Browse */
  1032. UA_BrowsePathResult bpr;
  1033. UA_BrowsePathResult_init(&bpr);
  1034. UA_UInt32 nodeClassMask = UA_NODECLASS_OBJECT | UA_NODECLASS_VARIABLE;
  1035. Operation_TranslateBrowsePathToNodeIds(server, &server->adminSession, &nodeClassMask, &bp, &bpr);
  1036. return bpr;
  1037. }
  1038. UA_BrowsePathResult
  1039. UA_Server_browseSimplifiedBrowsePath(UA_Server *server, const UA_NodeId origin,
  1040. size_t browsePathSize, const UA_QualifiedName *browsePath) {
  1041. UA_LOCK(server->serviceMutex);
  1042. UA_BrowsePathResult bpr = browseSimplifiedBrowsePath(server, origin, browsePathSize, browsePath);;
  1043. UA_UNLOCK(server->serviceMutex);
  1044. return bpr;
  1045. }
  1046. /************/
  1047. /* Register */
  1048. /************/
  1049. void Service_RegisterNodes(UA_Server *server, UA_Session *session,
  1050. const UA_RegisterNodesRequest *request,
  1051. UA_RegisterNodesResponse *response) {
  1052. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  1053. "Processing RegisterNodesRequest");
  1054. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1055. //TODO: hang the nodeids to the session if really needed
  1056. if(request->nodesToRegisterSize == 0) {
  1057. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  1058. return;
  1059. }
  1060. /* Test the number of operations in the request */
  1061. if(server->config.maxNodesPerRegisterNodes != 0 &&
  1062. request->nodesToRegisterSize > server->config.maxNodesPerRegisterNodes) {
  1063. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  1064. return;
  1065. }
  1066. response->responseHeader.serviceResult =
  1067. UA_Array_copy(request->nodesToRegister, request->nodesToRegisterSize,
  1068. (void**)&response->registeredNodeIds, &UA_TYPES[UA_TYPES_NODEID]);
  1069. if(response->responseHeader.serviceResult == UA_STATUSCODE_GOOD)
  1070. response->registeredNodeIdsSize = request->nodesToRegisterSize;
  1071. }
  1072. void Service_UnregisterNodes(UA_Server *server, UA_Session *session,
  1073. const UA_UnregisterNodesRequest *request,
  1074. UA_UnregisterNodesResponse *response) {
  1075. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  1076. "Processing UnRegisterNodesRequest");
  1077. UA_LOCK_ASSERT(server->serviceMutex, 1);
  1078. //TODO: remove the nodeids from the session if really needed
  1079. if(request->nodesToUnregisterSize == 0)
  1080. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  1081. /* Test the number of operations in the request */
  1082. if(server->config.maxNodesPerRegisterNodes != 0 &&
  1083. request->nodesToUnregisterSize > server->config.maxNodesPerRegisterNodes) {
  1084. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  1085. return;
  1086. }
  1087. }