2020-04-07 10:19:14 -07:00
|
|
|
// 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.
|
|
|
|
|
|
2020-09-04 11:56:52 +03:00
|
|
|
using System;
|
2022-10-13 03:41:21 -04:00
|
|
|
using System.Threading;
|
|
|
|
|
using System.Threading.Tasks;
|
2023-03-21 10:27:29 +01:00
|
|
|
using ManagedCommon;
|
2025-05-26 05:03:35 -04:00
|
|
|
using Microsoft.PowerToys.Settings.UI.Flyout;
|
2023-02-27 09:42:50 +00:00
|
|
|
using Microsoft.PowerToys.Settings.UI.Helpers;
|
2020-10-22 09:45:48 -07:00
|
|
|
using Microsoft.PowerToys.Settings.UI.Library;
|
2022-10-26 14:02:31 +01:00
|
|
|
using Microsoft.PowerToys.Settings.UI.ViewModels;
|
2022-04-19 22:00:28 +02:00
|
|
|
using Microsoft.UI.Xaml;
|
|
|
|
|
using Microsoft.UI.Xaml.Controls;
|
2025-06-17 14:49:54 +08:00
|
|
|
using Windows.Data.Json;
|
2020-03-12 07:25:24 +01:00
|
|
|
|
|
|
|
|
namespace Microsoft.PowerToys.Settings.UI.Views
|
|
|
|
|
{
|
2020-03-24 19:55:02 -07:00
|
|
|
/// <summary>
|
|
|
|
|
/// General Settings Page.
|
|
|
|
|
/// </summary>
|
Setting search (#41285)
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
- [ ] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [x] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx
<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
Localized search:
<img width="1576" height="480" alt="image"
src="https://github.com/user-attachments/assets/dd6e5e9f-419b-40b1-b796-f0799481ecfc"
/>
## AI summary
This pull request introduces infrastructure and code to support search
functionality for PowerToys settings, including a new search index
specification, a dedicated search library, and updates to the solution
configuration. The main changes are the addition of a spec describing
how settings should be indexed and navigated, the creation of a new
`Common.Search` project with a fuzz search implementation, and updates
to the solution file to include these new components.
**Settings Search Feature Implementation**
* Documentation:
* Added a detailed specification (`settings-search.md`) describing the
structure of PowerToys settings pages, how to index settings, navigation
logic, runtime search, result grouping, build-time indexing strategy,
and corner cases.
* New Search Library:
* Added the new `Common.Search` project to the solution, including its
project file and implementation of a fuzz search service
(`FuzzSearchService<T>`), match options, match results, and search
precision scoring.
[[1]](diffhunk://#diff-ddc06fa41e4e723e54181b0cb85cdd00f57f75725d51ceefa242d4d651a9a363R1-R8)
[[2]](diffhunk://#diff-1a2ca29fc33bcccf338a7843a040ca2c31ba821e8cab7064fab0dbb1224d454cR1-R39)
[[3]](diffhunk://#diff-242764d948b795f39653a84d9b6bfcdc52730100deab2e3a0995be95bb8e7868R1-R10)
[[4]](diffhunk://#diff-61e525491ed916ebd65dabb66dd4f5dc720320d7e295ef1e0bd6d506ea0f7df6R1-R67)
[[5]](diffhunk://#diff-a775f6de2e8d42982829b4161668f49dedbbd9dcbb05ce20003de7e62275c57aR1-R12)
* Solution Configuration:
* Updated `PowerToys.sln` to include `Common.Search` and
`Settings.UI.XamlIndexBuilder` projects, and configured their build
settings for various platforms and mapped project dependencies.
[[1]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R714-R716)
[[2]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R2704-R2727)
[[3]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R2889)
[[4]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R3157-R3158)
**Spell-check Dictionary Updates**
* Added new terms related to navigation and settings UI components (such
as `Navigatable`, `NavigatablePage`, `settingscard`, `Tru`, `tweakable`)
to the spell-check dictionary to support the new search and indexing
features.
[[1]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1020-R1021)
[[2]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1498)
[[3]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1755-R1761)
---------
Co-authored-by: Niels Laute <niels.laute@live.nl>
Co-authored-by: Gordon Lam (SH) <yeelam@microsoft.com>
Co-authored-by: Gordon Lam <73506701+yeelam-gordon@users.noreply.github.com>
2025-08-25 21:23:07 +08:00
|
|
|
public sealed partial class GeneralPage : NavigatablePage, IRefreshablePage
|
2020-03-12 07:25:24 +01:00
|
|
|
{
|
2022-10-13 03:41:21 -04:00
|
|
|
private static DateTime OkToHideBackupAndRestoreMessageTime { get; set; }
|
|
|
|
|
|
2020-03-24 19:55:02 -07:00
|
|
|
/// <summary>
|
2020-04-17 15:25:08 -07:00
|
|
|
/// Gets or sets view model.
|
2020-03-24 19:55:02 -07:00
|
|
|
/// </summary>
|
2020-04-17 15:25:08 -07:00
|
|
|
public GeneralViewModel ViewModel { get; set; }
|
2020-03-12 07:25:24 +01:00
|
|
|
|
2020-03-24 19:55:02 -07:00
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="GeneralPage"/> class.
|
|
|
|
|
/// General Settings page constructor.
|
|
|
|
|
/// </summary>
|
2020-03-12 07:25:24 +01:00
|
|
|
public GeneralPage()
|
|
|
|
|
{
|
2020-08-19 15:59:10 -07:00
|
|
|
InitializeComponent();
|
2020-03-24 19:55:02 -07:00
|
|
|
|
2020-08-13 15:02:05 -07:00
|
|
|
// Load string resources
|
2023-07-20 00:12:46 +01:00
|
|
|
var loader = Helpers.ResourceLoaderInstance.ResourceLoader;
|
2020-11-02 18:33:43 +01:00
|
|
|
var settingsUtils = new SettingsUtils();
|
2020-08-13 15:02:05 -07:00
|
|
|
|
2022-04-19 22:00:28 +02:00
|
|
|
Action stateUpdatingAction = () =>
|
2021-05-21 13:32:34 +03:00
|
|
|
{
|
2022-04-19 22:00:28 +02:00
|
|
|
this.DispatcherQueue.TryEnqueue(() =>
|
|
|
|
|
{
|
|
|
|
|
ViewModel.RefreshUpdatingState();
|
|
|
|
|
});
|
2021-05-21 13:32:34 +03:00
|
|
|
};
|
|
|
|
|
|
2022-10-13 03:41:21 -04:00
|
|
|
Action hideBackupAndRestoreMessageArea = () =>
|
|
|
|
|
{
|
|
|
|
|
this.DispatcherQueue.TryEnqueue(async () =>
|
|
|
|
|
{
|
|
|
|
|
const int messageShowTimeIs = 10000;
|
|
|
|
|
|
|
|
|
|
// in order to keep the message for about 5 seconds after the last call
|
|
|
|
|
// and not need any lock/thread-synch, use an OK-To-Hide time, and wait just a little longer than that.
|
|
|
|
|
OkToHideBackupAndRestoreMessageTime = DateTime.UtcNow.AddMilliseconds(messageShowTimeIs - 16);
|
|
|
|
|
await System.Threading.Tasks.Task.Delay(messageShowTimeIs);
|
|
|
|
|
if (DateTime.UtcNow > OkToHideBackupAndRestoreMessageTime)
|
|
|
|
|
{
|
|
|
|
|
ViewModel.HideBackupAndRestoreMessageArea();
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
var doRefreshBackupRestoreStatus = new Action<int>(RefreshBackupRestoreStatus);
|
|
|
|
|
|
2020-08-19 15:59:10 -07:00
|
|
|
ViewModel = new GeneralViewModel(
|
2020-09-23 13:20:32 -07:00
|
|
|
SettingsRepository<GeneralSettings>.GetInstance(settingsUtils),
|
2020-08-13 15:02:05 -07:00
|
|
|
loader.GetString("GeneralSettings_RunningAsAdminText"),
|
|
|
|
|
loader.GetString("GeneralSettings_RunningAsUserText"),
|
|
|
|
|
ShellPage.IsElevated,
|
|
|
|
|
ShellPage.IsUserAnAdmin,
|
|
|
|
|
ShellPage.SendDefaultIPCMessage,
|
|
|
|
|
ShellPage.SendRestartAdminIPCMessage,
|
2021-05-21 13:32:34 +03:00
|
|
|
ShellPage.SendCheckForUpdatesIPCMessage,
|
|
|
|
|
string.Empty,
|
2022-10-13 03:41:21 -04:00
|
|
|
stateUpdatingAction,
|
|
|
|
|
hideBackupAndRestoreMessageArea,
|
|
|
|
|
doRefreshBackupRestoreStatus,
|
|
|
|
|
PickSingleFolderDialog,
|
|
|
|
|
loader);
|
2020-09-04 11:56:52 +03:00
|
|
|
|
2020-08-13 15:02:05 -07:00
|
|
|
DataContext = ViewModel;
|
2022-10-13 03:41:21 -04:00
|
|
|
|
2025-04-10 10:29:06 +02:00
|
|
|
ViewModel.InitializeReportBugLink();
|
|
|
|
|
|
2025-06-17 14:49:54 +08:00
|
|
|
// Register IPC handler for bug report status
|
|
|
|
|
ShellPage.ShellHandler.IPCResponseHandleList.Add(HandleBugReportStatusResponse); // Register cleanup on unload
|
|
|
|
|
this.Unloaded += GeneralPage_Unloaded;
|
|
|
|
|
|
|
|
|
|
CheckBugReportStatus();
|
|
|
|
|
|
2022-10-13 03:41:21 -04:00
|
|
|
doRefreshBackupRestoreStatus(100);
|
2020-08-13 15:02:05 -07:00
|
|
|
}
|
|
|
|
|
|
2021-02-09 14:11:51 +03:00
|
|
|
private void OpenColorsSettings_Click(object sender, RoutedEventArgs e)
|
|
|
|
|
{
|
2023-08-06 16:48:06 +01:00
|
|
|
try
|
|
|
|
|
{
|
|
|
|
|
Helpers.StartProcessHelper.Start(Helpers.StartProcessHelper.ColorsSettings);
|
|
|
|
|
}
|
|
|
|
|
catch (Exception ex)
|
|
|
|
|
{
|
|
|
|
|
Logger.LogError("Error while trying to open the system color settings", ex);
|
|
|
|
|
}
|
2021-02-09 14:11:51 +03:00
|
|
|
}
|
2022-10-13 03:41:21 -04:00
|
|
|
|
2024-10-24 22:04:32 +02:00
|
|
|
private void OpenDiagnosticsAndFeedbackSettings_Click(object sender, RoutedEventArgs e)
|
|
|
|
|
{
|
|
|
|
|
try
|
|
|
|
|
{
|
|
|
|
|
Helpers.StartProcessHelper.Start(Helpers.StartProcessHelper.DiagnosticsAndFeedback);
|
|
|
|
|
}
|
|
|
|
|
catch (Exception ex)
|
|
|
|
|
{
|
|
|
|
|
Logger.LogError("Error while trying to open the system Diagnostics & Feedback settings", ex);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-10-13 03:41:21 -04:00
|
|
|
private void RefreshBackupRestoreStatus(int delayMs = 0)
|
|
|
|
|
{
|
|
|
|
|
Task.Run(() =>
|
|
|
|
|
{
|
|
|
|
|
if (delayMs > 0)
|
|
|
|
|
{
|
|
|
|
|
Thread.Sleep(delayMs);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var settingsBackupAndRestoreUtils = SettingsBackupAndRestoreUtils.Instance;
|
|
|
|
|
var results = settingsBackupAndRestoreUtils.DryRunBackup();
|
|
|
|
|
this.DispatcherQueue.TryEnqueue(() =>
|
|
|
|
|
{
|
|
|
|
|
ViewModel.NotifyAllBackupAndRestoreProperties();
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void UpdateBackupAndRestoreStatusText(Microsoft.UI.Xaml.Documents.Hyperlink sender, Microsoft.UI.Xaml.Documents.HyperlinkClickEventArgs args)
|
|
|
|
|
{
|
|
|
|
|
RefreshBackupRestoreStatus();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private async Task<string> PickSingleFolderDialog()
|
|
|
|
|
{
|
2023-02-27 09:42:50 +00:00
|
|
|
// This function was changed to use the shell32 API to open folder dialog
|
|
|
|
|
// as the old one (PickSingleFolderAsync) can't work when the process is elevated
|
|
|
|
|
// TODO: go back PickSingleFolderAsync when it's fixed
|
2022-10-13 03:41:21 -04:00
|
|
|
var hwnd = WinRT.Interop.WindowNative.GetWindowHandle(App.GetSettingsWindow());
|
2023-02-27 09:42:50 +00:00
|
|
|
string r = await Task.FromResult<string>(ShellGetFolder.GetFolderDialog(hwnd));
|
|
|
|
|
return r;
|
2022-10-13 03:41:21 -04:00
|
|
|
}
|
2024-09-25 22:20:15 +02:00
|
|
|
|
|
|
|
|
private void Click_LanguageRestart(object sender, RoutedEventArgs e)
|
|
|
|
|
{
|
|
|
|
|
ViewModel.Restart();
|
|
|
|
|
}
|
2024-10-24 22:04:32 +02:00
|
|
|
|
|
|
|
|
private void Click_ViewDiagnosticDataViewerRestart(object sender, RoutedEventArgs e)
|
|
|
|
|
{
|
|
|
|
|
ViewModel.Restart();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void RefreshEnabledState()
|
|
|
|
|
{
|
|
|
|
|
ViewModel.RefreshSettingsOnExternalChange();
|
|
|
|
|
}
|
|
|
|
|
|
2024-10-31 09:15:42 +01:00
|
|
|
private async void ViewDiagnosticData_Click(object sender, RoutedEventArgs e)
|
2024-10-24 22:04:32 +02:00
|
|
|
{
|
2024-10-31 09:15:42 +01:00
|
|
|
await Task.Run(ViewModel.ViewDiagnosticData);
|
2024-10-24 22:04:32 +02:00
|
|
|
}
|
2025-05-26 05:03:35 -04:00
|
|
|
|
|
|
|
|
private void BugReportToolClicked(object sender, RoutedEventArgs e)
|
|
|
|
|
{
|
2025-06-17 14:49:54 +08:00
|
|
|
// Start bug report
|
2025-05-26 05:03:35 -04:00
|
|
|
var launchPage = new LaunchPage();
|
|
|
|
|
launchPage.ReportBugBtn_Click(sender, e);
|
2025-06-17 14:49:54 +08:00
|
|
|
|
|
|
|
|
ViewModel.IsBugReportRunning = true;
|
|
|
|
|
|
|
|
|
|
// No need to start timer - the observer pattern will notify us when it finishes
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void CheckBugReportStatus()
|
|
|
|
|
{
|
|
|
|
|
// Send one-time request to check current bug report status
|
|
|
|
|
string ipcMessage = "{ \"bug_report_status\": { } }";
|
|
|
|
|
ShellPage.SendDefaultIPCMessage(ipcMessage);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void HandleBugReportStatusResponse(JsonObject response)
|
|
|
|
|
{
|
|
|
|
|
if (response.ContainsKey("bug_report_running"))
|
|
|
|
|
{
|
|
|
|
|
var isRunning = response.GetNamedBoolean("bug_report_running");
|
|
|
|
|
|
|
|
|
|
// Update UI on the UI thread
|
|
|
|
|
this.DispatcherQueue.TryEnqueue(() =>
|
|
|
|
|
{
|
|
|
|
|
ViewModel.IsBugReportRunning = isRunning;
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void GeneralPage_Unloaded(object sender, RoutedEventArgs e)
|
|
|
|
|
{
|
|
|
|
|
CleanupBugReportHandlers();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void CleanupBugReportHandlers()
|
|
|
|
|
{
|
|
|
|
|
// Remove IPC handler
|
|
|
|
|
if (ShellPage.ShellHandler?.IPCResponseHandleList != null)
|
|
|
|
|
{
|
|
|
|
|
ShellPage.ShellHandler.IPCResponseHandleList.Remove(HandleBugReportStatusResponse);
|
|
|
|
|
}
|
2025-05-26 05:03:35 -04:00
|
|
|
}
|
2025-08-21 10:40:37 +02:00
|
|
|
|
|
|
|
|
private void ShowSystemTrayIcon_Toggled(object sender, RoutedEventArgs e)
|
|
|
|
|
{
|
|
|
|
|
if (sender is ToggleSwitch toggleSwitch)
|
|
|
|
|
{
|
|
|
|
|
var shellViewModel = ShellPage.ShellHandler?.ViewModel;
|
|
|
|
|
if (shellViewModel != null)
|
|
|
|
|
{
|
|
|
|
|
shellViewModel.ShowCloseMenu = !toggleSwitch.IsOn;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-03-12 07:25:24 +01:00
|
|
|
}
|
2020-04-02 06:08:56 -07:00
|
|
|
}
|