LogDockerDock.cpp

Go to the documentation of this file.

/*
 *  SPDX-FileCopyrightText: 2018 Boudewijn Rempt <boud@valdyas.org>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 
#include "LogDockerDock.h"
 
#include <QHBoxLayout>
#include <QScrollBar>
#include <QStandardPaths>
#include <QDateTime>
#include <QCheckBox>
#include <QMessageBox>
 
#include <klocalizedstring.h>
#include <ksharedconfig.h>
#include <kconfiggroup.h>
 
#include <KisPart.h>
#include <KoDialog.h>
#include <KoCanvasBase.h>
#include <KoIcon.h>
#include <KoFileDialog.h>
 
#include "kis_canvas2.h"
#include "KisViewManager.h"
#include "KisMainWindow.h"
#include "kis_config.h"
 
#include <QThread>
#include <QMutex>
#include <QWaitCondition>
#include <QGlobalStatic>
#include <KisStaticInitializer.h>
 
QTextCharFormat LogDockerDock::s_debug;
QTextCharFormat LogDockerDock::s_info;
QTextCharFormat LogDockerDock::s_warning;
QTextCharFormat LogDockerDock::s_critical;
QTextCharFormat LogDockerDock::s_fatal;
 
KIS_DECLARE_STATIC_INITIALIZER {
    qRegisterMetaType<QtMsgType>("QtMsgType");
}
 
class MessageForwarderThread : public QThread
{
    Q_OBJECT
public:
    void run() override {
        while (1) {
            QMutexLocker locker(&m_mutex);
            m_waitCondition.wait(&m_mutex);
            if (m_exitFlag) break;
 
            while (!m_messages.empty()) {
                auto message = m_messages.dequeue();
                Q_EMIT sigDeliverMessage(message.first, message.second);
            }
        }
    }
 
    void pushMessage(QtMsgType type, const QString &message) {
        QMutexLocker locker(&m_mutex);
        m_messages.enqueue(std::make_pair(type, message));
        locker.unlock();
        m_waitCondition.wakeAll();
    }
 
    void pushExitFlag() {
        QMutexLocker locker(&m_mutex);
        m_exitFlag = true;
        locker.unlock();
        m_waitCondition.wakeAll();
    }
 
Q_SIGNALS:
    void sigDeliverMessage(QtMsgType type, const QString &message);
 
 
private:
    QMutex m_mutex;
    QWaitCondition m_waitCondition;
    QQueue<std::pair<QtMsgType, QString>> m_messages;
    bool m_exitFlag {false};
};
 
void kritaLoggerMessageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);
 
class MessageHandler : public QObject
{
    Q_OBJECT
public:
    ~MessageHandler() {
        setLoggingEnabled(false);
    }
 
    void setLoggingEnabled(bool value) {
        if (value == isLoggingEnabled()) return;
        
        if (value) {
            const QtMessageHandler oldHandler = qInstallMessageHandler(kritaLoggerMessageHandler);
            m_originalMessageHandler = oldHandler;
            m_forwarderThread.reset(new MessageForwarderThread());
            connect(m_forwarderThread.get(), &MessageForwarderThread::sigDeliverMessage, this, &MessageHandler::sigDeliverMessage);
            m_forwarderThread->start();
        } else {
            qInstallMessageHandler(nullptr);
            m_originalMessageHandler = nullptr;
            m_forwarderThread->pushExitFlag();
            m_forwarderThread->wait();
            m_forwarderThread.reset();
        }
    }
 
    bool isLoggingEnabled() const {
        return m_originalMessageHandler;
    }
 
Q_SIGNALS:
    void sigDeliverMessage(QtMsgType type, const QString &message);
 
public:
    QtMessageHandler m_originalMessageHandler {nullptr};
    std::unique_ptr<MessageForwarderThread> m_forwarderThread;
};
 
Q_GLOBAL_STATIC(MessageHandler, s_messageHandlerObject)
 
void kritaLoggerMessageHandler(QtMsgType type, const QMessageLogContext &context, const QString &message)
{
    KIS_SAFE_ASSERT_RECOVER_RETURN(s_messageHandlerObject->m_forwarderThread);
    KIS_SAFE_ASSERT_RECOVER_RETURN(s_messageHandlerObject->m_originalMessageHandler);
    
    s_messageHandlerObject->m_forwarderThread->pushMessage(type, message);
    s_messageHandlerObject->m_originalMessageHandler(type, context, message);
}
 
LogDockerDock::LogDockerDock( )
    : QDockWidget(i18n("Log Viewer"))
{
    QWidget *page = new QWidget(this);
    setupUi(page);
    setWidget(page);
 
    bnToggle->setIcon(koIcon("view-list-text-16"));
    connect(bnToggle, SIGNAL(clicked(bool)), SLOT(toggleLogging(bool)));
    bnToggle->setChecked(KisConfig(true).readEntry<bool>("logviewer_enabled", false));
    toggleLogging(KisConfig(true).readEntry<bool>("logviewer_enabled", false));
 
    bnClear->setIcon(koIcon("edit-clear-16"));
    connect(bnClear, SIGNAL(clicked(bool)), SLOT(clearLog()));
 
    bnSave->setIcon(koIcon("document-save-16"));
    connect(bnSave, SIGNAL(clicked(bool)), SLOT(saveLog()));
 
    bnSettings->setIcon(koIcon("configure-thicker"));
    connect(bnSettings, SIGNAL(clicked(bool)), SLOT(settings()));
 
    connect(s_messageHandlerObject, SIGNAL(sigDeliverMessage(QtMsgType,QString)), this, SLOT(insertMessage(QtMsgType,QString)), Qt::AutoConnection);
 
    changeTheme();
}
 
void LogDockerDock::setCanvas(KoCanvasBase *)
{
    setEnabled(true);
}
 
void LogDockerDock::setViewManager(KisViewManager *kisview)
{
    connect(kisview->mainWindow(), SIGNAL(themeChanged()), SLOT(changeTheme()));
}
 
void LogDockerDock::toggleLogging(bool toggle)
{
    KisConfig(false).writeEntry<bool>("logviewer_enabled", toggle);
    
    if (toggle) {
        applyCategories();
    } else {
        QLoggingCategory::setFilterRules(QString());
    }
 
    s_messageHandlerObject->setLoggingEnabled(toggle);
}
 
void LogDockerDock::clearLog()
{
    txtLogViewer->document()->clear();
}
 
void LogDockerDock::saveLog()
{
    KoFileDialog fileDialog(this, KoFileDialog::SaveFile, "logfile");
    fileDialog.setDefaultDir(QStandardPaths::writableLocation(QStandardPaths::DesktopLocation) + "/" + QString("krita_%1.log").arg(QDateTime::currentDateTime().toString("yyyy-MM-ddThh")));
    QString filename = fileDialog.filename();
    if (!filename.isEmpty()) {
        QFile f(filename);
        if (f.open(QFile::WriteOnly)) {
            f.write(txtLogViewer->document()->toPlainText().toUtf8());
            f.close();
        } else {
            QMessageBox::warning(this, i18nc("@title:window", "Krita"),
                i18n("Could not save %1.\nReason: %2.", f.fileName(), f.errorString()));
        }
    }
}
 
void LogDockerDock::settings()
{
    KoDialog dlg(this);
    dlg.setButtons(KoDialog::Ok | KoDialog::Cancel);
    dlg.setCaption(i18n("Log Settings"));
    QWidget *page = new QWidget(&dlg);
    dlg.setMainWidget(page);
    QVBoxLayout *layout = new QVBoxLayout(page);
 
    KConfigGroup cfg( KSharedConfig::openConfig(), "LogDocker");
 
    QCheckBox *chkKrita = new QCheckBox(i18n("General"), page);
    chkKrita->setChecked(cfg.readEntry("krita_41000", false));
    layout->addWidget(chkKrita);
 
    QCheckBox *chkResources = new QCheckBox(i18n("Resource Management"), page);
    chkResources->setChecked(cfg.readEntry("resources_30009", false));
    layout->addWidget(chkResources);
 
    QCheckBox *chkImage = new QCheckBox(i18n("Image Core"), page);
    chkImage->setChecked(cfg.readEntry("image_41001", false));
    layout->addWidget(chkImage);
 
    QCheckBox *chkRegistry = new QCheckBox(i18n("Registries"), page);
    chkRegistry->setChecked(cfg.readEntry("registry_41002", false));
    layout->addWidget(chkRegistry);
 
    QCheckBox *chkTools = new QCheckBox(i18n("Tools"), page);
    chkTools->setChecked(cfg.readEntry("tools_41003", false));
    layout->addWidget(chkTools);
 
    QCheckBox *chkTiles = new QCheckBox(i18n("Tile Engine"), page);
    chkTiles->setChecked(cfg.readEntry("tiles_41004", false));
    layout->addWidget(chkTiles);
 
    QCheckBox *chkFilters = new QCheckBox(i18nc("Filter as an effect", "Filters"), page);
    chkFilters->setChecked(cfg.readEntry("filters_41005", false));
    layout->addWidget(chkFilters);
 
    QCheckBox *chkPlugins = new QCheckBox(i18n("Plugin Management"), page);
    chkPlugins->setChecked(cfg.readEntry("plugins_41006", false));
    layout->addWidget(chkPlugins);
 
    QCheckBox *chkUi = new QCheckBox(i18n("User Interface"), page);
    chkUi->setChecked(cfg.readEntry("ui_41007", false));
    layout->addWidget(chkUi);
 
    QCheckBox *chkFile = new QCheckBox(i18n("File loading and saving"), page);
    chkFile->setChecked(cfg.readEntry("file_41008", false));
    layout->addWidget(chkFile);
 
    QCheckBox *chkMath = new QCheckBox(i18n("Mathematics and calculations"), page);
    chkMath->setChecked(cfg.readEntry("math_41009", false));
    layout->addWidget(chkMath);
 
    QCheckBox *chkRender = new QCheckBox(i18n("Image Rendering"), page);
    chkRender->setChecked(cfg.readEntry("render_41010", false));
    layout->addWidget(chkRender);
 
    QCheckBox *chkScript = new QCheckBox(i18n("Scripting"), page);
    chkScript->setChecked(cfg.readEntry("script_41011", false));
    layout->addWidget(chkScript);
 
    QCheckBox *chkInput = new QCheckBox(i18n("Input handling"), page);
    chkInput->setChecked(cfg.readEntry("input_41012", false));
    layout->addWidget(chkInput);
 
    QCheckBox *chkAction = new QCheckBox(i18n("Actions"), page);
    chkAction->setChecked(cfg.readEntry("action_41013", false));
    layout->addWidget(chkAction);
 
    QCheckBox *chkTablet = new QCheckBox(i18n("Tablet Handling"), page);
    chkTablet->setChecked(cfg.readEntry("tablet_41014", false));
    layout->addWidget(chkTablet);
 
    QCheckBox *chkOpenGL = new QCheckBox(i18n("GPU Canvas"), page);
    chkOpenGL->setChecked(cfg.readEntry("opengl_41015", false));
    layout->addWidget(chkOpenGL);
 
    QCheckBox *chkMetaData = new QCheckBox(i18n("Metadata"), page);
    chkMetaData->setChecked(cfg.readEntry("metadata_41016", false));
    layout->addWidget(chkMetaData);
 
    QCheckBox *chkPigment = new QCheckBox(i18n("Color Management"), page);
    chkPigment->setChecked(cfg.readEntry("pigment", false));
    layout->addWidget(chkPigment);
 
 
    if (dlg.exec()) {
        // Apply the new settings
        cfg.writeEntry("resources_30009", chkResources->isChecked());
        cfg.writeEntry("krita_41000", chkKrita->isChecked());
        cfg.writeEntry("image_41001", chkImage->isChecked());
        cfg.writeEntry("registry_41002", chkRegistry->isChecked());
        cfg.writeEntry("tools_41003", chkTools->isChecked());
        cfg.writeEntry("tiles_41004", chkTiles->isChecked());
        cfg.writeEntry("filters_41005", chkFilters->isChecked());
        cfg.writeEntry("plugins_41006", chkPlugins->isChecked());
        cfg.writeEntry("ui_41007", chkUi->isChecked());
        cfg.writeEntry("file_41008", chkFile->isChecked());
        cfg.writeEntry("math_41009", chkMath->isChecked());
        cfg.writeEntry("render_41010", chkRender->isChecked());
        cfg.writeEntry("script_41011", chkScript->isChecked());
        cfg.writeEntry("input_41012", chkInput->isChecked());
        cfg.writeEntry("action_41013", chkAction->isChecked());
        cfg.writeEntry("tablet_41014", chkTablet->isChecked());
        cfg.writeEntry("opengl_41015", chkOpenGL->isChecked());
        cfg.writeEntry("metadata_41016", chkMetaData->isChecked());
        cfg.writeEntry("pigment", chkPigment->isChecked());
 
        if (bnToggle->isChecked()) {
            applyCategories();
        }
    }
 
}
 
QString cfgToString(const char *category, bool cfg)
{
    if (cfg) {
        return QStringLiteral("%0=true").arg(QLatin1String(category));
    }
    return QStringLiteral("%0.debug=false").arg(QLatin1String(category));
}
 
void LogDockerDock::applyCategories()
{
    QStringList filters;
    KConfigGroup cfg( KSharedConfig::openConfig(), "LogDocker");
 
    filters << cfgToString("krita.general", cfg.readEntry("krita_41000", false));
    filters << cfgToString("krita.lib.resources", cfg.readEntry("resources_30009", false));
    filters << cfgToString("krita.core", cfg.readEntry("image_41001", false));
    filters << cfgToString("krita.registry", cfg.readEntry("registry_41002", false));
 
    filters << cfgToString("krita.tools", cfg.readEntry("tools_41003", false));
    filters << cfgToString("krita.lib.flake", cfg.readEntry("tools_41003", false));
 
    filters << cfgToString("krita.tiles", cfg.readEntry("tiles_41004", false));
    filters << cfgToString("krita.filters", cfg.readEntry("filters_41005", false));
 
    filters << cfgToString("krita.plugins", cfg.readEntry("plugins_41006", false));
    filters << cfgToString("krita.lib.plugin", cfg.readEntry("plugins_41006", false));
 
    filters << cfgToString("krita.ui", cfg.readEntry("ui_41007", false));
    filters << cfgToString("krita.widgets", cfg.readEntry("ui_41007", false));
    filters << cfgToString("krita.widgetutils", cfg.readEntry("ui_41007", false));
 
    filters << cfgToString("krita.file", cfg.readEntry("file_41008", false));
    filters << cfgToString("krita.lib.store", cfg.readEntry("file_41008", false));
    filters << cfgToString("krita.lib.odf", cfg.readEntry("file_41008", false));
 
    filters << cfgToString("krita.math", cfg.readEntry("math_41009", false));
    filters << cfgToString("krita.grender", cfg.readEntry("render_41010", false));
    filters << cfgToString("krita.scripting", cfg.readEntry("script_41011", false));
    filters << cfgToString("krita.input", cfg.readEntry("input_41012", false));
    filters << cfgToString("krita.action", cfg.readEntry("action_41013", false));
    filters << cfgToString("krita.tablet", cfg.readEntry("tablet_41014", false));
    filters << cfgToString("krita.opengl", cfg.readEntry("opengl_41015", false));
    filters << cfgToString("krita.metadata", cfg.readEntry("metadata_41016", false));
 
    filters << cfgToString("krita.lib.pigment", cfg.readEntry("pigment", false));
 
    QLoggingCategory::setFilterRules(filters.join("\n"));
}
 
void LogDockerDock::insertMessage(QtMsgType type, const QString &msg)
{
    QTextDocument *doc = txtLogViewer->document();
    QTextCursor cursor(doc);
    cursor.movePosition(QTextCursor::End, QTextCursor::MoveAnchor);
    cursor.beginEditBlock();
 
    switch (type) {
    case QtDebugMsg:
        cursor.insertText(msg + "\n", s_debug);
        break;
    case QtInfoMsg:
        cursor.insertText(msg + "\n", s_info);
        break;
    case QtWarningMsg:
        cursor.insertText(msg + "\n", s_warning);
        break;
    case QtCriticalMsg:
        cursor.insertText(msg + "\n", s_critical);
        break;
    case QtFatalMsg:
        cursor.insertText(msg + "\n", s_fatal);
        break;
    }
 
    cursor.endEditBlock();
    txtLogViewer->verticalScrollBar()->setValue(txtLogViewer->verticalScrollBar()->maximum());
}
 
void LogDockerDock::changeTheme()
{
    clearLog();
    QColor background = qApp->palette().window().color();
    if (background.value() > 100) {
        s_debug.setForeground(Qt::black);
        s_info.setForeground(Qt::darkGreen);
        s_warning.setForeground(Qt::darkYellow);
        s_critical.setForeground(Qt::darkRed);
        s_fatal.setForeground(Qt::darkRed);
    }
    else {
        s_debug.setForeground(Qt::white);
        s_info.setForeground(Qt::green);
        s_warning.setForeground(Qt::yellow);
        s_critical.setForeground(Qt::red);
        s_fatal.setForeground(Qt::red);
    }
    s_fatal.setFontWeight(QFont::Bold);
}
 
#include <LogDockerDock.moc>