akremotelog.cpp

/*
    SPDX-FileCopyrightText: 2018 Daniel Vrátil <dvratil@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "akremotelog.h"
 
#include <QCoreApplication>
#include <QDateTime>
#include <QLoggingCategory>
#include <QString>
#include <QThread>
#include <QTimer>
 
#include <QDBusConnection>
#include <QDBusInterface>
#include <QDBusPendingCallWatcher>
#include <QDBusPendingReply>
#include <QDBusServiceWatcher>
 
#include "private/instance_p.h"
 
#define AKONADICONSOLE_SERVICE "org.kde.akonadiconsole"
#define AKONADICONSOLE_LOGGER_PATH "/logger"
#define AKONADICONSOLE_LOGGER_INTERFACE "org.kde.akonadiconsole.logger"
 
namespace
{
class RemoteLogger : public QObject
{
    Q_OBJECT
public:
    explicit RemoteLogger()
        : mWatcher(akonadiConsoleServiceName(),
                   QDBusConnection::sessionBus(),
                   QDBusServiceWatcher::WatchForRegistration | QDBusServiceWatcher::WatchForUnregistration)
    {
        connect(qApp, &QCoreApplication::aboutToQuit, this, &RemoteLogger::deleteLater);
 
        sInstance = this;
 
        // Don't do remote logging for Akonadi Console because it deadlocks it
        if (QCoreApplication::applicationName() == QLatin1StringView("akonadiconsole")) {
            return;
        }
 
        connect(&mWatcher, &QDBusServiceWatcher::serviceRegistered, this, &RemoteLogger::serviceRegistered);
        connect(&mWatcher, &QDBusServiceWatcher::serviceUnregistered, this, &RemoteLogger::serviceUnregistered);
 
        mOldHandler = qInstallMessageHandler(dbusLogger);
    }
 
    ~RemoteLogger() override
    {
        sInstance = nullptr;
 
        QLoggingCategory::installFilter(mOldFilter);
        qInstallMessageHandler(mOldHandler);
 
        mEnabled = false;
    }
 
    static RemoteLogger *self()
    {
        return sInstance;
    }
 
private Q_SLOTS:
    void serviceRegistered(const QString &service)
    {
        mAkonadiConsoleInterface = std::make_unique<QDBusInterface>(service,
                                                                    QStringLiteral(AKONADICONSOLE_LOGGER_PATH),
                                                                    QStringLiteral(AKONADICONSOLE_LOGGER_INTERFACE),
                                                                    QDBusConnection::sessionBus(),
                                                                    this);
        if (!mAkonadiConsoleInterface->isValid()) {
            mAkonadiConsoleInterface.reset();
            return;
        }
 
        connect(mAkonadiConsoleInterface.get(), // clazy:exclude=old-style-connect
                SIGNAL(enabledChanged(bool)),
                this,
                SLOT(onAkonadiConsoleLoggingEnabled(bool)));
 
        QTimer::singleShot(0, this, [this]() {
            auto watcher = new QDBusPendingCallWatcher(mAkonadiConsoleInterface->asyncCall(QStringLiteral("enabled")));
            connect(watcher, &QDBusPendingCallWatcher::finished, this, [this](QDBusPendingCallWatcher *watcher) {
                watcher->deleteLater();
                QDBusPendingReply<bool> reply = *watcher;
                if (reply.isError()) {
                    return;
                }
                onAkonadiConsoleLoggingEnabled(reply.argumentAt<0>());
            });
        });
    }
 
    void serviceUnregistered(const QString & /*unused*/)
    {
        onAkonadiConsoleLoggingEnabled(false);
        mAkonadiConsoleInterface.reset();
    }
 
    void onAkonadiConsoleLoggingEnabled(bool enabled)
    {
        if (mEnabled == enabled) {
            return;
        }
 
        mEnabled = enabled;
        if (mEnabled) {
            // FIXME: Qt calls our categoryFilter from installFilter() but at that
            // point we cannot refer to mOldFilter yet (as we only receive it after
            // this call returns. So we set our category filter twice: once to get
            // the original Qt filter and second time to force our category filter
            // to be called when we already know the old filter.
            mOldFilter = QLoggingCategory::installFilter(categoryFilter);
            QLoggingCategory::installFilter(categoryFilter);
        } else {
            QLoggingCategory::installFilter(mOldFilter);
            mOldFilter = nullptr;
        }
    }
 
private:
    QString akonadiConsoleServiceName()
    {
        QString service = QStringLiteral(AKONADICONSOLE_SERVICE);
        if (Akonadi::Instance::hasIdentifier()) {
            service += QStringLiteral("-%1").arg(Akonadi::Instance::identifier());
        }
        return service;
    }
 
    static void categoryFilter(QLoggingCategory *cat)
    {
        auto const that = self();
        if (!that) {
            return;
        }
 
        if (qstrncmp(cat->categoryName(), "org.kde.pim.", 12) == 0) {
            cat->setEnabled(QtDebugMsg, true);
            cat->setEnabled(QtInfoMsg, true);
            cat->setEnabled(QtWarningMsg, true);
            cat->setEnabled(QtCriticalMsg, true);
        } else if (that->mOldFilter) {
            that->mOldFilter(cat);
        }
    }
 
    static void dbusLogger(QtMsgType type, const QMessageLogContext &ctx, const QString &msg)
    {
        auto const that = self();
        if (!that) {
            return;
        }
 
        // Log to previous logger
        that->mOldHandler(type, ctx, msg);
 
        if (that->mEnabled) {
            that->mAkonadiConsoleInterface->asyncCallWithArgumentList(QStringLiteral("message"),
                                                                      QList<QVariant>{QDateTime::currentMSecsSinceEpoch(),
                                                                                      qAppName(),
                                                                                      qApp->applicationPid(),
                                                                                      static_cast<int>(type),
                                                                                      QString::fromUtf8(ctx.category),
                                                                                      QString::fromUtf8(ctx.file),
                                                                                      QString::fromUtf8(ctx.function),
                                                                                      ctx.line,
                                                                                      ctx.version,
                                                                                      msg});
        }
    }
 
private:
    QDBusServiceWatcher mWatcher;
    QLoggingCategory::CategoryFilter mOldFilter = nullptr;
    QtMessageHandler mOldHandler = nullptr;
    std::unique_ptr<QDBusInterface> mAkonadiConsoleInterface;
    bool mEnabled = false;
 
    static RemoteLogger *sInstance;
};
 
RemoteLogger *RemoteLogger::sInstance = nullptr;
 
} // namespace
 
void akInitRemoteLog()
{
    Q_ASSERT(qApp->thread() == QThread::currentThread());
 
    if (!RemoteLogger::self()) {
        new RemoteLogger();
    }
}
 
#include "akremotelog.moc"