chore: merge branch release/perth_narrows to devel

2025-12-23 02:26:42 +00:00 · 2023-02-15 13:13:08 +01:00
parent d7fd39503f 08dab2d115
commit 249658c05b
126 changed files with 4339 additions and 1484 deletions
--- a/internal/frontend/bridge-gui/bridge-gui/BuildConfig.h.in
+++ b/internal/frontend/bridge-gui/bridge-gui/BuildConfig.h.in
@ -24,5 +24,7 @@
 #define PROJECT_VER         "@BRIDGE_APP_VERSION@"
 #define PROJECT_REVISION    "@BRIDGE_REVISION@"
 #define PROJECT_BUILD_TIME  "@BRIDGE_BUILD_TIME@"
+#define PROJECT_DSN_SENTRY  "@BRIDGE_DSN_SENTRY@"
+#define PROJECT_BUILD_ENV   "@BRIDGE_BUILD_ENV@"

 #endif // BRIDGE_GUI_VERSION_H
--- a/internal/frontend/bridge-gui/bridge-gui/CMakeLists.txt
+++ b/internal/frontend/bridge-gui/bridge-gui/CMakeLists.txt
@ -85,20 +85,12 @@ message(STATUS "Using Qt ${Qt6_VERSION}")
 #*****************************************************************************************************************************************************
 find_package(sentry CONFIG REQUIRED)

-set(DSN_SENTRY "https://ea31dfe8574849108fb8ba044fec3620@api.protonmail.ch/core/v4/reports/sentry/7")
-set(SENTRY_CONFIG_GENERATED_FILE_DIR ${CMAKE_CURRENT_BINARY_DIR}/sentry-generated)
-set(SENTRY_CONFIG_FILE ${SENTRY_CONFIG_GENERATED_FILE_DIR}/project_sentry_config.h)
-file(GENERATE OUTPUT ${SENTRY_CONFIG_FILE} CONTENT
-    "// AUTO GENERATED FILE, DO NOT MODIFY\n#pragma once\nconst char* SentryDNS=\"${DSN_SENTRY}\";\nconst char* SentryProductID=\"bridge-mail@${BRIDGE_APP_VERSION}\";\n"
-)
-
-

 #*****************************************************************************************************************************************************
 # Source files and output
 #*****************************************************************************************************************************************************

-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Version.h.in ${CMAKE_CURRENT_SOURCE_DIR}/Version.h)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/BuildConfig.h.in ${CMAKE_CURRENT_SOURCE_DIR}/BuildConfig.h)

 if (NOT TARGET bridgepp)
    add_subdirectory(../bridgepp bridgepp)
@ -122,7 +114,7 @@ add_executable(bridge-gui
    EventStreamWorker.cpp EventStreamWorker.h
    main.cpp
    Pch.h
-    Version.h
+    BuildConfig.h
    QMLBackend.cpp QMLBackend.h
    UserList.cpp UserList.h
    SentryUtils.cpp SentryUtils.h
--- a/internal/frontend/bridge-gui/bridge-gui/QMLBackend.cpp
+++ b/internal/frontend/bridge-gui/bridge-gui/QMLBackend.cpp
@ -18,7 +18,7 @@

 #include "QMLBackend.h"
 #include "EventStreamWorker.h"
-#include "Version.h"
+#include "BuildConfig.h"
 #include <bridgepp/GRPC/GRPCClient.h>
 #include <bridgepp/Exception/Exception.h>
 #include <bridgepp/Worker/Overseer.h>
@ -467,6 +467,7 @@ bool QMLBackend::isDoHEnabled() const {
    )
 }

+
 //****************************************************************************************************************************************************
 /// \return The value for the 'isAutomaticUpdateOn' property.
 //****************************************************************************************************************************************************
@ -875,8 +876,9 @@ void QMLBackend::onLoginAlreadyLoggedIn(QString const &userID) {
 void QMLBackend::onUserBadEvent(QString const &userID, QString const &errorMessage) {
    HANDLE_EXCEPTION(
        SPUser const user = users_->getUserWithID(userID);
-        if (!user)
+        if (!user) {
            app().log().error(QString("Received bad event for unknown user %1").arg(user->id()));
+        }
        user->setState(UserState::SignedOut);
        emit userBadEvent(
            tr("Internal error: %1 was automatically logged out. Please log in again or report this problem if the issue persists.").arg(user->primaryEmailOrUsername()),
@ -888,6 +890,24 @@ void QMLBackend::onUserBadEvent(QString const &userID, QString const &errorMessa
 }


+//****************************************************************************************************************************************************
+/// \param[in] username The username (or primary email address)
+//****************************************************************************************************************************************************
+void QMLBackend::onIMAPLoginFailed(QString const &username) {
+    HANDLE_EXCEPTION(
+        SPUser const user = users_->getUserWithUsernameOrEmail(username);
+        if ((!user) || (user->state() != UserState::SignedOut)) { // We want to pop-up only if a signed-out user has been detected
+            return;
+        }
+        if (user->isInIMAPLoginFailureCooldown())
+            return;
+        user->startImapLoginFailureCooldown(60 * 60 * 1000); // 1 hour cooldown during which we will not display this notification to this user again.
+        emit selectUser(user->id());
+        emit imapLoginWhileSignedOut(username);
+    )
+}
+
+
 //****************************************************************************************************************************************************
 //
 //****************************************************************************************************************************************************
@ -996,5 +1016,7 @@ void QMLBackend::connectGrpcEvents() {
    // user events
    connect(client, &GRPCClient::userDisconnected, this, &QMLBackend::userDisconnected);
    connect(client, &GRPCClient::userBadEvent, this, &QMLBackend::onUserBadEvent);
+    connect(client, &GRPCClient::imapLoginFailed, this, &QMLBackend::onIMAPLoginFailed);
+
    users_->connectGRPCEvents();
 }
--- a/internal/frontend/bridge-gui/bridge-gui/QMLBackend.h
+++ b/internal/frontend/bridge-gui/bridge-gui/QMLBackend.h
@ -21,7 +21,7 @@


 #include "MacOS/DockIcon.h"
-#include "Version.h"
+#include "BuildConfig.h"
 #include "UserList.h"
 #include <bridgepp/GRPC/GRPCClient.h>
 #include <bridgepp/GRPC/GRPCUtils.h>
@ -180,6 +180,7 @@ public slots: // slot for signals received from gRPC that need transformation in
    void onLoginFinished(QString const &userID, bool wasSignedOut); ///< Slot for LoginFinished gRPC event.
    void onLoginAlreadyLoggedIn(QString const &userID); ///< Slot for the LoginAlreadyLoggedIn gRPC event.
    void onUserBadEvent(QString const& userID, QString const& errorMessage); ///< Slot for the userBadEvent gRPC event.
+    void onIMAPLoginFailed(QString const& username); ///< Slot the the imapLoginFailed event.

 signals: // Signals received from the Go backend, to be forwarded to QML
    void toggleAutostartFinished(); ///< Signal for the 'toggleAutostartFinished' gRPC stream event.
@ -233,6 +234,7 @@ signals: // Signals received from the Go backend, to be forwarded to QML
    void hideMainWindow(); ///< Signal for the 'hideMainWindow' gRPC stream event.
    void genericError(QString const &title, QString const &description); ///< Signal for the 'genericError' gRPC stream event.
    void selectUser(QString const); ///< Signal that request the given user account to be displayed.
+    void imapLoginWhileSignedOut(QString const& username); ///< Signal for the notification of IMAP login attempt on a signed out account.

    // This signal is emitted when an exception is intercepted is calls triggered by QML. QML engine would intercept the exception otherwise.
    void fatalError(QString const &function, QString const &message) const; ///< Signal emitted when an fatal error occurs.
--- a/internal/frontend/bridge-gui/bridge-gui/SentryUtils.cpp
+++ b/internal/frontend/bridge-gui/bridge-gui/SentryUtils.cpp
@ -16,7 +16,7 @@
 // along with Proton Mail Bridge. If not, see <https://www.gnu.org/licenses/>.

 #include "SentryUtils.h"
-#include "Version.h"
+#include "BuildConfig.h"
 #include <bridgepp/BridgeUtils.h>

 #include <QByteArray>
@ -31,13 +31,39 @@ QByteArray getProtectedHostname() {
    return hostname.toHex();
 }

+QString getApiOS() {
+#if defined(Q_OS_DARWIN)
+    return "macos";
+#elif defined(Q_OS_WINDOWS)
+    return "windows";
+#else
+    return "linux";
+#endif
+}
+
+QString appVersion(const QString& version) {
+    return QString("%1-bridge@%2").arg(getApiOS()).arg(version);
+}
+
 void setSentryReportScope() {
    sentry_set_tag("OS", bridgepp::goos().toUtf8());
    sentry_set_tag("Client", PROJECT_FULL_NAME);
-    sentry_set_tag("Version",   PROJECT_VER);
-    sentry_set_tag("UserAgent", QString("/ (%1)").arg(bridgepp::goos()).toUtf8());
-    sentry_set_tag("HostArch",  QSysInfo::currentCpuArchitecture().toUtf8());
-    sentry_set_tag("server_name",  getProtectedHostname());
+    sentry_set_tag("Version", QByteArray(PROJECT_REVISION).toHex());
+    sentry_set_tag("HostArch", QSysInfo::currentCpuArchitecture().toUtf8());
+    sentry_set_tag("server_name", getProtectedHostname());
+}
+
+sentry_options_t* newSentryOptions(const char *sentryDNS, const char *cacheDir) {
+    sentry_options_t *sentryOptions = sentry_options_new();
+    sentry_options_set_dsn(sentryOptions, sentryDNS);
+    sentry_options_set_database_path(sentryOptions, cacheDir);
+    sentry_options_set_release(sentryOptions, appVersion(PROJECT_VER).toUtf8());
+    sentry_options_set_max_breadcrumbs(sentryOptions, 50);
+    sentry_options_set_environment(sentryOptions, PROJECT_BUILD_ENV);
+    // Enable this for debugging sentry.
+    // sentry_options_set_debug(sentryOptions, 1);
+
+    return sentryOptions;
 }

 sentry_uuid_t reportSentryEvent(sentry_level_t level, const char *message) {
@ -51,3 +77,5 @@ sentry_uuid_t reportSentryException(sentry_level_t level, const char *message, c
    sentry_event_add_exception(event, sentry_value_new_exception(exceptionType, exception));
    return sentry_capture_event(event);
 }
+
+
--- a/internal/frontend/bridge-gui/bridge-gui/SentryUtils.h
+++ b/internal/frontend/bridge-gui/bridge-gui/SentryUtils.h
@ -22,6 +22,7 @@
 #include <sentry.h>

 void setSentryReportScope();
+sentry_options_t* newSentryOptions(const char * sentryDNS, const char * cacheDir);
 sentry_uuid_t reportSentryEvent(sentry_level_t level, const char *message);
 sentry_uuid_t reportSentryException(sentry_level_t level, const char *message, const char *exceptionType, const char *exception);

--- a/internal/frontend/bridge-gui/bridge-gui/UserList.cpp
+++ b/internal/frontend/bridge-gui/bridge-gui/UserList.cpp
@ -38,6 +38,7 @@ void UserList::connectGRPCEvents() const {
    GRPCClient &client = app().grpc();
    connect(&client, &GRPCClient::userChanged, this, &UserList::onUserChanged);
    connect(&client, &GRPCClient::toggleSplitModeFinished, this, &UserList::onToggleSplitModeFinished);
+    connect(&client, &GRPCClient::usedBytesChanged, this, &UserList::onUsedBytesChanged);
 }


@ -148,6 +149,19 @@ bridgepp::SPUser UserList::getUserWithID(QString const &userID) const {
 }


+//****************************************************************************************************************************************************
+/// \param[in] username The username or email.
+/// \return The user with the given ID.
+/// \return A null pointer if the user could not be found.
+//****************************************************************************************************************************************************
+bridgepp::SPUser UserList::getUserWithUsernameOrEmail(QString const &username) const {
+    QList<SPUser>::const_iterator it = std::find_if(users_.begin(), users_.end(), [username](SPUser const &user) -> bool {
+        return user && ((username.compare(user->username(), Qt::CaseInsensitive) == 0) || user->addresses().contains(username, Qt::CaseInsensitive));
+    });
+    return (it == users_.end()) ? nullptr : *it;
+}
+
+
 //****************************************************************************************************************************************************
 /// \param[in] row The row.
 //****************************************************************************************************************************************************
@ -223,3 +237,17 @@ void UserList::onToggleSplitModeFinished(QString const &userID) {
 int UserList::count() const {
    return users_.size();
 }
+
+
+//****************************************************************************************************************************************************
+/// \param[in] userID The userID.
+/// \param[in] usedBytes The used space, in bytes.
+//****************************************************************************************************************************************************
+void UserList::onUsedBytesChanged(QString const &userID, qint64 usedBytes) {
+    int const index = this->rowOfUserID(userID);
+    if (index < 0) {
+        app().log().error(QString("Received usedBytesChanged event for unknown userID %1").arg(userID));
+        return;
+    }
+    users_[index]->setUsedBytes(usedBytes);
+}
--- a/internal/frontend/bridge-gui/bridge-gui/UserList.h
+++ b/internal/frontend/bridge-gui/bridge-gui/UserList.h
@ -44,6 +44,7 @@ public: // member functions.
    void appendUser(bridgepp::SPUser const &user); ///< Add a new user.
    void updateUserAtRow(int row, bridgepp::User const &user); ///< Update the user at given row.
    bridgepp::SPUser getUserWithID(QString const &userID) const; ///< Retrieve the user with the given ID.
+    bridgepp::SPUser getUserWithUsernameOrEmail(QString const& username) const; ///< Retrieve the user with the given primary email address or username

    // the userCount property.
    Q_PROPERTY(int count READ count NOTIFY countChanged)
@ -59,6 +60,7 @@ public:
 public slots: ///< handler for signals coming from the gRPC service
    void onUserChanged(QString const &userID);
    void onToggleSplitModeFinished(QString const &userID);
+    void onUsedBytesChanged(QString const &userID, qint64 usedBytes); ///< Slot for usedBytesChanged events.

 private: // data members
    QList<bridgepp::SPUser> users_; ///< The user list.
--- a/internal/frontend/bridge-gui/bridge-gui/build.ps1
+++ b/internal/frontend/bridge-gui/bridge-gui/build.ps1
@ -76,6 +76,15 @@ function check_exit() {
 Write-host "Running build for version $bridgeVersion - $buildConfig in $buildDir"

 $REVISION_HASH = git rev-parse --short=10 HEAD
+$bridgeDsnSentry = ($env:BRIDGE_DSN_SENTRY)
+$bridgeBuidTime = ($env:BRIDGE_BUILD_TIME)
+
+$bridgeBuildEnv = ($env:BRIDGE_BUILD_ENV)
+if ($null -eq $bridgeBuildEnv)
+{
+    $bridgeBuildEnv =  "dev"
+}
+
 git submodule update --init --recursive $vcpkgRoot
 . $vcpkgBootstrap -disableMetrics
 . $vcpkgExe install sentry-native:x64-windows grpc:x64-windows --clean-after-build
@ -85,6 +94,9 @@ git submodule update --init --recursive $vcpkgRoot
                                       -DBRIDGE_VENDOR="$bridgeVendor" `
                                       -DBRIDGE_REVISION=$REVISION_HASH `
                                       -DBRIDGE_APP_VERSION="$bridgeVersion" `
+                                       -DBRIDGE_BUILD_TIME="$bridgeBuidTime" `
+                                       -DBRIDGE_DSN_SENTRY="$bridgeDsnSentry" `
+                                       -DBRIDGE_BUILD_ENV="$bridgeBuildEnv" `
                                       -S . -B $buildDir

 check_exit "CMake failed"
--- a/internal/frontend/bridge-gui/bridge-gui/build.sh
+++ b/internal/frontend/bridge-gui/bridge-gui/build.sh
@ -56,6 +56,9 @@ BUILD_CONFIG=${BRIDGE_GUI_BUILD_CONFIG:-Debug}
 BUILD_DIR=$(echo "./cmake-build-${BUILD_CONFIG}" | tr '[:upper:]' '[:lower:]')
 VCPKG_ROOT="${BRIDGE_REPO_ROOT}/extern/vcpkg"
 BRIDGE_REVISION=$(git rev-parse --short=10 HEAD)
+BRIDGE_DSN_SENTRY=${BRIDGE_DSN_SENTRY}
+BRIDGE_BUILD_TIME=${BRIDGE_BUILD_TIME}
+BRIDGE_BUILD_ENV= ${BRIDGE_BUILD_ENV:-"dev"}
 git submodule update --init --recursive ${VCPKG_ROOT}
 check_exit "Failed to initialize vcpkg as a submodule."

@ -94,6 +97,9 @@ cmake  \
    -DBRIDGE_APP_FULL_NAME="${BRIDGE_APP_FULL_NAME}" \
    -DBRIDGE_VENDOR="${BRIDGE_VENDOR}" \
    -DBRIDGE_REVISION="${BRIDGE_REVISION}" \
+    -DBRIDGE_DSN_SENTRY="${BRIDGE_DSN_SENTRY}" \
+    -DBRIDGE_BRIDGE_TIME="${BRIDGE_BRIDGE_TIME}" \
+    -DBRIDGE_BUILD_ENV="${BRIDGE_BUILD_ENV}" \
    -DBRIDGE_APP_VERSION="${BRIDGE_APP_VERSION}" "${BRIDGE_CMAKE_MACOS_OPTS}" \
    -G Ninja \
    -S . \
--- a/internal/frontend/bridge-gui/bridge-gui/main.cpp
+++ b/internal/frontend/bridge-gui/bridge-gui/main.cpp
@ -21,7 +21,7 @@
 #include "CommandLine.h"
 #include "QMLBackend.h"
 #include "SentryUtils.h"
-#include "Version.h"
+#include "BuildConfig.h"
 #include <bridgepp/BridgeUtils.h>
 #include <bridgepp/Exception/Exception.h>
 #include <bridgepp/FocusGRPC/FocusGRPCClient.h>
@ -29,7 +29,6 @@
 #include <bridgepp/ProcessMonitor.h>
 #include <sentry.h>
 #include <SentryUtils.h>
-#include <project_sentry_config.h>


 #ifdef Q_OS_MACOS
@ -229,8 +228,21 @@ bool isBridgeRunning() {
 void focusOtherInstance() {
    try {
        FocusGRPCClient client;
+        GRPCConfig sc;
+        QString const path = FocusGRPCClient::grpcFocusServerConfigPath();
+        QFile file(path);
+        if (file.exists()) {
+            if (!sc.load(path)) {
+                throw Exception("The gRPC focus service configuration file is invalid.");
+            }
+        }
+        else {
+            throw Exception("Server did not provide gRPC Focus service configuration.");
+        }
+
+
        QString error;
-        if (!client.connectToServer(5000, &error)) {
+        if (!client.connectToServer(5000, sc.port, &error)) {
            throw Exception(QString("Could not connect to bridge focus service for a raise call: %1").arg(error));
        }
        if (!client.raise().ok()) {
@ -292,15 +304,8 @@ void closeBridgeApp() {
 //****************************************************************************************************************************************************
 int main(int argc, char *argv[]) {
    // Init sentry.
-    sentry_options_t *sentryOptions = sentry_options_new();
-    sentry_options_set_dsn(sentryOptions, SentryDNS);
-    {
-        const QString sentryCachePath = sentryCacheDir();
-        sentry_options_set_database_path(sentryOptions, sentryCachePath.toStdString().c_str());
-    }
-    sentry_options_set_release(sentryOptions, QByteArray(PROJECT_REVISION).toHex());
-    // Enable this for debugging sentry.
-    // sentry_options_set_debug(sentryOptions, 1);
+    sentry_options_t *sentryOptions = newSentryOptions(PROJECT_DSN_SENTRY, sentryCacheDir().toStdString().c_str());
+
    if (sentry_init(sentryOptions) != 0) {
        std::cerr << "Failed to initialize sentry" << std::endl;
    }
@ -344,6 +349,7 @@ int main(int argc, char *argv[]) {
            }

            // before launching bridge, we remove any trailing service config file, because we need to make sure we get a newly generated one.
+            FocusGRPCClient::removeServiceConfigFile();
            GRPCClient::removeServiceConfigFile();
            launchBridge(cliOptions.bridgeArgs);
        }
--- a/internal/frontend/bridge-gui/bridge-gui/qml/Notifications/Notifications.qml
+++ b/internal/frontend/bridge-gui/bridge-gui/qml/Notifications/Notifications.qml
@ -81,6 +81,7 @@ QtObject {
        root.apiCertIssue,
        root.noActiveKeyForRecipient,
        root.userBadEvent,
+        root.imapLoginWhileSignedOut,
        root.genericError
    ]

@ -1147,6 +1148,34 @@ QtObject {

    }

+    property Notification imapLoginWhileSignedOut: Notification {
+        title: qsTr("IMAP Login failed")
+        brief: title
+        description: "#PlaceHolderText"
+        icon: "./icons/ic-exclamation-circle-filled.svg"
+        type: Notification.NotificationType.Danger
+        group: Notifications.Group.Connection
+
+        Connections {
+            target: Backend
+            function onImapLoginWhileSignedOut(username) {
+                root.imapLoginWhileSignedOut.description = qsTr("An email client tried to connect to the account %1, but this account is signed " +
+                "out. Please sign-in to continue.").arg(username)
+                root.imapLoginWhileSignedOut.active = true
+            }
+        }
+
+        action: [
+            Action {
+                text: qsTr("OK")
+
+                onTriggered: {
+                    root.imapLoginWhileSignedOut.active = false
+                }
+            }
+        ]
+    }
+
    property Notification genericError: Notification {
        title: "#PlaceholderText#"
        description: "#PlaceholderText#"