Tweaking how paths are handled

- Correcting PreRelease build config so that projects are building correctly as needed.
- Logger class handles its own directory since the Logging API provides default file locations.
- Removing global variables and logic relating to data paths since the only code that really used it was the Logger class.
- Specified output path for crashbugs.
- Simplified Logger initialization to be more predictable and utilize standard values and paths.

Author: gbakeman

WinNUT_V2/WinNUT-Client/ApplicationEvents.vb

@@ -23,8 +23,8 @@ Namespace My
     ' NetworkAvailabilityChanged : Déclenché quand la connexion réseau est connectée ou déconnectée.
     Partial Friend Class MyApplication
         ' Default culture for output so logs can be shared with the project.
-        Private Shared DEF_CULTURE_INFO As CultureInfo = CultureInfo.InvariantCulture
-
+        Private Shared ReadOnly DEF_CULTURE_INFO As CultureInfo = CultureInfo.InvariantCulture
+        Private Shared ReadOnly CRASHBUG_OUTPUT_PATH = System.Windows.Forms.Application.LocalUserAppDataPath
 
         Private CrashBug_Form As New Form
         Private BtnClose As New Button
@@ -168,13 +168,13 @@ Namespace My
 
             Computer.Clipboard.SetText(crashReportData)
 
-            Directory.CreateDirectory(TEMP_DATA_PATH)
-            Dim CrashLog_Report = New StreamWriter(Path.Combine(TEMP_DATA_PATH, logFileName))
+            Directory.CreateDirectory(CRASHBUG_OUTPUT_PATH)
+            Dim CrashLog_Report = New StreamWriter(Path.Combine(CRASHBUG_OUTPUT_PATH, logFileName))
             CrashLog_Report.WriteLine(crashReportData)
             CrashLog_Report.Close()
 
             ' Open an Explorer window to the crash log.
-            Process.Start(TEMP_DATA_PATH)
+            Process.Start(CRASHBUG_OUTPUT_PATH)
             End
         End Sub
 

WinNUT_V2/WinNUT-Client/Pref_Gui.vb

@@ -343,8 +343,8 @@ Public Class Pref_Gui
 
     Private Sub Btn_ViewLog_Click(sender As Object, e As EventArgs) Handles Btn_ViewLog.Click
         LogFile.LogTracing("Show LogFile", LogLvl.LOG_DEBUG, Me)
-        If File.Exists(LogFile.LogFileLocation) Then
-            Process.Start(LogFile.LogFileLocation)
+        If File.Exists(LogFile.LogFilePath) Then
+            Process.Start(LogFile.LogFilePath)
         Else
             LogFile.LogTracing("LogFile does not exists", LogLvl.LOG_WARNING, Me)
             Btn_ViewLog.Enabled = False

WinNUT_V2/WinNUT-Client/WinNUT.vb

@@ -140,15 +140,6 @@ Public Class WinNUT
         WinNUT_PrefsChanged(True)
         LogFile.LogTracing("Loaded Params Complete", LogLvl.LOG_DEBUG, Me)
 
-        ' Setup logging preferences
-        ' LogFile.LogLevel = Arr_Reg_Key.Item("Log Level")
-        ' LogFile.IsWritingToFile = Arr_Reg_Key.Item("UseLogFile")
-        'If Arr_Reg_Key.Item("UseLogFile") Then
-        '    LogFile.InitializeLogFile()
-        'End If
-
-        'LogFile.LogTracing("Logging is configured.", LogLvl.LOG_DEBUG, Me)
-
         'Init Systray
         NotifyIcon.Text = LongProgramName & " - " & ShortProgramVersion
         NotifyIcon.Visible = False
@@ -836,7 +827,7 @@ Public Class WinNUT
         ' Setup logging preferences
         If Arr_Reg_Key.Item("UseLogFile") Then
             LogFile.LogLevelValue = Arr_Reg_Key.Item("Log Level")
-            LogFile.InitializeLogFile(ApplicationDataPath)
+            LogFile.InitializeLogFile()
         ElseIf LogFile.IsWritingToFile Then
             LogFile.DeleteLogFile()
         End If

WinNUT_V2/WinNUT-Client_Common/Logger.vb

@@ -9,28 +9,28 @@
 
 Imports System.Globalization
 Imports System.IO
+Imports Microsoft.VisualBasic.Logging
 
 Public Class Logger
 #Region "Constants/Shared"
-    Private Const LOG_FILE_CREATION_SCHEDULE = Logging.LogFileCreationScheduleOption.Daily
+    Private Const LOG_FILE_CREATION_SCHEDULE = LogFileCreationScheduleOption.Daily
 
-#If DEBUG Then
+    ' Set TEST_RELEASE_DIRS in the custom compiler constants dialog for file storage to behave like release.
+#If DEBUG And Not TEST_RELEASE_DIRS Then
     Private Shared ReadOnly DEFAULT_DATETIMEFORMAT = DateTimeFormatInfo.InvariantInfo
+    Private Shared ReadOnly DEFAULT_LOCATION = LogFileLocation.ExecutableDirectory
 #Else
     Private Shared ReadOnly DEFAULT_DATETIMEFORMAT = DateTimeFormatInfo.CurrentInfo
+    ' Actually goes to the Roaming folder.
+    Private Shared ReadOnly DEFAULT_LOCATION = LogFileLocation.LocalUserApplicationDirectory
 #End If
 
-
-    ' The subfolder that will contain logs.
-    Public Const LOG_SUBFOLDER = "Logs"
-
-    Private Shared ReadOnly BASE_FILE_NAME = ProgramName
     Private ReadOnly TEventCache As New TraceEventCache()
 #End Region
 
 #Region "Private/backing values"
 
-    Private LogFile As Logging.FileLogTraceListener
+    Private LogFile As FileLogTraceListener
     Private L_CurrentLogData As String
     Private LastEventsList As New List(Of Object)
     Private _DateTimeFormatInfo As DateTimeFormatInfo = DEFAULT_DATETIMEFORMAT
@@ -86,7 +86,7 @@ Public Class Logger
     ''' Get the log file location from the <see cref="LogFile"/> object.
     ''' </summary>
     ''' <returns>The possible path to the log file. Note that this does not gaurantee it exists.</returns>
-    Public ReadOnly Property LogFileLocation() As String
+    Public ReadOnly Property LogFilePath() As String
         Get
             Return LogFile.FullLogFileName
         End Get
@@ -108,16 +108,27 @@ Public Class Logger
         LogLevelValue = LogLevel
     End Sub
 
-    Public Sub InitializeLogFile(baseDataFolder As String)
-        LogFile = New Logging.FileLogTraceListener(BASE_FILE_NAME) With {
+    ''' <summary>
+    ''' Instantiates a new <see cref="FileLogTraceListener"/> at a the desired location, and outputs the
+    ''' <see cref="LastEvents"/> buffer into the file before synchronizing with write calls.
+    ''' </summary>
+    ''' <param name="baseDataFolder">Desired location to initiate the log file. If unspecified,
+    ''' then a default location is used.</param>
+    Public Sub InitializeLogFile(Optional baseDataFolder As String = Nothing)
+        LogFile = New FileLogTraceListener() With {
             .TraceOutputOptions = TraceOptions.DateTime Or TraceOptions.ProcessId,
             .Append = True,
             .AutoFlush = True,
-            .LogFileCreationSchedule = LOG_FILE_CREATION_SCHEDULE,
-            .CustomLocation = Path.Combine(baseDataFolder, LOG_SUBFOLDER),
-            .Location = Logging.LogFileLocation.Custom
+            .LogFileCreationSchedule = LOG_FILE_CREATION_SCHEDULE
         }
 
+        If baseDataFolder Is Nothing Then
+            LogFile.Location = DEFAULT_LOCATION
+        Else
+            LogFile.Location = LogFileLocation.Custom
+            LogFile.CustomLocation = baseDataFolder
+        End If
+
         LogTracing(String.Format("{0} {1} Log file init", LongProgramName, ProgramVersion), LogLvl.LOG_NOTICE, Me)
 
         If LastEventsList.Count > 0 Then

WinNUT_V2/WinNUT-Client_Common/WinNUT_Globals.vb

@@ -20,58 +20,12 @@ Public Module WinNUT_Globals
     Public ReadOnly GitHubURL = My.Application.Info.Trademark
     Public ReadOnly Copyright = My.Application.Info.Copyright
 
-#Region "File Directories"
-
-    Private ReadOnly DATA_DIRECTORY_NAME = "WinNUT-Client"
-    Private ReadOnly TEMP_FOLDER = Path.GetTempPath() + DATA_DIRECTORY_NAME
-
-#If DEBUG Then
-    Public ReadOnly IsDebugBuild = True
-    ' If debugging, keep any generated data next to the debug executable.
-    Private ReadOnly DESIRED_DATA_PATH As String = Path.Combine(Environment.CurrentDirectory, DATA_DIRECTORY_NAME)
-#Else
-    Public ReadOnly IsDebugBuild = False
-    Private ReadOnly DESIRED_DATA_PATH As String = Path.Combine(Environment.GetFolderPath(
-                Environment.SpecialFolder.ApplicationData), DATA_DIRECTORY_NAME)
-#End If
-
-    Public ReadOnly TEMP_DATA_PATH = Path.Combine(Path.GetTempPath(), DATA_DIRECTORY_NAME)
-
-#End Region
-
-    Public ApplicationDataPath = TEMP_DATA_PATH
     Public WithEvents LogFile As Logger = New Logger(LogLvl.LOG_DEBUG)
     Public StrLog As New List(Of String)
 
 #End Region
 
     Public Sub Init_Globals()
-        ApplicationDataPath = GetAppDirectory(DESIRED_DATA_PATH)
-    End Sub
-
-    ''' <summary>
-    ''' Do everything possible to find a safe place to write to, with the <see cref="ProgramName"/> appended to it. If
-    ''' the requested option is unavailable, we fall back to the temporary directory for the current user.
-    ''' </summary>
-    ''' <param name="requestedDir">The requested directory, with <see cref="ProgramName"/> appended to it.</param>
-    ''' <returns>The best possible option available as a writable data directory.</returns>
-    Private Function GetAppDirectory(requestedDir As String) As String
-        Dim finalDir As String
-
-        Try
-            Directory.CreateDirectory(requestedDir)
-            LogFile.LogTracing("Successfully created or opened requested data directory for WinNUT." &
-                               vbNewLine & "requestedDir: " & requestedDir, LogLvl.LOG_DEBUG, Nothing)
-            finalDir = requestedDir
 
-        Catch ex As Exception
-            LogFile.LogTracing(ex.ToString & " encountered trying to create app data directory. Falling back to temp.",
-                               LogLvl.LOG_ERROR, Nothing)
-
-            Directory.CreateDirectory(TEMP_DATA_PATH)
-            finalDir = TEMP_DATA_PATH
-        End Try
-
-        Return finalDir
-    End Function
+    End Sub
 End Module

WinNUT_V2/WinNUT_V2.sln

@@ -99,8 +99,8 @@ Global
 		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.Debug|x64.Build.0 = Debug|Any CPU
 		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.Debug|x86.ActiveCfg = Debug|Any CPU
 		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.Debug|x86.Build.0 = Debug|Any CPU
-		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.PreRelease|Any CPU.ActiveCfg = Debug|Any CPU
-		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.PreRelease|Any CPU.Build.0 = Debug|Any CPU
+		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.PreRelease|Any CPU.ActiveCfg = Release|Any CPU
+		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.PreRelease|Any CPU.Build.0 = Release|Any CPU
 		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.PreRelease|ARM.ActiveCfg = Release|Any CPU
 		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.PreRelease|ARM.Build.0 = Release|Any CPU
 		{CBDB1D25-5A95-43D4-A958-BF6AE65C6C3F}.PreRelease|ARM64.ActiveCfg = Release|Any CPU
@@ -129,8 +129,8 @@ Global
 		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.Debug|x64.Build.0 = Debug|Any CPU
 		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.Debug|x86.ActiveCfg = Debug|Any CPU
 		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.Debug|x86.Build.0 = Debug|Any CPU
-		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.PreRelease|Any CPU.ActiveCfg = Debug|Any CPU
-		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.PreRelease|Any CPU.Build.0 = Debug|Any CPU
+		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.PreRelease|Any CPU.ActiveCfg = PreRelease|Any CPU
+		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.PreRelease|Any CPU.Build.0 = PreRelease|Any CPU
 		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.PreRelease|ARM.ActiveCfg = Release|Any CPU
 		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.PreRelease|ARM.Build.0 = Release|Any CPU
 		{9074CE60-DB9A-4BDF-B851-6EAB8A81F366}.PreRelease|ARM64.ActiveCfg = Release|Any CPU