using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json.Serialization;
namespace Artemis.Core;
///
/// Represents basic info about a plugin and contains a reference to the instance of said plugin
///
public class PluginInfo : CorePropertyChanged, IPrerequisitesSubject
{
private Version? _api;
private string? _author;
private bool _autoEnableFeatures = true;
private string? _description;
private Guid _guid;
private string? _icon;
private string _main = null!;
private string _name = null!;
private PluginPlatform? _platforms;
private Plugin _plugin = null!;
private Uri? _repository;
private bool _requiresAdmin;
private string _version = null!;
private Uri? _website;
private Uri? _helpPage;
private bool _hotReloadSupported = true;
private Uri? _license;
private string? _licenseName;
[JsonConstructor]
internal PluginInfo()
{
}
///
/// The plugins GUID
///
[JsonRequired]
[JsonInclude]
public Guid Guid
{
get => _guid;
internal set => SetAndNotify(ref _guid, value);
}
///
/// The name of the plugin
///
[JsonRequired]
[JsonInclude]
public string Name
{
get => _name;
internal set => SetAndNotify(ref _name, value);
}
///
/// A short description of the plugin
///
public string? Description
{
get => _description;
set => SetAndNotify(ref _description, value);
}
///
/// Gets or sets the author of this plugin
///
public string? Author
{
get => _author;
set => SetAndNotify(ref _author, value);
}
///
/// Gets or sets the website of this plugin or its author
///
public Uri? Website
{
get => _website;
set => SetAndNotify(ref _website, value);
}
///
/// Gets or sets the repository of this plugin
///
public Uri? Repository
{
get => _repository;
set => SetAndNotify(ref _repository, value);
}
///
/// Gets or sets the help page of this plugin
///
public Uri? HelpPage
{
get => _helpPage;
set => SetAndNotify(ref _helpPage, value);
}
///
/// Gets or sets the help page of this plugin
///
public Uri? License
{
get => _license;
set => SetAndNotify(ref _license, value);
}
///
/// Gets or sets the author of this plugin
///
public string? LicenseName
{
get => _licenseName;
set => SetAndNotify(ref _licenseName, value);
}
///
/// The plugins display icon that's shown in the settings see for
/// available icons
///
public string? Icon
{
get => _icon;
set => SetAndNotify(ref _icon, value);
}
///
/// The version of the plugin
///
[JsonRequired]
[JsonInclude]
public string Version
{
get => _version;
internal set => SetAndNotify(ref _version, value);
}
///
/// The main entry DLL, should contain a class implementing Plugin
///
[JsonRequired]
[JsonInclude]
public string Main
{
get => _main;
internal set => SetAndNotify(ref _main, value);
}
///
/// Gets or sets a boolean indicating whether this plugin should automatically enable all its features when it is first
/// loaded
///
public bool AutoEnableFeatures
{
get => _autoEnableFeatures;
set => SetAndNotify(ref _autoEnableFeatures, value);
}
///
/// Gets a boolean indicating whether this plugin requires elevated admin privileges
///
[JsonInclude]
public bool RequiresAdmin
{
get => _requiresAdmin;
internal set => SetAndNotify(ref _requiresAdmin, value);
}
///
/// Gets or sets a boolean indicating whether hot reloading this plugin is supported
///
public bool HotReloadSupported
{
get => _hotReloadSupported;
set => SetAndNotify(ref _hotReloadSupported, value);
}
///
/// Gets
///
[JsonInclude]
public PluginPlatform? Platforms
{
get => _platforms;
internal set => SetAndNotify(ref _platforms, value);
}
///
/// Gets the API version the plugin was built for
///
[JsonInclude]
public Version? Api
{
get => _api;
internal set => SetAndNotify(ref _api, value);
}
///
/// Gets the plugin this info is associated with
///
[JsonIgnore]
public Plugin Plugin
{
get => _plugin;
internal set => SetAndNotify(ref _plugin, value);
}
///
/// Gets a string representing either a full path pointing to an svg or the markdown icon
///
[JsonIgnore]
public string? ResolvedIcon
{
get
{
if (Icon == null)
return null;
return Icon.Contains('.') ? Plugin.ResolveRelativePath(Icon) : Icon;
}
}
///
/// Gets a boolean indicating whether this plugin is compatible with the current operating system and API version
///
public bool IsCompatible => Platforms.MatchesCurrentOperatingSystem() && Api != null && Api.Major >= Constants.PluginApiVersion;
internal string PreferredPluginDirectory => $"{Main.Split(".dll")[0].Replace("/", "").Replace("\\", "")}-{Guid.ToString().Substring(0, 8)}";
///
public override string ToString()
{
return $"{Name} v{Version} - {Guid}";
}
///
[JsonIgnore]
public List Prerequisites { get; } = new();
///
[JsonIgnore]
public IEnumerable PlatformPrerequisites => Prerequisites.Where(p => p.AppliesToPlatform());
///
public bool ArePrerequisitesMet()
{
return PlatformPrerequisites.All(p => p.IsMet());
}
}