(k)ubuntu 10.04+ notification support (based on @zwierzak his code)

6 files changed, 337 insertions, 29 deletions

diff --git a/README.rst b/README.rst
index ceaebc1bc4..b9485f4d1f 100644
--- a/README.rst
+++ b/README.rst
@@ -8,9 +8,9 @@ Features
 
 - Compatibility with Linux (both GNOME and KDE), MacOSX and Windows
 
-- Splash screen
+- Notification on incoming / outgoing transactions (compatible with FreeDesktop and other desktop notification schemes)
 
-- Tabbed interface
+- General interface improvements: Splash screen, tabbed interface
 
 - Overview page with current balance, unconfirmed balance, and such
 
@@ -32,7 +32,7 @@ Features
 
 - Address books and transaction table can be sorted by any column
 
-- Accepts "bitcoin:" URLs from browsers through drag and drop
+- Accepts "bitcoin:" URLs from browsers and other sources through drag and drop
 
 Build instructions 
 ===================
@@ -79,8 +79,11 @@ Windows build instructions:
 .. [#] PGP signature: http://download.visucore.com/bitcoin/qtgui_deps_1.zip.sig (signed with RSA key ID `610945D0`_)
 .. _`610945D0`: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x610945D0
 
+Build configuration options
+============================
+
 UPNnP port forwarding
-=====================
+---------------------
 
 To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable bitcoin experience), pass the following argument to qmake:
 
@@ -103,6 +106,16 @@ Set USE_UPNP to a different value to control this:
 | USE_UPNP=1 | UPnP support turned on by default at runtime.                |
 +------------+--------------------------------------------------------------+
 
+Notification support for recent (k)ubuntu versions
+---------------------------------------------------
+
+To see desktop notifications on (k)ubuntu versions starting from 10.04, enable usage of the 
+FreeDesktop notification interface through DBUS using the following qmake option:
+
+::
+
+    qmake "USE_DBUS=1"
+
 Berkely DB version warning
 ==========================
 
diff --git a/bitcoin-qt.pro b/bitcoin-qt.pro
index 951296891a..053dc70850 100644
--- a/bitcoin-qt.pro
+++ b/bitcoin-qt.pro
@@ -22,6 +22,12 @@ count(USE_UPNP, 1) {
     LIBS += -lminiupnpc
 }
 
+count(USE_DBUS, 1) {
+    message(Building with DBUS (Freedesktop notifications) support)
+    DEFINES += QT_DBUS
+    QT += dbus
+}
+
 # for extra security against potential buffer overflows
 QMAKE_CXXFLAGS += -fstack-protector 
 QMAKE_LFLAGS += -fstack-protector
@@ -100,7 +106,8 @@ HEADERS += src/qt/bitcoingui.h \
     src/qt/bitcoinunits.h \
     src/qt/qvaluecombobox.h \
     src/qt/askpassphrasedialog.h \
-    src/protocol.h
+    src/protocol.h \
+    src/qt/notificator.h
 
 SOURCES += src/qt/bitcoin.cpp src/qt/bitcoingui.cpp \
     src/qt/transactiontablemodel.cpp \
@@ -147,7 +154,8 @@ SOURCES += src/qt/bitcoin.cpp src/qt/bitcoingui.cpp \
     src/qt/bitcoinunits.cpp \
     src/qt/qvaluecombobox.cpp \
     src/qt/askpassphrasedialog.cpp \
-    src/protocol.cpp
+    src/protocol.cpp \
+    src/qt/notificator.cpp
 
 RESOURCES += \
     src/qt/bitcoin.qrc
diff --git a/src/qt/bitcoingui.cpp b/src/qt/bitcoingui.cpp
index e15941e7dd..95646b1df1 100644
--- a/src/qt/bitcoingui.cpp
+++ b/src/qt/bitcoingui.cpp
@@ -20,6 +20,7 @@
 #include "bitcoinunits.h"
 #include "guiconstants.h"
 #include "askpassphrasedialog.h"
+#include "notificator.h"
 
 #include <QApplication>
 #include <QMainWindow>
@@ -51,7 +52,8 @@ BitcoinGUI::BitcoinGUI(QWidget *parent):
     walletModel(0),
     encryptWalletAction(0),
     changePassphraseAction(0),
-    trayIcon(0)
+    trayIcon(0),
+    notificator(0)
 {
     resize(850, 550);
     setWindowTitle(tr("Bitcoin Wallet"));
@@ -287,6 +289,8 @@ void BitcoinGUI::createTrayIcon()
     connect(trayIcon, SIGNAL(activated(QSystemTrayIcon::ActivationReason)),
             this, SLOT(trayIconActivated(QSystemTrayIcon::ActivationReason)));
     trayIcon->show();
+
+    notificator = new Notificator(tr("bitcoin-qt"), trayIcon);
 }
 
 void BitcoinGUI::trayIconActivated(QSystemTrayIcon::ActivationReason reason)
@@ -394,18 +398,7 @@ void BitcoinGUI::setNumBlocks(int count)
 void BitcoinGUI::error(const QString &title, const QString &message)
 {
     // Report errors from network/worker thread
-    if(trayIcon->supportsMessages())
-    {
-        // Show as "balloon" message if possible
-        trayIcon->showMessage(title, message, QSystemTrayIcon::Critical);
-    }
-    else
-    {
-        // Fall back to old fashioned popup dialog if not
-        QMessageBox::critical(this, title,
-            message,
-            QMessageBox::Ok, QMessageBox::Ok);
-    }
+    notificator->notify(Notificator::Critical, title, message);
 }
 
 void BitcoinGUI::changeEvent(QEvent *e)
@@ -453,8 +446,6 @@ void BitcoinGUI::askFee(qint64 nFeeRequired, bool *payFee)
 
 void BitcoinGUI::incomingTransaction(const QModelIndex & parent, int start, int end)
 {
-    if(start == end)
-        return;
     TransactionTableModel *ttm = walletModel->getTransactionTableModel();
     qint64 amount = ttm->index(start, TransactionTableModel::Amount, parent)
                     .data(Qt::EditRole).toULongLong();
@@ -468,14 +459,21 @@ void BitcoinGUI::incomingTransaction(const QModelIndex & parent, int start, int
                         .data().toString();
         QString address = ttm->index(start, TransactionTableModel::ToAddress, parent)
                         .data().toString();
-
-        trayIcon->showMessage((amount)<0 ? tr("Sent transaction") :
-                                           tr("Incoming transaction"),
-                              tr("Date: ") + date + "\n" +
-                              tr("Amount: ") + BitcoinUnits::formatWithUnit(walletModel->getOptionsModel()->getDisplayUnit(), amount, true) + "\n" +
-                              tr("Type: ") + type + "\n" +
-                              tr("Address: ") + address + "\n",
-                              QSystemTrayIcon::Information);
+        QIcon icon = qvariant_cast<QIcon>(ttm->index(start,
+                            TransactionTableModel::ToAddress, parent)
+                        .data(Qt::DecorationRole));
+
+        notificator->notify(Notificator::Information,
+                            (amount)<0 ? tr("Sent transaction") :
+                                         tr("Incoming transaction"),
+                              tr("Date: %1\n"
+                                 "Amount: %2\n"
+                                 "Type: %3\n"
+                                 "Address: %4\n")
+                              .arg(date)
+                              .arg(BitcoinUnits::formatWithUnit(walletModel->getOptionsModel()->getDisplayUnit(), amount, true))
+                              .arg(type)
+                              .arg(address), icon);
     }
 }
 
diff --git a/src/qt/bitcoingui.h b/src/qt/bitcoingui.h
index 484987ca68..59661350c3 100644
--- a/src/qt/bitcoingui.h
+++ b/src/qt/bitcoingui.h
@@ -11,6 +11,7 @@ class TransactionView;
 class OverviewPage;
 class AddressBookPage;
 class SendCoinsDialog;
+class Notificator;
 
 QT_BEGIN_NAMESPACE
 class QLabel;
@@ -77,6 +78,7 @@ private:
     QAction *changePassphraseAction;
 
     QSystemTrayIcon *trayIcon;
+    Notificator *notificator;
     TransactionView *transactionView;
 
     QMovie *syncIconMovie;
diff --git a/src/qt/notificator.cpp b/src/qt/notificator.cpp
new file mode 100644
index 0000000000..86ccfc8541
--- /dev/null
+++ b/src/qt/notificator.cpp
@@ -0,0 +1,224 @@
+#include "notificator.h"
+
+#include <QMetaType>
+#include <QVariant>
+#include <QIcon>
+#include <QApplication>
+#include <QStyle>
+#include <QByteArray>
+#include <QSystemTrayIcon>
+#include <QMessageBox>
+
+#ifdef QT_DBUS
+#include <QtDBus/QtDBus>
+#include <stdint.h>
+#endif
+
+// https://wiki.ubuntu.com/NotificationDevelopmentGuidelines recommends at least 128
+const int FREEDESKTOP_NOTIFICATION_ICON_SIZE = 128;
+
+Notificator::Notificator(const QString &programName, QSystemTrayIcon *trayicon, QWidget *parent):
+    QObject(parent),
+    parent(parent),
+    programName(programName),
+    mode(None),
+    trayIcon(trayicon)
+#ifdef QT_DBUS
+    ,interface(0)
+#endif
+{
+    if(trayicon && trayicon->supportsMessages())
+    {
+        mode = QSystemTray;
+    }
+#ifdef QT_DBUS
+    interface = new QDBusInterface("org.freedesktop.Notifications",
+          "/org/freedesktop/Notifications", "org.freedesktop.Notifications");
+    if(interface->isValid())
+    {
+        mode = Freedesktop;
+    }
+#endif
+}
+
+Notificator::~Notificator()
+{
+#ifdef QT_DBUS
+    delete interface;
+#endif
+}
+
+#ifdef QT_DBUS
+
+// Loosely based on http://www.qtcentre.org/archive/index.php/t-25879.html
+class FreedesktopImage
+{
+public:
+    FreedesktopImage() {}
+    FreedesktopImage(const QImage &img);
+
+    static int metaType();
+
+    // Image to variant that can be marshaled over DBus
+    static QVariant toVariant(const QImage &img);
+
+private:
+    int width, height, stride;
+    bool hasAlpha;
+    int channels;
+    int bitsPerSample;
+    QByteArray image;
+
+    friend QDBusArgument &operator<<(QDBusArgument &a, const FreedesktopImage &i);
+    friend const QDBusArgument &operator>>(const QDBusArgument &a, FreedesktopImage &i);
+};
+
+Q_DECLARE_METATYPE(FreedesktopImage);
+
+// Image configuration settings
+const int CHANNELS = 4;
+const int BYTES_PER_PIXEL = 4;
+const int BITS_PER_SAMPLE = 8;
+
+FreedesktopImage::FreedesktopImage(const QImage &img):
+    width(img.width()),
+    height(img.height()),
+    stride(img.width() * BYTES_PER_PIXEL),
+    hasAlpha(true),
+    channels(CHANNELS),
+    bitsPerSample(BITS_PER_SAMPLE)
+{
+    // Convert 00xAARRGGBB to RGBA bytewise (endian-independent) format
+    QImage tmp = img.convertToFormat(QImage::Format_ARGB32);
+    const uint32_t *data = reinterpret_cast<const uint32_t*>(tmp.constBits());
+
+    unsigned int num_pixels = width * height;
+    image.resize(num_pixels * BYTES_PER_PIXEL);
+
+    for(unsigned int ptr = 0; ptr < num_pixels; ++ptr)
+    {
+        image[ptr*BYTES_PER_PIXEL+0] = data[ptr] >> 16; // R
+        image[ptr*BYTES_PER_PIXEL+1] = data[ptr] >> 8;  // G
+        image[ptr*BYTES_PER_PIXEL+2] = data[ptr];       // B
+        image[ptr*BYTES_PER_PIXEL+3] = data[ptr] >> 24; // A
+    }
+}
+
+QDBusArgument &operator<<(QDBusArgument &a, const FreedesktopImage &i)
+{
+    a.beginStructure();
+    a << i.width << i.height << i.stride << i.hasAlpha << i.bitsPerSample << i.channels << i.image;
+    a.endStructure();
+    return a;
+}
+
+const QDBusArgument &operator>>(const QDBusArgument &a, FreedesktopImage &i)
+{
+    a.beginStructure();
+    a >> i.width >> i.height >> i.stride >> i.hasAlpha >> i.bitsPerSample >> i.channels >> i.image;
+    a.endStructure();
+    return a;
+}
+
+int FreedesktopImage::metaType()
+{
+    return qDBusRegisterMetaType<FreedesktopImage>();
+}
+
+QVariant FreedesktopImage::toVariant(const QImage &img)
+{
+    FreedesktopImage fimg(img);
+    return QVariant(FreedesktopImage::metaType(), &fimg);
+}
+
+void Notificator::notifyDBus(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout)
+{
+    Q_UNUSED(cls);
+    // Arguments for DBus call:
+    QList<QVariant> args;
+
+    // Program Name:
+    args.append(programName);
+
+    // Unique ID of this notification type:
+    args.append(0U);
+
+    // Application Icon, empty string
+    args.append(QString());
+
+    // Summary
+    args.append(title);
+
+    // Body
+    args.append(text);
+
+    // Actions (none, actions are deprecated)
+    QStringList actions;
+    args.append(actions);
+
+    // Hints
+    QVariantMap hints;
+
+    // If no icon specified, set icon based on class
+    QIcon tmpicon;
+    if(icon.isNull())
+    {
+        QStyle::StandardPixmap sicon = QStyle::SP_MessageBoxQuestion;
+        switch(cls)
+        {
+        case Information: sicon = QStyle::SP_MessageBoxInformation; break;
+        case Warning: sicon = QStyle::SP_MessageBoxWarning; break;
+        case Critical: sicon = QStyle::SP_MessageBoxCritical; break;
+        default: break;
+        }
+        tmpicon = QApplication::style()->standardIcon(sicon);
+    }
+    else
+    {
+        tmpicon = icon;
+    }
+    hints["icon_data"] = FreedesktopImage::toVariant(tmpicon.pixmap(FREEDESKTOP_NOTIFICATION_ICON_SIZE).toImage());
+    args.append(hints);
+
+    // Timeout (in msec)
+    args.append(millisTimeout);
+
+    // "Fire and forget"
+    interface->callWithArgumentList(QDBus::NoBlock, "Notify", args);
+}
+#endif
+
+void Notificator::notifySystray(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout)
+{
+    Q_UNUSED(icon);
+    QSystemTrayIcon::MessageIcon sicon = QSystemTrayIcon::NoIcon;
+    switch(cls) // Set icon based on class
+    {
+    case Information: sicon = QSystemTrayIcon::Information; break;
+    case Warning: sicon = QSystemTrayIcon::Warning; break;
+    case Critical: sicon = QSystemTrayIcon::Critical; break;
+    }
+    trayIcon->showMessage(title, text, sicon, millisTimeout);
+}
+
+void Notificator::notify(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout)
+{
+    switch(mode)
+    {
+#ifdef QT_DBUS
+    case Freedesktop:
+        notifyDBus(cls, title, text, icon, millisTimeout);
+        break;
+#endif
+    case QSystemTray:
+        notifySystray(cls, title, text, icon, millisTimeout);
+        break;
+    default:
+        if(cls == Critical)
+        {
+            // Fall back to old fashioned popup dialog if critical and no other notification available
+            QMessageBox::critical(parent, title, text, QMessageBox::Ok, QMessageBox::Ok);
+        }
+        break;
+    }
+}
diff --git a/src/qt/notificator.h b/src/qt/notificator.h
new file mode 100644
index 0000000000..13f6a908da
--- /dev/null
+++ b/src/qt/notificator.h
@@ -0,0 +1,63 @@
+#ifndef NOTIFICATOR_H
+#define NOTIFICATOR_H
+
+#include <QObject>
+#include <QIcon>
+
+QT_BEGIN_NAMESPACE
+class QSystemTrayIcon;
+#ifdef QT_DBUS
+class QDBusInterface;
+#endif
+QT_END_NAMESPACE
+
+// Cross-platform desktop notification client
+class Notificator: public QObject
+{
+    Q_OBJECT
+public:
+    // Create a new notificator
+    // Ownership of trayIcon is not transferred to this object
+    Notificator(const QString &programName=QString(), QSystemTrayIcon *trayIcon=0, QWidget *parent=0);
+    ~Notificator();
+
+    // Message class
+    enum Class
+    {
+        Information,
+        Warning,
+        Critical,
+    };
+
+public slots:
+
+    /* Show notification message.
+     *
+     *  cls: general message class
+     *  title: title shown with message
+     *  text: message content
+     *  icon: optional icon to show with message
+     *  millisTimeout: notification timeout in milliseconds (default 10 seconds)
+     */
+    void notify(Class cls, const QString &title, const QString &text,
+                const QIcon &icon = QIcon(), int millisTimeout = 10000);
+
+private:
+    QWidget *parent;
+    enum Mode {
+        None,
+        Freedesktop, // Use DBus org.freedesktop.Notifications
+        QSystemTray, // Use QSystemTray::showMessage
+    };
+    QString programName;
+    Mode mode;
+    QSystemTrayIcon *trayIcon;
+#ifdef QT_DBUS
+    QDBusInterface *interface;
+
+    void notifyDBus(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout);
+#endif
+    void notifySystray(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout);
+};
+
+#endif // NOTIFICATOR_H