Merge pull request #234 from Hirogen/portable-mode-all-in-same-folder

Hirogen · web-flow · commit 728a081f7770 · 2022-07-15T15:20:58.000+02:00
Add PortableMode for Session Files
diff --git a/src/LogExpert/Classes/Persister/Persister.cs b/src/LogExpert/Classes/Persister/Persister.cs
@@ -147,28 +147,42 @@ public static PersistenceData LoadOptionsOnly(string fileName)
 
         private static string BuildPersisterFileName(string logFileName, Preferences preferences)
         {
-            string dir = null;
-            string file = null;
+            string dir;
+            string file;
+
             switch (preferences.saveLocation)
             {
                 case SessionSaveLocation.SameDir:
                 default:
+                {
                     FileInfo fileInfo = new FileInfo(logFileName);
                     dir = fileInfo.DirectoryName;
                     file = fileInfo.DirectoryName + Path.DirectorySeparatorChar + fileInfo.Name + ".lxp";
                     break;
+                }
                 case SessionSaveLocation.DocumentsDir:
+                {
                     dir = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) +
                           Path.DirectorySeparatorChar +
                           "LogExpert";
                     file = dir + Path.DirectorySeparatorChar + BuildSessionFileNameFromPath(logFileName);
                     break;
+                }
                 case SessionSaveLocation.OwnDir:
+                {
                     dir = preferences.sessionSaveDirectory;
                     file = dir + Path.DirectorySeparatorChar + BuildSessionFileNameFromPath(logFileName);
                     break;
+                }
+                case SessionSaveLocation.ApplicationStartupDir:
+                {
+                    dir = Application.StartupPath;
+                    file = dir + Path.DirectorySeparatorChar + BuildSessionFileNameFromPath(logFileName);
+                    break;
+                }
             }
-            if (!string.IsNullOrWhiteSpace(dir) && !Directory.Exists(dir))
+
+            if (string.IsNullOrWhiteSpace(dir) == false && Directory.Exists(dir) == false)
             {
                 try
                 {
diff --git a/src/LogExpert/Config/ConfigManager.cs b/src/LogExpert/Config/ConfigManager.cs
@@ -60,9 +60,12 @@ public static ConfigManager Instance
             }
         }
         
-        public static string ConfigDir => Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + "\\LogExpert";
+        public static string ConfigDir => Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + Path.DirectorySeparatorChar + "LogExpert";
 
-        public static string PortableMode => Application.StartupPath + "\\portableMode.json";
+        /// <summary>
+        /// Application.StartupPath + portableMode.json
+        /// </summary>
+        public static string PortableMode => Application.StartupPath + Path.DirectorySeparatorChar + "portableMode.json";
 
         public static Settings Settings => Instance._settings;
 
@@ -112,14 +115,14 @@ private Settings Load()
                 Directory.CreateDirectory(dir);
             }
 
-            if (!File.Exists(dir + "\\settings.json"))
+            if (!File.Exists(dir + Path.DirectorySeparatorChar + "settings.json"))
             {
                 return LoadOrCreateNew(null);
             }
 
             try
             {
-                FileInfo fileInfo = new FileInfo(dir + "\\settings.json");
+                FileInfo fileInfo = new FileInfo(dir + Path.DirectorySeparatorChar + "settings.json");
                 return LoadOrCreateNew(fileInfo);
             }
             catch (Exception e)
@@ -298,7 +301,7 @@ private void Save(Settings settings, SettingsFlags flags)
                         Directory.CreateDirectory(dir);
                     }
 
-                    FileInfo fileInfo = new FileInfo(dir + "\\settings.json");
+                    FileInfo fileInfo = new FileInfo(dir + Path.DirectorySeparatorChar + "settings.json");
                     Save(fileInfo, settings);
                 }
 
diff --git a/src/LogExpert/Config/SessionSaveLocation.cs b/src/LogExpert/Config/SessionSaveLocation.cs
@@ -5,9 +5,22 @@ namespace LogExpert.Config
     [Serializable]
     public enum SessionSaveLocation
     {
+        //Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + Path.DirectorySeparatorChar + "LogExpert"
+        /// <summary>
+        /// <see cref="Environment.SpecialFolder.MyDocuments"/>
+        /// </summary>
         DocumentsDir,
+        //same directory as the logfile
         SameDir,
+        //uses configured folder to save the session files 
+        /// <summary>
+        /// <see cref="Preferences.sessionSaveDirectory"/>
+        /// </summary>
         OwnDir,
+        /// <summary>
+        /// <see cref="System.Windows.Forms.Application.StartupPath"/>
+        /// </summary>
+        ApplicationStartupDir,
         LoadedSessionFile
     }
 }
diff --git a/src/LogExpert/Dialogs/SettingsDialog.Designer.cs b/src/LogExpert/Dialogs/SettingsDialog.Designer.cs
diff --git a/src/LogExpert/Dialogs/SettingsDialog.cs b/src/LogExpert/Dialogs/SettingsDialog.cs
@@ -103,6 +103,7 @@ private void FillDialog()
 
             checkBoxTimeSpread.Checked = Preferences.showTimeSpread;
             checkBoxReverseAlpha.Checked = Preferences.reverseAlpha;
+
             radioButtonTimeView.Checked = Preferences.timeSpreadTimeMode;
             radioButtonLineView.Checked = !Preferences.timeSpreadTimeMode;
 
@@ -123,8 +124,19 @@ private void FillDialog()
                 case SessionSaveLocation.DocumentsDir:
                 {
                     radioButtonsessionSaveDocuments.Checked = true;
+                    break;
                 }
-                break;
+                case SessionSaveLocation.ApplicationStartupDir:
+                {
+                    radioButtonSessionApplicationStartupDir.Checked = true;
+                    break;
+                }
+            }
+            
+            //overwrite preferences save location in portable mode to always be application startup directory
+            if (checkBoxPortableMode.Checked)
+            {
+                radioButtonSessionApplicationStartupDir.Checked = true;
             }
 
             upDownMaximumFilterEntriesDisplayed.Value = Preferences.maximumFilterEntriesDisplayed;
@@ -582,7 +594,7 @@ private void changeFontButton_Click(object sender, EventArgs e)
             DisplayFontName();
         }
 
-        private void okButton_Click(object sender, EventArgs e)
+        private void OnOkButtonClick(object sender, EventArgs e)
         {
             Preferences.timestampControl = checkBoxTimestamp.Checked;
             Preferences.filterSync = checkBoxSyncFilter.Checked;
@@ -627,6 +639,10 @@ private void okButton_Click(object sender, EventArgs e)
             {
                 Preferences.saveLocation = SessionSaveLocation.OwnDir;
             }
+            else if (radioButtonSessionApplicationStartupDir.Checked)
+            {
+                Preferences.saveLocation = SessionSaveLocation.ApplicationStartupDir;
+            }
             else
             {
                 Preferences.saveLocation = SessionSaveLocation.SameDir;
@@ -775,15 +791,25 @@ private void OnPortableModeCheckedChanged(object sender, EventArgs e)
                 {
                     case CheckState.Checked when !File.Exists(ConfigManager.PortableMode):
                     {
-                        File.Create(ConfigManager.PortableMode);
-                        break;
+                        using (File.Create(ConfigManager.PortableMode)) 
+                            break;
                     }
                     case CheckState.Unchecked when File.Exists(ConfigManager.PortableMode):
                     {
                         File.Delete(ConfigManager.PortableMode);
                         break;
                     }
                 }
+
+                switch (checkBoxPortableMode.CheckState)
+                {
+                    case CheckState.Unchecked:
+                        checkBoxPortableMode.Text = @"Activate Portable Mode";
+                        break;
+                    case CheckState.Checked:
+                        checkBoxPortableMode.Text = @"Deactivate Portable Mode";
+                        break;
+                }
             }
             catch (Exception exception)
             {
diff --git a/src/LogExpert/Dialogs/SettingsDialog.resx b/src/LogExpert/Dialogs/SettingsDialog.resx
@@ -120,6 +120,15 @@
   <metadata name="toolTip.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>144, 17</value>
   </metadata>
+  <metadata name="toolTip.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>144, 17</value>
+  </metadata>
+  <metadata name="columnFileMask.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
+  <metadata name="columnColumnizer.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
   <metadata name="columnFileMask.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
     <value>True</value>
   </metadata>
@@ -132,12 +141,21 @@
   <metadata name="columnHighlightGroup.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
     <value>True</value>
   </metadata>
+  <metadata name="columnFileName.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
+  <metadata name="columnHighlightGroup.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
   <metadata name="helpProvider.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>17, 17</value>
   </metadata>
   <data name="labelNoteMultiFile.Text" xml:space="preserve">
     <value>Note: You can always load your logfiles as MultiFile automatically if the files names follow the MultiFile naming rule (&lt;filename&gt;, &lt;filename&gt;.1, &lt;filename&gt;.2, ...). Simply choose 'MultiFile' from the File menu after loading the first file.</value>
   </data>
+  <metadata name="helpProvider.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>17, 17</value>
+  </metadata>
   <assembly alias="System.Drawing" name="System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
   <data name="$this.Icon" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
     <value>
diff --git a/src/LogExpert/Program.cs b/src/LogExpert/Program.cs
@@ -156,6 +156,11 @@ private static void Sub_Main(string[] orgArgs)
                         _logger.Error(errMsg, "IpcClientChannel error, giving up: ");
                         MessageBox.Show($"Cannot open connection to first instance ({errMsg})", "LogExpert");
                     }
+
+                    if (settings.preferences.allowOnlyOneInstance)
+                    {
+                        MessageBox.Show($"Only one instance allowed, uncheck \"View Settings => Allow only 1 Instances\" to start multiple instances!", "Logexpert");
+                    }
                 }
 
                 mutex.Close();
diff --git a/src/UnitTests/RolloverHandlerTestBase.cs b/src/UnitTests/RolloverHandlerTestBase.cs

Original file line number	Diff line number	Diff line change
`@@ -60,9 +60,12 @@ public static ConfigManager Instance`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`- public static string ConfigDir => Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + "\\LogExpert";`
	`63`	`+ public static string ConfigDir => Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + Path.DirectorySeparatorChar + "LogExpert";`
`64`	`64`
`65`		`- public static string PortableMode => Application.StartupPath + "\\portableMode.json";`
	`65`	`+ /// <summary>`
	`66`	`+ /// Application.StartupPath + portableMode.json`
	`67`	`+ /// </summary>`
	`68`	`+ public static string PortableMode => Application.StartupPath + Path.DirectorySeparatorChar + "portableMode.json";`
`66`	`69`
`67`	`70`	`public static Settings Settings => Instance._settings;`
`68`	`71`
`@@ -112,14 +115,14 @@ private Settings Load()`
`112`	`115`	`Directory.CreateDirectory(dir);`
`113`	`116`	`}`
`114`	`117`
`115`		`- if (!File.Exists(dir + "\\settings.json"))`
	`118`	`+ if (!File.Exists(dir + Path.DirectorySeparatorChar + "settings.json"))`
`116`	`119`	`{`
`117`	`120`	`return LoadOrCreateNew(null);`
`118`	`121`	`}`
`119`	`122`
`120`	`123`	`try`
`121`	`124`	`{`
`122`		`- FileInfo fileInfo = new FileInfo(dir + "\\settings.json");`
	`125`	`+ FileInfo fileInfo = new FileInfo(dir + Path.DirectorySeparatorChar + "settings.json");`
`123`	`126`	`return LoadOrCreateNew(fileInfo);`
`124`	`127`	`}`
`125`	`128`	`catch (Exception e)`
`@@ -298,7 +301,7 @@ private void Save(Settings settings, SettingsFlags flags)`
`298`	`301`	`Directory.CreateDirectory(dir);`
`299`	`302`	`}`
`300`	`303`
`301`		`- FileInfo fileInfo = new FileInfo(dir + "\\settings.json");`
	`304`	`+ FileInfo fileInfo = new FileInfo(dir + Path.DirectorySeparatorChar + "settings.json");`
`302`	`305`	`Save(fileInfo, settings);`
`303`	`306`	`}`
`304`	`307`
Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,7 @@ private void FillDialog()`
`103`	`103`
`104`	`104`	`checkBoxTimeSpread.Checked = Preferences.showTimeSpread;`
`105`	`105`	`checkBoxReverseAlpha.Checked = Preferences.reverseAlpha;`
	`106`	`+`
`106`	`107`	`radioButtonTimeView.Checked = Preferences.timeSpreadTimeMode;`
`107`	`108`	`radioButtonLineView.Checked = !Preferences.timeSpreadTimeMode;`
`108`	`109`
`@@ -123,8 +124,19 @@ private void FillDialog()`
`123`	`124`	`case SessionSaveLocation.DocumentsDir:`
`124`	`125`	`{`
`125`	`126`	`radioButtonsessionSaveDocuments.Checked = true;`
	`127`	`+ break;`
`126`	`128`	`}`
`127`		`- break;`
	`129`	`+ case SessionSaveLocation.ApplicationStartupDir:`
	`130`	`+ {`
	`131`	`+ radioButtonSessionApplicationStartupDir.Checked = true;`
	`132`	`+ break;`
	`133`	`+ }`
	`134`	`+ }`
	`135`	`+`
	`136`	`+ //overwrite preferences save location in portable mode to always be application startup directory`
	`137`	`+ if (checkBoxPortableMode.Checked)`
	`138`	`+ {`
	`139`	`+ radioButtonSessionApplicationStartupDir.Checked = true;`
`128`	`140`	`}`
`129`	`141`
`130`	`142`	`upDownMaximumFilterEntriesDisplayed.Value = Preferences.maximumFilterEntriesDisplayed;`
`@@ -582,7 +594,7 @@ private void changeFontButton_Click(object sender, EventArgs e)`
`582`	`594`	`DisplayFontName();`
`583`	`595`	`}`
`584`	`596`
`585`		`- private void okButton_Click(object sender, EventArgs e)`
	`597`	`+ private void OnOkButtonClick(object sender, EventArgs e)`
`586`	`598`	`{`
`587`	`599`	`Preferences.timestampControl = checkBoxTimestamp.Checked;`
`588`	`600`	`Preferences.filterSync = checkBoxSyncFilter.Checked;`
`@@ -627,6 +639,10 @@ private void okButton_Click(object sender, EventArgs e)`
`627`	`639`	`{`
`628`	`640`	`Preferences.saveLocation = SessionSaveLocation.OwnDir;`
`629`	`641`	`}`
	`642`	`+ else if (radioButtonSessionApplicationStartupDir.Checked)`
	`643`	`+ {`
	`644`	`+ Preferences.saveLocation = SessionSaveLocation.ApplicationStartupDir;`
	`645`	`+ }`
`630`	`646`	`else`
`631`	`647`	`{`
`632`	`648`	`Preferences.saveLocation = SessionSaveLocation.SameDir;`
`@@ -775,15 +791,25 @@ private void OnPortableModeCheckedChanged(object sender, EventArgs e)`
`775`	`791`	`{`
`776`	`792`	`case CheckState.Checked when !File.Exists(ConfigManager.PortableMode):`
`777`	`793`	`{`
`778`		`- File.Create(ConfigManager.PortableMode);`
`779`		`- break;`
	`794`	`+ using (File.Create(ConfigManager.PortableMode))`
	`795`	`+ break;`
`780`	`796`	`}`
`781`	`797`	`case CheckState.Unchecked when File.Exists(ConfigManager.PortableMode):`
`782`	`798`	`{`
`783`	`799`	`File.Delete(ConfigManager.PortableMode);`
`784`	`800`	`break;`
`785`	`801`	`}`
`786`	`802`	`}`
	`803`	`+`
	`804`	`+ switch (checkBoxPortableMode.CheckState)`
	`805`	`+ {`
	`806`	`+ case CheckState.Unchecked:`
	`807`	`+ checkBoxPortableMode.Text = @"Activate Portable Mode";`
	`808`	`+ break;`
	`809`	`+ case CheckState.Checked:`
	`810`	`+ checkBoxPortableMode.Text = @"Deactivate Portable Mode";`
	`811`	`+ break;`
	`812`	`+ }`
`787`	`813`	`}`
`788`	`814`	`catch (Exception exception)`
`789`	`815`	`{`
Original file line number	Diff line number	Diff line change
`@@ -156,6 +156,11 @@ private static void Sub_Main(string[] orgArgs)`
`156`	`156`	`_logger.Error(errMsg, "IpcClientChannel error, giving up: ");`
`157`	`157`	`MessageBox.Show($"Cannot open connection to first instance ({errMsg})", "LogExpert");`
`158`	`158`	`}`
	`159`	`+`
	`160`	`+ if (settings.preferences.allowOnlyOneInstance)`
	`161`	`+ {`
	`162`	`+ MessageBox.Show($"Only one instance allowed, uncheck \"View Settings => Allow only 1 Instances\" to start multiple instances!", "Logexpert");`
	`163`	`+ }`
`159`	`164`	`}`
`160`	`165`
`161`	`166`	`mutex.Close();`