src/qt/notificator.cpp

   1 // Copyright (c) 2011-2016 The Bitcoin Core developers
   2 // Distributed under the MIT software license, see the accompanying
   3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   4
   5 #include "notificator.h"
   6
   7 #include <QApplication>
   8 #include <QByteArray>
   9 #include <QIcon>
  10 #include <QImageWriter>
  11 #include <QMessageBox>
  12 #include <QMetaType>
  13 #include <QStyle>
  14 #include <QSystemTrayIcon>
  15 #include <QTemporaryFile>
  16 #include <QVariant>
  17 #ifdef USE_DBUS
  18 #include <stdint.h>
  19 #include <QtDBus>
  20 #endif
  21 // Include ApplicationServices.h after QtDbus to avoid redefinition of check().
  22 // This affects at least OSX 10.6. See /usr/include/AssertMacros.h for details.
  23 // Note: This could also be worked around using:
  24 // #define __ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES 0
  25 #ifdef Q_OS_MAC
  26 #include <ApplicationServices/ApplicationServices.h>
  27 #include "macnotificationhandler.h"
  28 #endif
  29
  30
  31 #ifdef USE_DBUS
  32 // https://wiki.ubuntu.com/NotificationDevelopmentGuidelines recommends at least 128
  33 const int FREEDESKTOP_NOTIFICATION_ICON_SIZE = 128;
  34 #endif
  35
  36 Notificator::Notificator(const QString &_programName, QSystemTrayIcon *_trayIcon, QWidget *_parent) :
  37     QObject(_parent),
  38     parent(_parent),
  39     programName(_programName),
  40     mode(None),
  41     trayIcon(_trayIcon)
  42 #ifdef USE_DBUS
  43     ,interface(0)
  44 #endif
  45 {
  46     if(_trayIcon && _trayIcon->supportsMessages())
  47     {
  48         mode = QSystemTray;
  49     }
  50 #ifdef USE_DBUS
  51     interface = new QDBusInterface("org.freedesktop.Notifications",
  52         "/org/freedesktop/Notifications", "org.freedesktop.Notifications");
  53     if(interface->isValid())
  54     {
  55         mode = Freedesktop;
  56     }
  57 #endif
  58 #ifdef Q_OS_MAC
  59     // check if users OS has support for NSUserNotification
  60     if( MacNotificationHandler::instance()->hasUserNotificationCenterSupport()) {
  61         mode = UserNotificationCenter;
  62     }
  63 #endif
  64 }
  65
  66 Notificator::~Notificator()
  67 {
  68 #ifdef USE_DBUS
  69     delete interface;
  70 #endif
  71 }
  72
  73 #ifdef USE_DBUS
  74
  75 // Loosely based on http://www.qtcentre.org/archive/index.php/t-25879.html
  76 class FreedesktopImage
  77 {
  78 public:
  79     FreedesktopImage() {}
  80     explicit FreedesktopImage(const QImage &img);
  81
  82     static int metaType();
  83
  84     // Image to variant that can be marshalled over DBus
  85     static QVariant toVariant(const QImage &img);
  86
  87 private:
  88     int width, height, stride;
  89     bool hasAlpha;
  90     int channels;
  91     int bitsPerSample;
  92     QByteArray image;
  93
  94     friend QDBusArgument &operator<<(QDBusArgument &a, const FreedesktopImage &i);
  95     friend const QDBusArgument &operator>>(const QDBusArgument &a, FreedesktopImage &i);
  96 };
  97
  98 Q_DECLARE_METATYPE(FreedesktopImage);
  99
 100 // Image configuration settings
 101 const int CHANNELS = 4;
 102 const int BYTES_PER_PIXEL = 4;
 103 const int BITS_PER_SAMPLE = 8;
 104
 105 FreedesktopImage::FreedesktopImage(const QImage &img):
 106     width(img.width()),
 107     height(img.height()),
 108     stride(img.width() * BYTES_PER_PIXEL),
 109     hasAlpha(true),
 110     channels(CHANNELS),
 111     bitsPerSample(BITS_PER_SAMPLE)
 112 {
 113     // Convert 00xAARRGGBB to RGBA bytewise (endian-independent) format
 114     QImage tmp = img.convertToFormat(QImage::Format_ARGB32);
 115     const uint32_t *data = reinterpret_cast<const uint32_t*>(tmp.bits());
 116
 117     unsigned int num_pixels = width * height;
 118     image.resize(num_pixels * BYTES_PER_PIXEL);
 119
 120     for(unsigned int ptr = 0; ptr < num_pixels; ++ptr)
 121     {
 122         image[ptr*BYTES_PER_PIXEL+0] = data[ptr] >> 16; // R
 123         image[ptr*BYTES_PER_PIXEL+1] = data[ptr] >> 8;  // G
 124         image[ptr*BYTES_PER_PIXEL+2] = data[ptr];       // B
 125         image[ptr*BYTES_PER_PIXEL+3] = data[ptr] >> 24; // A
 126     }
 127 }
 128
 129 QDBusArgument &operator<<(QDBusArgument &a, const FreedesktopImage &i)
 130 {
 131     a.beginStructure();
 132     a << i.width << i.height << i.stride << i.hasAlpha << i.bitsPerSample << i.channels << i.image;
 133     a.endStructure();
 134     return a;
 135 }
 136
 137 const QDBusArgument &operator>>(const QDBusArgument &a, FreedesktopImage &i)
 138 {
 139     a.beginStructure();
 140     a >> i.width >> i.height >> i.stride >> i.hasAlpha >> i.bitsPerSample >> i.channels >> i.image;
 141     a.endStructure();
 142     return a;
 143 }
 144
 145 int FreedesktopImage::metaType()
 146 {
 147     return qDBusRegisterMetaType<FreedesktopImage>();
 148 }
 149
 150 QVariant FreedesktopImage::toVariant(const QImage &img)
 151 {
 152     FreedesktopImage fimg(img);
 153     return QVariant(FreedesktopImage::metaType(), &fimg);
 154 }
 155
 156 void Notificator::notifyDBus(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout)
 157 {
 158     Q_UNUSED(cls);
 159     // Arguments for DBus call:
 160     QList<QVariant> args;
 161
 162     // Program Name:
 163     args.append(programName);
 164
 165     // Unique ID of this notification type:
 166     args.append(0U);
 167
 168     // Application Icon, empty string
 169     args.append(QString());
 170
 171     // Summary
 172     args.append(title);
 173
 174     // Body
 175     args.append(text);
 176
 177     // Actions (none, actions are deprecated)
 178     QStringList actions;
 179     args.append(actions);
 180
 181     // Hints
 182     QVariantMap hints;
 183
 184     // If no icon specified, set icon based on class
 185     QIcon tmpicon;
 186     if(icon.isNull())
 187     {
 188         QStyle::StandardPixmap sicon = QStyle::SP_MessageBoxQuestion;
 189         switch(cls)
 190         {
 191         case Information: sicon = QStyle::SP_MessageBoxInformation; break;
 192         case Warning: sicon = QStyle::SP_MessageBoxWarning; break;
 193         case Critical: sicon = QStyle::SP_MessageBoxCritical; break;
 194         default: break;
 195         }
 196         tmpicon = QApplication::style()->standardIcon(sicon);
 197     }
 198     else
 199     {
 200         tmpicon = icon;
 201     }
 202     hints["icon_data"] = FreedesktopImage::toVariant(tmpicon.pixmap(FREEDESKTOP_NOTIFICATION_ICON_SIZE).toImage());
 203     args.append(hints);
 204
 205     // Timeout (in msec)
 206     args.append(millisTimeout);
 207
 208     // "Fire and forget"
 209     interface->callWithArgumentList(QDBus::NoBlock, "Notify", args);
 210 }
 211 #endif
 212
 213 void Notificator::notifySystray(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout)
 214 {
 215     Q_UNUSED(icon);
 216     QSystemTrayIcon::MessageIcon sicon = QSystemTrayIcon::NoIcon;
 217     switch(cls) // Set icon based on class
 218     {
 219     case Information: sicon = QSystemTrayIcon::Information; break;
 220     case Warning: sicon = QSystemTrayIcon::Warning; break;
 221     case Critical: sicon = QSystemTrayIcon::Critical; break;
 222     }
 223     trayIcon->showMessage(title, text, sicon, millisTimeout);
 224 }
 225
 226 // Based on Qt's tray icon implementation
 227 #ifdef Q_OS_MAC
 228 void Notificator::notifyMacUserNotificationCenter(Class cls, const QString &title, const QString &text, const QIcon &icon) {
 229     // icon is not supported by the user notification center yet. OSX will use the app icon.
 230     MacNotificationHandler::instance()->showNotification(title, text);
 231 }
 232
 233 #endif
 234
 235 void Notificator::notify(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout)
 236 {
 237     switch(mode)
 238     {
 239 #ifdef USE_DBUS
 240     case Freedesktop:
 241         notifyDBus(cls, title, text, icon, millisTimeout);
 242         break;
 243 #endif
 244     case QSystemTray:
 245         notifySystray(cls, title, text, icon, millisTimeout);
 246         break;
 247 #ifdef Q_OS_MAC
 248     case UserNotificationCenter:
 249         notifyMacUserNotificationCenter(cls, title, text, icon);
 250         break;
 251 #endif
 252     default:
 253         if(cls == Critical)
 254         {
 255             // Fall back to old fashioned pop-up dialog if critical and no other notification available
 256             QMessageBox::critical(parent, title, text, QMessageBox::Ok, QMessageBox::Ok);
 257         }
 258         break;
 259     }
 260 }