mirror of
https://github.com/ProtonMail/proton-bridge.git
synced 2025-12-10 04:36:43 +00:00
72708d6e2c
Other: renaming of bridge-gui. WIP: locate bridge exe. WIP: bridge process launch. WIP: cleaner closure of bridge. WIP: grpcClient connection retries. WIP: clean exit when bridge process is killed. Fixed issues from MR review. [skip-ci]. WIP: Fixed gRPC case in CMakelists.txt [skip-ci] It caused issues on Debian. WIP: update gRPC/protobuf and tweaked CMakeLists.txt. [skip-ci] WIP: Fixed a bug where splash screen could not be dismissed. [skip-ci]
228 lines
28 KiB
C++
228 lines
28 KiB
C++
// Copyright (c) 2022 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_QT6_QMLBACKEND_H
|
|
#define BRIDGE_QT6_QMLBACKEND_H
|
|
|
|
|
|
#include <grpcpp/support/status.h>
|
|
#include "DockIcon/DockIcon.h"
|
|
#include "GRPC/GRPCClient.h"
|
|
#include "GRPC/GRPCUtils.h"
|
|
#include "Worker/Overseer.h"
|
|
#include "User/UserList.h"
|
|
|
|
|
|
//****************************************************************************************************************************************************
|
|
/// \brief Bridge C++ backend class.
|
|
//****************************************************************************************************************************************************
|
|
class QMLBackend: public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public: // member functions.
|
|
QMLBackend(); ///< Default constructor.
|
|
QMLBackend(QMLBackend const &) = delete; ///< Disabled copy-constructor.
|
|
QMLBackend(QMLBackend &&) = delete; ///< Disabled assignment copy-constructor.
|
|
~QMLBackend() override = default; ///< Destructor.
|
|
QMLBackend &operator=(QMLBackend const &) = delete; ///< Disabled assignment operator.
|
|
QMLBackend &operator=(QMLBackend &&) = delete; ///< Disabled move assignment operator.
|
|
void init(); ///< Initialize the backend.
|
|
void clearUserList(); ///< Clear the user list.
|
|
|
|
// invokable methods can be called from QML. They generally return a value, which slots cannot do.
|
|
Q_INVOKABLE static QPoint getCursorPos(); // _ func() *core.QPoint `slot:"getCursorPos"`
|
|
Q_INVOKABLE static bool isPortFree(int port); // _ func(port int) bool `slot:"isPortFree"`
|
|
|
|
public: // Qt/QML properties. Note that the NOTIFY-er signal is required even for read-only properties (QML warning otherwise)
|
|
Q_PROPERTY(bool showOnStartup READ showOnStartup NOTIFY showOnStartupChanged) // _ bool `property:showOnStartup`
|
|
Q_PROPERTY(bool showSplashScreen READ showSplashScreen WRITE setShowSplashScreen NOTIFY showSplashScreenChanged) // _ bool `property:showSplashScreen`
|
|
Q_PROPERTY(QString goos READ goos NOTIFY goosChanged) // _ string `property:"goos"`
|
|
Q_PROPERTY(QUrl logsPath READ logsPath NOTIFY logsPathChanged) // _ core.QUrl `property:"logsPath"`
|
|
Q_PROPERTY(QUrl licensePath READ licensePath NOTIFY licensePathChanged) // _ core.QUrl `property:"licensePath"`
|
|
Q_PROPERTY(QUrl releaseNotesLink READ releaseNotesLink WRITE setReleaseNotesLink NOTIFY releaseNotesLinkChanged) // _ core.QUrl `property:"releaseNotesLink"`
|
|
Q_PROPERTY(QUrl dependencyLicensesLink READ dependencyLicensesLink NOTIFY dependencyLicensesLinkChanged) // _ core.QUrl `property:"dependencyLicensesLink"`
|
|
Q_PROPERTY(QUrl landingPageLink READ landingPageLink WRITE setLandingPageLink NOTIFY landingPageLinkChanged) // _ core.QUrl `property:"landingPageLink"`
|
|
Q_PROPERTY(QString version READ version NOTIFY versionChanged) // _ string `property:"version"`
|
|
Q_PROPERTY(QString hostname READ hostname NOTIFY hostnameChanged) // _ string `property:"hostname"`
|
|
Q_PROPERTY(bool isAutostartOn READ isAutostartOn NOTIFY isAutostartOnChanged) // _ bool `property:"isAutostartOn"`
|
|
Q_PROPERTY(bool isBetaEnabled READ isBetaEnabled NOTIFY isBetaEnabledChanged) // _ bool `property:"isBetaEnabled"`
|
|
Q_PROPERTY(QString colorSchemeName READ colorSchemeName NOTIFY colorSchemeNameChanged) // _ string `property:"colorSchemeName"`
|
|
Q_PROPERTY(bool isDiskCacheEnabled READ isDiskCacheEnabled NOTIFY isDiskCacheEnabledChanged) // _ bool `property:"isDiskCacheEnabled"`
|
|
Q_PROPERTY(QUrl diskCachePath READ diskCachePath NOTIFY diskCachePathChanged) // _ core.QUrl `property:"diskCachePath"`
|
|
Q_PROPERTY(bool useSSLforSMTP READ useSSLForSMTP NOTIFY useSSLforSMTPChanged) // _ bool `property:"useSSLforSMTP"`
|
|
Q_PROPERTY(int portIMAP READ portIMAP NOTIFY portIMAPChanged) // _ int `property:"portIMAP"`
|
|
Q_PROPERTY(int portSMTP READ portSMTP NOTIFY portSMTPChanged) // _ int `property:"portSMTP"`
|
|
Q_PROPERTY(bool isDoHEnabled READ isDoHEnabled NOTIFY isDoHEnabledChanged) // _ bool `property:"isDoHEnabled"`
|
|
Q_PROPERTY(bool isFirstGUIStart READ isFirstGUIStart) // _ bool `property:"isFirstGUIStart"`
|
|
Q_PROPERTY(bool isAutomaticUpdateOn READ isAutomaticUpdateOn NOTIFY isAutomaticUpdateOnChanged) // _ bool `property:"isAutomaticUpdateOn"`
|
|
Q_PROPERTY(QString currentEmailClient READ currentEmailClient NOTIFY currentEmailClientChanged) // _ string `property:"currentEmailClient"`
|
|
Q_PROPERTY(QStringList availableKeychain READ availableKeychain NOTIFY availableKeychainChanged) // _ []string `property:"availableKeychain"`
|
|
Q_PROPERTY(QString currentKeychain READ currentKeychain NOTIFY currentKeychainChanged) // _ string `property:"currentKeychain"`
|
|
Q_PROPERTY(UserList* users MEMBER users_ NOTIFY usersChanged)
|
|
Q_PROPERTY(bool dockIconVisible READ dockIconVisible WRITE setDockIconVisible NOTIFY dockIconVisibleChanged) // _ bool `property:dockIconVisible`
|
|
|
|
// Qt Property system setters & getters.
|
|
bool showOnStartup() const { bool v = false; logGRPCCallStatus(app().grpc().showOnStartup(v), "showOnStartup"); return v; };
|
|
bool showSplashScreen() const { return showSplashScreen_; };
|
|
void setShowSplashScreen(bool show) { if (show != showSplashScreen_) { showSplashScreen_ = show; emit showSplashScreenChanged(show); } }
|
|
QString goos() { return goos_; }
|
|
QUrl logsPath() const { return logsPath_; }
|
|
QUrl licensePath() const { return licensePath_; }
|
|
QUrl releaseNotesLink() const { return releaseNotesLink_; }
|
|
void setReleaseNotesLink(QUrl const& url) { if (url != releaseNotesLink_) { releaseNotesLink_ = url; emit releaseNotesLinkChanged(url); } }
|
|
QUrl dependencyLicensesLink() const { QUrl link; logGRPCCallStatus(app().grpc().dependencyLicensesLink(link), "dependencyLicensesLink"); return link; }
|
|
QUrl landingPageLink() const { return landingPageLink_; }
|
|
void setLandingPageLink(QUrl const& url) { if (url != landingPageLink_) { landingPageLink_ = url; emit landingPageLinkChanged(url); } }
|
|
QString version() const { QString version; logGRPCCallStatus(app().grpc().version(version), "version"); return version; }
|
|
QString hostname() const { QString hostname; logGRPCCallStatus(app().grpc().hostname(hostname), "hostname"); return hostname; }
|
|
bool isAutostartOn() const { bool v; logGRPCCallStatus(app().grpc().isAutostartOn(v), "isAutostartOn"); return v; };
|
|
bool isBetaEnabled() const { bool v; logGRPCCallStatus(app().grpc().isBetaEnabled(v), "isBetaEnabled"); return v; }
|
|
QString colorSchemeName() const { QString name; logGRPCCallStatus(app().grpc().colorSchemeName(name), "colorSchemeName"); return name; }
|
|
bool isDiskCacheEnabled() const { bool enabled; logGRPCCallStatus(app().grpc().isCacheOnDiskEnabled(enabled), "isCacheOnDiskEnabled"); return enabled;}
|
|
QUrl diskCachePath() const { QUrl path; logGRPCCallStatus(app().grpc().diskCachePath(path), "diskCachePath"); return path; }
|
|
bool useSSLForSMTP() const{ bool useSSL; logGRPCCallStatus(app().grpc().useSSLForSMTP(useSSL), "useSSLForSMTP"); return useSSL; }
|
|
int portIMAP() const { int port; logGRPCCallStatus(app().grpc().portIMAP(port), "portIMAP"); return port; }
|
|
int portSMTP() const { int port; logGRPCCallStatus(app().grpc().portSMTP(port), "portSMTP"); return port; }
|
|
bool isDoHEnabled() const { bool isEnabled; logGRPCCallStatus(app().grpc().isDoHEnabled(isEnabled), "isDoHEnabled"); return isEnabled;}
|
|
bool isFirstGUIStart() const { bool v; logGRPCCallStatus(app().grpc().isFirstGUIStart(v), "isFirstGUIStart"); return v; };
|
|
bool isAutomaticUpdateOn() const { bool isOn = false; logGRPCCallStatus(app().grpc().isAutomaticUpdateOn(isOn), "isAutomaticUpdateOn"); return isOn; }
|
|
QString currentEmailClient() { QString client; logGRPCCallStatus(app().grpc().currentEmailClient(client), "currentEmailClient"); return client;}
|
|
QStringList availableKeychain() const { QStringList keychains; logGRPCCallStatus(app().grpc().availableKeychains(keychains), "availableKeychain"); return keychains; }
|
|
QString currentKeychain() const { QString keychain; logGRPCCallStatus(app().grpc().currentKeychain(keychain), "currentKeychain"); return keychain; }
|
|
bool dockIconVisible() const { return getDockIconVisibleState(); };
|
|
void setDockIconVisible(bool visible) { setDockIconVisibleState(visible); emit dockIconVisibleChanged(visible); }
|
|
|
|
signals: // Signal used by the Qt property system. Many of them are unused but required to avoir warning from the QML engine.
|
|
void showSplashScreenChanged(bool value);
|
|
void showOnStartupChanged(bool value);
|
|
void goosChanged(QString const &value);
|
|
void isDiskCacheEnabledChanged(bool value);
|
|
void diskCachePathChanged(QUrl const &url);
|
|
void useSSLforSMTPChanged(bool value);
|
|
void isAutomaticUpdateOnChanged(bool value);
|
|
void isBetaEnabledChanged(bool value);
|
|
void colorSchemeNameChanged(QString const &scheme);
|
|
void isDoHEnabledChanged(bool value);
|
|
void logsPathChanged(QUrl const &path);
|
|
void licensePathChanged(QUrl const &path);
|
|
void releaseNotesLinkChanged(QUrl const &link);
|
|
void dependencyLicensesLinkChanged(QUrl const &link);
|
|
void landingPageLinkChanged(QUrl const &link);
|
|
void versionChanged(QString const &version);
|
|
void currentEmailClientChanged(QString const &email);
|
|
void currentKeychainChanged(QString const &keychain);
|
|
void availableKeychainChanged(QStringList const &keychains);
|
|
void hostnameChanged(QString const &hostname);
|
|
void isAutostartOnChanged(bool value);
|
|
void portIMAPChanged(int port);
|
|
void portSMTPChanged(int port);
|
|
void usersChanged(UserList* users);
|
|
void dockIconVisibleChanged(bool value);
|
|
|
|
public slots: // slot for signals received from QML -> To be forwarded to Bridge via RPC Client calls.
|
|
void toggleAutostart(bool active); // _ func(makeItActive bool) `slot:"toggleAutostart"`
|
|
void toggleBeta(bool active); // _ func(makeItActive bool) `slot:"toggleBeta"`
|
|
void changeColorScheme(QString const &scheme); // _ func(string) `slot:"changeColorScheme"`
|
|
void changeLocalCache(bool enable, QUrl const& path) { logGRPCCallStatus(app().grpc().changeLocalCache(enable, path), "changeLocalCache"); } // _ func(enableDiskCache bool, diskCachePath core.QUrl) `slot:"changeLocalCache"`
|
|
void login(QString const& username, QString const& password) { logGRPCCallStatus(app().grpc().login(username, password), "login");} // _ func(username, password string) `slot:"login"`
|
|
void login2FA(QString const& username, QString const& code) { logGRPCCallStatus(app().grpc().login2FA(username, code), "login2FA");} // _ func(username, code string) `slot:"login2FA"`
|
|
void login2Password(QString const& username, QString const& password) { logGRPCCallStatus(app().grpc().login2Passwords(username, password),
|
|
"login2Passwords");} // _ func(username, password string) `slot:"login2Password"`
|
|
void loginAbort(QString const& username){ logGRPCCallStatus(app().grpc().loginAbort(username), "loginAbort");} // _ func(username string) `slot:"loginAbort"`
|
|
void toggleUseSSLforSMTP(bool makeItActive); // _ func(makeItActive bool) `slot:"toggleUseSSLforSMTP"`
|
|
void changePorts(int imapPort, int smtpPort); // _ func(imapPort, smtpPort int) `slot:"changePorts"`
|
|
void toggleDoH(bool active); // _ func(makeItActive bool) `slot:"toggleDoH"`
|
|
void toggleAutomaticUpdate(bool makeItActive); // _ func(makeItActive bool) `slot:"toggleAutomaticUpdate"`
|
|
void updateCurrentMailClient() { emit currentEmailClientChanged(currentEmailClient()); } // _ func() `slot:"updateCurrentMailClient"`
|
|
void changeKeychain(QString const &keychain); // _ func(keychain string) `slot:"changeKeychain"`
|
|
void guiReady(); // _ func() `slot:"guiReady"`
|
|
void quit(); // _ func() `slot:"quit"`
|
|
void restart(); // _ func() `slot:"restart"`
|
|
void checkUpdates(); // _ func() `slot:"checkUpdates"`
|
|
void installUpdate(); // _ func() `slot:"installUpdate"`
|
|
void triggerReset(); // _ func() `slot:"triggerReset"`
|
|
void reportBug(QString const &description, QString const& address, QString const &emailClient, bool includeLogs); // _ func(description, address, emailClient string, includeLogs bool) `slot:"reportBug"`
|
|
|
|
signals: // Signals received from the Go backend, to be forwarded to QML
|
|
void toggleAutostartFinished(); // _ func() `signal:"toggleAutostartFinished"`
|
|
void cacheUnavailable(); // _ func() `signal:"cacheUnavailable"`
|
|
void cacheCantMove(); // _ func() `signal:"cacheCantMove"`
|
|
void cacheLocationChangeSuccess(); // _ func() `signal:"cacheLocationChangeSuccess"`
|
|
void diskFull(); // _ func() `signal:"diskFull"`
|
|
void changeLocalCacheFinished(); // _ func() `signal:"changeLocalCacheFinished"`
|
|
void loginUsernamePasswordError(QString const &errorMsg); // _ func(errorMsg string) `signal:"loginUsernamePasswordError"`
|
|
void loginFreeUserError(); // _ func() `signal:"loginFreeUserError"`
|
|
void loginConnectionError(QString const &errorMsg); // _ func(errorMsg string) `signal:"loginConnectionError"`
|
|
void login2FARequested(QString const &username); // _ func(username string) `signal:"login2FARequested"`
|
|
void login2FAError(QString const& errorMsg); // _ func(errorMsg string) `signal:"login2FAError"`
|
|
void login2FAErrorAbort(QString const& errorMsg); // _ func(errorMsg string) `signal:"login2FAErrorAbort"`
|
|
void login2PasswordRequested(); // _ func() `signal:"login2PasswordRequested"`
|
|
void login2PasswordError(QString const& errorMsg); // _ func(errorMsg string) `signal:"login2PasswordError"`
|
|
void login2PasswordErrorAbort(QString const& errorMsg); // _ func(errorMsg string) `signal:"login2PasswordErrorAbort"`
|
|
void loginFinished(int index); // _ func(index int) `signal:"loginFinished"`
|
|
void loginAlreadyLoggedIn(int index); // _ func(index int) `signal:"loginAlreadyLoggedIn"`
|
|
void updateManualReady(QString const& version); // _ func(version string) `signal:"updateManualReady"`
|
|
void updateManualRestartNeeded(); // _ func() `signal:"updateManualRestartNeeded"`
|
|
void updateManualError(); // _ func() `signal:"updateManualError"`
|
|
void updateForce(QString const& version); // _ func(version string) `signal:"updateForce"`
|
|
void updateForceError(); // _ func() `signal:"updateForceError"`
|
|
void updateSilentRestartNeeded(); // _ func() `signal:"updateSilentRestartNeeded"`
|
|
void updateSilentError(); // _ func() `signal:"updateSilentError"`
|
|
void updateIsLatestVersion(); // _ func() `signal:"updateIsLatestVersion"`
|
|
void checkUpdatesFinished(); // _ func() `signal:"checkUpdatesFinished"`
|
|
void toggleUseSSLFinished(); // _ func() `signal:"toggleUseSSLFinished"`
|
|
void changePortFinished(); // _ func() `signal:"changePortFinished"`
|
|
void portIssueIMAP(); // _ func() `signal:"portIssueIMAP"`
|
|
void portIssueSMTP(); // _ func() `signal:"portIssueSMTP"`
|
|
void changeKeychainFinished(); // _ func() `signal:"changeKeychainFinished"`
|
|
void notifyHasNoKeychain(); // _ func() `signal:"notifyHasNoKeychain"`
|
|
void notifyRebuildKeychain(); // _ func() `signal:"notifyRebuildKeychain"`
|
|
void noActiveKeyForRecipient(QString const& email); // _ func(email string) `signal:noActiveKeyForRecipient`
|
|
void addressChanged(QString const& address); // _ func(address string) `signal:addressChanged`
|
|
void addressChangedLogout(QString const& address); // _ func(address string) `signal:addressChangedLogout`
|
|
void apiCertIssue(); // _ func() `signal:apiCertIssue`
|
|
void userDisconnected(QString const& username); // _ func(username string) `signal:userDisconnected`
|
|
void internetOff(); // _ func() `signal:"internetOff"`
|
|
void internetOn(); // _ func() `signal:"internetOn"`
|
|
void resetFinished(); // _ func() `signal:"resetFinished"`
|
|
void reportBugFinished(); // _ func() `signal:"reportBugFinished"`
|
|
void bugReportSendSuccess(); // _ func() `signal:"bugReportSendSuccess"`
|
|
void bugReportSendError(); // _ func() `signal:"bugReportSendError"`
|
|
void showMainWindow(); // _ func() `signal:showMainWindow`
|
|
|
|
private: // member functions
|
|
void retrieveUserList(); ///< Retrieve the list of users via gRPC.
|
|
void connectGrpcEvents(); ///< Connect gRPC that need to be forwarded to QML via backend signals
|
|
|
|
private: // data members
|
|
UserList* users_ { nullptr }; ///< The user list. Owned by backend.
|
|
std::unique_ptr<Overseer> eventStreamOverseer_; ///< The event stream overseer.
|
|
bool showSplashScreen_ { false }; ///< The cached version of show splash screen. Retrieved on startup from bridge, and potentially modified locally.
|
|
QString goos_; ///< The cached version of the GOOS variable.
|
|
QUrl logsPath_; ///< The logs path. Retrieved from bridge on startup.
|
|
QUrl licensePath_; ///< The license path. Retrieved from bridge on startup.
|
|
QUrl releaseNotesLink_; /// Release notes is not stored in the backend, it's pushed by the update check so we keep a local copy of it. \todo GODT-1670 Check this is implemented.
|
|
QUrl landingPageLink_; /// Landing page link is not stored in the backend, it's pushed by the update check so we keep a local copy of it. \todo GODT-1670 Check this is implemented.
|
|
|
|
friend class AppController;
|
|
};
|
|
|
|
|
|
#endif // BRIDGE_QT6_QMLBACKEND_H
|