SimpleWebSocketServer.cpp

/*
  ==============================================================================

	juce_SimpleWebSocketServer.cpp
	Created: 17 Jun 2020 11:22:54pm
	Author:  bkupe

  ==============================================================================
*/

#include "JuceHeader.h"

using namespace juce;

SimpleWebSocketServerBase::SimpleWebSocketServerBase() : Thread("Web socket"), port(0), allowAddressReuse(false), isConnected(false) {}

SimpleWebSocketServerBase::~SimpleWebSocketServerBase()
{
	stopThread(2000);
}

void SimpleWebSocketServerBase::start(int _port, const String& _wsSuffix, const String& _localAddress, bool allowAddrReuse)
{
	stopThread(1000);
	localAddress = _localAddress;
	port = _port;
	wsSuffix = _wsSuffix;
	allowAddressReuse = allowAddrReuse;
	isConnecting = true;
	startThread();
}

void SimpleWebSocketServerBase::send(const MemoryBlock& data)
{
	send((const char*) data.getData(), (int) data.getSize());
}

void SimpleWebSocketServerBase::stop()
{
	// #if !JUCE_DEBUG
	//	if (Thread::getCurrentThreadId() != this->getThreadId()) stopThread(500);
	// #endif

	stopInternal();
	isConnecting = false;
	isConnected = false;

	// #if JUCE_DEBUG //don't know why the order is not the same for debug and release...
	//	if (Thread::getCurrentThreadId() != this->getThreadId()) stopThread(500);
	// #endif
}

void SimpleWebSocketServerBase::closeConnection(const String& id, int code, const String& reason)
{
	closeConnectionInternal(id, code, reason);
}

void SimpleWebSocketServerBase::run()
{
	// HTTP init
	isConnected = false;
	isConnecting = true;
	initServer();
}

void SimpleWebSocketServerBase::addHTTPRequestHandler(RequestHandler* newHandler)
{
	handlers.add(newHandler);
}

void SimpleWebSocketServerBase::removeHTTPRequestHandler(RequestHandler* handlerToRemove)
{
	handlers.removeAllInstancesOf(handlerToRemove);
}

// SIMPLE

SimpleWebSocketServer::SimpleWebSocketServer() {}

SimpleWebSocketServer::~SimpleWebSocketServer()
{
	stop();
}

void SimpleWebSocketServer::send(const String& message)
{
	HashMap<String, std::shared_ptr<WsServer::Connection>, DefaultHashFunctions, CriticalSection>::Iterator it(connectionMap);
	while (it.next())
	{
		it.getValue()->send(message.toStdString());
	}
}

void SimpleWebSocketServer::send(const char* data, int numData)
{
	std::shared_ptr<WsServer::OutMessage> out_message = std::make_shared<WsServer::OutMessage>();
	out_message->write(data, numData);
	HashMap<String, std::shared_ptr<WsServer::Connection>, DefaultHashFunctions, CriticalSection>::Iterator it(connectionMap);
	while (it.next())
	{
		it.getValue()->send(out_message, nullptr, 130); // 130 = binary
	}
}

void SimpleWebSocketServer::sendTo(const String& message, const String& id)
{
	if (connectionMap.contains(id))
	{
		connectionMap[id]->send(message.toStdString());
	}
	else
	{
		DBG("Websocket connection not found : " << id);
	}
}

void SimpleWebSocketServer::sendTo(const MemoryBlock& data, const String& id)
{
	std::shared_ptr<WsServer::OutMessage> out_message = std::make_shared<WsServer::OutMessage>();
	out_message->write((const char*) data.getData(), data.getSize());
	if (connectionMap.contains(id))
	{
		connectionMap[id]->send(out_message, nullptr, 130); // 130 = binary
	}
	else
	{
		DBG("Websocket connection not found : " << id);
	}
}

void SimpleWebSocketServer::sendExclude(const String& message, const StringArray excludeIds)
{
	HashMap<String, std::shared_ptr<WsServer::Connection>, DefaultHashFunctions, CriticalSection>::Iterator it(connectionMap);
	while (it.next())
	{
		if (excludeIds.contains(it.getKey()))
		{
			continue;
		}
		it.getValue()->send(message.toStdString());
	}
}

void SimpleWebSocketServer::sendExclude(const MemoryBlock& data, const StringArray excludeIds)
{
	std::shared_ptr<WsServer::OutMessage> out_message = std::make_shared<WsServer::OutMessage>();
	out_message->write((const char*) data.getData(), data.getSize());

	HashMap<String, std::shared_ptr<WsServer::Connection>, DefaultHashFunctions, CriticalSection>::Iterator it(connectionMap);
	while (it.next())
	{
		if (excludeIds.contains(it.getKey()))
		{
			continue;
		}
		it.getValue()->send(out_message, nullptr, 130); // 130 = binary
	}
}

void SimpleWebSocketServer::stopInternal()
{
	if (ioService != nullptr)
	{
		ioService->stop();
	}
	ScopedLock lock(serverLock);

	if (ws != nullptr)
	{
		std::unordered_set<std::shared_ptr<WsServer::Connection>> connections = ws->get_connections();
		for (auto& c : connections)
		{
			c->send_close(1000, "Server destroyed");
		}
		connectionMap.clear();

		ws->stop();
	}

	if (http != nullptr)
	{
		http->stop();
	}

	ws.reset();
	http.reset();
	ioService.reset();

	stopThread(1000);
}

void SimpleWebSocketServer::closeConnectionInternal(const String& id, int code, const String& reason)
{
	if (!connectionMap.contains(id))
	{
		return;
	}
	connectionMap[id]->send_close(code, reason.toStdString());
}

void SimpleWebSocketServer::initServer()
{
	ScopedLock lock(serverLock);

	try
	{
		ioService = std::make_shared<asio::io_service>();
		DBG("HTTP create");
		http.reset(new HttpServer());
		if (localAddress.isNotEmpty())
		{
			http->config.address = localAddress.toStdString();
		}
		http->config.port = port;
		http->io_service = ioService;

		std::function<void(std::shared_ptr<HttpServer::Response>, std::shared_ptr<HttpServer::Request>)> httpCallbackFunc = std::bind(&SimpleWebSocketServer::httpDefaultCallback, this, std::placeholders::_1, std::placeholders::_2);
		http->default_resource["GET"] = httpCallbackFunc;
		http->default_resource["POST"] = httpCallbackFunc;
		http->default_resource["PUT"] = httpCallbackFunc;
		http->default_resource["DELETE"] = httpCallbackFunc;
		http->default_resource["PATCH"] = httpCallbackFunc;
		http->on_upgrade = std::bind(&SimpleWebSocketServer::onHTTPUpgrade, this, std::placeholders::_1, std::placeholders::_2);

		// WebSocket init
		DBG("WS create");
		ws.reset(new WsServer());
		auto& wsEndpoint = ws->endpoint[("^" + wsSuffix + "/?$").toStdString()];

		wsEndpoint.on_message = std::bind(&SimpleWebSocketServer::onMessageCallback, this, std::placeholders::_1, std::placeholders::_2);
		wsEndpoint.on_error = std::bind(&SimpleWebSocketServer::onErrorCallback, this, std::placeholders::_1, std::placeholders::_2);
		wsEndpoint.on_open = std::bind(&SimpleWebSocketServer::onNewConnectionCallback, this, std::placeholders::_1);
		wsEndpoint.on_close = std::bind(&SimpleWebSocketServer::onConnectionCloseCallback, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);

		http->config.timeout_request = 1;
		http->config.timeout_content = 300;
		http->config.max_request_streambuf_size = 1000000;
		http->config.thread_pool_size = 4;
		http->config.reuse_address = allowAddressReuse;

		DBG("Http start");

		http->start(std::bind(&SimpleWebSocketServer::httpStartCallback, this, std::placeholders::_1));

		DBG("Service run");
		isConnected = true;
		isConnecting = false;

		webSocketListeners.call(&Listener::serverInitSuccess);

		if (ioService != nullptr)
		{
			ioService->run();
		}
	}
	catch (std::exception e)
	{
		DBG("Error init server " << e.what());
		webSocketListeners.call(&Listener::serverInitError, e.what());
	}
}

int SimpleWebSocketServer::getNumActiveConnections() const
{
	return connectionMap.size();
}

String SimpleWebSocketServer::getConnectionString(std::shared_ptr<WsServer::Connection> connection) const
{
	return String(connection->remote_endpoint().address().to_string()) + ":" + String(connection->remote_endpoint().port());
}

void SimpleWebSocketServerBase::serveFile(const File& file, std::shared_ptr<HttpServer::Response> response)
{
	String contentType = MIMETypes::getMIMEType(file.getFileExtension());

	bool fileIsText = contentType.contains("text") || contentType.contains("json") || contentType.contains("script") || contentType.contains("css");

	SimpleWeb::CaseInsensitiveMultimap header;
	header.emplace("Content-Length", String(file.getSize()).toStdString());
	header.emplace("Content-Type", contentType.toStdString());
	header.emplace("Accept-range", "bytes");
	header.emplace("Access-Control-Allow-Origin", "*");

	response->write(SimpleWeb::StatusCode::success_ok, header);

	if (fileIsText)
	{
		*response << file.loadFileAsString().toStdString();
	}
	else
	{
		MemoryBlock b;
		std::unique_ptr<FileInputStream> fs = file.createInputStream();
		fs->readIntoMemoryBlock(b);
		response->write((const char*) b.getData(), b.getSize());
	}
}

void SimpleWebSocketServerBase::serveFile(const File& file, std::shared_ptr<HttpsServer::Response> response)
{
	String contentType = MIMETypes::getMIMEType(file.getFileExtension());

	bool fileIsText = contentType.contains("text") || contentType.contains("json") || contentType.contains("script") || contentType.contains("css");

	SimpleWeb::CaseInsensitiveMultimap header;
	header.emplace("Content-Length", String(file.getSize()).toStdString());
	header.emplace("Content-Type", contentType.toStdString());
	header.emplace("Accept-range", "bytes");
	header.emplace("Access-Control-Allow-Origin", "*");

	response->write(SimpleWeb::StatusCode::success_ok, header);

	if (fileIsText)
	{
		*response << file.loadFileAsString().toStdString();
	}
	else
	{
		MemoryBlock b;
		std::unique_ptr<FileInputStream> fs = file.createInputStream();
		fs->readIntoMemoryBlock(b);
		response->write((const char*) b.getData(), b.getSize());
	}
}

void SimpleWebSocketServer::onMessageCallback(std::shared_ptr<WsServer::Connection> connection, std::shared_ptr<WsServer::InMessage> in_message)
{
	String id = getConnectionString(connection);
	if (in_message->fin_rsv_opcode == 129)
	{
		webSocketListeners.call(&Listener::messageReceived, id, String(in_message->string()));
	}
	else if (in_message->fin_rsv_opcode == 130)
	{
		MemoryBlock b(in_message->string().c_str(), in_message->size());
		webSocketListeners.call(&Listener::dataReceived, id, b);
	}
	else if (in_message->fin_rsv_opcode == 136)
	{
		DBG("Connection ended for " << id);
	}
}

void SimpleWebSocketServer::onNewConnectionCallback(std::shared_ptr<WsServer::Connection> connection)
{
	String id = getConnectionString(connection);
	connectionMap.set(id, connection);
	webSocketListeners.call(&Listener::connectionOpened, id);
}

void SimpleWebSocketServer::onConnectionCloseCallback(std::shared_ptr<WsServer::Connection> connection, int status, const std::string& reason)
{
	String id = getConnectionString(connection);
	connectionMap.remove(id);
	webSocketListeners.call(&Listener::connectionClosed, id, status, reason);
}

void SimpleWebSocketServer::onErrorCallback(std::shared_ptr<WsServer::Connection> connection, const SimpleWeb::error_code& ec)
{
	String id = getConnectionString(connection);
	connectionMap.remove(id);
	webSocketListeners.call(&Listener::connectionError, id, ec.message());
}

void SimpleWebSocketServer::httpStartCallback(unsigned short _port)
{
	isConnected = port == _port;
}

void SimpleWebSocketServer::onHTTPUpgrade(std::unique_ptr<SimpleWeb::HTTP>& socket, std::shared_ptr<HttpServer::Request> request)
{
	jassert(ws != nullptr);

	auto connection = std::make_shared<WsServer::Connection>(std::move(socket));
	connection->method = std::move(request->method);
	connection->path = std::move(request->path);
	connection->http_version = std::move(request->http_version);
	connection->header = std::move(request->header);
	ws->upgrade(connection);
}

void SimpleWebSocketServer::httpDefaultCallback(std::shared_ptr<HttpServer::Response> response, std::shared_ptr<HttpServer::Request> request)
{
	for (auto& secondaryHandler : handlers)
	{
		if (secondaryHandler->handleHTTPRequest(response, request))
		{
			return;
		}
	}

	if (rootPath.exists() && rootPath.isDirectory())
	{
		// String content = "";
		String contentType = "text/html";
		File f;

		String path = request->path.substr(1);
		if (path.isEmpty())
		{
			path = "index.html";
		}
		f = rootPath.getChildFile(path); // substr to remove the first "/"

		if (f.exists() && f.isDirectory())
		{
			f = f.getChildFile("index.html");
		}

		if (f.existsAsFile())
		{
			// check that file is not outside rootPath
			if (!f.isAChildOf(rootPath))
			{
				*response << "HTTP/1.1 403 Forbidden";
				serveFile(rootPath.getChildFile("403.html"), response);
				return;
			}

			serveFile(f, response);
			return;
		}
		else
		{
			DBG("WebServer requested file not found : " << f.getFullPathName());
		}
	}

	*response << "HTTP/1.1 404 Not Found";
}

// SECURE

#if SIMPLEWEB_SECURE_SUPPORTED

SecureWebSocketServer::SecureWebSocketServer(const String& certFile, const String& privateKeyFile, const String& verifyFile) : certFile(certFile), keyFile(privateKeyFile), verifyFile(verifyFile) {}

SecureWebSocketServer::~SecureWebSocketServer()
{
	stop();
}

void SecureWebSocketServer::send(const String& message)
{
	HashMap<String, std::shared_ptr<WssServer::Connection>>::Iterator it(connectionMap);
	while (it.next())
	{
		it.getValue()->send(message.toStdString());
	}
}

void SecureWebSocketServer::send(const char* data, int numData)
{
	std::shared_ptr<WssServer::OutMessage> out_message = std::make_shared<WssServer::OutMessage>();
	out_message->write(data, numData);
	HashMap<String, std::shared_ptr<WssServer::Connection>>::Iterator it(connectionMap);
	while (it.next())
	{
		it.getValue()->send(out_message, nullptr, 130); // 130 = binary
	}
}

void SecureWebSocketServer::sendTo(const String& message, const String& id)
{
	if (connectionMap.contains(id))
	{
		connectionMap[id]->send(message.toStdString());
	}
	else
	{
		DBG("[Dashboard] Websocket connection not found : " << id);
	}
}

void SecureWebSocketServer::sendTo(const MemoryBlock& data, const String& id)
{
	std::shared_ptr<WssServer::OutMessage> out_message = std::make_shared<WssServer::OutMessage>();
	out_message->write((const char*) data.getData(), data.getSize());
	if (connectionMap.contains(id))
	{
		connectionMap[id]->send(out_message, nullptr, 130); // 130 = binary
	}
	else
	{
		DBG("[Dashboard] Websocket connection not found : " << id);
	}
}

void SecureWebSocketServer::sendExclude(const String& message, const StringArray excludeIds)
{
	HashMap<String, std::shared_ptr<WssServer::Connection>>::Iterator it(connectionMap);
	while (it.next())
	{
		if (excludeIds.contains(it.getKey()))
		{
			continue;
		}
		it.getValue()->send(message.toStdString());
	}
}

void SecureWebSocketServer::sendExclude(const MemoryBlock& data, const StringArray excludeIds)
{
	std::shared_ptr<WssServer::OutMessage> out_message = std::make_shared<WssServer::OutMessage>();
	out_message->write((const char*) data.getData(), data.getSize());

	HashMap<String, std::shared_ptr<WssServer::Connection>>::Iterator it(connectionMap);
	while (it.next())
	{
		if (excludeIds.contains(it.getKey()))
		{
			continue;
		}
		it.getValue()->send(out_message, nullptr, 130); // 130 = binary
	}
}

void SecureWebSocketServer::stopInternal()
{
	if (ioService != nullptr)
	{
		ioService->stop();
	}

	ScopedLock lock(serverLock);

	if (ws != nullptr)
	{
		std::unordered_set<std::shared_ptr<WssServer::Connection>> connections = ws->get_connections();
		for (auto& c : connections)
		{
			c->send_close(1000, "Server destroyed");
		}
		connectionMap.clear();

		ws->stop();
	}

	if (http != nullptr)
	{
		http->stop();
	}

	ws.reset();
	http.reset();
	ioService.reset();
}

void SecureWebSocketServer::closeConnectionInternal(const String& id, int code, const String& reason)
{
	if (!connectionMap.contains(id))
	{
		return;
	}
	connectionMap[id]->send_close(code, reason.toStdString());
}

void SecureWebSocketServer::initServer()
{
	ScopedLock lock(serverLock);

	try
	{
		ioService = std::make_shared<asio::io_service>();

		http.reset(new HttpsServer(certFile.toStdString(), keyFile.toStdString(), verifyFile.toStdString()));
		http->config.port = port;
		http->io_service = ioService;

		http->default_resource["GET"] = std::bind(&SecureWebSocketServer::httpDefaultCallback, this, std::placeholders::_1, std::placeholders::_2);
		http->on_upgrade = std::bind(&SecureWebSocketServer::onHTTPUpgrade, this, std::placeholders::_1, std::placeholders::_2);

		// WebSocket init
		ws.reset(new WssServer(certFile.toStdString(), keyFile.toStdString(), verifyFile.toStdString()));
		// ws->config.timeout_idle = 1;
		ws->config.timeout_request = 2;

		auto& wsEndpoint = ws->endpoint[("^" + wsSuffix + "/?$").toStdString()];

		wsEndpoint.on_message = std::bind(&SecureWebSocketServer::onMessageCallback, this, std::placeholders::_1, std::placeholders::_2);
		wsEndpoint.on_error = std::bind(&SecureWebSocketServer::onErrorCallback, this, std::placeholders::_1, std::placeholders::_2);
		wsEndpoint.on_open = std::bind(&SecureWebSocketServer::onNewConnectionCallback, this, std::placeholders::_1);
		wsEndpoint.on_close = std::bind(&SecureWebSocketServer::onConnectionCloseCallback, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);

		http->config.timeout_request = 1;
		http->config.timeout_content = 2;
		http->config.max_request_streambuf_size = 1000000;
		http->config.thread_pool_size = 2;
		http->config.reuse_address = allowAddressReuse;
		http->start(std::bind(&SecureWebSocketServer::httpStartCallback, this, std::placeholders::_1));

		isConnected = true;
		isConnecting = false;
		webSocketListeners.call(&Listener::serverInitSuccess);

		if (ioService != nullptr)
		{
			ioService->run();
		}
	}
	catch (std::exception e)
	{
		DBG("Error init server " << e.what());
		webSocketListeners.call(&Listener::serverInitError, e.what());
	}
}

int SecureWebSocketServer::getNumActiveConnections() const
{
	return connectionMap.size();
}

String SecureWebSocketServer::getConnectionString(std::shared_ptr<WssServer::Connection> connection) const
{
	return String(connection->remote_endpoint().address().to_string()) + ":" + String(connection->remote_endpoint().port());
}

void SecureWebSocketServer::onMessageCallback(std::shared_ptr<WssServer::Connection> connection, std::shared_ptr<WssServer::InMessage> in_message)
{
	String id = getConnectionString(connection);
	if (in_message->fin_rsv_opcode == 129)
	{
		webSocketListeners.call(&Listener::messageReceived, id, String(in_message->string()));
	}
	else if (in_message->fin_rsv_opcode == 130)
	{
		webSocketListeners.call(&Listener::dataReceived, id, in_message->binary);
	}
	else if (in_message->fin_rsv_opcode == 136)
	{
		DBG("Connection ended for " << id);
	}
}

void SecureWebSocketServer::onNewConnectionCallback(std::shared_ptr<WssServer::Connection> connection)
{
	String id = getConnectionString(connection);
	connectionMap.set(id, connection);
	webSocketListeners.call(&Listener::connectionOpened, id);
}

void SecureWebSocketServer::onConnectionCloseCallback(std::shared_ptr<WssServer::Connection> connection, int status, const std::string& reason)
{
	String id = getConnectionString(connection);
	connectionMap.remove(id);
	webSocketListeners.call(&Listener::connectionClosed, id, status, reason);
}

void SecureWebSocketServer::onErrorCallback(std::shared_ptr<WssServer::Connection> connection, const SimpleWeb::error_code& ec)
{
	String id = getConnectionString(connection);
	connectionMap.remove(id);
	webSocketListeners.call(&Listener::connectionError, id, ec.message());
}

void SecureWebSocketServer::httpStartCallback(unsigned short _port)
{
	isConnected = port == _port;
}

void SecureWebSocketServer::onHTTPUpgrade(std::unique_ptr<SimpleWeb::HTTPS>& socket, std::shared_ptr<HttpsServer::Request> request)
{
	jassert(ws != nullptr);

	auto connection = std::make_shared<WssServer::Connection>(std::move(socket));
	connection->method = std::move(request->method);
	connection->path = std::move(request->path);
	connection->http_version = std::move(request->http_version);
	connection->header = std::move(request->header);
	ws->upgrade(connection);
}

void SecureWebSocketServer::httpDefaultCallback(std::shared_ptr<HttpsServer::Response> response, std::shared_ptr<HttpsServer::Request> request)
{
	for (auto& handler : handlers)
	{
		if (handler->handleHTTPSRequest(response, request))
		{
			return;
		}
	}

	if (rootPath.exists() && rootPath.isDirectory())
	{
		// String content = "";
		File f;
		String path = request->path.substr(1);
		if (path.isEmpty())
		{
			path = "index.html";
		}
		f = rootPath.getChildFile(path); // substr to remove the first "/"
		if (f.exists() && f.isDirectory())
		{
			f = f.getChildFile("index.html");
		}

		if (f.existsAsFile())
		{
			serveFile(f, response);
			return;
		}
		else
		{
			DBG("WebServer requested file not found : " << f.getFullPathName());
		}
	}

	*response << "HTTP/1.1 404 Not Found";
}

#endif