dbusnotification.cpp

Go to the documentation of this file.

#include "./dbusnotification.h"
#include "notificationsinterface.h"
 
#include <QCoreApplication>
#include <QDBusConnection>
#include <QDBusPendingReply>
#include <QImage>
#include <QMutex>
#include <QMutexLocker>
 
#include <limits>
#include <map>
 
using namespace std;
 
namespace QtUtilities {
 
using IDType = uint;
static QMutex pendingNotificationsMutex;
static std::map<IDType, DBusNotification *> pendingNotifications;
OrgFreedesktopNotificationsInterface *DBusNotification::s_dbusInterface = nullptr;
constexpr auto initialId = std::numeric_limits<IDType>::min();
constexpr auto pendingId = std::numeric_limits<IDType>::max();
constexpr auto pendingId2 = pendingId - 1;
 
struct SwappedImage : public QImage {
    SwappedImage(const QImage &image);
};
 
inline SwappedImage::SwappedImage(const QImage &image)
    : QImage(image.rgbSwapped())
{
}
 
struct NotificationImage : public QDBusArgument {
    NotificationImage();
    NotificationImage(SwappedImage image);
    QImage toQImage() const;
    QVariant toDBusArgument() const;
    static NotificationImage fromDBusArgument(const QVariant &variant);
 
    qint32 width;
    qint32 height;
    qint32 rowstride;
    bool hasAlpha;
    qint32 channels;
    qint32 bitsPerSample;
    QByteArray data;
    bool isValid;
 
private:
    NotificationImage(const QImage &image);
};
 
QDBusArgument &operator<<(QDBusArgument &argument, const NotificationImage &img)
{
    argument.beginStructure();
    argument << img.width << img.height << img.rowstride << img.hasAlpha << img.bitsPerSample << img.channels << img.data;
    argument.endStructure();
    return argument;
}
 
const QDBusArgument &operator>>(const QDBusArgument &argument, NotificationImage &img)
{
    argument.beginStructure();
    argument >> img.width >> img.height >> img.rowstride >> img.hasAlpha >> img.bitsPerSample >> img.channels >> img.data;
    argument.endStructure();
    return argument;
}
 
inline NotificationImage::NotificationImage()
    : isValid(false)
{
}
 
inline NotificationImage::NotificationImage(SwappedImage image)
    : NotificationImage(static_cast<const QImage &>(image))
{
}
 
inline NotificationImage::NotificationImage(const QImage &image)
    : width(image.width())
    , height(image.height())
    , rowstride(static_cast<qint32>(image.bytesPerLine()))
    , hasAlpha(image.hasAlphaChannel())
    , channels(image.isGrayscale() ? 1
              : hasAlpha           ? 4
                                   : 3)
    , bitsPerSample(image.depth() / channels)
#if (QT_VERSION >= QT_VERSION_CHECK(5, 10, 0))
    , data(reinterpret_cast<const char *>(image.bits()), static_cast<int>(image.sizeInBytes()))
#else
    , data(reinterpret_cast<const char *>(image.bits()), image.byteCount())
#endif
    , isValid(!image.isNull())
{
    if (isValid) {
        // populate QDBusArgument structure
        // note: Just use the operator overload which is required for qDBusMarshallHelper().
        *this << *this;
    }
}
 
inline QImage NotificationImage::toQImage() const
{
    return isValid ? QImage(reinterpret_cast<const uchar *>(data.constData()), width, height, hasAlpha ? QImage::Format_ARGB32 : QImage::Format_RGB32)
                         .rgbSwapped()
                   : QImage();
}
 
inline QVariant NotificationImage::toDBusArgument() const
{
    return QVariant::fromValue(*this);
}
 
inline NotificationImage NotificationImage::fromDBusArgument(const QVariant &variant)
{
    return variant.canConvert<NotificationImage>() ? variant.value<NotificationImage>() : NotificationImage();
}
 
} // namespace QtUtilities
 
Q_DECLARE_METATYPE(QtUtilities::NotificationImage);
 
namespace QtUtilities {
 
DBusNotification::DBusNotification(const QString &title, NotificationIcon icon, int timeout, QObject *parent)
    : QObject(parent)
    , m_id(initialId)
    , m_watcher(nullptr)
    , m_title(title)
    , m_timeout(timeout)
{
    initInterface();
    setIcon(icon);
}
 
DBusNotification::DBusNotification(const QString &title, const QString &icon, int timeout, QObject *parent)
    : QObject(parent)
    , m_id(initialId)
    , m_watcher(nullptr)
    , m_title(title)
    , m_icon(icon)
    , m_timeout(timeout)
{
    initInterface();
}
 
void DBusNotification::initInterface()
{
    if (!s_dbusInterface) {
        qDBusRegisterMetaType<NotificationImage>();
        s_dbusInterface = new OrgFreedesktopNotificationsInterface(
            QStringLiteral("org.freedesktop.Notifications"), QStringLiteral("/org/freedesktop/Notifications"), QDBusConnection::sessionBus());
        connect(s_dbusInterface, &OrgFreedesktopNotificationsInterface::ActionInvoked, &DBusNotification::handleActionInvoked);
        connect(s_dbusInterface, &OrgFreedesktopNotificationsInterface::NotificationClosed, &DBusNotification::handleNotificationClosed);
    }
}
 
DBusNotification::~DBusNotification()
{
    {
        QMutexLocker lock(&pendingNotificationsMutex);
        auto i = pendingNotifications.find(m_id);
        if (i != pendingNotifications.end()) {
            pendingNotifications.erase(i);
        }
    }
    hide();
}
 
bool DBusNotification::isAvailable()
{
    initInterface();
    return s_dbusInterface->isValid();
}
 
void DBusNotification::setIcon(NotificationIcon icon)
{
    switch (icon) {
    case NotificationIcon::Information:
        m_icon = QStringLiteral("dialog-information");
        break;
    case NotificationIcon::Warning:
        m_icon = QStringLiteral("dialog-warning");
        break;
    case NotificationIcon::Critical:
        m_icon = QStringLiteral("dialog-critical");
        break;
    default:;
    }
}
 
const QImage DBusNotification::image() const
{
    return NotificationImage::fromDBusArgument(hint(QStringLiteral("image-data"), QStringLiteral("image_data"))).toQImage();
}
 
void DBusNotification::setImage(const QImage &image)
{
    m_hints[QStringLiteral("image-data")] = NotificationImage(SwappedImage(image)).toDBusArgument();
}
 
bool DBusNotification::isPending() const
{
    return m_id == pendingId || m_id == pendingId2;
}
 
void DBusNotification::deleteOnCloseOrError()
{
    connect(this, &DBusNotification::closed, this, &DBusNotification::deleteLater);
    connect(this, &DBusNotification::error, this, &DBusNotification::deleteLater);
}
 
bool DBusNotification::show()
{
    if (isPending()) {
        m_id = pendingId2;
        return true;
    }
    if (!s_dbusInterface->isValid()) {
        emit error();
        return false;
    }
 
    delete m_watcher;
    m_watcher
        = new QDBusPendingCallWatcher(s_dbusInterface->Notify(m_applicationName.isEmpty() ? QCoreApplication::applicationName() : m_applicationName,
                                          m_id, m_icon, m_title, m_msg, m_actions, m_hints, m_timeout),
            this);
    connect(m_watcher, &QDBusPendingCallWatcher::finished, this, &DBusNotification::handleNotifyResult);
    m_id = pendingId;
    return true;
}
 
bool DBusNotification::show(const QString &message)
{
    m_msg = message;
    return show();
}
 
bool DBusNotification::update(const QString &line)
{
    if ((!isPending() && !isVisible()) || m_msg.isEmpty()) {
        m_msg = line;
    } else {
        if (!m_msg.startsWith(QStringLiteral("•"))) {
            m_msg.insert(0, QStringLiteral("• "));
        }
        m_msg.append(QStringLiteral("\n• "));
        m_msg.append(line);
    }
    return show();
}
 
bool DBusNotification::queryCapabilities(const std::function<void(Capabilities &&capabilities)> &callback)
{
    // ensure DBus-interface is initialized and valid
    initInterface();
    if (!s_dbusInterface->isValid()) {
        return false;
    }
 
    // invoke GetCapabilities() and pass the return value to the callback when available
    const auto *const newWatcher = new QDBusPendingCallWatcher(s_dbusInterface->GetCapabilities());
    connect(newWatcher, &QDBusPendingCallWatcher::finished, [&callback](QDBusPendingCallWatcher *watcher) {
        watcher->deleteLater();
        const QDBusPendingReply<QStringList> returnValue(*watcher);
        if (returnValue.isError()) {
            callback(Capabilities());
        } else {
            callback(Capabilities(std::move(returnValue.value())));
        }
    });
    return true;
}
 
bool DBusNotification::hide()
{
    if (m_id) {
        s_dbusInterface->CloseNotification(m_id);
        return true;
    }
    return false;
}
 
void DBusNotification::handleNotifyResult(QDBusPendingCallWatcher *watcher)
{
    if (watcher != m_watcher) {
        return;
    }
 
    watcher->deleteLater();
    m_watcher = nullptr;
 
    QDBusPendingReply<uint> returnValue = *watcher;
    if (returnValue.isError()) {
        m_id = initialId;
        emit error();
        return;
    }
 
    const auto needsUpdate = m_id == pendingId2;
    {
        QMutexLocker lock(&pendingNotificationsMutex);
        pendingNotifications[m_id = returnValue.argumentAt<0>()] = this;
    }
    emit shown();
 
    // update the notification again if show() was called before we've got the ID
    if (needsUpdate) {
        show();
    }
}
 
void DBusNotification::handleNotificationClosed(IDType id, uint reason)
{
    QMutexLocker lock(&pendingNotificationsMutex);
    auto i = pendingNotifications.find(id);
    if (i != pendingNotifications.end()) {
        DBusNotification *notification = i->second;
        notification->m_id = initialId;
        emit notification->closed(reason >= 1 && reason <= 3 ? static_cast<NotificationCloseReason>(reason) : NotificationCloseReason::Undefined);
        pendingNotifications.erase(i);
    }
}
 
void DBusNotification::handleActionInvoked(IDType id, const QString &action)
{
    QMutexLocker lock(&pendingNotificationsMutex);
    auto i = pendingNotifications.find(id);
    if (i != pendingNotifications.end()) {
        DBusNotification *notification = i->second;
        emit notification->actionInvoked(action);
        // Plasma 5 also closes the notification but doesn't emit the
        // NotificationClose signal
        // -> just consider the notification closed
        emit notification->closed(NotificationCloseReason::ActionInvoked);
        notification->m_id = initialId;
        pendingNotifications.erase(i);
        // however, lxqt-notificationd does not close the notification
        // -> close manually for consistent behaviour
        s_dbusInterface->CloseNotification(i->first);
    }
}
 
} // namespace QtUtilities