/* ========================================================================
* Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System;
using System.Collections.Generic;
using System.Security.Cryptography.X509Certificates;
#pragma warning disable 0618
namespace Opc.Ua.Server
{
///
/// A class that stores the globally accessible state of a server instance.
///
///
/// This is a readonly class that is initialized when the server starts up. It provides
/// access to global objects and data that different parts of the server may require.
/// It also defines some global methods.
///
/// This object is constructed is three steps:
/// - the configuration is provided.
/// - the node managers et. al. are provided.
/// - the session/subscription managers are provided.
///
/// The server is not running until all three steps are complete.
///
/// The references returned from this object do not change after all three states are complete.
/// This ensures the object is thread safe even though it does not use a lock.
/// Objects returned from this object can be assumed to be threadsafe unless otherwise stated.
///
public class ServerInternalData : IServerInternal, IDisposable
{
#region Constructors
///
/// Initializes the datastore with the server configuration.
///
/// The server description.
/// The configuration.
/// The message context.
/// The certificate validator.
/// The instance certificate.
public ServerInternalData(
ServerProperties serverDescription,
ApplicationConfiguration configuration,
ServiceMessageContext messageContext,
CertificateValidator certificateValidator,
X509Certificate2 instanceCertificate)
{
m_serverDescription = serverDescription;
m_configuration = configuration;
m_messageContext = messageContext;
m_endpointAddresses = new List();
foreach (string baseAddresses in m_configuration.ServerConfiguration.BaseAddresses)
{
Uri url = Utils.ParseUri(baseAddresses);
if (url != null)
{
m_endpointAddresses.Add(url);
}
}
m_namespaceUris = m_messageContext.NamespaceUris;
m_factory = m_messageContext.Factory;
m_serverUris = new StringTable();
m_typeTree = new TypeTable(m_namespaceUris);
#if LEGACY_CORENODEMANAGER
m_typeSources = new TypeSourceTable();
#endif
// add the server uri to the server table.
m_serverUris.Append(m_configuration.ApplicationUri);
// create the default system context.
m_defaultSystemContext = new ServerSystemContext(this);
}
#endregion
#region IDisposable Members
///
/// Frees any unmanaged resources.
///
public void Dispose()
{
Dispose(true);
}
///
/// An overrideable version of the Dispose.
///
/// true to release both managed and unmanaged resources; false to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
{
if (disposing)
{
Utils.SilentDispose(m_resourceManager);
Utils.SilentDispose(m_requestManager);
Utils.SilentDispose(m_aggregateManager);
Utils.SilentDispose(m_nodeManager);
Utils.SilentDispose(m_sessionManager);
Utils.SilentDispose(m_subscriptionManager);
}
}
#endregion
#region Public Interface
///
/// The session manager to use with the server.
///
/// The session manager.
public SessionManager SessionManager
{
get { return m_sessionManager; }
}
///
/// The subscription manager to use with the server.
///
/// The subscription manager.
public SubscriptionManager SubscriptionManager
{
get { return m_subscriptionManager; }
}
///
/// Stores the MasterNodeManager and the CoreNodeManager
///
/// The node manager.
public void SetNodeManager(MasterNodeManager nodeManager)
{
m_nodeManager = nodeManager;
m_diagnosticsNodeManager = nodeManager.DiagnosticsNodeManager;
m_coreNodeManager = nodeManager.CoreNodeManager;
}
///
/// Sets the EventManager, the ResourceManager, the RequestManager and the AggregateManager.
///
/// The event manager.
/// The resource manager.
/// The request manager.
public void CreateServerObject(
EventManager eventManager,
ResourceManager resourceManager,
RequestManager requestManager)
{
m_eventManager = eventManager;
m_resourceManager = resourceManager;
m_requestManager = requestManager;
// create the server object.
CreateServerObject();
}
///
/// Stores the SessionManager, the SubscriptionManager in the datastore.
///
/// The session manager.
/// The subscription manager.
public void SetSessionManager(
SessionManager sessionManager,
SubscriptionManager subscriptionManager)
{
m_sessionManager = sessionManager;
m_subscriptionManager = subscriptionManager;
}
#endregion
#region IServerInternal Members
///
/// The endpoint addresses used by the server.
///
/// The endpoint addresses.
public IEnumerable EndpointAddresses
{
get { return m_endpointAddresses; }
}
///
/// The context to use when serializing/deserializing extension objects.
///
/// The message context.
public ServiceMessageContext MessageContext
{
get { return m_messageContext; }
}
///
/// The default system context for the server.
///
/// The default system context.
public ServerSystemContext DefaultSystemContext
{
get { return m_defaultSystemContext; }
}
///
/// The table of namespace uris known to the server.
///
/// The namespace URIs.
public NamespaceTable NamespaceUris
{
get { return m_namespaceUris; }
}
///
/// The table of remote server uris known to the server.
///
/// The server URIs.
public StringTable ServerUris
{
get { return m_serverUris; }
}
///
/// The factory used to create encodeable objects that the server understands.
///
/// The factory.
public EncodeableFactory Factory
{
get { return m_factory; }
}
///
/// The datatypes, object types and variable types known to the server.
///
/// The type tree.
///
/// The type tree table is a global object that all components of a server have access to.
/// Node managers must populate this table with all types that they define.
/// This object is thread safe.
///
public TypeTable TypeTree
{
get { return m_typeTree; }
}
#if LEGACY_CORENODEMANAGER
///
/// Returns the source for a types that has shared components defined.
///
/// The type sources.
///
/// Some types define shared components which are used by all instances of the type. This
/// table contains sources for those shared components. The namespace qualified browse name
/// is assumed to be a unique identifier for a type.
///
public TypeSourceTable TypeSources
{
get { return m_typeSources; }
}
#endif
///
/// The master node manager for the server.
///
/// The node manager.
public MasterNodeManager NodeManager
{
get { return m_nodeManager; }
}
///
/// The internal node manager for the servers.
///
/// The core node manager.
public CoreNodeManager CoreNodeManager
{
get { return m_coreNodeManager; }
}
///
/// Returns the node manager that managers the server diagnostics.
///
/// The diagnostics node manager.
public DiagnosticsNodeManager DiagnosticsNodeManager
{
get { return m_diagnosticsNodeManager; }
}
///
/// The manager for events that all components use to queue events that occur.
///
/// The event manager.
public EventManager EventManager
{
get { return m_eventManager; }
}
///
/// A manager for localized resources that components can use to localize text.
///
/// The resource manager.
public ResourceManager ResourceManager
{
get { return m_resourceManager; }
}
///
/// A manager for outstanding requests that allows components to receive notifications if the timeout or are cancelled.
///
/// The request manager.
public RequestManager RequestManager
{
get { return m_requestManager; }
}
///
/// A manager for aggregate calculators supported by the server.
///
/// The aggregate manager.
public AggregateManager AggregateManager
{
get { return m_aggregateManager; }
set { m_aggregateManager = value; }
}
///
/// The manager for active sessions.
///
/// The session manager.
ISessionManager IServerInternal.SessionManager
{
get { return m_sessionManager; }
}
///
/// The manager for active subscriptions.
///
ISubscriptionManager IServerInternal.SubscriptionManager
{
get { return m_subscriptionManager; }
}
///
/// Returns the status object for the server.
///
/// The status.
public ServerStatusValue Status
{
get { return m_serverStatus; }
}
///
/// Gets or sets the current state of the server.
///
/// The state of the current.
public ServerState CurrentState
{
get
{
lock (m_serverStatus.Lock)
{
return m_serverStatus.Value.State;
}
}
set
{
lock (m_serverStatus.Lock)
{
m_serverStatus.Value.State = value;
}
}
}
///
/// Returns the Server object node
///
/// The Server object node.
public ServerObjectState ServerObject
{
get { return m_serverObject; }
}
///
/// Used to synchronize access to the server diagnostics.
///
/// The diagnostics lock.
public object DiagnosticsLock
{
get { return m_dataLock; }
}
///
/// Used to synchronize write access to
/// the server diagnostics.
///
/// The diagnostics lock.
public object DiagnosticsWriteLock
{
get
{
// implicitly force diagnostics update
if (DiagnosticsNodeManager != null)
{
DiagnosticsNodeManager.ForceDiagnosticsScan();
}
return DiagnosticsLock;
}
}
///
/// Returns the diagnostics structure for the server.
///
/// The server diagnostics.
public ServerDiagnosticsSummaryDataType ServerDiagnostics
{
get { return m_serverDiagnostics; }
}
#if LEGACY_CORENODEMANAGER
///
/// Returns the diagnostics object for the server.
///
/// The diagnostics.
public ServerDiagnostics Diagnostics
{
get { return null; }
}
#endif
///
/// Whether the server is currently running.
///
///
/// true if this instance is running; otherwise, false.
///
///
/// This flag is set to false when the server shuts down. Threads running should check this flag whenever
/// they return from a blocking operation. If it is false the thread should clean up and terminate.
///
public bool IsRunning
{
get
{
if (m_serverStatus == null)
{
return false;
}
lock (m_serverStatus.Lock)
{
if (m_serverStatus.Value.State == ServerState.Running)
return true;
if (m_serverStatus.Value.State == ServerState.Shutdown && m_serverStatus.Value.SecondsTillShutdown > 0)
return true;
return false;
}
}
}
///
/// Whether the server is collecting diagnostics.
///
/// true if diagnostics are enabled; otherwise, false.
public bool DiagnosticsEnabled
{
get
{
if (m_diagnosticsNodeManager == null)
{
return false;
}
return m_diagnosticsNodeManager.DiagnosticsEnabled;
}
}
///
/// Closes the specified session.
///
/// The context.
/// The session identifier.
/// if set to true subscriptions are to be deleted.
public void CloseSession(OperationContext context, NodeId sessionId, bool deleteSubscriptions)
{
m_nodeManager.SessionClosing(context, sessionId, deleteSubscriptions);
m_subscriptionManager.SessionClosing(context, sessionId, deleteSubscriptions);
m_sessionManager.CloseSession(sessionId);
}
///
/// Deletes the specified subscription.
///
/// The subscription identifier.
public void DeleteSubscription(uint subscriptionId)
{
m_subscriptionManager.DeleteSubscription(null, subscriptionId);
}
///
/// Called by any component to report a global event.
///
/// The event.
public void ReportEvent(IFilterTarget e)
{
if (m_serverObject != null)
{
m_serverObject.ReportEvent(this.DefaultSystemContext, e);
}
}
///
/// Called by any component to report a global event.
///
/// The context.
/// The event.
public void ReportEvent(ISystemContext context, IFilterTarget e)
{
if (m_serverObject != null)
{
m_serverObject.ReportEvent(context, e);
}
}
///
/// Refreshes the conditions for the specified subscription.
///
/// The context.
/// The subscription identifier.
public void ConditionRefresh(OperationContext context, uint subscriptionId)
{
m_subscriptionManager.ConditionRefresh(context, subscriptionId);
}
#endregion
#region Private Methods
///
/// Creates the ServerObject and attaches it to the NodeManager.
///
private void CreateServerObject()
{
lock (m_diagnosticsNodeManager.Lock)
{
// get the server object.
ServerObjectState serverObject = m_serverObject = (ServerObjectState)m_diagnosticsNodeManager.FindPredefinedNode(
ObjectIds.Server,
typeof(ServerObjectState));
// update server capabilities.
serverObject.ServiceLevel.Value = 255;
serverObject.ServerCapabilities.LocaleIdArray.Value = m_resourceManager.GetAvailableLocales();
serverObject.ServerCapabilities.ServerProfileArray.Value = m_configuration.ServerConfiguration.ServerProfileArray.ToArray();
serverObject.ServerCapabilities.MinSupportedSampleRate.Value = 0;
serverObject.ServerCapabilities.MaxBrowseContinuationPoints.Value = (ushort)m_configuration.ServerConfiguration.MaxBrowseContinuationPoints;
serverObject.ServerCapabilities.MaxQueryContinuationPoints.Value = (ushort)m_configuration.ServerConfiguration.MaxQueryContinuationPoints;
serverObject.ServerCapabilities.MaxHistoryContinuationPoints.Value = (ushort)m_configuration.ServerConfiguration.MaxHistoryContinuationPoints;
serverObject.ServerCapabilities.MaxArrayLength.Value = (uint)m_configuration.TransportQuotas.MaxArrayLength;
serverObject.ServerCapabilities.MaxStringLength.Value = (uint)m_configuration.TransportQuotas.MaxStringLength;
serverObject.ServerCapabilities.MaxByteStringLength.Value = (uint)m_configuration.TransportQuotas.MaxByteStringLength;
serverObject.ServerCapabilities.OperationLimits.MaxNodesPerRead.Value = 0;
serverObject.ServerCapabilities.OperationLimits.MaxNodesPerWrite.Value = 0;
serverObject.ServerCapabilities.OperationLimits.MaxNodesPerMethodCall.Value = 1000;
serverObject.ServerCapabilities.OperationLimits.MaxNodesPerBrowse.Value = 0;
serverObject.ServerCapabilities.OperationLimits.MaxNodesPerRegisterNodes.Value = 0;
// setup callbacks for dynamic values.
serverObject.NamespaceArray.OnSimpleReadValue = OnReadNamespaceArray;
serverObject.NamespaceArray.MinimumSamplingInterval = 1000;
serverObject.ServerArray.OnSimpleReadValue = OnReadServerArray;
serverObject.ServerArray.MinimumSamplingInterval = 1000;
// dynamic change of enabledFlag is disabled to pass CTT
serverObject.ServerDiagnostics.EnabledFlag.AccessLevel = AccessLevels.CurrentRead;
serverObject.ServerDiagnostics.EnabledFlag.UserAccessLevel = AccessLevels.CurrentRead;
serverObject.ServerDiagnostics.EnabledFlag.OnSimpleReadValue = OnReadDiagnosticsEnabledFlag;
serverObject.ServerDiagnostics.EnabledFlag.OnSimpleWriteValue = OnWriteDiagnosticsEnabledFlag;
serverObject.ServerDiagnostics.EnabledFlag.MinimumSamplingInterval = 1000;
// initialize status.
ServerStatusDataType serverStatus = new ServerStatusDataType();
serverStatus.StartTime = DateTime.UtcNow;
serverStatus.CurrentTime = DateTime.UtcNow;
serverStatus.State = ServerState.Shutdown;
serverStatus.BuildInfo.ProductName = m_serverDescription.ProductName;
serverStatus.BuildInfo.ProductUri = m_serverDescription.ProductUri;
serverStatus.BuildInfo.ManufacturerName = m_serverDescription.ManufacturerName;
serverStatus.BuildInfo.SoftwareVersion = m_serverDescription.SoftwareVersion;
serverStatus.BuildInfo.BuildNumber = m_serverDescription.BuildNumber;
serverStatus.BuildInfo.BuildDate = m_serverDescription.BuildDate;
serverObject.ServerStatus.MinimumSamplingInterval = 1000;
serverObject.ServerStatus.CurrentTime.MinimumSamplingInterval = 1000;
m_serverStatus = new ServerStatusValue(
serverObject.ServerStatus,
serverStatus,
m_dataLock);
m_serverStatus.Timestamp = DateTime.UtcNow;
m_serverStatus.OnBeforeRead = OnReadServerStatus;
// initialize diagnostics.
m_serverDiagnostics = new ServerDiagnosticsSummaryDataType();
m_serverDiagnostics.ServerViewCount = 0;
m_serverDiagnostics.CurrentSessionCount = 0;
m_serverDiagnostics.CumulatedSessionCount = 0;
m_serverDiagnostics.SecurityRejectedSessionCount = 0;
m_serverDiagnostics.RejectedSessionCount = 0;
m_serverDiagnostics.SessionTimeoutCount = 0;
m_serverDiagnostics.SessionAbortCount = 0;
m_serverDiagnostics.PublishingIntervalCount = 0;
m_serverDiagnostics.CurrentSubscriptionCount = 0;
m_serverDiagnostics.CumulatedSubscriptionCount = 0;
m_serverDiagnostics.SecurityRejectedRequestsCount = 0;
m_serverDiagnostics.RejectedRequestsCount = 0;
m_diagnosticsNodeManager.CreateServerDiagnostics(
m_defaultSystemContext,
m_serverDiagnostics,
OnUpdateDiagnostics);
// set the diagnostics enabled state.
m_diagnosticsNodeManager.SetDiagnosticsEnabled(
m_defaultSystemContext,
m_configuration.ServerConfiguration.DiagnosticsEnabled);
ConfigurationNodeManager configurationNodeManager = m_diagnosticsNodeManager as ConfigurationNodeManager;
configurationNodeManager?.CreateServerConfiguration(
m_defaultSystemContext,
m_configuration);
}
}
///
/// Updates the server status before a read.
///
private void OnReadServerStatus(
ISystemContext context,
BaseVariableValue variable,
NodeState component)
{
lock (m_dataLock)
{
DateTime now = DateTime.UtcNow;
m_serverStatus.Timestamp = now;
m_serverStatus.Value.CurrentTime = now;
}
}
///
/// Returns a copy of the namespace array.
///
private ServiceResult OnReadNamespaceArray(
ISystemContext context,
NodeState node,
ref object value)
{
value = m_namespaceUris.ToArray();
return ServiceResult.Good;
}
///
/// Returns a copy of the server array.
///
private ServiceResult OnReadServerArray(
ISystemContext context,
NodeState node,
ref object value)
{
value = m_serverUris.ToArray();
return ServiceResult.Good;
}
///
/// Returns Diagnostics.EnabledFlag
///
private ServiceResult OnReadDiagnosticsEnabledFlag(
ISystemContext context,
NodeState node,
ref object value)
{
value = m_diagnosticsNodeManager.DiagnosticsEnabled;
return ServiceResult.Good;
}
///
/// Sets the Diagnostics.EnabledFlag
///
private ServiceResult OnWriteDiagnosticsEnabledFlag(
ISystemContext context,
NodeState node,
ref object value)
{
bool enabled = (bool)value;
m_diagnosticsNodeManager.SetDiagnosticsEnabled(
m_defaultSystemContext,
enabled);
return ServiceResult.Good;
}
///
/// Returns a copy of the current diagnostics.
///
private ServiceResult OnUpdateDiagnostics(
ISystemContext context,
NodeState node,
ref object value)
{
lock (m_serverDiagnostics)
{
value = Utils.Clone(m_serverDiagnostics);
}
return ServiceResult.Good;
}
#endregion
#region Private Fields
private ServerProperties m_serverDescription;
private ApplicationConfiguration m_configuration;
private List m_endpointAddresses;
private ServiceMessageContext m_messageContext;
private ServerSystemContext m_defaultSystemContext;
private NamespaceTable m_namespaceUris;
private StringTable m_serverUris;
private EncodeableFactory m_factory;
private TypeTable m_typeTree;
#if LEGACY_CORENODEMANAGER
private TypeSourceTable m_typeSources;
#endif
private ResourceManager m_resourceManager;
private RequestManager m_requestManager;
private AggregateManager m_aggregateManager;
private MasterNodeManager m_nodeManager;
private CoreNodeManager m_coreNodeManager;
private DiagnosticsNodeManager m_diagnosticsNodeManager;
private EventManager m_eventManager;
private SessionManager m_sessionManager;
private SubscriptionManager m_subscriptionManager;
private object m_dataLock = new object();
private ServerObjectState m_serverObject;
private ServerStatusValue m_serverStatus;
private ServerDiagnosticsSummaryDataType m_serverDiagnostics;
#endregion
}
}