X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fqtui%2Fstatusnotifieritem.cpp;h=f3b362e9c451a6c189e2564e5da20cc4df4853dd;hp=841f0cf540254a025df7691030ec1cc85fb3408e;hb=ab7ef4d24f62b5848b628482b7762ebfc0b53e1a;hpb=732bb803a12b77b55aab33c91381ff9c2998f0e3 diff --git a/src/qtui/statusnotifieritem.cpp b/src/qtui/statusnotifieritem.cpp index 841f0cf5..f3b362e9 100644 --- a/src/qtui/statusnotifieritem.cpp +++ b/src/qtui/statusnotifieritem.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2012 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This contains code from KStatusNotifierItem, part of the KDE libs * @@ -18,22 +18,34 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ #ifdef HAVE_DBUS +#include "statusnotifieritem.h" + #include +#include +#include +#include #include #include #include +#include "icon.h" +#include "qtui.h" #include "quassel.h" -#include "statusnotifieritem.h" #include "statusnotifieritemdbus.h" -const int StatusNotifierItem::_protocolVersion = 0; -const QString StatusNotifierItem::_statusNotifierWatcherServiceName("org.kde.StatusNotifierWatcher"); +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" @@ -41,274 +53,328 @@ const QString StatusNotifierItem::_statusNotifierWatcherServiceName("org.kde.Sta /** * Specialization to provide access to icon names */ -class QuasselDBusMenuExporter : public DBusMenuExporter { +class QuasselDBusMenuExporter : public DBusMenuExporter +{ public: - QuasselDBusMenuExporter(const QString &dbusObjectPath, QMenu *menu, const QDBusConnection &dbusConnection) - : DBusMenuExporter(dbusObjectPath, menu, 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 - Icon icon(action->icon()); -#if QT_VERSION >= 0x040701 - // QIcon::name() is in the 4.7 git branch, but it is not in 4.7 TP. - // If you get a build error here, you need to update your pre-release - // of Qt 4.7. - return icon.isNull() ? QString() : icon.name(); -#else - return QString(); -#endif - } + virtual QString iconNameForAction(QAction *action) // TODO Qt 4.7: fixme when we have converted our iconloader + { + QIcon icon(action->icon()); + return icon.isNull() ? QString() : icon.name(); + } }; #endif /* HAVE_DBUSMENU */ StatusNotifierItem::StatusNotifierItem(QWidget *parent) - : StatusNotifierItemParent(parent), - _statusNotifierItemDBus(0), - _statusNotifierWatcher(0), - _notificationsClient(0), - _notificationsClientSupportsMarkup(true), - _lastNotificationsDBusId(0) + : StatusNotifierItemParent(parent) + , _iconThemeDir{QDir::tempPath() + QLatin1String{"/quassel-sni-XXXXXX"}} { + static bool registered = []() -> bool { + qDBusRegisterMetaType(); + qDBusRegisterMetaType(); + qDBusRegisterMetaType(); + return true; + }(); + Q_UNUSED(registered) -} - -StatusNotifierItem::~StatusNotifierItem() { - delete _statusNotifierWatcher; -} - -void StatusNotifierItem::init() { - qDBusRegisterMetaType(); - qDBusRegisterMetaType(); - qDBusRegisterMetaType(); - - _statusNotifierItemDBus = new StatusNotifierItemDBus(this); - - 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))); - - setMode(StatusNotifier); + setMode(Mode::StatusNotifier); - _notificationsClient = new org::freedesktop::Notifications("org.freedesktop.Notifications", "/org/freedesktop/Notifications", - QDBusConnection::sessionBus(), this); + connect(this, SIGNAL(visibilityChanged(bool)), this, SLOT(onVisibilityChanged(bool))); + connect(this, SIGNAL(modeChanged(Mode)), this, SLOT(onModeChanged(Mode))); + connect(this, SIGNAL(stateChanged(State)), this, SLOT(onStateChanged(State))); - connect(_notificationsClient, SIGNAL(NotificationClosed(uint,uint)), SLOT(notificationClosed(uint,uint))); - connect(_notificationsClient, SIGNAL(ActionInvoked(uint,QString)), SLOT(notificationInvoked(uint,QString))); + trayMenu()->installEventFilter(this); - if(_notificationsClient->isValid()) { - QStringList desktopCapabilities = _notificationsClient->GetCapabilities(); - _notificationsClientSupportsMarkup = desktopCapabilities.contains("body-markup"); - _notificationsClientSupportsActions = desktopCapabilities.contains("actions"); - } + // 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!"; + } - StatusNotifierItemParent::init(); - trayMenu()->installEventFilter(this); + connect(this, SIGNAL(iconsChanged()), this, SLOT(refreshIcons())); + refreshIcons(); + + // Our own SNI service + _statusNotifierItemDBus = new StatusNotifierItemDBus(this); + connect(this, SIGNAL(currentIconNameChanged()), _statusNotifierItemDBus, SIGNAL(NewIcon())); + connect(this, SIGNAL(currentIconNameChanged()), _statusNotifierItemDBus, SIGNAL(NewAttentionIcon())); + connect(this, SIGNAL(toolTipChanged(QString, QString)), _statusNotifierItemDBus, SIGNAL(NewToolTip())); + + // Service watcher to keep track of the StatusNotifierWatcher service + _serviceWatcher = new QDBusServiceWatcher(kSniWatcherService, + QDBusConnection::sessionBus(), + QDBusServiceWatcher::WatchForOwnerChange, + this); + connect(_serviceWatcher, SIGNAL(serviceOwnerChanged(QString, QString, QString)), SLOT(serviceChange(QString, QString, QString))); + + // Client instance for StatusNotifierWatcher + _statusNotifierWatcher = new org::kde::StatusNotifierWatcher(kSniWatcherService, + kSniWatcherPath, + QDBusConnection::sessionBus(), + this); + connect(_statusNotifierWatcher, SIGNAL(StatusNotifierHostRegistered()), SLOT(checkForRegisteredHosts())); + connect(_statusNotifierWatcher, SIGNAL(StatusNotifierHostUnregistered()), SLOT(checkForRegisteredHosts())); - // use the appdata icon folder for now - _iconThemePath = Quassel::findDataFilePath("icons"); + // Client instance for notifications + _notificationsClient = new org::freedesktop::Notifications(kXdgNotificationsService, + kXdgNotificationsPath, + QDBusConnection::sessionBus(), + this); + connect(_notificationsClient, SIGNAL(NotificationClosed(uint, uint)), SLOT(notificationClosed(uint, uint))); + connect(_notificationsClient, SIGNAL(ActionInvoked(uint, QString)), SLOT(notificationInvoked(uint, QString))); + + if (_notificationsClient->isValid()) { + QStringList desktopCapabilities = _notificationsClient->GetCapabilities(); + _notificationsClientSupportsMarkup = desktopCapabilities.contains("body-markup"); + _notificationsClientSupportsActions = desktopCapabilities.contains("actions"); + } #ifdef HAVE_DBUSMENU - _menuObjectPath = "/MenuBar"; - new QuasselDBusMenuExporter(menuObjectPath(), trayMenu(), _statusNotifierItemDBus->dbusConnection()); // will be added as menu child + new QuasselDBusMenuExporter(menuObjectPath(), trayMenu(), _statusNotifierItemDBus->dbusConnection()); // will be added as menu child #endif } -void StatusNotifierItem::registerToDaemon() { - 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(); - } else { - //qDebug() << "StatusNotifierWatcher not reachable!"; - setMode(Legacy); - } +void StatusNotifierItem::serviceChange(const QString &name, const QString &oldOwner, const QString &newOwner) +{ + Q_UNUSED(name); + if (newOwner.isEmpty()) { + //unregistered + setMode(Mode::Legacy); + } + else if (oldOwner.isEmpty()) { + //registered + setMode(Mode::StatusNotifier); + } } -void StatusNotifierItem::serviceChange(const QString& name, const QString& oldOwner, const QString& newOwner) { - Q_UNUSED(name); - if(newOwner.isEmpty()) { - //unregistered - //qDebug() << "Connection to the StatusNotifierWatcher lost"; - delete _statusNotifierWatcher; - _statusNotifierWatcher = 0; - setMode(Legacy); - } else if(oldOwner.isEmpty()) { - //registered - setMode(StatusNotifier); - } -} -void StatusNotifierItem::checkForRegisteredHosts() { - if(!_statusNotifierWatcher || !_statusNotifierWatcher->property("IsStatusNotifierHostRegistered").toBool()) - setMode(Legacy); - else - setMode(StatusNotifier); +void StatusNotifierItem::registerToWatcher() +{ + 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 { + setMode(Mode::Legacy); + } } -bool StatusNotifierItem::isSystemTrayAvailable() const { - if(mode() == StatusNotifier) - return true; // else it should be set to legacy on registration - return StatusNotifierItemParent::isSystemTrayAvailable(); +void StatusNotifierItem::checkForRegisteredHosts() +{ + if (!_statusNotifierWatcher || !_statusNotifierWatcher->property("IsStatusNotifierHostRegistered").toBool()) { + setMode(Mode::Legacy); + } + else { + setMode(Mode::StatusNotifier); + } } -bool StatusNotifierItem::isVisible() const { - if(mode() == StatusNotifier) - return shouldBeVisible(); // we don't have a way to check, so we need to trust everything went right - return StatusNotifierItemParent::isVisible(); +void StatusNotifierItem::onDBusError(const QDBusError &error) +{ + qWarning() << "StatusNotifierItem encountered a D-Bus error:" << error; + setMode(Mode::Legacy); } -void StatusNotifierItem::setMode(Mode mode_) { - if(mode_ == mode()) - return; - if(mode_ != StatusNotifier) { - _statusNotifierItemDBus->unregisterService(); - } +void StatusNotifierItem::refreshIcons() +{ + 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; + } + } + } + } + + if (_statusNotifierItemDBus) { + emit _statusNotifierItemDBus->NewIcon(); + emit _statusNotifierItemDBus->NewAttentionIcon(); + } +} + - StatusNotifierItemParent::setMode(mode_); +bool StatusNotifierItem::isSystemTrayAvailable() const +{ + if (mode() == Mode::StatusNotifier) { + return true; // else it should be set to legacy on registration + } - if(mode() == StatusNotifier) { - _statusNotifierItemDBus->registerService(); - registerToDaemon(); - } + return StatusNotifierItemParent::isSystemTrayAvailable(); } -void StatusNotifierItem::setState(State state_) { - StatusNotifierItemParent::setState(state_); - emit _statusNotifierItemDBus->NewStatus(metaObject()->enumerator(metaObject()->indexOfEnumerator("State")).valueToKey(state())); - emit _statusNotifierItemDBus->NewIcon(); +void StatusNotifierItem::onModeChanged(Mode mode) +{ + if (mode == Mode::StatusNotifier) { + _statusNotifierItemDBus->registerTrayIcon(); + registerToWatcher(); + } + else { + _statusNotifierItemDBus->unregisterTrayIcon(); + } } -void StatusNotifierItem::setVisible(bool visible) { - if(visible == isVisible()) - return; - LegacySystemTray::setVisible(visible); +void StatusNotifierItem::onStateChanged(State state) +{ + if (mode() == Mode::StatusNotifier) { + emit _statusNotifierItemDBus->NewStatus(metaObject()->enumerator(metaObject()->indexOfEnumerator("State")).valueToKey(state)); + } +} + - if(mode() == StatusNotifier) { - if(shouldBeVisible()) { - _statusNotifierItemDBus->registerService(); - registerToDaemon(); - } else { - _statusNotifierItemDBus->unregisterService(); - _statusNotifierWatcher->deleteLater(); - _statusNotifierWatcher = 0; +void StatusNotifierItem::onVisibilityChanged(bool isVisible) +{ + if (mode() == Mode::StatusNotifier) { + if (isVisible) { + _statusNotifierItemDBus->registerTrayIcon(); + registerToWatcher(); + } + else { + _statusNotifierItemDBus->unregisterTrayIcon(); + } } - } } -QString StatusNotifierItem::title() const { - return QString("Quassel IRC"); + +QString StatusNotifierItem::title() const +{ + return QString("Quassel IRC"); } -QString StatusNotifierItem::iconName() const { - if(state() == Passive) - return QString("quassel-inactive"); - else - return QString("quassel"); + +QString StatusNotifierItem::iconName() const +{ + return currentIconName(); } -QString StatusNotifierItem::attentionIconName() const { - if(animationEnabled()) - return QString("quassel-message"); - else - return QString("quassel"); + +QString StatusNotifierItem::attentionIconName() const +{ + return currentAttentionIconName(); } -QString StatusNotifierItem::toolTipIconName() const { - return QString("quassel"); + +QString StatusNotifierItem::toolTipIconName() const +{ + return "quassel"; } -QString StatusNotifierItem::iconThemePath() const { - return _iconThemePath; + +QString StatusNotifierItem::iconThemePath() const +{ + return _iconThemePath; } -QString StatusNotifierItem::menuObjectPath() const { - return _menuObjectPath; + +QString StatusNotifierItem::menuObjectPath() const +{ + return kMenuObjectPath; } -void StatusNotifierItem::activated(const QPoint &pos) { - Q_UNUSED(pos) - activate(Trigger); + +void StatusNotifierItem::activated(const QPoint &pos) +{ + Q_UNUSED(pos) + activate(Trigger); } -bool StatusNotifierItem::eventFilter(QObject *watched, QEvent *event) { - if(mode() == StatusNotifier) { - //FIXME: ugly ugly workaround to weird QMenu's focus problems -#ifdef HAVE_KDE - if(watched == trayMenu() && - (event->type() == QEvent::WindowDeactivate || (event->type() == QEvent::MouseButtonRelease && static_cast(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(); + +bool StatusNotifierItem::eventFilter(QObject *watched, QEvent *event) +{ + if (mode() == StatusNotifier) { + if (watched == trayMenu() && event->type() == QEvent::HoverLeave) { + trayMenu()->hide(); + } } -#endif - } - return StatusNotifierItemParent::eventFilter(watched, event); + return StatusNotifierItemParent::eventFilter(watched, event); } -void StatusNotifierItem::showMessage(const QString &title, const QString &message_, SystemTray::MessageIcon icon, int timeout, uint notificationId) { - QString message = message_; - if(_notificationsClient->isValid()) { - if(_notificationsClientSupportsMarkup) - message = Qt::escape(message); - - QStringList actions; - if(_notificationsClientSupportsActions) - actions << "activate" << "View"; - - // we always queue notifications right now - QDBusReply reply = _notificationsClient->Notify(title, 0, "quassel", title, message, actions, QVariantMap(), timeout); - if(reply.isValid()) { - uint dbusid = reply.value(); - _notificationsIdMap.insert(dbusid, notificationId); - _lastNotificationsDBusId = dbusid; + +void StatusNotifierItem::showMessage(const QString &title, const QString &message_, SystemTray::MessageIcon icon, int timeout, uint notificationId) +{ + QString message = message_; + if (_notificationsClient->isValid()) { + if (_notificationsClientSupportsMarkup) { + message = message.toHtmlEscaped(); + } + + QStringList actions; + if (_notificationsClientSupportsActions) + actions << "activate" << "View"; + + // we always queue notifications right now + QDBusReply reply = _notificationsClient->Notify(title, 0, "quassel", title, message, actions, QVariantMap(), timeout); + if (reply.isValid()) { + uint dbusid = reply.value(); + _notificationsIdMap.insert(dbusid, notificationId); + _lastNotificationsDBusId = dbusid; + } } - } else - StatusNotifierItemParent::showMessage(title, message, icon, timeout, notificationId); + else + StatusNotifierItemParent::showMessage(title, message, icon, timeout, notificationId); } -void StatusNotifierItem::closeMessage(uint notificationId) { - foreach(uint dbusid, _notificationsIdMap.keys()) { - if(_notificationsIdMap.value(dbusid) == notificationId) { - _notificationsIdMap.remove(dbusid); - _notificationsClient->CloseNotification(dbusid); + +void StatusNotifierItem::closeMessage(uint notificationId) +{ + for (auto &&dbusid : _notificationsIdMap.keys()) { + if (_notificationsIdMap.value(dbusid) == notificationId) { + _notificationsIdMap.remove(dbusid); + _notificationsClient->CloseNotification(dbusid); + } } - } - _lastNotificationsDBusId = 0; + _lastNotificationsDBusId = 0; + + StatusNotifierItemParent::closeMessage(notificationId); } -void StatusNotifierItem::notificationClosed(uint dbusid, uint reason) { - Q_UNUSED(reason) - _lastNotificationsDBusId = 0; - emit messageClosed(_notificationsIdMap.take(dbusid)); + +void StatusNotifierItem::notificationClosed(uint dbusid, uint reason) +{ + Q_UNUSED(reason) + _lastNotificationsDBusId = 0; + emit messageClosed(_notificationsIdMap.take(dbusid)); } -void StatusNotifierItem::notificationInvoked(uint dbusid, const QString &action) { - Q_UNUSED(action) - emit messageClicked(_notificationsIdMap.value(dbusid, 0)); + +void StatusNotifierItem::notificationInvoked(uint dbusid, const QString &action) +{ + Q_UNUSED(action) + emit messageClicked(_notificationsIdMap.value(dbusid, 0)); } + #endif