feat(GODT-2295): notifications for IMAP login when signed out.

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

@@ -467,6 +467,7 @@ bool QMLBackend::isDoHEnabled() const {
     )
 }
 
+
 //****************************************************************************************************************************************************
 /// \return The value for the 'isAutomaticUpdateOn' property.
 //****************************************************************************************************************************************************
@@ -876,8 +877,9 @@ void QMLBackend::onUserBadEvent(QString const &userID, QString const &errorMessa
     HANDLE_EXCEPTION(
         Q_UNUSED(errorMessage);
         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("%1 was logged out because of an internal error.").arg(user->primaryEmailOrUsername()));
         emit selectUser(userID);
@@ -886,6 +888,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);
+    )
+}
+
+
 //****************************************************************************************************************************************************
 //
 //****************************************************************************************************************************************************
@@ -994,5 +1014,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();
 }

internal/frontend/bridge-gui/bridge-gui/QMLBackend.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.

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

@@ -149,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.
 //****************************************************************************************************************************************************

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)

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
     ]
 
@@ -1129,6 +1130,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#"