PowerToys/src/settings-ui/Settings.UI.Library/GeneralSettings.cs

// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Text.Json;
using System.Text.Json.Serialization;

using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library.Helpers;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
using Microsoft.PowerToys.Settings.UI.Library.Utilities;
using Settings.UI.Library.Attributes;

namespace Microsoft.PowerToys.Settings.UI.Library
{
    public enum DashboardSortOrder
    {
        Alphabetical,
        ByStatus,
    }

    public class GeneralSettings : ISettingsConfig, IHotkeyConfig
    {
        // Gets or sets a value indicating whether run powertoys on start-up.
        [JsonPropertyName("startup")]
        public bool Startup { get; set; }

        // Gets or sets a value indicating whether the powertoys system tray icon should be hidden.
        [JsonPropertyName("show_tray_icon")]
        public bool ShowSysTrayIcon { get; set; }

        // Gets or sets a value indicating whether the powertoys system tray icon should show a theme adaptive icon
        [JsonPropertyName("show_theme_adaptive_tray_icon")]
        public bool ShowThemeAdaptiveTrayIcon { get; set; }

        // Gets or sets a value indicating whether the powertoy elevated.
        [CmdConfigureIgnoreAttribute]
        [JsonPropertyName("is_elevated")]
        public bool IsElevated { get; set; }

        // Gets or sets a value indicating whether powertoys should run elevated.
        [JsonPropertyName("run_elevated")]
        [CmdConfigureIgnoreAttribute]
        public bool RunElevated { get; set; }

        // Gets or sets a value indicating whether is admin.
        [JsonPropertyName("is_admin")]
        [CmdConfigureIgnoreAttribute]
        public bool IsAdmin { get; set; }

        // Gets or sets a value indicating whether is warnings of elevated apps enabled.
        [JsonPropertyName("enable_warnings_elevated_apps")]
        public bool EnableWarningsElevatedApps { get; set; }

        // Gets or sets a value indicating whether Quick Access is enabled.
        [JsonPropertyName("enable_quick_access")]
        public bool EnableQuickAccess { get; set; }

        // Gets or sets Quick Access shortcut.
        [JsonPropertyName("quick_access_shortcut")]
        public HotkeySettings QuickAccessShortcut { get; set; }

        // Gets or sets theme Name.
        [JsonPropertyName("theme")]
        public string Theme { get; set; }

        // Gets or sets system theme name.
        [JsonPropertyName("system_theme")]
        [CmdConfigureIgnore]
        public string SystemTheme { get; set; }

        // Gets or sets powertoys version number.
        [JsonPropertyName("powertoys_version")]
        [CmdConfigureIgnore]
        public string PowertoysVersion { get; set; }

        [JsonPropertyName("action_name")]
        [CmdConfigureIgnore]
        public string CustomActionName { get; set; }

        [JsonPropertyName("enabled")]
        [CmdConfigureIgnore]
        public EnabledModules Enabled { get; set; }

        [JsonPropertyName("show_new_updates_toast_notification")]
        public bool ShowNewUpdatesToastNotification { get; set; }

        [JsonPropertyName("download_updates_automatically")]
        public bool AutoDownloadUpdates { get; set; }

        [JsonPropertyName("show_whats_new_after_updates")]
        public bool ShowWhatsNewAfterUpdates { get; set; }

        [JsonPropertyName("enable_experimentation")]
        public bool EnableExperimentation { get; set; }

        [JsonPropertyName("dashboard_sort_order")]
        public DashboardSortOrder DashboardSortOrder { get; set; }

        [JsonPropertyName("ignored_conflict_properties")]
        public ShortcutConflictProperties IgnoredConflictProperties { get; set; }

        public GeneralSettings()
        {
            Startup = false;
            ShowSysTrayIcon = true;
            IsAdmin = false;
            EnableWarningsElevatedApps = true;
            EnableQuickAccess = true;
            QuickAccessShortcut = new HotkeySettings();
            IsElevated = false;
            ShowNewUpdatesToastNotification = true;
            AutoDownloadUpdates = false;
            EnableExperimentation = true;
            DashboardSortOrder = DashboardSortOrder.Alphabetical;
            Theme = "system";
            SystemTheme = "light";
            try
            {
                PowertoysVersion = DefaultPowertoysVersion();
            }
            catch (Exception e)
            {
                Logger.LogError("Exception encountered when getting PowerToys version", e);
                PowertoysVersion = "v0.0.0";
            }

            Enabled = new EnabledModules();
            CustomActionName = string.Empty;
            IgnoredConflictProperties = new ShortcutConflictProperties();
        }

        public HotkeyAccessor[] GetAllHotkeyAccessors()
        {
            return new HotkeyAccessor[]
            {
                new HotkeyAccessor(
                    () => QuickAccessShortcut,
                    (hotkey) => { QuickAccessShortcut = hotkey; },
                    "GeneralPage_QuickAccessShortcut"),
            };
        }

        public ModuleType GetModuleType()
        {
            return ModuleType.GeneralSettings;
        }

        // converts the current to a json string.
        public string ToJsonString()
        {
            return JsonSerializer.Serialize(this, SettingsSerializationContext.Default.GeneralSettings);
        }

        private static string DefaultPowertoysVersion()
        {
            return global::PowerToys.Interop.CommonManaged.GetProductVersion();
        }

        // This function is to implement the ISettingsConfig interface.
        // This interface helps in getting the settings configurations.
        public string GetModuleName()
        {
            // The SettingsUtils functions access general settings when the module name is an empty string.
            return string.Empty;
        }

        public bool UpgradeSettingsConfiguration()
        {
            try
            {
                if (Helper.CompareVersions(PowertoysVersion, Helper.GetProductVersion()) != 0)
                {
                    // Update settings
                    PowertoysVersion = Helper.GetProductVersion();
                    return true;
                }
            }
            catch (FormatException)
            {
                // If there is an issue with the version number format, don't migrate settings.
            }

            // Ensure IgnoredConflictProperties is initialized (for backward compatibility)
            if (IgnoredConflictProperties == null)
            {
                IgnoredConflictProperties = new ShortcutConflictProperties();
                return true; // Indicate that settings were upgraded
            }

            return false;
        }

        public void AddEnabledModuleChangeNotification(Action callBack)
        {
            Enabled.AddEnabledModuleChangeNotification(callBack);
        }
    }
}