mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-03 09:46:54 +02:00
[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
committed by
GitHub
GitHub
parent
31a0deee35
commit
3176eb94a9
@@ -0,0 +1,13 @@
|
||||
// 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.
|
||||
|
||||
namespace Settings.UI.Library.Enumerations
|
||||
{
|
||||
public enum HostsDeleteBackupMode
|
||||
{
|
||||
Never = 0,
|
||||
Count = 1,
|
||||
Age = 2,
|
||||
}
|
||||
}
|
||||
@@ -1,10 +1,10 @@
|
||||
// Copyright (c) Microsoft Corporation
|
||||
// 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.IO;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
using Settings.UI.Library.Attributes;
|
||||
using Settings.UI.Library.Enumerations;
|
||||
|
||||
namespace Microsoft.PowerToys.Settings.UI.Library
|
||||
@@ -27,6 +27,17 @@ namespace Microsoft.PowerToys.Settings.UI.Library
|
||||
[JsonConverter(typeof(BoolPropertyJsonConverter))]
|
||||
public bool NoLeadingSpaces { get; set; }
|
||||
|
||||
[JsonConverter(typeof(BoolPropertyJsonConverter))]
|
||||
public bool BackupHosts { get; set; }
|
||||
|
||||
public string BackupPath { get; set; }
|
||||
|
||||
public HostsDeleteBackupMode DeleteBackupsMode { get; set; }
|
||||
|
||||
public int DeleteBackupsDays { get; set; }
|
||||
|
||||
public int DeleteBackupsCount { get; set; }
|
||||
|
||||
public HostsProperties()
|
||||
{
|
||||
ShowStartupWarning = true;
|
||||
@@ -35,6 +46,11 @@ namespace Microsoft.PowerToys.Settings.UI.Library
|
||||
AdditionalLinesPosition = HostsAdditionalLinesPosition.Top;
|
||||
Encoding = HostsEncoding.Utf8;
|
||||
NoLeadingSpaces = false;
|
||||
BackupHosts = true;
|
||||
BackupPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.Windows), @"System32\drivers\etc");
|
||||
DeleteBackupsMode = HostsDeleteBackupMode.Age;
|
||||
DeleteBackupsDays = 15;
|
||||
DeleteBackupsCount = 5;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,9 +7,24 @@
|
||||
xmlns:local="using:Microsoft.PowerToys.Settings.UI.Helpers"
|
||||
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
|
||||
xmlns:tkcontrols="using:CommunityToolkit.WinUI.Controls"
|
||||
xmlns:tkconverters="using:CommunityToolkit.WinUI.Converters"
|
||||
xmlns:ui="using:CommunityToolkit.WinUI"
|
||||
mc:Ignorable="d">
|
||||
|
||||
<Page.Resources>
|
||||
<tkconverters:ResourceNameToResourceStringConverter x:Key="ResourceNameToResourceStringConverter" />
|
||||
<tkconverters:DoubleToVisibilityConverter
|
||||
x:Key="CountBasedVisibilityConverter"
|
||||
FalseValue="Collapsed"
|
||||
GreaterThan="0"
|
||||
LessThan="2"
|
||||
TrueValue="Visible" />
|
||||
<tkconverters:DoubleToVisibilityConverter
|
||||
x:Key="AgeBasedVisibilityConverter"
|
||||
FalseValue="Collapsed"
|
||||
GreaterThan="1"
|
||||
LessThan="3"
|
||||
TrueValue="Visible" />
|
||||
</Page.Resources>
|
||||
<controls:SettingsPageControl x:Uid="Hosts" ModuleImageSource="ms-appx:///Assets/Settings/Modules/HostsFileEditor.png">
|
||||
<controls:SettingsPageControl.ModuleContent>
|
||||
<StackPanel ChildrenTransitions="{StaticResource SettingsCardsAnimations}" Orientation="Vertical">
|
||||
@@ -70,6 +85,92 @@
|
||||
</ComboBox>
|
||||
</tkcontrols:SettingsCard>
|
||||
</controls:SettingsGroup>
|
||||
|
||||
<controls:SettingsGroup x:Uid="Hosts_Backup_GroupSettings" IsEnabled="{x:Bind ViewModel.IsEnabled, Mode=OneWay}">
|
||||
<tkcontrols:SettingsExpander
|
||||
x:Uid="Hosts_Backup"
|
||||
HeaderIcon="{ui:FontIcon Glyph=}"
|
||||
IsExpanded="True">
|
||||
<ToggleSwitch IsOn="{x:Bind ViewModel.BackupHosts, Mode=TwoWay}" />
|
||||
<tkcontrols:SettingsExpander.Items>
|
||||
<tkcontrols:SettingsCard x:Uid="Hosts_Backup_Location" IsEnabled="{x:Bind ViewModel.BackupHosts, Mode=OneWay}">
|
||||
<Grid ColumnSpacing="8">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="*" />
|
||||
<ColumnDefinition Width="Auto" />
|
||||
</Grid.ColumnDefinitions>
|
||||
<TextBlock
|
||||
x:Name="pathTextBlock"
|
||||
Grid.Column="0"
|
||||
VerticalAlignment="Center"
|
||||
Foreground="{ThemeResource TextFillColorSecondaryBrush}"
|
||||
IsTextSelectionEnabled="True"
|
||||
Text="{x:Bind ViewModel.BackupPath, Mode=TwoWay}"
|
||||
TextWrapping="Wrap">
|
||||
<ToolTipService.ToolTip>
|
||||
<ToolTip IsEnabled="{Binding IsTextTrimmed, ElementName=pathTextBlock, Mode=OneWay}">
|
||||
<TextBlock Text="{x:Bind ViewModel.BackupPath, Mode=TwoWay}" />
|
||||
</ToolTip>
|
||||
</ToolTipService.ToolTip>
|
||||
</TextBlock>
|
||||
<Button
|
||||
Grid.Column="1"
|
||||
Command="{x:Bind ViewModel.SelectBackupPathEventHandler}"
|
||||
Content=""
|
||||
FontFamily="{ThemeResource SymbolThemeFontFamily}">
|
||||
<ToolTipService.ToolTip>
|
||||
<ToolTip>
|
||||
<TextBlock x:Uid="Hosts_ButtonSelectLocation" />
|
||||
</ToolTip>
|
||||
</ToolTipService.ToolTip>
|
||||
</Button>
|
||||
</Grid>
|
||||
</tkcontrols:SettingsCard>
|
||||
<tkcontrols:SettingsCard x:Uid="Hosts_Delete_Backup" IsEnabled="{x:Bind ViewModel.BackupHosts, Mode=OneWay}">
|
||||
<ComboBox MinWidth="{StaticResource SettingActionControlMinWidth}" SelectedIndex="{x:Bind Path=ViewModel.DeleteBackupsMode, Mode=TwoWay}">
|
||||
<ComboBoxItem x:Uid="Hosts_DeleteBackupMode_Never" />
|
||||
<ComboBoxItem x:Uid="Hosts_DeleteBackupMode_CountBased" />
|
||||
<ComboBoxItem x:Uid="Hosts_DeleteBackupMode_AgeAndCountBased" />
|
||||
</ComboBox>
|
||||
</tkcontrols:SettingsCard>
|
||||
|
||||
<!-- Count -->
|
||||
<tkcontrols:SettingsCard
|
||||
x:Name="BackupsCountInputSettingsCard"
|
||||
IsEnabled="{x:Bind ViewModel.BackupHosts, Mode=OneWay}"
|
||||
Visibility="{x:Bind ViewModel.DeleteBackupsMode, Converter={StaticResource CountBasedVisibilityConverter}, Mode=OneWay}">
|
||||
<NumberBox
|
||||
MinWidth="{StaticResource SettingActionControlMinWidth}"
|
||||
Minimum="{x:Bind ViewModel.MinimumBackupsCount, Mode=OneWay}"
|
||||
SpinButtonPlacementMode="Compact"
|
||||
Value="{x:Bind ViewModel.DeleteBackupsCount, Mode=TwoWay}" />
|
||||
</tkcontrols:SettingsCard>
|
||||
|
||||
<!-- Age and count -->
|
||||
<tkcontrols:SettingsCard
|
||||
x:Uid="Hosts_Backup_DaysInput"
|
||||
IsEnabled="{x:Bind ViewModel.BackupHosts, Mode=OneWay}"
|
||||
Visibility="{x:Bind ViewModel.DeleteBackupsMode, Converter={StaticResource AgeBasedVisibilityConverter}, Mode=OneWay}">
|
||||
<NumberBox
|
||||
MinWidth="{StaticResource SettingActionControlMinWidth}"
|
||||
Minimum="1"
|
||||
SpinButtonPlacementMode="Compact"
|
||||
Value="{x:Bind ViewModel.DeleteBackupsDays, Mode=TwoWay}" />
|
||||
</tkcontrols:SettingsCard>
|
||||
<tkcontrols:SettingsCard
|
||||
x:Name="BackupsCountInputAgeSettingsCard"
|
||||
IsEnabled="{x:Bind ViewModel.BackupHosts, Mode=OneWay}"
|
||||
Visibility="{x:Bind ViewModel.DeleteBackupsMode, Converter={StaticResource AgeBasedVisibilityConverter}, Mode=OneWay}">
|
||||
<NumberBox
|
||||
MinWidth="{StaticResource SettingActionControlMinWidth}"
|
||||
Minimum="{x:Bind ViewModel.MinimumBackupsCount, Mode=OneWay}"
|
||||
SpinButtonPlacementMode="Compact"
|
||||
Value="{x:Bind ViewModel.DeleteBackupsCount, Mode=TwoWay}" />
|
||||
</tkcontrols:SettingsCard>
|
||||
|
||||
</tkcontrols:SettingsExpander.Items>
|
||||
</tkcontrols:SettingsExpander>
|
||||
</controls:SettingsGroup>
|
||||
</StackPanel>
|
||||
</controls:SettingsPageControl.ModuleContent>
|
||||
|
||||
|
||||
@@ -18,6 +18,10 @@ namespace Microsoft.PowerToys.Settings.UI.Views
|
||||
InitializeComponent();
|
||||
var settingsUtils = new SettingsUtils();
|
||||
ViewModel = new HostsViewModel(settingsUtils, SettingsRepository<GeneralSettings>.GetInstance(settingsUtils), SettingsRepository<HostsSettings>.GetInstance(settingsUtils), ShellPage.SendDefaultIPCMessage, App.IsElevated);
|
||||
BackupsCountInputSettingsCard.Header = ResourceLoaderInstance.ResourceLoader.GetString("Hosts_Backup_CountInput_Header");
|
||||
BackupsCountInputSettingsCard.Description = ResourceLoaderInstance.ResourceLoader.GetString("Hosts_Backup_CountInput_Description");
|
||||
BackupsCountInputAgeSettingsCard.Header = ResourceLoaderInstance.ResourceLoader.GetString("Hosts_Backup_CountInput_Header");
|
||||
BackupsCountInputAgeSettingsCard.Description = ResourceLoaderInstance.ResourceLoader.GetString("Hosts_Backup_CountInput_Age_Description");
|
||||
}
|
||||
|
||||
public void RefreshEnabledState()
|
||||
|
||||
@@ -5599,4 +5599,48 @@ To record a specific window, enter the hotkey with the Alt key in the opposite m
|
||||
<data name="Shortcut_Conflict_LearnMore.Content" xml:space="preserve">
|
||||
<value>Learn more</value>
|
||||
</data>
|
||||
<data name="Hosts_Backup_GroupSettings.Header" xml:space="preserve">
|
||||
<value>Backup</value>
|
||||
</data>
|
||||
<data name="Hosts_Backup.Header" xml:space="preserve">
|
||||
<value>Backup hosts file</value>
|
||||
<comment>"Hosts" refers to the system hosts file, do not loc</comment>
|
||||
</data>
|
||||
<data name="Hosts_Backup.Description" xml:space="preserve">
|
||||
<value>Automatically create a backup of the hosts file when you save for the first time in a session</value>
|
||||
<comment>"Hosts" refers to the system hosts file, do not loc</comment>
|
||||
</data>
|
||||
<data name="Hosts_Backup_Location.Header" xml:space="preserve">
|
||||
<value>Location</value>
|
||||
</data>
|
||||
<data name="Hosts_ButtonSelectLocation.Text" xml:space="preserve">
|
||||
<value>Select location</value>
|
||||
</data>
|
||||
<data name="Hosts_Delete_Backup.Header" xml:space="preserve">
|
||||
<value>Automatically delete backups</value>
|
||||
</data>
|
||||
<data name="Hosts_Backup_DaysInput.Header" xml:space="preserve">
|
||||
<value>Days</value>
|
||||
</data>
|
||||
<data name="Hosts_Backup_CountInput_Description" xml:space="preserve">
|
||||
<value>Set the number of backups to keep. Older backups will be deleted once the limit is reached.</value>
|
||||
</data>
|
||||
<data name="Hosts_Backup_DaysInput.Description" xml:space="preserve">
|
||||
<value>Set the number of days to keep backups. Older backups will be deleted once the limit is reached.</value>
|
||||
</data>
|
||||
<data name="Hosts_DeleteBackupMode_Never.Content" xml:space="preserve">
|
||||
<value>Never</value>
|
||||
</data>
|
||||
<data name="Hosts_DeleteBackupMode_CountBased.Content" xml:space="preserve">
|
||||
<value>Based on count</value>
|
||||
</data>
|
||||
<data name="Hosts_DeleteBackupMode_AgeAndCountBased.Content" xml:space="preserve">
|
||||
<value>Based on age and count</value>
|
||||
</data>
|
||||
<data name="Hosts_Backup_CountInput_Age_Description" xml:space="preserve">
|
||||
<value>Set an optional number of backups to always keep despite their age</value>
|
||||
</data>
|
||||
<data name="Hosts_Backup_CountInput_Header" xml:space="preserve">
|
||||
<value>Backup count</value>
|
||||
</data>
|
||||
</root>
|
||||
@@ -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;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user