namespace AIStudio.Settings; /// /// The type-independent part of the configuration metadata: which configuration plugin manages /// the setting, and in which way. /// /// /// The managed state lives here so that it can be processed without knowing the setting's type, /// e.g. when cleaning up settings whose configuration plugin was removed. /// public abstract record ConfigMetaBase(string SettingName) : IConfig { protected static SettingsManager SettingsManagerAccess => Program.SERVICE_PROVIDER.GetRequiredService(); /// /// The persisted name of the configuration setting. /// public string SettingName { get; } = SettingName; /// /// Indicates whether the configuration is locked by a configuration plugin. /// public bool IsLocked { get; private set; } /// /// The ID of the plugin that locked this configuration. /// public Guid LockedByConfigPluginId { get; private set; } /// /// How this setting is managed by a configuration plugin, if at all. /// public ManagedConfigurationMode? ManagedMode { get; private set; } /// /// The ID of the plugin that currently provides an editable default value. /// public Guid EditableDefaultByConfigPluginId { get; private set; } /// /// The configuration plugins which contribute to this setting. /// /// /// Contributions are additive, so several configuration plugins may contribute at the same time /// and each of them keeps its own contribution. An organization might enable one preview feature /// for everybody and another one for a single department, for example. /// public abstract IReadOnlyCollection ContributingConfigPluginIds { get; } /// /// Indicates whether at least one configuration plugin contributes to this setting. /// public bool HasPluginContribution => this.ContributingConfigPluginIds.Count > 0; /// /// Locks the configuration state, indicating that it is controlled by a specific plugin. /// /// The ID of the plugin that is locking this configuration. public void LockConfiguration(Guid pluginId) { this.IsLocked = true; this.LockedByConfigPluginId = pluginId; this.ManagedMode = ManagedConfigurationMode.LOCKED; this.EditableDefaultByConfigPluginId = Guid.Empty; SettingsManagerAccess.ConfigurationData.ManagedLockedConfigurations[this.SettingName] = pluginId; } /// /// Restores persisted locked configuration metadata after settings were loaded. /// public void RestoreLockedConfiguration() { if (this.IsLocked || this.ManagedMode is not null) return; if (!SettingsManagerAccess.ConfigurationData.ManagedLockedConfigurations.TryGetValue(this.SettingName, out var pluginId) || pluginId == Guid.Empty) return; this.IsLocked = true; this.LockedByConfigPluginId = pluginId; this.ManagedMode = ManagedConfigurationMode.LOCKED; this.EditableDefaultByConfigPluginId = Guid.Empty; } /// /// Resets the locked state of the configuration, allowing it to be modified again. /// This will also reset the property to its default value. /// public void ResetLockedConfiguration() { SettingsManagerAccess.ConfigurationData.ManagedLockedConfigurations.Remove(this.SettingName); this.IsLocked = false; this.LockedByConfigPluginId = Guid.Empty; if (this.ManagedMode is ManagedConfigurationMode.LOCKED) this.ManagedMode = null; this.Reset(); } /// /// Unlocks the configuration state without changing the current value. /// public void UnlockConfiguration() { SettingsManagerAccess.ConfigurationData.ManagedLockedConfigurations.Remove(this.SettingName); this.IsLocked = false; this.LockedByConfigPluginId = Guid.Empty; if (this.ManagedMode is ManagedConfigurationMode.LOCKED) this.ManagedMode = null; } /// /// Marks the setting as having an editable default provided by a configuration plugin. /// public void SetEditableDefaultConfiguration(Guid pluginId) { SettingsManagerAccess.ConfigurationData.ManagedLockedConfigurations.Remove(this.SettingName); this.IsLocked = false; this.LockedByConfigPluginId = Guid.Empty; this.ManagedMode = ManagedConfigurationMode.EDITABLE_DEFAULT; this.EditableDefaultByConfigPluginId = pluginId; } /// /// Clears the editable-default state without changing the current value. /// public void ClearEditableDefaultConfiguration() { if (this.ManagedMode is ManagedConfigurationMode.EDITABLE_DEFAULT) this.ManagedMode = null; this.EditableDefaultByConfigPluginId = Guid.Empty; } /// /// Removes the contribution of one configuration plugin without changing the current value. /// /// The configuration plugin whose contribution is removed. /// True when that plugin had a contribution, otherwise false. public abstract bool RemovePluginContribution(Guid configPluginId); /// /// Resets the configuration property to its default value. /// protected abstract void Reset(); }