Feature: HostsFileEditor delete entry added (#3094)

* Feature: HostsFileEditor delete entry added

* Docs: #3094

Author: BornToBeRoot

Source/NETworkManager.Localization/Resources/Strings.Designer.cs

@@ -3933,4 +3933,9 @@ Right-click for more options.</value>
   <data name="Entries" xml:space="preserve">
     <value>Entries</value>
   </data>
+  <data name="DeleteHostsFileEntryMessage" xml:space="preserve">
+    <value>The selected entry is permanently deleted:
+
+{0} {1} {2}</value>
+  </data>
 </root>

Source/NETworkManager.Localization/Resources/Strings.resx

@@ -164,27 +164,52 @@ private static IEnumerable<HostsFileEntry> GetHostsFileEntries()
         return entries;
     }
 
-    public static Task<bool> EnableEntryAsync(HostsFileEntry entry)
+    /// <summary>
+    /// Enable a hosts file entry asynchronously.
+    /// </summary>
+    /// <param name="entry">Entry to enable.</param>
+    /// <returns><see cref="HostsFileEntryModifyResult.Success"/> if the entry was enabled successfully, otherwise an error result.</returns>
+    public static Task<HostsFileEntryModifyResult> EnableEntryAsync(HostsFileEntry entry)
     {
         return Task.Run(() => EnableEntry(entry));
     }
 
-    private static bool EnableEntry(HostsFileEntry entry)
+    /// <summary>
+    /// Enable a hosts file entry.
+    /// </summary>
+    /// <param name="entry">Entry to enable.</param>
+    /// <returns><see cref="HostsFileEntryModifyResult.Success"/> if the entry was enabled successfully, otherwise an error result.</returns>
+    private static HostsFileEntryModifyResult EnableEntry(HostsFileEntry entry)
     {
         // Create a backup of the hosts file before making changes
         if (CreateBackup() == false)
         {
             Log.Error("EnableEntry - Failed to create backup before enabling entry.");
-            return false;
+            return HostsFileEntryModifyResult.BackupError;
         }
 
         // Replace the entry in the hosts file
         var hostsFileLines = File.ReadAllLines(HostsFilePath).ToList();
 
+        bool entryFound = false;
+
         for (var i = 0; i < hostsFileLines.Count; i++)
         {
             if (hostsFileLines[i] == entry.Line)
+            {
+                entryFound = true;
+
                 hostsFileLines[i] = entry.Line.TrimStart('#', ' ');
+
+                break;
+            }
+        }
+
+        if (!entryFound)
+        {
+            Log.Warn($"EnableEntry - Entry not found in hosts file: {entry.Line}");
+
+            return HostsFileEntryModifyResult.NotFound;
         }
 
         try
@@ -195,34 +220,57 @@ private static bool EnableEntry(HostsFileEntry entry)
         catch (Exception ex)
         {
             Log.Error($"EnableEntry - Failed to write changes to hosts file: {HostsFilePath}", ex);
-
-            return false;
+            return HostsFileEntryModifyResult.WriteError;
         }
 
-        return true;
+        return HostsFileEntryModifyResult.Success;
     }
 
-    public static Task<bool> DisableEntryAsync(HostsFileEntry entry)
+    /// <summary>
+    /// Disable a hosts file entry asynchronously.
+    /// </summary>
+    /// <param name="entry">Entry to disable.</param>
+    /// <returns><see cref="HostsFileEntryModifyResult.Success"/> if the entry was enabled successfully, otherwise an error result.</returns>
+    public static Task<HostsFileEntryModifyResult> DisableEntryAsync(HostsFileEntry entry)
     {
         return Task.Run(() => DisableEntry(entry));
     }
 
-    private static bool DisableEntry(HostsFileEntry entry)
+    /// <summary>
+    /// Disable a hosts file entry.
+    /// </summary>
+    /// <param name="entry">Entry to disable.</param>
+    /// <returns><see cref="HostsFileEntryModifyResult.Success"/> if the entry was enabled successfully, otherwise an error result.</returns>
+    private static HostsFileEntryModifyResult DisableEntry(HostsFileEntry entry)
     {
         // Create a backup of the hosts file before making changes
         if (CreateBackup() == false)
         {
             Log.Error("DisableEntry - Failed to create backup before disabling entry.");
-            return false;
+            return HostsFileEntryModifyResult.BackupError;
         }
 
         // Replace the entry in the hosts file
         var hostsFileLines = File.ReadAllLines(HostsFilePath).ToList();
 
+        bool entryFound = false;
+
         for (var i = 0; i < hostsFileLines.Count; i++)
         {
             if (hostsFileLines[i] == entry.Line)
+            {
+                entryFound = true;
+
                 hostsFileLines[i] = "# " + entry.Line;
+
+                break;
+            }
+        }
+
+        if (!entryFound)
+        {
+            Log.Warn($"DisableEntry - Entry not found in hosts file: {entry.Line}");
+            return HostsFileEntryModifyResult.NotFound;
         }
 
         try
@@ -233,15 +281,75 @@ private static bool DisableEntry(HostsFileEntry entry)
         catch (Exception ex)
         {
             Log.Error($"DisableEntry - Failed to write changes to hosts file: {HostsFilePath}", ex);
+            return HostsFileEntryModifyResult.WriteError;
+        }
 
-            return false;
+        return HostsFileEntryModifyResult.Success;
+    }
+
+    /// <summary>
+    /// Delete a hosts file entry asynchronously.
+    /// </summary>
+    /// <param name="entry">Entry to delete.</param>"/>
+    /// <returns><see cref="HostsFileEntryModifyResult.Success"/> if the entry was enabled successfully, otherwise an error result.</returns>s
+    public static Task<HostsFileEntryModifyResult> DeleteEntryAsync(HostsFileEntry entry)
+    {
+        return Task.Run(() => DeleteEntry(entry));
+    }
+
+    /// <summary>
+    /// Delete a hosts file entry.
+    /// </summary>
+    /// <param name="entry">Entry to delete.</param>"/>
+    /// <returns><see cref="HostsFileEntryModifyResult.Success"/> if the entry was enabled successfully, otherwise an error result.</returns>
+    private static HostsFileEntryModifyResult DeleteEntry(HostsFileEntry entry)
+    {
+        // Create a backup of the hosts file before making changes
+        if (CreateBackup() == false)
+        {
+            Log.Error("DeleteEntry - Failed to create backup before deleting entry.");
+            return HostsFileEntryModifyResult.BackupError;
         }
 
-        return true;
+        // Remove the entry from the hosts file
+        var hostsFileLines = File.ReadAllLines(HostsFilePath).ToList();
+
+        bool entryFound = false;
+
+        for (var i = 0; i < hostsFileLines.Count; i++)
+        {
+            if (hostsFileLines[i] == entry.Line)
+            {
+                entryFound = true;
+
+                hostsFileLines.RemoveAt(i);
+
+                break;
+            }
+        }
+
+        if (!entryFound)
+        {
+            Log.Warn($"DeleteEntry - Entry not found in hosts file: {entry.Line}");
+            return HostsFileEntryModifyResult.NotFound;
+        }
+
+        try
+        {
+            Log.Debug($"DeleteEntry - Writing changes to hosts file: {HostsFilePath}");
+            File.WriteAllLines(HostsFilePath, hostsFileLines);
+        }
+        catch (Exception ex)
+        {
+            Log.Error($"DeleteEntry - Failed to write changes to hosts file: {HostsFilePath}", ex);
+            return HostsFileEntryModifyResult.WriteError;
+        }
+        OnHostsFileChanged();
+        return HostsFileEntryModifyResult.Success;
     }
 
     /// <summary>
-    /// Create a daily backup of the hosts file (before making a change).
+    /// Create a "daily" backup of the hosts file (before making a change).
     /// </summary>
     private static bool CreateBackup()
     {

Source/NETworkManager.Models/HostsFileEditor/HostsFileEditor.cs

@@ -0,0 +1,28 @@
+namespace NETworkManager.Models.HostsFileEditor
+{
+    /// <summary>
+    ///     Represents the result of an attempt to modify a hosts file entry.
+    /// </summary>
+    public enum HostsFileEntryModifyResult
+    {
+        /// <summary>
+        ///     The entry was modified successfully and the hosts file was updated.
+        /// </summary>
+        Success,
+
+        /// <summary>
+        ///     The entry was not found in the hosts file.
+        /// </summary>
+        NotFound,
+
+        /// <summary>
+        ///     An error occurred while writing to the hosts file.
+        /// </summary>
+        WriteError,
+
+        /// <summary>
+        ///     An error occurred while backing up the hosts file.
+        /// </summary>
+        BackupError,
+    }
+}

Source/NETworkManager.Models/HostsFileEditor/HostsFileEntryModifyResult.cs

@@ -93,6 +93,21 @@ public IList SelectedResults
         }
     }
 
+    private bool _isModifying;
+
+    public bool IsModifying
+    {
+        get => _isModifying;
+        set
+        {
+            if (value == _isModifying)
+                return;
+
+            _isModifying = value;
+            OnPropertyChanged();
+        }
+    }
+
     private bool _isRefreshing;
 
     public bool IsRefreshing
@@ -192,7 +207,8 @@ private bool Refresh_CanExecute(object parameter)
         return Application.Current.MainWindow != null &&
                !((MetroWindow)Application.Current.MainWindow).IsAnyDialogOpen &&
                !ConfigurationManager.Current.IsChildWindowOpen &&
-               !IsRefreshing;
+               !IsRefreshing &&
+               !IsModifying;
     }
 
     private async Task RefreshAction()
@@ -253,14 +269,22 @@ await _dialogCoordinator.ShowMessageAsync(this, Strings.Error,
 
     private async Task EnableEntryAction()
     {
+        IsModifying = true;
+
         await HostsFileEditor.EnableEntryAsync(SelectedResult);
+
+        IsModifying = false;
     }
 
     public ICommand DisableEntryCommand => new RelayCommand(_ => DisableEntryAction().ConfigureAwait(false), ModifyEntry_CanExecute);
 
     private async Task DisableEntryAction()
     {
+        IsModifying = true;
+
         await HostsFileEditor.DisableEntryAsync(SelectedResult);
+
+        IsModifying = false;
     }
 
     public ICommand AddEntryCommand => new RelayCommand(_ => AddEntryAction().ConfigureAwait(false), ModifyEntry_CanExecute);
@@ -274,7 +298,33 @@ private async Task AddEntryAction()
 
     private async Task DeleteEntryAction()
     {
-        MessageBox.Show("Delete entry action is not implemented yet.", "Delete Entry", MessageBoxButton.OK, MessageBoxImage.Information);
+        IsModifying = true;
+
+        var childWindow = new OKCancelInfoMessageChildWindow();
+
+        var childWindowViewModel = new OKCancelInfoMessageViewModel(async _ =>
+        {
+            childWindow.IsOpen = false;
+            ConfigurationManager.Current.IsChildWindowOpen = false;
+
+            await HostsFileEditor.DeleteEntryAsync(SelectedResult);
+
+            IsModifying = false;
+        }, _ =>
+        {
+            childWindow.IsOpen = false;
+            ConfigurationManager.Current.IsChildWindowOpen = false;
+
+            IsModifying = false;
+        }, string.Format(Strings.DeleteHostsFileEntryMessage, SelectedResult.IPAddress, SelectedResult.Hostname, string.IsNullOrEmpty(SelectedResult.Comment) ? "" : $"# {SelectedResult.Comment}"));
+
+        childWindow.Title = Strings.DeleteEntry;
+
+        childWindow.DataContext = childWindowViewModel;
+
+        ConfigurationManager.Current.IsChildWindowOpen = true;
+
+        await (Application.Current.MainWindow as MainWindow).ShowChildWindowAsync(childWindow);
     }
 
     public ICommand EditEntryCommand => new RelayCommand(_ => EditEntryAction().ConfigureAwait(false), ModifyEntry_CanExecute);
@@ -290,7 +340,8 @@ private bool ModifyEntry_CanExecute(object obj)
             Application.Current.MainWindow != null &&
             !((MetroWindow)Application.Current.MainWindow).IsAnyDialogOpen &&
             !ConfigurationManager.Current.IsChildWindowOpen &&
-            !IsRefreshing;
+            !IsRefreshing &&
+            !IsModifying;
     }
 
     public ICommand RestartAsAdminCommand => new RelayCommand(_ => RestartAsAdminAction().ConfigureAwait(false));

Source/NETworkManager/ViewModels/HostsFileEditorViewModel.cs

@@ -1,17 +1,17 @@
-using System.Collections.Generic;
-using System.ComponentModel;
-using System.Linq;
-using System.Threading.Tasks;
-using System.Windows;
-using System.Windows.Data;
-using System.Windows.Input;
-using MahApps.Metro.Controls.Dialogs;
+using MahApps.Metro.Controls.Dialogs;
 using MahApps.Metro.SimpleChildWindow;
 using NETworkManager.Localization.Resources;
 using NETworkManager.Models.Network;
 using NETworkManager.Settings;
 using NETworkManager.Utilities;
 using NETworkManager.Views;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+using System.Threading.Tasks;
+using System.Windows;
+using System.Windows.Data;
+using System.Windows.Input;
 
 namespace NETworkManager.ViewModels;
 
@@ -189,7 +189,6 @@ private Task DeleteServer()
     {
         var childWindow = new OKCancelInfoMessageChildWindow();
 
-
         var childWindowViewModel = new OKCancelInfoMessageViewModel(_ =>
             {
                 childWindow.IsOpen = false;

Source/NETworkManager/ViewModels/SNTPLookupSettingsViewModel.cs

@@ -30,7 +30,7 @@
     <Grid Margin="10">
         <Grid.RowDefinitions>
             <RowDefinition Height="*" />
-            <RowDefinition Height="10" />
+            <RowDefinition Height="20" />
             <RowDefinition Height="Auto" />
         </Grid.RowDefinitions>
         <Grid Grid.Row="0">