RobustToolbox/Robust.Shared/Serialization/Manager/SerializationManager.cs

using System;
using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;
using Robust.Shared.IoC;
using Robust.Shared.Log;
using Robust.Shared.Network;
using Robust.Shared.Prototypes;
using Robust.Shared.Reflection;
using Robust.Shared.Serialization.Manager.Attributes;
using Robust.Shared.Serialization.Manager.Definition;
using Robust.Shared.Serialization.Markdown;
using Robust.Shared.Utility;

namespace Robust.Shared.Serialization.Manager
{
    public sealed partial class SerializationManager : ISerializationManager
    {
        [Dependency] private readonly INetManager _net = default!;
        [Dependency] private readonly IReflectionManager _reflectionManager = default!;

        public IReflectionManager ReflectionManager => _reflectionManager;

        public const string LogCategory = "serialization";

        private bool _initializing;
        private bool _initialized;

        private readonly ConcurrentDictionary<Type, DataDefinition> _dataDefinitions = new();

        private ImmutableHashSet<Type> _copyByRefRegistrations = ImmutableHashSet<Type>.Empty;

        [field: Dependency]
        public IDependencyCollection DependencyCollection { get; } = default!;

        public bool IsServer { get; private set; }

        public void Initialize()
        {
            if (_initializing)
                throw new InvalidOperationException($"{nameof(SerializationManager)} is already being initialized.");

            if (_initialized)
                throw new InvalidOperationException($"{nameof(SerializationManager)} has already been initialized.");

            IsServer = _net.IsServer;
            _initializing = true;

            _read = typeof(SerializationManager)
                .GetMethods(BindingFlags.Instance | BindingFlags.NonPublic)
                .First(m => m.Name == nameof(ReadObject) &&
                            m.GetGenericArguments().Length == 1 &&
                            GetParametersBase(m)
                                .SequenceEqual([
                                    typeof(DataNode), typeof(SerializationHookContext), typeof(ISerializationContext),
                                    typeof(bool)
                                ]));

            var flagsTypes = _reflectionManager.FindTypesWithAttribute<FlagsForAttribute>();
            var constantsTypes = _reflectionManager.FindTypesWithAttribute<ConstantsForAttribute>();
            var typeSerializers = _reflectionManager.FindTypesWithAttribute<TypeSerializerAttribute>();
            var meansDataDef = _reflectionManager.FindTypesWithAttribute<MeansDataDefinitionAttribute>();
            var meansDataRecord = _reflectionManager.FindTypesWithAttribute<MeansDataRecordAttribute>();
            var implicitDataDef = _reflectionManager.FindTypesWithAttribute<ImplicitDataDefinitionForInheritorsAttribute>();
            var implicitDataRecord = _reflectionManager.FindTypesWithAttribute<ImplicitDataRecordAttribute>();
            _copyByRefRegistrations = _reflectionManager.FindTypesWithAttributeSet<CopyByRefAttribute>();

            InitializeFlagsAndConstants(flagsTypes, constantsTypes);
            InitializeTypeSerializers(typeSerializers);

            // This is a bag, not a hash set.
            // Duplicates are fine since the CWT<,> won't re-run the constructor if it's already in there.
            var registrations = new ConcurrentBag<Type>();
            var records = new ConcurrentDictionary<Type, byte>();

            IEnumerable<Type> GetImplicitTypes(Type type)
            {
                // Inherited attributes don't work with interfaces.
                if (type.IsInterface)
                {
                    foreach (var child in _reflectionManager.GetAllChildren(type))
                    {
                        if (child.IsAbstract || child.IsGenericTypeDefinition || child.IsInterface)
                            continue;

                        yield return child;
                    }
                }
                else if (!type.IsAbstract && !type.IsGenericTypeDefinition)
                {
                    yield return type;
                }
            }

            foreach (var baseType in implicitDataDef)
            {
                foreach (var type in GetImplicitTypes(baseType))
                {
                    registrations.Add(type);
                }
            }

            foreach (var baseType in implicitDataRecord)
            {
                foreach (var type in GetImplicitTypes(baseType))
                {
                    records.TryAdd(type, 0);
                }
            }

            Parallel.ForEach(_reflectionManager.FindAllTypes(), type =>
            {
                var meansDef = false;
                foreach (var meansAttr in meansDataDef)
                {
                    if (!_reflectionManager.IsAttributeDefined(type, meansAttr))
                        continue;

                    meansDef = true;
                    break;
                }

                if (meansDef)
                    registrations.Add(type);

                if (_reflectionManager.IsAttributeDefined(type, typeof(DataRecordAttribute)))
                {
                    records[type] = 0;
                }
                else
                {
                    var meansRecord = false;
                    foreach (var meansAttr in meansDataRecord)
                    {
                        if (!_reflectionManager.IsAttributeDefined(type, meansAttr))
                            continue;

                        meansRecord = true;
                        break;
                    }

                    if (meansRecord)
                        records[type] = 0;
                }
            });

            var sawmill = Logger.GetSawmill(LogCategory);
            _serializerSawmill = Logger.GetSawmill("szr");

            Parallel.ForEach(registrations, type =>
            {
                if (type.IsAbstract || type.IsInterface || type.IsGenericTypeDefinition)
                {
                    sawmill.Debug(
                        $"Skipping registering data definition for type {type} since it is abstract or an interface");
                    return;
                }

                var isRecord = records.ContainsKey(type);
                if (!type.IsValueType &&
                    !isRecord &&
                    !type.HasParameterlessConstructor(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic))
                {
                    // If someone attempts to save or load an entity that uses this DataDefinition, this will lead to errors.
                    sawmill.Warning(
                        $"Skipping registering data definition for type {type} since it has no parameterless ctor");
                    return;
                }

                _dataDefinitions.GetOrAdd(type, static (t, s) => s.Item1.CreateDataDefinition(t, s.isRecord), (this, isRecord));
            });

            var duplicateErrors = new StringBuilder();
            var invalidIncludes = new StringBuilder();

            //check for duplicates
            var dataDefs = _dataDefinitions.Select(x => x.Key).ToHashSet();
            var includeTree = new MultiRootInheritanceGraph<Type>();
            foreach (var (type, definition) in _dataDefinitions)
            {
                var invalidTypes = new List<string>();
                foreach (var includedField in definition.BaseFieldDefinitions.Where(x => x is { IsIncludeDataField: true, CustomTypeSerializer: null }))
                {
                    if (!dataDefs.Contains(includedField.FieldType))
                    {
                        invalidTypes.Add(includedField.ToString());
                        continue;
                    }

                    includeTree.Add(includedField.FieldType, type);
                }

                if (invalidTypes.Count > 0)
                    invalidIncludes.Append($"{type}: [{string.Join(", ", invalidTypes)}]");

                if (definition.TryGetDuplicates(out var definitionDuplicates))
                {
                    duplicateErrors.Append($"{type}: [{string.Join(", ", definitionDuplicates)}]\n");
                }
            }

            if (duplicateErrors.Length > 0)
            {
                throw new ArgumentException($"Duplicate data field tags found in:\n{duplicateErrors}");
            }

            if (invalidIncludes.Length > 0)
            {
                throw new ArgumentException($"Invalid Types used for include fields:\n{invalidIncludes}");
            }

            // We want to ensure that all the fields marked with a DataFieldAttribute in some DataDefinition are
            // actually serializable. Problem is that I have NFI how to do that, and all of this serialization code is
            // such convoluted spaghetti that this is the best way I could think of.
            //
            // The only alternative Idea I had was to try brute force this by repeatedly trying to call ValidateNode
            // with either a value, mapping, or sequence data node and checking that at least one of them doesn't throw
            // an exception due to the type having no serializer/validator. But that still fails, because things like
            // EntityUid aren't actually serializable without the mapping context which provides the serializer.
            // TODO SERIALIZATION REFACTOR Somehow validate that data-fields are serializable.
            // So for now, This will just do a very basic blacklist check.

            var forbidden = _reflectionManager.FindTypesWithAttribute<NotYamlSerializableAttribute>()
                .ToFrozenSet();

            foreach (var def in _dataDefinitions.Values)
            {
                foreach (var field in def.BaseFieldDefinitions)
                {
                    if (field.FieldType.ContainsGenericParameters)
                        continue; // This just isn't supported yet, can't validate it so just skip it.

                    if (field.CustomTypeSerializer != null)
                        continue; // Assume that anything with a custom type serializer can be handled.

                    if (!ValidateIsSerializable(field.FieldType, forbidden))
                        sawmill.Error($"Data-field of type {field.FieldType} in {def} is not serializable");
                }
            }

            _copyByRefRegistrations = _copyByRefRegistrations.Add(typeof(Type));

            _initialized = true;
            _initializing = false;
        }

        /// <summary>
        /// Check if the given type is, or contains instances of, any forbidden types.
        /// This is not at all a thorough check, but should help prevent people from accidentally using the
        /// <see cref="DataFieldAttribute"/> on invalid / unserializable fields.
        /// </summary>
        private bool ValidateIsSerializable(Type type, FrozenSet<Type> forbidden)
        {
            if (type.IsArray)
                return ValidateIsSerializable(type.GetElementType()!, forbidden);

            if (!type.IsGenericType)
                return !forbidden.Contains(type);

            var genDef = type.GetGenericTypeDefinition();
            if (forbidden.Contains(genDef))
                return false;

            if (genDef == typeof(List<>) || genDef == typeof(HashSet<>) || genDef == typeof(Nullable<>))
                return ValidateIsSerializable(type.GetGenericArguments()[0], forbidden);

            if (genDef == typeof(Dictionary<,>))
            {
                var args = type.GetGenericArguments();
                return ValidateIsSerializable(args[0], forbidden) && ValidateIsSerializable(args[1], forbidden);
            }

            return true;
        }

        private DataDefinition CreateDataDefinition(Type t, bool isRecord)
        {
            return (DataDefinition)typeof(DataDefinition<>).MakeGenericType(t)
                .GetConstructor(BindingFlags.Instance | BindingFlags.NonPublic,
                [
                    typeof(SerializationManager), typeof(bool)
                ])!
                .Invoke([this, isRecord]);
        }

        public void Shutdown()
        {
            _constantsMapping.Clear();
            _flagsMapping.Clear();

            _dataDefinitions.Clear();

            _copyByRefRegistrations.Clear();

            _highestFlagBit.Clear();

            _readBoxingDelegates.Clear();

            _initialized = false;
        }

        internal DataDefinition<T>? GetDefinition<T>() where T : ISerializationGenerated<T>
        {
            return GetDefinition(typeof(T)) as DataDefinition<T>;
        }

        internal DataDefinition? GetDefinition(Type type)
        {
            return _dataDefinitions.GetValueOrDefault(type);
        }

        internal bool TryGetDefinition<T>([NotNullWhen(true)] out DataDefinition<T>? dataDefinition) where T : ISerializationGenerated<T>
        {
            dataDefinition = GetDefinition<T>();
            return dataDefinition != null;
        }

        internal bool TryGetDefinition(Type type, [NotNullWhen(true)] out DataDefinition? dataDefinition)
        {
            dataDefinition = GetDefinition(type);
            return dataDefinition != null;
        }

        public bool TryGetVariableType(Type type, string variableName, [NotNullWhen(true)] out Type? variableType)
        {
            if (!TryGetDefinition(type, out var definition))
            {
                variableType = null;
                return false;
            }

            var foundFieldDef = definition.BaseFieldDefinitions.FirstOrDefault(fieldDef => fieldDef.IsDataField && fieldDef.Tag == variableName, default);
            if (foundFieldDef != default)
            {
                variableType = foundFieldDef.FieldType;
                return true;
            }

            variableType = null;
            return false;
        }

        private bool TryResolveConcreteType(Type baseType, string typeName, [NotNullWhen(true)] out Type? concreteType)
        {
            concreteType = ReflectionManager.YamlTypeTagLookup(baseType, typeName);
            return concreteType != null;
        }

        private Type ResolveConcreteType(Type baseType, string typeName)
        {
            if (TryResolveConcreteType(baseType, typeName, out var concreteType))
                return concreteType;

            throw new InvalidOperationException($"Type '{baseType}' is abstract, but could not find concrete type '{typeName}'.");
        }

#pragma warning disable CS0618
        internal static void TryRunAfterHook<TValue>(TValue instance, SerializationHookContext ctx)
        {
            if (ctx.SkipHooks)
                return;

            if (instance is ISerializationHooks hooks)
                ForceRunAfterHookGenerated(hooks, ctx);
        }

        private static void ForceRunAfterHookGenerated<TValue>(TValue instance, SerializationHookContext ctx) where TValue : ISerializationHooks
        {
            DebugTools.Assert(!typeof(TValue).IsValueType, "ISerializationHooks must only be used on reference types");

            if (ctx.DeferQueue != null)
                ctx.DeferQueue.TryWrite(instance);
            else
                instance.AfterDeserialization();
        }

        private static IEnumerable<Type> GetParametersBase(MethodInfo method)
        {
            return method.GetParameters()
                .Select(p =>
                    p.ParameterType.IsGenericType
                        ? p.ParameterType.GetGenericTypeDefinition()
                        : p.ParameterType);
        }
#pragma warning restore CS0618
    }
}