cmake: avoid de-duplication of user's CXXFLAGS
[quassel.git] / src / qtui / statusnotifieritem.cpp
index a75c325..244ceab 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2015 by the Quassel Project                        *
+ *   Copyright (C) 2005-2022 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This contains code from KStatusNotifierItem, part of the KDE libs     *
 
 #ifdef HAVE_DBUS
 
-#include <QApplication>
-#include <QMenu>
-#include <QMouseEvent>
-#include <QTextDocument>
+#    include "statusnotifieritem.h"
 
-#include "quassel.h"
-#include "statusnotifieritem.h"
-#include "statusnotifieritemdbus.h"
+#    include <QApplication>
+#    include <QDir>
+#    include <QFile>
+#    include <QIcon>
+#    include <QMenu>
+#    include <QMouseEvent>
+#    include <QTextDocument>
 
-const int StatusNotifierItem::_protocolVersion = 0;
-const QString StatusNotifierItem::_statusNotifierWatcherServiceName("org.kde.StatusNotifierWatcher");
+#    include "icon.h"
+#    include "qtui.h"
+#    include "quassel.h"
+#    include "statusnotifieritemdbus.h"
 
-#ifdef HAVE_DBUSMENU
-#  include "dbusmenuexporter.h"
+constexpr int kProtocolVersion{0};
+
+const QString kSniWatcherService{QLatin1String{"org.kde.StatusNotifierWatcher"}};
+const QString kSniWatcherPath{QLatin1String{"/StatusNotifierWatcher"}};
+const QString kSniPath{QLatin1String{"/StatusNotifierItem"}};
+const QString kXdgNotificationsService{QLatin1String{"org.freedesktop.Notifications"}};
+const QString kXdgNotificationsPath{QLatin1String{"/org/freedesktop/Notifications"}};
+const QString kMenuObjectPath{QLatin1String{"/MenuBar"}};
+
+#    ifdef HAVE_DBUSMENU
+#        include "dbusmenuexporter.h"
 
 /**
  * Specialization to provide access to icon names
@@ -44,62 +56,79 @@ const QString StatusNotifierItem::_statusNotifierWatcherServiceName("org.kde.Sta
 class QuasselDBusMenuExporter : public DBusMenuExporter
 {
 public:
-    QuasselDBusMenuExporter(const QString &dbusObjectPath, QMenu *menu, const QDBusConnection &dbusConnection)
+    QuasselDBusMenuExporter(const QString& dbusObjectPath, QMenu* menu, const QDBusConnection& dbusConnection)
         : DBusMenuExporter(dbusObjectPath, menu, dbusConnection)
     {}
 
 protected:
-    virtual QString iconNameForAction(QAction *action) // TODO Qt 4.7: fixme when we have converted our iconloader
+    QString iconNameForAction(QAction* action) override  // TODO Qt 4.7: fixme when we have converted our iconloader
     {
         QIcon icon(action->icon());
         return icon.isNull() ? QString() : icon.name();
     }
 };
 
+#    endif /* HAVE_DBUSMENU */
 
-#endif /* HAVE_DBUSMENU */
-
-StatusNotifierItem::StatusNotifierItem(QWidget *parent)
-    : StatusNotifierItemParent(parent),
-    _statusNotifierItemDBus(0),
-    _statusNotifierWatcher(0),
-    _notificationsClient(0),
-    _notificationsClientSupportsMarkup(true),
-    _lastNotificationsDBusId(0)
+StatusNotifierItem::StatusNotifierItem(QWidget* parent)
+    : StatusNotifierItemParent(parent)
+    , _iconThemeDir{QDir::tempPath() + QLatin1String{"/quassel-sni-XXXXXX"}}
 {
-}
+    static bool registered = []() -> bool {
+        qDBusRegisterMetaType<DBusImageStruct>();
+        qDBusRegisterMetaType<DBusImageVector>();
+        qDBusRegisterMetaType<DBusToolTipStruct>();
+        return true;
+    }();
+    Q_UNUSED(registered)
 
+    setMode(Mode::StatusNotifier);
 
-StatusNotifierItem::~StatusNotifierItem()
-{
-    delete _statusNotifierWatcher;
-}
-
-
-void StatusNotifierItem::init()
-{
-    qDBusRegisterMetaType<DBusImageStruct>();
-    qDBusRegisterMetaType<DBusImageVector>();
-    qDBusRegisterMetaType<DBusToolTipStruct>();
-
-    _statusNotifierItemDBus = new StatusNotifierItemDBus(this);
+    connect(this, &StatusNotifierItem::visibilityChanged, this, &StatusNotifierItem::onVisibilityChanged);
+    connect(this, &StatusNotifierItem::modeChanged, this, &StatusNotifierItem::onModeChanged);
+    connect(this, &StatusNotifierItem::stateChanged, this, &StatusNotifierItem::onStateChanged);
 
-    connect(this, SIGNAL(toolTipChanged(QString, QString)), _statusNotifierItemDBus, SIGNAL(NewToolTip()));
-    connect(this, SIGNAL(animationEnabledChanged(bool)), _statusNotifierItemDBus, SIGNAL(NewAttentionIcon()));
-
-    QDBusServiceWatcher *watcher = new QDBusServiceWatcher(_statusNotifierWatcherServiceName,
-        QDBusConnection::sessionBus(),
-        QDBusServiceWatcher::WatchForOwnerChange,
-        this);
-    connect(watcher, SIGNAL(serviceOwnerChanged(QString, QString, QString)), SLOT(serviceChange(QString, QString, QString)));
+    trayMenu()->installEventFilter(this);
 
-    setMode(StatusNotifier);
+    // Create a temporary directory that holds copies of the tray icons. That way, visualizers can find our icons.
+    if (_iconThemeDir.isValid()) {
+        _iconThemePath = _iconThemeDir.path();
+    }
+    else {
+        qWarning() << "Could not create temporary directory for themed tray icons!";
+    }
 
-    _notificationsClient = new org::freedesktop::Notifications("org.freedesktop.Notifications", "/org/freedesktop/Notifications",
-        QDBusConnection::sessionBus(), this);
+    connect(this, &SystemTray::iconsChanged, this, &StatusNotifierItem::refreshIcons);
+    refreshIcons();
 
-    connect(_notificationsClient, SIGNAL(NotificationClosed(uint, uint)), SLOT(notificationClosed(uint, uint)));
-    connect(_notificationsClient, SIGNAL(ActionInvoked(uint, QString)), SLOT(notificationInvoked(uint, QString)));
+    // Our own SNI service
+    _statusNotifierItemDBus = new StatusNotifierItemDBus(this);
+    connect(this, &StatusNotifierItem::currentIconNameChanged, _statusNotifierItemDBus, &StatusNotifierItemDBus::NewIcon);
+    connect(this, &StatusNotifierItem::currentIconNameChanged, _statusNotifierItemDBus, &StatusNotifierItemDBus::NewAttentionIcon);
+    connect(this, &StatusNotifierItem::toolTipChanged, _statusNotifierItemDBus, &StatusNotifierItemDBus::NewToolTip);
+
+    // Service watcher to keep track of the StatusNotifierWatcher service
+    _serviceWatcher = new QDBusServiceWatcher(kSniWatcherService, QDBusConnection::sessionBus(), QDBusServiceWatcher::WatchForOwnerChange, this);
+    connect(_serviceWatcher, &QDBusServiceWatcher::serviceOwnerChanged, this, &StatusNotifierItem::serviceChange);
+
+    // Client instance for StatusNotifierWatcher
+    _statusNotifierWatcher = new org::kde::StatusNotifierWatcher(kSniWatcherService, kSniWatcherPath, QDBusConnection::sessionBus(), this);
+    connect(_statusNotifierWatcher,
+            &OrgKdeStatusNotifierWatcherInterface::StatusNotifierHostRegistered,
+            this,
+            &StatusNotifierItem::checkForRegisteredHosts);
+    connect(_statusNotifierWatcher,
+            &OrgKdeStatusNotifierWatcherInterface::StatusNotifierHostUnregistered,
+            this,
+            &StatusNotifierItem::checkForRegisteredHosts);
+
+    // Client instance for notifications
+    _notificationsClient = new org::freedesktop::Notifications(kXdgNotificationsService,
+                                                               kXdgNotificationsPath,
+                                                               QDBusConnection::sessionBus(),
+                                                               this);
+    connect(_notificationsClient, &OrgFreedesktopNotificationsInterface::NotificationClosed, this, &StatusNotifierItem::notificationClosed);
+    connect(_notificationsClient, &OrgFreedesktopNotificationsInterface::ActionInvoked, this, &StatusNotifierItem::notificationInvoked);
 
     if (_notificationsClient->isValid()) {
         QStringList desktopCapabilities = _notificationsClient->GetCapabilities();
@@ -107,215 +136,191 @@ void StatusNotifierItem::init()
         _notificationsClientSupportsActions = desktopCapabilities.contains("actions");
     }
 
-    StatusNotifierItemParent::init();
-    trayMenu()->installEventFilter(this);
-
-    // use the appdata icon folder for now
-    _iconThemePath = Quassel::findDataFilePath("icons");
-
-#ifdef HAVE_DBUSMENU
-    _menuObjectPath = "/MenuBar";
-    new QuasselDBusMenuExporter(menuObjectPath(), trayMenu(), _statusNotifierItemDBus->dbusConnection()); // will be added as menu child
-#endif
+#    ifdef HAVE_DBUSMENU
+    new QuasselDBusMenuExporter(menuObjectPath(), trayMenu(), _statusNotifierItemDBus->dbusConnection());  // will be added as menu child
+#    endif
 }
 
-
-void StatusNotifierItem::registerToDaemon()
+void StatusNotifierItem::serviceChange(const QString& name, const QString& oldOwner, const QString& newOwner)
 {
-    if (!_statusNotifierWatcher) {
-        _statusNotifierWatcher = new org::kde::StatusNotifierWatcher(_statusNotifierWatcherServiceName,
-            "/StatusNotifierWatcher",
-            QDBusConnection::sessionBus());
-        connect(_statusNotifierWatcher, SIGNAL(StatusNotifierHostRegistered()), SLOT(checkForRegisteredHosts()));
-        connect(_statusNotifierWatcher, SIGNAL(StatusNotifierHostUnregistered()), SLOT(checkForRegisteredHosts()));
-    }
-    if (_statusNotifierWatcher->isValid()
-        && _statusNotifierWatcher->property("ProtocolVersion").toInt() == _protocolVersion) {
-        _statusNotifierWatcher->RegisterStatusNotifierItem(_statusNotifierItemDBus->service());
-        checkForRegisteredHosts();
+    Q_UNUSED(name);
+    if (newOwner.isEmpty()) {
+        // unregistered
+        setMode(Mode::Legacy);
     }
-    else {
-        //qDebug() << "StatusNotifierWatcher not reachable!";
-        setMode(Legacy);
+    else if (oldOwner.isEmpty()) {
+        // registered
+        setMode(Mode::StatusNotifier);
     }
 }
 
-
-void StatusNotifierItem::serviceChange(const QString &name, const QString &oldOwner, const QString &newOwner)
+void StatusNotifierItem::registerToWatcher()
 {
-    Q_UNUSED(name);
-    if (newOwner.isEmpty()) {
-        //unregistered
-        //qDebug() << "Connection to the StatusNotifierWatcher lost";
-        delete _statusNotifierWatcher;
-        _statusNotifierWatcher = 0;
-        setMode(Legacy);
+    if (_statusNotifierWatcher->isValid() && _statusNotifierWatcher->property("ProtocolVersion").toInt() == kProtocolVersion) {
+        auto registerMethod = QDBusMessage::createMethodCall(kSniWatcherService,
+                                                             kSniWatcherPath,
+                                                             kSniWatcherService,
+                                                             QLatin1String{"RegisterStatusNotifierItem"});
+        registerMethod.setArguments(QVariantList() << _statusNotifierItemDBus->service());
+        _statusNotifierItemDBus->dbusConnection().callWithCallback(registerMethod,
+                                                                   this,
+                                                                   SLOT(checkForRegisteredHosts()),
+                                                                   SLOT(onDBusError(QDBusError)));
     }
-    else if (oldOwner.isEmpty()) {
-        //registered
-        setMode(StatusNotifier);
+    else {
+        setMode(Mode::Legacy);
     }
 }
 
-
 void StatusNotifierItem::checkForRegisteredHosts()
 {
-    if (!_statusNotifierWatcher || !_statusNotifierWatcher->property("IsStatusNotifierHostRegistered").toBool())
-        setMode(Legacy);
-    else
-        setMode(StatusNotifier);
+    if (!_statusNotifierWatcher || !_statusNotifierWatcher->property("IsStatusNotifierHostRegistered").toBool()) {
+        setMode(Mode::Legacy);
+    }
+    else {
+        setMode(Mode::StatusNotifier);
+    }
 }
 
-
-bool StatusNotifierItem::isSystemTrayAvailable() const
+void StatusNotifierItem::onDBusError(const QDBusError& error)
 {
-    if (mode() == StatusNotifier)
-        return true;  // else it should be set to legacy on registration
-
-    return StatusNotifierItemParent::isSystemTrayAvailable();
+    qWarning() << "StatusNotifierItem encountered a D-Bus error:" << error;
+    setMode(Mode::Legacy);
 }
 
-
-bool StatusNotifierItem::isVisible() const
+void StatusNotifierItem::refreshIcons()
 {
-    if (mode() == StatusNotifier)
-        return shouldBeVisible();  // we don't have a way to check, so we need to trust everything went right
+    if (!_iconThemePath.isEmpty()) {
+        QDir baseDir{_iconThemePath + "/hicolor"};
+        baseDir.removeRecursively();
+        for (auto&& trayState : {State::Active, State::Passive, State::NeedsAttention}) {
+            auto iconName = SystemTray::iconName(trayState);
+            QIcon icon = icon::get(iconName);
+            if (!icon.isNull()) {
+                for (auto&& size : icon.availableSizes()) {
+                    auto pixDir = QString{"%1/%2x%3/status"}.arg(baseDir.absolutePath()).arg(size.width()).arg(size.height());
+                    QDir{}.mkpath(pixDir);
+                    if (!icon.pixmap(size).save(pixDir + "/" + iconName + ".png")) {
+                        qWarning() << "Could not save tray icon" << iconName << "for size" << size;
+                    }
+                }
+            }
+            else {
+                // No theme icon found; use fallback from resources
+                auto iconDir = QString{"%1/24x24/status"}.arg(baseDir.absolutePath());
+                QDir{}.mkpath(iconDir);
+                if (!QFile::copy(QString{":/icons/hicolor/24x24/status/%1.svg"}.arg(iconName), QString{"%1/%2.svg"}.arg(iconDir, iconName))) {
+                    qWarning() << "Could not access fallback tray icon" << iconName;
+                    continue;
+                }
+            }
+        }
+    }
 
-    return StatusNotifierItemParent::isVisible();
+    if (_statusNotifierItemDBus) {
+        emit _statusNotifierItemDBus->NewIcon();
+        emit _statusNotifierItemDBus->NewAttentionIcon();
+    }
 }
 
-
-void StatusNotifierItem::setMode(Mode mode_)
+bool StatusNotifierItem::isSystemTrayAvailable() const
 {
-    if (mode_ == mode())
-        return;
-
-    if (mode_ != StatusNotifier) {
-        _statusNotifierItemDBus->unregisterService();
+    if (mode() == Mode::StatusNotifier) {
+        return true;  // else it should be set to legacy on registration
     }
 
-    StatusNotifierItemParent::setMode(mode_);
+    return StatusNotifierItemParent::isSystemTrayAvailable();
+}
 
-    if (mode() == StatusNotifier) {
-        _statusNotifierItemDBus->registerService();
-        registerToDaemon();
+void StatusNotifierItem::onModeChanged(Mode mode)
+{
+    if (mode == Mode::StatusNotifier) {
+        _statusNotifierItemDBus->registerTrayIcon();
+        registerToWatcher();
+    }
+    else {
+        _statusNotifierItemDBus->unregisterTrayIcon();
     }
 }
 
-
-void StatusNotifierItem::setState(State state_)
+void StatusNotifierItem::onStateChanged(State state)
 {
-    StatusNotifierItemParent::setState(state_);
-
-    emit _statusNotifierItemDBus->NewStatus(metaObject()->enumerator(metaObject()->indexOfEnumerator("State")).valueToKey(state()));
-    emit _statusNotifierItemDBus->NewIcon();
+    if (mode() == Mode::StatusNotifier) {
+        emit _statusNotifierItemDBus->NewStatus(metaObject()->enumerator(metaObject()->indexOfEnumerator("State")).valueToKey(state));
+    }
 }
 
-
-void StatusNotifierItem::setVisible(bool visible)
+void StatusNotifierItem::onVisibilityChanged(bool isVisible)
 {
-    if (visible == isVisible())
-        return;
-
-    LegacySystemTray::setVisible(visible);
-
-    if (mode() == StatusNotifier) {
-        if (shouldBeVisible()) {
-            _statusNotifierItemDBus->registerService();
-            registerToDaemon();
+    if (mode() == Mode::StatusNotifier) {
+        if (isVisible) {
+            _statusNotifierItemDBus->registerTrayIcon();
+            registerToWatcher();
         }
         else {
-            _statusNotifierItemDBus->unregisterService();
-            _statusNotifierWatcher->deleteLater();
-            _statusNotifierWatcher = 0;
+            _statusNotifierItemDBus->unregisterTrayIcon();
         }
     }
 }
 
-
 QString StatusNotifierItem::title() const
 {
     return QString("Quassel IRC");
 }
 
-
 QString StatusNotifierItem::iconName() const
 {
-    if (state() == Passive)
-        return QString("quassel-inactive");
-    else
-        return QString("quassel");
+    return currentIconName();
 }
 
-
 QString StatusNotifierItem::attentionIconName() const
 {
-    if (animationEnabled())
-        return QString("quassel-message");
-    else
-        return QString("quassel");
+    return currentAttentionIconName();
 }
 
-
 QString StatusNotifierItem::toolTipIconName() const
 {
-    return QString("quassel");
+    return "quassel";
 }
 
-
 QString StatusNotifierItem::iconThemePath() const
 {
     return _iconThemePath;
 }
 
-
 QString StatusNotifierItem::menuObjectPath() const
 {
-    return _menuObjectPath;
+    return kMenuObjectPath;
 }
 
-
-void StatusNotifierItem::activated(const QPoint &pos)
+void StatusNotifierItem::activated(const QPoint& pos)
 {
     Q_UNUSED(pos)
     activate(Trigger);
 }
 
-
-bool StatusNotifierItem::eventFilter(QObject *watched, QEvent *event)
+bool StatusNotifierItem::eventFilter(QObject* watched, QEvent* event)
 {
     if (mode() == StatusNotifier) {
-        //FIXME: ugly ugly workaround to weird QMenu's focus problems
-#ifdef HAVE_KDE4
-        if (watched == trayMenu() &&
-            (event->type() == QEvent::WindowDeactivate || (event->type() == QEvent::MouseButtonRelease && static_cast<QMouseEvent *>(event)->button() == Qt::LeftButton))) {
-            // put at the back of event queue to let the action activate anyways
-            QTimer::singleShot(0, trayMenu(), SLOT(hide()));
-        }
-#else
         if (watched == trayMenu() && event->type() == QEvent::HoverLeave) {
             trayMenu()->hide();
         }
-#endif
     }
     return StatusNotifierItemParent::eventFilter(watched, event);
 }
 
-
-void StatusNotifierItem::showMessage(const QString &title, const QString &message_, SystemTray::MessageIcon icon, int timeout, uint notificationId)
+void StatusNotifierItem::showMessage(const QString& title, const QString& message_, SystemTray::MessageIcon icon, int timeout, uint notificationId)
 {
     QString message = message_;
     if (_notificationsClient->isValid()) {
-        if (_notificationsClientSupportsMarkup)
-#if QT_VERSION < 0x050000
-            message = Qt::escape(message);
-#else
+        if (_notificationsClientSupportsMarkup) {
             message = message.toHtmlEscaped();
-#endif
+        }
 
         QStringList actions;
         if (_notificationsClientSupportsActions)
-            actions << "activate" << "View";
+            actions << "activate"
+                    << "View";
 
         // we always queue notifications right now
         QDBusReply<uint> reply = _notificationsClient->Notify(title, 0, "quassel", title, message, actions, QVariantMap(), timeout);
@@ -329,18 +334,18 @@ void StatusNotifierItem::showMessage(const QString &title, const QString &messag
         StatusNotifierItemParent::showMessage(title, message, icon, timeout, notificationId);
 }
 
-
 void StatusNotifierItem::closeMessage(uint notificationId)
 {
-    foreach(uint dbusid, _notificationsIdMap.keys()) {
+    for (auto&& dbusid : _notificationsIdMap.keys()) {
         if (_notificationsIdMap.value(dbusid) == notificationId) {
             _notificationsIdMap.remove(dbusid);
             _notificationsClient->CloseNotification(dbusid);
         }
     }
     _lastNotificationsDBusId = 0;
-}
 
+    StatusNotifierItemParent::closeMessage(notificationId);
+}
 
 void StatusNotifierItem::notificationClosed(uint dbusid, uint reason)
 {
@@ -349,12 +354,10 @@ void StatusNotifierItem::notificationClosed(uint dbusid, uint reason)
     emit messageClosed(_notificationsIdMap.take(dbusid));
 }
 
-
-void StatusNotifierItem::notificationInvoked(uint dbusid, const QString &action)
+void StatusNotifierItem::notificationInvoked(uint dbusid, const QString& action)
 {
     Q_UNUSED(action)
     emit messageClicked(_notificationsIdMap.value(dbusid, 0));
 }
 
-
 #endif