[Hosts] Backup Settings (#37778)

<!-- 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

Add backup settings for the Hosts File Editor to allow users to
customize the existing hardcoded logic.

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [x] **Closes:** #37666
- [ ] **Communication:** I've discussed this with core contributors
already. If 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)
- [x] **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:
https://github.com/MicrosoftDocs/windows-dev-docs/pull/5342

<!-- 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

<img width="707" alt="image"
src="https://github.com/user-attachments/assets/e114431e-60e0-4b8c-bba7-df23f7af0182"
/>

<img width="707" alt="image"
src="https://github.com/user-attachments/assets/a02b591e-eb46-4964-bee7-548ec175b3aa"
/>

<img width="707" alt="image"
src="https://github.com/user-attachments/assets/6eb0ff21-74fa-4229-8832-df2df877b5cd"
/>

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed

- Backup on: verified that backup isn't executed
- Backups off: Verified that only one backup is executed
- Verified that backup is located in the expected path
- Auto delete is set to "never": verified that no backups are deleted
- Auto delete is set to "based on count": verified that backups are
deleted according to count value
- Auto delete is set to "based on age and count": verified that backups
are deleted according to days and count values
- Verified that files without the backup pattern aren't deleted
- There is also adequate test coverage for these scenarios 🚀

---------

Co-authored-by: Gordon Lam (SH) <yeelam@microsoft.com>
This commit is contained in:
Davide Giacometti
2025-11-05 09:42:31 +01:00
committed by GitHub
parent 31a0deee35
commit 3176eb94a9
19 changed files with 686 additions and 84 deletions

View File

@@ -5,8 +5,8 @@
using System;
using System.Runtime.CompilerServices;
using System.Threading;
using global::PowerToys.GPOWrapper;
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;
@@ -33,6 +33,8 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
public ButtonClickCommand LaunchEventHandler => new ButtonClickCommand(Launch);
public ButtonClickCommand SelectBackupPathEventHandler => new ButtonClickCommand(SelectBackupPath);
public bool IsEnabled
{
get => _isEnabled;
@@ -144,6 +146,74 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
}
}
public bool BackupHosts
{
get => Settings.Properties.BackupHosts;
set
{
if (value != Settings.Properties.BackupHosts)
{
Settings.Properties.BackupHosts = value;
NotifyPropertyChanged();
}
}
}
public string BackupPath
{
get => Settings.Properties.BackupPath;
set
{
if (value != Settings.Properties.BackupPath)
{
Settings.Properties.BackupPath = value;
NotifyPropertyChanged();
}
}
}
public int DeleteBackupsMode
{
get => (int)Settings.Properties.DeleteBackupsMode;
set
{
if (value != (int)Settings.Properties.DeleteBackupsMode)
{
Settings.Properties.DeleteBackupsMode = (HostsDeleteBackupMode)value;
NotifyPropertyChanged();
OnPropertyChanged(nameof(MinimumBackupsCount));
}
}
}
public int DeleteBackupsDays
{
get => Settings.Properties.DeleteBackupsDays;
set
{
if (value != Settings.Properties.DeleteBackupsDays)
{
Settings.Properties.DeleteBackupsDays = value;
NotifyPropertyChanged();
}
}
}
public int DeleteBackupsCount
{
get => Settings.Properties.DeleteBackupsCount;
set
{
if (value != Settings.Properties.DeleteBackupsCount)
{
Settings.Properties.DeleteBackupsCount = value;
NotifyPropertyChanged();
}
}
}
public int MinimumBackupsCount => DeleteBackupsMode == 1 ? 1 : 0;
public HostsViewModel(ISettingsUtils settingsUtils, ISettingsRepository<GeneralSettings> settingsRepository, ISettingsRepository<HostsSettings> moduleSettingsRepository, Func<string, int> ipcMSGCallBackFunc, bool isElevated)
{
SettingsUtils = settingsUtils;
@@ -192,5 +262,18 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
InitializeEnabledValue();
OnPropertyChanged(nameof(IsEnabled));
}
public void SelectBackupPath()
{
// 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
var hwnd = WinRT.Interop.WindowNative.GetWindowHandle(App.GetSettingsWindow());
var result = ShellGetFolder.GetFolderDialog(hwnd);
if (!string.IsNullOrEmpty(result))
{
BackupPath = result;
}
}
}
}