Refactor WebSocket

Author: Lord-Grey

libsrc/webserver/CMakeLists.txt

@@ -1,3 +1,4 @@
+find_package(Qt${QT_VERSION_MAJOR} COMPONENTS WebSockets REQUIRED)
 
 file(GLOB_RECURSE webFiles RELATIVE ${CMAKE_BINARY_DIR}  ${CMAKE_SOURCE_DIR}/assets/webconfig/*)
 file(RELATIVE_PATH webConfigPath ${CMAKE_BINARY_DIR} ${CMAKE_SOURCE_DIR}/assets/webconfig)
@@ -28,13 +29,13 @@ add_library(webserver
 	${CMAKE_SOURCE_DIR}/libsrc/webserver/StaticFileServing.cpp
 	${CMAKE_SOURCE_DIR}/libsrc/webserver/WebJsonRpc.h
 	${CMAKE_SOURCE_DIR}/libsrc/webserver/WebJsonRpc.cpp
-	${CMAKE_SOURCE_DIR}/libsrc/webserver/WebSocketClient.h
-	${CMAKE_SOURCE_DIR}/libsrc/webserver/WebSocketClient.cpp
-	${CMAKE_SOURCE_DIR}/libsrc/webserver/WebSocketUtils.h
+	${CMAKE_SOURCE_DIR}/libsrc/webserver/WebSocketJsonHandler.h
+	${CMAKE_SOURCE_DIR}/libsrc/webserver/WebSocketJsonHandler.cpp
 	${CMAKE_BINARY_DIR}/WebConfig.qrc
-)
+ )
 
 target_link_libraries(webserver
+	Qt${QT_VERSION_MAJOR}::WebSockets
 	hyperion
 	hyperion-utils
 	hyperion-api

libsrc/webserver/QtHttpClientWrapper.cpp

@@ -5,7 +5,7 @@
 #include "QtHttpReply.h"
 #include "QtHttpServer.h"
 #include "QtHttpHeader.h"
-#include "WebSocketClient.h"
+#include "WebSocketJsonHandler.h"
 #include "WebJsonRpc.h"
 
 #include <QCryptographicHash>
@@ -29,6 +29,8 @@ QtHttpClientWrapper::QtHttpClientWrapper (QTcpSocket * sock, const bool& localCo
 	, m_webJsonRpc     (nullptr)
 {
 	connect (m_sockClient, &QTcpSocket::readyRead, this, &QtHttpClientWrapper::onClientDataReceived);
+	connect(&m_websocketServer, &QWebSocketServer::newConnection,
+		this, &QtHttpClientWrapper::onNewWebSocketConnection);
 }
 
 QString QtHttpClientWrapper::getGuid (void)
@@ -50,6 +52,11 @@ void QtHttpClientWrapper::onClientDataReceived (void)
 {
 	if (m_sockClient != Q_NULLPTR)
 	{
+		if (!m_sockClient->isTransactionStarted())
+		{
+			m_sockClient->startTransaction();
+		}
+
 		while (m_sockClient->bytesAvailable () != 0)
 		{
 			QByteArray line = m_sockClient->readLine ();
@@ -162,22 +169,25 @@ void QtHttpClientWrapper::onClientDataReceived (void)
 			{
 			case RequestParsed: // a valid request has ben fully parsed
 			{
-				// Catch websocket header "Upgrade"
-				if(m_currentRequest->getHeader(QtHttpHeader::Upgrade).toLower() == "websocket")
-				{
+				const auto& upgradeValue = m_currentRequest->getHeader(QtHttpHeader::Upgrade).toLower();
+				if (upgradeValue.compare(QByteArrayLiteral("websocket"), Qt::CaseInsensitive) == 0) {
+
+					qDebug() << "WebSocket upgrade detected, passing to QWebSocketServer";
+
 					if(m_websocketClient == Q_NULLPTR)
 					{
 						// disconnect this slot from socket for further requests
 						disconnect(m_sockClient, &QTcpSocket::readyRead, this, &QtHttpClientWrapper::onClientDataReceived);
-						// disabling packet bunching
-						m_sockClient->setSocketOption(QAbstractSocket::LowDelayOption, 1);
-						m_sockClient->setSocketOption(QAbstractSocket::KeepAliveOption, 1);
-						m_websocketClient = new WebSocketClient(m_currentRequest, m_sockClient, m_localConnection, this);
+						m_sockClient->rollbackTransaction();
+						m_websocketServer.handleConnection(m_sockClient);
+						emit m_sockClient->readyRead();
+						return;
 					}
 
 					break;
 				}
 
+				m_sockClient->commitTransaction();
 				// add  post data to request and catch /jsonrpc subroute url
 				if ( m_currentRequest->getCommand() == "POST")
 				{
@@ -227,6 +237,8 @@ void QtHttpClientWrapper::onClientDataReceived (void)
 			case ParsingError: // there was an error durin one of parsing steps
 			{
 				m_sockClient->readAll (); // clear remaining buffer to ignore content
+				m_sockClient->commitTransaction();
+
 				QtHttpReply reply (m_serverHandle);
 				reply.setStatusCode (QtHttpReply::BadRequest);
 				reply.appendRawData (QByteArrayLiteral ("<h1>Bad Request (HTTP parsing error) !</h1>"));
@@ -365,3 +377,19 @@ void QtHttpClientWrapper::closeConnection()
 	}
 	m_sockClient->close ();
 }
+
+void QtHttpClientWrapper::onNewWebSocketConnection() {
+
+	// Handle the pending connection
+	QWebSocket* webSocket = m_websocketServer.nextPendingConnection();
+	if (webSocket) {
+		qDebug() << "New WebSocket connection established";
+
+		// Manage the WebSocketJsonHandler for this connection
+		WebSocketJsonHandler* handler = new WebSocketJsonHandler(webSocket);
+		connect(webSocket, &QWebSocket::disconnected, handler, &QObject::deleteLater);
+	}
+	else {
+		qWarning() << "No pending WebSocket connection!";
+	}
+}

libsrc/webserver/QtHttpClientWrapper.h

@@ -3,6 +3,8 @@
 
 #include <QObject>
 #include <QString>
+#include <QWebSocketServer>
+#include <QCoreApplication>
 
 class QTcpSocket;
 
@@ -39,8 +41,17 @@ class QtHttpClientWrapper : public QObject {
 	///
 	void closeConnection();
 
+	QWebSocketServer m_websocketServer{
+	QCoreApplication::applicationName() + QLatin1Char('/') + QCoreApplication::applicationVersion(),
+	QWebSocketServer::NonSecureMode
+	};
+
+signals:
+	void newWebSocketConnection();
+
 private slots:
 	void onClientDataReceived (void);
+	void onNewWebSocketConnection();
 
 protected:
 	ParsingStatus sendReplyToClient (QtHttpReply * reply);

libsrc/webserver/QtHttpServer.cpp

@@ -40,7 +40,7 @@ QtHttpServer::QtHttpServer (QObject * parent)
 	, m_netOrigin  (NetOrigin::getInstance())
 {
 	m_sockServer = new QtHttpServerWrapper (this);
-	connect (m_sockServer, &QtHttpServerWrapper::newConnection, this, &QtHttpServer::onClientConnected);
+	connect (m_sockServer, &QtHttpServerWrapper::newConnection, this, &QtHttpServer::onClientConnected, Qt::UniqueConnection);
 }
 
 void QtHttpServer::start (quint16 port)
@@ -81,27 +81,27 @@ void QtHttpServer::onClientConnected (void)
 	{
 		if (QTcpSocket * sock = m_sockServer->nextPendingConnection ())
 		{
-			if(m_netOrigin->accessAllowed(sock->peerAddress(), sock->localAddress()))
+			if (m_netOrigin->accessAllowed(sock->peerAddress(), sock->localAddress()))
 			{
-				connect (sock, &QTcpSocket::disconnected, this, &QtHttpServer::onClientDisconnected);
+				connect(sock, &QTcpSocket::disconnected, this, &QtHttpServer::onClientDisconnected);
 
 				if (m_useSsl)
 				{
-					if (QSslSocket * ssl = qobject_cast<QSslSocket *> (sock))
+					if (QSslSocket* ssl = qobject_cast<QSslSocket*> (sock))
 					{
-						connect (ssl, SslErrorSignal (&QSslSocket::sslErrors), this, &QtHttpServer::onClientSslErrors);
-						connect (ssl, &QSslSocket::encrypted,                  this, &QtHttpServer::onClientSslEncrypted);
-						connect (ssl, &QSslSocket::peerVerifyError,            this, &QtHttpServer::onClientSslPeerVerifyError);
-						connect (ssl, &QSslSocket::modeChanged,                this, &QtHttpServer::onClientSslModeChanged);
-						ssl->setLocalCertificateChain (m_sslCerts);
-						ssl->setPrivateKey (m_sslKey);
-						ssl->setPeerVerifyMode (QSslSocket::AutoVerifyPeer);
-						ssl->startServerEncryption ();
+						connect(ssl, SslErrorSignal(&QSslSocket::sslErrors), this, &QtHttpServer::onClientSslErrors);
+						connect(ssl, &QSslSocket::encrypted, this, &QtHttpServer::onClientSslEncrypted);
+						connect(ssl, &QSslSocket::peerVerifyError, this, &QtHttpServer::onClientSslPeerVerifyError);
+						connect(ssl, &QSslSocket::modeChanged, this, &QtHttpServer::onClientSslModeChanged);
+						ssl->setLocalCertificateChain(m_sslCerts);
+						ssl->setPrivateKey(m_sslKey);
+						ssl->setPeerVerifyMode(QSslSocket::AutoVerifyPeer);
+						ssl->startServerEncryption();
 					}
 				}
 
-				QtHttpClientWrapper * wrapper = new QtHttpClientWrapper (sock, m_netOrigin->isLocalAddress(sock->peerAddress(), sock->localAddress()), this);
-				m_socksClientsHash.insert (sock, wrapper);
+				QtHttpClientWrapper* wrapper = new QtHttpClientWrapper(sock, m_netOrigin->isLocalAddress(sock->peerAddress(), sock->localAddress()), this);
+				m_socksClientsHash.insert(sock, wrapper);
 				emit clientConnected (wrapper->getGuid ());
 			}
 			else