Add plugin system

app/MindWork AI Studio/Layout/MainLayout.razor.cs

@@ -1,6 +1,7 @@
 using AIStudio.Dialogs;
 using AIStudio.Settings;
 using AIStudio.Settings.DataModel;
+using AIStudio.Tools.PluginSystem;
 using AIStudio.Tools.Rust;
 using AIStudio.Tools.Services;
 
@@ -81,6 +82,9 @@ protected override async Task OnInitializedAsync()
         // Ensure that all settings are loaded:
         await this.SettingsManager.LoadSettings();
 
+        // Ensure that all internal plugins are present:
+        await PluginFactory.EnsureInternalPlugins();
+
         // Register this component with the message bus:
         this.MessageBus.RegisterComponent(this);
         this.MessageBus.ApplyFilters(this, [], [ Event.UPDATE_AVAILABLE, Event.USER_SEARCH_FOR_UPDATE, Event.CONFIGURATION_CHANGED, Event.COLOR_THEME_CHANGED ]);

app/MindWork AI Studio/MindWork AI Studio.csproj

@@ -41,8 +41,8 @@
     </ItemGroup>
 
     <ItemGroup>
-        <!-- Embed all files in wwwroot folder -->
         <EmbeddedResource Include="wwwroot\**" CopyToOutputDirectory="PreserveNewest" />
+        <EmbeddedResource Include="Plugins\**" CopyToOutputDirectory="PreserveNewest" />
     </ItemGroup>
 
     <ItemGroup>
@@ -52,6 +52,7 @@
       <PackageReference Include="MudBlazor" Version="8.4.0" />
       <PackageReference Include="MudBlazor.Markdown" Version="8.0.0" />
       <PackageReference Include="ReverseMarkdown" Version="4.6.0" />
+      <PackageReference Include="LuaCSharp" Version="0.4.2" />
     </ItemGroup>
 
     <ItemGroup>

app/MindWork AI Studio/Pages/About.razor

@@ -108,6 +108,7 @@
                     <ThirdPartyComponent Name="base64" Developer="Marshall Pierce, Alice Maz & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/marshallpierce/rust-base64/blob/master/LICENSE-MIT" RepositoryUrl="https://github.com/marshallpierce/rust-base64" UseCase="For some data transfers, we need to encode the data in base64. This Rust library is great for this purpose."/>
                     <ThirdPartyComponent Name="Rust Crypto" Developer="Artyom Pavlov, Tony Arcieri, Brian Warner, Arthur Gautier, Vlad Filippov, Friedel Ziegelmayer, Nicolas Stalder & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/RustCrypto/traits/blob/master/cipher/LICENSE-MIT" RepositoryUrl="https://github.com/RustCrypto" UseCase="When transferring sensitive data between Rust runtime and .NET app, we encrypt the data. We use some libraries from the Rust Crypto project for this purpose: cipher, aes, cbc, pbkdf2, hmac, and sha2. We are thankful for the great work of the Rust Crypto project."/>
                     <ThirdPartyComponent Name="rcgen" Developer="RustTLS developers, est31 & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/rustls/rcgen/blob/main/LICENSE" RepositoryUrl="https://github.com/rustls/rcgen" UseCase="For the secure communication between the user interface and the runtime, we need to create certificates. This Rust library is great for this purpose."/>
+                    <ThirdPartyComponent Name="Lua-CSharp" Developer="Yusuke Nakada & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/nuskey8/Lua-CSharp/blob/main/LICENSE" RepositoryUrl="https://github.com/nuskey8/Lua-CSharp" UseCase="We use Lua as the language for plugins. Lua-CSharp lets Lua scripts communicate with AI Studio and vice versa. Thank you, Yusuke Nakada, for this great library." />
                     <ThirdPartyComponent Name="HtmlAgilityPack" Developer="ZZZ Projects & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/zzzprojects/html-agility-pack/blob/master/LICENSE" RepositoryUrl="https://github.com/zzzprojects/html-agility-pack" UseCase="We use the HtmlAgilityPack to extract content from the web. This is necessary, e.g., when you provide a URL as input for an assistant."/>
                     <ThirdPartyComponent Name="ReverseMarkdown" Developer="Babu Annamalai & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/mysticmind/reversemarkdown-net/blob/master/LICENSE" RepositoryUrl="https://github.com/mysticmind/reversemarkdown-net" UseCase="This library is used to convert HTML to Markdown. This is necessary, e.g., when you provide a URL as input for an assistant."/>
                     <ThirdPartyComponent Name="wikEd diff" Developer="Cacycle & Open Source Community" LicenseName="None (public domain)" LicenseUrl="https://en.wikipedia.org/wiki/User:Cacycle/diff#License" RepositoryUrl="https://en.wikipedia.org/wiki/User:Cacycle/diff" UseCase="This library is used to display the differences between two texts. This is necessary, e.g., for the grammar and spelling assistant."/>

app/MindWork AI Studio/Plugins/languages/de-de-43065dbc-78d0-45b7-92be-f14c2926e2dc/contentHome.lua

@@ -0,0 +1,3 @@
+CONTENT_HOME = {
+	LetsGetStarted = "Lass uns anfangen",
+}

app/MindWork AI Studio/Plugins/languages/de-de-43065dbc-78d0-45b7-92be-f14c2926e2dc/plugin.lua

@@ -0,0 +1,39 @@
+-- The ID for this plugin:
+ID = "43065dbc-78d0-45b7-92be-f14c2926e2dc"
+
+-- The name of the plugin:
+NAME = "MindWork AI Studio - German / Deutsch"
+
+-- The description of the plugin:
+DESCRIPTION = "Dieses Plugin bietet deutsche Sprachunterstützung für MindWork AI Studio."
+
+-- The version of the plugin:
+VERSION = "1.0.0"
+
+-- The type of the plugin:
+TYPE = "LANGUAGE"
+
+-- The authors of the plugin:
+AUTHORS = {"MindWork AI Community"}
+
+-- The support contact for the plugin:
+SUPPORT_CONTACT = "MindWork AI Community"
+
+-- The source URL for the plugin:
+SOURCE_URL = "https://github.com/MindWorkAI/AI-Studio"
+
+-- The categories for the plugin:
+CATEGORIES = { "CORE" }
+
+-- The target groups for the plugin:
+TARGET_GROUPS = { "EVERYONE" }
+
+-- The flag for whether the plugin is maintained:
+IS_MAINTAINED = true
+
+-- When the plugin is deprecated, this message will be shown to users:
+DEPRECATION_MESSAGE = nil
+
+UI_TEXT_CONTENT = {
+    HOME = CONTENT_HOME,
+}

app/MindWork AI Studio/Plugins/languages/en-us-97dfb1ba-50c4-4440-8dfa-6575daf543c8/contentHome.lua

@@ -0,0 +1,3 @@
+CONTENT_HOME = {
+	LetsGetStarted = "Let's get started",
+}

app/MindWork AI Studio/Plugins/languages/en-us-97dfb1ba-50c4-4440-8dfa-6575daf543c8/plugin.lua

@@ -0,0 +1,41 @@
+require("contentHome")
+
+-- The ID for this plugin:
+ID = "97dfb1ba-50c4-4440-8dfa-6575daf543c8"
+
+-- The name of the plugin:
+NAME = "MindWork AI Studio - US English"
+
+-- The description of the plugin:
+DESCRIPTION = "This plugin provides US English language support for MindWork AI Studio."
+
+-- The version of the plugin:
+VERSION = "1.0.0"
+
+-- The type of the plugin:
+TYPE = "LANGUAGE"
+
+-- The authors of the plugin:
+AUTHORS = {"MindWork AI Community"}
+
+-- The support contact for the plugin:
+SUPPORT_CONTACT = "MindWork AI Community"
+
+-- The source URL for the plugin:
+SOURCE_URL = "https://github.com/MindWorkAI/AI-Studio"
+
+-- The categories for the plugin:
+CATEGORIES = { "CORE" }
+
+-- The target groups for the plugin:
+TARGET_GROUPS = { "EVERYONE" }
+
+-- The flag for whether the plugin is maintained:
+IS_MAINTAINED = true
+
+-- When the plugin is deprecated, this message will be shown to users:
+DEPRECATION_MESSAGE = nil
+
+UI_TEXT_CONTENT = {
+    HOME = CONTENT_HOME,
+}

app/MindWork AI Studio/Program.cs

@@ -22,6 +22,7 @@ internal sealed class Program
     public static Encryption ENCRYPTION = null!;
     public static string API_TOKEN = null!;
     public static IServiceProvider SERVICE_PROVIDER = null!;
+    public static ILoggerFactory LOGGER_FACTORY = null!;
 
     public static async Task Main(string[] args)
     {
@@ -147,6 +148,9 @@ public static async Task Main(string[] args)
         // Execute the builder to get the app:
         var app = builder.Build();
 
+        // Get the logging factory for e.g., static classes:
+        LOGGER_FACTORY = app.Services.GetRequiredService<ILoggerFactory>();
+
         // Get a program logger:
         var programLogger = app.Services.GetRequiredService<ILogger<Program>>();
         programLogger.LogInformation("Starting the AI Studio server.");

app/MindWork AI Studio/Settings/DataModel/PreviewFeatures.cs

@@ -8,4 +8,6 @@ public enum PreviewFeatures
     //
     PRE_WRITER_MODE_2024,
     PRE_RAG_2024,
+
+    PRE_PLUGINS_2025,
 }

app/MindWork AI Studio/Settings/DataModel/PreviewFeaturesExtensions.cs

@@ -6,6 +6,7 @@ public static class PreviewFeaturesExtensions
     {
         PreviewFeatures.PRE_WRITER_MODE_2024 => "Writer Mode: Experiments about how to write long texts using AI",
         PreviewFeatures.PRE_RAG_2024 => "RAG: Preview of our RAG implementation where you can refer your files or integrate enterprise data within your company",
+        PreviewFeatures.PRE_PLUGINS_2025 => "Plugins: Preview of our plugin system where you can extend the functionality of the app",
 
         _ => "Unknown preview feature"
     };

app/MindWork AI Studio/Settings/DataModel/PreviewVisibilityExtensions.cs

@@ -25,6 +25,7 @@ public static IList<PreviewFeatures> GetPreviewFeatures(this PreviewVisibility v
         if (visibility >= PreviewVisibility.EXPERIMENTAL)
         {
             features.Add(PreviewFeatures.PRE_WRITER_MODE_2024);
+            features.Add(PreviewFeatures.PRE_PLUGINS_2025);
         }
 
         return features;

app/MindWork AI Studio/Tools/CommonTools.cs

@@ -0,0 +1,22 @@
+using System.Text;
+
+namespace AIStudio.Tools;
+
+public static class CommonTools
+{
+    /// <summary>
+    /// Get all the values (the names) of an enum as a string, separated by commas.
+    /// </summary>
+    /// <typeparam name="TEnum">The enum type to get the values of.</typeparam>
+    /// <param name="exceptions">The values to exclude from the result.</param>
+    /// <returns>The values of the enum as a string, separated by commas.</returns>
+    public static string GetAllEnumValues<TEnum>(params TEnum[] exceptions) where TEnum : struct, Enum
+    {
+        var sb = new StringBuilder();
+        foreach (var value in Enum.GetValues<TEnum>())
+            if(!exceptions.Contains(value))
+                sb.Append(value).Append(", ");
+
+        return sb.ToString();
+    }
+}

app/MindWork AI Studio/Tools/PluginSystem/ForbiddenPlugins.cs

@@ -0,0 +1,99 @@
+namespace AIStudio.Tools.PluginSystem;
+
+/// <summary>
+/// Checks if a plugin is forbidden.
+/// </summary>
+public static class ForbiddenPlugins
+{
+    private const string ID_PATTERN = "ID = \"";
+    private static readonly int ID_PATTERN_LEN = ID_PATTERN.Length;
+
+    /// <summary>
+    /// Checks if the given code represents a forbidden plugin.
+    /// </summary>
+    /// <param name="code">The code to check.</param>
+    /// <returns>The result of the check.</returns>
+    public static PluginCheckResult Check(ReadOnlySpan<char> code)
+    {
+        var endIndex = 0;
+        var foundAnyId = false;
+        var id = ReadOnlySpan<char>.Empty;
+        while (true)
+        {
+            // Create a slice of the code starting at the end index.
+            // This way we can search for all IDs in the code:
+            code = code[endIndex..];
+
+            // Read the next ID as a string:
+            if (!TryGetId(code, out id, out endIndex))
+            {
+                // When no ID was found at all, we block this plugin.
+                // When another ID was found previously, we allow this plugin.
+                if(foundAnyId)
+                    return new PluginCheckResult(false, null);
+
+                return new PluginCheckResult(true, "No ID was found.");
+            }
+
+            // Try to parse the ID as a GUID:
+            if (!Guid.TryParse(id, out var parsedGuid))
+            {
+                // Again, when no ID was found at all, we block this plugin.
+                if(foundAnyId)
+                    return new PluginCheckResult(false, null);
+
+                return new PluginCheckResult(true, "The ID is not a valid GUID.");
+            }
+
+            // Check if the GUID is forbidden:
+            if (FORBIDDEN_PLUGINS.TryGetValue(parsedGuid, out var reason))
+                return new PluginCheckResult(true, reason);
+
+            foundAnyId = true;
+        }
+    }
+
+    private static bool TryGetId(ReadOnlySpan<char> code, out ReadOnlySpan<char> id, out int endIndex)
+    {
+        //
+        // Please note: the code variable is a slice of the original code.
+        // That means the indices are relative to the slice, not the original code.
+        //
+
+        id = ReadOnlySpan<char>.Empty;
+        endIndex = 0;
+
+        // Find the next ID:
+        var idStartIndex = code.IndexOf(ID_PATTERN);
+        if (idStartIndex < 0)
+            return false;
+
+        // Find the start index of the value (Guid):
+        var valueStartIndex = idStartIndex + ID_PATTERN_LEN;
+
+        // Find the end index of the value. In order to do that,
+        // we create a slice of the code starting at the value
+        // start index. That means that the end index is relative
+        // to the inner slice, not the original code nor the outer slice.
+        var valueEndIndex = code[valueStartIndex..].IndexOf('"');
+        if (valueEndIndex < 0)
+            return false;
+
+        // From the perspective of the start index is the end index
+        // the length of the value:
+        endIndex = valueStartIndex + valueEndIndex;
+        id = code.Slice(valueStartIndex, valueEndIndex);
+        return true;
+    }
+
+    /// <summary>
+    /// The forbidden plugins.
+    /// </summary>
+    /// <remarks>
+    /// A dictionary that maps the GUID of a plugin to the reason why it is forbidden.
+    /// </remarks>
+    // ReSharper disable once CollectionNeverUpdated.Local
+    private static readonly Dictionary<Guid, string> FORBIDDEN_PLUGINS =
+    [
+    ];
+}

app/MindWork AI Studio/Tools/PluginSystem/ILanguagePlugin.cs

@@ -0,0 +1,21 @@
+namespace AIStudio.Tools.PluginSystem;
+
+/// <summary>
+/// Represents a contract for a language plugin.
+/// </summary>
+public interface ILanguagePlugin
+{
+    /// <summary>
+    /// Tries to get a text from the language plugin.
+    /// </summary>
+    /// <remarks>
+    /// When the key does not exist, the value will be an empty string.
+    /// Please note that the key is case-sensitive. Furthermore, the keys
+    /// are in the format "root::key". That means that the keys are
+    /// hierarchical and separated by "::".
+    /// </remarks>
+    /// <param name="key">The key to use to get the text.</param>
+    /// <param name="value">The desired text.</param>
+    /// <returns>True if the key exists, false otherwise.</returns>
+    public bool TryGetText(string key, out string value);
+}

app/MindWork AI Studio/Tools/PluginSystem/InternalPlugin.cs

@@ -0,0 +1,7 @@
+namespace AIStudio.Tools.PluginSystem;
+
+public enum InternalPlugin
+{
+    LANGUAGE_EN_US,
+    LANGUAGE_DE_DE,
+}

app/MindWork AI Studio/Tools/PluginSystem/InternalPluginData.cs

@@ -0,0 +1,8 @@
+namespace AIStudio.Tools.PluginSystem;
+
+public readonly record struct InternalPluginData(PluginType Type, Guid Id, string ShortName)
+{
+    public string ResourcePath => $"{this.Type.GetDirectory()}/{this.ShortName.ToLowerInvariant()}-{this.Id}";
+
+    public string ResourceName => $"{this.ShortName.ToLowerInvariant()}-{this.Id}";
+}

app/MindWork AI Studio/Tools/PluginSystem/InternalPluginExtensions.cs

@@ -0,0 +1,12 @@
+namespace AIStudio.Tools.PluginSystem;
+
+public static class InternalPluginExtensions
+{
+    public static InternalPluginData MetaData(this InternalPlugin plugin) => plugin switch
+    {
+        InternalPlugin.LANGUAGE_EN_US => new (PluginType.LANGUAGE, new("97dfb1ba-50c4-4440-8dfa-6575daf543c8"), "en-us"),
+        InternalPlugin.LANGUAGE_DE_DE => new(PluginType.LANGUAGE, new("43065dbc-78d0-45b7-92be-f14c2926e2dc"), "de-de"),
+
+        _ => new InternalPluginData(PluginType.NONE, Guid.Empty, "unknown")
+    };
+}

app/MindWork AI Studio/Tools/PluginSystem/NoModuleLoader.cs

@@ -0,0 +1,20 @@
+using Lua;
+
+namespace AIStudio.Tools.PluginSystem;
+
+/// <summary>
+/// This Lua module loader does not load any modules.
+/// </summary>
+public sealed class NoModuleLoader : ILuaModuleLoader
+{
+    #region Implementation of ILuaModuleLoader
+
+    public bool Exists(string moduleName) => false;
+
+    public ValueTask<LuaModule> LoadAsync(string moduleName, CancellationToken cancellationToken = default)
+    {
+        return ValueTask.FromResult(new LuaModule());
+    }
+
+    #endregion
+}