Jeremy Sinclair 00ee6c1510
[Dev][Build] .NET 9 Upgrade (#35716)
* [Deps] Upgrade Framework Libraries to .NET 9 RC2

* [Common][Build] Update TFM to NET9

* [FileLocksmith][Build] Update TFM to NET9 in Publish Profile

* [PreviewPane][Build] Update TFM to NET9 in Publish Profile

* [PTRun][Build] Update TFM to NET9 in Publish Profile

* [Settings][Build] Update TFM to NET9 in Publish Profile

* [MouseWithoutBorders][Analyzers] Resolve WFO1000 by configuring Designer Serialization Visibility

* [Deps] Update Microsoft.CodeAnalysis.NetAnalyzers

* [Analyzers] Set CA1859,CA2263,CA2022 to be excluded from error

* [MouseWithoutBorders] Use System.Threading.Lock to lock instead of object instance

* [ColorPicker] Use System.Threading.Lock to lock instead of object instance

* [AdvancedPaste] Use System.Threading.Lock to lock instead of object instance

* [TextExtractor] Use System.Threading.Lock to lock instead of object instance

* [Hosts] Use System.Threading.Lock to lock instead of object instance

* [MouseJump] Use System.Threading.Lock to lock instead of object instance

* [PTRun] Use System.Threading.Lock to lock instead of object instance

* [Wox] Use System.Threading.Lock to lock instead of object instance

* [Peek] Use System.Threading.Lock to lock instead of object instance

* [PowerAccent] Use System.Threading.Lock to lock instead of object instance

* [Settings] Use System.Threading.Lock to lock instead of object instance

* [Deps] Update NOTICE.md

* [CI] Update .NET version step to target 9.0

* [Build] Attempt to add manual trigger for using Visual Studio Preview for building

* [Build] Fix variable typo

* [Build][Temporary] set to use preview builds

* [Build] Add missing parameters

* [Build][Temporary] directly hardcode preview image

* [Build][Temporary] Trying ImageOverride

* [Build] Revert hardcode and use ImageOverride

* [Build] Add env var for adding prerelease argument for vswhere

* [Build] Update VCToolsVersion script to use env var to optionally add prerelease version checking

* [Build] Remove unneeded parameter

* [Build] Re-add parameter in all the right places

* [CI][Build] Add NoWarn NU5104 when building with VS Preview

* [Deps] Update to stable .NET 9 packages

* [Deps] Update NOTICE.md

* Everything is WPF and WindowsForms now to fix .NET 9 dependency conflicts

* Ensure .NET 9 SDK for tests too

---------

Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
2024-11-13 12:36:45 -05:00

1405 lines
52 KiB
C#

// 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.Collections.ObjectModel;
using System.Globalization;
using System.Linq;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Input;
using System.Windows.Interop;
using System.Windows.Threading;
using Common.UI;
using Mages.Core.Runtime.Converters;
using Microsoft.PowerLauncher.Telemetry;
using Microsoft.PowerToys.Telemetry;
using PowerLauncher.Helper;
using PowerLauncher.Plugin;
using PowerLauncher.Storage;
using PowerToys.Interop;
using Wox.Infrastructure;
using Wox.Infrastructure.Hotkey;
using Wox.Infrastructure.Storage;
using Wox.Infrastructure.UserSettings;
using Wox.Plugin;
using Wox.Plugin.Logger;
namespace PowerLauncher.ViewModel
{
[System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1309:Use ordinal string comparison", Justification = "Using CurrentCultureIgnoreCase for user facing strings. Each usage is attributed with a comment.")]
public class MainViewModel : BaseModel, IMainViewModel, ISavable, IDisposable
{
private string _currentQuery;
private static string _emptyQuery = string.Empty;
private static bool _disposed;
private readonly WoxJsonStorage<QueryHistory> _historyItemsStorage;
private readonly WoxJsonStorage<UserSelectedRecord> _userSelectedRecordStorage;
private readonly PowerToysRunSettings _settings;
private readonly QueryHistory _history;
private readonly UserSelectedRecord _userSelectedRecord;
private static readonly Lock _addResultsLock = new Lock();
private readonly System.Diagnostics.Stopwatch _hotkeyTimer = new System.Diagnostics.Stopwatch();
private string _queryTextBeforeLeaveResults;
private CancellationTokenSource _updateSource;
private CancellationToken _updateToken;
private CancellationToken _nativeWaiterCancelToken;
private bool _saved;
private ushort _hotkeyHandle;
private const int _globalHotKeyId = 0x0001;
private IntPtr _globalHotKeyHwnd;
private uint _globalHotKeyVK;
private uint _globalHotKeyFSModifiers;
private bool _usingGlobalHotKey;
internal HotkeyManager HotkeyManager { get; private set; }
private static readonly CompositeFormat RegisterHotkeyFailed = System.Text.CompositeFormat.Parse(Properties.Resources.registerHotkeyFailed);
public MainViewModel(PowerToysRunSettings settings, CancellationToken nativeThreadCancelToken)
{
_saved = false;
_queryTextBeforeLeaveResults = string.Empty;
_currentQuery = _emptyQuery;
_disposed = false;
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
_nativeWaiterCancelToken = nativeThreadCancelToken;
_historyItemsStorage = new WoxJsonStorage<QueryHistory>();
_userSelectedRecordStorage = new WoxJsonStorage<UserSelectedRecord>();
_history = _historyItemsStorage.Load();
_userSelectedRecord = _userSelectedRecordStorage.Load();
ContextMenu = new ResultsViewModel(_settings, this);
Results = new ResultsViewModel(_settings, this);
History = new ResultsViewModel(_settings, this);
_selectedResults = Results;
InitializeKeyCommands();
RegisterResultsUpdatedEvent();
}
public void RemoveUserSelectedRecord(Result result)
{
_userSelectedRecord.Remove(result);
}
public void RegisterHotkey(IntPtr hwnd)
{
Log.Info("RegisterHotkey()", GetType());
// Allow OOBE to call PowerToys Run.
NativeEventWaiter.WaitForEventLoop(Constants.PowerLauncherSharedEvent(), OnHotkey, Application.Current.Dispatcher, _nativeWaiterCancelToken);
if (_settings.StartedFromPowerToysRunner)
{
// Allow runner to call PowerToys Run from the centralized keyboard hook.
NativeEventWaiter.WaitForEventLoop(Constants.PowerLauncherCentralizedHookSharedEvent(), OnCentralizedKeyboardHookHotKey, Application.Current.Dispatcher, _nativeWaiterCancelToken);
}
_settings.PropertyChanged += (s, e) =>
{
if (e.PropertyName == nameof(PowerToysRunSettings.Hotkey) || e.PropertyName == nameof(PowerToysRunSettings.UseCentralizedKeyboardHook))
{
Application.Current.Dispatcher.Invoke(() =>
{
if (!string.IsNullOrEmpty(_settings.PreviousHotkey))
{
if (_usingGlobalHotKey)
{
NativeMethods.UnregisterHotKey(_globalHotKeyHwnd, _globalHotKeyId);
_usingGlobalHotKey = false;
Log.Info("Unregistering previous global hotkey", GetType());
}
if (_hotkeyHandle != 0)
{
HotkeyManager?.UnregisterHotkey(_hotkeyHandle);
_hotkeyHandle = 0;
Log.Info("Unregistering previous low level key handler", GetType());
}
}
if (!string.IsNullOrEmpty(_settings.Hotkey))
{
SetHotkey(hwnd, _settings.Hotkey, OnHotkey);
}
});
}
else if (e.PropertyName == nameof(PowerToysRunSettings.ShowPluginsOverview))
{
RefreshPluginsOverview();
}
};
SetHotkey(hwnd, _settings.Hotkey, OnHotkey);
// TODO: Custom plugin hotkeys.
// SetCustomPluginHotkey();
}
public void RegisterSettingsChangeListener(System.ComponentModel.PropertyChangedEventHandler handler)
{
_settings.PropertyChanged += handler;
}
private void RegisterResultsUpdatedEvent()
{
foreach (var pair in PluginManager.GetPluginsForInterface<IResultUpdated>())
{
var plugin = (IResultUpdated)pair.Plugin;
plugin.ResultsUpdated += (s, e) =>
{
Task.Run(
() =>
{
PluginManager.UpdatePluginMetadata(e.Results, pair.Metadata, e.Query);
UpdateResultView(e.Results, e.Query.RawQuery, _updateToken);
},
_updateToken);
};
}
}
private void OpenResultsEvent(object index, bool isMouseClick)
{
var results = SelectedResults;
if (index != null)
{
// Using InvariantCulture since this is internal
results.SelectedIndex = int.Parse(index.ToString(), CultureInfo.InvariantCulture);
}
if (results.SelectedItem != null)
{
bool executeResultRequired = false;
if (isMouseClick)
{
executeResultRequired = true;
}
else
{
// If there is a context button selected fire the action for that button instead, and the main command will not be executed
executeResultRequired = !results.SelectedItem.ExecuteSelectedContextButton();
}
if (executeResultRequired)
{
var result = results.SelectedItem.Result;
// SelectedItem returns null if selection is empty.
if (result != null && result.Action != null)
{
bool hideWindow = true;
Application.Current.Dispatcher.Invoke(() =>
{
hideWindow = result.Action(new ActionContext
{
SpecialKeyState = KeyboardHelper.CheckModifiers(),
});
});
if (hideWindow)
{
Hide();
}
if (SelectedIsFromQueryResults())
{
_userSelectedRecord.Add(result);
_history.Add(result.OriginQuery.RawQuery);
}
else
{
SelectedResults = Results;
}
}
}
}
}
private void InitializeKeyCommands()
{
IgnoreCommand = new RelayCommand(_ => { });
EscCommand = new RelayCommand(_ =>
{
if (!SelectedIsFromQueryResults())
{
SelectedResults = Results;
}
else
{
Hide();
}
});
SelectNextItemCommand = new RelayCommand(_ =>
{
SelectedResults.SelectNextResult();
});
SelectPrevItemCommand = new RelayCommand(_ =>
{
SelectedResults.SelectPrevResult();
});
SelectNextTabItemCommand = new RelayCommand(_ =>
{
SelectedResults.SelectNextTabItem();
});
SelectPrevTabItemCommand = new RelayCommand(_ =>
{
SelectedResults.SelectPrevTabItem();
});
SelectNextContextMenuItemCommand = new RelayCommand(_ =>
{
SelectedResults.SelectNextContextMenuItem();
});
SelectPreviousContextMenuItemCommand = new RelayCommand(_ =>
{
SelectedResults.SelectPreviousContextMenuItem();
});
SelectNextPageCommand = new RelayCommand(_ =>
{
SelectedResults.SelectNextPage();
});
SelectPrevPageCommand = new RelayCommand(_ =>
{
SelectedResults.SelectPrevPage();
});
OpenResultWithKeyboardCommand = new RelayCommand(index =>
{
OpenResultsEvent(index, false);
});
OpenResultWithMouseCommand = new RelayCommand(index =>
{
OpenResultsEvent(index, true);
});
ClearQueryCommand = new RelayCommand(_ =>
{
if (!string.IsNullOrEmpty(QueryText))
{
ChangeQueryText(string.Empty, true);
// Push Event to UI SystemQuery has changed
OnPropertyChanged(nameof(SystemQueryText));
}
});
SelectNextOverviewPluginCommand = new RelayCommand(_ =>
{
SelectNextOverviewPlugin();
});
SelectPrevOverviewPluginCommand = new RelayCommand(_ =>
{
SelectPrevOverviewPlugin();
});
}
private ResultsViewModel _results;
public ResultsViewModel Results
{
get => _results;
private set
{
if (value != _results)
{
_results = value;
OnPropertyChanged(nameof(Results));
}
}
}
public ResultsViewModel ContextMenu { get; private set; }
public ResultsViewModel History { get; private set; }
private string _systemQueryText = string.Empty;
public string SystemQueryText
{
get => _systemQueryText;
set
{
if (_systemQueryText != value)
{
_systemQueryText = value;
OnPropertyChanged(nameof(SystemQueryText));
}
}
}
private string _queryText = string.Empty;
public string QueryText
{
get => _queryText;
set
{
if (_queryText != value)
{
_queryText = value;
SetPluginsOverviewVisibility();
OnPropertyChanged(nameof(QueryText));
}
}
}
/// <summary>
/// we need move cursor to end when we manually changed query
/// but we don't want to move cursor to end when query is updated from TextBox.
/// Also we don't want to force the results to change unless explicitly told to.
/// </summary>
/// <param name="queryText">Text that is being queried from user</param>
/// <param name="requery">Optional Parameter that if true, will automatically execute a query against the updated text</param>
public void ChangeQueryText(string queryText, bool requery = false)
{
var sameQueryText = SystemQueryText == queryText;
SystemQueryText = queryText;
if (sameQueryText)
{
OnPropertyChanged(nameof(SystemQueryText));
}
if (requery)
{
QueryText = queryText;
Query();
}
}
public void SetPluginsOverviewVisibility()
{
if (_settings.ShowPluginsOverview != PowerToysRunSettings.ShowPluginsOverviewMode.None && (string.IsNullOrEmpty(_queryText) || string.IsNullOrWhiteSpace(_queryText)))
{
PluginsOverviewVisibility = Visibility.Visible;
}
else
{
PluginsOverviewVisibility = Visibility.Collapsed;
}
}
public void SetFontSize()
{
App.Current.Resources["TitleFontSize"] = (double)_settings.TitleFontSize;
}
public bool LastQuerySelected { get; set; }
private ResultsViewModel _selectedResults;
private ResultsViewModel SelectedResults
{
get
{
return _selectedResults;
}
set
{
_selectedResults = value;
if (SelectedIsFromQueryResults())
{
ContextMenu.Visibility = Visibility.Collapsed;
History.Visibility = Visibility.Collapsed;
ChangeQueryText(_queryTextBeforeLeaveResults);
}
else
{
Results.Visibility = Visibility.Collapsed;
_queryTextBeforeLeaveResults = QueryText;
}
_selectedResults.Visibility = Visibility.Collapsed;
}
}
public bool LoadedAtLeastOnce { get; set; }
private Visibility _visibility;
public Visibility MainWindowVisibility
{
get
{
return _visibility;
}
set
{
if (_visibility != value)
{
_visibility = value;
if (LoadedAtLeastOnce)
{
// Don't trigger telemetry on cold boot. Must have been loaded at least once.
if (value == Visibility.Visible)
{
PowerToysTelemetry.Log.WriteEvent(new LauncherShowEvent());
}
else
{
PowerToysTelemetry.Log.WriteEvent(new LauncherHideEvent());
}
}
OnPropertyChanged(nameof(MainWindowVisibility));
}
}
}
public ICommand IgnoreCommand { get; private set; }
public ICommand EscCommand { get; private set; }
public ICommand SelectNextItemCommand { get; private set; }
public ICommand SelectPrevItemCommand { get; private set; }
public ICommand SelectNextContextMenuItemCommand { get; private set; }
public ICommand SelectPreviousContextMenuItemCommand { get; private set; }
public ICommand SelectNextTabItemCommand { get; private set; }
public ICommand SelectPrevTabItemCommand { get; private set; }
public ICommand SelectNextPageCommand { get; private set; }
public ICommand SelectPrevPageCommand { get; private set; }
public ICommand OpenResultWithKeyboardCommand { get; private set; }
public ICommand OpenResultWithMouseCommand { get; private set; }
public ICommand ClearQueryCommand { get; private set; }
public ICommand SelectNextOverviewPluginCommand { get; private set; }
public ICommand SelectPrevOverviewPluginCommand { get; private set; }
public class QueryTuningOptions
{
public int SearchClickedItemWeight { get; set; }
public bool SearchQueryTuningEnabled { get; set; }
public bool SearchWaitForSlowResults { get; set; }
}
public void Query()
{
Query(null);
}
public void Query(bool? delayedExecution)
{
if (SelectedIsFromQueryResults())
{
QueryResults(delayedExecution);
}
else if (HistorySelected())
{
QueryHistory();
}
}
private void QueryHistory()
{
// Using CurrentCulture since query is received from user and used in downstream comparisons using CurrentCulture
var query = QueryText.ToLower(CultureInfo.CurrentCulture).Trim();
History.Clear();
var results = new List<Result>();
foreach (var h in _history.Items)
{
var title = Properties.Resources.executeQuery;
var time = Properties.Resources.lastExecuteTime;
var result = new Result
{
Title = string.Format(CultureInfo.InvariantCulture, title, h.Query),
SubTitle = string.Format(CultureInfo.InvariantCulture, time, h.ExecutedDateTime),
IcoPath = "Images\\history.png",
OriginQuery = new Query(h.Query),
Action = _ =>
{
SelectedResults = Results;
ChangeQueryText(h.Query);
return false;
},
};
results.Add(result);
}
if (!string.IsNullOrEmpty(query))
{
var filtered = results.Where(
r => StringMatcher.FuzzySearch(query, r.Title).IsSearchPrecisionScoreMet() ||
StringMatcher.FuzzySearch(query, r.SubTitle).IsSearchPrecisionScoreMet()).ToList();
History.AddResults(filtered, _updateToken);
}
else
{
History.AddResults(results, _updateToken);
}
}
private void QueryResults()
{
QueryResults(null);
}
private void QueryResults(bool? delayedExecution)
{
var queryTuning = GetQueryTuningOptions();
var doFinalSort = queryTuning.SearchQueryTuningEnabled && queryTuning.SearchWaitForSlowResults;
if (!string.IsNullOrEmpty(QueryText))
{
var queryTimer = new System.Diagnostics.Stopwatch();
queryTimer.Start();
_updateSource?.Cancel();
_updateSource?.Dispose();
var currentUpdateSource = new CancellationTokenSource();
_updateSource = currentUpdateSource;
_updateToken = _updateSource.Token;
var queryText = QueryText.Trim();
var pluginQueryPairs = QueryBuilder.Build(queryText);
if (pluginQueryPairs != null && pluginQueryPairs.Count > 0)
{
queryText = pluginQueryPairs.Values.First().RawQuery;
_currentQuery = queryText;
var queryResultsTask = Task.Factory.StartNew(
() =>
{
Thread.Sleep(20);
// Keep track of total number of results for telemetry
var numResults = 0;
// Contains all the plugins for which this raw query is valid
var plugins = pluginQueryPairs.Keys.ToList();
var sw = System.Diagnostics.Stopwatch.StartNew();
try
{
var resultPluginPair = new System.Collections.Concurrent.ConcurrentDictionary<PluginMetadata, List<Result>>();
if (_settings.PTRunNonDelayedSearchInParallel)
{
Parallel.ForEach(pluginQueryPairs, (pluginQueryItem) =>
{
try
{
var plugin = pluginQueryItem.Key;
var query = pluginQueryItem.Value;
query.SelectedItems = _userSelectedRecord.GetGenericHistory();
var results = PluginManager.QueryForPlugin(plugin, query);
resultPluginPair[plugin.Metadata] = results;
_updateToken.ThrowIfCancellationRequested();
}
catch (OperationCanceledException)
{
// nothing to do here
}
});
sw.Stop();
}
else
{
_updateToken.ThrowIfCancellationRequested();
// To execute a query corresponding to each plugin
foreach (KeyValuePair<PluginPair, Query> pluginQueryItem in pluginQueryPairs)
{
var plugin = pluginQueryItem.Key;
var query = pluginQueryItem.Value;
query.SelectedItems = _userSelectedRecord.GetGenericHistory();
var results = PluginManager.QueryForPlugin(plugin, query);
resultPluginPair[plugin.Metadata] = results;
_updateToken.ThrowIfCancellationRequested();
}
}
lock (_addResultsLock)
{
// Using CurrentCultureIgnoreCase since this is user facing
if (queryText.Equals(_currentQuery, StringComparison.CurrentCultureIgnoreCase))
{
Results.Clear();
foreach (var p in resultPluginPair)
{
UpdateResultView(p.Value, queryText, _updateToken);
_updateToken.ThrowIfCancellationRequested();
}
_updateToken.ThrowIfCancellationRequested();
numResults = Results.Results.Count;
if (!doFinalSort)
{
Results.Sort(queryTuning);
Results.SelectedItem = Results.Results.FirstOrDefault();
}
}
_updateToken.ThrowIfCancellationRequested();
if (!doFinalSort)
{
UpdateResultsListViewAfterQuery(queryText);
}
}
bool noInitialResults = numResults == 0;
if (!delayedExecution.HasValue || delayedExecution.Value)
{
// Run the slower query of the DelayedExecution plugins
_updateToken.ThrowIfCancellationRequested();
Parallel.ForEach(plugins, (plugin) =>
{
try
{
Query query;
pluginQueryPairs.TryGetValue(plugin, out query);
var results = PluginManager.QueryForPlugin(plugin, query, true);
_updateToken.ThrowIfCancellationRequested();
if ((results?.Count ?? 0) != 0)
{
lock (_addResultsLock)
{
// Using CurrentCultureIgnoreCase since this is user facing
if (queryText.Equals(_currentQuery, StringComparison.CurrentCultureIgnoreCase))
{
_updateToken.ThrowIfCancellationRequested();
// Remove the original results from the plugin
Results.Results.RemoveAll(r => r.Result.PluginID == plugin.Metadata.ID);
_updateToken.ThrowIfCancellationRequested();
// Add the new results from the plugin
UpdateResultView(results, queryText, _updateToken);
_updateToken.ThrowIfCancellationRequested();
numResults = Results.Results.Count;
if (!doFinalSort)
{
Results.Sort(queryTuning);
}
}
_updateToken.ThrowIfCancellationRequested();
if (!doFinalSort)
{
UpdateResultsListViewAfterQuery(queryText, noInitialResults, true);
}
}
}
}
catch (OperationCanceledException)
{
// nothing to do here
}
});
}
}
catch (OperationCanceledException)
{
// nothing to do here
}
queryTimer.Stop();
var queryEvent = new LauncherQueryEvent()
{
QueryTimeMs = queryTimer.ElapsedMilliseconds,
NumResults = numResults,
QueryLength = queryText.Length,
};
PowerToysTelemetry.Log.WriteEvent(queryEvent);
},
_updateToken);
if (doFinalSort)
{
Task.Factory.ContinueWhenAll(
new Task[] { queryResultsTask },
completedTasks =>
{
Results.Sort(queryTuning);
Results.SelectedItem = Results.Results.FirstOrDefault();
UpdateResultsListViewAfterQuery(queryText, false, false);
},
_updateToken);
}
}
}
else
{
_updateSource?.Cancel();
_currentQuery = _emptyQuery;
Results.SelectedItem = null;
Results.Visibility = Visibility.Collapsed;
Task.Run(() =>
{
lock (_addResultsLock)
{
Results.Clear();
}
});
}
}
private void UpdateResultsListViewAfterQuery(string queryText, bool noInitialResults = false, bool isDelayedInvoke = false)
{
Application.Current.Dispatcher.BeginInvoke(new Action(() =>
{
lock (_addResultsLock)
{
// Using CurrentCultureIgnoreCase since this is user facing
if (queryText.Equals(_currentQuery, StringComparison.CurrentCultureIgnoreCase))
{
Results.Results.NotifyChanges();
}
if (Results.Results.Count > 0)
{
Results.Visibility = Visibility.Visible;
if (!isDelayedInvoke || noInitialResults)
{
Results.SelectedIndex = 0;
if (noInitialResults)
{
Results.SelectedItem = Results.Results.FirstOrDefault();
}
}
}
else
{
Results.Visibility = Visibility.Collapsed;
}
}
}));
}
private bool SelectedIsFromQueryResults()
{
var selected = SelectedResults == Results;
return selected;
}
private bool HistorySelected()
{
var selected = SelectedResults == History;
return selected;
}
internal bool ProcessHotKeyMessages(IntPtr wparam, IntPtr lparam)
{
if (wparam.ToInt32() == _globalHotKeyId)
{
OnHotkey();
return true;
}
return false;
}
private static uint VKModifiersFromHotKey(Hotkey hotkey)
{
return (uint)(HOTKEY_MODIFIERS.NOREPEAT | (hotkey.Alt ? HOTKEY_MODIFIERS.ALT : 0) | (hotkey.Ctrl ? HOTKEY_MODIFIERS.CONTROL : 0) | (hotkey.Shift ? HOTKEY_MODIFIERS.SHIFT : 0) | (hotkey.Win ? HOTKEY_MODIFIERS.WIN : 0));
}
private void SetHotkey(IntPtr hwnd, string hotkeyStr, HotkeyCallback action)
{
var hotkey = new HotkeyModel(hotkeyStr);
SetHotkey(hwnd, hotkey, action);
}
private void SetHotkey(IntPtr hwnd, HotkeyModel hotkeyModel, HotkeyCallback action)
{
Log.Info("Set HotKey()", GetType());
string hotkeyStr = hotkeyModel.ToString();
try
{
Hotkey hotkey = new Hotkey
{
Alt = hotkeyModel.Alt,
Shift = hotkeyModel.Shift,
Ctrl = hotkeyModel.Ctrl,
Win = hotkeyModel.Win,
Key = (byte)KeyInterop.VirtualKeyFromKey(hotkeyModel.CharKey),
};
if (_usingGlobalHotKey)
{
NativeMethods.UnregisterHotKey(_globalHotKeyHwnd, _globalHotKeyId);
_usingGlobalHotKey = false;
Log.Info("Unregistering previous global hotkey", GetType());
}
if (_hotkeyHandle != 0)
{
HotkeyManager?.UnregisterHotkey(_hotkeyHandle);
_hotkeyHandle = 0;
Log.Info("Unregistering previous low level key handler", GetType());
}
if (_settings.StartedFromPowerToysRunner && _settings.UseCentralizedKeyboardHook)
{
Log.Info("Using the Centralized Keyboard Hook for the HotKey.", GetType());
}
else
{
_globalHotKeyVK = hotkey.Key;
_globalHotKeyFSModifiers = VKModifiersFromHotKey(hotkey);
if (NativeMethods.RegisterHotKey(hwnd, _globalHotKeyId, _globalHotKeyFSModifiers, _globalHotKeyVK))
{
// Using global hotkey registered through the native RegisterHotKey method.
_globalHotKeyHwnd = hwnd;
_usingGlobalHotKey = true;
Log.Info("Registered global hotkey", GetType());
return;
}
Log.Warn("Registering global shortcut failed. Will use low-level keyboard hook instead.", GetType());
// Using fallback low-level keyboard hook through HotkeyManager.
if (HotkeyManager == null)
{
HotkeyManager = new HotkeyManager();
}
_hotkeyHandle = HotkeyManager.RegisterHotkey(hotkey, action);
}
}
catch (Exception)
{
string errorMsg = string.Format(CultureInfo.InvariantCulture, RegisterHotkeyFailed, hotkeyStr);
MessageBox.Show(errorMsg, Properties.Resources.RegisterHotkeyFailedTitle);
}
}
/// <summary>
/// Checks if Wox should ignore any hotkeys
/// </summary>
/// <returns>if any hotkeys should be ignored</returns>
private bool ShouldIgnoreHotkeys()
{
// double if to omit calling win32 function
if (_settings.IgnoreHotkeysOnFullscreen)
{
if (WindowsInteropHelper.IsWindowFullscreen())
{
return true;
}
}
return false;
}
/* TODO: Custom Hotkeys for Plugins. Commented since this is an incomplete feature.
* This needs:
* - Support for use with global shortcut.
* - Support for use with the fallback Shortcut Manager.
* - Support for use through the runner centralized keyboard hooks.
private void SetCustomPluginHotkey()
{
if (_settings.CustomPluginHotkeys == null)
{
return;
}
foreach (CustomPluginHotkey hotkey in _settings.CustomPluginHotkeys)
{
SetHotkey(hotkey.Hotkey, () =>
{
if (ShouldIgnoreHotkeys())
{
return;
}
MainWindowVisibility = Visibility.Visible;
ChangeQueryText(hotkey.ActionKeyword);
});
}
}
*/
private void OnCentralizedKeyboardHookHotKey()
{
if (_settings.StartedFromPowerToysRunner && _settings.UseCentralizedKeyboardHook)
{
OnHotkey();
}
}
private void OnHotkey()
{
Application.Current.Dispatcher.Invoke(() =>
{
Log.Info("OnHotkey", MethodBase.GetCurrentMethod().DeclaringType);
if (!ShouldIgnoreHotkeys())
{
// If launcher window was hidden and the hotkey was pressed, start telemetry event
if (MainWindowVisibility != Visibility.Visible)
{
StartHotkeyTimer();
}
if (_settings.LastQueryMode == LastQueryMode.Empty)
{
ChangeQueryText(string.Empty);
}
else if (_settings.LastQueryMode == LastQueryMode.Preserved)
{
LastQuerySelected = true;
}
else if (_settings.LastQueryMode == LastQueryMode.Selected)
{
LastQuerySelected = false;
}
else
{
throw new ArgumentException($"wrong LastQueryMode: <{_settings.LastQueryMode}>");
}
ToggleWox();
}
});
}
public void ToggleWox()
{
if (MainWindowVisibility != Visibility.Visible)
{
MainWindowVisibility = Visibility.Visible;
// HACK: The following code in this if is a fix for https://github.com/microsoft/PowerToys/issues/30206 and https://github.com/microsoft/PowerToys/issues/33135
// WPF UI theme watcher removes the composition target background color, among other weird stuff.
// https://github.com/lepoco/wpfui/blob/303f0aefcd59a142bc681415dc4360a34a15f33d/src/Wpf.Ui/Controls/Window/WindowBackdrop.cs#L280
// So we set it back with https://github.com/lepoco/wpfui/blob/303f0aefcd59a142bc681415dc4360a34a15f33d/src/Wpf.Ui/Controls/Window/WindowBackdrop.cs#L191
var window = Application.Current.MainWindow;
// Only makes sense for Windows 11 or greater, since Windows 10 doesn't have Mica.
if (OSVersionHelper.IsWindows11())
{
Wpf.Ui.Controls.WindowBackdrop.RemoveBackground(window);
}
// Setting uint titlebarPvAttribute = 0xFFFFFFFE; works on 22H2 or higher, 21H2 (aka SV1) this value causes a crash
if (OSVersionHelper.IsGreaterThanWindows11_21H2())
{
// Taken from WPFUI's fix for the title bar issue. We should be able to remove this fix when WPF UI 4 is integrated.
// https://github.com/lepoco/wpfui/pull/1122/files#diff-196b404f4db09632665ef546da6c8e57302b2f3e3d082eb4b5c295ae3482d94a
IntPtr windowHandle = new WindowInteropHelper(window).Handle;
if (windowHandle == IntPtr.Zero)
{
return;
}
HwndSource windowSource = HwndSource.FromHwnd(windowHandle);
// Remove background from client area
if (windowSource != null && windowSource.Handle != IntPtr.Zero && windowSource?.CompositionTarget != null)
{
// NOTE: https://learn.microsoft.com/en-us/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute
// Specifying DWMWA_COLOR_DEFAULT (value 0xFFFFFFFF) for the color will reset the window back to using the system's default behavior for the caption color.
uint titlebarPvAttribute = 0xFFFFFFFE;
_ = Wox.Plugin.Common.Win32.NativeMethods.DwmSetWindowAttribute(
windowSource.Handle,
(int)Wox.Plugin.Common.Win32.DwmWindowAttributes.CaptionColor, // CaptionColor attribute is only available on Windows 11.
ref titlebarPvAttribute,
Marshal.SizeOf(typeof(uint)));
}
}
}
else
{
if (_settings.ClearInputOnLaunch)
{
ClearQueryCommand.Execute(null);
Task.Run(() =>
{
Thread.Sleep(100);
Application.Current.Dispatcher.BeginInvoke(DispatcherPriority.Normal, new Action(() =>
{
MainWindowVisibility = Visibility.Collapsed;
}));
});
}
else
{
MainWindowVisibility = Visibility.Collapsed;
}
}
}
public void Hide()
{
if (MainWindowVisibility != Visibility.Collapsed)
{
ToggleWox();
}
}
public void Save()
{
if (!_saved)
{
if (_historyItemsStorage.CheckVersionMismatch())
{
if (!_historyItemsStorage.TryLoadData())
{
_history.Update();
}
}
_historyItemsStorage.Save();
if (_userSelectedRecordStorage.CheckVersionMismatch())
{
if (!_userSelectedRecordStorage.TryLoadData())
{
_userSelectedRecord.Update();
}
}
_userSelectedRecordStorage.Save();
_saved = true;
}
}
/// <summary>
/// To avoid deadlock, this method should not called from main thread
/// </summary>
public void UpdateResultView(List<Result> list, string originQuery, CancellationToken ct)
{
ArgumentNullException.ThrowIfNull(list);
ArgumentNullException.ThrowIfNull(originQuery);
foreach (var result in list)
{
var selectedData = _userSelectedRecord.GetSelectedData(result);
result.SelectedCount = selectedData.SelectedCount;
result.LastSelected = selectedData.LastSelected;
}
// Using CurrentCultureIgnoreCase since this is user facing
if (originQuery.Equals(_currentQuery, StringComparison.CurrentCultureIgnoreCase))
{
ct.ThrowIfCancellationRequested();
Results.AddResults(list, ct);
}
}
public void HandleContextMenu(Key acceleratorKey, ModifierKeys acceleratorModifiers)
{
var results = SelectedResults;
if (results.SelectedItem != null)
{
foreach (ContextMenuItemViewModel contextMenuItems in results.SelectedItem.ContextMenuItems)
{
if (contextMenuItems.AcceleratorKey == acceleratorKey && contextMenuItems.AcceleratorModifiers == acceleratorModifiers)
{
contextMenuItems.Command.Execute(null);
}
}
}
}
public static bool ShouldAutoCompleteTextBeEmpty(string queryText, string autoCompleteText)
{
if (string.IsNullOrEmpty(autoCompleteText))
{
return false;
}
else
{
// Using Ordinal this is internal
return string.IsNullOrEmpty(queryText) || !autoCompleteText.StartsWith(queryText, StringComparison.Ordinal);
}
}
public static string GetAutoCompleteText(int index, string input, string query)
{
if (!string.IsNullOrEmpty(input) && !string.IsNullOrEmpty(query))
{
if (index == 0)
{
// Using OrdinalIgnoreCase because we want the characters to be exact in autocomplete text and the query
if (input.StartsWith(query, StringComparison.OrdinalIgnoreCase))
{
// Use the same case as the input query for the matched portion of the string
return string.Concat(query, input.AsSpan(query.Length));
}
}
}
return string.Empty;
}
public static string GetSearchText(int index, string input, string query)
{
if (!string.IsNullOrEmpty(input))
{
if (index == 0 && !string.IsNullOrEmpty(query))
{
// Using OrdinalIgnoreCase since this is internal
if (input.StartsWith(query, StringComparison.OrdinalIgnoreCase))
{
return string.Concat(query, input.AsSpan(query.Length));
}
}
return input;
}
return string.Empty;
}
public static FlowDirection GetLanguageFlowDirection()
{
try
{
bool isCurrentLanguageRightToLeft = System.Windows.Input.InputLanguageManager.Current.CurrentInputLanguage.TextInfo.IsRightToLeft;
return isCurrentLanguageRightToLeft ? FlowDirection.RightToLeft : FlowDirection.LeftToRight;
}
catch (CultureNotFoundException ex)
{
Log.Exception($"CultureNotFoundException: {ex.Message}", ex, MethodBase.GetCurrentMethod().DeclaringType);
return FlowDirection.LeftToRight; // default FlowDirection.LeftToRight
}
}
protected virtual void Dispose(bool disposing)
{
if (!_disposed)
{
if (disposing)
{
if (_usingGlobalHotKey)
{
NativeMethods.UnregisterHotKey(_globalHotKeyHwnd, _globalHotKeyId);
_usingGlobalHotKey = false;
}
if (_hotkeyHandle != 0)
{
HotkeyManager?.UnregisterHotkey(_hotkeyHandle);
}
HotkeyManager?.Dispose();
_updateSource?.Dispose();
_disposed = true;
}
}
}
public void Dispose()
{
Dispose(disposing: true);
GC.SuppressFinalize(this);
}
public void StartHotkeyTimer()
{
_hotkeyTimer.Start();
}
public long GetHotkeyEventTimeMs()
{
_hotkeyTimer.Stop();
long recordedTime = _hotkeyTimer.ElapsedMilliseconds;
// Reset the stopwatch and return the time elapsed
_hotkeyTimer.Reset();
return recordedTime;
}
public bool GetSearchQueryResultsWithDelaySetting()
{
return _settings.SearchQueryResultsWithDelay;
}
public int GetSearchInputDelayFastSetting()
{
return _settings.SearchInputDelayFast;
}
public int GetSearchInputDelaySetting()
{
return _settings.SearchInputDelay;
}
public QueryTuningOptions GetQueryTuningOptions()
{
return new MainViewModel.QueryTuningOptions
{
SearchClickedItemWeight = GetSearchClickedItemWeight(),
SearchQueryTuningEnabled = GetSearchQueryTuningEnabled(),
SearchWaitForSlowResults = GetSearchWaitForSlowResults(),
};
}
public int GetSearchClickedItemWeight()
{
return _settings.SearchClickedItemWeight;
}
public bool GetSearchQueryTuningEnabled()
{
return _settings.SearchQueryTuningEnabled;
}
public bool GetSearchWaitForSlowResults()
{
return _settings.SearchWaitForSlowResults;
}
public static void PerformSafeAction(Action action)
{
lock (_addResultsLock)
{
action.Invoke();
}
}
public ObservableCollection<PluginPair> Plugins { get; } = new();
private PluginPair _selectedPlugin;
public PluginPair SelectedPlugin
{
get => _selectedPlugin;
set
{
if (_selectedPlugin != value)
{
_selectedPlugin = value;
OnPropertyChanged(nameof(SelectedPlugin));
}
}
}
private Visibility _pluginsOverviewVisibility = Visibility.Visible;
public Visibility PluginsOverviewVisibility
{
get => _pluginsOverviewVisibility;
set
{
if (_pluginsOverviewVisibility != value)
{
_pluginsOverviewVisibility = value;
OnPropertyChanged(nameof(PluginsOverviewVisibility));
}
}
}
public void RefreshPluginsOverview()
{
Log.Info("Refresh plugins overview", GetType());
Application.Current.Dispatcher.Invoke(() =>
{
Plugins.Clear();
foreach (var p in PluginManager.AllPlugins.Where(a => a.IsPluginInitialized && !a.Metadata.Disabled && a.Metadata.ActionKeyword != string.Empty))
{
if (_settings.ShowPluginsOverview == PowerToysRunSettings.ShowPluginsOverviewMode.All || (_settings.ShowPluginsOverview == PowerToysRunSettings.ShowPluginsOverviewMode.NonGlobal && !p.Metadata.IsGlobal))
{
Plugins.Add(p);
}
}
});
}
private void SelectNextOverviewPlugin()
{
if (Plugins.Count == 0)
{
return;
}
var selectedIndex = Plugins.IndexOf(SelectedPlugin);
if (selectedIndex == -1)
{
selectedIndex = 0;
}
else
{
if (++selectedIndex > Plugins.Count - 1)
{
selectedIndex = 0;
}
}
SelectedPlugin = Plugins[selectedIndex];
}
private void SelectPrevOverviewPlugin()
{
if (Plugins.Count == 0)
{
return;
}
var selectedIndex = Plugins.IndexOf(SelectedPlugin);
if (selectedIndex == -1)
{
selectedIndex = Plugins.Count - 1;
}
else
{
if (--selectedIndex < 0)
{
selectedIndex = Plugins.Count - 1;
}
}
SelectedPlugin = Plugins[selectedIndex];
}
}
}