Add Clear User Settings Functionality (RDMP-7/GH#749) (#1586)

* Add Clear User Settings button, command and unit test
* Update SelfCertifyingDataAccessPoint.cs - Fix typo


---------

Co-authored-by: jas88 <[email protected]>

Rdmp.Core.Tests/CommandExecution/TestExecuteCommandClearUserSettings.cs

@@ -0,0 +1,34 @@
+// Copyright (c) The University of Dundee 2018-2023
+// This file is part of the Research Data Management Platform (RDMP).
+// RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+// RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
+
+using NUnit.Framework;
+using Rdmp.Core.CommandExecution.AtomicCommands;
+using Rdmp.Core.CommandLine.Interactive.Picking;
+using Rdmp.Core.ReusableLibraryCode.Checks;
+using Rdmp.Core.ReusableLibraryCode.Settings;
+
+namespace Rdmp.Core.Tests.CommandExecution;
+
+internal sealed class TestExecuteCommandClearUserSettings : CommandCliTests
+{
+    [Test]
+    public void Test_ClearUserSettings()
+    {
+        var invoker = GetInvoker();
+        var activator = GetActivator();
+
+        UserSettings.Wait5SecondsAfterStartupUI = false;
+
+        invoker.ExecuteCommand(typeof(ExecuteCommandSetUserSetting), new CommandLineObjectPicker(new[] { nameof(UserSettings.Wait5SecondsAfterStartupUI), "true" }, activator));
+
+        Assert.IsTrue(UserSettings.Wait5SecondsAfterStartupUI);
+        invoker.ExecuteCommand(typeof(ExecuteCommandSetUserSetting), new CommandLineObjectPicker(new[] { nameof(UserSettings.Wait5SecondsAfterStartupUI), "false" }, activator));
+        Assert.IsFalse(UserSettings.Wait5SecondsAfterStartupUI);
+        invoker.ExecuteCommand(typeof(ExecuteCommandClearUserSettings), new CommandLineObjectPicker(System.Array.Empty<string>(), activator));
+
+        Assert.IsTrue(UserSettings.Wait5SecondsAfterStartupUI);
+    }
+}

Rdmp.Core/CommandExecution/AtomicCommands/ExecuteCommandClearUserSettings.cs

@@ -0,0 +1,24 @@
+// Copyright (c) The University of Dundee 2018-2019
+// This file is part of the Research Data Management Platform (RDMP).
+// RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+// RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
+
+using Rdmp.Core.ReusableLibraryCode.Settings;
+
+namespace Rdmp.Core.CommandExecution.AtomicCommands;
+
+public class ExecuteCommandClearUserSettings : BasicCommandExecution
+{
+    public ExecuteCommandClearUserSettings(IBasicActivateItems activator):base(activator)
+    {
+
+    }
+    public override void Execute()
+    {
+        base.Execute();
+
+        UserSettings.ClearUserSettings();
+    }
+
+}

Rdmp.Core/Curation/Data/SelfCertifyingDataAccessPoint.cs

@@ -16,7 +16,7 @@ namespace Rdmp.Core.Curation.Data;
 
 /// <summary>
 /// Normally to open a connection to an IDataAccessPoint (location of server/database) you also need an optional IDataAccessCredentials (username and encrypted password).  These
-/// These are usually two separate objects e.g. TableInfo and DataAccessCredentials (optional - if ommmited connections use integrated/windows security).  
+/// These are usually two separate objects e.g. TableInfo and DataAccessCredentials (optional - if omitted connections use integrated/windows security).
 /// 
 /// <para>Instead of doing that however, you can use this class to store all the bits in one object that implements both interfaces.  It can then be used with a 
 /// DataAccessPortal.</para>

Rdmp.Core/GlobalStrings.resx

@@ -138,6 +138,18 @@
   <data name="CreateNewCatalogueByImportingExistingDataTableHelp" xml:space="preserve">
     <value>Creates a New Catalogue by associating it with an existing Table in your database</value>
   </data>
+  <data name="ConfirmClearUserSettings" xml:space="preserve">
+    <value>Are you sure you want to clear your settings?</value>
+  </data>
+  <data name="ClearUserSettings" xml:space="preserve">
+    <value>Clear User Settings</value>
+  </data>
+  <data name="ClearSettings" xml:space="preserve">
+    <value>Clear Settings</value>
+  </data>
+  <data name="ClearUserSettingsTooltip" xml:space="preserve">
+  <value>Reset settings back to the defaults</value>
+  </data>
   <data name="Activate" xml:space="preserve">
     <value>Edit</value>
   </data>

Rdmp.Core/ReusableLibraryCode/Settings/UserSettings.cs

@@ -33,6 +33,7 @@ private static ISettings AppSettings
         }
     }
 
+
     /// <summary>
     /// Show a Yes/No confirmation dialog box when closing RDMP
     /// </summary>
@@ -604,5 +605,14 @@ public static void SetSplitterDistance(Guid controlGuid, int splitterDistance)
         }
     }
 
+    public static void ClearUserSettings(){
+        AppSettings.Clear();
+    }
+
+    private static ISettings CreateSettings()
+    {
+        return new RDMPApplicationSettings();
+    }
+
     private static ISettings CreateSettings() => new RDMPApplicationSettings();
 }

Rdmp.UI/SimpleDialogs/UserSettingsUI.cs

@@ -8,6 +8,7 @@
 using System.Collections.Generic;
 using System.Reflection;
 using System.Windows.Forms;
+using Rdmp.Core.CommandExecution.AtomicCommands;
 using Rdmp.Core.ReusableLibraryCode;
 using Rdmp.Core.ReusableLibraryCode.Checks;
 using Rdmp.Core.ReusableLibraryCode.Settings;
@@ -16,7 +17,6 @@
 using Rdmp.UI.TestsAndSetup.ServicePropogation;
 using ScintillaNET;
 using static BrightIdeasSoftware.ObjectListView;
-
 namespace Rdmp.UI.SimpleDialogs;
 
 /// <summary>
@@ -148,6 +148,23 @@ public UserSettingsFileUI(IActivateItems activator)
             cmd.Execute();
             btnClearFavourites.Enabled = !cmd.IsImpossible;
         };
+
+        var clearUserSettingsCmd = new ExecuteCommandClearUserSettings(activator);
+        btnClearUserSettings.Enabled = true;
+
+        btnClearUserSettings.Click += (s, e) =>
+        {
+            if (activator.YesNo(
+              Core.GlobalStrings.ConfirmClearUserSettings,
+                               Core.GlobalStrings.ClearUserSettings
+            ))
+            {
+                clearUserSettingsCmd.Execute();
+                Dispose(true);
+                var settings = new UserSettingsFileUI(activator);
+                settings.Show();
+            }
+        };
     }
 
     private Dictionary<CheckBox, PropertyInfo> checkboxDictionary = new();