UA-.NETStandard/Libraries/Opc.Ua.Server/FileSystem/FileHandle.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;
using System.Collections.Generic;
using System.IO;
using System.Threading;

namespace Opc.Ua.Server.FileSystem
{
    /// <summary>
    /// Per-file handle bag. Tracks the streams opened against a single
    /// file via repeated <c>FileType.Open</c> calls (one writer +
    /// many readers per the spec) and dispenses the integer
    /// file-handle values returned to OPC UA clients.
    /// </summary>
    internal sealed class FileHandle : IDisposable
    {
        public FileHandle(IFileSystemProvider provider, string providerPath)
        {
            m_provider = provider;
            ProviderPath = providerPath;
        }

        public string ProviderPath { get; }

        public ushort OpenCount
        {
            get
            {
                lock (m_lock)
                {
                    return (ushort)(m_reads.Count + (m_write != null ? 1 : 0));
                }
            }
        }

        public bool IsWriteable
        {
            get
            {
                lock (m_lock)
                {
                    if (!m_provider.IsWritable || m_reads.Count != 0 || m_write != null)
                    {
                        return false;
                    }
                }
                // Outside the lock: ask the provider for the latest
                // writable bit without serialising readers.
                FileSystemEntry? entry = m_provider.GetEntryAsync(
                    ProviderPath, CancellationToken.None)
                    .AsTask().GetAwaiter().GetResult();
                return entry?.IsWritable ?? false;
            }
        }

        public long Length
        {
            get
            {
                FileSystemEntry? entry = m_provider.GetEntryAsync(
                    ProviderPath, CancellationToken.None)
                    .AsTask().GetAwaiter().GetResult();
                return entry?.Length ?? 0L;
            }
        }

        public DateTime LastModifiedTime
        {
            get
            {
                FileSystemEntry? entry = m_provider.GetEntryAsync(
                    ProviderPath, CancellationToken.None)
                    .AsTask().GetAwaiter().GetResult();
                return entry?.LastModifiedUtc ?? DateTime.MinValue;
            }
        }

        public string MimeType
        {
            get
            {
                FileSystemEntry? entry = m_provider.GetEntryAsync(
                    ProviderPath, CancellationToken.None)
                    .AsTask().GetAwaiter().GetResult();
                return entry?.MimeType ?? string.Empty;
            }
        }

        public Stream? GetStream(uint fileHandle)
        {
            lock (m_lock)
            {
                if (m_write != null && fileHandle == 1)
                {
                    return m_write;
                }
                if (m_reads.TryGetValue(fileHandle, out Stream? stream))
                {
                    return stream;
                }
                return null;
            }
        }

        /// <summary>
        /// Implements <c>FileType.Open</c>. The mode bits are per
        /// Part 5 §C: 0x1 = Read, 0x2 = Write, 0x4 = EraseExisting,
        /// 0x8 = Append.
        /// </summary>
        public ServiceResult Open(byte mode, out uint fileHandle)
        {
            fileHandle = 0u;
            bool wantsRead = (mode & 0x1) != 0;
            bool wantsWrite = (mode & 0x2) != 0;

            if (!wantsRead && !wantsWrite)
            {
                return ServiceResult.Create(
                    StatusCodes.BadInvalidArgument,
                    "FileType.Open mode must include read or write.");
            }
            if (wantsRead && wantsWrite)
            {
                return ServiceResult.Create(
                    StatusCodes.BadInvalidArgument,
                    "Simultaneous read + write open not supported.");
            }
            if (wantsWrite && !m_provider.IsWritable)
            {
                return ServiceResult.Create(
                    StatusCodes.BadUserAccessDenied,
                    "Provider is read-only.");
            }

            try
            {
                if (wantsRead)
                {
                    Stream stream = m_provider
                        .OpenReadAsync(ProviderPath, CancellationToken.None)
                        .AsTask().GetAwaiter().GetResult();
                    lock (m_lock)
                    {
                        if (m_write != null)
                        {
                            stream.Dispose();
                            return ServiceResult.Create(
                                StatusCodes.BadInvalidState,
                                "File already open for write.");
                        }
                        fileHandle = ++m_nextHandle;
                        m_reads.Add(fileHandle, stream);
                    }
                    return ServiceResult.Good;
                }

                FileWriteMode writeMode;
                if ((mode & 0x4) != 0)
                {
                    writeMode = FileWriteMode.Truncate;
                }
                else if ((mode & 0x8) != 0)
                {
                    writeMode = FileWriteMode.Append;
                }
                else
                {
                    writeMode = FileWriteMode.OpenOrCreate;
                }

                Stream writeStream = m_provider
                    .OpenWriteAsync(ProviderPath, writeMode, CancellationToken.None)
                    .AsTask().GetAwaiter().GetResult();
                lock (m_lock)
                {
                    if (m_reads.Count != 0 || m_write != null)
                    {
                        writeStream.Dispose();
                        return ServiceResult.Create(
                            StatusCodes.BadInvalidState,
                            "File already open for read or write.");
                    }
                    m_write = writeStream;
                    fileHandle = 1u;
                }
                return ServiceResult.Good;
            }
            catch (FileNotFoundException ex)
            {
                return ServiceResult.Create(ex, StatusCodes.BadNotFound,
                    "File not found");
            }
            catch (UnauthorizedAccessException ex)
            {
                return ServiceResult.Create(ex, StatusCodes.BadUserAccessDenied,
                    "Failed to open file");
            }
            catch (IOException ex)
            {
                return ServiceResult.Create(ex, StatusCodes.BadInvalidState,
                    "Failed to open file");
            }
        }

        public bool Close(uint fileHandle)
        {
            lock (m_lock)
            {
                if (m_write != null && fileHandle == 1)
                {
                    m_write.Dispose();
                    m_write = null;
                    return true;
                }
                if (m_reads.TryGetValue(fileHandle, out Stream? stream))
                {
                    stream.Dispose();
                    m_reads.Remove(fileHandle);
                    return true;
                }
            }
            return false;
        }

        public void Dispose()
        {
            lock (m_lock)
            {
                m_write?.Dispose();
                m_write = null;
                foreach (Stream stream in m_reads.Values)
                {
                    stream.Dispose();
                }
                m_reads.Clear();
            }
        }

        private readonly Lock m_lock = new();
        private readonly Dictionary<uint, Stream> m_reads = [];
        private readonly IFileSystemProvider m_provider;
        private uint m_nextHandle = 1;
        private Stream? m_write;
    }
}