Logging-related improvements

gbakeman · gbakeman · commit ce5be39c66e3 · 2022-08-01T12:00:20.000-07:00
- WinNUT_Globals:
  - Move AppData directory info to a Property, and return different values if debugging or not.
  - Logger object is now stored in globals, rathern than WinNUT.vb
- Logger.vb:
  - BaseFileName is now a const, LogFolder is shared and stored in a subdirectory
  - LogFile writing is now a property that handles setup and shutdown of logging
  - Actual logging setup is moved to its own subrouting, so the class constructor has very little to do.

- Updated/simplified/commented out unnecessary LogFile references.
- Pref_Gui: Simplified log controls, created a subrouting for log control enablement.
- WinNUT.vb:
  - Instantiate Logger at beginning of form load.
  - Relocated logtracing lines to appropriate locations.
  - Renamed local Logger object for events handling.
diff --git a/WinNUT_V2/WinNUT-Client_Common/Logger.vb b/WinNUT_V2/WinNUT-Client_Common/Logger.vb
@@ -7,16 +7,22 @@
 '
 ' This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY
 
+Imports System.IO
+
 Public Class Logger
-    Private ReadOnly LogFile As New Microsoft.VisualBasic.Logging.FileLogTraceListener()
+    Private Const BaseFileName = "WinNUT-CLient"
+    ' Logs will be stored in the program's appdata folder, in a Logs subdirectory.
+    Public Shared ReadOnly LogFolder = Path.Combine(ApplicationData, "Logs")
+
+    Private LogFile As Logging.FileLogTraceListener
     Private ReadOnly TEventCache As New TraceEventCache()
-    ' Enable writing to a log file.
-    Public WriteToFile As Boolean
     Public LogLevelValue As LogLvl
     Private L_CurrentLogData As String
     Private LastEventsList As New List(Of Object)
     Public Event NewData(ByVal sender As Object)
 
+#Region "Properties"
+
     Public Property CurrentLogData() As String
         Get
             Dim Tmp_Data = Me.L_CurrentLogData
@@ -32,32 +38,38 @@ Public Class Logger
             Return Me.LastEventsList
         End Get
     End Property
-    Public Sub New(ByVal WriteLog As Boolean, ByVal LogLevel As LogLvl)
-        Me.WriteToFile = WriteLog
-        Me.LogLevelValue = LogLevel
-        Me.LogFile.TraceOutputOptions = TraceOptions.DateTime Or TraceOptions.ProcessId
-        Me.LogFile.Append = True
-        Me.LogFile.AutoFlush = True
-        Me.LogFile.BaseFileName = "WinNUT-CLient"
-        Me.LogFile.LogFileCreationSchedule = Logging.LogFileCreationScheduleOption.Daily
-        Me.LogFile.Location = Microsoft.VisualBasic.Logging.LogFileLocation.Custom
-        Me.LogFile.CustomLocation = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) & "\WinNUT-Client"
-        Me.LastEventsList.Capacity = 50
-        ' WinNUT_Globals.LogFilePath = Me.LogFile.FullLogFileName
-    End Sub
 
-    Public Property WriteLog() As Boolean
+    ''' <summary>
+    ''' Returns if data is being written to a file. Also allows for file logging to be setup or stopped.
+    ''' </summary>
+    ''' <returns>True when the <see cref="LogFile"/> object is instantiated, false if not.</returns>
+    Public Property IsWritingToFile() As Boolean
         Get
-            Return Me.WriteToFile
+            Return Not (LogFile Is Nothing)
         End Get
-        Set(ByVal Value As Boolean)
-            Me.WriteToFile = Value
-            If Not Me.WriteToFile Then
+
+        Set(Value As Boolean)
+            If Value = False And LogFile IsNot Nothing Then
+                LogFile.Close()
                 LogFile.Dispose()
+                LogFile = Nothing
+                LogTracing("Logging to file has been disabled.", LogLvl.LOG_NOTICE, Me)
+            ElseIf Value Then
+                SetupLogfile()
             End If
         End Set
     End Property
 
+    Public ReadOnly Property LogFileLocation() As String
+        Get
+            If IsWritingToFile Then
+                Return LogFile.FullLogFileName
+            Else
+                Return String.Empty
+            End If
+        End Get
+    End Property
+
     Public Property LogLevel() As LogLvl
         Get
             Return Me.LogLevelValue
@@ -67,10 +79,42 @@ Public Class Logger
         End Set
     End Property
 
+#End Region
+
+    Public Sub New(WriteLog As Boolean, LogLevel As LogLvl)
+        IsWritingToFile = WriteLog
+        LogLevelValue = LogLevel
+        LastEventsList.Capacity = 50
+    End Sub
+
+    Public Sub SetupLogfile()
+        LogFile = New Logging.FileLogTraceListener(BaseFileName) With {
+            .TraceOutputOptions = TraceOptions.DateTime Or TraceOptions.ProcessId,
+            .Append = True,
+            .AutoFlush = True,
+            .LogFileCreationSchedule = Logging.LogFileCreationScheduleOption.Daily,
+            .CustomLocation = LogFolder,
+            .Location = Logging.LogFileLocation.Custom
+        }
+
+        LogTracing("Log file is initialized at " & LogFile.FullLogFileName, LogLvl.LOG_NOTICE, Me)
+    End Sub
+
+    Public Function DeleteLogFile() As Boolean
+        Try
+            Dim fileLocation = LogFile.FullLogFileName
+            IsWritingToFile = False
+            File.Delete(fileLocation)
+            Return True
+        Catch ex As Exception
+            Return False
+        End Try
+    End Function
+
     ''' <summary>
-    ''' Insert an event into the <see cref="LastEventsList" /> for report generating, write a line to the
-    ''' <see cref="LogFile"/> if the event is as or more important than the <see cref="LogLevel"/>, and notify any
-    ''' listeners if <paramref name="LogToDisplay"/> is specified.
+    ''' Write the <paramref name="message"/> to the Debug tracer is debugging, into the <see cref="LastEventsList" />
+    ''' for report generating, to the <see cref="LogFile"/> if appropriate, and notify any listeners if
+    ''' <paramref name="LogToDisplay"/> is specified.
     ''' </summary>
     ''' <param name="message">The raw information that needs to be recorded.</param>
     ''' <param name="LvlError">How important the information is.</param>
@@ -100,7 +144,7 @@ Public Class Logger
 
         Me.LastEventsList.Add(FinalMsg)
 
-        If Me.WriteToFile AndAlso Me.LogLevel >= LvlError Then
+        If IsWritingToFile AndAlso Me.LogLevel >= LvlError Then
             LogFile.WriteLine(FinalMsg)
         End If
         'If LvlError = LogLvl.LOG_NOTICE Then
diff --git a/WinNUT_V2/WinNUT-Client_Common/WinNUT_Globals.vb b/WinNUT_V2/WinNUT-Client_Common/WinNUT_Globals.vb
@@ -7,31 +7,43 @@
 '
 ' This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY
 
+Imports System.IO
+
 Public Module WinNUT_Globals
+#Region "Properties"
+    ' The directory where volatile appdata is stored.
+    ReadOnly Property ApplicationData() As String
+        Get
+#If DEBUG Then
+            ' If debugging, keep any generated data next to the debug executable.
+            Return Path.Combine(Environment.CurrentDirectory, "Data")
+#End If
+            Return Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "\WinNUT-Client")
+        End Get
+    End Property
+#End Region
+
     Public LongProgramName As String
     Public ProgramName As String
     Public ProgramVersion As String
     Public ShortProgramVersion As String
     Public GitHubURL As String
     Public Copyright As String
-    Public Directory_AppData As String
     Public IsConnected As Boolean
-    Public LogFile As String
+    ' Public LogFile As String
+    ' Handle application messages and debug events.
+    Public WithEvents LogFile As Logger '  As New Logger(False, 0)
     Public AppIcon As Dictionary(Of Integer, System.Drawing.Icon)
     Public StrLog As New List(Of String)
-    Public LogFilePath As String
+    ' Public LogFilePath As String
+
     Public Sub Init_Globals()
         LongProgramName = My.Application.Info.Description
         ProgramName = My.Application.Info.ProductName
         ProgramVersion = System.Reflection.Assembly.GetEntryAssembly().GetName().Version.ToString
         ShortProgramVersion = ProgramVersion.Substring(0, ProgramVersion.IndexOf(".", ProgramVersion.IndexOf(".") + 1))
         GitHubURL = My.Application.Info.Trademark
         Copyright = My.Application.Info.Copyright
-        Directory_AppData = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) & "\WinNUT-Client"
-
-        If Not System.IO.Directory.Exists(Directory_AppData) Then
-            My.Computer.FileSystem.CreateDirectory(Directory_AppData)
-        End If
         IsConnected = False
 
         'Add Main Gui's Strings
@@ -79,4 +91,14 @@ Public Module WinNUT_Globals
         'StrLog.Insert(AppResxStr.STR_LOG_NUT_FSD, Resources.Log_Str_12)
     End Sub
 
+    'Sub SetupAppDirectory()
+    '    If Not Directory.Exists(ApplicationData) Then
+    '        Try
+    '            Directory.CreateDirectory(ApplicationData)
+    '        Catch ex As Exception
+    '            Logger.LogTracing("Could not create application directory! Operating with reduced functionality.\n\n" & ex.ToString(),
+    '                                   LogLvl.LOG_ERROR, Nothing)
+    '        End Try
+    '    End If
+    'End Sub
 End Module
diff --git a/WinNUT_V2/WinNUT_GUI/About_Gui.vb b/WinNUT_V2/WinNUT_GUI/About_Gui.vb
@@ -19,7 +19,7 @@ Public Class About_Gui
         Lbl_Copyright_2019.Text = Strings.Replace(WinNUT_Globals.Copyright, "©", vbNewLine & "©")
         LkLbl_Github.Text = WinNUT_Globals.GitHubURL
         Me.Icon = WinNUT.Icon
-        Me.LogFile = WinNUT.LogFile
+        ' Me.LogFile = WinNUT.LogFile
         LogFile.LogTracing("Load About Gui", LogLvl.LOG_DEBUG, Me)
     End Sub
 
diff --git a/WinNUT_V2/WinNUT_GUI/ApplicationEvents.vb b/WinNUT_V2/WinNUT_GUI/ApplicationEvents.vb
@@ -7,6 +7,7 @@
 '
 ' This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY
 
+Imports WinNUT_Client_Common
 Imports WinNUT_Params = WinNUT_Client_Common.WinNUT_Params
 
 Namespace My
@@ -121,7 +122,7 @@ Namespace My
             Crash_Report &= Msg_Error.Text & vbNewLine & vbNewLine
             Crash_Report &= "Last Events :" & vbNewLine
 
-            For Each WinNUT_Event In WinNUT.LogFile.LastEvents
+            For Each WinNUT_Event In LogFile.LastEvents
                 Crash_Report &= WinNUT_Event & vbNewLine
             Next
             My.Computer.Clipboard.SetText(Crash_Report)
diff --git a/WinNUT_V2/WinNUT_GUI/List_Var_Gui.vb b/WinNUT_V2/WinNUT_GUI/List_Var_Gui.vb
@@ -16,7 +16,7 @@ Public Class List_Var_Gui
     Private LogFile As Logger
     Private UPS_Name = WinNUT.Nut_Config.UPSName
     Private Sub List_Var_Gui_Load(sender As Object, e As EventArgs) Handles MyBase.Load
-        Me.LogFile = WinNUT.LogFile
+        ' Me.LogFile = WinNUT.LogFile
         LogFile.LogTracing("Load List Var Gui", LogLvl.LOG_DEBUG, Me)
         Me.Icon = WinNUT.Icon
         Me.Visible = False
diff --git a/WinNUT_V2/WinNUT_GUI/Pref_Gui.vb b/WinNUT_V2/WinNUT_GUI/Pref_Gui.vb
@@ -10,11 +10,13 @@
 Imports WinNUT_Params = WinNUT_Client_Common.WinNUT_Params
 Imports Logger = WinNUT_Client_Common.Logger
 Imports LogLvl = WinNUT_Client_Common.LogLvl
-Imports WinNUT_Globals = WinNUT_Client_Common.WinNUT_Globals
+Imports WinNUT_Client_Common.WinNUT_Globals
+Imports System.IO
+
 Public Class Pref_Gui
     Private IsShowed As Boolean = False
     Private IsSaved As Boolean = False
-    Private LogFile As Logger
+
     Private Sub Btn_Cancel_Click(sender As Object, e As EventArgs) Handles Btn_Cancel.Click
         LogFile.LogTracing("Close Pref Gui from Button Cancel", LogLvl.LOG_DEBUG, Me)
         Me.Close()
@@ -72,23 +74,13 @@ Public Class Pref_Gui
                     LogFile.LogTracing("WinNUT Removed From Startup.", LogLvl.LOG_DEBUG, Me)
                 End If
             End If
-            If CB_Use_Logfile.Checked Then
-                WinNUT.LogFile.WriteLog = True
-                LogFile.LogTracing("LogFile Enabled.", LogLvl.LOG_DEBUG, Me)
-            Else
-                WinNUT.LogFile.WriteLog = False
-                LogFile.LogTracing("LogFile Disabled.", LogLvl.LOG_DEBUG, Me)
-            End If
-            WinNUT.LogFile.LogLevel = Cbx_LogLevel.SelectedIndex
 
-            WinNUT.LogFile.LogTracing("Pref_Gui Params Saved", 1, Me)
-            If My.Computer.FileSystem.FileExists(WinNUT_Globals.LogFilePath) Then
-                Btn_ViewLog.Enabled = True
-                Btn_DeleteLog.Enabled = True
-            Else
-                Btn_ViewLog.Enabled = False
-                Btn_DeleteLog.Enabled = False
-            End If
+            LogFile.LogLevel = Cbx_LogLevel.SelectedIndex
+            LogFile.IsWritingToFile = CB_Use_Logfile.Checked
+
+            LogFile.LogTracing("Pref_Gui Params Saved", 1, Me)
+
+            SetLogControlsStatus()
             WinNUT.WinNUT_PrefsChanged()
             Me.IsSaved = True
         Catch e As Exception
@@ -326,35 +318,28 @@ Public Class Pref_Gui
     End Sub
 
     Private Sub TabControl_Options_Selecting(sender As Object, e As TabControlCancelEventArgs) Handles TabControl_Options.Selecting
-        If My.Computer.FileSystem.FileExists(WinNUT_Globals.LogFilePath) Then
-            Btn_ViewLog.Enabled = True
-            Btn_DeleteLog.Enabled = True
-        Else
-            Btn_ViewLog.Enabled = False
-            Btn_DeleteLog.Enabled = False
+        If TabControl_Options.SelectedTab Is Tab_Miscellanous Then
+            SetLogControlsStatus()
         End If
     End Sub
 
     Private Sub Btn_DeleteLog_Click(sender As Object, e As EventArgs) Handles Btn_DeleteLog.Click
         LogFile.LogTracing("Delete LogFile", LogLvl.LOG_DEBUG, Me)
-        If My.Computer.FileSystem.FileExists(WinNUT_Globals.LogFilePath) Then
-            WinNUT.LogFile.WriteLog = False
-            My.Computer.FileSystem.DeleteFile(WinNUT_Globals.LogFilePath)
-            WinNUT.LogFile.WriteLog = WinNUT_Params.Arr_Reg_Key.Item("UseLogFile")
-            Btn_ViewLog.Enabled = True
-            Btn_DeleteLog.Enabled = True
+
+        If LogFile.DeleteLogFile() Then
             LogFile.LogTracing("LogFile Deleted", LogLvl.LOG_DEBUG, Me)
         Else
-            LogFile.LogTracing("LogFile does not exists", LogLvl.LOG_WARNING, Me)
-            Btn_ViewLog.Enabled = False
-            Btn_DeleteLog.Enabled = False
+            LogFile.LogTracing("Error deleting log file.", LogLvl.LOG_WARNING, Me)
         End If
+
+        LogFile.IsWritingToFile = WinNUT_Params.Arr_Reg_Key.Item("UseLogFile")
+        SetLogControlsStatus()
     End Sub
 
     Private Sub Btn_ViewLog_Click(sender As Object, e As EventArgs) Handles Btn_ViewLog.Click
         LogFile.LogTracing("Show LogFile", LogLvl.LOG_DEBUG, Me)
-        If My.Computer.FileSystem.FileExists(WinNUT_Globals.LogFilePath) Then
-            Process.Start(WinNUT_Globals.LogFilePath)
+        If File.Exists(LogFile.LogFileLocation) Then
+            Process.Start(LogFile.LogFileLocation)
         Else
             LogFile.LogTracing("LogFile does not exists", LogLvl.LOG_WARNING, Me)
             Btn_ViewLog.Enabled = False
@@ -364,7 +349,6 @@ Public Class Pref_Gui
 
     Private Sub Pref_Gui_Load(sender As Object, e As EventArgs) Handles MyBase.Load
         Me.Icon = WinNUT.Icon
-        Me.LogFile = WinNUT.LogFile
         LogFile.LogTracing("Load Pref Gui", LogLvl.LOG_DEBUG, Me)
     End Sub
 
@@ -374,4 +358,19 @@ Public Class Pref_Gui
             Me.Btn_Apply.Enabled = True
         End If
     End Sub
+
+    ''' <summary>
+    ''' Enable or disable controls to view and delete log data if it's available.
+    ''' </summary>
+    Private Sub SetLogControlsStatus()
+        If WinNUT_Params.Arr_Reg_Key.Item("UseLogFile") Then ' Directory.Exists(Logger.LogFolder)
+            Btn_ViewLog.Enabled = True
+            Btn_DeleteLog.Enabled = True
+        Else
+            Btn_ViewLog.Enabled = False
+            Btn_DeleteLog.Enabled = False
+        End If
+
+        LogFile.LogTracing("Setting LogControl statuses.", LogLvl.LOG_DEBUG, Me)
+    End Sub
 End Class
diff --git a/WinNUT_V2/WinNUT_GUI/Shutdown_Gui.vb b/WinNUT_V2/WinNUT_GUI/Shutdown_Gui.vb
@@ -34,7 +34,7 @@ Public Class Shutdown_Gui
 
     Private Sub Shutdown_Gui_Load(sender As Object, e As EventArgs) Handles MyBase.Load
         Me.Icon = WinNUT.Icon
-        Me.LogFile = WinNUT.LogFile
+        ' Me.LogFile = WinNUT.LogFile
         LogFile.LogTracing("Load ShutDown Gui", LogLvl.LOG_DEBUG, Me)
         Me.Grace_Timer.Enabled = False
         Me.Grace_Timer.Stop()
diff --git a/WinNUT_V2/WinNUT_GUI/Update_Gui.vb b/WinNUT_V2/WinNUT_GUI/Update_Gui.vb
@@ -46,7 +46,7 @@ Public Class Update_Gui
             MyBase.SetVisibleCore(False)
             WinNUT.NotifyIcon.Visible = False
             Me.Icon = WinNUT.Icon
-            LogFile = WinNUT.LogFile
+            ' LogFile = WinNUT.LogFile
             VerifyUpdate()
         End If
     End Sub
@@ -136,7 +136,7 @@ Public Class Update_Gui
                 End If
             End If
         Catch excep As Exception
-            WinNUT.LogFile.LogTracing(excep.Message, LogLvl.LOG_ERROR, Me)
+            LogFile.LogTracing(excep.Message, LogLvl.LOG_ERROR, Me)
         End Try
         WinNUT_Params.Arr_Reg_Key.Item("LastDateVerification") = Now.ToString
         WinNUT_Params.Save_Params()
diff --git a/WinNUT_V2/WinNUT_GUI/WinNUT.vb b/WinNUT_V2/WinNUT_GUI/WinNUT.vb
