Fixing my own attempt at OOP

gbakeman · gbakeman · commit 3b84ffabb7ec · 2022-08-01T17:32:32.000-07:00
- I shouldn't have put the Logger in the Globals module, IMO it belongs in the main client and passed as necessary to other objects.
- Remove user data from client library project.
diff --git a/WinNUT_V2/WinNUT-Client_Common/Nut_Socket.vb b/WinNUT_V2/WinNUT-Client_Common/Nut_Socket.vb
@@ -126,9 +126,9 @@ Public Class Nut_Socket
         Catch Excep As Exception
             RaiseEvent OnError(Excep, LogLvl.LOG_ERROR, Me)
             Return False
-        Finally
-
         End Try
+
+        Return False
     End Function
 
     Private Function Create_Socket(ByVal Host As String, ByVal Port As Integer) As Boolean
diff --git a/WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb b/WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb
@@ -27,7 +27,7 @@ Public Class UPS_Device
     Private Socket_Status As Boolean = False
 
 
-    'Private LogFile As Logger
+    Private LogFile As Logger
     'Private ConnectionStatus As Boolean = False
     'Private Server As String
     'Private Port As Integer
@@ -107,7 +107,7 @@ Public Class UPS_Device
     End Sub
 
     Public Sub New(ByVal Nut_Config As Nut_Parameter, ByRef LogFile As Logger)
-        ' Me.LogFile = LogFile
+        Me.LogFile = LogFile
         Me.Nut_Config = Nut_Config
         Me.ciClone = CType(CultureInfo.InvariantCulture.Clone(), CultureInfo)
         Me.ciClone.NumberFormat.NumberDecimalSeparator = "."
diff --git a/WinNUT_V2/WinNUT-Client_Common/WinNUT_Globals.vb b/WinNUT_V2/WinNUT-Client_Common/WinNUT_Globals.vb
@@ -32,7 +32,7 @@ Public Module WinNUT_Globals
     Public IsConnected As Boolean
     ' Public LogFile As String
     ' Handle application messages and debug events.
-    Public WithEvents LogFile As Logger '  As New Logger(False, 0)
+    ' 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
diff --git a/WinNUT_V2/WinNUT_GUI/ApplicationEvents.vb b/WinNUT_V2/WinNUT_GUI/ApplicationEvents.vb
@@ -23,6 +23,7 @@ Namespace My
         Private BtnGenerate As New Button
         Private Msg_Crash As New Label
         Private Msg_Error As New TextBox
+
         Private Sub MyApplication_UnhandledException(ByVal sender As Object, ByVal e As ApplicationServices.UnhandledExceptionEventArgs) Handles Me.UnhandledException
             e.ExitApplication = False
 
@@ -81,7 +82,7 @@ Namespace My
             End With
 
             AddHandler BtnClose.Click, AddressOf My.Application.Close_Button_Click
-            AddHandler BtnGenerate.Click, AddressOf My.Application.Generate_Button_Click
+            AddHandler BtnGenerate.Click, AddressOf Application.Generate_Button_Click
             AddHandler CrashBug_Form.FormClosing, AddressOf My.Application.CrashBug_FormClosing
 
             CrashBug_Form.Show()
@@ -122,7 +123,7 @@ Namespace My
             Crash_Report &= Msg_Error.Text & vbNewLine & vbNewLine
             Crash_Report &= "Last Events :" & vbNewLine
 
-            For Each WinNUT_Event In LogFile.LastEvents
+            For Each WinNUT_Event In WinNUT.LogFile.LastEvents
                 Crash_Report &= WinNUT_Event & vbNewLine
             Next
             My.Computer.Clipboard.SetText(Crash_Report)
diff --git a/WinNUT_V2/WinNUT_GUI/Pref_Gui.vb b/WinNUT_V2/WinNUT_GUI/Pref_Gui.vb
@@ -8,24 +8,22 @@
 ' This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY
 
 Imports WinNUT_Params = WinNUT_Client_Common.WinNUT_Params
-Imports Logger = WinNUT_Client_Common.Logger
 Imports LogLvl = WinNUT_Client_Common.LogLvl
-Imports WinNUT_Client_Common.WinNUT_Globals
 Imports System.IO
 
 Public Class Pref_Gui
     Private IsShowed As Boolean = False
     Private IsSaved As Boolean = False
 
     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)
+        WinNUT.LogFile.LogTracing("Close Pref Gui from Button Cancel", LogLvl.LOG_DEBUG, Me)
         Me.Close()
     End Sub
 
     Private Sub Save_Params()
         Try
             Me.IsSaved = False
-            LogFile.LogTracing("Save Parameters.", LogLvl.LOG_DEBUG, Me)
+            WinNUT.LogFile.LogTracing("Save Parameters.", LogLvl.LOG_DEBUG, Me)
             WinNUT_Params.Arr_Reg_Key.Item("ServerAddress") = Tb_Server_IP.Text
             WinNUT_Params.Arr_Reg_Key.Item("Port") = CInt(Tb_Port.Text)
             WinNUT_Params.Arr_Reg_Key.Item("UPSName") = Tb_UPS_Name.Text
@@ -66,19 +64,19 @@ Public Class Pref_Gui
             If CB_Start_W_Win.Checked Then
                 If My.Computer.Registry.GetValue("HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\", Application.ProductName, Nothing) Is Nothing Then
                     My.Computer.Registry.CurrentUser.OpenSubKey("SOFTWARE\Microsoft\Windows\CurrentVersion\Run", True).SetValue(Application.ProductName, Application.ExecutablePath)
-                    LogFile.LogTracing("WinNUT Added to Startup.", LogLvl.LOG_DEBUG, Me)
+                    WinNUT.LogFile.LogTracing("WinNUT Added to Startup.", LogLvl.LOG_DEBUG, Me)
                 End If
             Else
                 If Not My.Computer.Registry.GetValue("HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\", Application.ProductName, Nothing) Is Nothing Then
                     My.Computer.Registry.CurrentUser.OpenSubKey("SOFTWARE\Microsoft\Windows\CurrentVersion\Run", True).DeleteValue(Application.ProductName)
-                    LogFile.LogTracing("WinNUT Removed From Startup.", LogLvl.LOG_DEBUG, Me)
+                    WinNUT.LogFile.LogTracing("WinNUT Removed From Startup.", LogLvl.LOG_DEBUG, Me)
                 End If
             End If
 
-            LogFile.LogLevel = Cbx_LogLevel.SelectedIndex
-            LogFile.IsWritingToFile = CB_Use_Logfile.Checked
+            WinNUT.LogFile.LogLevel = Cbx_LogLevel.SelectedIndex
+            WinNUT.LogFile.IsWritingToFile = CB_Use_Logfile.Checked
 
-            LogFile.LogTracing("Pref_Gui Params Saved", 1, Me)
+            WinNUT.LogFile.LogTracing("Pref_Gui Params Saved", 1, Me)
 
             SetLogControlsStatus()
             WinNUT.WinNUT_PrefsChanged()
@@ -184,11 +182,11 @@ Public Class Pref_Gui
             Next
             Me.Btn_Apply.Enabled = False
             Me.IsShowed = True
-            LogFile.LogTracing("Pref Gui Opened.", LogLvl.LOG_DEBUG, Me)
+            WinNUT.LogFile.LogTracing("Pref Gui Opened.", LogLvl.LOG_DEBUG, Me)
         Catch Except As Exception
             Me.IsShowed = False
             Me.Close()
-            LogFile.LogTracing("Error on Opening Pref_Gui.", LogLvl.LOG_ERROR, Me)
+            WinNUT.LogFile.LogTracing("Error on Opening Pref_Gui.", LogLvl.LOG_ERROR, Me)
         End Try
     End Sub
 
@@ -238,7 +236,7 @@ Public Class Pref_Gui
             Dim Result As Object = 0
             Dim MinValue, MaxValue As Integer
 
-            LogFile.LogTracing(String.Format("Check that the value of {0} for {1} is correct.", sender.Text, sender.Name), LogLvl.LOG_DEBUG, Me)
+            WinNUT.LogFile.LogTracing(String.Format("Check that the value of {0} for {1} is correct.", sender.Text, sender.Name), LogLvl.LOG_DEBUG, Me)
             Select Case sender.Name
                 Case "Tb_Delay_Com"
                     MinValue = 0
@@ -267,10 +265,10 @@ Public Class Pref_Gui
 
             If Integer.TryParse(sender.Text, Result) Then
                 If (Result >= MinValue And Result <= MaxValue) Then
-                    LogFile.LogTracing(String.Format("Value of {0} for {1} is valid.", Result, sender.Name), LogLvl.LOG_DEBUG, Me)
+                    WinNUT.LogFile.LogTracing(String.Format("Value of {0} for {1} is valid.", Result, sender.Name), LogLvl.LOG_DEBUG, Me)
                     sender.BackColor = Color.White
                 Else
-                    LogFile.LogTracing(String.Format("Value of {0} for {1} is invalid.", Result, sender.Name), LogLvl.LOG_ERROR, Me)
+                    WinNUT.LogFile.LogTracing(String.Format("Value of {0} for {1} is invalid.", Result, sender.Name), LogLvl.LOG_ERROR, Me)
                     e.Cancel = True
                     sender.BackColor = Color.Red
                 End If
@@ -281,34 +279,34 @@ Public Class Pref_Gui
         End If
     End Sub
     Private Sub Correct_IP_Validating(sender As Object, e As System.ComponentModel.CancelEventArgs) Handles Tb_Server_IP.Validating
-        LogFile.LogTracing("Check that the Nut Host address is valid.", LogLvl.LOG_DEBUG, Me)
+        WinNUT.LogFile.LogTracing("Check that the Nut Host address is valid.", LogLvl.LOG_DEBUG, Me)
         Dim Pattern As String
         Dim StrTest As String = sender.Text
         Dim Is_Correct As Boolean = False
         'Test IPV4
         Pattern = "^(25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)$"
         If System.Text.RegularExpressions.Regex.IsMatch(sender.Text, Pattern) Then
             Is_Correct = True
-            LogFile.LogTracing("The Nut Host address is a valid IPV4 address.", LogLvl.LOG_WARNING, Me)
+            WinNUT.LogFile.LogTracing("The Nut Host address is a valid IPV4 address.", LogLvl.LOG_WARNING, Me)
         End If
         'Test IPV6
         Pattern = "^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$"
         If (System.Text.RegularExpressions.Regex.IsMatch(sender.Text, Pattern) And Not Is_Correct) Then
             Is_Correct = True
-            LogFile.LogTracing("The Nut Host address is a valid IPV6 address.", LogLvl.LOG_WARNING, Me)
+            WinNUT.LogFile.LogTracing("The Nut Host address is a valid IPV6 address.", LogLvl.LOG_WARNING, Me)
         End If
         'Test fqdn
         Pattern = "^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$"
         If (System.Text.RegularExpressions.Regex.IsMatch(sender.Text, Pattern) And Not Is_Correct) Then
             Is_Correct = True
-            LogFile.LogTracing("The Nut Host address is a valid FQDN address.", LogLvl.LOG_WARNING, Me)
+            WinNUT.LogFile.LogTracing("The Nut Host address is a valid FQDN address.", LogLvl.LOG_WARNING, Me)
         End If
 
         'Result
         If Is_Correct Then
             sender.BackColor = Color.White
         Else
-            LogFile.LogTracing("The Nut Host address is a invalid", LogLvl.LOG_ERROR, Me)
+            WinNUT.LogFile.LogTracing("The Nut Host address is a invalid", LogLvl.LOG_ERROR, Me)
             e.Cancel = True
             sender.BackColor = Color.Red
         End If
@@ -324,32 +322,32 @@ Public Class Pref_Gui
     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)
+        WinNUT.LogFile.LogTracing("Delete LogFile", LogLvl.LOG_DEBUG, Me)
 
-        If LogFile.DeleteLogFile() Then
-            LogFile.LogTracing("LogFile Deleted", LogLvl.LOG_DEBUG, Me)
+        If WinNUT.LogFile.DeleteLogFile() Then
+            WinNUT.LogFile.LogTracing("LogFile Deleted", LogLvl.LOG_DEBUG, Me)
         Else
-            LogFile.LogTracing("Error deleting log file.", LogLvl.LOG_WARNING, Me)
+            WinNUT.LogFile.LogTracing("Error deleting log file.", LogLvl.LOG_WARNING, Me)
         End If
 
-        LogFile.IsWritingToFile = WinNUT_Params.Arr_Reg_Key.Item("UseLogFile")
+        WinNUT.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 File.Exists(LogFile.LogFileLocation) Then
-            Process.Start(LogFile.LogFileLocation)
+        WinNUT.LogFile.LogTracing("Show LogFile", LogLvl.LOG_DEBUG, Me)
+        If File.Exists(WinNUT.LogFile.LogFileLocation) Then
+            Process.Start(WinNUT.LogFile.LogFileLocation)
         Else
-            LogFile.LogTracing("LogFile does not exists", LogLvl.LOG_WARNING, Me)
+            WinNUT.LogFile.LogTracing("LogFile does not exists", LogLvl.LOG_WARNING, Me)
             Btn_ViewLog.Enabled = False
             Btn_DeleteLog.Enabled = False
         End If
     End Sub
 
     Private Sub Pref_Gui_Load(sender As Object, e As EventArgs) Handles MyBase.Load
         Me.Icon = WinNUT.Icon
-        LogFile.LogTracing("Load Pref Gui", LogLvl.LOG_DEBUG, Me)
+        WinNUT.LogFile.LogTracing("Load Pref Gui", LogLvl.LOG_DEBUG, Me)
     End Sub
 
     Private Sub Event_Ctrl_Value_Changed(sender As Object, e As EventArgs)
@@ -371,6 +369,6 @@ Public Class Pref_Gui
             Btn_DeleteLog.Enabled = False
         End If
 
-        LogFile.LogTracing("Setting LogControl statuses.", LogLvl.LOG_DEBUG, Me)
+        WinNUT.LogFile.LogTracing("Setting LogControl statuses.", LogLvl.LOG_DEBUG, Me)
     End Sub
 End Class
diff --git a/WinNUT_V2/WinNUT_GUI/WinNUT-client.vbproj b/WinNUT_V2/WinNUT_GUI/WinNUT-client.vbproj
@@ -14,7 +14,7 @@
     <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
     <IsWebBootstrapper>false</IsWebBootstrapper>
     <TargetFrameworkProfile />
-    <PublishUrl>C:\Users\Nicolas\OneDrive\Documents\GitHub\WinNUT-Client\Releases\</PublishUrl>
+    <PublishUrl></PublishUrl>
     <Install>true</Install>
     <InstallFrom>Disk</InstallFrom>
     <UpdateEnabled>false</UpdateEnabled>
diff --git a/WinNUT_V2/WinNUT_GUI/WinNUT.vb b/WinNUT_V2/WinNUT_GUI/WinNUT.vb
@@ -14,7 +14,7 @@ Public Class WinNUT
 
 #End Region
     ' Logging
-    Private WithEvents ClientLogger As Logger
+    Public Shared WithEvents LogFile As Logger
 
     'Object for UPS management
     Public WithEvents UPS_Device As UPS_Device
@@ -158,7 +158,7 @@ Public Class WinNUT
         ' Setup logging preferences
         LogFile.LogLevel = Arr_Reg_Key.Item("Log Level")
         LogFile.IsWritingToFile = Arr_Reg_Key.Item("UseLogFile")
-        ClientLogger = LogFile
+
         LogFile.LogTracing("Logging is configured.", LogLvl.LOG_DEBUG, Me)
 
         'Init Systray
@@ -1011,7 +1011,7 @@ Public Class WinNUT
         HasFocus = False
     End Sub
 
-    Public Shared Sub Update_InstantLog(ByVal sender As System.Object) Handles ClientLogger.NewData
+    Public Shared Sub Update_InstantLog(sender As Object) Handles LogFile.NewData
         Dim Message As String = LogFile.CurrentLogData
         Static Dim Event_Id = 1
         LogFile.LogTracing("New Log to CB_Current Log : " & Message, LogLvl.LOG_DEBUG, sender.ToString)
