src/qtui/statusnotifieritem.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2010 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This contains code from KStatusNotifierItem, part of the KDE libs     *
   6  *   Copyright (C) 2009 Marco Martin <notmart@gmail.com>                   *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) version 3.                                           *
  12  *                                                                         *
  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.                          *
  17  *                                                                         *
  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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23
  24 #ifdef HAVE_DBUS
  25
  26 #include "statusnotifieritem.h"
  27 #include "statusnotifieritemdbus.h"
  28
  29 #include <QApplication>
  30 #include <QMenu>
  31 #include <QMouseEvent>
  32 #include <QTextDocument>
  33
  34 const int StatusNotifierItem::_protocolVersion = 0;
  35
  36 StatusNotifierItem::StatusNotifierItem(QWidget *parent)
  37   : StatusNotifierItemParent(parent),
  38   _statusNotifierItemDBus(0),
  39   _statusNotifierWatcher(0),
  40   _notificationsClient(0),
  41   _notificationsClientSupportsMarkup(true),
  42   _lastNotificationsDBusId(0)
  43 {
  44
  45 }
  46
  47 StatusNotifierItem::~StatusNotifierItem() {
  48   delete _statusNotifierWatcher;
  49 }
  50
  51 void StatusNotifierItem::init() {
  52   qDBusRegisterMetaType<DBusImageStruct>();
  53   qDBusRegisterMetaType<DBusImageVector>();
  54   qDBusRegisterMetaType<DBusToolTipStruct>();
  55
  56   _statusNotifierItemDBus = new StatusNotifierItemDBus(this);
  57
  58   connect(this, SIGNAL(toolTipChanged(QString,QString)), _statusNotifierItemDBus, SIGNAL(NewToolTip()));
  59   connect(this, SIGNAL(animationEnabledChanged(bool)), _statusNotifierItemDBus, SIGNAL(NewAttentionIcon()));
  60
  61   connect(QDBusConnection::sessionBus().interface(), SIGNAL(serviceOwnerChanged(QString,QString,QString)),
  62                                                      SLOT(serviceChange(QString,QString,QString)));
  63
  64   setMode(StatusNotifier);
  65
  66   _notificationsClient = new org::freedesktop::Notifications("org.freedesktop.Notifications", "/org/freedesktop/Notifications",
  67                                                              QDBusConnection::sessionBus(), this);
  68
  69   connect(_notificationsClient, SIGNAL(NotificationClosed(uint,uint)), SLOT(notificationClosed(uint,uint)));
  70   connect(_notificationsClient, SIGNAL(ActionInvoked(uint,QString)), SLOT(notificationInvoked(uint,QString)));
  71
  72   if(_notificationsClient->isValid()) {
  73     QStringList desktopCapabilities = _notificationsClient->GetCapabilities();
  74     _notificationsClientSupportsMarkup = desktopCapabilities.contains("body-markup");
  75   }
  76
  77   StatusNotifierItemParent::init();
  78   trayMenu()->installEventFilter(this);
  79 }
  80
  81 void StatusNotifierItem::registerToDaemon() {
  82   if(!_statusNotifierWatcher) {
  83     QString interface("org.kde.StatusNotifierWatcher");
  84     _statusNotifierWatcher = new org::kde::StatusNotifierWatcher(interface, "/StatusNotifierWatcher",
  85                                                                  QDBusConnection::sessionBus());
  86   }
  87   if(_statusNotifierWatcher->isValid()
  88     && _statusNotifierWatcher->property("ProtocolVersion").toInt() == _protocolVersion) {
  89
  90     _statusNotifierWatcher->RegisterStatusNotifierItem(_statusNotifierItemDBus->service());
  91
  92   } else {
  93     //qDebug() << "StatusNotifierWatcher not reachable!";
  94     setMode(Legacy);
  95   }
  96 }
  97
  98 // FIXME remove deprecated slot with Qt 4.6
  99 void StatusNotifierItem::serviceChange(const QString& name, const QString& oldOwner, const QString& newOwner) {
 100   bool legacy = false;
 101   if(name == "org.kde.StatusNotifierWatcher") {
 102     if(newOwner.isEmpty()) {
 103       //unregistered
 104       //qDebug() << "Connection to the StatusNotifierWatcher lost";
 105       legacy = true;
 106     } else if(oldOwner.isEmpty()) {
 107       //registered
 108       legacy = false;
 109     }
 110   } else if(name.startsWith(QLatin1String("org.kde.StatusNotifierHost-"))) {
 111     if(newOwner.isEmpty() && (!_statusNotifierWatcher ||
 112                               !_statusNotifierWatcher->property("IsStatusNotifierHostRegistered").toBool())) {
 113       //qDebug() << "Connection to the last StatusNotifierHost lost";
 114       legacy = true;
 115     } else if(oldOwner.isEmpty()) {
 116       //qDebug() << "New StatusNotifierHost";
 117       legacy = false;
 118     }
 119   } else {
 120     return;
 121   }
 122
 123   // qDebug() << "Service " << name << "status change, old owner:" << oldOwner << "new:" << newOwner;
 124
 125   if(legacy == (mode() == Legacy)) {
 126     return;
 127   }
 128
 129   if(legacy) {
 130     //unregistered
 131     setMode(Legacy);
 132   } else {
 133     //registered
 134     setMode(StatusNotifier);
 135   }
 136 }
 137
 138 bool StatusNotifierItem::isSystemTrayAvailable() const {
 139   if(mode() == StatusNotifier)
 140     return true; // else it should be set to legacy on registration
 141
 142   return StatusNotifierItemParent::isSystemTrayAvailable();
 143 }
 144
 145 bool StatusNotifierItem::isVisible() const {
 146   if(mode() == StatusNotifier)
 147     return shouldBeVisible(); // we don't have a way to check, so we need to trust everything went right
 148
 149   return StatusNotifierItemParent::isVisible();
 150 }
 151
 152 void StatusNotifierItem::setMode(Mode mode_) {
 153   StatusNotifierItemParent::setMode(mode_);
 154
 155   if(mode() == StatusNotifier) {
 156     registerToDaemon();
 157   }
 158 }
 159
 160 void StatusNotifierItem::setState(State state_) {
 161   StatusNotifierItemParent::setState(state_);
 162
 163   emit _statusNotifierItemDBus->NewStatus(metaObject()->enumerator(metaObject()->indexOfEnumerator("State")).valueToKey(state()));
 164   emit _statusNotifierItemDBus->NewIcon();
 165 }
 166
 167 void StatusNotifierItem::setVisible(bool visible) {
 168   LegacySystemTray::setVisible(visible);
 169
 170   if(mode() == StatusNotifier) {
 171     if(shouldBeVisible()) {
 172       _statusNotifierItemDBus->registerService();
 173       registerToDaemon();
 174     } else {
 175       _statusNotifierItemDBus->unregisterService();
 176       _statusNotifierWatcher->deleteLater();
 177       _statusNotifierWatcher = 0;
 178     }
 179   }
 180 }
 181
 182 QString StatusNotifierItem::title() const {
 183   return QString("Quassel IRC");
 184 }
 185
 186 QString StatusNotifierItem::iconName() const {
 187   if(state() == Passive)
 188     return QString("quassel_inactive");
 189   else
 190     return QString("quassel");
 191 }
 192
 193 QString StatusNotifierItem::attentionIconName() const {
 194   if(animationEnabled())
 195     return QString("quassel_message");
 196   else
 197     return QString("quassel");
 198 }
 199
 200 QString StatusNotifierItem::toolTipIconName() const {
 201   return QString("quassel");
 202 }
 203
 204 void StatusNotifierItem::activated(const QPoint &pos) {
 205   Q_UNUSED(pos)
 206   activate(Trigger);
 207 }
 208
 209 bool StatusNotifierItem::eventFilter(QObject *watched, QEvent *event) {
 210   if(mode() == StatusNotifier) {
 211     //FIXME: ugly ugly workaround to weird QMenu's focus problems
 212 #ifdef HAVE_KDE
 213     if(watched == trayMenu() &&
 214        (event->type() == QEvent::WindowDeactivate || (event->type() == QEvent::MouseButtonRelease && static_cast<QMouseEvent*>(event)->button() == Qt::LeftButton))) {
 215       // put at the back of event queue to let the action activate anyways
 216       QTimer::singleShot(0, trayMenu(), SLOT(hide()));
 217     }
 218 #else
 219     if(watched == trayMenu() && event->type() == QEvent::HoverLeave) {
 220       trayMenu()->hide();
 221     }
 222 #endif
 223   }
 224   return StatusNotifierItemParent::eventFilter(watched, event);
 225 }
 226
 227 void StatusNotifierItem::showMessage(const QString &title, const QString &message_, SystemTray::MessageIcon icon, int timeout, uint notificationId) {
 228   QString message = message_;
 229   if(_notificationsClient->isValid()) {
 230     if(_notificationsClientSupportsMarkup)
 231       message = Qt::escape(message);
 232
 233     QStringList actions = QStringList() << "activate" << "View";
 234
 235     // we always queue notifications right now
 236     QDBusReply<uint> reply = _notificationsClient->Notify(title, 0, "quassel", title, message, actions, QVariantMap(), timeout);
 237     if(reply.isValid()) {
 238       uint dbusid = reply.value();
 239       _notificationsIdMap.insert(dbusid, notificationId);
 240       _lastNotificationsDBusId = dbusid;
 241     }
 242   } else
 243     StatusNotifierItemParent::showMessage(title, message, icon, timeout, notificationId);
 244 }
 245
 246 void StatusNotifierItem::closeMessage(uint notificationId) {
 247   foreach(uint dbusid, _notificationsIdMap.keys()) {
 248     if(_notificationsIdMap.value(dbusid) == notificationId) {
 249       _notificationsIdMap.remove(dbusid);
 250       _notificationsClient->CloseNotification(dbusid);
 251     }
 252   }
 253   _lastNotificationsDBusId = 0;
 254 }
 255
 256 void StatusNotifierItem::notificationClosed(uint dbusid, uint reason) {
 257   Q_UNUSED(reason)
 258   _lastNotificationsDBusId = 0;
 259   emit messageClosed(_notificationsIdMap.take(dbusid));
 260 }
 261
 262 void StatusNotifierItem::notificationInvoked(uint dbusid, const QString &action) {
 263   Q_UNUSED(action)
 264   emit messageClicked(_notificationsIdMap.value(dbusid, 0));
 265 }
 266
 267 #endif