ua_services_view.c 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  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-2017 (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. struct ContinuationPointEntry {
  21. ContinuationPointEntry *next;
  22. UA_ByteString identifier;
  23. UA_BrowseDescription browseDescription;
  24. UA_UInt32 maxReferences;
  25. /* The last point in the node references? */
  26. size_t referenceKindIndex;
  27. size_t targetIndex;
  28. };
  29. ContinuationPointEntry *
  30. ContinuationPointEntry_clear(ContinuationPointEntry *cp) {
  31. UA_ByteString_deleteMembers(&cp->identifier);
  32. UA_BrowseDescription_deleteMembers(&cp->browseDescription);
  33. return cp->next;
  34. }
  35. /**********/
  36. /* Browse */
  37. /**********/
  38. /* Target node on top of the stack */
  39. static UA_StatusCode
  40. fillReferenceDescription(UA_Server *server, const UA_Node *curr,
  41. const UA_NodeReferenceKind *ref,
  42. UA_UInt32 mask, UA_ReferenceDescription *descr) {
  43. UA_ReferenceDescription_init(descr);
  44. UA_StatusCode retval = UA_NodeId_copy(&curr->nodeId, &descr->nodeId.nodeId);
  45. if(mask & UA_BROWSERESULTMASK_REFERENCETYPEID)
  46. retval |= UA_NodeId_copy(&ref->referenceTypeId, &descr->referenceTypeId);
  47. if(mask & UA_BROWSERESULTMASK_ISFORWARD)
  48. descr->isForward = !ref->isInverse;
  49. if(mask & UA_BROWSERESULTMASK_NODECLASS)
  50. retval |= UA_NodeClass_copy(&curr->nodeClass, &descr->nodeClass);
  51. if(mask & UA_BROWSERESULTMASK_BROWSENAME)
  52. retval |= UA_QualifiedName_copy(&curr->browseName, &descr->browseName);
  53. if(mask & UA_BROWSERESULTMASK_DISPLAYNAME)
  54. retval |= UA_LocalizedText_copy(&curr->displayName, &descr->displayName);
  55. if(mask & UA_BROWSERESULTMASK_TYPEDEFINITION) {
  56. if(curr->nodeClass == UA_NODECLASS_OBJECT ||
  57. curr->nodeClass == UA_NODECLASS_VARIABLE) {
  58. const UA_Node *type = getNodeType(server, curr);
  59. if(type) {
  60. retval |= UA_NodeId_copy(&type->nodeId, &descr->typeDefinition.nodeId);
  61. UA_Nodestore_releaseNode(server->nsCtx, type);
  62. }
  63. }
  64. }
  65. return retval;
  66. }
  67. static UA_Boolean
  68. relevantReference(UA_Server *server, UA_Boolean includeSubtypes,
  69. const UA_NodeId *rootRef, const UA_NodeId *testRef) {
  70. if(!includeSubtypes)
  71. return UA_NodeId_equal(rootRef, testRef);
  72. const UA_NodeId hasSubType = UA_NODEID_NUMERIC(0, UA_NS0ID_HASSUBTYPE);
  73. return isNodeInTree(server->nsCtx, testRef, rootRef, &hasSubType, 1);
  74. }
  75. static UA_Boolean
  76. matchClassMask(const UA_Node *node, UA_UInt32 nodeClassMask) {
  77. if(nodeClassMask != UA_NODECLASS_UNSPECIFIED &&
  78. (node->nodeClass & nodeClassMask) == 0)
  79. return false;
  80. return true;
  81. }
  82. /* Returns whether the node / continuationpoint is done */
  83. static UA_Boolean
  84. browseReferences(UA_Server *server, const UA_Node *node,
  85. ContinuationPointEntry *cp, UA_BrowseResult *result) {
  86. UA_assert(cp != NULL);
  87. const UA_BrowseDescription *descr = &cp->browseDescription;
  88. /* If the node has no references, just return */
  89. if(node->referencesSize == 0) {
  90. result->referencesSize = 0;
  91. return true;
  92. }
  93. /* Follow all references? */
  94. UA_Boolean browseAll = UA_NodeId_isNull(&descr->referenceTypeId);
  95. /* How many references can we return at most? */
  96. size_t maxrefs = cp->maxReferences;
  97. if(maxrefs == 0) {
  98. if(server->config.maxReferencesPerNode != 0) {
  99. maxrefs = server->config.maxReferencesPerNode;
  100. } else {
  101. maxrefs = UA_INT32_MAX;
  102. }
  103. } else {
  104. if(server->config.maxReferencesPerNode != 0 &&
  105. maxrefs > server->config.maxReferencesPerNode) {
  106. maxrefs = server->config.maxReferencesPerNode;
  107. }
  108. }
  109. /* Allocate the results array */
  110. size_t refs_size = 2; /* True size of the array */
  111. result->references = (UA_ReferenceDescription*)
  112. UA_Array_new(refs_size, &UA_TYPES[UA_TYPES_REFERENCEDESCRIPTION]);
  113. if(!result->references) {
  114. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  115. return false;
  116. }
  117. size_t referenceKindIndex = cp->referenceKindIndex;
  118. size_t targetIndex = cp->targetIndex;
  119. /* Loop over the node's references */
  120. for(; referenceKindIndex < node->referencesSize; ++referenceKindIndex) {
  121. UA_NodeReferenceKind *rk = &node->references[referenceKindIndex];
  122. /* Reference in the right direction? */
  123. if(rk->isInverse && descr->browseDirection == UA_BROWSEDIRECTION_FORWARD)
  124. continue;
  125. if(!rk->isInverse && descr->browseDirection == UA_BROWSEDIRECTION_INVERSE)
  126. continue;
  127. /* Is the reference part of the hierarchy of references we look for? */
  128. if(!browseAll && !relevantReference(server, descr->includeSubtypes,
  129. &descr->referenceTypeId, &rk->referenceTypeId))
  130. continue;
  131. /* Loop over the targets */
  132. for(; targetIndex < rk->targetIdsSize; ++targetIndex) {
  133. /* Get the node */
  134. const UA_Node *target =
  135. UA_Nodestore_getNode(server->nsCtx, &rk->targetIds[targetIndex].nodeId);
  136. if(!target)
  137. continue;
  138. /* Test if the node class matches */
  139. if(!matchClassMask(target, descr->nodeClassMask)) {
  140. UA_Nodestore_releaseNode(server->nsCtx, target);
  141. continue;
  142. }
  143. /* A match! Can we return it? */
  144. if(result->referencesSize >= maxrefs) {
  145. /* There are references we could not return */
  146. cp->referenceKindIndex = referenceKindIndex;
  147. cp->targetIndex = targetIndex;
  148. UA_Nodestore_releaseNode(server->nsCtx, target);
  149. return false;
  150. }
  151. /* Make enough space in the array */
  152. if(result->referencesSize >= refs_size) {
  153. refs_size *= 2;
  154. if(refs_size > maxrefs)
  155. refs_size = maxrefs;
  156. UA_ReferenceDescription *rd = (UA_ReferenceDescription*)
  157. UA_realloc(result->references, sizeof(UA_ReferenceDescription) * refs_size);
  158. if(!rd) {
  159. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  160. UA_Nodestore_releaseNode(server->nsCtx, target);
  161. goto error_recovery;
  162. }
  163. result->references = rd;
  164. }
  165. /* Copy the node description. Target is on top of the stack */
  166. result->statusCode =
  167. fillReferenceDescription(server, target, rk, descr->resultMask,
  168. &result->references[result->referencesSize]);
  169. UA_Nodestore_releaseNode(server->nsCtx, target);
  170. if(result->statusCode != UA_STATUSCODE_GOOD)
  171. goto error_recovery;
  172. /* Increase the counter */
  173. result->referencesSize++;
  174. }
  175. targetIndex = 0; /* Start at index 0 for the next reference kind */
  176. }
  177. /* No relevant references, return array of length zero */
  178. if(result->referencesSize == 0) {
  179. UA_free(result->references);
  180. result->references = (UA_ReferenceDescription*)UA_EMPTY_ARRAY_SENTINEL;
  181. }
  182. /* The node is done */
  183. return true;
  184. error_recovery:
  185. if(result->referencesSize == 0)
  186. UA_free(result->references);
  187. else
  188. UA_Array_delete(result->references, result->referencesSize,
  189. &UA_TYPES[UA_TYPES_REFERENCEDESCRIPTION]);
  190. result->references = NULL;
  191. result->referencesSize = 0;
  192. return false;
  193. }
  194. /* Results for a single browsedescription. This is the inner loop for both
  195. * Browse and BrowseNext. The ContinuationPoint contains all the data used.
  196. * Including the BrowseDescription. Returns whether there are remaining
  197. * references. */
  198. static UA_Boolean
  199. browseWithContinuation(UA_Server *server, UA_Session *session,
  200. ContinuationPointEntry *cp, UA_BrowseResult *result) {
  201. const UA_BrowseDescription *descr = &cp->browseDescription;
  202. /* Is the browsedirection valid? */
  203. if(descr->browseDirection != UA_BROWSEDIRECTION_BOTH &&
  204. descr->browseDirection != UA_BROWSEDIRECTION_FORWARD &&
  205. descr->browseDirection != UA_BROWSEDIRECTION_INVERSE) {
  206. result->statusCode = UA_STATUSCODE_BADBROWSEDIRECTIONINVALID;
  207. return true;
  208. }
  209. /* Is the reference type valid? */
  210. if(!UA_NodeId_isNull(&descr->referenceTypeId)) {
  211. const UA_Node *reftype = UA_Nodestore_getNode(server->nsCtx, &descr->referenceTypeId);
  212. if(!reftype) {
  213. result->statusCode = UA_STATUSCODE_BADREFERENCETYPEIDINVALID;
  214. return true;
  215. }
  216. UA_Boolean isRef = (reftype->nodeClass == UA_NODECLASS_REFERENCETYPE);
  217. UA_Nodestore_releaseNode(server->nsCtx, reftype);
  218. if(!isRef) {
  219. result->statusCode = UA_STATUSCODE_BADREFERENCETYPEIDINVALID;
  220. return true;
  221. }
  222. }
  223. const UA_Node *node = UA_Nodestore_getNode(server->nsCtx, &descr->nodeId);
  224. if(!node) {
  225. result->statusCode = UA_STATUSCODE_BADNODEIDUNKNOWN;
  226. return true;
  227. }
  228. /* Browse the references */
  229. UA_Boolean done = browseReferences(server, node, cp, result);
  230. UA_Nodestore_releaseNode(server->nsCtx, node);
  231. return done;
  232. }
  233. /* Start to browse with no previous cp */
  234. void
  235. Operation_Browse(UA_Server *server, UA_Session *session, const UA_UInt32 *maxrefs,
  236. const UA_BrowseDescription *descr, UA_BrowseResult *result) {
  237. /* Stack-allocate a temporary cp */
  238. UA_STACKARRAY(ContinuationPointEntry, cp, 1);
  239. memset(cp, 0, sizeof(ContinuationPointEntry));
  240. cp->maxReferences = *maxrefs;
  241. cp->browseDescription = *descr; /* Shallow copy. Deep-copy later if we persist the cp. */
  242. UA_Boolean done = browseWithContinuation(server, session, cp, result);
  243. /* Exit early if done or an error occurred */
  244. if(done || result->statusCode != UA_STATUSCODE_GOOD)
  245. return;
  246. /* Persist the new continuation point */
  247. ContinuationPointEntry *cp2 = NULL;
  248. UA_Guid *ident = NULL;
  249. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  250. /* Enough space for the continuation point? */
  251. if(session->availableContinuationPoints <= 0) {
  252. retval = UA_STATUSCODE_BADNOCONTINUATIONPOINTS;
  253. goto cleanup;
  254. }
  255. /* Allocate and fill the data structure */
  256. cp2 = (ContinuationPointEntry *)UA_malloc(sizeof(ContinuationPointEntry));
  257. if(!cp2) {
  258. retval = UA_STATUSCODE_BADOUTOFMEMORY;
  259. goto cleanup;
  260. }
  261. memset(cp2, 0, sizeof(ContinuationPointEntry));
  262. cp2->referenceKindIndex = cp->referenceKindIndex;
  263. cp2->targetIndex = cp->targetIndex;
  264. cp2->maxReferences = cp->maxReferences;
  265. retval = UA_BrowseDescription_copy(descr, &cp2->browseDescription);
  266. if(retval != UA_STATUSCODE_GOOD)
  267. goto cleanup;
  268. /* Create a random bytestring via a Guid */
  269. ident = UA_Guid_new();
  270. if(!ident) {
  271. retval = UA_STATUSCODE_BADOUTOFMEMORY;
  272. goto cleanup;
  273. }
  274. *ident = UA_Guid_random();
  275. cp2->identifier.data = (UA_Byte*)ident;
  276. cp2->identifier.length = sizeof(UA_Guid);
  277. /* Return the cp identifier */
  278. retval = UA_ByteString_copy(&cp2->identifier, &result->continuationPoint);
  279. if(retval != UA_STATUSCODE_GOOD)
  280. goto cleanup;
  281. /* Attach the cp to the session */
  282. cp2->next = session->continuationPoints;
  283. session->continuationPoints = cp2;
  284. --session->availableContinuationPoints;
  285. return;
  286. cleanup:
  287. if(cp2) {
  288. UA_ByteString_deleteMembers(&cp2->identifier);
  289. UA_BrowseDescription_deleteMembers(&cp2->browseDescription);
  290. UA_free(cp2);
  291. }
  292. UA_BrowseResult_deleteMembers(result);
  293. result->statusCode = retval;
  294. }
  295. void Service_Browse(UA_Server *server, UA_Session *session,
  296. const UA_BrowseRequest *request, UA_BrowseResponse *response) {
  297. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing BrowseRequest");
  298. /* Test the number of operations in the request */
  299. if(server->config.maxNodesPerBrowse != 0 &&
  300. request->nodesToBrowseSize > server->config.maxNodesPerBrowse) {
  301. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  302. return;
  303. }
  304. /* No views supported at the moment */
  305. if(!UA_NodeId_isNull(&request->view.viewId)) {
  306. response->responseHeader.serviceResult = UA_STATUSCODE_BADVIEWIDUNKNOWN;
  307. return;
  308. }
  309. UA_UInt32 requestedMaxReferencesPerNode = request->requestedMaxReferencesPerNode;
  310. response->responseHeader.serviceResult =
  311. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_Browse,
  312. &requestedMaxReferencesPerNode,
  313. &request->nodesToBrowseSize, &UA_TYPES[UA_TYPES_BROWSEDESCRIPTION],
  314. &response->resultsSize, &UA_TYPES[UA_TYPES_BROWSERESULT]);
  315. }
  316. UA_BrowseResult
  317. UA_Server_browse(UA_Server *server, UA_UInt32 maxReferences,
  318. const UA_BrowseDescription *bd) {
  319. UA_BrowseResult result;
  320. UA_BrowseResult_init(&result);
  321. Operation_Browse(server, &server->adminSession, &maxReferences, bd, &result);
  322. return result;
  323. }
  324. static void
  325. Operation_BrowseNext(UA_Server *server, UA_Session *session,
  326. const UA_Boolean *releaseContinuationPoints,
  327. const UA_ByteString *continuationPoint, UA_BrowseResult *result) {
  328. /* Find the continuation point */
  329. ContinuationPointEntry **prev = &session->continuationPoints, *cp;
  330. while((cp = *prev)) {
  331. if(UA_ByteString_equal(&cp->identifier, continuationPoint))
  332. break;
  333. prev = &cp->next;
  334. }
  335. if(!cp) {
  336. result->statusCode = UA_STATUSCODE_BADCONTINUATIONPOINTINVALID;
  337. return;
  338. }
  339. /* Remove the cp */
  340. if(*releaseContinuationPoints) {
  341. *prev = ContinuationPointEntry_clear(cp);
  342. UA_free(cp);
  343. ++session->availableContinuationPoints;
  344. return;
  345. }
  346. /* Continue browsing */
  347. UA_Boolean done = browseWithContinuation(server, session, cp, result);
  348. if(done) {
  349. /* Remove the cp if there are no references left */
  350. *prev = ContinuationPointEntry_clear(cp);
  351. UA_free(cp);
  352. ++session->availableContinuationPoints;
  353. } else {
  354. /* Return the cp identifier */
  355. UA_StatusCode retval = UA_ByteString_copy(&cp->identifier, &result->continuationPoint);
  356. if(retval != UA_STATUSCODE_GOOD) {
  357. UA_BrowseResult_deleteMembers(result);
  358. result->statusCode = retval;
  359. }
  360. }
  361. }
  362. void
  363. Service_BrowseNext(UA_Server *server, UA_Session *session,
  364. const UA_BrowseNextRequest *request,
  365. UA_BrowseNextResponse *response) {
  366. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  367. "Processing BrowseNextRequest");
  368. UA_Boolean releaseContinuationPoints = request->releaseContinuationPoints; /* request is const */
  369. response->responseHeader.serviceResult =
  370. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_BrowseNext,
  371. &releaseContinuationPoints,
  372. &request->continuationPointsSize, &UA_TYPES[UA_TYPES_BYTESTRING],
  373. &response->resultsSize, &UA_TYPES[UA_TYPES_BROWSERESULT]);
  374. }
  375. UA_BrowseResult
  376. UA_Server_browseNext(UA_Server *server, UA_Boolean releaseContinuationPoint,
  377. const UA_ByteString *continuationPoint) {
  378. UA_BrowseResult result;
  379. UA_BrowseResult_init(&result);
  380. Operation_BrowseNext(server, &server->adminSession, &releaseContinuationPoint,
  381. continuationPoint, &result);
  382. return result;
  383. }
  384. /***********************/
  385. /* TranslateBrowsePath */
  386. /***********************/
  387. static void
  388. walkBrowsePathElementReferenceTargets(UA_BrowsePathResult *result, size_t *targetsSize,
  389. UA_NodeId **next, size_t *nextSize, size_t *nextCount,
  390. UA_UInt32 elemDepth, const UA_NodeReferenceKind *rk) {
  391. /* Loop over the targets */
  392. for(size_t i = 0; i < rk->targetIdsSize; i++) {
  393. UA_ExpandedNodeId *targetId = &rk->targetIds[i];
  394. /* Does the reference point to an external server? Then add to the
  395. * targets with the right path depth. */
  396. if(targetId->serverIndex != 0) {
  397. UA_BrowsePathTarget *tempTargets =
  398. (UA_BrowsePathTarget*)UA_realloc(result->targets,
  399. sizeof(UA_BrowsePathTarget) * (*targetsSize) * 2);
  400. if(!tempTargets) {
  401. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  402. return;
  403. }
  404. result->targets = tempTargets;
  405. (*targetsSize) *= 2;
  406. result->statusCode = UA_ExpandedNodeId_copy(targetId,
  407. &result->targets[result->targetsSize].targetId);
  408. result->targets[result->targetsSize].remainingPathIndex = elemDepth;
  409. continue;
  410. }
  411. /* Can we store the node in the array of candidates for deep-search? */
  412. if(*nextSize <= *nextCount) {
  413. UA_NodeId *tempNext =
  414. (UA_NodeId*)UA_realloc(*next, sizeof(UA_NodeId) * (*nextSize) * 2);
  415. if(!tempNext) {
  416. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  417. return;
  418. }
  419. *next = tempNext;
  420. (*nextSize) *= 2;
  421. }
  422. /* Add the node to the next array for the following path element */
  423. result->statusCode = UA_NodeId_copy(&targetId->nodeId,
  424. &(*next)[*nextCount]);
  425. if(result->statusCode != UA_STATUSCODE_GOOD)
  426. return;
  427. ++(*nextCount);
  428. }
  429. }
  430. static void
  431. walkBrowsePathElement(UA_Server *server, UA_Session *session, UA_UInt32 nodeClassMask,
  432. UA_BrowsePathResult *result, size_t *targetsSize,
  433. const UA_RelativePathElement *elem, UA_UInt32 elemDepth,
  434. const UA_QualifiedName *targetName,
  435. const UA_NodeId *current, const size_t currentCount,
  436. UA_NodeId **next, size_t *nextSize, size_t *nextCount) {
  437. /* Return all references? */
  438. UA_Boolean all_refs = UA_NodeId_isNull(&elem->referenceTypeId);
  439. if(!all_refs) {
  440. const UA_Node *rootRef = UA_Nodestore_getNode(server->nsCtx, &elem->referenceTypeId);
  441. if(!rootRef)
  442. return;
  443. UA_Boolean match = (rootRef->nodeClass == UA_NODECLASS_REFERENCETYPE);
  444. UA_Nodestore_releaseNode(server->nsCtx, rootRef);
  445. if(!match)
  446. return;
  447. }
  448. /* Iterate over all nodes at the current depth-level */
  449. for(size_t i = 0; i < currentCount; ++i) {
  450. /* Get the node */
  451. const UA_Node *node = UA_Nodestore_getNode(server->nsCtx, &current[i]);
  452. if(!node) {
  453. /* If we cannot find the node at depth 0, the starting node does not exist */
  454. if(elemDepth == 0)
  455. result->statusCode = UA_STATUSCODE_BADNODEIDUNKNOWN;
  456. continue;
  457. }
  458. /* Test whether the node fits the class mask */
  459. if(!matchClassMask(node, nodeClassMask)) {
  460. UA_Nodestore_releaseNode(server->nsCtx, node);
  461. continue;
  462. }
  463. /* Test whether the node has the target name required in the previous
  464. * path element */
  465. if(targetName && (targetName->namespaceIndex != node->browseName.namespaceIndex ||
  466. !UA_String_equal(&targetName->name, &node->browseName.name))) {
  467. UA_Nodestore_releaseNode(server->nsCtx, node);
  468. continue;
  469. }
  470. /* Loop over the nodes references */
  471. for(size_t r = 0; r < node->referencesSize &&
  472. result->statusCode == UA_STATUSCODE_GOOD; ++r) {
  473. UA_NodeReferenceKind *rk = &node->references[r];
  474. /* Does the direction of the reference match? */
  475. if(rk->isInverse != elem->isInverse)
  476. continue;
  477. /* Is the node relevant? */
  478. if(!all_refs && !relevantReference(server, elem->includeSubtypes,
  479. &elem->referenceTypeId, &rk->referenceTypeId))
  480. continue;
  481. /* Walk over the reference targets */
  482. walkBrowsePathElementReferenceTargets(result, targetsSize, next, nextSize,
  483. nextCount, elemDepth, rk);
  484. }
  485. UA_Nodestore_releaseNode(server->nsCtx, node);
  486. }
  487. }
  488. /* This assumes that result->targets has enough room for all currentCount elements */
  489. static void
  490. addBrowsePathTargets(UA_Server *server, UA_Session *session, UA_UInt32 nodeClassMask,
  491. UA_BrowsePathResult *result, const UA_QualifiedName *targetName,
  492. UA_NodeId *current, size_t currentCount) {
  493. for(size_t i = 0; i < currentCount; i++) {
  494. const UA_Node *node = UA_Nodestore_getNode(server->nsCtx, &current[i]);
  495. if(!node) {
  496. UA_NodeId_deleteMembers(&current[i]);
  497. continue;
  498. }
  499. /* Test whether the node fits the class mask */
  500. UA_Boolean skip = !matchClassMask(node, nodeClassMask);
  501. /* Test whether the node has the target name required in the
  502. * previous path element */
  503. if(targetName->namespaceIndex != node->browseName.namespaceIndex ||
  504. !UA_String_equal(&targetName->name, &node->browseName.name))
  505. skip = true;
  506. UA_Nodestore_releaseNode(server->nsCtx, node);
  507. if(skip) {
  508. UA_NodeId_deleteMembers(&current[i]);
  509. continue;
  510. }
  511. /* Move the nodeid to the target array */
  512. UA_BrowsePathTarget_init(&result->targets[result->targetsSize]);
  513. result->targets[result->targetsSize].targetId.nodeId = current[i];
  514. result->targets[result->targetsSize].remainingPathIndex = UA_UINT32_MAX;
  515. ++result->targetsSize;
  516. }
  517. }
  518. static void
  519. walkBrowsePath(UA_Server *server, UA_Session *session, const UA_BrowsePath *path,
  520. UA_UInt32 nodeClassMask, UA_BrowsePathResult *result, size_t targetsSize,
  521. UA_NodeId **current, size_t *currentSize, size_t *currentCount,
  522. UA_NodeId **next, size_t *nextSize, size_t *nextCount) {
  523. UA_assert(*currentCount == 1);
  524. UA_assert(*nextCount == 0);
  525. /* Points to the targetName of the _previous_ path element */
  526. const UA_QualifiedName *targetName = NULL;
  527. /* Iterate over path elements */
  528. UA_assert(path->relativePath.elementsSize > 0);
  529. for(UA_UInt32 i = 0; i < path->relativePath.elementsSize; ++i) {
  530. walkBrowsePathElement(server, session, nodeClassMask, result, &targetsSize,
  531. &path->relativePath.elements[i], i, targetName,
  532. *current, *currentCount, next, nextSize, nextCount);
  533. /* Clean members of current */
  534. for(size_t j = 0; j < *currentCount; j++)
  535. UA_NodeId_deleteMembers(&(*current)[j]);
  536. *currentCount = 0;
  537. /* When no targets are left or an error occurred. None of next's
  538. * elements will be copied to result->targets */
  539. if(*nextCount == 0 || result->statusCode != UA_STATUSCODE_GOOD) {
  540. UA_assert(*currentCount == 0);
  541. UA_assert(*nextCount == 0);
  542. return;
  543. }
  544. /* Exchange current and next for the next depth */
  545. size_t tSize = *currentSize; size_t tCount = *currentCount; UA_NodeId *tT = *current;
  546. *currentSize = *nextSize; *currentCount = *nextCount; *current = *next;
  547. *nextSize = tSize; *nextCount = tCount; *next = tT;
  548. /* Store the target name of the previous path element */
  549. targetName = &path->relativePath.elements[i].targetName;
  550. }
  551. UA_assert(targetName != NULL);
  552. UA_assert(*nextCount == 0);
  553. /* After the last BrowsePathElement, move members from current to the
  554. * result targets */
  555. /* Realloc if more space is needed */
  556. if(targetsSize < result->targetsSize + (*currentCount)) {
  557. UA_BrowsePathTarget *newTargets =
  558. (UA_BrowsePathTarget*)UA_realloc(result->targets, sizeof(UA_BrowsePathTarget) *
  559. (result->targetsSize + (*currentCount)));
  560. if(!newTargets) {
  561. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  562. for(size_t i = 0; i < *currentCount; ++i)
  563. UA_NodeId_deleteMembers(&(*current)[i]);
  564. *currentCount = 0;
  565. return;
  566. }
  567. result->targets = newTargets;
  568. }
  569. /* Move the elements of current to the targets */
  570. addBrowsePathTargets(server, session, nodeClassMask, result, targetName, *current, *currentCount);
  571. *currentCount = 0;
  572. }
  573. static void
  574. Operation_TranslateBrowsePathToNodeIds(UA_Server *server, UA_Session *session,
  575. const UA_UInt32 *nodeClassMask, const UA_BrowsePath *path,
  576. UA_BrowsePathResult *result) {
  577. if(path->relativePath.elementsSize <= 0) {
  578. result->statusCode = UA_STATUSCODE_BADNOTHINGTODO;
  579. return;
  580. }
  581. /* RelativePath elements must not have an empty targetName */
  582. for(size_t i = 0; i < path->relativePath.elementsSize; ++i) {
  583. if(UA_QualifiedName_isNull(&path->relativePath.elements[i].targetName)) {
  584. result->statusCode = UA_STATUSCODE_BADBROWSENAMEINVALID;
  585. return;
  586. }
  587. }
  588. /* Allocate memory for the targets */
  589. size_t targetsSize = 10; /* When to realloc; the member count is stored in
  590. * result->targetsSize */
  591. result->targets =
  592. (UA_BrowsePathTarget*)UA_malloc(sizeof(UA_BrowsePathTarget) * targetsSize);
  593. if(!result->targets) {
  594. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  595. return;
  596. }
  597. /* Allocate memory for two temporary arrays. One with the results for the
  598. * previous depth of the path. The other for the new results at the current
  599. * depth. The two arrays alternate as we descend down the tree. */
  600. size_t currentSize = 10; /* When to realloc */
  601. size_t currentCount = 0; /* Current elements */
  602. UA_NodeId *current = (UA_NodeId*)UA_malloc(sizeof(UA_NodeId) * currentSize);
  603. if(!current) {
  604. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  605. UA_free(result->targets);
  606. return;
  607. }
  608. size_t nextSize = 10; /* When to realloc */
  609. size_t nextCount = 0; /* Current elements */
  610. UA_NodeId *next = (UA_NodeId*)UA_malloc(sizeof(UA_NodeId) * nextSize);
  611. if(!next) {
  612. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  613. UA_free(result->targets);
  614. UA_free(current);
  615. return;
  616. }
  617. /* Copy the starting node into current */
  618. result->statusCode = UA_NodeId_copy(&path->startingNode, &current[0]);
  619. if(result->statusCode != UA_STATUSCODE_GOOD) {
  620. UA_free(result->targets);
  621. UA_free(current);
  622. UA_free(next);
  623. return;
  624. }
  625. currentCount = 1;
  626. /* Walk the path elements */
  627. walkBrowsePath(server, session, path, *nodeClassMask, result, targetsSize,
  628. &current, &currentSize, &currentCount,
  629. &next, &nextSize, &nextCount);
  630. UA_assert(currentCount == 0);
  631. UA_assert(nextCount == 0);
  632. /* No results => BadNoMatch status code */
  633. if(result->targetsSize == 0 && result->statusCode == UA_STATUSCODE_GOOD)
  634. result->statusCode = UA_STATUSCODE_BADNOMATCH;
  635. /* Clean up the temporary arrays and the targets */
  636. UA_free(current);
  637. UA_free(next);
  638. if(result->statusCode != UA_STATUSCODE_GOOD) {
  639. for(size_t i = 0; i < result->targetsSize; ++i)
  640. UA_BrowsePathTarget_deleteMembers(&result->targets[i]);
  641. UA_free(result->targets);
  642. result->targets = NULL;
  643. result->targetsSize = 0;
  644. }
  645. }
  646. UA_BrowsePathResult
  647. UA_Server_translateBrowsePathToNodeIds(UA_Server *server,
  648. const UA_BrowsePath *browsePath) {
  649. UA_BrowsePathResult result;
  650. UA_BrowsePathResult_init(&result);
  651. UA_UInt32 nodeClassMask = 0; /* All node classes */
  652. Operation_TranslateBrowsePathToNodeIds(server, &server->adminSession, &nodeClassMask,
  653. browsePath, &result);
  654. return result;
  655. }
  656. void
  657. Service_TranslateBrowsePathsToNodeIds(UA_Server *server, UA_Session *session,
  658. const UA_TranslateBrowsePathsToNodeIdsRequest *request,
  659. UA_TranslateBrowsePathsToNodeIdsResponse *response) {
  660. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  661. "Processing TranslateBrowsePathsToNodeIdsRequest");
  662. /* Test the number of operations in the request */
  663. if(server->config.maxNodesPerTranslateBrowsePathsToNodeIds != 0 &&
  664. request->browsePathsSize > server->config.maxNodesPerTranslateBrowsePathsToNodeIds) {
  665. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  666. return;
  667. }
  668. UA_UInt32 nodeClassMask = 0; /* All node classes */
  669. response->responseHeader.serviceResult =
  670. UA_Server_processServiceOperations(server, session,
  671. (UA_ServiceOperation)Operation_TranslateBrowsePathToNodeIds,
  672. &nodeClassMask,
  673. &request->browsePathsSize, &UA_TYPES[UA_TYPES_BROWSEPATH],
  674. &response->resultsSize, &UA_TYPES[UA_TYPES_BROWSEPATHRESULT]);
  675. }
  676. UA_BrowsePathResult
  677. UA_Server_browseSimplifiedBrowsePath(UA_Server *server, const UA_NodeId origin,
  678. size_t browsePathSize, const UA_QualifiedName *browsePath) {
  679. /* Construct the BrowsePath */
  680. UA_BrowsePath bp;
  681. UA_BrowsePath_init(&bp);
  682. bp.startingNode = origin;
  683. UA_STACKARRAY(UA_RelativePathElement, rpe, browsePathSize);
  684. memset(rpe, 0, sizeof(UA_RelativePathElement) * browsePathSize);
  685. for(size_t j = 0; j < browsePathSize; j++) {
  686. rpe[j].referenceTypeId = UA_NODEID_NUMERIC(0, UA_NS0ID_HIERARCHICALREFERENCES);
  687. rpe[j].includeSubtypes = true;
  688. rpe[j].targetName = browsePath[j];
  689. }
  690. bp.relativePath.elements = rpe;
  691. bp.relativePath.elementsSize = browsePathSize;
  692. /* Browse */
  693. UA_BrowsePathResult bpr;
  694. UA_BrowsePathResult_init(&bpr);
  695. UA_UInt32 nodeClassMask = UA_NODECLASS_OBJECT | UA_NODECLASS_VARIABLE;
  696. Operation_TranslateBrowsePathToNodeIds(server, &server->adminSession, &nodeClassMask, &bp, &bpr);
  697. return bpr;
  698. }
  699. /************/
  700. /* Register */
  701. /************/
  702. void Service_RegisterNodes(UA_Server *server, UA_Session *session,
  703. const UA_RegisterNodesRequest *request,
  704. UA_RegisterNodesResponse *response) {
  705. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  706. "Processing RegisterNodesRequest");
  707. //TODO: hang the nodeids to the session if really needed
  708. if(request->nodesToRegisterSize == 0) {
  709. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  710. return;
  711. }
  712. /* Test the number of operations in the request */
  713. if(server->config.maxNodesPerRegisterNodes != 0 &&
  714. request->nodesToRegisterSize > server->config.maxNodesPerRegisterNodes) {
  715. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  716. return;
  717. }
  718. response->responseHeader.serviceResult =
  719. UA_Array_copy(request->nodesToRegister, request->nodesToRegisterSize,
  720. (void**)&response->registeredNodeIds, &UA_TYPES[UA_TYPES_NODEID]);
  721. if(response->responseHeader.serviceResult == UA_STATUSCODE_GOOD)
  722. response->registeredNodeIdsSize = request->nodesToRegisterSize;
  723. }
  724. void Service_UnregisterNodes(UA_Server *server, UA_Session *session,
  725. const UA_UnregisterNodesRequest *request,
  726. UA_UnregisterNodesResponse *response) {
  727. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  728. "Processing UnRegisterNodesRequest");
  729. //TODO: remove the nodeids from the session if really needed
  730. if(request->nodesToUnregisterSize == 0)
  731. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
  732. /* Test the number of operations in the request */
  733. if(server->config.maxNodesPerRegisterNodes != 0 &&
  734. request->nodesToUnregisterSize > server->config.maxNodesPerRegisterNodes) {
  735. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  736. return;
  737. }
  738. }