1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This contains code from KStatusNotifierItem, part of the KDE libs *
6 * Copyright (C) 2009 Marco Martin <notmart@gmail.com> *
8 * This file is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU Library General Public License (LGPL) *
10 * as published by the Free Software Foundation; either version 2 of the *
11 * License, or (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
22 ***************************************************************************/
26 #include <QApplication>
30 #include <QMouseEvent>
31 #include <QTextDocument>
35 #include "statusnotifieritem.h"
36 #include "statusnotifieritemdbus.h"
38 const int StatusNotifierItem::_protocolVersion = 0;
39 const QString StatusNotifierItem::_statusNotifierWatcherServiceName("org.kde.StatusNotifierWatcher");
42 # include "dbusmenuexporter.h"
45 * Specialization to provide access to icon names
47 class QuasselDBusMenuExporter : public DBusMenuExporter
50 QuasselDBusMenuExporter(const QString &dbusObjectPath, QMenu *menu, const QDBusConnection &dbusConnection)
51 : DBusMenuExporter(dbusObjectPath, menu, dbusConnection)
55 virtual QString iconNameForAction(QAction *action) // TODO Qt 4.7: fixme when we have converted our iconloader
57 QIcon icon(action->icon());
58 return icon.isNull() ? QString() : icon.name();
62 #endif /* HAVE_DBUSMENU */
64 StatusNotifierItem::StatusNotifierItem(QWidget *parent)
65 : StatusNotifierItemParent(parent)
66 #if QT_VERSION >= 0x050000
67 , _iconThemeDir{QDir::tempPath() + QLatin1String{"/quassel-sni-XXXXXX"}}
70 // Create a temporary directory that holds copies of the tray icons. That way, visualizers can find our icons.
71 // For Qt4 the relevant icons are installed in hicolor already, so nothing to be done.
72 #if QT_VERSION >= 0x050000
73 if (_iconThemeDir.isValid()) {
74 _iconThemePath = _iconThemeDir.path();
77 qWarning() << StatusNotifierItem::tr("Could not create temporary directory for themed tray icons: %1").arg(_iconThemeDir.errorString());
81 connect(QtUi::instance(), SIGNAL(iconThemeRefreshed()), this, SLOT(refreshIcons()));
85 StatusNotifierItem::~StatusNotifierItem()
87 delete _statusNotifierWatcher;
91 void StatusNotifierItem::init()
93 qDBusRegisterMetaType<DBusImageStruct>();
94 qDBusRegisterMetaType<DBusImageVector>();
95 qDBusRegisterMetaType<DBusToolTipStruct>();
99 _statusNotifierItemDBus = new StatusNotifierItemDBus(this);
101 connect(this, SIGNAL(toolTipChanged(QString, QString)), _statusNotifierItemDBus, SIGNAL(NewToolTip()));
102 connect(this, SIGNAL(animationEnabledChanged(bool)), _statusNotifierItemDBus, SIGNAL(NewAttentionIcon()));
104 QDBusServiceWatcher *watcher = new QDBusServiceWatcher(_statusNotifierWatcherServiceName,
105 QDBusConnection::sessionBus(),
106 QDBusServiceWatcher::WatchForOwnerChange,
108 connect(watcher, SIGNAL(serviceOwnerChanged(QString, QString, QString)), SLOT(serviceChange(QString, QString, QString)));
110 setMode(StatusNotifier);
112 _notificationsClient = new org::freedesktop::Notifications("org.freedesktop.Notifications", "/org/freedesktop/Notifications",
113 QDBusConnection::sessionBus(), this);
115 connect(_notificationsClient, SIGNAL(NotificationClosed(uint, uint)), SLOT(notificationClosed(uint, uint)));
116 connect(_notificationsClient, SIGNAL(ActionInvoked(uint, QString)), SLOT(notificationInvoked(uint, QString)));
118 if (_notificationsClient->isValid()) {
119 QStringList desktopCapabilities = _notificationsClient->GetCapabilities();
120 _notificationsClientSupportsMarkup = desktopCapabilities.contains("body-markup");
121 _notificationsClientSupportsActions = desktopCapabilities.contains("actions");
124 StatusNotifierItemParent::init();
125 trayMenu()->installEventFilter(this);
128 _menuObjectPath = "/MenuBar";
129 new QuasselDBusMenuExporter(menuObjectPath(), trayMenu(), _statusNotifierItemDBus->dbusConnection()); // will be added as menu child
134 void StatusNotifierItem::registerToDaemon()
136 if (!_statusNotifierWatcher) {
137 _statusNotifierWatcher = new org::kde::StatusNotifierWatcher(_statusNotifierWatcherServiceName,
138 "/StatusNotifierWatcher",
139 QDBusConnection::sessionBus());
140 connect(_statusNotifierWatcher, SIGNAL(StatusNotifierHostRegistered()), SLOT(checkForRegisteredHosts()));
141 connect(_statusNotifierWatcher, SIGNAL(StatusNotifierHostUnregistered()), SLOT(checkForRegisteredHosts()));
143 if (_statusNotifierWatcher->isValid()
144 && _statusNotifierWatcher->property("ProtocolVersion").toInt() == _protocolVersion) {
145 _statusNotifierWatcher->RegisterStatusNotifierItem(_statusNotifierItemDBus->service());
146 checkForRegisteredHosts();
149 //qDebug() << "StatusNotifierWatcher not reachable!";
155 void StatusNotifierItem::serviceChange(const QString &name, const QString &oldOwner, const QString &newOwner)
158 if (newOwner.isEmpty()) {
160 //qDebug() << "Connection to the StatusNotifierWatcher lost";
161 delete _statusNotifierWatcher;
162 _statusNotifierWatcher = nullptr;
165 else if (oldOwner.isEmpty()) {
167 setMode(StatusNotifier);
172 void StatusNotifierItem::checkForRegisteredHosts()
174 if (!_statusNotifierWatcher || !_statusNotifierWatcher->property("IsStatusNotifierHostRegistered").toBool())
177 setMode(StatusNotifier);
181 void StatusNotifierItem::refreshIcons()
183 #if QT_VERSION >= 0x050000
184 if (!_iconThemePath.isEmpty()) {
185 QDir baseDir{_iconThemePath + "/hicolor"};
186 baseDir.removeRecursively();
187 for (auto &&trayState : { State::Active, State::Passive, State::NeedsAttention }) {
188 auto iconName = SystemTray::iconName(trayState);
189 QIcon icon = QIcon::fromTheme(iconName);
190 if (!icon.isNull()) {
191 for (auto &&size : icon.availableSizes()) {
192 auto pixDir = QString{"%1/%2x%3/status"}.arg(baseDir.absolutePath()).arg(size.width()).arg(size.height());
193 QDir{}.mkpath(pixDir);
194 if (!icon.pixmap(size).save(pixDir + "/" + iconName + ".png")) {
195 qWarning() << "Could not save tray icon" << iconName << "for size" << size;
200 // No theme icon found; use fallback from resources
201 auto iconDir = QString{"%1/24x24/status"}.arg(baseDir.absolutePath());
202 QDir{}.mkpath(iconDir);
203 if (!QFile::copy(QString{":/icons/hicolor/24x24/status/%1.svg"}.arg(iconName),
204 QString{"%1/%2.svg"}.arg(iconDir, iconName))) {
205 qWarning() << "Could not access fallback tray icon" << iconName;
212 if (_statusNotifierItemDBus) {
213 emit _statusNotifierItemDBus->NewIcon();
214 emit _statusNotifierItemDBus->NewAttentionIcon();
219 bool StatusNotifierItem::isSystemTrayAvailable() const
221 if (mode() == StatusNotifier)
222 return true; // else it should be set to legacy on registration
224 return StatusNotifierItemParent::isSystemTrayAvailable();
228 bool StatusNotifierItem::isVisible() const
230 if (mode() == StatusNotifier)
231 return shouldBeVisible(); // we don't have a way to check, so we need to trust everything went right
233 return StatusNotifierItemParent::isVisible();
237 void StatusNotifierItem::setMode(Mode mode_)
242 if (mode_ != StatusNotifier) {
243 _statusNotifierItemDBus->unregisterService();
246 StatusNotifierItemParent::setMode(mode_);
248 if (mode() == StatusNotifier) {
249 _statusNotifierItemDBus->registerService();
255 void StatusNotifierItem::setState(State state_)
257 StatusNotifierItemParent::setState(state_);
259 emit _statusNotifierItemDBus->NewStatus(metaObject()->enumerator(metaObject()->indexOfEnumerator("State")).valueToKey(state()));
260 emit _statusNotifierItemDBus->NewIcon();
264 void StatusNotifierItem::setVisible(bool visible)
266 if (visible == isVisible())
269 LegacySystemTray::setVisible(visible);
271 if (mode() == StatusNotifier) {
272 if (shouldBeVisible()) {
273 _statusNotifierItemDBus->registerService();
277 _statusNotifierItemDBus->unregisterService();
278 _statusNotifierWatcher->deleteLater();
279 _statusNotifierWatcher = 0;
285 QString StatusNotifierItem::title() const
287 return QString("Quassel IRC");
291 QString StatusNotifierItem::iconName() const
293 if (state() == Passive) {
294 return SystemTray::iconName(State::Passive);
297 return SystemTray::iconName(State::Active);
302 QString StatusNotifierItem::attentionIconName() const
304 if (animationEnabled()) {
305 return SystemTray::iconName(State::NeedsAttention);
308 return SystemTray::iconName(State::Active);
313 QString StatusNotifierItem::toolTipIconName() const
319 QString StatusNotifierItem::iconThemePath() const
321 return _iconThemePath;
325 QString StatusNotifierItem::menuObjectPath() const
327 return _menuObjectPath;
331 void StatusNotifierItem::activated(const QPoint &pos)
338 bool StatusNotifierItem::eventFilter(QObject *watched, QEvent *event)
340 if (mode() == StatusNotifier) {
341 //FIXME: ugly ugly workaround to weird QMenu's focus problems
343 if (watched == trayMenu() &&
344 (event->type() == QEvent::WindowDeactivate || (event->type() == QEvent::MouseButtonRelease && static_cast<QMouseEvent *>(event)->button() == Qt::LeftButton))) {
345 // put at the back of event queue to let the action activate anyways
346 QTimer::singleShot(0, trayMenu(), SLOT(hide()));
349 if (watched == trayMenu() && event->type() == QEvent::HoverLeave) {
354 return StatusNotifierItemParent::eventFilter(watched, event);
358 void StatusNotifierItem::showMessage(const QString &title, const QString &message_, SystemTray::MessageIcon icon, int timeout, uint notificationId)
360 QString message = message_;
361 if (_notificationsClient->isValid()) {
362 if (_notificationsClientSupportsMarkup)
363 #if QT_VERSION < 0x050000
364 message = Qt::escape(message);
366 message = message.toHtmlEscaped();
370 if (_notificationsClientSupportsActions)
371 actions << "activate" << "View";
373 // we always queue notifications right now
374 QDBusReply<uint> reply = _notificationsClient->Notify(title, 0, "quassel", title, message, actions, QVariantMap(), timeout);
375 if (reply.isValid()) {
376 uint dbusid = reply.value();
377 _notificationsIdMap.insert(dbusid, notificationId);
378 _lastNotificationsDBusId = dbusid;
382 StatusNotifierItemParent::showMessage(title, message, icon, timeout, notificationId);
386 void StatusNotifierItem::closeMessage(uint notificationId)
388 foreach(uint dbusid, _notificationsIdMap.keys()) {
389 if (_notificationsIdMap.value(dbusid) == notificationId) {
390 _notificationsIdMap.remove(dbusid);
391 _notificationsClient->CloseNotification(dbusid);
394 _lastNotificationsDBusId = 0;
398 void StatusNotifierItem::notificationClosed(uint dbusid, uint reason)
401 _lastNotificationsDBusId = 0;
402 emit messageClosed(_notificationsIdMap.take(dbusid));
406 void StatusNotifierItem::notificationInvoked(uint dbusid, const QString &action)
409 emit messageClicked(_notificationsIdMap.value(dbusid, 0));