// 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.Diagnostics; using System.Globalization; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; using System.Windows.Input; using global::PowerToys.GPOWrapper; 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.Library.ViewModels.Commands; using Microsoft.PowerToys.Settings.Utilities; using Windows.ApplicationModel.Resources; namespace Microsoft.PowerToys.Settings.UI.ViewModels { public class KeyboardManagerViewModel : Observable { private GeneralSettings GeneralSettingsConfig { get; set; } private readonly ISettingsUtils _settingsUtils; private const string PowerToyName = KeyboardManagerSettings.ModuleName; private const string JsonFileType = ".json"; private const string KeyboardManagerEditorPath = "modules\\KeyboardManager\\KeyboardManagerEditor\\PowerToys.KeyboardManagerEditor.exe"; private Process editor; private enum KeyboardManagerEditorType { KeyEditor = 0, ShortcutEditor, } private GpoRuleConfigured _enabledGpoRuleConfiguration; private bool _enabledStateIsGPOConfigured; private bool _isEnabled; public KeyboardManagerSettings Settings { get; set; } private ICommand _remapKeyboardCommand; private ICommand _editShortcutCommand; private KeyboardManagerProfile _profile; private Func SendConfigMSG { get; } private Func, int> FilterRemapKeysList { get; } public KeyboardManagerViewModel(ISettingsUtils settingsUtils, ISettingsRepository settingsRepository, Func ipcMSGCallBackFunc, Func, int> filterRemapKeysList) { if (settingsRepository == null) { throw new ArgumentNullException(nameof(settingsRepository)); } GeneralSettingsConfig = settingsRepository.SettingsConfig; InitializeEnabledValue(); // set the callback functions value to hangle outgoing IPC message. SendConfigMSG = ipcMSGCallBackFunc; FilterRemapKeysList = filterRemapKeysList; _settingsUtils = settingsUtils ?? throw new ArgumentNullException(nameof(settingsUtils)); if (_settingsUtils.SettingsExists(PowerToyName)) { try { Settings = _settingsUtils.GetSettingsOrDefault(PowerToyName); } catch (Exception e) { Logger.LogError($"Exception encountered while reading {PowerToyName} settings.", e); #if DEBUG if (e is ArgumentException || e is ArgumentNullException || e is PathTooLongException) { throw; } #endif } // Load profile. if (!LoadProfile()) { _profile = new KeyboardManagerProfile(); } } else { Settings = new KeyboardManagerSettings(); _settingsUtils.SaveSettings(Settings.ToJsonString(), PowerToyName); } } private void InitializeEnabledValue() { _enabledGpoRuleConfiguration = GPOWrapper.GetConfiguredKeyboardManagerEnabledValue(); if (_enabledGpoRuleConfiguration == GpoRuleConfigured.Disabled || _enabledGpoRuleConfiguration == GpoRuleConfigured.Enabled) { // Get the enabled state from GPO. _enabledStateIsGPOConfigured = true; _isEnabled = _enabledGpoRuleConfiguration == GpoRuleConfigured.Enabled; } else { _isEnabled = GeneralSettingsConfig.Enabled.KeyboardManager; } } public bool Enabled { get { return _isEnabled; } set { if (_enabledStateIsGPOConfigured) { // If it's GPO configured, shouldn't be able to change this state. return; } if (_isEnabled != value) { _isEnabled = value; GeneralSettingsConfig.Enabled.KeyboardManager = value; OnPropertyChanged(nameof(Enabled)); if (!Enabled && editor != null) { editor.CloseMainWindow(); } OutGoingGeneralSettings outgoing = new OutGoingGeneralSettings(GeneralSettingsConfig); SendConfigMSG(outgoing.ToString()); } } } public bool IsEnabledGpoConfigured { get => _enabledStateIsGPOConfigured; } // store remappings public List RemapKeys { get { if (_profile != null) { return _profile.RemapKeys.InProcessRemapKeys; } else { return new List(); } } } public static List CombineShortcutLists(List globalShortcutList, List appSpecificShortcutList) { string allAppsDescription = "All Apps"; try { ResourceLoader resourceLoader = ResourceLoader.GetForViewIndependentUse(); allAppsDescription = resourceLoader.GetString("KeyboardManager_All_Apps_Description"); } catch (Exception ex) { Logger.LogError("Couldn't get translation for All Apps mention in KBM page.", ex); } if (globalShortcutList == null && appSpecificShortcutList == null) { return new List(); } else if (globalShortcutList == null) { return appSpecificShortcutList; } else if (appSpecificShortcutList == null) { return globalShortcutList.ConvertAll(x => new AppSpecificKeysDataModel { OriginalKeys = x.OriginalKeys, NewRemapKeys = x.NewRemapKeys, TargetApp = allAppsDescription }).ToList(); } else { return globalShortcutList.ConvertAll(x => new AppSpecificKeysDataModel { OriginalKeys = x.OriginalKeys, NewRemapKeys = x.NewRemapKeys, TargetApp = allAppsDescription }).Concat(appSpecificShortcutList).ToList(); } } public List RemapShortcuts { get { if (_profile != null) { return CombineShortcutLists(_profile.RemapShortcuts.GlobalRemapShortcuts, _profile.RemapShortcuts.AppSpecificRemapShortcuts); } else { return new List(); } } } public ICommand RemapKeyboardCommand => _remapKeyboardCommand ?? (_remapKeyboardCommand = new RelayCommand(OnRemapKeyboard)); public ICommand EditShortcutCommand => _editShortcutCommand ?? (_editShortcutCommand = new RelayCommand(OnEditShortcut)); private void OnRemapKeyboard() { OpenEditor((int)KeyboardManagerEditorType.KeyEditor); } private void OnEditShortcut() { OpenEditor((int)KeyboardManagerEditorType.ShortcutEditor); } private static void BringProcessToFront(Process process) { if (process == null) { return; } IntPtr handle = process.MainWindowHandle; if (NativeMethods.IsIconic(handle)) { NativeMethods.ShowWindow(handle, NativeMethods.SWRESTORE); } NativeMethods.SetForegroundWindow(handle); } private void OpenEditor(int type) { try { if (editor != null && editor.HasExited) { Logger.LogInfo($"Previous instance of {PowerToyName} editor exited"); editor = null; } if (editor != null) { Logger.LogInfo($"The {PowerToyName} editor instance {editor.Id} exists. Bringing the process to the front"); BringProcessToFront(editor); return; } string path = Path.Combine(Environment.CurrentDirectory, KeyboardManagerEditorPath); Logger.LogInfo($"Starting {PowerToyName} editor from {path}"); // InvariantCulture: type represents the KeyboardManagerEditorType enum value editor = Process.Start(path, $"{type.ToString(CultureInfo.InvariantCulture)} {Environment.ProcessId}"); } catch (Exception e) { Logger.LogError($"Exception encountered when opening an {PowerToyName} editor", e); } } public void NotifyFileChanged() { OnPropertyChanged(nameof(RemapKeys)); OnPropertyChanged(nameof(RemapShortcuts)); } public void RefreshEnabledState() { InitializeEnabledValue(); OnPropertyChanged(nameof(Enabled)); } public bool LoadProfile() { var success = true; var readSuccessfully = false; // The KBM process out of runner doesn't create the default.json file if it does not exist. string fileName = Settings.Properties.ActiveConfiguration.Value + JsonFileType; var profileExists = false; try { // retry loop for reading CancellationTokenSource ts = new CancellationTokenSource(); Task t = Task.Run(() => { while (!readSuccessfully && !ts.IsCancellationRequested) { profileExists = _settingsUtils.SettingsExists(PowerToyName, fileName); if (!profileExists) { break; } else { try { _profile = _settingsUtils.GetSettingsOrDefault(PowerToyName, fileName); readSuccessfully = true; } catch (Exception e) { Logger.LogError($"Exception encountered when reading {PowerToyName} settings", e); } } if (!readSuccessfully) { Task.Delay(500, ts.Token).Wait(ts.Token); } } }); var completedInTime = t.Wait(3000, ts.Token); ts.Cancel(); ts.Dispose(); if (readSuccessfully) { FilterRemapKeysList(_profile?.RemapKeys?.InProcessRemapKeys); } else { success = false; } if (!completedInTime) { Logger.LogError($"Timeout encountered when loading {PowerToyName} profile"); } } catch (Exception e) { // Failed to load the configuration. Logger.LogError($"Exception encountered when loading {PowerToyName} profile", e); success = false; } if (!profileExists) { Logger.LogInfo($"Couldn't load {PowerToyName} profile because it doesn't exist"); } else if (!success) { Logger.LogError($"Couldn't load {PowerToyName} profile"); } return success; } } }