Login, socket improvements

Nut_Socket.vb
- Removed Socket object and any relating code since TcpClient is already providing the functionality.
- Remove Disconnected event since this will be provided through exceptions or intentional commands.
- Fixed use of LOGIN protocol command
- Simplify Disconnect method

UPS_Device.vb
- Created dedicated Login method that interfaces with the socket layer.

WinNUT.vb
- Calls Login method only when a username is provided. Fixes forced/unintended logins.

Author: gbakeman

WinNUT_V2/WinNUT-Client/WinNUT.vb

@@ -383,6 +383,10 @@ Public Class WinNUT
         UPS_Device = New UPS_Device(Nut_Config, LogFile, My.Settings.NUT_PollIntervalMsec, My.Settings.CAL_FreqInNom)
         AddHandler UPS_Device.EncounteredNUTException, AddressOf HandleNUTException
         UPS_Device.Connect_UPS(retryOnConnFailure)
+
+        If Not String.IsNullOrEmpty(Nut_Config.Login) Then
+            UPS_Device.Login()
+        End If
     End Sub
 
     ''' <summary>
@@ -409,8 +413,8 @@ Public Class WinNUT
     End Sub
 
     Private Sub ConnectionError(sender As UPS_Device, ex As Exception) Handles UPS_Device.ConnectionError
-        LogFile.LogTracing(String.Format("Something went wrong connecting to UPS {0}. IsConnected: {1}, IsAuthenticated: {2}",
-                               sender.Name, sender.IsConnected, sender.IsAuthenticated), LogLvl.LOG_ERROR, Me,
+        LogFile.LogTracing(String.Format("Something went wrong connecting to UPS {0}. IsConnected: {1}, IsLoggedIn: {2}",
+                               sender.Name, sender.IsConnected, sender.IsLoggedIn), LogLvl.LOG_ERROR, Me,
                                String.Format(StrLog.Item(AppResxStr.STR_LOG_CON_FAILED), sender.Nut_Config.Host, sender.Nut_Config.Port,
                                              ex.Message))
     End Sub

WinNUT_V2/WinNUT-Client_Common/Nut_Socket.vb

@@ -11,18 +11,15 @@
 
 ' Class dealing only with the management of the communication socket with the Nut server
 Imports System.IO
+Imports System.Net
 Imports System.Net.Sockets
 
 Public Class Nut_Socket
 
 #Region "Properties"
     Public ReadOnly Property ConnectionStatus As Boolean
         Get
-            If NutSocket IsNot Nothing Then
-                Return NutSocket.Connected
-            Else
-                Return False
-            End If
+            Return client.Connected
         End Get
     End Property
 
@@ -58,8 +55,7 @@ Public Class Nut_Socket
     Private NutConfig As Nut_Parameter
 
     'Socket Variables
-    Private NutSocket As Socket
-    Private NutTCP As TcpClient
+    Private client As New TcpClient
     Private NutStream As NetworkStream
     Private ReaderStream As StreamReader
     Private WriterStream As StreamWriter
@@ -71,11 +67,6 @@ Public Class Nut_Socket
 
     Public Event Socket_Broken(ex As NutException)
 
-    ''' <summary>
-    ''' Socket was disconnected as a part of normal operations.
-    ''' </summary>
-    Public Event SocketDisconnected()
-
     Public Sub New(Nut_Config As Nut_Parameter, ByRef logger As Logger)
         LogFile = logger
         NutConfig = Nut_Config
@@ -93,67 +84,53 @@ Public Class Nut_Socket
         End If
 
         Try
-            ' NutSocket = New Socket(AddressFamily.InterNetwork, ProtocolType.IP)
-            NutSocket = New Socket(SocketType.Stream, ProtocolType.IP)
             LogFile.LogTracing(String.Format("Attempting TCP socket connection to {0}:{1}...", Host, Port), LogLvl.LOG_NOTICE, Me)
-            NutSocket.Connect(Host, Port)
-            NutTCP = New TcpClient(Host, Port)
-            NutStream = NutTCP.GetStream
+
+            client.Connect(Host, Port)
+            NutStream = client.GetStream()
             ReaderStream = New StreamReader(NutStream)
             WriterStream = New StreamWriter(NutStream)
-            LogFile.LogTracing(String.Format("Connection established and streams ready for {0}:{1}", Host, Port), LogLvl.LOG_NOTICE, Me)
 
-            ' Something went wrong - cleanup and pass along error.
+            LogFile.LogTracing("Connection established and streams ready.", LogLvl.LOG_NOTICE, Me)
+
         Catch Excep As Exception
             Disconnect(True)
             Throw ' Pass exception on up to UPS
         End Try
 
-        If ConnectionStatus Then
-            Try
-                AuthLogin(Login, Password)
-            Catch ex As NutException
-                ' TODO: Make friendly message string for user.
-                LogFile.LogTracing("Error while attempting to log in: " & ex.Message, LogLvl.LOG_ERROR, Me)
-            End Try
+        Dim Nut_Query = Query_Data("VER")
 
-            Dim Nut_Query = Query_Data("VER")
-
-            If Nut_Query.ResponseType = NUTResponse.OK Then
-                Nut_Ver = (Nut_Query.RawResponse.Split(" "c))(4)
-            End If
-            Nut_Query = Query_Data("NETVER")
-
-            If Nut_Query.ResponseType = NUTResponse.OK Then
-                Net_Ver = Nut_Query.RawResponse
-            End If
+        If Nut_Query.ResponseType = NUTResponse.OK Then
+            Nut_Ver = (Nut_Query.RawResponse.Split(" "c))(4)
+        End If
+        Nut_Query = Query_Data("NETVER")
 
-            LogFile.LogTracing(String.Format("NUT server reports VER: {0} NETVER: {1}", Nut_Ver, Net_Ver), LogLvl.LOG_NOTICE, Me)
+        If Nut_Query.ResponseType = NUTResponse.OK Then
+            Net_Ver = Nut_Query.RawResponse
         End If
+
+        LogFile.LogTracing(String.Format("NUT server reports VER: {0} NETVER: {1}", Nut_Ver, Net_Ver), LogLvl.LOG_NOTICE, Me)
     End Sub
 
-    ''' <summary>
-    ''' Register with the UPSd server as being dependant on it for power.
-    ''' </summary>
-    ''' <param name="Login"></param>
-    ''' <param name="Password"></param>
-    ''' <exception cref="NutException">A protocol error was encountered while trying to authenticate.</exception>
-    Private Sub AuthLogin(Login As String, Password As String)
+    Public Sub Login()
         If _isLoggedIn Then
             Throw New InvalidOperationException("Attempted to login when already logged in.")
         End If
 
-        LogFile.LogTracing("Attempting authentication...", LogLvl.LOG_NOTICE, Me)
+        LogFile.LogTracing(String.Format("Logging in to UPS [{0}] as user [{1}] ({2})...",
+                            NutConfig.UPSName, NutConfig.Login,
+                            If(String.IsNullOrEmpty(NutConfig.Password),
+                                "NO Password", "Password provided")), LogLvl.LOG_NOTICE, Me)
 
-        If Not String.IsNullOrEmpty(Login) Then
-            Query_Data("USERNAME " & Login)
+        If Not String.IsNullOrEmpty(NutConfig.Login) Then
+            Query_Data("USERNAME " & NutConfig.Login)
 
-            If Not String.IsNullOrEmpty(Password) Then
-                Query_Data("PASSWORD " & Password)
+            If Not String.IsNullOrEmpty(NutConfig.Password) Then
+                Query_Data("PASSWORD " & NutConfig.Password)
             End If
         End If
 
-        Query_Data("LOGIN")
+        Query_Data("LOGIN " & NutConfig.UPSName)
         _isLoggedIn = True
         LogFile.LogTracing("Authenticated successfully.", LogLvl.LOG_NOTICE, Me)
     End Sub
@@ -163,12 +140,29 @@ Public Class Nut_Socket
     ''' </summary>
     ''' <param name="forceful">Skip sending the LOGOUT command to the NUT server. Unknown effects.</param>
     Public Sub Disconnect(Optional forceful = False)
-        If Not forceful AndAlso IsConnected AndAlso IsLoggedIn Then
-            Query_Data("LOGOUT")
-        End If
+        If IsConnected Then
+            If IsLoggedIn AndAlso Not forceful Then
+                Query_Data("LOGOUT")
+            End If
 
-        Close_Socket()
-        RaiseEvent SocketDisconnected()
+            If WriterStream IsNot Nothing Then
+                WriterStream.Close()
+            End If
+
+            If ReaderStream IsNot Nothing Then
+                ReaderStream.Close()
+            End If
+
+            If NutStream IsNot Nothing Then
+                NutStream.Close()
+            End If
+
+            If client IsNot Nothing Then
+                client.Close()
+            End If
+        Else
+            Throw New InvalidOperationException("NUT Socket is already disconnected.")
+        End If
     End Sub
 
     ''' <summary>
@@ -383,31 +377,4 @@ Public Class Nut_Socket
             RaiseEvent Socket_Broken(New NutException(Nut_Query))
         End If
     End Sub
-
-    Private Sub Close_Socket()
-        Try
-            If WriterStream IsNot Nothing Then
-                WriterStream.Close()
-            End If
-
-            If ReaderStream IsNot Nothing Then
-                ReaderStream.Close()
-            End If
-
-            If NutStream IsNot Nothing Then
-                NutStream.Close()
-            End If
-
-            If NutTCP IsNot Nothing Then
-                NutTCP.Close()
-            End If
-
-            If NutSocket IsNot Nothing Then
-                NutSocket.Close()
-            End If
-        Catch Excep As Exception
-            LogFile.LogTracing("Error encountered while shutting down socket: " & vbNewLine & Excep.ToString(),
-                               LogLvl.LOG_ERROR, Me)
-        End Try
-    End Sub
 End Class

WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb

@@ -37,8 +37,7 @@ Public Class UPS_Device
             Return (Nut_Socket.IsConnected)
         End Get
     End Property
-
-    Public ReadOnly Property IsAuthenticated As Boolean
+    Public ReadOnly Property IsLoggedIn As Boolean
         Get
             Return Nut_Socket.IsLoggedIn
         End Get
@@ -154,6 +153,7 @@ Public Class UPS_Device
             UPS_Datas = GetUPSProductInfo()
             Update_Data.Start()
             RaiseEvent Connected(Me)
+
         Catch ex As NutException
             ' This is how we determine if we have a valid UPS name entered, among other errors.
             RaiseEvent EncounteredNUTException(Me, ex)
@@ -168,6 +168,21 @@ Public Class UPS_Device
         End Try
     End Sub
 
+    Public Sub Login()
+        If Not IsConnected OrElse IsLoggedIn Then
+            Throw New InvalidOperationException("UPS is in an invalid state to login.")
+        End If
+
+        If Not String.IsNullOrEmpty(Nut_Config.Login) Then
+            Try
+                Nut_Socket.Login()
+            Catch ex As NutException
+                LogFile.LogTracing("Error while attempting to log in.", LogLvl.LOG_ERROR, Me)
+                RaiseEvent EncounteredNUTException(Me, ex)
+            End Try
+        End If
+    End Sub
+
     Public Sub Disconnect(Optional cancelReconnect As Boolean = True, Optional forceful As Boolean = False)
         LogFile.LogTracing("Processing request to disconnect...", LogLvl.LOG_DEBUG, Me)
 
@@ -179,7 +194,7 @@ Public Class UPS_Device
 
         Retry = 0
         Try
-            Nut_Socket.Disconnect(forceful)
+
         Catch nutEx As NutException
             RaiseEvent EncounteredNUTException(Me, nutEx)
         Finally
@@ -189,12 +204,6 @@ Public Class UPS_Device
 
 #Region "Socket Interaction"
 
-    Private Sub SocketDisconnected() Handles Nut_Socket.SocketDisconnected
-        LogFile.LogTracing("NutSocket raised Disconnected event.", LogLvl.LOG_DEBUG, Me)
-
-        RaiseEvent Disconnected()
-    End Sub
-
     Private Sub Socket_Broken() Handles Nut_Socket.Socket_Broken
         LogFile.LogTracing("Socket has reported a Broken event.", LogLvl.LOG_WARNING, Me)
         RaiseEvent Lost_Connect()
@@ -215,6 +224,11 @@ Public Class UPS_Device
                 LogFile.LogTracing("Nut Host Reconnected", LogLvl.LOG_DEBUG, Me)
                 Reconnect_Nut.Stop()
                 Retry = 0
+
+                If Not String.IsNullOrEmpty(Nut_Config.Login) Then
+                    Login()
+                End If
+
                 RaiseEvent ReConnected(Me)
             End If
         Else