Adds template libs

2024-04-22 21:07:56 +02:00
parent 0724705939
commit b804b9df1f
126 changed files with 57429 additions and 13 deletions
@@ -0,0 +1,163 @@
+#ifndef WebSocketServer_h
+#define WebSocketServer_h
+
+/**
+ *   ESP32 SvelteKit
+ *
+ *   A simple, secure and extensible framework for IoT projects for ESP32 platforms
+ *   with responsive Sveltekit front-end built with TailwindCSS and DaisyUI.
+ *   https://github.com/theelims/ESP32-sveltekit
+ *
+ *   Copyright (C) 2018 - 2023 rjwats
+ *   Copyright (C) 2023 theelims
+ *
+ *   All Rights Reserved. This software may be modified and distributed under
+ *   the terms of the LGPL v3 license. See the LICENSE file for details.
+ **/
+
+#include <StatefulService.h>
+#include <PsychicHttp.h>
+#include <SecurityManager.h>
+
+#define WEB_SOCKET_CLIENT_ID_MSG_SIZE 128
+
+#define WEB_SOCKET_ORIGIN "wsserver"
+#define WEB_SOCKET_ORIGIN_CLIENT_ID_PREFIX "wsserver:"
+
+template <class T>
+class WebSocketServer
+{
+public:
+    WebSocketServer(JsonStateReader<T> stateReader,
+                    JsonStateUpdater<T> stateUpdater,
+                    StatefulService<T> *statefulService,
+                    PsychicHttpServer *server,
+                    const char *webSocketPath,
+                    SecurityManager *securityManager,
+                    AuthenticationPredicate authenticationPredicate = AuthenticationPredicates::IS_ADMIN,
+                    size_t bufferSize = DEFAULT_BUFFER_SIZE) : _stateReader(stateReader),
+                                                               _stateUpdater(stateUpdater),
+                                                               _statefulService(statefulService),
+                                                               _server(server),
+                                                               _bufferSize(bufferSize),
+                                                               _webSocketPath(webSocketPath),
+                                                               _authenticationPredicate(authenticationPredicate),
+                                                               _securityManager(securityManager)
+    {
+        _statefulService->addUpdateHandler(
+            [&](const String &originId)
+            { transmitData(nullptr, originId); },
+            false);
+    }
+
+    void begin()
+    {
+        _webSocket.setFilter(_securityManager->filterRequest(_authenticationPredicate));
+        _webSocket.onOpen(std::bind(&WebSocketServer::onWSOpen,
+                                    this,
+                                    std::placeholders::_1));
+        _webSocket.onClose(std::bind(&WebSocketServer::onWSClose,
+                                     this,
+                                     std::placeholders::_1));
+        _webSocket.onFrame(std::bind(&WebSocketServer::onWSFrame,
+                                     this,
+                                     std::placeholders::_1,
+                                     std::placeholders::_2));
+        _server->on(_webSocketPath.c_str(), &_webSocket);
+
+        ESP_LOGV("WebSocketServer", "Registered WebSocket handler: %s", _webSocketPath.c_str());
+    }
+
+    void onWSOpen(PsychicWebSocketClient *client)
+    {
+
+        // when a client connects, we transmit it's id and the current payload
+        transmitId(client);
+        transmitData(client, WEB_SOCKET_ORIGIN);
+        ESP_LOGI("WebSocketServer", "ws[%s][%u] connect", client->remoteIP().toString().c_str(), client->socket());
+    }
+
+    void onWSClose(PsychicWebSocketClient *client)
+    {
+        ESP_LOGI("WebSocketServer", "ws[%s][%u] disconnect", client->remoteIP().toString().c_str(), client->socket());
+    }
+
+    esp_err_t onWSFrame(PsychicWebSocketRequest *request, httpd_ws_frame *frame)
+    {
+        ESP_LOGV("WebSocketServer", "ws[%s][%u] opcode[%d]", request->client()->remoteIP().toString().c_str(), request->client()->socket(), frame->type);
+
+        if (frame->type == HTTPD_WS_TYPE_TEXT)
+        {
+            ESP_LOGV("WebSocketServer", "ws[%s][%u] request: %s", request->client()->remoteIP().toString().c_str(), request->client()->socket(), (char *)frame->payload);
+
+            DynamicJsonDocument jsonDocument = DynamicJsonDocument(_bufferSize);
+            DeserializationError error = deserializeJson(jsonDocument, (char *)frame->payload, frame->len);
+
+            if (!error && jsonDocument.is<JsonObject>())
+            {
+                JsonObject jsonObject = jsonDocument.as<JsonObject>();
+                _statefulService->update(jsonObject, _stateUpdater, clientId(request->client()));
+                return ESP_OK;
+            }
+        }
+        return ESP_OK;
+    }
+
+    String clientId(PsychicWebSocketClient *client)
+    {
+        return WEB_SOCKET_ORIGIN_CLIENT_ID_PREFIX + String(client->socket());
+    }
+
+private:
+    JsonStateReader<T> _stateReader;
+    JsonStateUpdater<T> _stateUpdater;
+    StatefulService<T> *_statefulService;
+    AuthenticationPredicate _authenticationPredicate;
+    SecurityManager *_securityManager;
+    PsychicHttpServer *_server;
+    PsychicWebSocketHandler _webSocket;
+    String _webSocketPath;
+    size_t _bufferSize;
+
+    void transmitId(PsychicWebSocketClient *client)
+    {
+        DynamicJsonDocument jsonDocument = DynamicJsonDocument(WEB_SOCKET_CLIENT_ID_MSG_SIZE);
+        JsonObject root = jsonDocument.to<JsonObject>();
+        root["type"] = "id";
+        root["id"] = clientId(client);
+
+        // serialize the json to a string
+        String buffer;
+        serializeJson(jsonDocument, buffer);
+        client->sendMessage(buffer.c_str());
+    }
+
+    /**
+     * Broadcasts the payload to the destination, if provided. Otherwise broadcasts to all clients except the origin, if
+     * specified.
+     *
+     * Original implementation sent clients their own IDs so they could ignore updates they initiated. This approach
+     * simplifies the client and the server implementation but may not be sufficient for all use-cases.
+     */
+    void transmitData(PsychicWebSocketClient *client, const String &originId)
+    {
+        DynamicJsonDocument jsonDocument = DynamicJsonDocument(_bufferSize);
+        JsonObject root = jsonDocument.to<JsonObject>();
+        String buffer;
+
+        _statefulService->read(root, _stateReader);
+
+        // serialize the json to a string
+        serializeJson(jsonDocument, buffer);
+        if (client)
+        {
+            client->sendMessage(buffer.c_str());
+        }
+        else
+        {
+            _webSocket.sendAll(buffer.c_str());
+        }
+    }
+};
+
+#endif