Artemis/src/Artemis.Core/Plugins/PluginFeatureInfo.cs

using System;
using System.Collections.Generic;
using System.Linq;
using Artemis.Core.DeviceProviders;
using Artemis.Core.LayerBrushes;
using Artemis.Core.LayerEffects;
using Artemis.Core.Modules;
using Artemis.Storage.Entities.Plugins;
using Humanizer;
using Newtonsoft.Json;

namespace Artemis.Core;

/// <summary>
///     Represents basic info about a plugin feature and contains a reference to the instance of said feature
/// </summary>
[JsonObject(MemberSerialization.OptIn)]
public class PluginFeatureInfo : CorePropertyChanged, IPrerequisitesSubject
{
    private string? _description;
    private string? _icon;
    private PluginFeature? _instance;
    private Exception? _loadException;
    private string _name = null!;

    internal PluginFeatureInfo(Plugin plugin, Type featureType, PluginFeatureEntity pluginFeatureEntity, PluginFeatureAttribute? attribute)
    {
        Plugin = plugin ?? throw new ArgumentNullException(nameof(plugin));
        FeatureType = featureType ?? throw new ArgumentNullException(nameof(featureType));
        Entity = pluginFeatureEntity;

        Name = attribute?.Name ?? featureType.Name.Humanize(LetterCasing.Title);
        Description = attribute?.Description;
        AlwaysEnabled = attribute?.AlwaysEnabled ?? false;
    }

    internal PluginFeatureInfo(Plugin plugin, PluginFeatureAttribute? attribute, PluginFeature instance)
    {
        if (instance == null) throw new ArgumentNullException(nameof(instance));
        Plugin = plugin ?? throw new ArgumentNullException(nameof(plugin));
        FeatureType = instance.GetType();
        Entity = new PluginFeatureEntity();

        Name = attribute?.Name ?? instance.GetType().Name.Humanize(LetterCasing.Title);
        Description = attribute?.Description;
        AlwaysEnabled = attribute?.AlwaysEnabled ?? false;
        Instance = instance;
    }

    /// <summary>
    ///     Gets the plugin this feature info is associated with
    /// </summary>
    public Plugin Plugin { get; }

    /// <summary>
    ///     Gets the type of the feature
    /// </summary>
    public Type FeatureType { get; }

    /// <summary>
    ///     Gets the exception thrown while loading
    /// </summary>
    public Exception? LoadException
    {
        get => _loadException;
        internal set => SetAndNotify(ref _loadException, value);
    }

    /// <summary>
    ///     The name of the feature
    /// </summary>
    [JsonProperty(Required = Required.Always)]
    public string Name
    {
        get => _name;
        internal set => SetAndNotify(ref _name, value);
    }

    /// <summary>
    ///     A short description of the feature
    /// </summary>
    [JsonProperty]
    public string? Description
    {
        get => _description;
        set => SetAndNotify(ref _description, value);
    }

    /// <summary>
    ///     Marks the feature to always be enabled as long as the plugin is enabled and cannot be disabled.
    ///     <para>Note: always <see langword="true" /> if this is the plugin's only feature</para>
    /// </summary>
    [JsonProperty]
    public bool AlwaysEnabled { get; internal set; }

    /// <summary>
    ///     Gets a boolean indicating whether the feature is enabled in persistent storage
    /// </summary>
    public bool EnabledInStorage => Entity.IsEnabled;

    /// <summary>
    ///     Gets the feature this info is associated with
    ///     <para>Note: <see langword="null" /> if the associated <see cref="Plugin" /> is disabled</para>
    /// </summary>
    public PluginFeature? Instance
    {
        get => _instance;
        internal set => SetAndNotify(ref _instance, value);
    }
    
    internal PluginFeatureEntity Entity { get; }

    /// <inheritdoc />
    public override string ToString()
    {
        return Instance?.Id ?? "Uninitialized feature";
    }

    /// <inheritdoc />
    public List<PluginPrerequisite> Prerequisites { get; } = new();

    /// <inheritdoc />
    public IEnumerable<PluginPrerequisite> PlatformPrerequisites => Prerequisites.Where(p => p.AppliesToPlatform());

    /// <inheritdoc />
    public bool ArePrerequisitesMet()
    {
        return PlatformPrerequisites.All(p => p.IsMet());
    }
}