open62541/src/server/ua_services_view.c

#include "ua_server_internal.h"
#include "ua_services.h"
#include "ua_statuscodes.h"
#include "ua_nodestore.h"
#include "ua_util.h"

/* Releases the current node, even if it was supplied as an argument. */
static UA_StatusCode fillReferenceDescription(UA_NodeStore *ns, const UA_Node *currentNode, UA_ReferenceNode *reference,
                                              UA_UInt32 resultMask, UA_ReferenceDescription *referenceDescription) {
    UA_StatusCode retval = UA_STATUSCODE_GOOD;
    UA_ReferenceDescription_init(referenceDescription);
    retval |= UA_NodeId_copy(&currentNode->nodeId, &referenceDescription->nodeId.nodeId);
    //TODO: ExpandedNodeId is mocked up
    referenceDescription->nodeId.serverIndex = 0;
    referenceDescription->nodeId.namespaceUri.length = -1;

    if(resultMask & UA_BROWSERESULTMASK_REFERENCETYPEID)
        retval |= UA_NodeId_copy(&reference->referenceTypeId, &referenceDescription->referenceTypeId);
    if(resultMask & UA_BROWSERESULTMASK_ISFORWARD)
        referenceDescription->isForward = !reference->isInverse;
    if(resultMask & UA_BROWSERESULTMASK_NODECLASS)
        retval |= UA_NodeClass_copy(&currentNode->nodeClass, &referenceDescription->nodeClass);
    if(resultMask & UA_BROWSERESULTMASK_BROWSENAME)
        retval |= UA_QualifiedName_copy(&currentNode->browseName, &referenceDescription->browseName);
    if(resultMask & UA_BROWSERESULTMASK_DISPLAYNAME)
        retval |= UA_LocalizedText_copy(&currentNode->displayName, &referenceDescription->displayName);
    if(resultMask & UA_BROWSERESULTMASK_TYPEDEFINITION ) {
        for(UA_Int32 i = 0;i < currentNode->referencesSize;i++) {
            UA_ReferenceNode *ref = &currentNode->references[i];
            if(ref->referenceTypeId.identifier.numeric == 40 /* hastypedefinition */) {
                retval |= UA_ExpandedNodeId_copy(&ref->targetId, &referenceDescription->typeDefinition);
                break;
            }
        }
    }

    if(currentNode)
        UA_NodeStore_release(currentNode);
    if(retval)
        UA_ReferenceDescription_deleteMembers(referenceDescription);
    return retval;
}

/* Tests if the node is relevant to the browse request and shall be returned. If
   so, it is retrieved from the Nodestore. If not, null is returned. */
static const UA_Node * getRelevantTargetNode(UA_NodeStore *ns, const UA_BrowseDescription *browseDescription,
                                             UA_Boolean returnAll, UA_ReferenceNode *reference,
                                             UA_NodeId *relevantRefTypes, size_t relevantRefTypesCount) {
    if(reference->isInverse == UA_TRUE &&
       browseDescription->browseDirection == UA_BROWSEDIRECTION_FORWARD)
        return UA_NULL;
    else if(reference->isInverse == UA_FALSE &&
            browseDescription->browseDirection == UA_BROWSEDIRECTION_INVERSE)
        return UA_NULL;

    UA_Boolean isRelevant = returnAll;
    if(!isRelevant) {
        for(size_t i = 0;i < relevantRefTypesCount;i++) {
            if(UA_NodeId_equal(&reference->referenceTypeId, &relevantRefTypes[i]))
                isRelevant = UA_TRUE;
        }
        if(!isRelevant)
            return UA_NULL;
    }

    const UA_Node *node = UA_NodeStore_get(ns, &reference->targetId.nodeId);
    if(node && browseDescription->nodeClassMask != 0 && (node->nodeClass & browseDescription->nodeClassMask) == 0) {
        UA_NodeStore_release(node);
        node = UA_NULL;
    }
    return node;
}

/* Find all referencetypes that are subtypes (of subtypes) of the given root referencetype */
static UA_StatusCode findReferenceTypeSubTypes(UA_NodeStore *ns, const UA_NodeId *rootReferenceType,
                                               UA_NodeId **referenceTypes, size_t *referenceTypesSize) {
    /* The references form a tree. We walk the tree by adding new nodes to the end of the array. */
    size_t index = 0;
    size_t lastIndex = 0;
    size_t arraySize = 20; // should be more than enough. if not, increase the array size.
    UA_NodeId *typeArray = UA_malloc(sizeof(UA_NodeId) * arraySize);
    if(!typeArray)
        return UA_STATUSCODE_BADOUTOFMEMORY;

    UA_StatusCode retval = UA_STATUSCODE_GOOD;
    retval |= UA_NodeId_copy(rootReferenceType, &typeArray[0]);
    if(retval) {
        UA_free(typeArray);
        return UA_STATUSCODE_BADOUTOFMEMORY;
    }
        
    /**
     * We find all subtypes by a single iteration over the array. We start with an array with a
     * single root nodeid at the beginning. When we find relevant references, we add the nodeids to
     * the back of the array and increase the size. Since the hierarchy is not cyclic, we can safely
     * progress in the array to process the newly found referencetype nodeids (emulated recursion).
     */
    do {
        // 1) Get the node
        const UA_ReferenceTypeNode *node =
            (const UA_ReferenceTypeNode *)UA_NodeStore_get(ns, &typeArray[index]);
        if(!node)
            break;

        // 2) Check that we have the right type of node
        if(node->nodeClass != UA_NODECLASS_REFERENCETYPE) 
            continue;

        // 3) Find references to subtypes
        for(UA_Int32 i = 0; i < node->referencesSize && retval == UA_STATUSCODE_GOOD; i++) {
            // Is this a subtype reference?
            if(node->references[i].referenceTypeId.identifier.numeric != 45 /* HasSubtype */ ||
               node->references[i].isInverse == UA_TRUE)
                continue;

            // Do we have enough space in the array?
            if(lastIndex + 1 >= arraySize) {
                UA_NodeId *newArray = UA_malloc(sizeof(UA_NodeId) * arraySize * 2);
                if(!newArray) {
                    retval = UA_STATUSCODE_BADOUTOFMEMORY;
                    break;
                }
                UA_memcpy(newArray, typeArray, sizeof(UA_NodeId) * arraySize);
                arraySize *= 2;
                UA_free(typeArray);
                typeArray = newArray;
            }

            // Copy the node
            retval |= UA_NodeId_copy(&node->references[i].targetId.nodeId, &typeArray[++lastIndex]);
            if(retval)
                lastIndex--; // undo if we need to delete the typeArray
        }
        UA_NodeStore_release((const UA_Node*)node);
    } while(++index <= lastIndex && retval == UA_STATUSCODE_GOOD);

    if(retval) {
        UA_Array_delete(typeArray, &UA_TYPES[UA_TYPES_NODEID], lastIndex);
        return retval;
    }

    *referenceTypes = typeArray;
    *referenceTypesSize = lastIndex + 1;
    return UA_STATUSCODE_GOOD;
}

/* Results for a single browsedescription. */
static void getBrowseResult(UA_NodeStore *ns, const UA_BrowseDescription *browseDescription,
                            UA_UInt32 maxReferences, UA_BrowseResult *browseResult) {
    size_t relevantReferenceTypesSize = 0;
    UA_NodeId *relevantReferenceTypes = UA_NULL;

    // if the referencetype is null, all referencetypes are returned
    UA_Boolean returnAll = UA_NodeId_isNull(&browseDescription->referenceTypeId);
    if(!returnAll) {
        if(browseDescription->includeSubtypes) {
            browseResult->statusCode =
                findReferenceTypeSubTypes(ns, &browseDescription->referenceTypeId, &relevantReferenceTypes,
                                          &relevantReferenceTypesSize);
            if(browseResult->statusCode != UA_STATUSCODE_GOOD)
                return;
        } else {
            relevantReferenceTypes = UA_NodeId_new();
            UA_NodeId_copy(&browseDescription->referenceTypeId, relevantReferenceTypes);
            relevantReferenceTypesSize = 1;
        }
    }

    const UA_Node *parentNode = UA_NodeStore_get(ns, &browseDescription->nodeId);
    if(!parentNode) {
        browseResult->statusCode = UA_STATUSCODE_BADNODEIDUNKNOWN;
        if(!returnAll)
            UA_Array_delete(relevantReferenceTypes, &UA_TYPES[UA_TYPES_NODEID], relevantReferenceTypesSize);
        return;
    }

    if(parentNode->referencesSize <= 0) {
        UA_NodeStore_release(parentNode);
        browseResult->referencesSize = 0;
        if(!returnAll)
            UA_Array_delete(relevantReferenceTypes, &UA_TYPES[UA_TYPES_NODEID], relevantReferenceTypesSize);
        return;
    }
    maxReferences = parentNode->referencesSize; // 0 => unlimited references

    /* We allocate an array that is probably too big. But since most systems
       have more than enough memory, this has zero impact on speed and
       performance. Call Array_delete with the actual content size! */
    browseResult->references = UA_malloc(sizeof(UA_ReferenceDescription) * maxReferences);
    if(!browseResult->references) {
        browseResult->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
    } else {
        size_t currentRefs = 0;
        for(UA_Int32 i = 0;i < parentNode->referencesSize && currentRefs < maxReferences;i++) {
            // 1) Is the node relevant? If yes, the node is retrieved from the nodestore.
            const UA_Node *currentNode =
                getRelevantTargetNode(ns, browseDescription, returnAll, &parentNode->references[i],
                                      relevantReferenceTypes, relevantReferenceTypesSize);
            if(!currentNode)
                continue;

            // 2) Fill the reference description. This also releases the current node.
            if(fillReferenceDescription(ns, currentNode, &parentNode->references[i],
                                        browseDescription->resultMask,
                                        &browseResult->references[currentRefs]) != UA_STATUSCODE_GOOD) {
                UA_Array_delete(browseResult->references, &UA_TYPES[UA_TYPES_REFERENCEDESCRIPTION], currentRefs);
                currentRefs = 0;
                browseResult->references = UA_NULL;
                browseResult->statusCode = UA_STATUSCODE_UNCERTAINNOTALLNODESAVAILABLE;
                break;
            }
            currentRefs++;
        }
        if(currentRefs != 0)
            browseResult->referencesSize = currentRefs;
        else {
            UA_free(browseResult->references);
            browseResult->references = UA_NULL;
        }
    }

    UA_NodeStore_release(parentNode);
    if(!returnAll)
        UA_Array_delete(relevantReferenceTypes, &UA_TYPES[UA_TYPES_NODEID], relevantReferenceTypesSize);
}

void Service_Browse(UA_Server *server, UA_Session *session, const UA_BrowseRequest *request,
                    UA_BrowseResponse *response) {
   if(request->nodesToBrowseSize <= 0) {
        response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
        return;
    }
   size_t size = request->nodesToBrowseSize;

   response->results = UA_Array_new(&UA_TYPES[UA_TYPES_BROWSERESULT], size);
    if(!response->results) {
        response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
        return;
    }

    /* ### Begin External Namespaces */
    UA_Boolean *isExternal = UA_alloca(sizeof(UA_Boolean) * size);
    UA_memset(isExternal, UA_FALSE, sizeof(UA_Boolean) * size);
    UA_UInt32 *indices = UA_alloca(sizeof(UA_UInt32) * size);
    for(UA_Int32 j = 0;j<server->externalNamespacesSize;j++) {
        size_t indexSize = 0;
        for(size_t i = 0;i < size;i++) {
            if(request->nodesToBrowse[i].nodeId.namespaceIndex != server->externalNamespaces[j].index)
                continue;
            isExternal[i] = UA_TRUE;
            indices[indexSize] = i;
            indexSize++;
        }
        if(indexSize == 0)
            continue;

        UA_ExternalNodeStore *ens = &server->externalNamespaces[j].externalNodeStore;
        ens->browseNodes(ens->ensHandle, &request->requestHeader, request->nodesToBrowse, indices, indexSize,
                         request->requestedMaxReferencesPerNode, response->results, response->diagnosticInfos);
    }
    /* ### End External Namespaces */

    response->resultsSize = size;
    for(size_t i = 0;i < size;i++){
        if(!isExternal[i])
            getBrowseResult(server->nodestore, &request->nodesToBrowse[i],
                        request->requestedMaxReferencesPerNode, &response->results[i]);
    }
}

static UA_StatusCode walkBrowsePath(UA_Server *server, UA_Session *session, const UA_Node *current,
                                    const UA_RelativePath *path, size_t pathindex,
                                    UA_BrowsePathTarget *targets, size_t *targetsSize,
                                    UA_Int32 *currentTargets) {

    const UA_RelativePathElement *elem = &path->elements[pathindex];
    if(elem->targetName.name.length == -1)
        return UA_STATUSCODE_BADBROWSENAMEINVALID;
    UA_StatusCode retval = UA_STATUSCODE_GOOD;
    UA_NodeId *referenceTypes;
    size_t referenceTypesSize;
    UA_Boolean allReferences = UA_FALSE;
    if(UA_NodeId_isNull(&elem->referenceTypeId)) {
        allReferences = UA_TRUE;
        referenceTypesSize = 1; // so we enter the inner loop once
    } else if(elem->includeSubtypes) {
        retval = findReferenceTypeSubTypes(server->nodestore, &elem->referenceTypeId, &referenceTypes,
                                           &referenceTypesSize);
        if(retval != UA_STATUSCODE_GOOD)
            return UA_STATUSCODE_BADNOMATCH;
    } else {
        uintptr_t ptr = (uintptr_t)&elem->referenceTypeId; // ptr magic due to const cast
        referenceTypes = (UA_NodeId*)ptr;
        referenceTypesSize = 1;
    }

    for(UA_Int32 i=0;i<current->referencesSize && retval == UA_STATUSCODE_GOOD;i++) {
        for(size_t j=0;j<referenceTypesSize && retval == UA_STATUSCODE_GOOD;j++) {
            if(!allReferences && (!UA_NodeId_equal(&current->references[i].referenceTypeId, &referenceTypes[j])
                                   || current->references[i].isInverse != elem->isInverse))
                continue;
            // todo: expandednodeid
            const UA_Node *next = UA_NodeStore_get(server->nodestore, &current->references[i].targetId.nodeId);
            if(!next)
                continue;
            if(elem->targetName.namespaceIndex == next->browseName.namespaceIndex &&
               UA_String_equal(&elem->targetName.name, &next->browseName.name)) {
                if((UA_Int32)pathindex + 1 >= path->elementsSize) {
                    // at the end of the path.. add the node
                    if(*currentTargets >= (UA_Int32)*targetsSize) {
                        UA_BrowsePathTarget *newtargets = UA_realloc(targets, sizeof(UA_BrowsePathTarget) *
                                                                     (*targetsSize) * 2);
                        if(!newtargets) {
                            retval = UA_STATUSCODE_BADOUTOFMEMORY;
                        } else {
                            targets = newtargets;
                            *targetsSize *= 2;
                        }
                    }
                    if(retval == UA_STATUSCODE_GOOD) {
                        UA_ExpandedNodeId_init(&targets[*currentTargets].targetId);
                        UA_NodeId_copy(&next->nodeId, &targets[*currentTargets].targetId.nodeId);
                        targets[*currentTargets].remainingPathIndex = UA_UINT32_MAX;
                        *currentTargets += 1;
                        UA_NodeStore_release(next);
                        break; // go to the next node
                    }
                } else {
                    // recurse deeper into the path
                    retval = walkBrowsePath(server, session, next, path, pathindex + 1,
                                            targets, targetsSize, currentTargets);
                }
            }
            UA_NodeStore_release(next);
        }
    }

    if(!allReferences && elem->includeSubtypes)
        UA_Array_delete(referenceTypes, &UA_TYPES[UA_TYPES_NODEID], (UA_Int32)referenceTypesSize);
    return retval;
}

static void translateBrowsePath(UA_Server *server, UA_Session *session, const UA_BrowsePath *path,
                                UA_BrowsePathResult *result) {
    size_t arraySize = 10;
    result->targets = UA_malloc(sizeof(UA_BrowsePathTarget) * arraySize);
    if(!result->targets) {
        result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
        return;
    }
    result->targetsSize = 0;
    const UA_Node *firstNode = UA_NodeStore_get(server->nodestore, &path->startingNode);
    if(!firstNode) {
        result->statusCode = UA_STATUSCODE_BADNODEIDUNKNOWN;
        UA_free(result->targets);
        return;
    }
    if(path->relativePath.elementsSize > 0)
        result->statusCode = walkBrowsePath(server, session, firstNode, &path->relativePath, 0,
                                            result->targets, &arraySize, &result->targetsSize);
    else
        result->statusCode = UA_STATUSCODE_BADNOTHINGTODO;
    UA_NodeStore_release(firstNode);
    if(result->statusCode != UA_STATUSCODE_GOOD) {
        UA_Array_delete(result->targets, &UA_TYPES[UA_TYPES_BROWSEPATHTARGET], result->targetsSize);
        result->targets = UA_NULL;
        result->targetsSize = -1;
    } else if(result->targetsSize == 0) {
        result->statusCode = UA_STATUSCODE_BADNOMATCH;
        UA_free(result->targets);
        result->targets = UA_NULL;
        result->targetsSize = -1;
    }
}

void Service_TranslateBrowsePathsToNodeIds(UA_Server *server, UA_Session *session,
                                           const UA_TranslateBrowsePathsToNodeIdsRequest *request,
                                           UA_TranslateBrowsePathsToNodeIdsResponse *response) {
    if(request->browsePathsSize <= 0) {
        response->responseHeader.serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
        return;
    }

    response->results = UA_Array_new(&UA_TYPES[UA_TYPES_BROWSEPATHRESULT], request->browsePathsSize);
    if(!response->results) {
        response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
        return;
    }

    response->resultsSize = request->browsePathsSize;
    for(UA_Int32 i = 0;i < response->resultsSize;i++)
        translateBrowsePath(server, session, &request->browsePaths[i], &response->results[i]);
}