Merge branch 'develop' into feature/RDMP-7-add-clear-user-settings-bu…

…tton

.github/workflows/build.yml

@@ -133,7 +133,7 @@ jobs:
           (cd PublishWinForms ; echo 7z a -mx=9 ../dist/rdmp-${{ steps.version.outputs.rdmpversion }}-client.zip . | cmd)
 
       - name: Install Perl dependencies
-        uses: shogo82148/[email protected].0
+        uses: shogo82148/[email protected].1
         with:
           install-modules-with: cpanm
           install-modules: Archive::Zip Archive::Tar

.nuget/packages.config

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <packages>
   <package id="NUnit.Console" version="3.9.0" />
   <package id="NUnit.ConsoleRunner" version="3.9.0" />

Application/ResearchDataManagementPlatform/Menus/MenuItems/DataExportMenu.cs

@@ -14,9 +14,8 @@ namespace ResearchDataManagementPlatform.Menus.MenuItems;
 
 internal class DataExportMenu : RDMPToolStripMenuItem
 {
-    public DataExportMenu(IActivateItems activator):base(activator,"Data Export Options")
+    public DataExportMenu(IActivateItems activator) : base(activator, "Data Export Options")
     {
-
         Enabled = _activator.RepositoryLocator.DataExportRepository != null;
 
         DropDownItems.Add(new ToolStripMenuItem("Configure Disclaimer", null, ConfigureDisclaimer));

Application/ResearchDataManagementPlatform/Menus/MenuItems/LaunchTutorialMenuItem.cs

@@ -21,9 +21,10 @@ public class LaunchTutorialMenuItem : ToolStripMenuItem
     private readonly Tutorial _tutorial;
     private readonly TutorialTracker _tracker;
 
-    public LaunchTutorialMenuItem(ToolStripMenuItem parent,IActivateItems activator, Tutorial tutorial, TutorialTracker tracker)
+    public LaunchTutorialMenuItem(ToolStripMenuItem parent, IActivateItems activator, Tutorial tutorial,
+        TutorialTracker tracker)
     {
-        parent.DropDownOpening += parent_DropDownOpening; 
+        parent.DropDownOpening += parent_DropDownOpening;
         _activator = activator;
         _tutorial = tutorial;
         _tracker = tracker;

Application/ResearchDataManagementPlatform/Menus/MenuItems/ResetTutorialsMenuItem.cs

@@ -36,6 +36,4 @@ private void parent_DropDownOpening(object sender, EventArgs e)
     {
         Enabled = _tracker.IsClearable();
     }
-
-
 }

Application/ResearchDataManagementPlatform/NLog.template.config

@@ -1,4 +1,5 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
+
 <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"
@@ -9,13 +10,14 @@
   <targets>
     <target xsi:type="ColoredConsole" name="c"
             layout="${longdate} ${uppercase:${level}} ${message} ${all-event-properties}. ${exception:format=toString}" />
-  <target xsi:type="File" name="log4j" fileName="${basedir}/logs/${shortdate}-log4j.log" layout="${log4jxmlevent}" />
-  <target xsi:type="File" name="simple" fileName="${basedir}/logs/${shortdate}-simple.log" layout="${longdate}|${level:uppercase=true}|${logger}|${message}|${exception:format=toString}" />
-  <target xsi:type="Network" name="u" address="udp4://localhost:878" layout="${log4jxmlevent}" />
+    <target xsi:type="File" name="log4j" fileName="${basedir}/logs/${shortdate}-log4j.log" layout="${log4jxmlevent}" />
+    <target xsi:type="File" name="simple" fileName="${basedir}/logs/${shortdate}-simple.log"
+            layout="${longdate}|${level:uppercase=true}|${logger}|${message}|${exception:format=toString}" />
+    <target xsi:type="Network" name="u" address="udp4://localhost:878" layout="${log4jxmlevent}" />
   </targets>
   <rules>
-	  <!--<logger name="*" minlevel="Trace" writeTo="c" />
+    <!--<logger name="*" minlevel="Trace" writeTo="c" />
     <logger name="*" minlevel="Trace" writeTo="log4j" />-->
     <logger name="*" minlevel="Trace" writeTo="simple" />
   </rules>
-</nlog>
+</nlog>

Application/ResearchDataManagementPlatform/Program.cs

@@ -23,31 +23,31 @@ internal static class Program
     [DllImport("kernel32.dll")]
     [return: MarshalAs(UnmanagedType.Bool)]
     private static extern bool AttachConsole([MarshalAs(UnmanagedType.U4)] int dwProcessId);
-  
-        /// <summary>
-        /// The main entry point for the application.
-        /// </summary>
-        [STAThread]
+
+    /// <summary>
+    /// The main entry point for the application.
+    /// </summary>
+    [STAThread]
     private static void Main(string[] args)
-        {
-            // if user has the command line built and runnable from the windows
-            // client then don't load the dlls (or we end up with 2 copies!).
-            SafeDirectoryCatalog.IgnoreDll = f => Path.GetFileName(f.DirectoryName)?.Equals("cli")==true;
+    {
+        // if user has the command line built and runnable from the windows
+        // client then don't load the dlls (or we end up with 2 copies!).
+        SafeDirectoryCatalog.IgnoreDll = f => Path.GetFileName(f.DirectoryName)?.Equals("cli") == true;
 
-            try
-            {
-                AttachConsole(-1);
-            }
-            catch (Exception)
-            {
-                Console.WriteLine("Couldn't redirect console. Never mind");
-            }
+        try
+        {
+            AttachConsole(-1);
+        }
+        catch (Exception)
+        {
+            Console.WriteLine("Couldn't redirect console. Never mind");
+        }
 
-            Startup.PreStartup();
+        Startup.PreStartup();
 
-            UsefulStuff.GetParser()
-                .ParseArguments<ResearchDataManagementPlatformOptions>(args)
-                .MapResult(RunApp, err => -1);
+        UsefulStuff.GetParser()
+            .ParseArguments<ResearchDataManagementPlatformOptions>(args)
+            .MapResult(RunApp, err => -1);
     }
 
     private static object RunApp(ResearchDataManagementPlatformOptions arg)
@@ -56,7 +56,7 @@ private static object RunApp(ResearchDataManagementPlatformOptions arg)
         {
             arg.PopulateConnectionStringsFromYamlIfMissing(new ThrowImmediatelyCheckNotifier());
         }
-        catch(Exception ex)
+        catch (Exception ex)
         {
             ExceptionViewer.Show(ex);
             return -500;

Application/ResearchDataManagementPlatform/Properties/AssemblyInfo.cs

@@ -6,4 +6,4 @@
 [assembly: ComVisible(false)]
 
 // The following GUID is for the ID of the typelib if this project is exposed to COM
-[assembly: Guid("cac9817c-fc66-48e8-9333-c740af6ab5b9")]
+[assembly: Guid("cac9817c-fc66-48e8-9333-c740af6ab5b9")]

Application/ResearchDataManagementPlatform/RDMP.nuspec

@@ -1,15 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
-    <metadata>
-        <id>ResearchDataManagementPlatform</id>
-        <version>$version$</version>
-		<authors>Health Informatics Service, University of Dundee</authors>
-		<description>Research Data Management Platform</description>
-    </metadata>
+  <metadata>
+    <id>ResearchDataManagementPlatform</id>
+    <version>$version$</version>
+    <authors>Health Informatics Service, University of Dundee</authors>
+    <description>Research Data Management Platform</description>
+  </metadata>
   <files>
     <file src="bin\$configuration$\net6.0-windows\win-x64\*" target="lib\net6.0-windows7.0" />
-	<file src="bin\$configuration$\net6.0-windows\win-x64\Curation\**\*" target="lib\net6.0-windows7.0" />
-	<file src="bin\$configuration$\net6.0-windows\win-x64\Icon\**\*" target="lib\net6.0-windows7.0" />
-	<file src="bin\$configuration$\net6.0-windows\win-x64\WindowManagement\**\*" target="lib\net6.0-windows7.0" />
+    <file src="bin\$configuration$\net6.0-windows\win-x64\Curation\**\*" target="lib\net6.0-windows7.0" />
+    <file src="bin\$configuration$\net6.0-windows\win-x64\Icon\**\*" target="lib\net6.0-windows7.0" />
+    <file src="bin\$configuration$\net6.0-windows\win-x64\WindowManagement\**\*" target="lib\net6.0-windows7.0" />
   </files>
 </package>

Application/ResearchDataManagementPlatform/RDMPMainForm.cs

@@ -60,10 +60,12 @@ public RDMPMainForm()
             if (!string.IsNullOrWhiteSpace(t))
             {
                 var type = Type.GetType(t);
-                _theme = type == null ? new MyVS2015BlueTheme() : (ITheme) System.Activator.CreateInstance(type);
+                _theme = type == null ? new MyVS2015BlueTheme() : (ITheme)System.Activator.CreateInstance(type);
             }
             else
+            {
                 _theme = new MyVS2015BlueTheme();
+            }
         }
         catch (Exception)
         {
@@ -103,52 +105,51 @@ private void RDMPMainForm_Load(object sender, EventArgs e)
         _globalErrorCheckNotifier = exceptionCounter;
         _rdmpTopMenuStrip1.InjectButton(exceptionCounter);
 
-        _windowManager = new WindowManager(_theme,this,_refreshBus, dockPanel1, RepositoryLocator, exceptionCounter);
+        _windowManager = new WindowManager(_theme, this, _refreshBus, dockPanel1, RepositoryLocator, exceptionCounter);
         SetItemActivator(_windowManager.ActivateItems);
 
         _rdmpTopMenuStrip1.SetWindowManager(_windowManager);
-            
+
         //put the version of the software into the window title
-            
-            _version = StartupUI.GetVersion();
-            
+
+        _version = StartupUI.GetVersion();
+
         //put the current platform database into the window title too
         if (Activator?.RepositoryLocator?.CatalogueRepository is TableRepository connectedTo)
         {
             var database = connectedTo.DiscoveredServer?.GetCurrentDatabase();
             var instanceDescription = "";
 
-            var connectionStringsFileLoaded = RDMPBootStrapper<RDMPMainForm>.ApplicationArguments?.ConnectionStringsFileLoaded;
+            var connectionStringsFileLoaded =
+                RDMPBootStrapper<RDMPMainForm>.ApplicationArguments?.ConnectionStringsFileLoaded;
             if (connectionStringsFileLoaded != null)
-            {
                 instanceDescription =
                     $" - {connectionStringsFileLoaded.Name ?? connectionStringsFileLoaded.FileLoaded.Name}";
-            }
-            if (database != null) 
+            if (database != null)
                 _connectedTo = $"({database.GetRuntimeName()} on {database.Server.Name}){instanceDescription}";
         }
-            
+
         Text = "Research Data Management Platform";
 
-        var rdmpDir = new DirectoryInfo(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "RDMP"));
-        if(!rdmpDir.Exists)
+        var rdmpDir =
+            new DirectoryInfo(
+                Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "RDMP"));
+        if (!rdmpDir.Exists)
             rdmpDir.Create();
 
-        _persistenceFile = new FileInfo(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),"RDMP", "RDMPDockPanelPersist.xml"));
+        _persistenceFile =
+            new FileInfo(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "RDMP",
+                "RDMPDockPanelPersist.xml"));
 
         //if there is no persist file or user wants to show the home screen always on startup
         if (!_persistenceFile.Exists || UserSettings.ShowHomeOnStartup)
-        {
             _windowManager.PopHome();
-        }
         else
-        {
             try
             {
                 if (_persistenceFile.Exists)
                     LoadFromXml(new FileStream(_persistenceFile.FullName, FileMode.Open));
-
-                    //load the state using the method
+                //load the state using the method
             }
             catch (Exception ex)
             {
@@ -161,33 +162,29 @@ private void RDMPMainForm_Load(object sender, EventArgs e)
                 _persistenceFile.Delete();
                 ApplicationRestarter.Restart();
             }
-        }
-
+
         FormClosing += CloseForm;
         Loading = false;
     }
 
-    public override string Text { 
+    public override string Text
+    {
         get => base.Text;
         set => base.Text = (value + " v" + _version + " " + _connectedTo).Trim();
     }
 
     public void LoadFromXml(Stream stream)
     {
         if (dockPanel1.DocumentStyle == DocumentStyle.SystemMdi)
-        {
             foreach (var form in MdiChildren)
                 form.Close();
-        }
         else
-        {
             foreach (var document in dockPanel1.DocumentsToArray())
             {
                 // IMPORANT: dispose all panes.
                 document.DockHandler.DockPanel = null;
                 document.DockHandler.Close();
             }
-        }
 
         foreach (var pane in dockPanel1.Panes.ToList())
         {
@@ -198,17 +195,18 @@ public void LoadFromXml(Stream stream)
         // IMPORTANT: dispose all float windows.
         foreach (var window in dockPanel1.FloatWindows.ToList())
             window.Dispose();
-            
+
         System.Diagnostics.Debug.Assert(dockPanel1.Panes.Count == 0);
         System.Diagnostics.Debug.Assert(dockPanel1.Contents.Count == 0);
         System.Diagnostics.Debug.Assert(dockPanel1.FloatWindows.Count == 0);
 
         dockPanel1.LoadFromXml(stream, DeserializeContent);
     }
+
     public void LoadFromXml(WindowLayout target)
     {
         var uniEncoding = new UnicodeEncoding();
-            
+
         // You might not want to use the outer using statement that I have
         // I wasn't sure how long you would need the MemoryStream object    
         using (var ms = new MemoryStream())
@@ -217,7 +215,7 @@ public void LoadFromXml(WindowLayout target)
             try
             {
                 sw.Write(target.LayoutData);
-                sw.Flush();//otherwise you are risking empty stream
+                sw.Flush(); //otherwise you are risking empty stream
                 ms.Seek(0, SeekOrigin.Begin);
 
                 LoadFromXml(ms);
@@ -256,10 +254,7 @@ private void CloseForm(object sender, FormClosingEventArgs e)
         // give the window manager a chance to cancel closing
         _windowManager.OnFormClosing(e);
 
-        if (e.Cancel)
-        {
-            return;
-        }
+        if (e.Cancel) return;
 
         if (e.CloseReason == CloseReason.UserClosing && UserSettings.ConfirmApplicationExiting)
             if (!Activator.YesNo("Are you sure you want to Exit?", "Confirm Exit"))
@@ -278,9 +273,9 @@ private void CloseForm(object sender, FormClosingEventArgs e)
                 dockPanel1.SaveAsXml(_persistenceFile.FullName); //save when Form closes
             }
         }
-        catch(Exception ex)
+        catch (Exception ex)
         {
-            ExceptionViewer.Show("Could not write persistence file",ex);
+            ExceptionViewer.Show("Could not write persistence file", ex);
         }
     }
 
@@ -295,17 +290,19 @@ private IDockContent DeserializeContent(string persiststring)
                 return toolboxInstance;
             }
 
-            var instruction = PersistenceDecisionFactory.ShouldCreateBasicControl(persiststring,RepositoryLocator) ??
-                              PersistenceDecisionFactory.ShouldCreateSingleObjectControl(persiststring,RepositoryLocator) ??
+            var instruction = PersistenceDecisionFactory.ShouldCreateBasicControl(persiststring, RepositoryLocator) ??
+                              PersistenceDecisionFactory.ShouldCreateSingleObjectControl(persiststring,
+                                  RepositoryLocator) ??
                               PersistenceDecisionFactory.ShouldCreateObjectCollection(persiststring, RepositoryLocator);
 
             if (instruction != null)
-                return _windowManager.ActivateItems.Activate(instruction,_windowManager.ActivateItems);
+                return _windowManager.ActivateItems.Activate(instruction, _windowManager.ActivateItems);
         }
         catch (Exception e)
         {
             _globalErrorCheckNotifier.OnCheckPerformed(new CheckEventArgs(
-                $"Could not work out what window to show for persistence string '{persiststring}'",CheckResult.Fail, e));
+                $"Could not work out what window to show for persistence string '{persiststring}'", CheckResult.Fail,
+                e));
         }
 
         return null;