Dalamud/Dalamud/Plugin/Ipc/Internal/DataShare.cs

using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq;

using Dalamud.Plugin.Ipc.Exceptions;
using Serilog;

namespace Dalamud.Plugin.Ipc.Internal;

/// <summary>
/// This class facilitates sharing data-references of standard types between plugins without using more expensive IPC.
/// </summary>
[ServiceManager.EarlyLoadedService]
internal class DataShare : IServiceType
{
    /// <summary>
    /// Dictionary of cached values. Note that <see cref="Lazy{T}"/> is being used, as it does its own locking,
    /// effectively preventing calling the data generator multiple times concurrently.
    /// </summary>
    private readonly Dictionary<string, Lazy<DataCache>> caches = new();

    [ServiceManager.ServiceConstructor]
    private DataShare()
    {
    }

    /// <summary>
    /// If a data cache for <paramref name="tag"/> exists, return the data.
    /// Otherwise, call the function <paramref name="dataGenerator"/> to create data and store it as a new cache.
    /// In either case, the calling assembly will be added to the current consumers on success.
    /// </summary>
    /// <typeparam name="T">The type of the stored data - needs to be a reference type that is shared through Dalamud itself, not loaded by the plugin.</typeparam>
    /// <param name="tag">The name for the data cache.</param>
    /// <param name="dataGenerator">The function that generates the data if it does not already exist.</param>
    /// <returns>Either the existing data for <paramref name="tag"/> or the data generated by <paramref name="dataGenerator"/>.</returns>
    /// <exception cref="DataCacheTypeMismatchError">Thrown if a cache for <paramref name="tag"/> exists, but contains data of a type not assignable to <typeparamref name="T>"/>.</exception>
    /// <exception cref="DataCacheValueNullError">Thrown if the stored data for a cache is null.</exception>
    /// <exception cref="DataCacheCreationError">Thrown if <paramref name="dataGenerator"/> throws an exception or returns null.</exception>
    public T GetOrCreateData<T>(string tag, Func<T> dataGenerator)
        where T : class
    {
        var callerName = GetCallerName();

        Lazy<DataCache> cacheLazy;
        lock (this.caches)
        {
            if (!this.caches.TryGetValue(tag, out cacheLazy))
                this.caches[tag] = cacheLazy = new(() => DataCache.From(tag, callerName, dataGenerator));
        }

        return cacheLazy.Value.TryGetData<T>(callerName, out var value, out var ex) ? value : throw ex;
    }

    /// <summary>
    /// Notifies the DataShare that the calling assembly no longer uses the data stored for <paramref name="tag"/> (or uses it one time fewer).
    /// If no assembly uses the data anymore, the cache will be removed from the data share and if it is an IDisposable, Dispose will be called on it.
    /// </summary>
    /// <param name="tag">The name for the data cache.</param>
    public void RelinquishData(string tag)
    {
        DataCache cache;
        lock (this.caches)
        {
            if (!this.caches.TryGetValue(tag, out var cacheLazy))
                return;

            var callerName = GetCallerName();

            cache = cacheLazy.Value;
            if (!cache.UserAssemblyNames.Remove(callerName) || cache.UserAssemblyNames.Count > 0)
                return;
            if (!this.caches.Remove(tag))
                return;
        }

        if (cache.Data is IDisposable disposable)
        {
            try
            {
                disposable.Dispose();
                Log.Verbose("[DataShare] Disposed [{Tag:l}] after it was removed from all shares.", tag);
            }
            catch (Exception e)
            {
                Log.Error(e, "[DataShare] Failed to dispose [{Tag:l}] after it was removed from all shares.", tag);                
            }
        }
        else
        {
            Log.Verbose("[DataShare] Removed [{Tag:l}] from all shares.", tag);
        }
    }

    /// <summary>
    /// Obtain the data for the given <paramref name="tag"/>, if it exists and has the correct type.
    /// Add the calling assembly to the current consumers if true is returned.
    /// </summary>
    /// <typeparam name="T">The type of the stored data - needs to be a reference type that is shared through Dalamud itself, not loaded by the plugin.</typeparam>
    /// <param name="tag">The name for the data cache.</param>
    /// <param name="data">The requested data on success, null otherwise.</param>
    /// <returns>True if the requested data exists and is assignable to the requested type.</returns>
    public bool TryGetData<T>(string tag, [NotNullWhen(true)] out T? data)
        where T : class
    {
        data = null;
        Lazy<DataCache> cacheLazy;
        lock (this.caches)
        {
            if (!this.caches.TryGetValue(tag, out cacheLazy))
                return false;
        }

        return cacheLazy.Value.TryGetData(GetCallerName(), out data, out _);
    }

    /// <summary>
    /// Obtain the data for the given <paramref name="tag"/>, if it exists and has the correct type.
    /// Add the calling assembly to the current consumers if non-null is returned.
    /// </summary>
    /// <typeparam name="T">The type of the stored data - needs to be a reference type that is shared through Dalamud itself, not loaded by the plugin.</typeparam>
    /// <param name="tag">The name for the data cache.</param>
    /// <returns>The requested data.</returns>
    /// <exception cref="KeyNotFoundException">Thrown if <paramref name="tag"/> is not registered.</exception>
    /// <exception cref="DataCacheTypeMismatchError">Thrown if a cache for <paramref name="tag"/> exists, but contains data of a type not assignable to <typeparamref name="T>"/>.</exception>
    /// <exception cref="DataCacheValueNullError">Thrown if the stored data for a cache is null.</exception>
    public T GetData<T>(string tag)
        where T : class
    {
        Lazy<DataCache> cacheLazy;
        lock (this.caches)
        {
            if (!this.caches.TryGetValue(tag, out cacheLazy))
                throw new KeyNotFoundException($"The data cache [{tag}] is not registered.");
        }

        return cacheLazy.Value.TryGetData<T>(GetCallerName(), out var value, out var ex) ? value : throw ex;
    }

    /// <summary>
    /// Obtain a read-only list of data shares.
    /// </summary>
    /// <returns>All currently subscribed tags, their creator names and all their users.</returns>
    internal IEnumerable<(string Tag, string CreatorAssembly, string[] Users)> GetAllShares()
    {
        lock (this.caches)
        {
            return this.caches.Select(
                kvp => (kvp.Key, kvp.Value.Value.CreatorAssemblyName, kvp.Value.Value.UserAssemblyNames.ToArray()));
        }
    }

    /// <summary> Obtain the last assembly name in the stack trace that is not a system or dalamud assembly. </summary>
    private static string GetCallerName()
    {
        var frames = new StackTrace().GetFrames();
        foreach (var frame in frames.Reverse())
        {
            var name = frame.GetMethod()?.DeclaringType?.Assembly.GetName().Name ?? "Unknown";
            if (!name.StartsWith("System") && !name.StartsWith("Dalamud"))
            {
                return name;
            }
        }

        return "Unknown";
    }
}