From b12e79804174880810c2aa9006e0d63574636b83 Mon Sep 17 00:00:00 2001 From: Alex Johnson Date: Wed, 24 Aug 2022 14:11:46 -0400 Subject: [PATCH 01/19] Reworks reconnect timer due to issues seen on 4 series where autoreconnect cycle breaks. --- .../Pepperdash Core/Comm/GenericSshClient.cs | 39 ++++++-------- .../Comm/GenericTcpIpClient.cs | 51 ++++++++++++------- 2 files changed, 48 insertions(+), 42 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index a0093a7..5f4c5c8 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -151,6 +151,11 @@ namespace PepperDash.Core Username = username; Password = password; AutoReconnectIntervalMs = 5000; + + ReconnectTimer = new CTimer(o => + { + Connect(); + }, Timeout.Infinite); } /// @@ -162,6 +167,11 @@ namespace PepperDash.Core StreamDebugging = new CommunicationStreamDebugging(SPlusKey); CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); AutoReconnectIntervalMs = 5000; + + ReconnectTimer = new CTimer(o => + { + Connect(); + }, Timeout.Infinite); } /// @@ -203,11 +213,7 @@ namespace PepperDash.Core Debug.Console(1, this, "attempting connect"); // Cancel reconnect if running. - if (ReconnectTimer != null) - { - ReconnectTimer.Stop(); - ReconnectTimer = null; - } + ReconnectTimer.Stop(); // Don't try to connect if already if (IsConnected) @@ -297,11 +303,7 @@ namespace PepperDash.Core { ConnectEnabled = false; // Stop trying reconnects, if we are - if (ReconnectTimer != null) - { - ReconnectTimer.Stop(); - ReconnectTimer = null; - } + ReconnectTimer.Stop(); KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY); } @@ -334,20 +336,9 @@ namespace PepperDash.Core if (AutoReconnect && ConnectEnabled) { Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); - if (ReconnectTimer == null) - { - ReconnectTimer = new CTimer(o => - { - Connect(); - }, AutoReconnectIntervalMs); - Debug.Console(1, this, "Attempting connection in {0} seconds", - (float) (AutoReconnectIntervalMs/1000)); - } - else - { - Debug.Console(1, this, "{0} second reconnect cycle running", - (float) (AutoReconnectIntervalMs/1000)); - } + ReconnectTimer.Reset(AutoReconnectIntervalMs); + Debug.Console(1, this, "Attempting connection in {0} seconds", + (float) (AutoReconnectIntervalMs/1000)); } } diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs index 480e4d1..5f09f36 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs @@ -185,6 +185,16 @@ namespace PepperDash.Core BufferSize = bufferSize; AutoReconnectIntervalMs = 5000; + RetryTimer = new CTimer(o => + { + if (Client == null) + { + return; + } + + Client.ConnectToServerAsync(ConnectToServerCallback); + }, Timeout.Infinite); + CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); } @@ -199,6 +209,16 @@ namespace PepperDash.Core CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); AutoReconnectIntervalMs = 5000; BufferSize = 2000; + + RetryTimer = new CTimer(o => + { + if (Client == null) + { + return; + } + + Client.ConnectToServerAsync(ConnectToServerCallback); + }, Timeout.Infinite); } /// @@ -211,6 +231,16 @@ namespace PepperDash.Core CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); AutoReconnectIntervalMs = 5000; BufferSize = 2000; + + RetryTimer = new CTimer(o => + { + if (Client == null) + { + return; + } + + Client.ConnectToServerAsync(ConnectToServerCallback); + }, Timeout.Infinite); } /// @@ -287,11 +317,7 @@ namespace PepperDash.Core DisconnectCalledByUser = true; // Stop trying reconnects, if we are - if (RetryTimer != null) - { - RetryTimer.Stop(); - RetryTimer = null; - } + RetryTimer.Stop(); if (Client != null) { @@ -337,15 +363,7 @@ namespace PepperDash.Core Debug.Console(1, this, "Attempting reconnect, status={0}", Client.ClientStatus); if (!DisconnectCalledByUser) - RetryTimer = new CTimer(o => - { - if (Client == null) - { - return; - } - - Client.ConnectToServerAsync(ConnectToServerCallback); - }, AutoReconnectIntervalMs); + RetryTimer.Reset(AutoReconnectIntervalMs); } } @@ -381,11 +399,8 @@ namespace PepperDash.Core textHandler(this, new GenericCommMethodReceiveTextArgs(str)); - } - - + } } - client.ReceiveDataAsync(Receive); } } From c722542b044b1f19a58543f38b4b1bddd170d2b2 Mon Sep 17 00:00:00 2001 From: Alex Johnson Date: Fri, 2 Sep 2022 14:50:15 -0400 Subject: [PATCH 02/19] Adds lock to ssh and tcp classes to prevent possible threading issues. --- .../Pepperdash Core/Comm/GenericSshClient.cs | 262 +++++++++--------- .../Comm/GenericTcpIpClient.cs | 139 +++++----- .../Pepperdash Core/Logging/Debug.cs | 4 - 3 files changed, 204 insertions(+), 201 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index 5f4c5c8..54ff6c9 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -14,6 +14,10 @@ namespace PepperDash.Core public class GenericSshClient : Device, ISocketStatusWithStreamDebugging, IAutoReconnect { private const string SPlusKey = "Uninitialized SshClient"; + + /// + /// Enables debugging to console + /// public CommunicationStreamDebugging StreamDebugging { get; private set; } /// @@ -31,11 +35,6 @@ namespace PepperDash.Core /// public event EventHandler ConnectionChange; - /// - /// - /// - //public event GenericSocketStatusChangeEventDelegate SocketStatusChange; - /// /// Address of server /// @@ -62,12 +61,9 @@ namespace PepperDash.Core public bool IsConnected { // returns false if no client or not connected - get { return ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } + get { return Client != null && ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } } - private bool IsConnecting = false; - private bool DisconnectLogged = false; - /// /// S+ helper for IsConnected /// @@ -132,10 +128,10 @@ namespace PepperDash.Core CTimer ReconnectTimer; - //string PreviousHostname; - //int PreviousPort; - //string PreviousUsername; - //string PreviousPassword; + //Lock object to prevent simulatneous connect/disconnect operations + private readonly object connectLock = new object(); + + private bool DisconnectLogged = false; /// /// Typical constructor. @@ -154,7 +150,10 @@ namespace PepperDash.Core ReconnectTimer = new CTimer(o => { - Connect(); + if (ConnectEnabled) + { + Connect(); + } }, Timeout.Infinite); } @@ -170,7 +169,10 @@ namespace PepperDash.Core ReconnectTimer = new CTimer(o => { - Connect(); + if (ConnectEnabled) + { + Connect(); + } }, Timeout.Infinite); } @@ -202,110 +204,111 @@ namespace PepperDash.Core /// public void Connect() { - if (IsConnecting) - { - Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Connection attempt in progress. Exiting Connect()"); - return; - } - - IsConnecting = true; - ConnectEnabled = true; - Debug.Console(1, this, "attempting connect"); - - // Cancel reconnect if running. - ReconnectTimer.Stop(); - - // Don't try to connect if already - if (IsConnected) - return; - // Don't go unless everything is here if (string.IsNullOrEmpty(Hostname) || Port < 1 || Port > 65535 || Username == null || Password == null) { - Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Connect failed. Check hostname, port, username and password are set or not null"); + Debug.Console(0, this, Debug.ErrorLogLevel.Error, "Connect failed. Check hostname, port, username and password are set or not null"); return; } - // Cleanup the old client if it already exists - if (Client != null) + ConnectEnabled = true; + lock (connectLock) { - Debug.Console(1, this, "Cleaning up disconnected client"); - Client.ErrorOccurred -= Client_ErrorOccurred; - KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY); - } - - // This handles both password and keyboard-interactive (like on OS-X, 'nixes) - KeyboardInteractiveAuthenticationMethod kauth = new KeyboardInteractiveAuthenticationMethod(Username); - kauth.AuthenticationPrompt += new EventHandler(kauth_AuthenticationPrompt); - PasswordAuthenticationMethod pauth = new PasswordAuthenticationMethod(Username, Password); - - Debug.Console(1, this, "Creating new SshClient"); - ConnectionInfo connectionInfo = new ConnectionInfo(Hostname, Port, Username, pauth, kauth); - Client = new SshClient(connectionInfo); - - Client.ErrorOccurred -= Client_ErrorOccurred; - Client.ErrorOccurred += Client_ErrorOccurred; - - //Attempt to connect - ClientStatus = SocketStatus.SOCKET_STATUS_WAITING; - try - { - Client.Connect(); - TheStream = Client.CreateShellStream("PDTShell", 100, 80, 100, 200, 65534); - TheStream.DataReceived += Stream_DataReceived; - //TheStream.ErrorOccurred += TheStream_ErrorOccurred; - Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Connected"); - ClientStatus = SocketStatus.SOCKET_STATUS_CONNECTED; - IsConnecting = false; - DisconnectLogged = false; - return; // Success will not pass here - } - catch (SshConnectionException e) - { - var ie = e.InnerException; // The details are inside!! - var errorLogLevel = DisconnectLogged == true ? Debug.ErrorLogLevel.None : Debug.ErrorLogLevel.Error; - - if (ie is SocketException) - Debug.Console(1, this, errorLogLevel, "'{0}' CONNECTION failure: Cannot reach host, ({1})", Key, ie.Message); - else if (ie is System.Net.Sockets.SocketException) - Debug.Console(1, this, errorLogLevel, "'{0}' Connection failure: Cannot reach host '{1}' on port {2}, ({3})", - Key, Hostname, Port, ie.GetType()); - else if (ie is SshAuthenticationException) + if (IsConnected) { - Debug.Console(1, this, errorLogLevel, "Authentication failure for username '{0}', ({1})", - Username, ie.Message); + Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Connection already connected. Exiting Connect()"); } else - Debug.Console(1, this, errorLogLevel, "Error on connect:\r({0})", e); + { + Debug.Console(1, this, "Attempting connect"); - DisconnectLogged = true; - ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; - HandleConnectionFailure(); - } - catch (Exception e) - { - Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Unhandled exception on connect:\r({0})", e); - ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; - HandleConnectionFailure(); - } + // Cancel reconnect if running. + ReconnectTimer.Stop(); - ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; - HandleConnectionFailure(); + // Cleanup the old client if it already exists + if (Client != null) + { + Debug.Console(1, this, "Cleaning up disconnected client"); + KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY); + } + + // This handles both password and keyboard-interactive (like on OS-X, 'nixes) + KeyboardInteractiveAuthenticationMethod kauth = new KeyboardInteractiveAuthenticationMethod(Username); + kauth.AuthenticationPrompt += new EventHandler(kauth_AuthenticationPrompt); + PasswordAuthenticationMethod pauth = new PasswordAuthenticationMethod(Username, Password); + + Debug.Console(1, this, "Creating new SshClient"); + ConnectionInfo connectionInfo = new ConnectionInfo(Hostname, Port, Username, pauth, kauth); + Client = new SshClient(connectionInfo); + + Client.ErrorOccurred -= Client_ErrorOccurred; + Client.ErrorOccurred += Client_ErrorOccurred; + + //Attempt to connect + ClientStatus = SocketStatus.SOCKET_STATUS_WAITING; + try + { + Client.Connect(); + TheStream = Client.CreateShellStream("PDTShell", 100, 80, 100, 200, 65534); + TheStream.DataReceived += Stream_DataReceived; + Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Connected"); + ClientStatus = SocketStatus.SOCKET_STATUS_CONNECTED; + DisconnectLogged = false; + } + catch (SshConnectionException e) + { + var ie = e.InnerException; // The details are inside!! + var errorLogLevel = DisconnectLogged == true ? Debug.ErrorLogLevel.None : Debug.ErrorLogLevel.Error; + + if (ie is SocketException) + Debug.Console(1, this, errorLogLevel, "'{0}' CONNECTION failure: Cannot reach host, ({1})", Key, ie.Message); + else if (ie is System.Net.Sockets.SocketException) + Debug.Console(1, this, errorLogLevel, "'{0}' Connection failure: Cannot reach host '{1}' on port {2}, ({3})", + Key, Hostname, Port, ie.GetType()); + else if (ie is SshAuthenticationException) + { + Debug.Console(1, this, errorLogLevel, "Authentication failure for username '{0}', ({1})", + Username, ie.Message); + } + else + Debug.Console(1, this, errorLogLevel, "Error on connect:\r({0})", e); + + DisconnectLogged = true; + KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED); + if (AutoReconnect) + { + Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); + ReconnectTimer.Reset(AutoReconnectIntervalMs); + } + } + catch (Exception e) + { + var errorLogLevel = DisconnectLogged == true ? Debug.ErrorLogLevel.None : Debug.ErrorLogLevel.Error; + Debug.Console(1, this, errorLogLevel, "Unhandled exception on connect:\r({0})", e); + DisconnectLogged = true; + KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED); + if (AutoReconnect) + { + Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); + ReconnectTimer.Reset(AutoReconnectIntervalMs); + } + } + } + } } - - /// /// Disconnect the clients and put away it's resources. /// public void Disconnect() { - ConnectEnabled = false; - // Stop trying reconnects, if we are - ReconnectTimer.Stop(); - - KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY); + lock(connectLock) + { + // Stop trying reconnects, if we are + ReconnectTimer.Stop(); + KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY); + } } /// @@ -317,31 +320,21 @@ namespace PepperDash.Core if (Client != null) { - IsConnecting = false; - Client.Disconnect(); - Client = null; - ClientStatus = status; - Debug.Console(1, this, "Disconnected"); + try + { + Client.Disconnect(); + Client.Dispose(); + Client = null; + ClientStatus = status; + Debug.Console(1, this, "Disconnected client"); + } + catch (Exception ex) + { + Debug.Console(0, this, "Exception killing client: {0}", ex.Message); + } } } - /// - /// Anything to do with reestablishing connection on failures - /// - void HandleConnectionFailure() - { - KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED); - - Debug.Console(1, this, "Client nulled due to connection failure. AutoReconnect: {0}, ConnectEnabled: {1}", AutoReconnect, ConnectEnabled); - if (AutoReconnect && ConnectEnabled) - { - Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); - ReconnectTimer.Reset(AutoReconnectIntervalMs); - Debug.Console(1, this, "Attempting connection in {0} seconds", - (float) (AutoReconnectIntervalMs/1000)); - } - } - /// /// Kills the stream /// @@ -353,6 +346,7 @@ namespace PepperDash.Core TheStream.Close(); TheStream.Dispose(); TheStream = null; + Debug.Console(1, this, "Disconnected stream"); } } @@ -403,13 +397,23 @@ namespace PepperDash.Core /// void Client_ErrorOccurred(object sender, Crestron.SimplSharp.Ssh.Common.ExceptionEventArgs e) { - if (e.Exception is SshConnectionException || e.Exception is System.Net.Sockets.SocketException) - Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Disconnected by remote"); - else - Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Unhandled SSH client error: {0}", e.Exception); + CrestronInvoke.BeginInvoke(o => + { + if (e.Exception is SshConnectionException || e.Exception is System.Net.Sockets.SocketException) + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Disconnected by remote"); + else + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Unhandled SSH client error: {0}", e.Exception); - ClientStatus = SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY; - HandleConnectionFailure(); + lock (connectLock) + { + KillClient(SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY); + } + if (AutoReconnect && ConnectEnabled) + { + Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); + ReconnectTimer.Reset(AutoReconnectIntervalMs); + } + }); } /// @@ -451,8 +455,6 @@ namespace PepperDash.Core Debug.Console(0, "Stack Trace: {0}", ex.StackTrace); Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Stream write failed. Disconnected, closing"); - ClientStatus = SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY; - HandleConnectionFailure(); } } @@ -480,8 +482,6 @@ namespace PepperDash.Core catch { Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Stream write failed. Disconnected, closing"); - ClientStatus = SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY; - HandleConnectionFailure(); } } diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs index 5f09f36..0d5eb29 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs @@ -5,7 +5,6 @@ using System.Text; using System.Text.RegularExpressions; using Crestron.SimplSharp; using Crestron.SimplSharp.CrestronSockets; - using Newtonsoft.Json; using Newtonsoft.Json.Linq; @@ -17,6 +16,10 @@ namespace PepperDash.Core public class GenericTcpIpClient : Device, ISocketStatusWithStreamDebugging, IAutoReconnect { private const string SplusKey = "Uninitialized TcpIpClient"; + + /// + /// Enables debugging to console + /// public CommunicationStreamDebugging StreamDebugging { get; private set; } /// @@ -167,6 +170,9 @@ namespace PepperDash.Core get { return Client.ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } } + //Lock object to prevent simulatneous connect/disconnect operations + private readonly object connectLock = new object(); + CTimer RetryTimer; /// @@ -187,12 +193,7 @@ namespace PepperDash.Core RetryTimer = new CTimer(o => { - if (Client == null) - { - return; - } - - Client.ConnectToServerAsync(ConnectToServerCallback); + Reconnect(); }, Timeout.Infinite); CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); @@ -212,12 +213,7 @@ namespace PepperDash.Core RetryTimer = new CTimer(o => { - if (Client == null) - { - return; - } - - Client.ConnectToServerAsync(ConnectToServerCallback); + Reconnect(); }, Timeout.Infinite); } @@ -234,12 +230,7 @@ namespace PepperDash.Core RetryTimer = new CTimer(o => { - if (Client == null) - { - return; - } - - Client.ConnectToServerAsync(ConnectToServerCallback); + Reconnect(); }, Timeout.Infinite); } @@ -259,7 +250,7 @@ namespace PepperDash.Core if (programEventType == eProgramStatusEventType.Stopping) { Debug.Console(1, this, "Program stopping. Closing connection"); - Disconnect(); + Deactivate(); } } @@ -269,6 +260,8 @@ namespace PepperDash.Core /// public override bool Deactivate() { + RetryTimer.Stop(); + RetryTimer.Dispose(); if (Client != null) { Client.SocketStatusChange -= this.Client_SocketStatusChange; @@ -282,9 +275,6 @@ namespace PepperDash.Core /// public void Connect() { - if (IsConnected) - DisconnectClient(); - if (string.IsNullOrEmpty(Hostname)) { Debug.Console(1, Debug.ErrorLogLevel.Warning, "GenericTcpIpClient '{0}': No address set", Key); @@ -298,32 +288,58 @@ namespace PepperDash.Core } } + lock(connectLock) + { + if (IsConnected) + { + Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Connection already connected. Exiting Connect()"); + } + else + { + //Stop retry timer if running + RetryTimer.Stop(); + + Client = new TCPClient(Hostname, Port, BufferSize); + Client.SocketStatusChange -= Client_SocketStatusChange; + Client.SocketStatusChange += Client_SocketStatusChange; + DisconnectCalledByUser = false; + + Client.ConnectToServerAsync(ConnectToServerCallback); + } + } + } + + private void Reconnect() + { if (Client == null) { - Client = new TCPClient(Hostname, Port, BufferSize); - Client.SocketStatusChange -= Client_SocketStatusChange; - Client.SocketStatusChange += Client_SocketStatusChange; + return; } - DisconnectCalledByUser = false; - - Client.ConnectToServerAsync(ConnectToServerCallback); // (null); - } + lock (connectLock) + { + if (IsConnected || DisconnectCalledByUser == true) + { + Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Reconnect no longer needed. Exiting Reconnect()"); + } + else + { + Client.ConnectToServerAsync(ConnectToServerCallback); + } + } + } /// /// Attempts to disconnect the client /// public void Disconnect() { - DisconnectCalledByUser = true; - - // Stop trying reconnects, if we are - RetryTimer.Stop(); - - if (Client != null) + lock (connectLock) { + DisconnectCalledByUser = true; + + // Stop trying reconnects, if we are + RetryTimer.Stop(); DisconnectClient(); - Client = null; - Debug.Console(1, this, "Disconnected"); } } @@ -335,7 +351,7 @@ namespace PepperDash.Core if (Client != null) { Debug.Console(1, this, "Disconnecting client"); - if(IsConnected) + if (IsConnected) Client.DisconnectFromServer(); } } @@ -347,7 +363,7 @@ namespace PepperDash.Core void ConnectToServerCallback(TCPClient c) { Debug.Console(1, this, "Server connection result: {0}", c.ClientStatus); - if (c.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED && AutoReconnect) + if (c.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED) WaitAndTryReconnect(); } @@ -356,16 +372,18 @@ namespace PepperDash.Core /// void WaitAndTryReconnect() { - DisconnectClient(); - - if (Client != null) + CrestronInvoke.BeginInvoke(o => { - Debug.Console(1, this, "Attempting reconnect, status={0}", Client.ClientStatus); - - if (!DisconnectCalledByUser) - RetryTimer.Reset(AutoReconnectIntervalMs); - } - + lock (connectLock) + { + if (!IsConnected && AutoReconnect && !DisconnectCalledByUser && Client != null) + { + DisconnectClient(); + Debug.Console(1, this, "Attempting reconnect, status={0}", Client.ClientStatus); + RetryTimer.Reset(AutoReconnectIntervalMs); + } + } + }); } /// @@ -398,7 +416,6 @@ namespace PepperDash.Core Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length); textHandler(this, new GenericCommMethodReceiveTextArgs(str)); - } } client.ReceiveDataAsync(Receive); @@ -416,8 +433,6 @@ namespace PepperDash.Core Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text)); if(Client != null) Client.SendData(bytes, bytes.Length); - - } /// @@ -453,26 +468,18 @@ namespace PepperDash.Core void Client_SocketStatusChange(TCPClient client, SocketStatus clientSocketStatus) { Debug.Console(1, this, "Socket status change {0} ({1})", clientSocketStatus, ClientStatusText); - if (client.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED && !DisconnectCalledByUser && AutoReconnect) + if (client.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED) WaitAndTryReconnect(); - // Probably doesn't need to be a switch since all other cases were eliminated - switch (clientSocketStatus) - { - case SocketStatus.SOCKET_STATUS_CONNECTED: - Client.ReceiveDataAsync(Receive); - DisconnectCalledByUser = false; - break; - } + if(clientSocketStatus == SocketStatus.SOCKET_STATUS_CONNECTED) + { + Client.ReceiveDataAsync(Receive); + DisconnectCalledByUser = false; + } var handler = ConnectionChange; if (handler != null) ConnectionChange(this, new GenericSocketStatusChageEventArgs(this)); - - // Relay the event - //var handler = SocketStatusChange; - //if (handler != null) - // SocketStatusChange(this); } } diff --git a/Pepperdash Core/Pepperdash Core/Logging/Debug.cs b/Pepperdash Core/Pepperdash Core/Logging/Debug.cs index 211bc2d..d15f711 100644 --- a/Pepperdash Core/Pepperdash Core/Logging/Debug.cs +++ b/Pepperdash Core/Pepperdash Core/Logging/Debug.cs @@ -537,10 +537,6 @@ namespace PepperDash.Core //check for file at old path if (!File.Exists(oldFilePath)) { - Console(0, ErrorLogLevel.Notice, - String.Format( - @"Debug settings file not found at \nvram\debugSettings\program{0}. Attempting to use file at \user\debugSettings\program{0}", - InitialParametersClass.ApplicationNumber)); return; } From 413955614913eea0de78131afefcac5deba06b13 Mon Sep 17 00:00:00 2001 From: Alex Johnson Date: Fri, 2 Sep 2022 15:00:57 -0400 Subject: [PATCH 03/19] Changes some debug levels to notify upon errors in console --- .../Pepperdash Core/Comm/GenericSshClient.cs | 8 ++--- .../Comm/GenericTcpIpClient.cs | 29 ++++++++++++------- 2 files changed, 22 insertions(+), 15 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index 54ff6c9..f3d0d37 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -217,7 +217,7 @@ namespace PepperDash.Core { if (IsConnected) { - Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Connection already connected. Exiting Connect()"); + Debug.Console(1, this, "Connection already connected. Exiting Connect()"); } else { @@ -272,7 +272,7 @@ namespace PepperDash.Core Username, ie.Message); } else - Debug.Console(1, this, errorLogLevel, "Error on connect:\r({0})", e); + Debug.Console(1, this, errorLogLevel, "Error on connect:\r({0})", ie.Message); DisconnectLogged = true; KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED); @@ -285,7 +285,7 @@ namespace PepperDash.Core catch (Exception e) { var errorLogLevel = DisconnectLogged == true ? Debug.ErrorLogLevel.None : Debug.ErrorLogLevel.Error; - Debug.Console(1, this, errorLogLevel, "Unhandled exception on connect:\r({0})", e); + Debug.Console(1, this, errorLogLevel, "Unhandled exception on connect:\r({0})", e.Message); DisconnectLogged = true; KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED); if (AutoReconnect) @@ -330,7 +330,7 @@ namespace PepperDash.Core } catch (Exception ex) { - Debug.Console(0, this, "Exception killing client: {0}", ex.Message); + Debug.Console(1, this, "Exception killing client: {0}", ex.Message); } } } diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs index 0d5eb29..a9198da 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs @@ -292,7 +292,7 @@ namespace PepperDash.Core { if (IsConnected) { - Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Connection already connected. Exiting Connect()"); + Debug.Console(1, this, "Connection already connected. Exiting Connect()"); } else { @@ -319,10 +319,11 @@ namespace PepperDash.Core { if (IsConnected || DisconnectCalledByUser == true) { - Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Reconnect no longer needed. Exiting Reconnect()"); + Debug.Console(1, this, "Reconnect no longer needed. Exiting Reconnect()"); } else { + Debug.Console(1, this, "Attempting reconnect now"); Client.ConnectToServerAsync(ConnectToServerCallback); } } @@ -362,9 +363,15 @@ namespace PepperDash.Core /// void ConnectToServerCallback(TCPClient c) { - Debug.Console(1, this, "Server connection result: {0}", c.ClientStatus); - if (c.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED) - WaitAndTryReconnect(); + if (c.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED) + { + Debug.Console(0, this, "Server connection result: {0}", c.ClientStatus); + WaitAndTryReconnect(); + } + else + { + Debug.Console(1, this, "Server connection result: {0}", c.ClientStatus); + } } /// @@ -467,14 +474,14 @@ namespace PepperDash.Core /// void Client_SocketStatusChange(TCPClient client, SocketStatus clientSocketStatus) { - Debug.Console(1, this, "Socket status change {0} ({1})", clientSocketStatus, ClientStatusText); - if (client.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED) - WaitAndTryReconnect(); - - if(clientSocketStatus == SocketStatus.SOCKET_STATUS_CONNECTED) + if (clientSocketStatus != SocketStatus.SOCKET_STATUS_CONNECTED) { + Debug.Console(0, this, "Socket status change {0} ({1})", clientSocketStatus, ClientStatusText); + WaitAndTryReconnect(); + } + { + Debug.Console(1, this, "Socket status change {0} ({1})", clientSocketStatus, ClientStatusText); Client.ReceiveDataAsync(Receive); - DisconnectCalledByUser = false; } var handler = ConnectionChange; From 9326703454ac69c870262aa8b4ca3e68796d30fb Mon Sep 17 00:00:00 2001 From: Alex Johnson Date: Wed, 7 Sep 2022 11:46:06 -0400 Subject: [PATCH 04/19] Changes lock to CCriticalSection --- .../Pepperdash Core/Comm/GenericSshClient.cs | 25 +++- .../Comm/GenericTcpIpClient.cs | 121 ++++++++++-------- 2 files changed, 90 insertions(+), 56 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index f3d0d37..0211205 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -129,7 +129,7 @@ namespace PepperDash.Core CTimer ReconnectTimer; //Lock object to prevent simulatneous connect/disconnect operations - private readonly object connectLock = new object(); + private CCriticalSection connectLock = new CCriticalSection(); private bool DisconnectLogged = false; @@ -163,7 +163,6 @@ namespace PepperDash.Core public GenericSshClient() : base(SPlusKey) { - StreamDebugging = new CommunicationStreamDebugging(SPlusKey); CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); AutoReconnectIntervalMs = 5000; @@ -213,8 +212,10 @@ namespace PepperDash.Core } ConnectEnabled = true; - lock (connectLock) + + try { + connectLock.Enter(); if (IsConnected) { Debug.Console(1, this, "Connection already connected. Exiting Connect()"); @@ -296,6 +297,10 @@ namespace PepperDash.Core } } } + finally + { + connectLock.Leave(); + } } /// @@ -303,11 +308,16 @@ namespace PepperDash.Core /// public void Disconnect() { - lock(connectLock) + try { + connectLock.Enter(); // Stop trying reconnects, if we are ReconnectTimer.Stop(); KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY); + } + finally + { + connectLock.Leave(); } } @@ -404,10 +414,15 @@ namespace PepperDash.Core else Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Unhandled SSH client error: {0}", e.Exception); - lock (connectLock) + try { + connectLock.Enter(); KillClient(SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY); } + finally + { + connectLock.Leave(); + } if (AutoReconnect && ConnectEnabled) { Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs index a9198da..6e57bed 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs @@ -6,7 +6,6 @@ using System.Text.RegularExpressions; using Crestron.SimplSharp; using Crestron.SimplSharp.CrestronSockets; using Newtonsoft.Json; -using Newtonsoft.Json.Linq; namespace PepperDash.Core { @@ -18,7 +17,7 @@ namespace PepperDash.Core private const string SplusKey = "Uninitialized TcpIpClient"; /// - /// Enables debugging to console + /// Stream debugging /// public CommunicationStreamDebugging StreamDebugging { get; private set; } @@ -39,23 +38,24 @@ namespace PepperDash.Core public event EventHandler ConnectionChange; - private string _Hostname { get; set;} + private string _hostname; + /// /// Address of server /// - public string Hostname { + public string Hostname + { get { - return _Hostname; + return _hostname; } set { - _Hostname = value; - if (Client != null) + _hostname = value; + if (_client != null) { - - Client.AddressClientConnectedTo = _Hostname; + _client.AddressClientConnectedTo = _hostname; } } } @@ -83,14 +83,14 @@ namespace PepperDash.Core /// /// The actual client class /// - public TCPClient Client { get; private set; } + private TCPClient _client; /// - /// True if connected to the server + /// Bool showing if socket is connected /// public bool IsConnected { - get { return Client != null && Client.ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } + get { return _client != null && _client.ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } } /// @@ -102,21 +102,19 @@ namespace PepperDash.Core } /// - /// Status of the socket + /// _client socket status Read only /// public SocketStatus ClientStatus { get { - if (Client == null) - return SocketStatus.SOCKET_STATUS_NO_CONNECT; - return Client.ClientStatus; + return _client == null ? SocketStatus.SOCKET_STATUS_NO_CONNECT : _client.ClientStatus; } } /// /// Contains the familiar Simpl analog status values. This drives the ConnectionChange event - /// and IsConnected with be true when this == 2. + /// and IsConnected would be true when this == 2. /// public ushort UStatus { @@ -124,7 +122,7 @@ namespace PepperDash.Core } /// - /// Status of the socket + /// Status text shows the message associated with socket status /// public string ClientStatusText { get { return ClientStatus.ToString(); } } @@ -140,7 +138,7 @@ namespace PepperDash.Core public string ConnectionFailure { get { return ClientStatus.ToString(); } } /// - /// If true, enables AutoConnect + /// bool to track if auto reconnect should be set on the socket /// public bool AutoReconnect { get; set; } @@ -152,13 +150,14 @@ namespace PepperDash.Core get { return (ushort)(AutoReconnect ? 1 : 0); } set { AutoReconnect = value == 1; } } + /// /// Milliseconds to wait before attempting to reconnect. Defaults to 5000 /// public int AutoReconnectIntervalMs { get; set; } /// - /// Set only when the disconnect method is called. + /// Set only when the disconnect method is called /// bool DisconnectCalledByUser; @@ -167,13 +166,14 @@ namespace PepperDash.Core /// public bool Connected { - get { return Client.ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } + get { return _client.ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } } //Lock object to prevent simulatneous connect/disconnect operations - private readonly object connectLock = new object(); + private CCriticalSection connectLock = new CCriticalSection(); - CTimer RetryTimer; + // private Timer for auto reconnect + private CTimer RetryTimer; /// /// Constructor @@ -186,18 +186,17 @@ namespace PepperDash.Core : base(key) { StreamDebugging = new CommunicationStreamDebugging(key); + CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); + AutoReconnectIntervalMs = 5000; Hostname = address; Port = port; BufferSize = bufferSize; - AutoReconnectIntervalMs = 5000; RetryTimer = new CTimer(o => { Reconnect(); }, Timeout.Infinite); - - CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); - } + } /// /// Constructor @@ -223,7 +222,6 @@ namespace PepperDash.Core public GenericTcpIpClient() : base(SplusKey) { - StreamDebugging = new CommunicationStreamDebugging(SplusKey); CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler); AutoReconnectIntervalMs = 5000; BufferSize = 2000; @@ -262,9 +260,9 @@ namespace PepperDash.Core { RetryTimer.Stop(); RetryTimer.Dispose(); - if (Client != null) + if (_client != null) { - Client.SocketStatusChange -= this.Client_SocketStatusChange; + _client.SocketStatusChange -= this.Client_SocketStatusChange; DisconnectClient(); } return true; @@ -288,8 +286,9 @@ namespace PepperDash.Core } } - lock(connectLock) + try { + connectLock.Enter(); if (IsConnected) { Debug.Console(1, this, "Connection already connected. Exiting Connect()"); @@ -298,25 +297,28 @@ namespace PepperDash.Core { //Stop retry timer if running RetryTimer.Stop(); - - Client = new TCPClient(Hostname, Port, BufferSize); - Client.SocketStatusChange -= Client_SocketStatusChange; - Client.SocketStatusChange += Client_SocketStatusChange; + _client = new TCPClient(Hostname, Port, BufferSize); + _client.SocketStatusChange -= Client_SocketStatusChange; + _client.SocketStatusChange += Client_SocketStatusChange; DisconnectCalledByUser = false; - - Client.ConnectToServerAsync(ConnectToServerCallback); + _client.ConnectToServerAsync(ConnectToServerCallback); } + } + finally + { + connectLock.Leave(); } } private void Reconnect() { - if (Client == null) + if (_client == null) { return; } - lock (connectLock) + try { + connectLock.Enter(); if (IsConnected || DisconnectCalledByUser == true) { Debug.Console(1, this, "Reconnect no longer needed. Exiting Reconnect()"); @@ -324,9 +326,13 @@ namespace PepperDash.Core else { Debug.Console(1, this, "Attempting reconnect now"); - Client.ConnectToServerAsync(ConnectToServerCallback); + _client.ConnectToServerAsync(ConnectToServerCallback); } } + finally + { + connectLock.Leave(); + } } /// @@ -334,13 +340,18 @@ namespace PepperDash.Core /// public void Disconnect() { - lock (connectLock) + try { + connectLock.Enter(); DisconnectCalledByUser = true; // Stop trying reconnects, if we are RetryTimer.Stop(); DisconnectClient(); + } + finally + { + connectLock.Leave(); } } @@ -349,11 +360,11 @@ namespace PepperDash.Core /// public void DisconnectClient() { - if (Client != null) + if (_client != null) { Debug.Console(1, this, "Disconnecting client"); if (IsConnected) - Client.DisconnectFromServer(); + _client.DisconnectFromServer(); } } @@ -381,15 +392,20 @@ namespace PepperDash.Core { CrestronInvoke.BeginInvoke(o => { - lock (connectLock) + try { - if (!IsConnected && AutoReconnect && !DisconnectCalledByUser && Client != null) + connectLock.Enter(); + if (!IsConnected && AutoReconnect && !DisconnectCalledByUser && _client != null) { DisconnectClient(); - Debug.Console(1, this, "Attempting reconnect, status={0}", Client.ClientStatus); + Debug.Console(1, this, "Attempting reconnect, status={0}", _client.ClientStatus); RetryTimer.Reset(AutoReconnectIntervalMs); } } + finally + { + connectLock.Leave(); + } }); } @@ -420,7 +436,9 @@ namespace PepperDash.Core var str = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length); if (StreamDebugging.RxStreamDebuggingIsEnabled) + { Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length); + } textHandler(this, new GenericCommMethodReceiveTextArgs(str)); } @@ -438,8 +456,8 @@ namespace PepperDash.Core // Check debug level before processing byte array if (StreamDebugging.TxStreamDebuggingIsEnabled) Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text)); - if(Client != null) - Client.SendData(bytes, bytes.Length); + if (_client != null) + _client.SendData(bytes, bytes.Length); } /// @@ -463,8 +481,8 @@ namespace PepperDash.Core { if (StreamDebugging.TxStreamDebuggingIsEnabled) Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes)); - if(Client != null) - Client.SendData(bytes, bytes.Length); + if (_client != null) + _client.SendData(bytes, bytes.Length); } /// @@ -479,9 +497,10 @@ namespace PepperDash.Core Debug.Console(0, this, "Socket status change {0} ({1})", clientSocketStatus, ClientStatusText); WaitAndTryReconnect(); } + else { Debug.Console(1, this, "Socket status change {0} ({1})", clientSocketStatus, ClientStatusText); - Client.ReceiveDataAsync(Receive); + _client.ReceiveDataAsync(Receive); } var handler = ConnectionChange; From 1cbdc5aaef114abe000b4eb4dc8396f423713e28 Mon Sep 17 00:00:00 2001 From: jdevito Date: Tue, 17 Jan 2023 09:50:39 -0600 Subject: [PATCH 05/19] feat: added crestron web server (cws) generic base --- .../CrestronWebServer/GenericCwsBase.cs | 266 ++++++++++++++++++ .../RequestHandlerUnknown.cs | 16 ++ .../Pepperdash Core/PepperDash_Core.csproj | 6 + 3 files changed, 288 insertions(+) create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs new file mode 100644 index 0000000..9446e6a --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs @@ -0,0 +1,266 @@ +using System; +using Crestron.SimplSharp; +using Crestron.SimplSharp.WebScripting; + +namespace PepperDash.Core +{ + public class GenericCwsBase : Device + { + private const string SplusKey = "Uninitialized CWS Server"; + private const string DefaultBasePath = "/api"; + + private const uint DebugTrace = 0; + private const uint DebugInfo = 1; + private const uint DebugVerbose = 2; + + private HttpCwsServer _server; + private readonly CCriticalSection _serverLock = new CCriticalSection(); + + /// + /// CWS base path, will default to "/api" if not set via initialize method + /// + public string BasePath { get; private set; } + + /// + /// Indicates CWS is registered with base path + /// + public bool IsRegistered { get; private set; } + + /// + /// Constructor for S+. Make sure to set necessary properties using init method + /// + public GenericCwsBase() + : base(SplusKey) + { + CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; + CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; + } + + /// + /// Constructor + /// + /// + /// + public GenericCwsBase(string key, string basePath) + : base(key) + { + + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// + /// + /// + /// + /// + public GenericCwsBase(string key, string name, string basePath) + : base(key, name) + { + + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// Program status event handler + /// + /// + void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType) + { + if (programEventType != eProgramStatusEventType.Stopping) + return; + + Debug.Console(DebugInfo, this, "Program stopping. Disabling Server"); + + Stop(); + } + + /// + /// Ethernet event handler + /// + /// + void CrestronEnvironment_EthernetEventHandler(EthernetEventArgs ethernetEventArgs) + { + // Re-enable the server if the link comes back up and the status should be connected + if (ethernetEventArgs.EthernetEventType == eEthernetEventType.LinkUp + && IsRegistered) + { + Debug.Console(DebugInfo, this, "Ethernet link up. Starting server"); + + Start(); + } + } + + /// + /// Initializes CWS class + /// + public void Initialize(string key, string basePath) + { + Key = key; + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// Starts CWS instance + /// + public void Start() + { + try + { + _serverLock.Enter(); + + if (_server != null) + { + Debug.Console(DebugInfo, this, "Server has already been started"); + return; + } + + Debug.Console(DebugInfo, this, "Starting server"); + + _server = new HttpCwsServer(BasePath) + { + HttpRequestHandler = new RequestHandlerUnknown() + }; + + IsRegistered = _server.Register(); + } + catch (Exception ex) + { + Debug.Console(DebugInfo, this, "Start Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "Start Exception StackTrace: {0}", ex.StackTrace); + if (ex.InnerException != null) + Debug.Console(DebugVerbose, this, "Start Exception InnerException: {0}", ex.InnerException); + } + finally + { + _serverLock.Leave(); + } + } + + /// + /// Stop CWS instance + /// + public void Stop() + { + try + { + _serverLock.Enter(); + + if (_server == null) + { + Debug.Console(DebugInfo, this, "Servier has already been stopped"); + return; + } + + if (_server.Unregister()) + { + IsRegistered = false; + } + + Dispose(true); + } + catch (Exception ex) + { + Debug.Console(DebugInfo, this, "ServerStop Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "ServerStop Exception StackTrace: {0}", ex.StackTrace); + if (ex.InnerException != null) + Debug.Console(DebugVerbose, this, "ServerStop Exception InnerException: {0}", ex.InnerException); + } + finally + { + _serverLock.Leave(); + } + } + + /// + /// Received request handler + /// + /// + /// This is here for development and testing + /// + /// + /// + public void ReceivedRequestEventHandler(object sender, HttpCwsRequestEventArgs args) + { + try + { + // TODO [ ] Add logic for received requests + Debug.Console(DebugInfo, this, @"RecieveRequestEventHandler +Method: {0} +Path: {1} +PathInfo: {2} +PhysicalPath: {3} +ContentType: {4} +RawUrl: {5} +Url: {6} +UserAgent: {7} +UserHostAddress: {8} +UserHostName: {9}", + args.Context.Request.HttpMethod, + args.Context.Request.Path, + args.Context.Request.PathInfo, + args.Context.Request.PhysicalPath, + args.Context.Request.ContentType, + args.Context.Request.RawUrl, + args.Context.Request.Url, + args.Context.Request.UserAgent, + args.Context.Request.UserHostAddress, + args.Context.Request.UserHostName); + + } + catch (Exception ex) + { + Debug.Console(DebugInfo, this, "ReceivedRequestEventHandler Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "ReceivedRequestEventHandler Exception StackTrace: {0}", ex.StackTrace); + if (ex.InnerException != null) + Debug.Console(DebugVerbose, this, "ReceivedRequestEventHandler Exception InnerException: {0}", ex.InnerException); + } + } + + /// + /// Tracks if CWS is disposed + /// + public bool Disposed + { + get + { + return (_server == null); + } + } + + /// + /// Disposes CWS instance + /// + public void Dispose() + { + Dispose(true); + CrestronEnvironment.GC.SuppressFinalize(this); + } + + /// + /// Disposes CWS instance + /// + /// + protected void Dispose(bool disposing) + { + if (Disposed) + { + Debug.Console(DebugInfo, this, "Server has already been disposed"); + return; + } + + if (!disposing) return; + + if (_server != null) + { + _server.Dispose(); + _server = null; + } + } + + ~GenericCwsBase() + { + Dispose(true); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs new file mode 100644 index 0000000..5a2adac --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs @@ -0,0 +1,16 @@ +using Crestron.SimplSharp.WebScripting; + +namespace PepperDash.Core +{ + public class RequestHandlerUnknown : IHttpCwsHandler + { + public void ProcessRequest(HttpCwsContext context) + { + // TODO [ ] Modify unknown request handler + context.Response.StatusCode = 418; + context.Response.StatusDescription = "I'm a teapot"; + context.Response.ContentType = "application/json"; + context.Response.Write(string.Format("{0} {1}", context.Request.HttpMethod, context.Request.RawUrl), true); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index 86ae71d..8e49d82 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -51,6 +51,10 @@ False ..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll + + False + ..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCWSHelperInterface.dll + False ..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll @@ -89,6 +93,8 @@ + + From e98aae2d89ffe2a4c833dd2407c1ca864f36a833 Mon Sep 17 00:00:00 2001 From: jdevito Date: Wed, 18 Jan 2023 13:30:27 -0600 Subject: [PATCH 06/19] fix: Added CwsBaseHandler, refactored CwsDefaultRequestHandler --- .../CrestronWebServer/CwsBaseHandler.cs | 149 ++++++++++++++++++ .../CwsDefaultRequestHandler.cs | 106 +++++++++++++ .../CrestronWebServer/GenericCwsBase.cs | 120 ++++++-------- .../RequestHandlerUnknown.cs | 16 -- .../Pepperdash Core/PepperDash_Core.csproj | 5 +- .../PepperDash_Core.csproj.DotSettings | 2 + 6 files changed, 309 insertions(+), 89 deletions(-) create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs delete mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs create mode 100644 Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs new file mode 100644 index 0000000..f9e25bf --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs @@ -0,0 +1,149 @@ +using System; +using System.Collections.Generic; +using Crestron.SimplSharp.WebScripting; +using Newtonsoft.Json; + +namespace PepperDash.Core +{ + /// + /// CWS Base Handler, implements IHttpCwsHandler + /// + public abstract class CwsBaseHandler : IHttpCwsHandler + { + private readonly Dictionary> _handlers; + + /// + /// Constructor + /// + protected CwsBaseHandler() + { + _handlers = new Dictionary> + { + {"CONNECT", HandleConnect}, + {"DELETE", HandleDelete}, + {"GET", HandleGet}, + {"HEAD", HandleHead}, + {"OPTIONS", HandleOptions}, + {"PATCH", HandlePatch}, + {"POST", HandlePost}, + {"PUT", HandlePut}, + {"TRACE", HandleTrace} + }; + } + + /// + /// Handles CONNECT method requests + /// + /// + protected virtual void HandleConnect(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles DELETE method requests + /// + /// + protected virtual void HandleDelete(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles GET method requests + /// + /// + protected virtual void HandleGet(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles HEAD method requests + /// + /// + protected virtual void HandleHead(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles OPTIONS method requests + /// + /// + protected virtual void HandleOptions(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PATCH method requests + /// + /// + protected virtual void HandlePatch(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles POST method requests + /// + /// + protected virtual void HandlePost(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PUT method requests + /// + /// + protected virtual void HandlePut(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles TRACE method requests + /// + /// + protected virtual void HandleTrace(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Process request + /// + /// + public void ProcessRequest(HttpCwsContext context) + { + Action handler; + + if (!_handlers.TryGetValue(context.Request.HttpMethod, out handler)) + { + return; + } + + handler(context); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs new file mode 100644 index 0000000..3a91114 --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs @@ -0,0 +1,106 @@ +using Crestron.SimplSharp.WebScripting; + +namespace PepperDash.Core +{ + public class CwsDefaultRequestHandler : CwsBaseHandler + { + /// + /// Handles CONNECT method requests + /// + /// + protected override void HandleConnect(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles DELETE method requests + /// + /// + protected override void HandleDelete(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles GET method requests + /// + /// + protected override void HandleGet(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles HEAD method requests + /// + /// + protected override void HandleHead(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles OPTIONS method requests + /// + /// + protected override void HandleOptions(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PATCH method requests + /// + /// + protected override void HandlePatch(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles POST method requests + /// + /// + protected override void HandlePost(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PUT method requests + /// + /// + protected override void HandlePut(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles TRACE method requests + /// + /// + protected override void HandleTrace(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs index 9446e6a..0bfbb63 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs @@ -44,7 +44,6 @@ namespace PepperDash.Core public GenericCwsBase(string key, string basePath) : base(key) { - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; } @@ -57,7 +56,6 @@ namespace PepperDash.Core public GenericCwsBase(string key, string name, string basePath) : base(key, name) { - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; } @@ -67,8 +65,7 @@ namespace PepperDash.Core /// void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType) { - if (programEventType != eProgramStatusEventType.Stopping) - return; + if (programEventType != eProgramStatusEventType.Stopping) return; Debug.Console(DebugInfo, this, "Program stopping. Disabling Server"); @@ -82,13 +79,15 @@ namespace PepperDash.Core void CrestronEnvironment_EthernetEventHandler(EthernetEventArgs ethernetEventArgs) { // Re-enable the server if the link comes back up and the status should be connected - if (ethernetEventArgs.EthernetEventType == eEthernetEventType.LinkUp - && IsRegistered) + if (ethernetEventArgs.EthernetEventType == eEthernetEventType.LinkUp && IsRegistered) { - Debug.Console(DebugInfo, this, "Ethernet link up. Starting server"); - - Start(); + Debug.Console(DebugInfo, this, "Ethernet link up. Server is alreedy registered."); + return; } + + Debug.Console(DebugInfo, this, "Ethernet link up. Starting server"); + + Start(); } /// @@ -97,7 +96,37 @@ namespace PepperDash.Core public void Initialize(string key, string basePath) { Key = key; - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// Adds a route to CWS + /// + public void AddRoute(HttpCwsRoute route) + { + if (route == null) + { + Debug.Console(DebugInfo, this, "Failed to add route, route parameter is null"); + return; + } + + _server.Routes.Add(route); + + } + + /// + /// Removes a route from CWS + /// + /// + public void RemoveRoute(HttpCwsRoute route) + { + if (route == null) + { + Debug.Console(DebugInfo, this, "Failed to remote route, orute parameter is null"); + return; + } + + _server.Routes.Remove(route); } /// @@ -119,7 +148,7 @@ namespace PepperDash.Core _server = new HttpCwsServer(BasePath) { - HttpRequestHandler = new RequestHandlerUnknown() + HttpRequestHandler = new CwsDefaultRequestHandler() }; IsRegistered = _server.Register(); @@ -148,29 +177,26 @@ namespace PepperDash.Core if (_server == null) { - Debug.Console(DebugInfo, this, "Servier has already been stopped"); + Debug.Console(DebugInfo, this, "Server has already been stopped"); return; } - if (_server.Unregister()) - { - IsRegistered = false; - } - - Dispose(true); + IsRegistered = _server.Unregister() == false; + _server.Dispose(); + _server = null; } catch (Exception ex) { - Debug.Console(DebugInfo, this, "ServerStop Exception Message: {0}", ex.Message); - Debug.Console(DebugVerbose, this, "ServerStop Exception StackTrace: {0}", ex.StackTrace); + Debug.Console(DebugInfo, this, "Server Stop Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "Server Stop Exception StackTrace: {0}", ex.StackTrace); if (ex.InnerException != null) - Debug.Console(DebugVerbose, this, "ServerStop Exception InnerException: {0}", ex.InnerException); + Debug.Console(DebugVerbose, this, "Server Stop Exception InnerException: {0}", ex.InnerException); } finally { _serverLock.Leave(); } - } + } /// /// Received request handler @@ -184,7 +210,6 @@ namespace PepperDash.Core { try { - // TODO [ ] Add logic for received requests Debug.Console(DebugInfo, this, @"RecieveRequestEventHandler Method: {0} Path: {1} @@ -206,7 +231,6 @@ UserHostName: {9}", args.Context.Request.UserAgent, args.Context.Request.UserHostAddress, args.Context.Request.UserHostName); - } catch (Exception ex) { @@ -215,52 +239,6 @@ UserHostName: {9}", if (ex.InnerException != null) Debug.Console(DebugVerbose, this, "ReceivedRequestEventHandler Exception InnerException: {0}", ex.InnerException); } - } - - /// - /// Tracks if CWS is disposed - /// - public bool Disposed - { - get - { - return (_server == null); - } - } - - /// - /// Disposes CWS instance - /// - public void Dispose() - { - Dispose(true); - CrestronEnvironment.GC.SuppressFinalize(this); - } - - /// - /// Disposes CWS instance - /// - /// - protected void Dispose(bool disposing) - { - if (Disposed) - { - Debug.Console(DebugInfo, this, "Server has already been disposed"); - return; - } - - if (!disposing) return; - - if (_server != null) - { - _server.Dispose(); - _server = null; - } - } - - ~GenericCwsBase() - { - Dispose(true); - } + } } } \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs deleted file mode 100644 index 5a2adac..0000000 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs +++ /dev/null @@ -1,16 +0,0 @@ -using Crestron.SimplSharp.WebScripting; - -namespace PepperDash.Core -{ - public class RequestHandlerUnknown : IHttpCwsHandler - { - public void ProcessRequest(HttpCwsContext context) - { - // TODO [ ] Modify unknown request handler - context.Response.StatusCode = 418; - context.Response.StatusDescription = "I'm a teapot"; - context.Response.ContentType = "application/json"; - context.Response.Write(string.Format("{0} {1}", context.Request.HttpMethod, context.Request.RawUrl), true); - } - } -} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index 8e49d82..55c4a20 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -7,7 +7,7 @@ {87E29B4C-569B-4368-A4ED-984AC1440C96} Library Properties - PepperDash_Core + PepperDash.Core PepperDash_Core {0B4745B0-194B-4BB6-8E21-E9057CA92500};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} WindowsCE @@ -93,8 +93,9 @@ + - + diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings new file mode 100644 index 0000000..8107a4f --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings @@ -0,0 +1,2 @@ + + True \ No newline at end of file From 78631be83021898148d8a7dd19584122f630878c Mon Sep 17 00:00:00 2001 From: jdevito Date: Wed, 18 Jan 2023 15:22:50 -0600 Subject: [PATCH 07/19] refactor: Changed CWS references to WebApi, re-organized Web folder --- .../Pepperdash Core/PepperDash_Core.csproj | 6 ++-- .../PepperDash_Core.csproj.DotSettings | 3 +- .../DefaultRequestRequestHandler.cs} | 4 +-- .../WebApiBaseRequestHandler.cs} | 7 ++-- .../GenericCwsBase.cs => Web/WebApiServer.cs} | 34 +++++++++++-------- 5 files changed, 30 insertions(+), 24 deletions(-) rename Pepperdash Core/Pepperdash Core/{CrestronWebServer/CwsDefaultRequestHandler.cs => Web/RequestHandlers/DefaultRequestRequestHandler.cs} (92%) rename Pepperdash Core/Pepperdash Core/{CrestronWebServer/CwsBaseHandler.cs => Web/RequestHandlers/WebApiBaseRequestHandler.cs} (92%) rename Pepperdash Core/Pepperdash Core/{CrestronWebServer/GenericCwsBase.cs => Web/WebApiServer.cs} (86%) diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index 55c4a20..b4785a2 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -93,9 +93,9 @@ - - - + + + diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings index 8107a4f..8e644b9 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings @@ -1,2 +1,3 @@  - True \ No newline at end of file + True + False \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs similarity index 92% rename from Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs rename to Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs index 3a91114..38dd6b3 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs @@ -1,8 +1,8 @@ using Crestron.SimplSharp.WebScripting; -namespace PepperDash.Core +namespace PepperDash.Core.Web.RequestHandlers { - public class CwsDefaultRequestHandler : CwsBaseHandler + public class DefaultRequestRequestHandler : WebApiBaseRequestHandler { /// /// Handles CONNECT method requests diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs similarity index 92% rename from Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs rename to Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs index f9e25bf..6d4b41c 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs @@ -1,21 +1,20 @@ using System; using System.Collections.Generic; using Crestron.SimplSharp.WebScripting; -using Newtonsoft.Json; -namespace PepperDash.Core +namespace PepperDash.Core.Web.RequestHandlers { /// /// CWS Base Handler, implements IHttpCwsHandler /// - public abstract class CwsBaseHandler : IHttpCwsHandler + public abstract class WebApiBaseRequestHandler : IHttpCwsHandler { private readonly Dictionary> _handlers; /// /// Constructor /// - protected CwsBaseHandler() + protected WebApiBaseRequestHandler() { _handlers = new Dictionary> { diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs similarity index 86% rename from Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs rename to Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs index 0bfbb63..6843e25 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs +++ b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs @@ -1,12 +1,14 @@ using System; using Crestron.SimplSharp; using Crestron.SimplSharp.WebScripting; +using PepperDash.Core.Web.RequestHandlers; -namespace PepperDash.Core +namespace PepperDash.Core.Web { - public class GenericCwsBase : Device + public class WebApiServer : IKeyName { - private const string SplusKey = "Uninitialized CWS Server"; + private const string SplusKey = "Uninitialized Web API Server"; + private const string DefaultName = "Web API Server"; private const string DefaultBasePath = "/api"; private const uint DebugTrace = 0; @@ -16,6 +18,9 @@ namespace PepperDash.Core private HttpCwsServer _server; private readonly CCriticalSection _serverLock = new CCriticalSection(); + public string Key { get; private set; } + public string Name { get; private set; } + /// /// CWS base path, will default to "/api" if not set via initialize method /// @@ -29,11 +34,9 @@ namespace PepperDash.Core /// /// Constructor for S+. Make sure to set necessary properties using init method /// - public GenericCwsBase() - : base(SplusKey) - { - CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; - CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; + public WebApiServer() + : this(SplusKey, DefaultName, null) + { } /// @@ -41,10 +44,9 @@ namespace PepperDash.Core /// /// /// - public GenericCwsBase(string key, string basePath) - : base(key) + public WebApiServer(string key, string basePath) + : this(key, DefaultName, basePath) { - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; } /// @@ -53,10 +55,14 @@ namespace PepperDash.Core /// /// /// - public GenericCwsBase(string key, string name, string basePath) - : base(key, name) + public WebApiServer(string key, string name, string basePath) { + Key = key; + Name = string.IsNullOrEmpty(name) ? DefaultName : name; BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + + CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; + CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; } /// @@ -148,7 +154,7 @@ namespace PepperDash.Core _server = new HttpCwsServer(BasePath) { - HttpRequestHandler = new CwsDefaultRequestHandler() + HttpRequestHandler = new DefaultRequestRequestHandler() }; IsRegistered = _server.Register(); From 2a93f3bdb403bad5d10154a073eb0180af9874b2 Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Thu, 19 Jan 2023 11:47:52 -0700 Subject: [PATCH 08/19] fix: remove leftover merge issue --- Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index 4ac42fa..88f9682 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -331,7 +331,7 @@ namespace PepperDash.Core private void KillClient(SocketStatus status) { KillStream(); - IsConnecting = false; + if (Client != null) { try From 897b1c86e15f65a7a68d1455d893516eabda052d Mon Sep 17 00:00:00 2001 From: jdevito Date: Tue, 24 Jan 2023 11:54:03 -0600 Subject: [PATCH 09/19] fix: rebased on latest development branch, added missing XML comments to resolve warnings in Web classes --- .../RequestHandlers/DefaultRequestRequestHandler.cs | 3 +++ Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs | 10 ++++++++++ 2 files changed, 13 insertions(+) diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs index 38dd6b3..e7545df 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs @@ -2,6 +2,9 @@ namespace PepperDash.Core.Web.RequestHandlers { + /// + /// Web API default request handler + /// public class DefaultRequestRequestHandler : WebApiBaseRequestHandler { /// diff --git a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs index 6843e25..150e629 100644 --- a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs +++ b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs @@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers; namespace PepperDash.Core.Web { + /// + /// Web API server + /// public class WebApiServer : IKeyName { private const string SplusKey = "Uninitialized Web API Server"; @@ -18,7 +21,14 @@ namespace PepperDash.Core.Web private HttpCwsServer _server; private readonly CCriticalSection _serverLock = new CCriticalSection(); + /// + /// Web API server key + /// public string Key { get; private set; } + + /// + /// Web API server name + /// public string Name { get; private set; } /// From 812b49eba41b26537c74c6430a50a27c866a0411 Mon Sep 17 00:00:00 2001 From: jdevito Date: Tue, 17 Jan 2023 09:50:39 -0600 Subject: [PATCH 10/19] feat: added crestron web server (cws) generic base --- .../CrestronWebServer/GenericCwsBase.cs | 266 ++++++++++++++++++ .../RequestHandlerUnknown.cs | 16 ++ .../Pepperdash Core/PepperDash_Core.csproj | 6 + 3 files changed, 288 insertions(+) create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs new file mode 100644 index 0000000..9446e6a --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs @@ -0,0 +1,266 @@ +using System; +using Crestron.SimplSharp; +using Crestron.SimplSharp.WebScripting; + +namespace PepperDash.Core +{ + public class GenericCwsBase : Device + { + private const string SplusKey = "Uninitialized CWS Server"; + private const string DefaultBasePath = "/api"; + + private const uint DebugTrace = 0; + private const uint DebugInfo = 1; + private const uint DebugVerbose = 2; + + private HttpCwsServer _server; + private readonly CCriticalSection _serverLock = new CCriticalSection(); + + /// + /// CWS base path, will default to "/api" if not set via initialize method + /// + public string BasePath { get; private set; } + + /// + /// Indicates CWS is registered with base path + /// + public bool IsRegistered { get; private set; } + + /// + /// Constructor for S+. Make sure to set necessary properties using init method + /// + public GenericCwsBase() + : base(SplusKey) + { + CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; + CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; + } + + /// + /// Constructor + /// + /// + /// + public GenericCwsBase(string key, string basePath) + : base(key) + { + + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// + /// + /// + /// + /// + public GenericCwsBase(string key, string name, string basePath) + : base(key, name) + { + + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// Program status event handler + /// + /// + void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType) + { + if (programEventType != eProgramStatusEventType.Stopping) + return; + + Debug.Console(DebugInfo, this, "Program stopping. Disabling Server"); + + Stop(); + } + + /// + /// Ethernet event handler + /// + /// + void CrestronEnvironment_EthernetEventHandler(EthernetEventArgs ethernetEventArgs) + { + // Re-enable the server if the link comes back up and the status should be connected + if (ethernetEventArgs.EthernetEventType == eEthernetEventType.LinkUp + && IsRegistered) + { + Debug.Console(DebugInfo, this, "Ethernet link up. Starting server"); + + Start(); + } + } + + /// + /// Initializes CWS class + /// + public void Initialize(string key, string basePath) + { + Key = key; + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// Starts CWS instance + /// + public void Start() + { + try + { + _serverLock.Enter(); + + if (_server != null) + { + Debug.Console(DebugInfo, this, "Server has already been started"); + return; + } + + Debug.Console(DebugInfo, this, "Starting server"); + + _server = new HttpCwsServer(BasePath) + { + HttpRequestHandler = new RequestHandlerUnknown() + }; + + IsRegistered = _server.Register(); + } + catch (Exception ex) + { + Debug.Console(DebugInfo, this, "Start Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "Start Exception StackTrace: {0}", ex.StackTrace); + if (ex.InnerException != null) + Debug.Console(DebugVerbose, this, "Start Exception InnerException: {0}", ex.InnerException); + } + finally + { + _serverLock.Leave(); + } + } + + /// + /// Stop CWS instance + /// + public void Stop() + { + try + { + _serverLock.Enter(); + + if (_server == null) + { + Debug.Console(DebugInfo, this, "Servier has already been stopped"); + return; + } + + if (_server.Unregister()) + { + IsRegistered = false; + } + + Dispose(true); + } + catch (Exception ex) + { + Debug.Console(DebugInfo, this, "ServerStop Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "ServerStop Exception StackTrace: {0}", ex.StackTrace); + if (ex.InnerException != null) + Debug.Console(DebugVerbose, this, "ServerStop Exception InnerException: {0}", ex.InnerException); + } + finally + { + _serverLock.Leave(); + } + } + + /// + /// Received request handler + /// + /// + /// This is here for development and testing + /// + /// + /// + public void ReceivedRequestEventHandler(object sender, HttpCwsRequestEventArgs args) + { + try + { + // TODO [ ] Add logic for received requests + Debug.Console(DebugInfo, this, @"RecieveRequestEventHandler +Method: {0} +Path: {1} +PathInfo: {2} +PhysicalPath: {3} +ContentType: {4} +RawUrl: {5} +Url: {6} +UserAgent: {7} +UserHostAddress: {8} +UserHostName: {9}", + args.Context.Request.HttpMethod, + args.Context.Request.Path, + args.Context.Request.PathInfo, + args.Context.Request.PhysicalPath, + args.Context.Request.ContentType, + args.Context.Request.RawUrl, + args.Context.Request.Url, + args.Context.Request.UserAgent, + args.Context.Request.UserHostAddress, + args.Context.Request.UserHostName); + + } + catch (Exception ex) + { + Debug.Console(DebugInfo, this, "ReceivedRequestEventHandler Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "ReceivedRequestEventHandler Exception StackTrace: {0}", ex.StackTrace); + if (ex.InnerException != null) + Debug.Console(DebugVerbose, this, "ReceivedRequestEventHandler Exception InnerException: {0}", ex.InnerException); + } + } + + /// + /// Tracks if CWS is disposed + /// + public bool Disposed + { + get + { + return (_server == null); + } + } + + /// + /// Disposes CWS instance + /// + public void Dispose() + { + Dispose(true); + CrestronEnvironment.GC.SuppressFinalize(this); + } + + /// + /// Disposes CWS instance + /// + /// + protected void Dispose(bool disposing) + { + if (Disposed) + { + Debug.Console(DebugInfo, this, "Server has already been disposed"); + return; + } + + if (!disposing) return; + + if (_server != null) + { + _server.Dispose(); + _server = null; + } + } + + ~GenericCwsBase() + { + Dispose(true); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs new file mode 100644 index 0000000..5a2adac --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs @@ -0,0 +1,16 @@ +using Crestron.SimplSharp.WebScripting; + +namespace PepperDash.Core +{ + public class RequestHandlerUnknown : IHttpCwsHandler + { + public void ProcessRequest(HttpCwsContext context) + { + // TODO [ ] Modify unknown request handler + context.Response.StatusCode = 418; + context.Response.StatusDescription = "I'm a teapot"; + context.Response.ContentType = "application/json"; + context.Response.Write(string.Format("{0} {1}", context.Request.HttpMethod, context.Request.RawUrl), true); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index 86ae71d..8e49d82 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -51,6 +51,10 @@ False ..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll + + False + ..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCWSHelperInterface.dll + False ..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll @@ -89,6 +93,8 @@ + + From 6221619400aba612fefb729d7bd44e1c4edf8ec2 Mon Sep 17 00:00:00 2001 From: jdevito Date: Wed, 18 Jan 2023 13:30:27 -0600 Subject: [PATCH 11/19] fix: Added CwsBaseHandler, refactored CwsDefaultRequestHandler --- .../CrestronWebServer/CwsBaseHandler.cs | 149 ++++++++++++++++++ .../CwsDefaultRequestHandler.cs | 106 +++++++++++++ .../CrestronWebServer/GenericCwsBase.cs | 120 ++++++-------- .../RequestHandlerUnknown.cs | 16 -- .../Pepperdash Core/PepperDash_Core.csproj | 5 +- .../PepperDash_Core.csproj.DotSettings | 2 + 6 files changed, 309 insertions(+), 89 deletions(-) create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs create mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs delete mode 100644 Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs create mode 100644 Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs new file mode 100644 index 0000000..f9e25bf --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs @@ -0,0 +1,149 @@ +using System; +using System.Collections.Generic; +using Crestron.SimplSharp.WebScripting; +using Newtonsoft.Json; + +namespace PepperDash.Core +{ + /// + /// CWS Base Handler, implements IHttpCwsHandler + /// + public abstract class CwsBaseHandler : IHttpCwsHandler + { + private readonly Dictionary> _handlers; + + /// + /// Constructor + /// + protected CwsBaseHandler() + { + _handlers = new Dictionary> + { + {"CONNECT", HandleConnect}, + {"DELETE", HandleDelete}, + {"GET", HandleGet}, + {"HEAD", HandleHead}, + {"OPTIONS", HandleOptions}, + {"PATCH", HandlePatch}, + {"POST", HandlePost}, + {"PUT", HandlePut}, + {"TRACE", HandleTrace} + }; + } + + /// + /// Handles CONNECT method requests + /// + /// + protected virtual void HandleConnect(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles DELETE method requests + /// + /// + protected virtual void HandleDelete(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles GET method requests + /// + /// + protected virtual void HandleGet(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles HEAD method requests + /// + /// + protected virtual void HandleHead(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles OPTIONS method requests + /// + /// + protected virtual void HandleOptions(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PATCH method requests + /// + /// + protected virtual void HandlePatch(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles POST method requests + /// + /// + protected virtual void HandlePost(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PUT method requests + /// + /// + protected virtual void HandlePut(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles TRACE method requests + /// + /// + protected virtual void HandleTrace(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Process request + /// + /// + public void ProcessRequest(HttpCwsContext context) + { + Action handler; + + if (!_handlers.TryGetValue(context.Request.HttpMethod, out handler)) + { + return; + } + + handler(context); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs new file mode 100644 index 0000000..3a91114 --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs @@ -0,0 +1,106 @@ +using Crestron.SimplSharp.WebScripting; + +namespace PepperDash.Core +{ + public class CwsDefaultRequestHandler : CwsBaseHandler + { + /// + /// Handles CONNECT method requests + /// + /// + protected override void HandleConnect(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles DELETE method requests + /// + /// + protected override void HandleDelete(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles GET method requests + /// + /// + protected override void HandleGet(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles HEAD method requests + /// + /// + protected override void HandleHead(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles OPTIONS method requests + /// + /// + protected override void HandleOptions(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PATCH method requests + /// + /// + protected override void HandlePatch(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles POST method requests + /// + /// + protected override void HandlePost(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles PUT method requests + /// + /// + protected override void HandlePut(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + + /// + /// Handles TRACE method requests + /// + /// + protected override void HandleTrace(HttpCwsContext context) + { + context.Response.StatusCode = 501; + context.Response.StatusDescription = "Not Implemented"; + context.Response.End(); + } + } +} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs index 9446e6a..0bfbb63 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs +++ b/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs @@ -44,7 +44,6 @@ namespace PepperDash.Core public GenericCwsBase(string key, string basePath) : base(key) { - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; } @@ -57,7 +56,6 @@ namespace PepperDash.Core public GenericCwsBase(string key, string name, string basePath) : base(key, name) { - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; } @@ -67,8 +65,7 @@ namespace PepperDash.Core /// void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType) { - if (programEventType != eProgramStatusEventType.Stopping) - return; + if (programEventType != eProgramStatusEventType.Stopping) return; Debug.Console(DebugInfo, this, "Program stopping. Disabling Server"); @@ -82,13 +79,15 @@ namespace PepperDash.Core void CrestronEnvironment_EthernetEventHandler(EthernetEventArgs ethernetEventArgs) { // Re-enable the server if the link comes back up and the status should be connected - if (ethernetEventArgs.EthernetEventType == eEthernetEventType.LinkUp - && IsRegistered) + if (ethernetEventArgs.EthernetEventType == eEthernetEventType.LinkUp && IsRegistered) { - Debug.Console(DebugInfo, this, "Ethernet link up. Starting server"); - - Start(); + Debug.Console(DebugInfo, this, "Ethernet link up. Server is alreedy registered."); + return; } + + Debug.Console(DebugInfo, this, "Ethernet link up. Starting server"); + + Start(); } /// @@ -97,7 +96,37 @@ namespace PepperDash.Core public void Initialize(string key, string basePath) { Key = key; - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + } + + /// + /// Adds a route to CWS + /// + public void AddRoute(HttpCwsRoute route) + { + if (route == null) + { + Debug.Console(DebugInfo, this, "Failed to add route, route parameter is null"); + return; + } + + _server.Routes.Add(route); + + } + + /// + /// Removes a route from CWS + /// + /// + public void RemoveRoute(HttpCwsRoute route) + { + if (route == null) + { + Debug.Console(DebugInfo, this, "Failed to remote route, orute parameter is null"); + return; + } + + _server.Routes.Remove(route); } /// @@ -119,7 +148,7 @@ namespace PepperDash.Core _server = new HttpCwsServer(BasePath) { - HttpRequestHandler = new RequestHandlerUnknown() + HttpRequestHandler = new CwsDefaultRequestHandler() }; IsRegistered = _server.Register(); @@ -148,29 +177,26 @@ namespace PepperDash.Core if (_server == null) { - Debug.Console(DebugInfo, this, "Servier has already been stopped"); + Debug.Console(DebugInfo, this, "Server has already been stopped"); return; } - if (_server.Unregister()) - { - IsRegistered = false; - } - - Dispose(true); + IsRegistered = _server.Unregister() == false; + _server.Dispose(); + _server = null; } catch (Exception ex) { - Debug.Console(DebugInfo, this, "ServerStop Exception Message: {0}", ex.Message); - Debug.Console(DebugVerbose, this, "ServerStop Exception StackTrace: {0}", ex.StackTrace); + Debug.Console(DebugInfo, this, "Server Stop Exception Message: {0}", ex.Message); + Debug.Console(DebugVerbose, this, "Server Stop Exception StackTrace: {0}", ex.StackTrace); if (ex.InnerException != null) - Debug.Console(DebugVerbose, this, "ServerStop Exception InnerException: {0}", ex.InnerException); + Debug.Console(DebugVerbose, this, "Server Stop Exception InnerException: {0}", ex.InnerException); } finally { _serverLock.Leave(); } - } + } /// /// Received request handler @@ -184,7 +210,6 @@ namespace PepperDash.Core { try { - // TODO [ ] Add logic for received requests Debug.Console(DebugInfo, this, @"RecieveRequestEventHandler Method: {0} Path: {1} @@ -206,7 +231,6 @@ UserHostName: {9}", args.Context.Request.UserAgent, args.Context.Request.UserHostAddress, args.Context.Request.UserHostName); - } catch (Exception ex) { @@ -215,52 +239,6 @@ UserHostName: {9}", if (ex.InnerException != null) Debug.Console(DebugVerbose, this, "ReceivedRequestEventHandler Exception InnerException: {0}", ex.InnerException); } - } - - /// - /// Tracks if CWS is disposed - /// - public bool Disposed - { - get - { - return (_server == null); - } - } - - /// - /// Disposes CWS instance - /// - public void Dispose() - { - Dispose(true); - CrestronEnvironment.GC.SuppressFinalize(this); - } - - /// - /// Disposes CWS instance - /// - /// - protected void Dispose(bool disposing) - { - if (Disposed) - { - Debug.Console(DebugInfo, this, "Server has already been disposed"); - return; - } - - if (!disposing) return; - - if (_server != null) - { - _server.Dispose(); - _server = null; - } - } - - ~GenericCwsBase() - { - Dispose(true); - } + } } } \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs b/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs deleted file mode 100644 index 5a2adac..0000000 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/RequestHandlerUnknown.cs +++ /dev/null @@ -1,16 +0,0 @@ -using Crestron.SimplSharp.WebScripting; - -namespace PepperDash.Core -{ - public class RequestHandlerUnknown : IHttpCwsHandler - { - public void ProcessRequest(HttpCwsContext context) - { - // TODO [ ] Modify unknown request handler - context.Response.StatusCode = 418; - context.Response.StatusDescription = "I'm a teapot"; - context.Response.ContentType = "application/json"; - context.Response.Write(string.Format("{0} {1}", context.Request.HttpMethod, context.Request.RawUrl), true); - } - } -} \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index 8e49d82..55c4a20 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -7,7 +7,7 @@ {87E29B4C-569B-4368-A4ED-984AC1440C96} Library Properties - PepperDash_Core + PepperDash.Core PepperDash_Core {0B4745B0-194B-4BB6-8E21-E9057CA92500};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} WindowsCE @@ -93,8 +93,9 @@ + - + diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings new file mode 100644 index 0000000..8107a4f --- /dev/null +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings @@ -0,0 +1,2 @@ + + True \ No newline at end of file From a56f66230a0b4918bb3df84f069abe107cd253c6 Mon Sep 17 00:00:00 2001 From: jdevito Date: Wed, 18 Jan 2023 15:22:50 -0600 Subject: [PATCH 12/19] refactor: Changed CWS references to WebApi, re-organized Web folder --- .../Pepperdash Core/PepperDash_Core.csproj | 6 ++-- .../PepperDash_Core.csproj.DotSettings | 3 +- .../DefaultRequestRequestHandler.cs} | 4 +-- .../WebApiBaseRequestHandler.cs} | 7 ++-- .../GenericCwsBase.cs => Web/WebApiServer.cs} | 34 +++++++++++-------- 5 files changed, 30 insertions(+), 24 deletions(-) rename Pepperdash Core/Pepperdash Core/{CrestronWebServer/CwsDefaultRequestHandler.cs => Web/RequestHandlers/DefaultRequestRequestHandler.cs} (92%) rename Pepperdash Core/Pepperdash Core/{CrestronWebServer/CwsBaseHandler.cs => Web/RequestHandlers/WebApiBaseRequestHandler.cs} (92%) rename Pepperdash Core/Pepperdash Core/{CrestronWebServer/GenericCwsBase.cs => Web/WebApiServer.cs} (86%) diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index 55c4a20..b4785a2 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -93,9 +93,9 @@ - - - + + + diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings index 8107a4f..8e644b9 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj.DotSettings @@ -1,2 +1,3 @@  - True \ No newline at end of file + True + False \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs similarity index 92% rename from Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs rename to Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs index 3a91114..38dd6b3 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsDefaultRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs @@ -1,8 +1,8 @@ using Crestron.SimplSharp.WebScripting; -namespace PepperDash.Core +namespace PepperDash.Core.Web.RequestHandlers { - public class CwsDefaultRequestHandler : CwsBaseHandler + public class DefaultRequestRequestHandler : WebApiBaseRequestHandler { /// /// Handles CONNECT method requests diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs similarity index 92% rename from Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs rename to Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs index f9e25bf..6d4b41c 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/CwsBaseHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs @@ -1,21 +1,20 @@ using System; using System.Collections.Generic; using Crestron.SimplSharp.WebScripting; -using Newtonsoft.Json; -namespace PepperDash.Core +namespace PepperDash.Core.Web.RequestHandlers { /// /// CWS Base Handler, implements IHttpCwsHandler /// - public abstract class CwsBaseHandler : IHttpCwsHandler + public abstract class WebApiBaseRequestHandler : IHttpCwsHandler { private readonly Dictionary> _handlers; /// /// Constructor /// - protected CwsBaseHandler() + protected WebApiBaseRequestHandler() { _handlers = new Dictionary> { diff --git a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs similarity index 86% rename from Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs rename to Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs index 0bfbb63..6843e25 100644 --- a/Pepperdash Core/Pepperdash Core/CrestronWebServer/GenericCwsBase.cs +++ b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs @@ -1,12 +1,14 @@ using System; using Crestron.SimplSharp; using Crestron.SimplSharp.WebScripting; +using PepperDash.Core.Web.RequestHandlers; -namespace PepperDash.Core +namespace PepperDash.Core.Web { - public class GenericCwsBase : Device + public class WebApiServer : IKeyName { - private const string SplusKey = "Uninitialized CWS Server"; + private const string SplusKey = "Uninitialized Web API Server"; + private const string DefaultName = "Web API Server"; private const string DefaultBasePath = "/api"; private const uint DebugTrace = 0; @@ -16,6 +18,9 @@ namespace PepperDash.Core private HttpCwsServer _server; private readonly CCriticalSection _serverLock = new CCriticalSection(); + public string Key { get; private set; } + public string Name { get; private set; } + /// /// CWS base path, will default to "/api" if not set via initialize method /// @@ -29,11 +34,9 @@ namespace PepperDash.Core /// /// Constructor for S+. Make sure to set necessary properties using init method /// - public GenericCwsBase() - : base(SplusKey) - { - CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; - CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; + public WebApiServer() + : this(SplusKey, DefaultName, null) + { } /// @@ -41,10 +44,9 @@ namespace PepperDash.Core /// /// /// - public GenericCwsBase(string key, string basePath) - : base(key) + public WebApiServer(string key, string basePath) + : this(key, DefaultName, basePath) { - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; } /// @@ -53,10 +55,14 @@ namespace PepperDash.Core /// /// /// - public GenericCwsBase(string key, string name, string basePath) - : base(key, name) + public WebApiServer(string key, string name, string basePath) { + Key = key; + Name = string.IsNullOrEmpty(name) ? DefaultName : name; BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + + CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; + CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; } /// @@ -148,7 +154,7 @@ namespace PepperDash.Core _server = new HttpCwsServer(BasePath) { - HttpRequestHandler = new CwsDefaultRequestHandler() + HttpRequestHandler = new DefaultRequestRequestHandler() }; IsRegistered = _server.Register(); From 5e03ce51c055f82b392455dc1ef15e98f2c83ba4 Mon Sep 17 00:00:00 2001 From: jdevito Date: Tue, 24 Jan 2023 11:54:03 -0600 Subject: [PATCH 13/19] fix: rebased on latest development branch, added missing XML comments to resolve warnings in Web classes --- .../RequestHandlers/DefaultRequestRequestHandler.cs | 3 +++ Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs | 10 ++++++++++ 2 files changed, 13 insertions(+) diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs index 38dd6b3..e7545df 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs @@ -2,6 +2,9 @@ namespace PepperDash.Core.Web.RequestHandlers { + /// + /// Web API default request handler + /// public class DefaultRequestRequestHandler : WebApiBaseRequestHandler { /// diff --git a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs index 6843e25..150e629 100644 --- a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs +++ b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs @@ -5,6 +5,9 @@ using PepperDash.Core.Web.RequestHandlers; namespace PepperDash.Core.Web { + /// + /// Web API server + /// public class WebApiServer : IKeyName { private const string SplusKey = "Uninitialized Web API Server"; @@ -18,7 +21,14 @@ namespace PepperDash.Core.Web private HttpCwsServer _server; private readonly CCriticalSection _serverLock = new CCriticalSection(); + /// + /// Web API server key + /// public string Key { get; private set; } + + /// + /// Web API server name + /// public string Name { get; private set; } /// From ba930dafaf96ce59d76de9d6b15aa297e69b56e9 Mon Sep 17 00:00:00 2001 From: jdevito Date: Thu, 26 Jan 2023 11:52:31 -0600 Subject: [PATCH 14/19] fix: moved instantiation of server to resolve null ref exception --- .../Pepperdash Core/Web/WebApiServer.cs | 31 ++++++++++--------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs index 150e629..a3a30c0 100644 --- a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs +++ b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs @@ -46,7 +46,7 @@ namespace PepperDash.Core.Web /// public WebApiServer() : this(SplusKey, DefaultName, null) - { + { } /// @@ -71,6 +71,8 @@ namespace PepperDash.Core.Web Name = string.IsNullOrEmpty(name) ? DefaultName : name; BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + if (_server == null) _server = new HttpCwsServer(BasePath); + CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; } @@ -112,7 +114,7 @@ namespace PepperDash.Core.Web public void Initialize(string key, string basePath) { Key = key; - BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; + BasePath = string.IsNullOrEmpty(basePath) ? DefaultBasePath : basePath; } /// @@ -127,7 +129,7 @@ namespace PepperDash.Core.Web } _server.Routes.Add(route); - + } /// @@ -154,18 +156,19 @@ namespace PepperDash.Core.Web { _serverLock.Enter(); - if (_server != null) + if (_server == null) + { + Debug.Console(DebugInfo, this, "Server is null, unable to start"); + return; + } + + if (IsRegistered) { Debug.Console(DebugInfo, this, "Server has already been started"); return; } - Debug.Console(DebugInfo, this, "Starting server"); - - _server = new HttpCwsServer(BasePath) - { - HttpRequestHandler = new DefaultRequestRequestHandler() - }; + Debug.Console(DebugInfo, this, "Starting server"); IsRegistered = _server.Register(); } @@ -193,13 +196,13 @@ namespace PepperDash.Core.Web if (_server == null) { - Debug.Console(DebugInfo, this, "Server has already been stopped"); + Debug.Console(DebugInfo, this, "Server is null or has already been stopped"); return; } IsRegistered = _server.Unregister() == false; _server.Dispose(); - _server = null; + _server = null; } catch (Exception ex) { @@ -212,7 +215,7 @@ namespace PepperDash.Core.Web { _serverLock.Leave(); } - } + } /// /// Received request handler @@ -255,6 +258,6 @@ UserHostName: {9}", if (ex.InnerException != null) Debug.Console(DebugVerbose, this, "ReceivedRequestEventHandler Exception InnerException: {0}", ex.InnerException); } - } + } } } \ No newline at end of file From 627a39e63ad42c28bfea835cfd0cd003cf97d3da Mon Sep 17 00:00:00 2001 From: jdevito Date: Mon, 30 Jan 2023 16:25:23 -0600 Subject: [PATCH 15/19] fix: added GetRouteCollection method, additional refactoring to resolve use of base class --- .../DefaultRequestRequestHandler.cs | 2 +- .../Pepperdash Core/Web/WebApiServer.cs | 75 ++++++++++++------- 2 files changed, 49 insertions(+), 28 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs index e7545df..9db866e 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs @@ -14,7 +14,7 @@ namespace PepperDash.Core.Web.RequestHandlers protected override void HandleConnect(HttpCwsContext context) { context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; + context.Response.StatusDescription = "Not Implemented"; context.Response.End(); } diff --git a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs index a3a30c0..43efb5b 100644 --- a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs +++ b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs @@ -1,6 +1,10 @@ using System; +using System.Collections.Generic; +using System.Linq; using Crestron.SimplSharp; using Crestron.SimplSharp.WebScripting; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; using PepperDash.Core.Web.RequestHandlers; namespace PepperDash.Core.Web @@ -18,8 +22,8 @@ namespace PepperDash.Core.Web private const uint DebugInfo = 1; private const uint DebugVerbose = 2; - private HttpCwsServer _server; private readonly CCriticalSection _serverLock = new CCriticalSection(); + private HttpCwsServer _server; /// /// Web API server key @@ -41,6 +45,28 @@ namespace PepperDash.Core.Web /// public bool IsRegistered { get; private set; } + /// + /// Http request handler + /// + //public IHttpCwsHandler HttpRequestHandler + //{ + // get { return _server.HttpRequestHandler; } + // set + // { + // if (_server == null) return; + // _server.HttpRequestHandler = value; + // } + //} + + /// + /// Received request event handler + /// + //public event EventHandler ReceivedRequestEvent + //{ + // add { _server.ReceivedRequestEvent += new HttpCwsRequestEventHandler(value); } + // remove { _server.ReceivedRequestEvent -= new HttpCwsRequestEventHandler(value); } + //} + /// /// Constructor for S+. Make sure to set necessary properties using init method /// @@ -60,12 +86,12 @@ namespace PepperDash.Core.Web } /// - /// + /// Constructor /// /// /// /// - public WebApiServer(string key, string name, string basePath) + public WebApiServer(string key, string name, string basePath) { Key = key; Name = string.IsNullOrEmpty(name) ? DefaultName : name; @@ -73,6 +99,9 @@ namespace PepperDash.Core.Web if (_server == null) _server = new HttpCwsServer(BasePath); + _server.setProcessName(Key); + _server.HttpRequestHandler = new DefaultRequestRequestHandler(); + CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; } @@ -85,7 +114,7 @@ namespace PepperDash.Core.Web { if (programEventType != eProgramStatusEventType.Stopping) return; - Debug.Console(DebugInfo, this, "Program stopping. Disabling Server"); + Debug.Console(DebugInfo, this, "Program stopping. stopping server"); Stop(); } @@ -147,6 +176,14 @@ namespace PepperDash.Core.Web _server.Routes.Remove(route); } + /// + /// Returns a list of the current routes + /// + public HttpCwsRouteCollection GetRouteCollection() + { + return _server.Routes; + } + /// /// Starts CWS instance /// @@ -168,9 +205,9 @@ namespace PepperDash.Core.Web return; } - Debug.Console(DebugInfo, this, "Starting server"); - IsRegistered = _server.Register(); + + Debug.Console(DebugInfo, this, "Starting server, registration {0}", IsRegistered ? "was successful" : "failed"); } catch (Exception ex) { @@ -201,6 +238,9 @@ namespace PepperDash.Core.Web } IsRegistered = _server.Unregister() == false; + + Debug.Console(DebugInfo, this, "Stopping server, unregistration {0}", IsRegistered ? "failed" : "was successful"); + _server.Dispose(); _server = null; } @@ -229,27 +269,8 @@ namespace PepperDash.Core.Web { try { - Debug.Console(DebugInfo, this, @"RecieveRequestEventHandler -Method: {0} -Path: {1} -PathInfo: {2} -PhysicalPath: {3} -ContentType: {4} -RawUrl: {5} -Url: {6} -UserAgent: {7} -UserHostAddress: {8} -UserHostName: {9}", - args.Context.Request.HttpMethod, - args.Context.Request.Path, - args.Context.Request.PathInfo, - args.Context.Request.PhysicalPath, - args.Context.Request.ContentType, - args.Context.Request.RawUrl, - args.Context.Request.Url, - args.Context.Request.UserAgent, - args.Context.Request.UserHostAddress, - args.Context.Request.UserHostName); + var j = JsonConvert.SerializeObject(args.Context, Formatting.Indented); + Debug.Console(DebugVerbose, this, "RecieveRequestEventHandler Context:\x0d\x0a{0}", j); } catch (Exception ex) { From 71349e67a383562f3e28d99fe704e923420b08f8 Mon Sep 17 00:00:00 2001 From: jdevito Date: Mon, 6 Feb 2023 19:47:45 -0600 Subject: [PATCH 16/19] fix: remove default handler overrides --- .../Pepperdash Core/PepperDash_Core.csproj | 2 +- .../DefaultRequestRequestHandler.cs | 101 +----------------- 2 files changed, 2 insertions(+), 101 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index b4785a2..510d978 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -93,9 +93,9 @@ + - diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs index 9db866e..e052eb3 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs @@ -6,104 +6,5 @@ namespace PepperDash.Core.Web.RequestHandlers /// Web API default request handler /// public class DefaultRequestRequestHandler : WebApiBaseRequestHandler - { - /// - /// Handles CONNECT method requests - /// - /// - protected override void HandleConnect(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles DELETE method requests - /// - /// - protected override void HandleDelete(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles GET method requests - /// - /// - protected override void HandleGet(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles HEAD method requests - /// - /// - protected override void HandleHead(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles OPTIONS method requests - /// - /// - protected override void HandleOptions(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles PATCH method requests - /// - /// - protected override void HandlePatch(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles POST method requests - /// - /// - protected override void HandlePost(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles PUT method requests - /// - /// - protected override void HandlePut(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - - /// - /// Handles TRACE method requests - /// - /// - protected override void HandleTrace(HttpCwsContext context) - { - context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; - context.Response.End(); - } - } + {} } \ No newline at end of file From 8f47762409e38be535c43a22459e3be57419c2a8 Mon Sep 17 00:00:00 2001 From: jdevito Date: Mon, 20 Feb 2023 15:27:02 -0600 Subject: [PATCH 17/19] fix: add CORS headers to all responses Added EnableCors field,used to enable CORS support. Enabled CORS in default request handler for all requests. --- .../DefaultRequestRequestHandler.cs | 9 ++++++- .../WebApiBaseRequestHandler.cs | 26 ++++++++++++++++--- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs index e052eb3..a2ea2c0 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs @@ -6,5 +6,12 @@ namespace PepperDash.Core.Web.RequestHandlers /// Web API default request handler /// public class DefaultRequestRequestHandler : WebApiBaseRequestHandler - {} + { + /// + /// Constructor + /// + public DefaultRequestRequestHandler() + : base(true) + { } + } } \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs index 6d4b41c..22d9d23 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs @@ -14,8 +14,10 @@ namespace PepperDash.Core.Web.RequestHandlers /// /// Constructor /// - protected WebApiBaseRequestHandler() + protected WebApiBaseRequestHandler(bool enableCors) { + EnableCors = enableCors; + _handlers = new Dictionary> { {"CONNECT", HandleConnect}, @@ -30,6 +32,16 @@ namespace PepperDash.Core.Web.RequestHandlers }; } + /// + /// Constructor + /// + protected WebApiBaseRequestHandler() + : this(false) + { + } + + protected readonly bool EnableCors; + /// /// Handles CONNECT method requests /// @@ -37,7 +49,7 @@ namespace PepperDash.Core.Web.RequestHandlers protected virtual void HandleConnect(HttpCwsContext context) { context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; + context.Response.StatusDescription = "Not Implemented"; context.Response.End(); } @@ -48,7 +60,7 @@ namespace PepperDash.Core.Web.RequestHandlers protected virtual void HandleDelete(HttpCwsContext context) { context.Response.StatusCode = 501; - context.Response.StatusDescription = "Not Implemented"; + context.Response.StatusDescription = "Not Implemented"; context.Response.End(); } @@ -142,7 +154,13 @@ namespace PepperDash.Core.Web.RequestHandlers return; } + if (EnableCors) + { + context.Response.Headers.Add("Access-Control-Allow-Origin", "*"); + context.Response.Headers.Add("Access-Control-Allow-Methods", "POST, GET, OPTIONS"); + } + handler(context); - } + } } } \ No newline at end of file From ca648e6107ea39a322441cb21e141ebe6e473474 Mon Sep 17 00:00:00 2001 From: jdevito Date: Mon, 20 Feb 2023 16:01:32 -0600 Subject: [PATCH 18/19] fix: refactored default request handler to remove redundant reference --- Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj | 2 +- ...aultRequestRequestHandler.cs => DefaultRequestHandler.cs} | 4 ++-- .../Web/RequestHandlers/WebApiBaseRequestHandler.cs | 5 ++--- Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs | 2 +- 4 files changed, 6 insertions(+), 7 deletions(-) rename Pepperdash Core/Pepperdash Core/Web/RequestHandlers/{DefaultRequestRequestHandler.cs => DefaultRequestHandler.cs} (65%) diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index 510d978..ec6346d 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -93,7 +93,7 @@ - + diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestHandler.cs similarity index 65% rename from Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs rename to Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestHandler.cs index a2ea2c0..93cfae0 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/DefaultRequestHandler.cs @@ -5,12 +5,12 @@ namespace PepperDash.Core.Web.RequestHandlers /// /// Web API default request handler /// - public class DefaultRequestRequestHandler : WebApiBaseRequestHandler + public class DefaultRequestHandler : WebApiBaseRequestHandler { /// /// Constructor /// - public DefaultRequestRequestHandler() + public DefaultRequestHandler() : base(true) { } } diff --git a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs index 22d9d23..a73abd1 100644 --- a/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs +++ b/Pepperdash Core/Pepperdash Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs @@ -10,6 +10,7 @@ namespace PepperDash.Core.Web.RequestHandlers public abstract class WebApiBaseRequestHandler : IHttpCwsHandler { private readonly Dictionary> _handlers; + protected readonly bool EnableCors; /// /// Constructor @@ -38,9 +39,7 @@ namespace PepperDash.Core.Web.RequestHandlers protected WebApiBaseRequestHandler() : this(false) { - } - - protected readonly bool EnableCors; + } /// /// Handles CONNECT method requests diff --git a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs index 43efb5b..f2f8464 100644 --- a/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs +++ b/Pepperdash Core/Pepperdash Core/Web/WebApiServer.cs @@ -100,7 +100,7 @@ namespace PepperDash.Core.Web if (_server == null) _server = new HttpCwsServer(BasePath); _server.setProcessName(Key); - _server.HttpRequestHandler = new DefaultRequestRequestHandler(); + _server.HttpRequestHandler = new DefaultRequestHandler(); CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler; CrestronEnvironment.EthernetEventHandler += CrestronEnvironment_EthernetEventHandler; From 9b56db1cb8b0aa4b9e848077ac9a752013bee9cc Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Wed, 1 Mar 2023 09:35:31 -0700 Subject: [PATCH 19/19] fix: remove isConnecting reference --- Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs | 3 +-- Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index 4c93278..f9a6ef6 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -331,8 +331,7 @@ namespace PepperDash.Core KillStream(); if (Client != null) - { - IsConnecting = false; + { Client.Disconnect(); Client = null; ClientStatus = status; diff --git a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj index ec6346d..ec00542 100644 --- a/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj +++ b/Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj @@ -53,7 +53,7 @@ False - ..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCWSHelperInterface.dll + ..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCWSHelperInterface.dll False