UA-.NETStandard/Libraries/Opc.Ua.Server/Server/OperationContext.cs

/* ========================================================================
 * Copyright (c) 2005-2025 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;

namespace Opc.Ua.Server
{
    /// <summary>
    /// Stores information used while a thread is completing an operation on behalf of a client.
    /// </summary>
    public class OperationContext : ISessionOperationContext
    {
        /// <summary>
        /// Initializes the context with a session.
        /// </summary>
        /// <param name="requestHeader">The request header.</param>
        /// <param name="secureChannelContext">The secure channel context.</param>
        /// <param name="requestType">Type of the request.</param>
        /// <param name="requestLifetime">The request lifetime.</param>
        /// <param name="identity">The identity used in the request.</param>
        public OperationContext(
            RequestHeader requestHeader,
            SecureChannelContext? secureChannelContext,
            RequestType requestType,
            RequestLifetime requestLifetime,
            IUserIdentity? identity = null)
        {
            if (requestHeader == null)
            {
                throw new ArgumentNullException(nameof(requestHeader));
            }

            ChannelContext = secureChannelContext;
            Session = null!;
            UserIdentity = identity!;
            PreferredLocales = Array.Empty<string>();
            DiagnosticsMask = (DiagnosticsMasks)requestHeader.ReturnDiagnostics;
            StringTable = new StringTable();
            AuditEntryId = requestHeader.AuditEntryId!;
            RequestId = Utils.IncrementIdentifier(ref s_lastRequestId);
            RequestType = requestType;
            ClientHandle = requestHeader.RequestHandle;
            OperationDeadline = DateTime.MaxValue;
            RequestLifetime = requestLifetime ?? RequestLifetime.None;

            if (requestHeader.TimeoutHint > 0)
            {
                OperationDeadline = DateTime.UtcNow.AddMilliseconds(requestHeader.TimeoutHint);
            }
        }

        /// <summary>
        /// Initializes the context with a session.
        /// </summary>
        /// <param name="requestHeader">The request header.</param>
        /// <param name="secureChannelContext">The secure channel context.</param>
        /// <param name="requestType">Type of the request.</param>
        /// <param name="requestLifetime">The request lifetime.</param>
        /// <param name="session">The session.</param>
        public OperationContext(
            RequestHeader requestHeader,
            SecureChannelContext secureChannelContext,
            RequestType requestType,
            RequestLifetime requestLifetime,
            ISession session)
        {
            if (requestHeader == null)
            {
                throw new ArgumentNullException(nameof(requestHeader));
            }

            ChannelContext = secureChannelContext;
            Session = session ?? throw new ArgumentNullException(nameof(session));
            UserIdentity = session.EffectiveIdentity;
            PreferredLocales = session.PreferredLocales;
            DiagnosticsMask = (DiagnosticsMasks)requestHeader.ReturnDiagnostics;
            StringTable = new StringTable();
            AuditEntryId = requestHeader.AuditEntryId!;
            RequestId = Utils.IncrementIdentifier(ref s_lastRequestId);
            RequestType = requestType;
            ClientHandle = requestHeader.RequestHandle;
            OperationDeadline = DateTime.MaxValue;
            RequestLifetime = requestLifetime ?? RequestLifetime.None;

            if (requestHeader.TimeoutHint > 0)
            {
                OperationDeadline = DateTime.UtcNow.AddMilliseconds(requestHeader.TimeoutHint);
            }
        }

        /// <summary>
        /// Initializes the context with a session.
        /// </summary>
        /// <param name="session">The session.</param>
        /// <param name="diagnosticsMasks">The diagnostics masks.</param>
        public OperationContext(ISession session, DiagnosticsMasks diagnosticsMasks)
        {
            ChannelContext = null!;
            Session = session ?? throw new ArgumentNullException(nameof(session));
            UserIdentity = session.EffectiveIdentity;
            PreferredLocales = session.PreferredLocales;
            DiagnosticsMask = diagnosticsMasks;
            StringTable = new StringTable();
            AuditEntryId = null!;
            RequestId = 0;
            RequestType = RequestType.Unknown;
            ClientHandle = 0;
            OperationDeadline = DateTime.MaxValue;
            RequestLifetime = RequestLifetime.None;
        }

        /// <summary>
        /// Initializes the context with a monitored item.
        /// </summary>
        /// <param name="monitoredItem">The monitored item.</param>
        public OperationContext(IMonitoredItem monitoredItem)
        {
            if (monitoredItem == null)
            {
                throw new ArgumentNullException(nameof(monitoredItem));
            }

            ChannelContext = null!;
            UserIdentity = monitoredItem.EffectiveIdentity;
            Session = monitoredItem.Session;

            if (Session != null)
            {
                UserIdentity = Session.Identity;
                PreferredLocales = Session.PreferredLocales;
            }

            DiagnosticsMask = DiagnosticsMasks.SymbolicId;
            StringTable = new StringTable();
            AuditEntryId = null!;
            RequestId = 0;
            RequestType = RequestType.Unknown;
            ClientHandle = 0;
            OperationDeadline = DateTime.MaxValue;
            RequestLifetime = RequestLifetime.None;
        }

        /// <summary>
        /// The context for the secure channel used to send the request.
        /// </summary>
        /// <value>The channel context.</value>
        public SecureChannelContext? ChannelContext { get; }

        /// <summary>
        /// The session associated with the context.
        /// </summary>
        /// <value>The session.</value>
        public ISession Session { get; } = null!;

        /// <summary>
        /// The lifetime of the request.
        /// This object is used to track the lifetime of the request and to trigger cancellation if the client aborts the request or if the request times out.
        /// </summary>
        public RequestLifetime RequestLifetime { get; }

        /// <summary>
        /// The security policy used for the secure channel.
        /// </summary>
        /// <value>The security policy URI.</value>
        public string SecurityPolicyUri
        {
            get
            {
                if (ChannelContext != null && ChannelContext.EndpointDescription != null)
                {
                    return ChannelContext.EndpointDescription.SecurityPolicyUri!;
                }

                return null!;
            }
        }

        /// <summary>
        /// The type of request.
        /// </summary>
        /// <value>The type of the request.</value>
        public RequestType RequestType { get; }

        /// <summary>
        /// A unique identifier assigned to the request by the server.
        /// </summary>
        /// <value>The request id.</value>
        public uint RequestId { get; }

        /// <summary>
        /// The handle assigned by the client to the request.
        /// </summary>
        /// <value>The client handle.</value>
        public uint ClientHandle { get; }

        /// <summary>
        /// Updates the status code (thread safe).
        /// </summary>
        /// <param name="statusCode">The status code.</param>
        [Obsolete("Use RequestLifetime.TryCancel instead to update the status code and trigger cancellation if needed.")]
        public void SetStatusCode(StatusCode statusCode)
        {
            RequestLifetime.TryCancel(statusCode);
        }

        /// <summary>
        /// The identifier for the session (null if multiple sessions are associated with the operation).
        /// </summary>
        /// <value>The session id.</value>
        public NodeId SessionId
        {
            get
            {
                if (Session != null)
                {
                    return Session.Id;
                }

                return default;
            }
        }

        /// <summary>
        /// The identity context to use when processing the request.
        /// </summary>
        /// <value>The user identity.</value>
        public IUserIdentity UserIdentity { get; }

        /// <summary>
        /// The locales to use for the operation.
        /// </summary>
        /// <value>The preferred locales.</value>
        public ArrayOf<string> PreferredLocales { get; }

        /// <summary>
        /// The diagnostics mask specified with the request.
        /// </summary>
        /// <value>The diagnostics mask.</value>
        public DiagnosticsMasks DiagnosticsMask { get; }

        /// <summary>
        /// A table of diagnostics strings to return in the response.
        /// </summary>
        /// <value>The string table.</value>
        /// <remarks>
        /// This object is thread safe.
        /// </remarks>
        public StringTable StringTable { get; }

        /// <summary>
        /// When the request times out.
        /// </summary>
        /// <value>The operation deadline.</value>
        public DateTime OperationDeadline { get; }

        /// <summary>
        /// Gets the token that will be cancelled when the request is aborted.
        /// </summary>
        public System.Threading.CancellationToken CancellationToken => RequestLifetime?.CancellationToken ?? System.Threading.CancellationToken.None;

        /// <summary>
        /// The current status of the request (used to check for timeouts/client cancel requests).
        /// </summary>
        /// <value>The operation status.</value>
        public StatusCode OperationStatus => RequestLifetime.StatusCode;

        /// <summary>
        /// The audit log entry id provided by the client which must be included in an audit events generated by the server.
        /// </summary>
        /// <value>The audit entry id.</value>
        public string AuditEntryId { get; } = null!;
        private static uint s_lastRequestId;
    }
}