feat(GODT-2666): feat(GODT-2667): introduce sessionID in bridge.

internal/frontend/bridge-gui/bridgepp/CMakeLists.txt

@@ -32,9 +32,9 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 if (NOT DEFINED BRIDGE_APP_VERSION)
     message(FATAL_ERROR "BRIDGE_APP_VERSION is not defined.")
-else()
+else ()
     message(STATUS "Bridge version is ${BRIDGE_APP_VERSION}")
-endif()
+endif ()
 
 
 #****************************************************************************************************************************************************
@@ -148,6 +148,7 @@ add_library(bridgepp
     bridgepp/Log/Log.h bridgepp/Log/Log.cpp
     bridgepp/Log/LogUtils.h bridgepp/Log/LogUtils.cpp
     bridgepp/ProcessMonitor.cpp bridgepp/ProcessMonitor.h
+    bridgepp/SessionID/SessionID.cpp bridgepp/SessionID/SessionID.h
     bridgepp/User/User.cpp bridgepp/User/User.h
     bridgepp/Worker/Worker.h bridgepp/Worker/Overseer.h bridgepp/Worker/Overseer.cpp)
 
@@ -167,7 +168,7 @@ target_precompile_headers(bridgepp PRIVATE Pch.h)
 
 if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
     cmake_policy(SET CMP0135 NEW) # avoid warning DOWNLOAD_EXTRACT_TIMESTAMP
-endif()
+endif ()
 
 include(FetchContent)
 FetchContent_Declare(
@@ -188,7 +189,9 @@ enable_testing()
 add_executable(bridgepp-test EXCLUDE_FROM_ALL
     Test/TestBridgeUtils.cpp
     Test/TestException.cpp
-    Test/TestWorker.cpp Test/TestWorker.h)
+    Test/TestSessionID.cpp
+    Test/TestWorker.cpp Test/TestWorker.h
+    )
 add_dependencies(bridgepp-test bridgepp)
 target_precompile_headers(bridgepp-test PRIVATE Pch.h)
 target_link_libraries(bridgepp-test

internal/frontend/bridge-gui/bridgepp/Test/TestSessionID.cpp

@@ -0,0 +1,36 @@
+// Copyright (c) 2023 Proton AG
+//
+// This file is part of Proton Mail Bridge.
+//
+// Proton Mail Bridge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Proton Mail Bridge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Proton Mail Bridge. If not, see <https://www.gnu.org/licenses/>.
+
+
+#include "QtCore/qdatetime.h"
+#include <gtest/gtest.h>
+#include <bridgepp/SessionID/SessionID.h>
+
+
+using namespace bridgepp;
+
+
+TEST(SessionID, SessionID) {
+    QString const sessionID = newSessionID();
+    EXPECT_TRUE(sessionID.size() > 0);
+
+    EXPECT_FALSE(sessionIDToDateTime("invalidSessionID").isValid());
+
+    QDateTime const dateTime = sessionIDToDateTime(sessionID);
+    EXPECT_TRUE(dateTime.isValid());
+    EXPECT_TRUE(qAbs(dateTime.secsTo(QDateTime::currentDateTime())) < 5);
+}

internal/frontend/bridge-gui/bridgepp/bridgepp/SessionID/SessionID.cpp

@@ -0,0 +1,53 @@
+// Copyright (c) 2023 Proton AG
+//
+// This file is part of Proton Mail Bridge.
+//
+// Proton Mail Bridge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Proton Mail Bridge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Proton Mail Bridge. If not, see <https://www.gnu.org/licenses/>.
+
+
+#include "SessionID.h"
+#include "QtCore/qdatetime.h"
+
+
+namespace {
+
+
+QString const dateTimeFormat = "yyyyMMdd_hhmmsszzz"; ///< The format string for date/time used by the sessionID.
+
+
+}
+
+
+namespace bridgepp {
+
+
+//****************************************************************************************************************************************************
+/// \return a new session ID based on the current local date/time
+//****************************************************************************************************************************************************
+QString newSessionID() {
+    return QDateTime::currentDateTime().toString(dateTimeFormat);
+}
+
+
+//****************************************************************************************************************************************************
+/// \param[in] sessionID The sessionID.
+/// \return The date/time corresponding to the sessionID.
+/// \return An invalid date/time if an error occurs.
+//****************************************************************************************************************************************************
+QDateTime sessionIDToDateTime(QString const &sessionID) {
+    return QDateTime::fromString(sessionID, dateTimeFormat);
+}
+
+
+} // namespace

internal/frontend/bridge-gui/bridgepp/bridgepp/SessionID/SessionID.h

@@ -0,0 +1,32 @@
+// Copyright (c) 2023 Proton AG
+//
+// This file is part of Proton Mail Bridge.
+//
+// Proton Mail Bridge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Proton Mail Bridge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Proton Mail Bridge. If not, see <https://www.gnu.org/licenses/>.
+
+
+#ifndef BRIDGE_PP_SESSION_ID_H
+#define BRIDGE_PP_SESSION_ID_H
+
+
+namespace bridgepp {
+
+
+QString newSessionID(); ///< Create a new sessions
+QDateTime sessionIDToDateTime(QString const &sessionID); ///< Parse the date/time from a sessionID.
+
+
+} // namespace
+
+#endif //BRIDGE_PP_SESSION_ID_H