123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747 |
- /* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
- #include "ua_server_internal.h"
- #include "ua_services.h"
- #include "ua_mdns_internal.h"
- #ifdef _MSC_VER
- # ifndef UNDER_CE
- # include <io.h> //access
- # define access _access
- # endif
- #else
- # include <unistd.h> //access
- #endif
- #ifdef UA_ENABLE_DISCOVERY
- static UA_StatusCode
- setApplicationDescriptionFromRegisteredServer(const UA_FindServersRequest *request,
- UA_ApplicationDescription *target,
- const UA_RegisteredServer *registeredServer) {
- UA_StatusCode retval = UA_STATUSCODE_GOOD;
- UA_ApplicationDescription_init(target);
- retval |= UA_String_copy(®isteredServer->serverUri, &target->applicationUri);
- retval |= UA_String_copy(®isteredServer->productUri, &target->productUri);
- // if the client requests a specific locale, select the corresponding server name
- if (request->localeIdsSize) {
- UA_Boolean appNameFound = UA_FALSE;
- for (size_t i =0; i<request->localeIdsSize && !appNameFound; i++) {
- for (size_t j =0; j<registeredServer->serverNamesSize; j++) {
- if (UA_String_equal(&request->localeIds[i], ®isteredServer->serverNames[j].locale)) {
- retval |= UA_LocalizedText_copy(®isteredServer->serverNames[j],
- &target->applicationName);
- appNameFound = UA_TRUE;
- break;
- }
- }
- }
- // server does not have the requested local, therefore we can select the
- // most suitable one
- if(!appNameFound && registeredServer->serverNamesSize)
- retval |= UA_LocalizedText_copy(®isteredServer->serverNames[0],
- &target->applicationName);
- } else if (registeredServer->serverNamesSize) {
- // just take the first name
- retval |= UA_LocalizedText_copy(®isteredServer->serverNames[0], &target->applicationName);
- }
- target->applicationType = registeredServer->serverType;
- retval |= UA_String_copy(®isteredServer->gatewayServerUri, &target->gatewayServerUri);
- // TODO where do we get the discoveryProfileUri for application data?
- target->discoveryUrlsSize = registeredServer->discoveryUrlsSize;
- if(registeredServer->discoveryUrlsSize) {
- size_t duSize = sizeof(UA_String) * registeredServer->discoveryUrlsSize;
- target->discoveryUrls = (UA_String *)UA_malloc(duSize);
- if(!target->discoveryUrls)
- return UA_STATUSCODE_BADOUTOFMEMORY;
- for(size_t i = 0; i<registeredServer->discoveryUrlsSize; i++)
- retval |= UA_String_copy(®isteredServer->discoveryUrls[i], &target->discoveryUrls[i]);
- }
- return retval;
- }
- #endif
- static UA_StatusCode
- setApplicationDescriptionFromServer(UA_ApplicationDescription *target, const UA_Server *server) {
- /* Copy ApplicationDescription from the config */
- UA_StatusCode result = UA_ApplicationDescription_copy(&server->config.applicationDescription,
- target);
- if(result != UA_STATUSCODE_GOOD) {
- return result;
- }
- // UaExpert does not list DiscoveryServer, thus set it to Server
- // See http://forum.unified-automation.com/topic1987.html
- if (target->applicationType == UA_APPLICATIONTYPE_DISCOVERYSERVER)
- target->applicationType = UA_APPLICATIONTYPE_SERVER;
- /* add the discoveryUrls from the networklayers */
- size_t discSize = sizeof(UA_String) * (target->discoveryUrlsSize + server->config.networkLayersSize);
- UA_String* disc = (UA_String *)UA_realloc(target->discoveryUrls, discSize);
- if(!disc) {
- return UA_STATUSCODE_BADOUTOFMEMORY;
- }
- size_t existing = target->discoveryUrlsSize;
- target->discoveryUrls = disc;
- target->discoveryUrlsSize += server->config.networkLayersSize;
- // TODO: Add nl only if discoveryUrl not already present
- for (size_t i = 0; i < server->config.networkLayersSize; i++) {
- UA_ServerNetworkLayer* nl = &server->config.networkLayers[i];
- UA_String_copy(&nl->discoveryUrl, &target->discoveryUrls[existing + i]);
- }
- return UA_STATUSCODE_GOOD;
- }
- void Service_FindServers(UA_Server *server, UA_Session *session,
- const UA_FindServersRequest *request,
- UA_FindServersResponse *response) {
- UA_LOG_DEBUG_SESSION(server->config.logger, session,
- "Processing FindServersRequest");
- size_t foundServersSize = 0;
- UA_ApplicationDescription *foundServers = NULL;
- UA_Boolean addSelf = UA_FALSE;
- // temporarily store all the pointers which we found to avoid reiterating
- // through the list
- UA_RegisteredServer **foundServerFilteredPointer = NULL;
- #ifdef UA_ENABLE_DISCOVERY
- // check if client only requested a specific set of servers
- if (request->serverUrisSize) {
- size_t fsfpSize = sizeof(UA_RegisteredServer*) * server->registeredServersSize;
- foundServerFilteredPointer = (UA_RegisteredServer **)UA_malloc(fsfpSize);
- if(!foundServerFilteredPointer) {
- response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
- return;
- }
- for(size_t i = 0; i < request->serverUrisSize; i++) {
- if(!addSelf && UA_String_equal(&request->serverUris[i],
- &server->config.applicationDescription.applicationUri)) {
- addSelf = UA_TRUE;
- } else {
- registeredServer_list_entry* current;
- LIST_FOREACH(current, &server->registeredServers, pointers) {
- if(UA_String_equal(¤t->registeredServer.serverUri, &request->serverUris[i])) {
- // check if entry already in list:
- UA_Boolean existing = false;
- for (size_t j=0; j<foundServersSize; j++) {
- if (UA_String_equal(&foundServerFilteredPointer[j]->serverUri, &request->serverUris[i])) {
- existing = true;
- break;
- }
- }
- if (!existing)
- foundServerFilteredPointer[foundServersSize++] = ¤t->registeredServer;
- break;
- }
- }
- }
- }
- if(addSelf)
- foundServersSize++;
- } else {
- addSelf = true;
- // self + registered servers
- foundServersSize = 1 + server->registeredServersSize;
- }
- #else
- if(request->serverUrisSize) {
- for(size_t i = 0; i < request->serverUrisSize; i++) {
- if(UA_String_equal(&request->serverUris[i],
- &server->config.applicationDescription.applicationUri)) {
- addSelf = UA_TRUE;
- foundServersSize = 1;
- break;
- }
- }
- } else {
- addSelf = UA_TRUE;
- foundServersSize = 1;
- }
- #endif
- if(foundServersSize) {
- size_t fsSize = sizeof(UA_ApplicationDescription) * foundServersSize;
- foundServers = (UA_ApplicationDescription *)UA_malloc(fsSize);
- if(!foundServers) {
- if(foundServerFilteredPointer)
- UA_free(foundServerFilteredPointer);
- response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
- return;
- }
- if(addSelf) {
- response->responseHeader.serviceResult =
- setApplicationDescriptionFromServer(&foundServers[0], server);
- if(response->responseHeader.serviceResult != UA_STATUSCODE_GOOD) {
- UA_free(foundServers);
- if (foundServerFilteredPointer)
- UA_free(foundServerFilteredPointer);
- return;
- }
- }
- #ifdef UA_ENABLE_DISCOVERY
- size_t currentIndex = 0;
- if (addSelf)
- currentIndex++;
- // add all the registered servers to the list
- if (foundServerFilteredPointer) {
- // use filtered list because client only requested specific uris
- // -1 because foundServersSize also includes this self server
- size_t iterCount = addSelf ? foundServersSize - 1 : foundServersSize;
- for (size_t i = 0; i < iterCount; i++) {
- response->responseHeader.serviceResult =
- setApplicationDescriptionFromRegisteredServer(request, &foundServers[currentIndex++],
- foundServerFilteredPointer[i]);
- if (response->responseHeader.serviceResult != UA_STATUSCODE_GOOD) {
- UA_free(foundServers);
- UA_free(foundServerFilteredPointer);
- return;
- }
- }
- UA_free(foundServerFilteredPointer);
- foundServerFilteredPointer = NULL;
- } else {
- registeredServer_list_entry* current;
- LIST_FOREACH(current, &server->registeredServers, pointers) {
- response->responseHeader.serviceResult =
- setApplicationDescriptionFromRegisteredServer(request, &foundServers[currentIndex++],
- ¤t->registeredServer);
- if (response->responseHeader.serviceResult != UA_STATUSCODE_GOOD) {
- UA_free(foundServers);
- return;
- }
- }
- }
- #endif
- }
- if (foundServerFilteredPointer)
- UA_free(foundServerFilteredPointer);
- response->servers = foundServers;
- response->serversSize = foundServersSize;
- }
- void Service_GetEndpoints(UA_Server *server, UA_Session *session,
- const UA_GetEndpointsRequest *request,
- UA_GetEndpointsResponse *response) {
- /* If the client expects to see a specific endpointurl, mirror it back. If
- not, clone the endpoints with the discovery url of all networklayers. */
- const UA_String *endpointUrl = &request->endpointUrl;
- if(endpointUrl->length > 0) {
- UA_LOG_DEBUG_SESSION(server->config.logger, session,
- "Processing GetEndpointsRequest with endpointUrl "
- UA_PRINTF_STRING_FORMAT, UA_PRINTF_STRING_DATA(*endpointUrl));
- } else {
- UA_LOG_DEBUG_SESSION(server->config.logger, session,
- "Processing GetEndpointsRequest with an empty endpointUrl");
- }
- /* test if the supported binary profile shall be returned */
- size_t reSize = sizeof(UA_Boolean) * server->config.endpointsSize;
- UA_Boolean *relevant_endpoints = (UA_Boolean *)UA_alloca(reSize);
- memset(relevant_endpoints, 0, sizeof(UA_Boolean) * server->config.endpointsSize);
- size_t relevant_count = 0;
- if(request->profileUrisSize == 0) {
- for(size_t j = 0; j < server->config.endpointsSize; ++j)
- relevant_endpoints[j] = true;
- relevant_count = server->config.endpointsSize;
- } else {
- for(size_t j = 0; j < server->config.endpointsSize; ++j) {
- for(size_t i = 0; i < request->profileUrisSize; ++i) {
- if(!UA_String_equal(&request->profileUris[i],
- &server->config.endpoints[j].endpointDescription.transportProfileUri))
- continue;
- relevant_endpoints[j] = true;
- ++relevant_count;
- break;
- }
- }
- }
- if(relevant_count == 0) {
- response->endpointsSize = 0;
- return;
- }
- /* Clone the endpoint for each networklayer? */
- size_t clone_times = 1;
- UA_Boolean nl_endpointurl = false;
- if(endpointUrl->length == 0) {
- clone_times = server->config.networkLayersSize;
- nl_endpointurl = true;
- }
- response->endpoints =
- (UA_EndpointDescription*)UA_Array_new(relevant_count * clone_times,
- &UA_TYPES[UA_TYPES_ENDPOINTDESCRIPTION]);
- if(!response->endpoints) {
- response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
- return;
- }
- response->endpointsSize = relevant_count * clone_times;
- size_t k = 0;
- UA_StatusCode retval = UA_STATUSCODE_GOOD;
- for(size_t i = 0; i < clone_times; ++i) {
- if(nl_endpointurl)
- endpointUrl = &server->config.networkLayers[i].discoveryUrl;
- for(size_t j = 0; j < server->config.endpointsSize; ++j) {
- if(!relevant_endpoints[j])
- continue;
- retval |= UA_EndpointDescription_copy(&server->config.endpoints[j].endpointDescription,
- &response->endpoints[k]);
- retval |= UA_String_copy(endpointUrl, &response->endpoints[k].endpointUrl);
- ++k;
- }
- }
- if(retval != UA_STATUSCODE_GOOD) {
- response->responseHeader.serviceResult = retval;
- UA_Array_delete(response->endpoints, response->endpointsSize,
- &UA_TYPES[UA_TYPES_ENDPOINTDESCRIPTION]);
- response->endpoints = NULL;
- response->endpointsSize = 0;
- return;
- }
- }
- #ifdef UA_ENABLE_DISCOVERY
- #ifdef UA_ENABLE_MULTITHREADING
- static void
- freeEntry(UA_Server *server, void *entry) {
- UA_free(entry);
- }
- #endif
- static void
- process_RegisterServer(UA_Server *server, UA_Session *session,
- const UA_RequestHeader* requestHeader,
- const UA_RegisteredServer *requestServer,
- const size_t requestDiscoveryConfigurationSize,
- const UA_ExtensionObject *requestDiscoveryConfiguration,
- UA_ResponseHeader* responseHeader,
- size_t *responseConfigurationResultsSize,
- UA_StatusCode **responseConfigurationResults,
- size_t *responseDiagnosticInfosSize,
- UA_DiagnosticInfo *responseDiagnosticInfos) {
- /* Find the server from the request in the registered list */
- registeredServer_list_entry* current;
- registeredServer_list_entry *registeredServer_entry = NULL;
- LIST_FOREACH(current, &server->registeredServers, pointers) {
- if (UA_String_equal(¤t->registeredServer.serverUri, &requestServer->serverUri)) {
- registeredServer_entry = current;
- break;
- }
- }
- UA_MdnsDiscoveryConfiguration *mdnsConfig = NULL;
- const UA_String* mdnsServerName = NULL;
- if(requestDiscoveryConfigurationSize) {
- *responseConfigurationResults =
- (UA_StatusCode *)UA_Array_new(requestDiscoveryConfigurationSize,
- &UA_TYPES[UA_TYPES_STATUSCODE]);
- if(!(*responseConfigurationResults)) {
- responseHeader->serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
- return;
- }
- *responseConfigurationResultsSize = requestDiscoveryConfigurationSize;
- for(size_t i = 0; i < requestDiscoveryConfigurationSize; i++) {
- const UA_ExtensionObject *object = &requestDiscoveryConfiguration[i];
- if(!mdnsConfig && (object->encoding == UA_EXTENSIONOBJECT_DECODED ||
- object->encoding == UA_EXTENSIONOBJECT_DECODED_NODELETE) &&
- (object->content.decoded.type == &UA_TYPES[UA_TYPES_MDNSDISCOVERYCONFIGURATION])) {
- mdnsConfig = (UA_MdnsDiscoveryConfiguration *)object->content.decoded.data;
- mdnsServerName = &mdnsConfig->mdnsServerName;
- (*responseConfigurationResults)[i] = UA_STATUSCODE_GOOD;
- } else {
- (*responseConfigurationResults)[i] = UA_STATUSCODE_BADNOTSUPPORTED;
- }
- }
- }
- if(!mdnsServerName && requestServer->serverNamesSize)
- mdnsServerName = &requestServer->serverNames[0].text;
- if(!mdnsServerName) {
- responseHeader->serviceResult = UA_STATUSCODE_BADSERVERNAMEMISSING;
- return;
- }
- if(requestServer->discoveryUrlsSize == 0) {
- responseHeader->serviceResult = UA_STATUSCODE_BADDISCOVERYURLMISSING;
- return;
- }
- if(requestServer->semaphoreFilePath.length) {
- #ifdef UA_ENABLE_DISCOVERY_SEMAPHORE
- char* filePath = (char*)
- UA_malloc(sizeof(char)*requestServer->semaphoreFilePath.length+1);
- if (!filePath) {
- UA_LOG_ERROR_SESSION(server->config.logger, session,
- "Cannot allocate memory for semaphore path. Out of memory.");
- responseHeader->serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
- return;
- }
- memcpy(filePath, requestServer->semaphoreFilePath.data, requestServer->semaphoreFilePath.length );
- filePath[requestServer->semaphoreFilePath.length] = '\0';
- if(access( filePath, 0 ) == -1) {
- responseHeader->serviceResult = UA_STATUSCODE_BADSEMPAHOREFILEMISSING;
- UA_free(filePath);
- return;
- }
- UA_free(filePath);
- #else
- UA_LOG_WARNING(server->config.logger, UA_LOGCATEGORY_CLIENT,
- "Ignoring semaphore file path. open62541 not compiled "
- "with UA_ENABLE_DISCOVERY_SEMAPHORE=ON");
- #endif
- }
- #ifdef UA_ENABLE_DISCOVERY_MULTICAST
- if(server->config.applicationDescription.applicationType == UA_APPLICATIONTYPE_DISCOVERYSERVER) {
- for(size_t i = 0; i < requestServer->discoveryUrlsSize; i++) {
- /* create TXT if is online and first index, delete TXT if is offline and last index */
- UA_Boolean updateTxt = (requestServer->isOnline && i==0) ||
- (!requestServer->isOnline && i==requestServer->discoveryUrlsSize);
- UA_Discovery_update_MdnsForDiscoveryUrl(server, mdnsServerName, mdnsConfig,
- &requestServer->discoveryUrls[i],
- requestServer->isOnline, updateTxt);
- }
- }
- #endif
- if(!requestServer->isOnline) {
- // server is shutting down. Remove it from the registered servers list
- if(!registeredServer_entry) {
- // server not found, show warning
- UA_LOG_WARNING_SESSION(server->config.logger, session,
- "Could not unregister server %.*s. Not registered.",
- (int)requestServer->serverUri.length, requestServer->serverUri.data);
- responseHeader->serviceResult = UA_STATUSCODE_BADNOTHINGTODO;
- return;
- }
- if(server->registerServerCallback)
- server->registerServerCallback(requestServer, server->registerServerCallbackData);
- // server found, remove from list
- LIST_REMOVE(registeredServer_entry, pointers);
- UA_RegisteredServer_deleteMembers(®isteredServer_entry->registeredServer);
- #ifndef UA_ENABLE_MULTITHREADING
- UA_free(registeredServer_entry);
- server->registeredServersSize--;
- #else
- server->registeredServersSize = uatomic_add_return(&server->registeredServersSize, -1);
- UA_Server_delayedCallback(server, freeEntry, registeredServer_entry);
- #endif
- responseHeader->serviceResult = UA_STATUSCODE_GOOD;
- return;
- }
- UA_StatusCode retval = UA_STATUSCODE_GOOD;
- if (!registeredServer_entry) {
- // server not yet registered, register it by adding it to the list
- UA_LOG_DEBUG_SESSION(server->config.logger, session, "Registering new server: %.*s",
- (int)requestServer->serverUri.length, requestServer->serverUri.data);
- registeredServer_entry =
- (registeredServer_list_entry *)UA_malloc(sizeof(registeredServer_list_entry));
- if(!registeredServer_entry) {
- responseHeader->serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
- return;
- }
- LIST_INSERT_HEAD(&server->registeredServers, registeredServer_entry, pointers);
- #ifndef UA_ENABLE_MULTITHREADING
- server->registeredServersSize++;
- #else
- server->registeredServersSize = uatomic_add_return(&server->registeredServersSize, 1);
- #endif
- if(server->registerServerCallback)
- server->registerServerCallback(requestServer, server->registerServerCallbackData);
- } else {
- UA_RegisteredServer_deleteMembers(®isteredServer_entry->registeredServer);
- }
- // copy the data from the request into the list
- UA_RegisteredServer_copy(requestServer, ®isteredServer_entry->registeredServer);
- registeredServer_entry->lastSeen = UA_DateTime_nowMonotonic();
- responseHeader->serviceResult = retval;
- }
- void Service_RegisterServer(UA_Server *server, UA_Session *session,
- const UA_RegisterServerRequest *request,
- UA_RegisterServerResponse *response) {
- UA_LOG_DEBUG_SESSION(server->config.logger, session,
- "Processing RegisterServerRequest");
- process_RegisterServer(server, session, &request->requestHeader, &request->server, 0,
- NULL, &response->responseHeader, 0, NULL, 0, NULL);
- }
- void Service_RegisterServer2(UA_Server *server, UA_Session *session,
- const UA_RegisterServer2Request *request,
- UA_RegisterServer2Response *response) {
- UA_LOG_DEBUG_SESSION(server->config.logger, session,
- "Processing RegisterServer2Request");
- process_RegisterServer(server, session, &request->requestHeader, &request->server,
- request->discoveryConfigurationSize, request->discoveryConfiguration,
- &response->responseHeader, &response->configurationResultsSize,
- &response->configurationResults, &response->diagnosticInfosSize,
- response->diagnosticInfos);
- }
- /* Cleanup server registration: If the semaphore file path is set, then it just
- * checks the existence of the file. When it is deleted, the registration is
- * removed. If there is no semaphore file, then the registration will be removed
- * if it is older than 60 minutes. */
- void UA_Discovery_cleanupTimedOut(UA_Server *server, UA_DateTime nowMonotonic) {
- UA_DateTime timedOut = nowMonotonic;
- // registration is timed out if lastSeen is older than 60 minutes (default
- // value, can be modified by user).
- if(server->config.discoveryCleanupTimeout)
- timedOut -= server->config.discoveryCleanupTimeout*UA_SEC_TO_DATETIME;
- registeredServer_list_entry* current, *temp;
- LIST_FOREACH_SAFE(current, &server->registeredServers, pointers, temp) {
- UA_Boolean semaphoreDeleted = UA_FALSE;
- #ifdef UA_ENABLE_DISCOVERY_SEMAPHORE
- if(current->registeredServer.semaphoreFilePath.length) {
- size_t fpSize = sizeof(char)*current->registeredServer.semaphoreFilePath.length+1;
- // todo: malloc may fail: return a statuscode
- char* filePath = (char *)UA_malloc(fpSize);
- if (filePath) {
- memcpy(filePath, current->registeredServer.semaphoreFilePath.data,
- current->registeredServer.semaphoreFilePath.length );
- filePath[current->registeredServer.semaphoreFilePath.length] = '\0';
- #ifdef UNDER_CE
- FILE *fp = fopen(filePath,"rb");
- semaphoreDeleted = (fp==NULL);
- if(fp)
- fclose(fp);
- #else
- semaphoreDeleted = access( filePath, 0 ) == -1;
- #endif
- UA_free(filePath);
- } else {
- UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER, "Cannot check registration semaphore. Out of memory");
- }
- }
- #endif
- if(semaphoreDeleted || (server->config.discoveryCleanupTimeout &&
- current->lastSeen < timedOut)) {
- if(semaphoreDeleted) {
- UA_LOG_INFO(server->config.logger, UA_LOGCATEGORY_SERVER,
- "Registration of server with URI %.*s is removed because "
- "the semaphore file '%.*s' was deleted.",
- (int)current->registeredServer.serverUri.length,
- current->registeredServer.serverUri.data,
- (int)current->registeredServer.semaphoreFilePath.length,
- current->registeredServer.semaphoreFilePath.data);
- } else {
- // cppcheck-suppress unreadVariable
- UA_LOG_INFO(server->config.logger, UA_LOGCATEGORY_SERVER,
- "Registration of server with URI %.*s has timed out and is removed.",
- (int)current->registeredServer.serverUri.length,
- current->registeredServer.serverUri.data);
- }
- LIST_REMOVE(current, pointers);
- UA_RegisteredServer_deleteMembers(¤t->registeredServer);
- #ifndef UA_ENABLE_MULTITHREADING
- UA_free(current);
- server->registeredServersSize--;
- #else
- server->registeredServersSize = uatomic_add_return(&server->registeredServersSize, -1);
- UA_Server_delayedCallback(server, freeEntry, current);
- #endif
- }
- }
- }
- struct PeriodicServerRegisterCallback {
- UA_UInt64 id;
- UA_UInt32 this_interval;
- UA_UInt32 default_interval;
- UA_Boolean registered;
- const char* discovery_server_url;
- };
- /* Called by the UA_Server callback. The OPC UA specification says:
- *
- * > If an error occurs during registration (e.g. the Discovery Server is not running) then the Server
- * > must periodically re-attempt registration. The frequency of these attempts should start at 1 second
- * > but gradually increase until the registration frequency is the same as what it would be if not
- * > errors occurred. The recommended approach would double the period each attempt until reaching the maximum.
- *
- * We will do so by using the additional data parameter which holds information
- * if the next interval is default or if it is a repeaded call. */
- static void
- periodicServerRegister(UA_Server *server, void *data) {
- UA_assert(data != NULL);
- struct PeriodicServerRegisterCallback *cb = (struct PeriodicServerRegisterCallback *)data;
- /* Which URL to register on */
- // fixme: remove magic url
- const char * server_url;
- if(cb->discovery_server_url != NULL)
- server_url = cb->discovery_server_url;
- else
- server_url = "opc.tcp://localhost:4840";
- /* Register
- You can also use a semaphore file. That file must exist. When the file is
- deleted, the server is automatically unregistered. The semaphore file has
- to be accessible by the discovery server
-
- UA_StatusCode retval = UA_Server_register_discovery(server,
- "opc.tcp://localhost:4840", "/path/to/some/file");
- */
- UA_StatusCode retval = UA_Server_register_discovery(server, server_url, NULL);
- /* Registering failed */
- if(retval != UA_STATUSCODE_GOOD) {
- UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER,
- "Could not register server with discovery server. "
- "Is the discovery server started? StatusCode %s",
- UA_StatusCode_name(retval));
- /* If the server was previously registered, retry in one second,
- * else, double the previous interval */
- UA_UInt32 nextInterval = 1000;
- if(!cb->registered)
- nextInterval = cb->this_interval * 2;
- /* The interval should be smaller than the default interval */
- if(nextInterval > cb->default_interval)
- nextInterval = cb->default_interval;
- cb->this_interval = nextInterval;
- UA_Server_changeRepeatedCallbackInterval(server, cb->id, nextInterval);
- return;
- }
- /* Registering succeeded */
- UA_LOG_DEBUG(server->config.logger, UA_LOGCATEGORY_SERVER,
- "Server successfully registered. Next periodical register will be in %d seconds",
- (int)(cb->default_interval/1000));
- if(!cb->registered) {
- retval = UA_Server_changeRepeatedCallbackInterval(server, cb->id, cb->default_interval);
- /* If changing the interval fails, try again after the next registering */
- if(retval == UA_STATUSCODE_GOOD)
- cb->registered = true;
- }
- }
- UA_StatusCode
- UA_Server_addPeriodicServerRegisterCallback(UA_Server *server,
- const char* discoveryServerUrl,
- UA_UInt32 intervalMs,
- UA_UInt32 delayFirstRegisterMs,
- UA_UInt64 *periodicCallbackId) {
- /* No valid server URL */
- if(!discoveryServerUrl) {
- UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER,
- "No discovery server URL provided");
- return UA_STATUSCODE_BADINTERNALERROR;
- }
- /* check if we are already registering with the given discovery url and remove the old periodic call */
- {
- periodicServerRegisterCallback_entry *rs, *rs_tmp;
- LIST_FOREACH_SAFE(rs, &server->periodicServerRegisterCallbacks, pointers, rs_tmp) {
- if (strcmp(rs->callback->discovery_server_url, discoveryServerUrl) == 0) {
- UA_LOG_INFO(server->config.logger, UA_LOGCATEGORY_SERVER,
- "There is already a register callback for '%s' in place. Removing the older one.", discoveryServerUrl);
- UA_Server_removeRepeatedCallback(server, rs->callback->id);
- LIST_REMOVE(rs, pointers);
- UA_free(rs->callback);
- UA_free(rs);
- break;
- }
- }
- }
- /* Allocate and initialize */
- struct PeriodicServerRegisterCallback* cb =
- (struct PeriodicServerRegisterCallback*)
- UA_malloc(sizeof(struct PeriodicServerRegisterCallback));
- if(!cb)
- return UA_STATUSCODE_BADOUTOFMEMORY;
- /* Start repeating a failed register after 1s, then increase the delay. Set
- * to 500ms, as the delay is doubled before changing the callback
- * interval.*/
- cb->this_interval = 500;
- cb->default_interval = intervalMs;
- cb->registered = false;
- cb->discovery_server_url = discoveryServerUrl;
- /* Add the callback */
- UA_StatusCode retval =
- UA_Server_addRepeatedCallback(server, periodicServerRegister,
- cb, delayFirstRegisterMs, &cb->id);
- if(retval != UA_STATUSCODE_GOOD) {
- UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER,
- "Could not create periodic job for server register. "
- "StatusCode %s", UA_StatusCode_name(retval));
- UA_free(cb);
- return retval;
- }
- #ifndef __clang_analyzer__
- // the analyzer reports on LIST_INSERT_HEAD a use after free false positive
- periodicServerRegisterCallback_entry *newEntry =
- (periodicServerRegisterCallback_entry *)UA_malloc(sizeof(periodicServerRegisterCallback_entry));
- if(!newEntry) {
- UA_Server_removeRepeatedCallback(server, cb->id);
- UA_free(cb);
- return UA_STATUSCODE_BADOUTOFMEMORY;
- }
- newEntry->callback = cb;
- LIST_INSERT_HEAD(&server->periodicServerRegisterCallbacks, newEntry, pointers);
- #endif
- if(periodicCallbackId)
- *periodicCallbackId = cb->id;
- return UA_STATUSCODE_GOOD;
- }
- void
- UA_Server_setRegisterServerCallback(UA_Server *server,
- UA_Server_registerServerCallback cb,
- void* data) {
- server->registerServerCallback = cb;
- server->registerServerCallbackData = data;
- }
- #endif /* UA_ENABLE_DISCOVERY */
|