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

internal/frontend/bridge-gui/bridge-gui/CommandLine.cpp

@@ -19,6 +19,7 @@
 #include "Pch.h"
 #include "CommandLine.h"
 #include "Settings.h"
+#include <bridgepp/SessionID/SessionID.h>
 
 
 using namespace bridgepp;
@@ -142,5 +143,12 @@ CommandLineOptions parseCommandLine(int argc, char *argv[]) {
 
     options.logLevel = parseLogLevel(argc, argv);
 
+    options.sessionID = parseGoCLIStringArgument(argc, argv, { "session-id" });
+    if (options.sessionID.isEmpty()) {
+        options.sessionID = newSessionID();
+        options.bridgeArgs.append("--session-id");
+        options.bridgeArgs.append(options.sessionID);
+    }
+
     return options;
 }

internal/frontend/bridge-gui/bridge-gui/CommandLine.h

@@ -34,6 +34,7 @@ struct CommandLineOptions {
     bridgepp::Log::Level logLevel { bridgepp::Log::defaultLevel }; ///< The log level
     bool noWindow { false }; ///< Should the application start without displaying the main window?
     bool useSoftwareRenderer { false }; ///< Should QML be renderer in software (i.e. without rendering hardware interface).
+    QString sessionID; ///< The sessionID.
 };
 
 

internal/frontend/bridge-gui/bridge-gui/LogUtils.cpp

@@ -19,7 +19,6 @@
 #include "LogUtils.h"
 #include "BuildConfig.h"
 #include <bridgepp/Log/LogUtils.h>
-#include <bridgepp/BridgeUtils.h>
 
 
 using namespace bridgepp;
@@ -28,7 +27,7 @@ using namespace bridgepp;
 //****************************************************************************************************************************************************
 /// \return A reference to the log.
 //****************************************************************************************************************************************************
-Log &initLog() {
+Log &initLog(QString const &sessionID) {
     Log &log = app().log();
     log.registerAsQtMessageHandler();
     log.setEchoInConsole(true);
@@ -41,7 +40,7 @@ Log &initLog() {
 
     // create new GUI log file
     QString error;
-    if (!log.startWritingToFile(logsDir.absoluteFilePath(QString("gui_v%1_%2.log").arg(PROJECT_VER).arg(QDateTime::currentSecsSinceEpoch())), &error)) {
+    if (!log.startWritingToFile(logsDir.absoluteFilePath(QString("%1_000_gui_v%2_%3.log").arg(sessionID, PROJECT_VER, PROJECT_TAG)), &error)) {
         log.error(error);
     }
 

internal/frontend/bridge-gui/bridge-gui/LogUtils.h

@@ -23,7 +23,7 @@
 #include <bridgepp/Log/Log.h>
 
 
-bridgepp::Log &initLog(); ///< Initialize the application log.
+bridgepp::Log &initLog(QString const &sessionID); ///< Initialize the application log.
 
 
 #endif //BRIDGE_GUI_LOG_UTILS_H

internal/frontend/bridge-gui/bridge-gui/main.cpp

@@ -286,7 +286,8 @@ int main(int argc, char *argv[]) {
 
         initQtApplication();
 
-        Log &log = initLog();
+        CommandLineOptions const cliOptions = parseCommandLine(argc, argv);
+        Log &log = initLog(cliOptions.sessionID);
 
         QLockFile lock(bridgepp::userCacheDir() + "/" + bridgeGUILock);
         if (!checkSingleInstance(lock)) {
@@ -294,8 +295,6 @@ int main(int argc, char *argv[]) {
             return EXIT_FAILURE;
         }
 
-        CommandLineOptions const cliOptions = parseCommandLine(argc, argv);
-
 #ifdef Q_OS_MACOS
         registerSecondInstanceHandler();
         setDockIconVisibleState(!cliOptions.noWindow);

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