PowerToys/src/settings-ui/Settings.UI/ViewModels/AlwaysOnTopViewModel.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.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text.Json;
using global::PowerToys.GPOWrapper;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Helpers;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.PowerToys.Settings.UI.Library.Helpers;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
using Microsoft.PowerToys.Settings.UI.Library.Utilities;
using Microsoft.PowerToys.Settings.UI.SerializationContext;

namespace Microsoft.PowerToys.Settings.UI.ViewModels
{
    public partial class AlwaysOnTopViewModel : PageViewModelBase
    {
        protected override string ModuleName => AlwaysOnTopSettings.ModuleName;

        private SettingsUtils SettingsUtils { get; set; }

        private GeneralSettings GeneralSettingsConfig { get; set; }

        private AlwaysOnTopSettings Settings { get; set; }

        private Func<string, int> SendConfigMSG { get; }

        public AlwaysOnTopViewModel(SettingsUtils settingsUtils, ISettingsRepository<GeneralSettings> settingsRepository, ISettingsRepository<AlwaysOnTopSettings> moduleSettingsRepository, Func<string, int> ipcMSGCallBackFunc)
        {
            ArgumentNullException.ThrowIfNull(settingsUtils);

            SettingsUtils = settingsUtils;

            // To obtain the general settings configurations of PowerToys Settings.
            ArgumentNullException.ThrowIfNull(settingsRepository);

            GeneralSettingsConfig = settingsRepository.SettingsConfig;

            InitializeEnabledValue();

            // To obtain the settings configurations of AlwaysOnTop.
            ArgumentNullException.ThrowIfNull(moduleSettingsRepository);

            Settings = moduleSettingsRepository.SettingsConfig;

            _hotkey = Settings.Properties.Hotkey.Value;
            _showInSystemMenu = Settings.Properties.ShowInSystemMenu.Value;
            _frameEnabled = Settings.Properties.FrameEnabled.Value;
            _frameThickness = Settings.Properties.FrameThickness.Value;
            _frameColor = Settings.Properties.FrameColor.Value;
            _frameOpacity = Settings.Properties.FrameOpacity.Value;
            _frameAccentColor = Settings.Properties.FrameAccentColor.Value;
            _soundEnabled = Settings.Properties.SoundEnabled.Value;
            _doNotActivateOnGameMode = Settings.Properties.DoNotActivateOnGameMode.Value;
            _roundCornersEnabled = Settings.Properties.RoundCornersEnabled.Value;
            _excludedApps = Settings.Properties.ExcludedApps.Value;
            _windows11 = OSVersionHelper.IsWindows11();

            // set the callback functions value to handle outgoing IPC message.
            SendConfigMSG = ipcMSGCallBackFunc;
        }

        private void InitializeEnabledValue()
        {
            _enabledGpoRuleConfiguration = GPOWrapper.GetConfiguredAlwaysOnTopEnabledValue();
            if (_enabledGpoRuleConfiguration == GpoRuleConfigured.Disabled || _enabledGpoRuleConfiguration == GpoRuleConfigured.Enabled)
            {
                // Get the enabled state from GPO.
                _enabledStateIsGPOConfigured = true;
                _isEnabled = _enabledGpoRuleConfiguration == GpoRuleConfigured.Enabled;
            }
            else
            {
                _isEnabled = GeneralSettingsConfig.Enabled.AlwaysOnTop;
            }
        }

        public override Dictionary<string, HotkeySettings[]> GetAllHotkeySettings()
        {
            var hotkeysDict = new Dictionary<string, HotkeySettings[]>
            {
                [ModuleName] = [Hotkey],
            };

            return hotkeysDict;
        }

        public bool IsEnabled
        {
            get => _isEnabled;

            set
            {
                if (_enabledStateIsGPOConfigured)
                {
                    // If it's GPO configured, shouldn't be able to change this state.
                    return;
                }

                if (value != _isEnabled)
                {
                    _isEnabled = value;

                    // Set the status in the general settings configuration
                    GeneralSettingsConfig.Enabled.AlwaysOnTop = value;
                    OutGoingGeneralSettings snd = new OutGoingGeneralSettings(GeneralSettingsConfig);

                    SendConfigMSG(snd.ToString());
                    OnPropertyChanged(nameof(IsEnabled));
                }
            }
        }

        public bool IsEnabledGpoConfigured
        {
            get => _enabledStateIsGPOConfigured;
        }

        public HotkeySettings Hotkey
        {
            get => _hotkey;

            set
            {
                if (value != _hotkey)
                {
                    _hotkey = value ?? AlwaysOnTopProperties.DefaultHotkeyValue;

                    Settings.Properties.Hotkey.Value = _hotkey;
                    NotifyPropertyChanged();

                    // Also notify that transparency shortcut strings have changed
                    OnPropertyChanged(nameof(IncreaseOpacityShortcut));
                    OnPropertyChanged(nameof(DecreaseOpacityShortcut));

                    // Using InvariantCulture as this is an IPC message
                    SendConfigMSG(
                        string.Format(
                            CultureInfo.InvariantCulture,
                            "{{ \"powertoys\": {{ \"{0}\": {1} }} }}",
                            AlwaysOnTopSettings.ModuleName,
                            JsonSerializer.Serialize(Settings, SourceGenerationContextContext.Default.AlwaysOnTopSettings)));
                }
            }
        }

        public bool FrameEnabled
        {
            get => _frameEnabled;

            set
            {
                if (value != _frameEnabled)
                {
                    _frameEnabled = value;
                    Settings.Properties.FrameEnabled.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public bool ShowInSystemMenu
        {
            get => _showInSystemMenu;

            set
            {
                if (value != _showInSystemMenu)
                {
                    _showInSystemMenu = value;
                    Settings.Properties.ShowInSystemMenu.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public int FrameThickness
        {
            get => _frameThickness;

            set
            {
                if (value != _frameThickness)
                {
                    _frameThickness = value;
                    Settings.Properties.FrameThickness.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public string FrameColor
        {
            get => _frameColor;

            set
            {
                if (value != _frameColor)
                {
                    _frameColor = value;
                    Settings.Properties.FrameColor.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public int FrameOpacity
        {
            get => _frameOpacity;

            set
            {
                if (value != _frameOpacity)
                {
                    _frameOpacity = value;
                    Settings.Properties.FrameOpacity.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public bool SoundEnabled
        {
            get => _soundEnabled;

            set
            {
                if (value != _soundEnabled)
                {
                    _soundEnabled = value;
                    Settings.Properties.SoundEnabled.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public bool DoNotActivateOnGameMode
        {
            get => _doNotActivateOnGameMode;

            set
            {
                if (value != _doNotActivateOnGameMode)
                {
                    _doNotActivateOnGameMode = value;
                    Settings.Properties.DoNotActivateOnGameMode.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public bool RoundCornersEnabled
        {
            get => _roundCornersEnabled;

            set
            {
                if (value != _roundCornersEnabled)
                {
                    _roundCornersEnabled = value;
                    Settings.Properties.RoundCornersEnabled.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public string ExcludedApps
        {
            get => _excludedApps;

            set
            {
                if (value != _excludedApps)
                {
                    _excludedApps = value;
                    Settings.Properties.ExcludedApps.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public bool FrameAccentColor
        {
            get => _frameAccentColor;

            set
            {
                if (value != _frameAccentColor)
                {
                    _frameAccentColor = value;
                    Settings.Properties.FrameAccentColor.Value = value;
                    NotifyPropertyChanged();
                }
            }
        }

        public bool Windows11
        {
            get => _windows11;

            set
            {
                _windows11 = value;
            }
        }

        /// <summary>
        /// Gets the formatted shortcut string for increasing window opacity (modifier keys + "+").
        /// </summary>
        public string IncreaseOpacityShortcut
        {
            get
            {
                var modifiers = new HotkeySettings(_hotkey.Win, _hotkey.Ctrl, _hotkey.Alt, _hotkey.Shift, 0).ToString();
                var shortcut = string.IsNullOrEmpty(modifiers) ? "+" : modifiers + " + +";
                return string.Format(CultureInfo.CurrentCulture, ResourceLoaderInstance.ResourceLoader.GetString("AlwaysOnTop_IncreaseOpacity"), shortcut);
            }
        }

        /// <summary>
        /// Gets the formatted shortcut string for decreasing window opacity (modifier keys + "-").
        /// </summary>
        public string DecreaseOpacityShortcut
        {
            get
            {
                var modifiers = new HotkeySettings(_hotkey.Win, _hotkey.Ctrl, _hotkey.Alt, _hotkey.Shift, 0).ToString();
                var shortcut = string.IsNullOrEmpty(modifiers) ? "-" : modifiers + " + -";
                return string.Format(CultureInfo.CurrentCulture, ResourceLoaderInstance.ResourceLoader.GetString("AlwaysOnTop_DecreaseOpacity"), shortcut);
            }
        }

        public void NotifyPropertyChanged([CallerMemberName] string propertyName = null)
        {
            OnPropertyChanged(propertyName);
            SettingsUtils.SaveSettings(Settings.ToJsonString(), AlwaysOnTopSettings.ModuleName);
        }

        public void RefreshEnabledState()
        {
            InitializeEnabledValue();
            OnPropertyChanged(nameof(IsEnabled));
        }

        private GpoRuleConfigured _enabledGpoRuleConfiguration;
        private bool _enabledStateIsGPOConfigured;
        private bool _isEnabled;
        private HotkeySettings _hotkey;
        private bool _showInSystemMenu;
        private bool _frameEnabled;
        private int _frameThickness;
        private string _frameColor;
        private bool _frameAccentColor;
        private int _frameOpacity;
        private bool _soundEnabled;
        private bool _doNotActivateOnGameMode;
        private bool _roundCornersEnabled;
        private string _excludedApps;
        private bool _windows11;
    }
}