rssguard/src/librssguard/miscellaneous/application.h

306 lines
9 KiB
C++

// For license of this file, see <project-root-folder>/LICENSE.md.
#ifndef APPLICATION_H
#define APPLICATION_H
#include "core/feeddownloader.h"
#include "database/databasefactory.h"
#include "definitions/definitions.h"
#include "gui/systemtrayicon.h"
#include "miscellaneous/feedreader.h"
#include "miscellaneous/iofactory.h"
#include "miscellaneous/localization.h"
#include "miscellaneous/nodejs.h"
#include "miscellaneous/notification.h"
#include "miscellaneous/settings.h"
#include "miscellaneous/singleapplication.h"
#include "miscellaneous/skinfactory.h"
#include "miscellaneous/systemfactory.h"
#include "network-web/downloadmanager.h"
#include <functional>
#include <QCommandLineParser>
#include <QList>
#if defined(qApp)
#undef qApp
#endif
// Define new qApp macro. Yeaaaaah.
#define qApp (Application::instance())
class FormMain;
class FormLog;
class IconFactory;
class QAction;
class Mutex;
#if QT_VERSION_MAJOR == 6
class QWebEngineDownloadRequest;
#else
class QWebEngineDownloadItem;
#endif
class WebFactory;
class NotificationFactory;
class ToastNotificationsManager;
class WebViewer;
#if defined(Q_OS_WIN)
struct ITaskbarList4;
#endif
struct GuiMessage {
public:
GuiMessage() {}
GuiMessage(QString title, QString message, QSystemTrayIcon::MessageIcon type)
: m_title(std::move(title)), m_message(std::move(message)), m_type(type) {}
QString m_title;
QString m_message;
QSystemTrayIcon::MessageIcon m_type;
};
Q_DECLARE_METATYPE(GuiMessage)
struct GuiMessageDestination {
public:
GuiMessageDestination(bool tray = true, bool message_box = false, bool status_bar = false)
: m_tray(tray), m_messageBox(message_box), m_statusBar(status_bar) {}
bool m_tray;
bool m_messageBox;
bool m_statusBar;
};
Q_DECLARE_METATYPE(GuiMessageDestination)
struct GuiAction {
public:
GuiAction(QString title = {}, const std::function<void()>& action = nullptr)
: m_title(std::move(title)), m_action(action) {}
QString m_title;
std::function<void()> m_action;
};
Q_DECLARE_METATYPE(GuiAction)
class RSSGUARD_DLLSPEC Application : public SingleApplication {
Q_OBJECT
public:
explicit Application(const QString& id, int& argc, char** argv, const QStringList& raw_cli_args);
virtual ~Application();
void reactOnForeignNotifications();
void hideOrShowMainForm();
void loadDynamicShortcuts();
void offerPolls() const;
void offerChanges() const;
bool isAlreadyRunning();
QStringList builtinSounds() const;
FeedReader* feedReader();
void setFeedReader(FeedReader* feed_reader);
// Globally accessible actions.
QList<QAction*> userActions();
// Check whether this application starts for the first time (ever).
bool isFirstRun() const;
// Check whether CURRENT VERSION of the application starts for the first time.
bool isFirstRunCurrentVersion() const;
QCommandLineParser* cmdParser();
WebFactory* web() const;
SystemFactory* system();
SkinFactory* skins();
Localization* localization();
DatabaseFactory* database();
IconFactory* icons();
DownloadManager* downloadManager();
Settings* settings() const;
Mutex* feedUpdateLock();
FormMain* mainForm();
QWidget* mainFormWidget();
SystemTrayIcon* trayIcon();
NotificationFactory* notifications() const;
NodeJs* nodejs() const;
QIcon desktopAwareIcon() const;
QString tempFolder() const;
QString documentsFolder() const;
QString homeFolder() const;
QString configFolder() const;
// These return user ready folders.
QString userDataAppFolder() const;
QString userDataHomeFolder() const;
QString customDataFolder() const;
// Returns the base folder to which store user data, the "data" folder.
// NOTE: Use this to get correct path under which store user data.
QString userDataFolder();
QString cacheFolder();
QString replaceDataUserDataFolderPlaceholder(QString text) const;
QStringList replaceDataUserDataFolderPlaceholder(QStringList texts) const;
void setMainForm(FormMain* main_form);
void backupDatabaseSettings(bool backup_database,
bool backup_settings,
const QString& target_path,
const QString& backup_name);
void restoreDatabaseSettings(bool restore_database,
bool restore_settings,
const QString& source_database_file_path = QString(),
const QString& source_settings_file_path = QString());
void showTrayIcon();
void deleteTrayIcon();
QStringList rawCliArgs() const;
// Displays given simple message in tray icon bubble or OSD
// or in message box if tray icon is disabled.
void showGuiMessage(Notification::Event event,
const GuiMessage& msg,
GuiMessageDestination dest = {},
const GuiAction& action = {},
QWidget* parent = nullptr);
WebViewer* createWebView();
#if defined(USE_WEBENGINE)
bool forcedNoWebEngine() const;
#endif
// Returns pointer to "GOD" application singleton.
static Application* instance();
// Custom debug/console log handler.
static void performLogging(QtMsgType type, const QMessageLogContext& context, const QString& msg);
int customAdblockPort() const;
QThreadPool* workHorsePool() const;
public slots:
// Restarts the application.
void restart();
// Processes incoming message from another RSS Guard instance.
void parseCmdArgumentsFromOtherInstance(const QString& message);
void parseCmdArgumentsFromMyInstance(const QStringList& raw_cli_args, QString& custom_ua);
void displayLog();
void showGuiMessageCore(Notification::Event event,
const GuiMessage& msg,
GuiMessageDestination dest = {},
const GuiAction& action = {},
QWidget* parent = nullptr);
private slots:
void fillCmdArgumentsParser(QCommandLineParser& parser);
void onNodeJsPackageUpdateError(const QList<NodeJs::PackageMetadata>& pkgs, const QString& error);
void onNodeJsPackageInstalled(const QList<NodeJs::PackageMetadata>& pkgs, bool already_up_to_date);
void onCommitData(QSessionManager& manager);
void onSaveState(QSessionManager& manager);
void onAboutToQuit();
void showMessagesNumber(int unread_messages, bool any_feed_has_new_unread_messages);
void onAdBlockFailure();
#if defined(USE_WEBENGINE)
#if QT_VERSION_MAJOR == 6
void downloadRequested(QWebEngineDownloadRequest* download_item);
#else
void downloadRequested(QWebEngineDownloadItem* download_item);
#endif
#endif
void onFeedUpdatesStarted();
void onFeedUpdatesProgress(const Feed* feed, int current, int total);
void onFeedUpdatesFinished(const FeedDownloadResults& results);
signals:
void sendLogToDialog(QString message);
private:
#if defined(Q_OS_WIN)
QImage generateOverlayIcon(int number) const;
#endif
void setupCustomDataFolder(const QString& data_folder);
void setupWorkHorsePool();
void determineFirstRuns();
void eliminateFirstRuns();
void displayLogMessageInDialog(const QString& message);
private:
QStringList m_rawCliArgs;
QCommandLineParser m_cmdParser;
FeedReader* m_feedReader;
bool m_quitLogicDone;
// This read-write lock is used by application on its close.
// Application locks this lock for WRITING.
// This means that if application locks that lock, then
// no other transaction-critical action can acquire lock
// for reading and won't be executed, so no critical action
// will be running when application quits
//
// EACH critical action locks this lock for READING.
// Several actions can lock this lock for reading.
// But of user decides to close the application (in other words,
// tries to lock the lock for writing), then no other
// action will be allowed to lock for reading.
QScopedPointer<Mutex> m_updateFeedsLock;
QList<QAction*> m_userActions;
FormMain* m_mainForm;
FormLog* m_logForm;
SystemTrayIcon* m_trayIcon;
Settings* m_settings;
WebFactory* m_webFactory;
SystemFactory* m_system;
SkinFactory* m_skins;
Localization* m_localization;
IconFactory* m_icons;
DatabaseFactory* m_database;
DownloadManager* m_downloadManager;
NotificationFactory* m_notifications;
ToastNotificationsManager* m_toastNotifications;
NodeJs* m_nodejs;
QThreadPool* m_workHorsePool;
bool m_shouldRestart;
bool m_firstRunEver;
bool m_firstRunCurrentVersion;
QString m_customDataFolder;
int m_customAdblockPort;
bool m_allowMultipleInstances;
#if defined(USE_WEBENGINE)
bool m_forcedNoWebEngine;
#endif
#if defined(Q_OS_WIN)
ITaskbarList4* m_windowsTaskBar;
#endif
};
inline Application* Application::instance() {
return static_cast<Application*>(QCoreApplication::instance());
}
#endif // APPLICATION_H