Merge pull request #100 from c-jimenez/dev/improve_websockets

c-jimenez · web-flow · commit 83c47128a700 · 2023-01-25T17:09:13.000+01:00
Improve websockets management
diff --git a/CMakeLists_Options.txt b/CMakeLists_Options.txt
@@ -8,6 +8,12 @@ if(NOT DEFINED LOG_LEVEL)
 endif()
 add_compile_definitions(LOG_LEVEL=${LOG_LEVEL})
 
+# Logger
+option(EXTERNAL_LOGGER      "Use an external logger"                OFF)
+if(EXTERNAL_LOGGER)
+    add_compile_definitions(EXTERNAL_LOGGER=1)
+endif()
+
 # Static library
 option(BUILD_STATIC_LIBRARY "Build Open OCPP as a static library"   ON)
 
diff --git a/examples/common/DefaultCentralSystemEventsHandler.cpp b/examples/common/DefaultCentralSystemEventsHandler.cpp
@@ -54,6 +54,13 @@ DefaultCentralSystemEventsHandler::~DefaultCentralSystemEventsHandler() { }
 
 // ICentralSystemEventsHandler interface
 
+/** @copydoc bool ICentralSystemEventsHandler::acceptConnection(const char*) */
+bool DefaultCentralSystemEventsHandler::acceptConnection(const char* ip_address)
+{
+    cout << "Accept connection from [" << ip_address << "]" << endl;
+    return true;
+}
+
 /** @copydoc bool ICentralSystemEventsHandler::checkCredentials(const std::string&, const std::string&) */
 bool DefaultCentralSystemEventsHandler::checkCredentials(const std::string& chargepoint_id, const std::string& password)
 {
diff --git a/examples/common/DefaultCentralSystemEventsHandler.h b/examples/common/DefaultCentralSystemEventsHandler.h
@@ -45,6 +45,9 @@ class DefaultCentralSystemEventsHandler : public ocpp::centralsystem::ICentralSy
 
     // ICentralSystemEventsHandler interface
 
+    /** @copydoc bool ICentralSystemEventsHandler::acceptConnection(const char*) */
+    bool acceptConnection(const char* ip_address) override;
+
     /** @copydoc bool ICentralSystemEventsHandler::checkCredentials(const std::string&, const std::string&) */
     bool checkCredentials(const std::string& chargepoint_id, const std::string& password) override;
 
diff --git a/examples/common/DefaultLocalControllerEventsHandler.cpp b/examples/common/DefaultLocalControllerEventsHandler.cpp
@@ -41,6 +41,13 @@ DefaultLocalControllerEventsHandler::~DefaultLocalControllerEventsHandler() { }
 
 // ILocalControllerEventsHandler interface
 
+/** @copydoc bool ILocalControllerEventsHandler::acceptConnection(const char*) */
+bool DefaultLocalControllerEventsHandler::acceptConnection(const char* ip_address)
+{
+    cout << "Accept connection from [" << ip_address << "]" << endl;
+    return true;
+}
+
 /** @copydoc bool ILocalControllerEventsHandler::checkCredentials(const std::string&, const std::string&) */
 bool DefaultLocalControllerEventsHandler::checkCredentials(const std::string& chargepoint_id, const std::string& password)
 {
diff --git a/examples/common/DefaultLocalControllerEventsHandler.h b/examples/common/DefaultLocalControllerEventsHandler.h
@@ -43,6 +43,9 @@ class DefaultLocalControllerEventsHandler : public ocpp::localcontroller::ILocal
 
     // ILocalControllerEventsHandler interface
 
+    /** @copydoc bool ILocalControllerEventsHandler::acceptConnection(const char*) */
+    bool acceptConnection(const char* ip_address) override;
+
     /** @copydoc bool ILocalControllerEventsHandler::checkCredentials(const std::string&, const std::string&) */
     bool checkCredentials(const std::string& chargepoint_id, const std::string& password) override;
 
diff --git a/src/centralsystem/CentralSystem.cpp b/src/centralsystem/CentralSystem.cpp
@@ -240,6 +240,14 @@ bool CentralSystem::stop()
     return ret;
 }
 
+/** @copydoc bool RpcServer::IListener::rpcAcceptConnection(const char*) */
+bool CentralSystem::rpcAcceptConnection(const char* ip_address)
+{
+    // Notify connection => no additional processing is done here
+    // to keep this callback has fast as possible
+    return m_events_handler.acceptConnection(ip_address);
+}
+
 /** @copydoc bool RpcServer::IListener::rpcCheckCredentials(const std::string&, const std::string&, const std::string&) */
 bool CentralSystem::rpcCheckCredentials(const std::string& chargepoint_id, const std::string& user, const std::string& password)
 {
diff --git a/src/centralsystem/CentralSystem.h b/src/centralsystem/CentralSystem.h
@@ -69,6 +69,9 @@ class CentralSystem : public ICentralSystem, public ocpp::rpc::RpcServer::IListe
 
     // RpcServer::IListener interface
 
+    /** @copydoc bool RpcServer::IListener::rpcAcceptConnection(const char*) */
+    bool rpcAcceptConnection(const char* ip_address) override;
+
     /** @copydoc bool RpcServer::IListener::rpcCheckCredentials(const std::string&, const std::string&, const std::string&) */
     bool rpcCheckCredentials(const std::string& chargepoint_id, const std::string& user, const std::string& password) override;
 
diff --git a/src/centralsystem/interface/ICentralSystemEventsHandler.h b/src/centralsystem/interface/ICentralSystemEventsHandler.h
@@ -33,6 +33,13 @@ class ICentralSystemEventsHandler
     /** @brief Destructor */
     virtual ~ICentralSystemEventsHandler() { }
 
+    /**
+     * @brief Called to accept an incoming connection
+     * @param ip_address IP address of the client
+     * @return true if the incoming connection must be accepted, false otherwise
+     */
+    virtual bool acceptConnection(const char* ip_address) = 0;
+
     /**
      * @brief Called to check the charge point credentials for HTTP basic authentication
      * @param chargepoint_id Charge Point identifier
diff --git a/src/localcontroller/LocalController.cpp b/src/localcontroller/LocalController.cpp
@@ -242,6 +242,14 @@ bool LocalController::stop()
     return ret;
 }
 
+/** @copydoc bool RpcServer::IListener::rpcAcceptConnection(const char*) */
+bool LocalController::rpcAcceptConnection(const char* ip_address)
+{
+    // Notify connection => no additional processing is done here
+    // to keep this callback has fast as possible
+    return m_events_handler.acceptConnection(ip_address);
+}
+
 /** @copydoc bool RpcServer::IListener::rpcCheckCredentials(const std::string&, const std::string&, const std::string&) */
 bool LocalController::rpcCheckCredentials(const std::string& chargepoint_id, const std::string& user, const std::string& password)
 {
diff --git a/src/localcontroller/LocalController.h b/src/localcontroller/LocalController.h
@@ -69,6 +69,9 @@ class LocalController : public ILocalController, public ocpp::rpc::RpcServer::IL
 
     // RpcServer::IListener interface
 
+    /** @copydoc bool RpcServer::IListener::rpcAcceptConnection(const char*) */
+    bool rpcAcceptConnection(const char* ip_address) override;
+
     /** @copydoc bool RpcServer::IListener::rpcCheckCredentials(const std::string&, const std::string&, const std::string&) */
     bool rpcCheckCredentials(const std::string& chargepoint_id, const std::string& user, const std::string& password) override;
 
diff --git a/src/localcontroller/interface/ILocalControllerEventsHandler.h b/src/localcontroller/interface/ILocalControllerEventsHandler.h
@@ -33,6 +33,13 @@ class ILocalControllerEventsHandler
     /** @brief Destructor */
     virtual ~ILocalControllerEventsHandler() { }
 
+    /**
+     * @brief Called to accept an incoming connection
+     * @param ip_address IP address of the client
+     * @return true if the incoming connection must be accepted, false otherwise
+     */
+    virtual bool acceptConnection(const char* ip_address) = 0;
+
     /**
      * @brief Called to check the charge point credentials for HTTP basic authentication
      * @param chargepoint_id Charge Point identifier
diff --git a/src/rpc/RpcBase.cpp b/src/rpc/RpcBase.cpp
@@ -88,7 +88,7 @@ bool RpcBase::call(const std::string&         action,
             std::stringstream expected_id;
             expected_id << m_transaction_id;
             std::shared_ptr<RpcMessage> rpc_message;
-            auto        wait_time   = std::chrono::steady_clock().now() + timeout;
+            auto                        wait_time = std::chrono::steady_clock().now() + timeout;
             do
             {
                 // Compute timeout
@@ -179,8 +179,11 @@ void RpcBase::stop()
     // Check if already started
     if (m_rx_thread)
     {
-        // Stop reception thread
+        // Stop queues
+        m_results_queue.setEnable(false);
         m_requests_queue.setEnable(false);
+
+        // Stop reception thread
         m_rx_thread->join();
         delete m_rx_thread;
         m_rx_thread = nullptr;
@@ -313,7 +316,7 @@ bool RpcBase::decodeCall(const std::string&      unique_id,
     {
         // Add request to the queue
         auto msg = std::make_shared<RpcMessage>(unique_id, action.GetString(), rpc_frame, payload);
-        m_requests_queue.push(msg);
+        m_requests_queue.push(std::move(msg));
 
         ret = true;
     }
@@ -331,7 +334,7 @@ bool RpcBase::decodeCallResult(const std::string& unique_id, rapidjson::Document
     {
         // Add result to the queue
         auto msg = std::make_shared<RpcMessage>(unique_id, rpc_frame, payload);
-        m_results_queue.push(msg);
+        m_results_queue.push(std::move(msg));
 
         ret = true;
     }
@@ -353,7 +356,7 @@ bool RpcBase::decodeCallError(const std::string&   unique_id,
     {
         // Add error to the queue
         auto msg = std::make_shared<RpcMessage>(unique_id, rpc_frame, payload, &error, &message);
-        m_results_queue.push(msg);
+        m_results_queue.push(std::move(msg));
 
         ret = true;
     }
diff --git a/src/rpc/RpcServer.cpp b/src/rpc/RpcServer.cpp
@@ -84,6 +84,12 @@ void RpcServer::registerServerListener(IListener& listener)
 
 // IWebsocketServer::IListener interface
 
+/** @copydoc bool IWebsocketServer::IListener::wsAcceptConnection(const char*) */
+bool RpcServer::wsAcceptConnection(const char* ip_address)
+{
+    return m_listener->rpcAcceptConnection(ip_address);
+}
+
 /** @copydoc bool IWebsocketServer::IListener::wsCheckCredentials(const char*, const std::string&, const std::string&) */
 bool RpcServer::wsCheckCredentials(const char* uri, const std::string& user, const std::string& password)
 {
diff --git a/src/rpc/RpcServer.h b/src/rpc/RpcServer.h
@@ -66,6 +66,9 @@ class RpcServer : public ocpp::websockets::IWebsocketServer::IListener
 
     // IWebsocketServer::IListener interface
 
+    /** @copydoc bool IWebsocketServer::IListener::wsAcceptConnection(const char*) */
+    bool wsAcceptConnection(const char* ip_address) override;
+
     /** @copydoc bool IWebsocketServer::IListener::wsCheckCredentials(const char*, const std::string&, const std::string&) */
     bool wsCheckCredentials(const char* uri, const std::string& user, const std::string& password) override;
 
@@ -82,6 +85,13 @@ class RpcServer : public ocpp::websockets::IWebsocketServer::IListener
         /** @brief Destructor */
         virtual ~IListener() { }
 
+        /**
+         * @brief Called to accept an incoming connection
+         * @param ip_address IP address of the client
+         * @return true if the incoming connection must be accepted, false otherwise
+         */
+        virtual bool rpcAcceptConnection(const char* ip_address) = 0;
+
         /**
          * @brief Called to check the user credentials for HTTP basic authentication
          * @param chargepoint_id Charge Point identifier
diff --git a/src/tools/log/Logger.cpp b/src/tools/log/Logger.cpp
@@ -103,5 +103,47 @@ void Logger::registerLogger(ocpp::database::Database& database, const std::strin
     }
 }
 
+/** @brief External logging function */
+std::function<void(unsigned int, const std::string&)> ExtLogger::m_log_function = [](unsigned int level, const std::string& log_line)
+{
+    // Default function if no external logger has been registered
+    static std::mutex mutex;
+
+    std::time_t                 now = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());
+    std::lock_guard<std::mutex> lock(mutex);
+
+    std::tm now_tm;
+    localtime_r(&now, &now_tm);
+    LOG_OUTPUT << level << " - [" << std::put_time(&now_tm, "%Y-%m-%dT%T") << "] - " << log_line << std::endl;
+};
+
+/** @brief Constructor */
+ExtLogger::ExtLogger(const char* level_str, unsigned int level, const char* filename, const char* line) : m_log_output(), m_level(level)
+{
+    (void)level_str;
+    m_log_output << filename << ":" << line << " - ";
+}
+
+/** @brief Constructor */
+ExtLogger::ExtLogger(const char* name, const char* level_str, unsigned int level, const char* filename, const char* line)
+    : m_log_output(), m_level(level)
+{
+    (void)name;
+    (void)level_str;
+    m_log_output << filename << ":" << line << " - ";
+}
+
+/** @brief Destructor */
+ExtLogger::~ExtLogger()
+{
+    m_log_function(m_level, m_log_output.str());
+}
+
+/** @brief Register an external logging function */
+void ExtLogger::registerLogFunction(std::function<void(unsigned int, const std::string&)> log_function)
+{
+    m_log_function = log_function;
+}
+
 } // namespace log
 } // namespace ocpp
diff --git a/src/tools/log/Logger.h b/src/tools/log/Logger.h
diff --git a/src/websockets/IWebsocketServer.h b/src/websockets/IWebsocketServer.h
diff --git a/src/websockets/libwebsockets/LibWebsocketClient.cpp b/src/websockets/libwebsockets/LibWebsocketClient.cpp
diff --git a/src/websockets/libwebsockets/LibWebsocketServer.cpp b/src/websockets/libwebsockets/LibWebsocketServer.cpp
diff --git a/tests/deploy/main.cpp b/tests/deploy/main.cpp
diff --git a/tests/tools/test_logs.cpp b/tests/tools/test_logs.cpp

Original file line number	Diff line number	Diff line change
`@@ -240,6 +240,14 @@ bool CentralSystem::stop()`
`240`	`240`	`return ret;`
`241`	`241`	`}`
`242`	`242`
	`243`	`+/** @copydoc bool RpcServer::IListener::rpcAcceptConnection(const char) /`
	`244`	`+bool CentralSystem::rpcAcceptConnection(const char* ip_address)`
	`245`	`+{`
	`246`	`+ // Notify connection => no additional processing is done here`
	`247`	`+ // to keep this callback has fast as possible`
	`248`	`+ return m_events_handler.acceptConnection(ip_address);`
	`249`	`+}`
	`250`	`+`
`243`	`251`	`/** @copydoc bool RpcServer::IListener::rpcCheckCredentials(const std::string&, const std::string&, const std::string&) */`
`244`	`252`	`bool CentralSystem::rpcCheckCredentials(const std::string& chargepoint_id, const std::string& user, const std::string& password)`
`245`	`253`	`{`
Original file line number	Diff line number	Diff line change
`@@ -242,6 +242,14 @@ bool LocalController::stop()`
`242`	`242`	`return ret;`
`243`	`243`	`}`
`244`	`244`
	`245`	`+/** @copydoc bool RpcServer::IListener::rpcAcceptConnection(const char) /`
	`246`	`+bool LocalController::rpcAcceptConnection(const char* ip_address)`
	`247`	`+{`
	`248`	`+ // Notify connection => no additional processing is done here`
	`249`	`+ // to keep this callback has fast as possible`
	`250`	`+ return m_events_handler.acceptConnection(ip_address);`
	`251`	`+}`
	`252`	`+`
`245`	`253`	`/** @copydoc bool RpcServer::IListener::rpcCheckCredentials(const std::string&, const std::string&, const std::string&) */`
`246`	`254`	`bool LocalController::rpcCheckCredentials(const std::string& chargepoint_id, const std::string& user, const std::string& password)`
`247`	`255`	`{`