// 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.CodeAnalysis; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; using System.Windows.Input; 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; namespace Microsoft.PowerToys.Settings.UI.Library.ViewModels { public class KeyboardManagerViewModel : Observable { private GeneralSettings GeneralSettingsConfig { get; set; } private readonly ISettingsUtils _settingsUtils; private const string PowerToyName = KeyboardManagerSettings.ModuleName; private const string RemapKeyboardActionName = "RemapKeyboard"; private const string RemapKeyboardActionValue = "Open Remap Keyboard Window"; private const string EditShortcutActionName = "EditShortcut"; private const string EditShortcutActionValue = "Open Edit Shortcut Window"; private const string JsonFileType = ".json"; private const string ProfileFileMutexName = "PowerToys.KeyboardManager.ConfigMutex"; private const int ProfileFileMutexWaitTimeoutMilliseconds = 1000; public KeyboardManagerSettings Settings { get; set; } private ICommand _remapKeyboardCommand; private ICommand _editShortcutCommand; private KeyboardManagerProfile _profile; private Func SendConfigMSG { get; } private Func, int> FilterRemapKeysList { get; } [SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "Exceptions should not crash the program but will be logged until we can understand common exception scenarios")] public KeyboardManagerViewModel(ISettingsUtils settingsUtils, ISettingsRepository settingsRepository, Func ipcMSGCallBackFunc, Func, int> filterRemapKeysList) { if (settingsRepository == null) { throw new ArgumentNullException(nameof(settingsRepository)); } GeneralSettingsConfig = settingsRepository.SettingsConfig; // 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.GetSettings(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); } } public bool Enabled { get { return GeneralSettingsConfig.Enabled.KeyboardManager; } set { if (GeneralSettingsConfig.Enabled.KeyboardManager != value) { GeneralSettingsConfig.Enabled.KeyboardManager = value; OnPropertyChanged(nameof(Enabled)); OutGoingGeneralSettings outgoing = new OutGoingGeneralSettings(GeneralSettingsConfig); SendConfigMSG(outgoing.ToString()); } } } // 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) { 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 = "All Apps" }).ToList(); } else { return globalShortcutList.ConvertAll(x => new AppSpecificKeysDataModel { OriginalKeys = x.OriginalKeys, NewRemapKeys = x.NewRemapKeys, TargetApp = "All Apps" }).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)); // Note: FxCop suggests calling ConfigureAwait() for the following methods, // and calling ConfigureAwait(true) has the same behavior as not explicitly // calling it (continuations are scheduled on the task-creating thread) private async void OnRemapKeyboard() { await Task.Run(() => OnRemapKeyboardBackground()).ConfigureAwait(true); } private async void OnEditShortcut() { await Task.Run(() => OnEditShortcutBackground()).ConfigureAwait(true); } private async Task OnRemapKeyboardBackground() { Helper.AllowRunnerToForeground(); SendConfigMSG(Helper.GetSerializedCustomAction(PowerToyName, RemapKeyboardActionName, RemapKeyboardActionValue)); await Task.CompletedTask.ConfigureAwait(true); } private async Task OnEditShortcutBackground() { Helper.AllowRunnerToForeground(); SendConfigMSG(Helper.GetSerializedCustomAction(PowerToyName, EditShortcutActionName, EditShortcutActionValue)); await Task.CompletedTask.ConfigureAwait(true); } public void NotifyFileChanged() { OnPropertyChanged(nameof(RemapKeys)); OnPropertyChanged(nameof(RemapShortcuts)); } [SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "Exceptions here (especially mutex errors) should not halt app execution, but they will be logged.")] public bool LoadProfile() { var success = true; try { using (var profileFileMutex = Mutex.OpenExisting(ProfileFileMutexName)) { if (profileFileMutex.WaitOne(ProfileFileMutexWaitTimeoutMilliseconds)) { // update the UI element here. try { string fileName = Settings.Properties.ActiveConfiguration.Value + JsonFileType; if (_settingsUtils.SettingsExists(PowerToyName, fileName)) { _profile = _settingsUtils.GetSettings(PowerToyName, fileName); } else { // The KBM process out of runner creates the default.json file if it does not exist. success = false; } FilterRemapKeysList(_profile?.RemapKeys?.InProcessRemapKeys); } finally { // Make sure to release the mutex. profileFileMutex.ReleaseMutex(); } } else { success = false; } } } catch (Exception e) { // Failed to load the configuration. Logger.LogError($"Exception encountered when loading {PowerToyName} profile", e); success = false; } return success; } } }