/* ======================================================================== * 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.Diagnostics.CodeAnalysis; using System.IO; using System.Linq; using System.Reflection; using System.Runtime.Serialization; using System.Text.Json; using System.Text.Json.Serialization; using System.Text.Json.Serialization.Metadata; using Microsoft.Extensions.Logging; namespace Opc.Ua.Server.UserDatabase { /// /// A user database with JSON storage. /// /// /// This db is used for testing, not for production. /// [UnconditionalSuppressMessage("AOT", "IL3050", Justification = "JsonStringEnumConverter is used with known enum types.")] public class JsonUserDatabase : LinqUserDatabase { /// /// Create a JSON database. /// public JsonUserDatabase(string fileName) { FileName = fileName; } /// /// Load the JSON application database. /// /// is null. [RequiresUnreferencedCode( "Uses System.Text.Json reflection-based serialization.")] [RequiresDynamicCode( "Uses System.Text.Json which requires dynamic code.")] public static IUserDatabase Load(string fileName, ITelemetryContext telemetry) { if (fileName == null) { throw new ArgumentNullException(nameof(fileName)); } try { if (File.Exists(fileName)) { byte[] utf8Json = File.ReadAllBytes(fileName); var utf8JsonReader = new Utf8JsonReader(utf8Json, s_allowTrailingCommasInJsonReader); JsonUserDatabase? db = JsonSerializer.Deserialize(ref utf8JsonReader, s_exchangeJsonSerializerOptions); db!.FileName = fileName; return db; } } catch { ILogger logger = telemetry.CreateLogger(); logger.LogWarning("User database {FileName} was not found.", fileName); } return new JsonUserDatabase(fileName); } /// /// Save the complete database. /// [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026", Justification = "Uses System.Text.Json with known user database types.")] [UnconditionalSuppressMessage("AOT", "IL3050", Justification = "Uses System.Text.Json with known user database types.")] protected override void Save() { byte[] utf8Json = JsonSerializer.SerializeToUtf8Bytes( this, s_exchangeJsonSerializerOptions); File.WriteAllBytes(FileName, utf8Json); } /// /// Get or set the filename. /// [IgnoreDataMember] [JsonIgnore] public string FileName { get; private set; } private static readonly JsonSerializerOptions s_exchangeJsonSerializerOptions = new() { AllowTrailingCommas = true, Converters = { new JsonStringEnumConverter(JsonNamingPolicy.CamelCase) }, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, PropertyNameCaseInsensitive = true, PropertyNamingPolicy = JsonNamingPolicy.CamelCase, WriteIndented = true, TypeInfoResolver = new SystemRuntimeSerializationAttributeResolver() }; private static readonly JsonReaderOptions s_allowTrailingCommasInJsonReader = new() { AllowTrailingCommas = true }; [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026", Justification = "Uses reflection on DataContract-attributed types with known structure.")] [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2070", Justification = "Uses reflection on DataContract-attributed types with known structure.")] [UnconditionalSuppressMessage("AOT", "IL3050", Justification = "Uses reflection on DataContract-attributed types with known structure.")] private class SystemRuntimeSerializationAttributeResolver : DefaultJsonTypeInfoResolver { public override JsonTypeInfo GetTypeInfo(Type type, JsonSerializerOptions options) { JsonTypeInfo jsonTypeInfo = base.GetTypeInfo(type, options); if (jsonTypeInfo.Kind == JsonTypeInfoKind.Object && type.GetCustomAttribute() is not null) { jsonTypeInfo.Properties.Clear(); foreach ((PropertyInfo propertyInfo, DataMemberAttribute? attr) in type! .GetProperties(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic) .Select((prop) => (prop, prop.GetCustomAttribute())) .Where((x) => x.Item2 != null) .OrderBy((x) => x!.Item2!.Order)) { JsonPropertyInfo jsonPropertyInfo = jsonTypeInfo.CreateJsonPropertyInfo( propertyInfo.PropertyType, attr!.Name ?? propertyInfo.Name); jsonPropertyInfo.Get = propertyInfo.CanRead ? propertyInfo.GetValue : null; jsonPropertyInfo.Set = propertyInfo.CanWrite ? propertyInfo.SetValue : null; jsonTypeInfo.Properties.Add(jsonPropertyInfo); } } return jsonTypeInfo; } } } }