diff --git a/app/MindWork AI Studio/Assistants/I18N/allTexts.lua b/app/MindWork AI Studio/Assistants/I18N/allTexts.lua index c94b4b7a..f0e307e8 100644 --- a/app/MindWork AI Studio/Assistants/I18N/allTexts.lua +++ b/app/MindWork AI Studio/Assistants/I18N/allTexts.lua @@ -2002,6 +2002,24 @@ UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANAGEPANDOCDEPENDENCY::T527187983"] = "C -- Install Pandoc UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANAGEPANDOCDEPENDENCY::T986578435"] = "Install Pandoc" +-- Version +UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANDATORYINFODISPLAY::T1573770551"] = "Version" + +-- This mandatory info has not been accepted yet. +UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANDATORYINFODISPLAY::T1870532312"] = "This mandatory info has not been accepted yet." + +-- Accepted version +UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANDATORYINFODISPLAY::T203086476"] = "Accepted version" + +-- The current version has not been accepted yet. +UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANDATORYINFODISPLAY::T2158667957"] = "The current version has not been accepted yet." + +-- Last accepted version +UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANDATORYINFODISPLAY::T3407978086"] = "Last accepted version" + +-- Accepted at (UTC) +UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MANDATORYINFODISPLAY::T3511160492"] = "Accepted at (UTC)" + -- Given that my employer's workplace uses both Windows and Linux, I wanted a cross-platform solution that would work seamlessly across all major operating systems, including macOS. Additionally, I wanted to demonstrate that it is possible to create modern, efficient, cross-platform applications without resorting to Electron bloatware. The combination of .NET and Rust with Tauri proved to be an excellent technology stack for building such robust applications. UI_TEXT_CONTENT["AISTUDIO::COMPONENTS::MOTIVATION::T1057189794"] = "Given that my employer's workplace uses both Windows and Linux, I wanted a cross-platform solution that would work seamlessly across all major operating systems, including macOS. Additionally, I wanted to demonstrate that it is possible to create modern, efficient, cross-platform applications without resorting to Electron bloatware. The combination of .NET and Rust with Tauri proved to be an excellent technology stack for building such robust applications." @@ -4696,6 +4714,12 @@ UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T13933 -- Preselect aspects for the LLM to focus on when generating slides, such as bullet points or specific topics to emphasize. UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T1528169602"] = "Preselect aspects for the LLM to focus on when generating slides, such as bullet points or specific topics to emphasize." +-- Slide Planner Assistant options are preselected +UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T1549358578"] = "Slide Planner Assistant options are preselected" + +-- No Slide Planner Assistant options are preselected +UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T1694374279"] = "No Slide Planner Assistant options are preselected" + -- Choose whether the assistant should use the app default profile, no profile, or a specific profile. UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T1766361623"] = "Choose whether the assistant should use the app default profile, no profile, or a specific profile." @@ -4705,9 +4729,6 @@ UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T20146 -- Which audience organizational level should be preselected? UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T216511105"] = "Which audience organizational level should be preselected?" --- Preselect Slide Planner Assistant options? -UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T227645894"] = "Preselect Slide Planner Assistant options?" - -- Preselect a profile UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T2322771068"] = "Preselect a profile" @@ -4724,26 +4745,23 @@ UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T25714 UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T2645589441"] = "Preselect the audience age group" -- Assistant: Slide Planner Assistant Options -UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T3215549988"] = "Assistant: Slide Planner Assistant Options" +UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T3226042276"] = "Assistant: Slide Planner Assistant Options" -- Which audience expertise should be preselected? UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T3228597992"] = "Which audience expertise should be preselected?" +-- Preselect Slide Planner Assistant options? +UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T339924858"] = "Preselect Slide Planner Assistant options?" + -- Close UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T3448155331"] = "Close" -- Preselect important aspects UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T3705987833"] = "Preselect important aspects" --- No Slide Planner Assistant options are preselected -UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T4214398691"] = "No Slide Planner Assistant options are preselected" - -- Preselect the audience profile UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T861397972"] = "Preselect the audience profile" --- Slide Planner Assistant options are preselected -UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T93124146"] = "Slide Planner Assistant options are preselected" - -- Which audience age group should be preselected? UI_TEXT_CONTENT["AISTUDIO::DIALOGS::SETTINGS::SETTINGSDIALOGSLIDEBUILDER::T956845877"] = "Which audience age group should be preselected?" @@ -5404,6 +5422,9 @@ UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T1137744461"] = "ID mismatch: the -- This is a private AI Studio installation. It runs without an enterprise configuration. UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T1209549230"] = "This is a private AI Studio installation. It runs without an enterprise configuration." +-- Unknown configuration plugin +UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T1290340974"] = "Unknown configuration plugin" + -- This library is used to read PDF files. This is necessary, e.g., for using PDFs as a data source for a chat. UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T1388816916"] = "This library is used to read PDF files. This is necessary, e.g., for using PDFs as a data source for a chat." @@ -5653,6 +5674,9 @@ UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T788846912"] = "Copies the config -- installed by AI Studio UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T833849470"] = "installed by AI Studio" +-- Provided by configuration plugin: {0} +UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T836298648"] = "Provided by configuration plugin: {0}" + -- We use this library to be able to read PowerPoint files. This allows us to insert content from slides into prompts and take PowerPoint files into account in RAG processes. We thank Nils Kruthoff for his work on this Rust crate. UI_TEXT_CONTENT["AISTUDIO::PAGES::INFORMATION::T855925638"] = "We use this library to be able to read PowerPoint files. This allows us to insert content from slides into prompts and take PowerPoint files into account in RAG processes. We thank Nils Kruthoff for his work on this Rust crate." diff --git a/app/MindWork AI Studio/Components/MandatoryInfoDisplay.razor b/app/MindWork AI Studio/Components/MandatoryInfoDisplay.razor new file mode 100644 index 00000000..ac671347 --- /dev/null +++ b/app/MindWork AI Studio/Components/MandatoryInfoDisplay.razor @@ -0,0 +1,42 @@ +@inherits MSGComponentBase + + + @if (this.ShowTitle) + { + @this.Info.Title + } + + + @T("Version"): @this.Info.VersionText + + + @if (this.ShowAcceptanceMetadata) + { + @if (this.Acceptance is null) + { + + @T("This mandatory info has not been accepted yet.") + + } + else if (!string.Equals(this.Acceptance.AcceptedVersion, this.Info.VersionText, StringComparison.Ordinal)) + { + + @T("The current version has not been accepted yet.") +
+ @T("Last accepted version"): @this.Acceptance.AcceptedVersion +
+ @T("Accepted at (UTC)"): @this.Acceptance.AcceptedAtUtc.UtcDateTime.ToString("u") +
+ } + else + { + + @T("Accepted version"): @this.Acceptance.AcceptedVersion +
+ @T("Accepted at (UTC)"): @this.Acceptance.AcceptedAtUtc.UtcDateTime.ToString("u") +
+ } + } + + +
\ No newline at end of file diff --git a/app/MindWork AI Studio/Components/MandatoryInfoDisplay.razor.cs b/app/MindWork AI Studio/Components/MandatoryInfoDisplay.razor.cs new file mode 100644 index 00000000..f2ac014c --- /dev/null +++ b/app/MindWork AI Studio/Components/MandatoryInfoDisplay.razor.cs @@ -0,0 +1,20 @@ +using AIStudio.Settings.DataModel; + +using Microsoft.AspNetCore.Components; + +namespace AIStudio.Components; + +public partial class MandatoryInfoDisplay +{ + [Parameter] + public DataMandatoryInfo Info { get; set; } = new(); + + [Parameter] + public DataMandatoryInfoAcceptance? Acceptance { get; set; } + + [Parameter] + public bool ShowTitle { get; set; } = true; + + [Parameter] + public bool ShowAcceptanceMetadata { get; set; } +} \ No newline at end of file diff --git a/app/MindWork AI Studio/Dialogs/DialogOptions.cs b/app/MindWork AI Studio/Dialogs/DialogOptions.cs index 0f8e97f4..eda95245 100644 --- a/app/MindWork AI Studio/Dialogs/DialogOptions.cs +++ b/app/MindWork AI Studio/Dialogs/DialogOptions.cs @@ -14,4 +14,10 @@ public static class DialogOptions CloseOnEscapeKey = true, FullWidth = true, MaxWidth = MaxWidth.Medium, }; + + public static readonly MudBlazor.DialogOptions BLOCKING_FULLSCREEN = new() + { + BackdropClick = false, + CloseOnEscapeKey = false, + }; } \ No newline at end of file diff --git a/app/MindWork AI Studio/Dialogs/MandatoryInfoDialog.razor b/app/MindWork AI Studio/Dialogs/MandatoryInfoDialog.razor new file mode 100644 index 00000000..1319e907 --- /dev/null +++ b/app/MindWork AI Studio/Dialogs/MandatoryInfoDialog.razor @@ -0,0 +1,25 @@ +@inherits MSGComponentBase + + + +
+ +
+
+ + + + @this.Info.RejectButtonText + + + @this.Info.AcceptButtonText + + + +
\ No newline at end of file diff --git a/app/MindWork AI Studio/Dialogs/MandatoryInfoDialog.razor.cs b/app/MindWork AI Studio/Dialogs/MandatoryInfoDialog.razor.cs new file mode 100644 index 00000000..4ed3451e --- /dev/null +++ b/app/MindWork AI Studio/Dialogs/MandatoryInfoDialog.razor.cs @@ -0,0 +1,19 @@ +using AIStudio.Components; +using AIStudio.Settings.DataModel; + +using Microsoft.AspNetCore.Components; + +namespace AIStudio.Dialogs; + +public partial class MandatoryInfoDialog : MSGComponentBase +{ + [CascadingParameter] + private IMudDialogInstance MudDialog { get; set; } = null!; + + [Parameter] + public DataMandatoryInfo Info { get; set; } = new(); + + private void Accept() => this.MudDialog.Close(DialogResult.Ok(true)); + + private void Reject() => this.MudDialog.Close(DialogResult.Ok(false)); +} \ No newline at end of file diff --git a/app/MindWork AI Studio/Layout/MainLayout.razor.cs b/app/MindWork AI Studio/Layout/MainLayout.razor.cs index 0fc41f7c..e4693070 100644 --- a/app/MindWork AI Studio/Layout/MainLayout.razor.cs +++ b/app/MindWork AI Studio/Layout/MainLayout.razor.cs @@ -53,6 +53,8 @@ public partial class MainLayout : LayoutComponentBase, IMessageBusReceiver, ILan private UpdateResponse? currentUpdateResponse; private MudThemeProvider themeProvider = null!; private bool useDarkMode; + private bool startupCompleted; + private readonly SemaphoreSlim mandatoryInfoDialogSemaphore = new(1, 1); private IReadOnlyCollection navItems = []; @@ -91,8 +93,8 @@ public partial class MainLayout : LayoutComponentBase, IMessageBusReceiver, ILan this.MessageBus.ApplyFilters(this, [], [ Event.UPDATE_AVAILABLE, Event.CONFIGURATION_CHANGED, Event.COLOR_THEME_CHANGED, Event.SHOW_ERROR, - Event.SHOW_ERROR, Event.SHOW_WARNING, Event.SHOW_SUCCESS, Event.STARTUP_PLUGIN_SYSTEM, - Event.PLUGINS_RELOADED, Event.INSTALL_UPDATE, + Event.SHOW_WARNING, Event.SHOW_SUCCESS, Event.STARTUP_PLUGIN_SYSTEM, Event.PLUGINS_RELOADED, + Event.INSTALL_UPDATE, Event.STARTUP_COMPLETED, ]); // Set the snackbar for the update service: @@ -174,6 +176,8 @@ public partial class MainLayout : LayoutComponentBase, IMessageBusReceiver, ILan await this.UpdateThemeConfiguration(); this.LoadNavItems(); this.StateHasChanged(); + if (this.startupCompleted) + _ = this.EnsureMandatoryInfosAcceptedAsync(); break; case Event.COLOR_THEME_CHANGED: @@ -261,6 +265,13 @@ public partial class MainLayout : LayoutComponentBase, IMessageBusReceiver, ILan this.LoadNavItems(); await this.InvokeAsync(this.StateHasChanged); + if (this.startupCompleted) + _ = this.EnsureMandatoryInfosAcceptedAsync(); + break; + + case Event.STARTUP_COMPLETED: + this.startupCompleted = true; + _ = this.EnsureMandatoryInfosAcceptedAsync(); break; } }); @@ -368,12 +379,87 @@ public partial class MainLayout : LayoutComponentBase, IMessageBusReceiver, ILan await this.MessageBus.SendMessage(this, Event.COLOR_THEME_CHANGED); this.StateHasChanged(); } + + private async Task EnsureMandatoryInfosAcceptedAsync() + { + if (!await this.mandatoryInfoDialogSemaphore.WaitAsync(0)) + return; + + try + { + while (true) + { + var pendingInfos = this.GetPendingMandatoryInfos().ToList(); + if (pendingInfos.Count == 0) + return; + + foreach (var info in pendingInfos) + { + var wasAccepted = await this.ShowMandatoryInfoDialog(info); + if (!wasAccepted) + { + await this.RustService.ExitApplication(); + return; + } + + await this.StoreMandatoryInfoAcceptance(info); + } + } + } + finally + { + this.mandatoryInfoDialogSemaphore.Release(); + } + } + + private IEnumerable GetPendingMandatoryInfos() + { + return PluginFactory.GetMandatoryInfos() + .Where(info => + { + var acceptance = this.SettingsManager.ConfigurationData.MandatoryInformation.FindAcceptance(info.Id); + return acceptance is null || acceptance.AcceptedVersion != info.VersionText; + }); + } + + private async Task ShowMandatoryInfoDialog(DataMandatoryInfo info) + { + var dialogParameters = new DialogParameters + { + { x => x.Info, info }, + }; + + var dialogReference = await this.DialogService.ShowAsync(null, dialogParameters, DialogOptions.BLOCKING_FULLSCREEN); + var dialogResult = await dialogReference.Result; + return dialogResult is { Canceled: false, Data: true }; + } + + private async Task StoreMandatoryInfoAcceptance(DataMandatoryInfo info) + { + var acceptances = this.SettingsManager.ConfigurationData.MandatoryInformation.Acceptances; + var acceptance = new DataMandatoryInfoAcceptance + { + InfoId = info.Id, + AcceptedVersion = info.VersionText, + AcceptedAtUtc = DateTimeOffset.UtcNow, + EnterpriseConfigurationPluginId = info.EnterpriseConfigurationPluginId, + }; + + var existingIndex = acceptances.FindIndex(item => item.InfoId == info.Id); + if (existingIndex >= 0) + acceptances[existingIndex] = acceptance; + else + acceptances.Add(acceptance); + + await this.SettingsManager.StoreSettings(); + } #region Implementation of IDisposable public void Dispose() { this.MessageBus.Unregister(this); + this.mandatoryInfoDialogSemaphore.Dispose(); } #endregion diff --git a/app/MindWork AI Studio/Pages/Information.razor b/app/MindWork AI Studio/Pages/Information.razor index b7b9aea4..07ddec73 100644 --- a/app/MindWork AI Studio/Pages/Information.razor +++ b/app/MindWork AI Studio/Pages/Information.razor @@ -222,6 +222,19 @@ + + @foreach (var mandatoryInfoPanel in this.mandatoryInfoPanels) + { + + + @string.Format(T("Provided by configuration plugin: {0}"), mandatoryInfoPanel.PluginName) + + + + } diff --git a/app/MindWork AI Studio/Pages/Information.razor.cs b/app/MindWork AI Studio/Pages/Information.razor.cs index b9172217..17c1dedd 100644 --- a/app/MindWork AI Studio/Pages/Information.razor.cs +++ b/app/MindWork AI Studio/Pages/Information.razor.cs @@ -2,6 +2,7 @@ using System.Reflection; using AIStudio.Components; using AIStudio.Dialogs; +using AIStudio.Settings.DataModel; using AIStudio.Tools.Databases; using AIStudio.Tools.Metadata; using AIStudio.Tools.PluginSystem; @@ -77,9 +78,13 @@ public partial class Information : MSGComponentBase .ToList(); private List enterpriseEnvironments = EnterpriseEnvironmentService.CURRENT_ENVIRONMENTS.ToList(); + + private List mandatoryInfoPanels = []; private sealed record DatabaseDisplayInfo(string Label, string Value); + private sealed record MandatoryInfoPanelData(string HeaderText, string PluginName, DataMandatoryInfo Info, DataMandatoryInfoAcceptance? Acceptance); + private readonly List databaseDisplayInfo = new(); private bool HasAnyActiveEnvironment => this.enterpriseEnvironments.Any(e => e.IsActive); @@ -117,7 +122,7 @@ public partial class Information : MSGComponentBase protected override async Task OnInitializedAsync() { - this.ApplyFilters([], [ Event.ENTERPRISE_ENVIRONMENTS_CHANGED ]); + this.ApplyFilters([], [ Event.ENTERPRISE_ENVIRONMENTS_CHANGED, Event.CONFIGURATION_CHANGED ]); await base.OnInitializedAsync(); this.RefreshEnterpriseConfigurationState(); @@ -145,6 +150,7 @@ public partial class Information : MSGComponentBase { case Event.PLUGINS_RELOADED: case Event.ENTERPRISE_ENVIRONMENTS_CHANGED: + case Event.CONFIGURATION_CHANGED: this.RefreshEnterpriseConfigurationState(); await this.InvokeAsync(this.StateHasChanged); break; @@ -163,6 +169,16 @@ public partial class Information : MSGComponentBase .ToList(); this.enterpriseEnvironments = EnterpriseEnvironmentService.CURRENT_ENVIRONMENTS.ToList(); + this.mandatoryInfoPanels = PluginFactory.GetMandatoryInfos() + .Select(info => + { + var plugin = this.configPlugins.FirstOrDefault(item => item.Id == info.EnterpriseConfigurationPluginId); + var pluginName = plugin?.Name ?? T("Unknown configuration plugin"); + var acceptance = this.SettingsManager.ConfigurationData.MandatoryInformation.FindAcceptance(info.Id); + var headerText = $"{pluginName}: {info.Title}"; + return new MandatoryInfoPanelData(headerText, pluginName, info, acceptance); + }) + .ToList(); } private async Task DeterminePandocVersion() diff --git a/app/MindWork AI Studio/Plugins/configuration/plugin.lua b/app/MindWork AI Studio/Plugins/configuration/plugin.lua index 03a9b0f4..3faa4c82 100644 --- a/app/MindWork AI Studio/Plugins/configuration/plugin.lua +++ b/app/MindWork AI Studio/Plugins/configuration/plugin.lua @@ -266,6 +266,30 @@ CONFIG["CHAT_TEMPLATES"] = {} -- Document analysis policies for this configuration: CONFIG["DOCUMENT_ANALYSIS_POLICIES"] = {} +-- Mandatory infos that users must explicitly accept before using AI Studio: +CONFIG["MANDATORY_INFOS"] = {} + +-- An example mandatory info: +-- CONFIG["MANDATORY_INFOS"][#CONFIG["MANDATORY_INFOS"]+1] = { +-- ["Id"] = "00000000-0000-0000-0000-000000000000", +-- ["Title"] = "AI Usage Requirements", +-- ["Version"] = "1", +-- ["Markdown"] = [===[ +-- ## Usage Requirements +-- +-- Before using this AI offering, please ensure that: +-- +-- - you have completed the required internal training, +-- - generated output is clearly labeled where necessary, +-- - results are reviewed by a human before reuse, +-- - all internal policies and applicable law are followed. +-- +-- Further information is available in the [internal wiki](https://example.org/wiki). +-- ]===], +-- ["AcceptButtonText"] = "Yes, I comply with these requirements", +-- ["RejectButtonText"] = "Stop. I do not agree to these requirements" +-- } + -- An example document analysis policy: -- CONFIG["DOCUMENT_ANALYSIS_POLICIES"][#CONFIG["DOCUMENT_ANALYSIS_POLICIES"]+1] = { -- ["Id"] = "00000000-0000-0000-0000-000000000000", diff --git a/app/MindWork AI Studio/Settings/DataModel/Data.cs b/app/MindWork AI Studio/Settings/DataModel/Data.cs index d6339739..36f81915 100644 --- a/app/MindWork AI Studio/Settings/DataModel/Data.cs +++ b/app/MindWork AI Studio/Settings/DataModel/Data.cs @@ -107,6 +107,8 @@ public sealed class Data public DataDocumentAnalysis DocumentAnalysis { get; init; } = new(); + public DataMandatoryInformation MandatoryInformation { get; init; } = new(); + public DataTextSummarizer TextSummarizer { get; init; } = new(); public DataTextContentCleaner TextContentCleaner { get; init; } = new(); diff --git a/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInfo.cs b/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInfo.cs new file mode 100644 index 00000000..ad49b008 --- /dev/null +++ b/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInfo.cs @@ -0,0 +1,96 @@ +using Lua; + +namespace AIStudio.Settings.DataModel; + +public sealed record DataMandatoryInfo +{ + private static readonly ILogger LOG = Program.LOGGER_FACTORY.CreateLogger(); + + /// + /// The stable ID of the mandatory info. + /// + public string Id { get; private init; } = string.Empty; + + /// + /// The ID of the enterprise configuration plugin that provides this info. + /// + public Guid EnterpriseConfigurationPluginId { get; private init; } = Guid.Empty; + + /// + /// The title shown to the user. + /// + public string Title { get; private init; } = string.Empty; + + /// + /// The configured version string. When it changes, the user must accept the text again. + /// + public string VersionText { get; private init; } = string.Empty; + + /// + /// The Markdown content shown to the user. + /// + public string Markdown { get; private init; } = string.Empty; + + /// + /// The label of the acceptance button. + /// + public string AcceptButtonText { get; private init; } = string.Empty; + + /// + /// The label of the reject button. + /// + public string RejectButtonText { get; private init; } = string.Empty; + + public static bool TryParseConfiguration(int idx, LuaTable table, Guid configPluginId, out DataMandatoryInfo mandatoryInfo) + { + mandatoryInfo = new DataMandatoryInfo(); + if (!table.TryGetValue("Id", out var idValue) || !idValue.TryRead(out var idText) || !Guid.TryParse(idText, out var id)) + { + LOG.LogWarning("The configured mandatory info {InfoIndex} does not contain a valid ID. The ID must be a valid GUID.", idx); + return false; + } + + if (!table.TryGetValue("Title", out var titleValue) || !titleValue.TryRead(out var title) || string.IsNullOrWhiteSpace(title)) + { + LOG.LogWarning("The configured mandatory info {InfoIndex} does not contain a valid Title field.", idx); + return false; + } + + if (!table.TryGetValue("Version", out var versionValue) || !versionValue.TryRead(out var versionText) || string.IsNullOrWhiteSpace(versionText)) + { + LOG.LogWarning("The configured mandatory info {InfoIndex} does not contain a valid Version field.", idx); + return false; + } + + if (!table.TryGetValue("Markdown", out var markdownValue) || !markdownValue.TryRead(out var markdown) || string.IsNullOrWhiteSpace(markdown)) + { + LOG.LogWarning("The configured mandatory info {InfoIndex} does not contain a valid Markdown field.", idx); + return false; + } + + if (!table.TryGetValue("AcceptButtonText", out var acceptButtonValue) || !acceptButtonValue.TryRead(out var acceptButtonText) || string.IsNullOrWhiteSpace(acceptButtonText)) + { + LOG.LogWarning("The configured mandatory info {InfoIndex} does not contain a valid AcceptButtonText field.", idx); + return false; + } + + if (!table.TryGetValue("RejectButtonText", out var rejectButtonValue) || !rejectButtonValue.TryRead(out var rejectButtonText) || string.IsNullOrWhiteSpace(rejectButtonText)) + { + LOG.LogWarning("The configured mandatory info {InfoIndex} does not contain a valid RejectButtonText field.", idx); + return false; + } + + mandatoryInfo = new DataMandatoryInfo + { + Id = id.ToString(), + Title = title, + VersionText = versionText, + Markdown = markdown, + AcceptButtonText = acceptButtonText, + RejectButtonText = rejectButtonText, + EnterpriseConfigurationPluginId = configPluginId, + }; + + return true; + } +} \ No newline at end of file diff --git a/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInfoAcceptance.cs b/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInfoAcceptance.cs new file mode 100644 index 00000000..765816c7 --- /dev/null +++ b/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInfoAcceptance.cs @@ -0,0 +1,24 @@ +namespace AIStudio.Settings.DataModel; + +public sealed record DataMandatoryInfoAcceptance +{ + /// + /// The ID of the mandatory info that was accepted. + /// + public string InfoId { get; init; } = string.Empty; + + /// + /// The accepted version string. + /// + public string AcceptedVersion { get; init; } = string.Empty; + + /// + /// The UTC time of the acceptance. + /// + public DateTimeOffset AcceptedAtUtc { get; init; } + + /// + /// The plugin that provided the accepted info at the time of acceptance. + /// + public Guid EnterpriseConfigurationPluginId { get; init; } = Guid.Empty; +} \ No newline at end of file diff --git a/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInformation.cs b/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInformation.cs new file mode 100644 index 00000000..fe348944 --- /dev/null +++ b/app/MindWork AI Studio/Settings/DataModel/DataMandatoryInformation.cs @@ -0,0 +1,24 @@ +namespace AIStudio.Settings.DataModel; + +public sealed class DataMandatoryInformation +{ + /// + /// Persisted user acceptances for configured mandatory infos. + /// + public List Acceptances { get; set; } = []; + + public DataMandatoryInfoAcceptance? FindAcceptance(string infoId) + { + return this.Acceptances.LastOrDefault(acceptance => string.Equals(acceptance.InfoId, infoId, StringComparison.OrdinalIgnoreCase)); + } + + public bool RemoveLeftOverAcceptances(IEnumerable mandatoryInfos) + { + var validInfoIds = mandatoryInfos + .Select(info => info.Id) + .ToHashSet(StringComparer.OrdinalIgnoreCase); + + var removedCount = this.Acceptances.RemoveAll(acceptance => !validInfoIds.Contains(acceptance.InfoId)); + return removedCount > 0; + } +} \ No newline at end of file diff --git a/app/MindWork AI Studio/Tools/PluginSystem/PluginConfiguration.cs b/app/MindWork AI Studio/Tools/PluginSystem/PluginConfiguration.cs index 99031624..e96967ea 100644 --- a/app/MindWork AI Studio/Tools/PluginSystem/PluginConfiguration.cs +++ b/app/MindWork AI Studio/Tools/PluginSystem/PluginConfiguration.cs @@ -1,4 +1,5 @@ using AIStudio.Settings; +using AIStudio.Settings.DataModel; using AIStudio.Tools.Services; using Lua; @@ -12,12 +13,18 @@ public sealed class PluginConfiguration(bool isInternal, LuaState state, PluginT private static readonly ILogger LOG = Program.LOGGER_FACTORY.CreateLogger(nameof(PluginConfiguration)); private List configObjects = []; + private List mandatoryInfos = []; /// /// The list of configuration objects. Configuration objects are, e.g., providers or chat templates. /// public IEnumerable ConfigObjects => this.configObjects; + /// + /// The list of mandatory infos provided by this configuration plugin. + /// + public IReadOnlyList MandatoryInfos => this.mandatoryInfos; + /// /// True/false when explicitly configured in the plugin, otherwise null. /// @@ -91,6 +98,7 @@ public sealed class PluginConfiguration(bool isInternal, LuaState state, PluginT private bool TryProcessConfiguration(bool dryRun, out string message) { this.configObjects.Clear(); + this.mandatoryInfos.Clear(); // Ensure that the main CONFIG table exists and is a valid Lua table: if (!this.state.Environment["CONFIG"].TryRead(out var mainTable)) @@ -150,6 +158,9 @@ public sealed class PluginConfiguration(bool isInternal, LuaState state, PluginT // Handle configured document analysis policies: PluginConfigurationObject.TryParse(PluginConfigurationObjectType.DOCUMENT_ANALYSIS_POLICY, x => x.DocumentAnalysis.Policies, x => x.NextDocumentAnalysisPolicyNum, mainTable, this.Id, ref this.configObjects, dryRun); + + // Handle configured mandatory infos: + this.TryReadMandatoryInfos(mainTable); // Config: preselected provider? ManagedConfiguration.TryProcessConfiguration(x => x.App, x => x.PreselectedProvider, Guid.Empty, this.Id, settingsTable, dryRun); @@ -163,4 +174,25 @@ public sealed class PluginConfiguration(bool isInternal, LuaState state, PluginT message = string.Empty; return true; } + + private void TryReadMandatoryInfos(LuaTable mainTable) + { + if (!mainTable.TryGetValue("MANDATORY_INFOS", out var mandatoryInfosValue) || !mandatoryInfosValue.TryRead(out var mandatoryInfosTable)) + return; + + for (var i = 1; i <= mandatoryInfosTable.ArrayLength; i++) + { + var luaMandatoryInfoValue = mandatoryInfosTable[i]; + if (!luaMandatoryInfoValue.TryRead(out var luaMandatoryInfoTable)) + { + LOG.LogWarning("The table 'MANDATORY_INFOS' entry at index {Index} is not a valid table (config plugin id: {ConfigPluginId}).", i, this.Id); + continue; + } + + if (DataMandatoryInfo.TryParseConfiguration(i, luaMandatoryInfoTable, this.Id, out var mandatoryInfo)) + this.mandatoryInfos.Add(mandatoryInfo); + else + LOG.LogWarning("The table 'MANDATORY_INFOS' entry at index {Index} does not contain a valid mandatory info (config plugin id: {ConfigPluginId}).", i, this.Id); + } + } } diff --git a/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.Loading.cs b/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.Loading.cs index f110e766..1e6d6ad1 100644 --- a/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.Loading.cs +++ b/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.Loading.cs @@ -186,6 +186,10 @@ public static partial class PluginFactory // Check document analysis policies: if(await PluginConfigurationObject.CleanLeftOverConfigurationObjects(PluginConfigurationObjectType.DOCUMENT_ANALYSIS_POLICY, x => x.DocumentAnalysis.Policies, AVAILABLE_PLUGINS, configObjectList)) wasConfigurationChanged = true; + + // Check left-over mandatory info acceptances: + if (SETTINGS_MANAGER.ConfigurationData.MandatoryInformation.RemoveLeftOverAcceptances(GetMandatoryInfos())) + wasConfigurationChanged = true; // Check for a preselected provider: if(ManagedConfiguration.IsConfigurationLeftOver(x => x.App, x => x.PreselectedProvider, AVAILABLE_PLUGINS)) diff --git a/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.cs b/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.cs index 4b4f6a08..a707ab06 100644 --- a/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.cs +++ b/app/MindWork AI Studio/Tools/PluginSystem/PluginFactory.cs @@ -1,4 +1,5 @@ using AIStudio.Settings; +using AIStudio.Settings.DataModel; namespace AIStudio.Tools.PluginSystem; @@ -127,4 +128,12 @@ public static partial class PluginFactory HOT_RELOAD_WATCHER.Dispose(); } + + public static IReadOnlyList GetMandatoryInfos() + { + return RUNNING_PLUGINS + .OfType() + .SelectMany(plugin => plugin.MandatoryInfos) + .ToList(); + } } \ No newline at end of file diff --git a/app/MindWork AI Studio/Tools/Rust/AppExitResponse.cs b/app/MindWork AI Studio/Tools/Rust/AppExitResponse.cs new file mode 100644 index 00000000..ef3c6702 --- /dev/null +++ b/app/MindWork AI Studio/Tools/Rust/AppExitResponse.cs @@ -0,0 +1,3 @@ +namespace AIStudio.Tools.Rust; + +public sealed record AppExitResponse(bool Success, string ErrorMessage); \ No newline at end of file diff --git a/app/MindWork AI Studio/Tools/Services/RustService.App.cs b/app/MindWork AI Studio/Tools/Services/RustService.App.cs index 8671e897..1602ecc4 100644 --- a/app/MindWork AI Studio/Tools/Services/RustService.App.cs +++ b/app/MindWork AI Studio/Tools/Services/RustService.App.cs @@ -1,5 +1,7 @@ using System.Security.Cryptography; +using AIStudio.Tools.Rust; + namespace AIStudio.Tools.Services; public sealed partial class RustService @@ -117,4 +119,35 @@ public sealed partial class RustService return await response.Content.ReadAsStringAsync(); } + + /// + /// Requests the Rust runtime to exit the entire desktop application. + /// + public async Task ExitApplication() + { + try + { + var response = await this.http.PostAsync("/app/exit", null); + if (!response.IsSuccessStatusCode) + { + this.logger?.LogError("Failed to exit the app due to network error: {StatusCode}.", response.StatusCode); + return false; + } + + var result = await response.Content.ReadFromJsonAsync(this.jsonRustSerializerOptions); + if (result is null || !result.Success) + { + this.logger?.LogError("Failed to exit the app: {Error}", result?.ErrorMessage ?? "Unknown error"); + return false; + } + + this.logger?.LogInformation("Exit request sent to Rust runtime."); + return true; + } + catch (Exception ex) + { + this.logger?.LogError(ex, "Exception while requesting application exit."); + return false; + } + } } \ No newline at end of file diff --git a/runtime/src/app_window.rs b/runtime/src/app_window.rs index 0066cfae..0d962e5f 100644 --- a/runtime/src/app_window.rs +++ b/runtime/src/app_window.rs @@ -727,6 +727,13 @@ pub struct ShortcutResponse { error_message: String, } +/// Response for application exit requests. +#[derive(Serialize)] +pub struct AppExitResponse { + success: bool, + error_message: String, +} + /// Internal helper function to register a shortcut with its callback. /// This is used by both `register_shortcut` and `resume_shortcuts` to /// avoid code duplication. @@ -755,6 +762,34 @@ fn register_shortcut_with_callback( } } +/// Requests a controlled shutdown of the entire desktop application. +#[post("/app/exit")] +pub fn exit_app(_token: APIToken) -> Json { + let main_window_lock = MAIN_WINDOW.lock().unwrap(); + let main_window = match main_window_lock.as_ref() { + Some(window) => window, + None => { + error!(Source = "Tauri"; "Cannot exit app: main window not available."); + return Json(AppExitResponse { + success: false, + error_message: "Main window not available".to_string(), + }); + } + }; + + let app_handle = main_window.app_handle(); + info!(Source = "Tauri"; "Controlled app exit was requested by the UI."); + tauri::async_runtime::spawn(async move { + time::sleep(Duration::from_millis(50)).await; + app_handle.exit(0); + }); + + Json(AppExitResponse { + success: true, + error_message: String::new(), + }) +} + /// Registers or updates a global shortcut. If the shortcut string is empty, /// the existing shortcut for that name will be unregistered. #[post("/shortcuts/register", data = "")] diff --git a/runtime/src/runtime_api.rs b/runtime/src/runtime_api.rs index 64bc8174..aa743345 100644 --- a/runtime/src/runtime_api.rs +++ b/runtime/src/runtime_api.rs @@ -76,6 +76,7 @@ pub fn start_runtime_api() { crate::app_window::select_file, crate::app_window::select_files, crate::app_window::save_file, + crate::app_window::exit_app, crate::secret::get_secret, crate::secret::store_secret, crate::secret::delete_secret,