Start the plugin system (#372)
Build and Release / Read metadata (push) Waiting to run
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-aarch64-apple-darwin, osx-arm64, macos-latest, aarch64-apple-darwin, dmg updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-aarch64-pc-windows-msvc.exe, win-arm64, windows-latest, aarch64-pc-windows-msvc, nsis updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-x86_64-apple-darwin, osx-x64, macos-latest, x86_64-apple-darwin, dmg updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-x86_64-pc-windows-msvc.exe, win-x64, windows-latest, x86_64-pc-windows-msvc, nsis updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-x86_64-unknown-linux-gnu, linux-x64, ubuntu-22.04, x86_64-unknown-linux-gnu, appimage deb updater) (push) Blocked by required conditions
Build and Release / Build app (linux-arm64) (push) Blocked by required conditions
Build and Release / Prepare & create release (push) Blocked by required conditions
Build and Release / Publish release (push) Blocked by required conditions

This commit is contained in:
Thorsten Sommer authored and GitHub committed 2025-03-29 18:40:17 +01:00
1 parent 3f8f399cd9
commit b632854cd4
36 files changed
+705 -233

No files matched your search

@@ -0,0 +1,74 @@
namespace AIStudio.Tools.PluginSystem;
public interface IPluginMetadata
{
/// <summary>
/// The icon of this plugin.
/// </summary>
public string IconSVG { get; }
/// <summary>
/// The type of this plugin.
/// </summary>
public PluginType Type { get; }
/// <summary>
/// The ID of this plugin.
/// </summary>
public Guid Id { get; }
/// <summary>
/// The name of this plugin.
/// </summary>
public string Name { get; }
/// <summary>
/// The description of this plugin.
/// </summary>
public string Description { get; }
/// <summary>
/// The version of this plugin.
/// </summary>
public PluginVersion Version { get; }
/// <summary>
/// The authors of this plugin.
/// </summary>
public string[] Authors { get; }
/// <summary>
/// The support contact for this plugin.
/// </summary>
public string SupportContact { get; }
/// <summary>
/// The source URL of this plugin.
/// </summary>
public string SourceURL { get; }
/// <summary>
/// The categories of this plugin.
/// </summary>
public PluginCategory[] Categories { get; }
/// <summary>
/// The target groups of this plugin.
/// </summary>
public PluginTargetGroup[] TargetGroups { get; }
/// <summary>
/// True, when the plugin is maintained.
/// </summary>
public bool IsMaintained { get; }
/// <summary>
/// The message that should be displayed when the plugin is deprecated.
/// </summary>
public string DeprecationMessage { get; }
/// <summary>
/// True, when the plugin is AI Studio internal.
/// </summary>
public bool IsInternal { get; }
}
@@ -6,4 +6,4 @@ namespace AIStudio.Tools.PluginSystem;
/// Represents a plugin that could not be loaded.
/// </summary>
/// <param name="parsingError">The error message that occurred while parsing the plugin.</param>
public sealed class NoPlugin(string parsingError) : PluginBase(string.Empty, LuaState.Create(), PluginType.NONE, parsingError);
public sealed class NoPlugin(string parsingError) : PluginBase(false, LuaState.Create(), PluginType.NONE, parsingError);
@@ -0,0 +1,45 @@
namespace AIStudio.Tools.PluginSystem;
public abstract partial class PluginBase
{
private const string DEFAULT_ICON_SVG =
"""
<svg height="1.5em" width="1.5em" viewBox="0 0 24 24" fill="#1f1f1f"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M19 13h-2V7h-6V5c0-.28-.22-.5-.5-.5s-.5.22-.5.5v2H4l.01 2.12C5.76 9.8 7 11.51 7 13.5c0 1.99-1.25 3.7-3 4.38V20h2.12c.68-1.75 2.39-3 4.38-3 1.99 0 3.7 1.25 4.38 3H17v-6h2c.28 0 .5-.22.5-.5s-.22-.5-.5-.5z" opacity=".3"/><path d="M19 11V7c0-1.1-.9-2-2-2h-4c0-1.38-1.12-2.5-2.5-2.5S8 3.62 8 5H4c-1.1 0-1.99.9-1.99 2v3.8h.29c1.49 0 2.7 1.21 2.7 2.7s-1.21 2.7-2.7 2.7H2V20c0 1.1.9 2 2 2h3.8v-.3c0-1.49 1.21-2.7 2.7-2.7s2.7 1.21 2.7 2.7v.3H17c1.1 0 2-.9 2-2v-4c1.38 0 2.5-1.12 2.5-2.5S20.38 11 19 11zm0 3h-2v6h-2.12c-.68-1.75-2.39-3-4.38-3-1.99 0-3.7 1.25-4.38 3H4v-2.12c1.75-.68 3-2.39 3-4.38 0-1.99-1.24-3.7-2.99-4.38L4 7h6V5c0-.28.22-.5.5-.5s.5.22.5.5v2h6v6h2c.28 0 .5.22.5.5s-.22.5-.5.5z"/></svg>
""";
#region Initialization-related methods
/// <summary>
/// Tries to initialize the icon of the plugin.
/// </summary>
/// <remarks>
/// When no icon is specified, the default icon will be used.
/// </remarks>
/// <param name="message">The error message, when the icon could not be read.</param>
/// <param name="iconSVG">The read icon as SVG.</param>
/// <returns>True, when the icon could be read successfully.</returns>
// ReSharper disable once OutParameterValueIsAlwaysDiscarded.Local
// ReSharper disable once UnusedMethodReturnValue.Local
private bool TryInitIconSVG(out string message, out string iconSVG)
{
if (!this.state.Environment["ICON_SVG"].TryRead(out iconSVG))
{
iconSVG = DEFAULT_ICON_SVG;
message = "The field ICON_SVG does not exist or is not a valid string.";
return true;
}
if (string.IsNullOrWhiteSpace(iconSVG))
{
iconSVG = DEFAULT_ICON_SVG;
message = "The field ICON_SVG is empty. The icon must be a non-empty string.";
return true;
}
message = string.Empty;
return true;
}
#endregion
}
@@ -1,5 +1,4 @@
using Lua;
using Lua.Standard;
// ReSharper disable MemberCanBePrivate.Global
namespace AIStudio.Tools.PluginSystem;
@@ -7,73 +6,55 @@ namespace AIStudio.Tools.PluginSystem;
/// <summary>
/// Represents the base of any AI Studio plugin.
/// </summary>
public abstract class PluginBase
public abstract partial class PluginBase : IPluginMetadata
{
private readonly IReadOnlyCollection<string> baseIssues;
protected readonly LuaState state;
protected readonly List<string> pluginIssues = [];
/// <inheritdoc />
public string IconSVG { get; }
/// <summary>
/// The type of this plugin.
/// </summary>
/// <inheritdoc />
public PluginType Type { get; }
/// <summary>
/// The ID of this plugin.
/// </summary>
/// <inheritdoc />
public Guid Id { get; }
/// <summary>
/// The name of this plugin.
/// </summary>
/// <inheritdoc />
public string Name { get; } = string.Empty;
/// <summary>
/// The description of this plugin.
/// </summary>
/// <inheritdoc />
public string Description { get; } = string.Empty;
/// <summary>
/// The version of this plugin.
/// </summary>
/// <inheritdoc />
public PluginVersion Version { get; }
/// <summary>
/// The authors of this plugin.
/// </summary>
/// <inheritdoc />
public string[] Authors { get; } = [];
/// <summary>
/// The support contact for this plugin.
/// </summary>
/// <inheritdoc />
public string SupportContact { get; } = string.Empty;
/// <summary>
/// The source URL of this plugin.
/// </summary>
/// <inheritdoc />
public string SourceURL { get; } = string.Empty;
/// <summary>
/// The categories of this plugin.
/// </summary>
/// <inheritdoc />
public PluginCategory[] Categories { get; } = [];
/// <summary>
/// The target groups of this plugin.
/// </summary>
/// <inheritdoc />
public PluginTargetGroup[] TargetGroups { get; } = [];
/// <summary>
/// True, when the plugin is maintained.
/// </summary>
/// <inheritdoc />
public bool IsMaintained { get; }
/// <summary>
/// The message that should be displayed when the plugin is deprecated.
/// </summary>
public string? DeprecationMessage { get; }
/// <inheritdoc />
public string DeprecationMessage { get; } = string.Empty;
/// <inheritdoc />
public bool IsInternal { get; }
/// <summary>
/// The issues that occurred during the initialization of this plugin.
/// </summary>
@@ -88,31 +69,24 @@ public abstract class PluginBase
/// </remarks>
public bool IsValid => this is not NoPlugin && this.baseIssues.Count == 0 && this.pluginIssues.Count == 0;
protected PluginBase(string path, LuaState state, PluginType type, string parseError = "")
protected PluginBase(bool isInternal, LuaState state, PluginType type, string parseError = "")
{
this.state = state;
this.Type = type;
// For security reasons, we don't want to allow the plugin to load modules:
this.state.ModuleLoader = new NoModuleLoader();
// Add some useful libraries:
this.state.OpenModuleLibrary();
this.state.OpenStringLibrary();
this.state.OpenTableLibrary();
this.state.OpenMathLibrary();
this.state.OpenBitwiseLibrary();
this.state.OpenCoroutineLibrary();
// Add the module loader so that the plugin can load other Lua modules:
this.state.ModuleLoader = new PluginLoader(path);
var issues = new List<string>();
if(!string.IsNullOrWhiteSpace(parseError))
issues.Add(parseError);
// Notice: when no icon is specified, the default icon will be used.
this.TryInitIconSVG(out _, out var iconSVG);
this.IconSVG = iconSVG;
if(this.TryInitId(out var issue, out var id))
{
this.Id = id;
this.IsInternal = isInternal;
}
else if(this is not NoPlugin)
issues.Add(issue);
@@ -456,19 +430,19 @@ public abstract class PluginBase
/// <param name="message">The error message, when the deprecation message could not be read.</param>
/// <param name="deprecationMessage">The read deprecation message.</param>
/// <returns>True, when the deprecation message could be read successfully.</returns>
private bool TryInitDeprecationMessage(out string message, out string? deprecationMessage)
private bool TryInitDeprecationMessage(out string message, out string deprecationMessage)
{
if (!this.state.Environment["DEPRECATION_MESSAGE"].TryRead(out deprecationMessage))
{
deprecationMessage = null;
message = "The field DEPRECATION_MESSAGE does not exist, is not a valid string. This field is optional: use nil to indicate that the plugin is not deprecated.";
deprecationMessage = string.Empty;
message = "The field DEPRECATION_MESSAGE does not exist, is not a valid string. This message is optional: use an empty string to indicate that the plugin is not deprecated.";
return false;
}
message = string.Empty;
return true;
}
/// <summary>
/// Tries to initialize the UI text content of the plugin.
/// </summary>
@@ -0,0 +1,79 @@
using System.Reflection;
using Microsoft.Extensions.FileProviders;
namespace AIStudio.Tools.PluginSystem;
public static partial class PluginFactory
{
public static async Task EnsureInternalPlugins()
{
LOG.LogInformation("Start ensuring internal plugins.");
foreach (var plugin in Enum.GetValues<InternalPlugin>())
{
LOG.LogInformation($"Ensure plugin: {plugin}");
await EnsurePlugin(plugin);
}
}
private static async Task EnsurePlugin(InternalPlugin plugin)
{
try
{
#if DEBUG
var basePath = Path.Join(Environment.CurrentDirectory, "Plugins");
var resourceFileProvider = new PhysicalFileProvider(basePath);
#else
var resourceFileProvider = new ManifestEmbeddedFileProvider(Assembly.GetAssembly(type: typeof(Program))!, "Plugins");
#endif
var metaData = plugin.MetaData();
var mainResourcePath = $"{metaData.ResourcePath}/plugin.lua";
var resourceInfo = resourceFileProvider.GetFileInfo(mainResourcePath);
if(!resourceInfo.Exists)
{
LOG.LogError($"The plugin {plugin} does not exist. This should not happen, since the plugin is an integral part of AI Studio.");
return;
}
// Ensure that the additional resources exist:
foreach (var content in resourceFileProvider.GetDirectoryContents(metaData.ResourcePath))
{
if(content.IsDirectory)
{
LOG.LogError("The plugin contains a directory. This is not allowed.");
continue;
}
await CopyInternalPluginFile(content, metaData);
}
}
catch
{
LOG.LogError($"Was not able to ensure the plugin: {plugin}");
}
}
private static async Task CopyInternalPluginFile(IFileInfo resourceInfo, InternalPluginData metaData)
{
await using var inputStream = resourceInfo.CreateReadStream();
var pluginTypeBasePath = Path.Join(INTERNAL_PLUGINS_ROOT, metaData.Type.GetDirectory());
if (!Directory.Exists(INTERNAL_PLUGINS_ROOT))
Directory.CreateDirectory(INTERNAL_PLUGINS_ROOT);
if (!Directory.Exists(pluginTypeBasePath))
Directory.CreateDirectory(pluginTypeBasePath);
var pluginPath = Path.Join(pluginTypeBasePath, metaData.ResourceName);
if (!Directory.Exists(pluginPath))
Directory.CreateDirectory(pluginPath);
var pluginFilePath = Path.Join(pluginPath, resourceInfo.Name);
await using var outputStream = File.Create(pluginFilePath);
await inputStream.CopyToAsync(outputStream);
}
}
@@ -1,101 +1,110 @@
using System.Reflection;
using System.Text;
using AIStudio.Settings;
using Lua;
using Microsoft.Extensions.FileProviders;
using Lua.Standard;
namespace AIStudio.Tools.PluginSystem;
public static class PluginFactory
public static partial class PluginFactory
{
private static readonly ILogger LOG = Program.LOGGER_FACTORY.CreateLogger("PluginFactory");
private static readonly string DATA_DIR = SettingsManager.DataDirectory!;
public static async Task EnsureInternalPlugins()
{
LOG.LogInformation("Start ensuring internal plugins.");
foreach (var plugin in Enum.GetValues<InternalPlugin>())
{
LOG.LogInformation($"Ensure plugin: {plugin}");
await EnsurePlugin(plugin);
}
}
private static readonly string PLUGINS_ROOT = Path.Join(DATA_DIR, "plugins");
private static async Task EnsurePlugin(InternalPlugin plugin)
private static readonly string INTERNAL_PLUGINS_ROOT = Path.Join(PLUGINS_ROOT, ".internal");
private static readonly List<IPluginMetadata> AVAILABLE_PLUGINS = [];
/// <summary>
/// A list of all available plugins.
/// </summary>
public static IReadOnlyCollection<IPluginMetadata> AvailablePlugins => AVAILABLE_PLUGINS;
/// <summary>
/// Try to load all plugins from the plugins directory.
/// </summary>
/// <remarks>
/// Loading plugins means:<br/>
/// - Parsing and checking the plugin code<br/>
/// - Check for forbidden plugins<br/>
/// - Creating a new instance of the allowed plugin<br/>
/// - Read the plugin metadata<br/>
/// <br/>
/// Loading a plugin does not mean to start the plugin, though.
/// </remarks>
public static async Task LoadAll(CancellationToken cancellationToken = default)
{
try
LOG.LogInformation("Start loading plugins.");
if (!Directory.Exists(PLUGINS_ROOT))
{
#if DEBUG
var basePath = Path.Join(Environment.CurrentDirectory, "Plugins");
var resourceFileProvider = new PhysicalFileProvider(basePath);
#else
var resourceFileProvider = new ManifestEmbeddedFileProvider(Assembly.GetAssembly(type: typeof(Program))!, "Plugins");
#endif
LOG.LogInformation("No plugins found.");
return;
}
//
// The easiest way to load all plugins is to find all `plugin.lua` files and load them.
// By convention, each plugin is enforced to have a `plugin.lua` file.
//
var pluginMainFiles = Directory.EnumerateFiles(PLUGINS_ROOT, "plugin.lua", SearchOption.AllDirectories);
foreach (var pluginMainFile in pluginMainFiles)
{
if (cancellationToken.IsCancellationRequested)
break;
var metaData = plugin.MetaData();
var mainResourcePath = $"{metaData.ResourcePath}/plugin.lua";
var resourceInfo = resourceFileProvider.GetFileInfo(mainResourcePath);
LOG.LogInformation($"Try to load plugin: {pluginMainFile}");
var code = await File.ReadAllTextAsync(pluginMainFile, Encoding.UTF8, cancellationToken);
var pluginPath = Path.GetDirectoryName(pluginMainFile)!;
var plugin = await Load(pluginPath, code, cancellationToken);
if(!resourceInfo.Exists)
switch (plugin)
{
LOG.LogError($"The plugin {plugin} does not exist. This should not happen, since the plugin is an integral part of AI Studio.");
return;
}
// Ensure that the additional resources exist:
foreach (var content in resourceFileProvider.GetDirectoryContents(metaData.ResourcePath))
{
if(content.IsDirectory)
{
LOG.LogError("The plugin contains a directory. This is not allowed.");
case NoPlugin noPlugin when noPlugin.Issues.Any():
LOG.LogError($"Was not able to load plugin: '{pluginMainFile}'. Reason: {noPlugin.Issues.First()}");
continue;
}
await CopyPluginFile(content, metaData);
case NoPlugin:
LOG.LogError($"Was not able to load plugin: '{pluginMainFile}'. Reason: Unknown.");
continue;
case { IsValid: false }:
LOG.LogError($"Was not able to load plugin '{pluginMainFile}', because the Lua code is not a valid AI Studio plugin. There are {plugin.Issues.Count()} issues to fix.");
#if DEBUG
foreach (var pluginIssue in plugin.Issues)
LOG.LogError($"Plugin issue: {pluginIssue}");
#endif
continue;
case { IsMaintained: false }:
LOG.LogWarning($"The plugin '{pluginMainFile}' is not maintained anymore. Please consider to disable it.");
break;
}
}
catch
{
LOG.LogError($"Was not able to ensure the plugin: {plugin}");
}
}
private static async Task CopyPluginFile(IFileInfo resourceInfo, InternalPluginData metaData)
{
await using var inputStream = resourceInfo.CreateReadStream();
var pluginsRoot = Path.Join(DATA_DIR, "plugins");
var pluginTypeBasePath = Path.Join(pluginsRoot, metaData.Type.GetDirectory());
if (!Directory.Exists(pluginsRoot))
Directory.CreateDirectory(pluginsRoot);
if (!Directory.Exists(pluginTypeBasePath))
Directory.CreateDirectory(pluginTypeBasePath);
var pluginPath = Path.Join(pluginTypeBasePath, metaData.ResourceName);
if (!Directory.Exists(pluginPath))
Directory.CreateDirectory(pluginPath);
var pluginFilePath = Path.Join(pluginPath, resourceInfo.Name);
await using var outputStream = File.Create(pluginFilePath);
await inputStream.CopyToAsync(outputStream);
LOG.LogInformation($"Successfully loaded plugin: '{pluginMainFile}' (Id='{plugin.Id}', Type='{plugin.Type}', Name='{plugin.Name}', Version='{plugin.Version}', Authors='{string.Join(", ", plugin.Authors)}')");
AVAILABLE_PLUGINS.Add(new PluginMetadata(plugin));
}
}
public static async Task LoadAll()
{
}
public static async Task<PluginBase> Load(string path, string code, CancellationToken cancellationToken = default)
private static async Task<PluginBase> Load(string pluginPath, string code, CancellationToken cancellationToken = default)
{
if(ForbiddenPlugins.Check(code) is { IsForbidden: true } forbiddenState)
return new NoPlugin($"This plugin is forbidden: {forbiddenState.Message}");
var state = LuaState.Create();
// Add the module loader so that the plugin can load other Lua modules:
state.ModuleLoader = new PluginLoader(pluginPath);
// Add some useful libraries:
state.OpenModuleLibrary();
state.OpenStringLibrary();
state.OpenTableLibrary();
state.OpenMathLibrary();
state.OpenBitwiseLibrary();
state.OpenCoroutineLibrary();
try
{
@@ -105,6 +114,10 @@ public static class PluginFactory
{
return new NoPlugin($"Was not able to parse the plugin: {e.Message}");
}
catch (LuaRuntimeException e)
{
return new NoPlugin($"Was not able to run the plugin: {e.Message}");
}
if (!state.Environment["TYPE"].TryRead<string>(out var typeText))
return new NoPlugin("TYPE does not exist or is not a valid string.");
@@ -115,9 +128,10 @@ public static class PluginFactory
if(type is PluginType.NONE)
return new NoPlugin($"TYPE is not a valid plugin type. Valid types are: {CommonTools.GetAllEnumValues<PluginType>()}");
var isInternal = pluginPath.StartsWith(INTERNAL_PLUGINS_ROOT, StringComparison.OrdinalIgnoreCase);
return type switch
{
PluginType.LANGUAGE => new PluginLanguage(path, state, type),
PluginType.LANGUAGE => new PluginLanguage(isInternal, state, type),
_ => new NoPlugin("This plugin type is not supported yet. Please try again with a future version of AI Studio.")
};
@@ -8,7 +8,7 @@ public sealed class PluginLanguage : PluginBase, ILanguagePlugin
private ILanguagePlugin? baseLanguage;
public PluginLanguage(string path, LuaState state, PluginType type) : base(path, state, type)
public PluginLanguage(bool isInternal, LuaState state, PluginType type) : base(isInternal, state, type)
{
if (this.TryInitUITextContent(out var issue, out var readContent))
this.content = readContent;
@@ -0,0 +1,50 @@
namespace AIStudio.Tools.PluginSystem;
public sealed class PluginMetadata(PluginBase plugin) : IPluginMetadata
{
#region Implementation of IPluginMetadata
/// <inheritdoc />
public string IconSVG { get; } = plugin.IconSVG;
/// <inheritdoc />
public PluginType Type { get; } = plugin.Type;
/// <inheritdoc />
public Guid Id { get; } = plugin.Id;
/// <inheritdoc />
public string Name { get; } = plugin.Name;
/// <inheritdoc />
public string Description { get; } = plugin.Description;
/// <inheritdoc />
public PluginVersion Version { get; } = plugin.Version;
/// <inheritdoc />
public string[] Authors { get; } = plugin.Authors;
/// <inheritdoc />
public string SupportContact { get; } = plugin.SupportContact;
/// <inheritdoc />
public string SourceURL { get; } = plugin.SourceURL;
/// <inheritdoc />
public PluginCategory[] Categories { get; } = plugin.Categories;
/// <inheritdoc />
public PluginTargetGroup[] TargetGroups { get; } = plugin.TargetGroups;
/// <inheritdoc />
public bool IsMaintained { get; } = plugin.IsMaintained;
/// <inheritdoc />
public string DeprecationMessage { get; } = plugin.DeprecationMessage;
/// <inheritdoc />
public bool IsInternal { get; } = plugin.IsInternal;
#endregion
}