kbugreport.cpp

Go to the documentation of this file.

/* This file is part of the KDE project
   SPDX-FileCopyrightText: 1999 David Faure <faure@kde.org>
 
   SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "kbugreport.h"
 
#include <QProcess>
#include <QCoreApplication>
#include <QDialogButtonBox>
#include <QPushButton>
#include <QLayout>
#include <QRadioButton>
#include <QGroupBox>
#include <QLocale>
#include <QCloseEvent>
#include <QLabel>
#include <QUrl>
#include <QUrlQuery>
#include <QStandardPaths>
#include <QLineEdit>
#include <QDebug>
#include <QTextEdit>
#include <QDesktopServices>
#include <QStandardPaths>
#include <QClipboard>
#include <QGuiApplication>
#include <QFile>
 
#include <kaboutdata.h>
#include <kconfig.h>
#include <kconfiggroup.h>
#include <kemailsettings.h>
#include <klocalizedstring.h>
#include <kmessagebox.h>
 
#include <ktitlewidget.h>
#include <kwidgetsaddons_version.h>
#include <kstandardguiitem.h>
 
#include "systeminformation_p.h"
 
#include "config-xmlgui.h"
 
#include <kis_icon_utils.h>
 
class KisKBugReportPrivate
{
public:
    KisKBugReportPrivate(KisKBugReport *q): q(q), m_aboutData(KAboutData::applicationData()) {}
 
    void _k_updateUrl();
 
    KisKBugReport *q {nullptr};
    QProcess *m_process {nullptr};
    KAboutData m_aboutData;
 
    QTextEdit *m_lineedit {nullptr};
    QLineEdit *m_subject {nullptr};
    QLabel *m_version {nullptr};
    QString m_strVersion;
    QGroupBox *m_bgSeverity {nullptr};
 
    QLabel *lblApplicationName {nullptr};
    QString lastError;
    QString appname;
    QString os;
    QUrl url;
    QList<QRadioButton *> severityButtons;
    int currentSeverity()
    {
        for (int i = 0; i < severityButtons.count(); i++)
            if (severityButtons[i]->isChecked()) {
                return i;
            }
        return -1;
    }
};
 
KisKBugReport::KisKBugReport(const KAboutData &aboutData, QWidget *_parent)
    : QDialog(_parent), d(new KisKBugReportPrivate(this))
{
    setWindowTitle(i18n("Submit Bug Report"));
 
    QDialogButtonBox *buttonBox = new QDialogButtonBox(this);
    buttonBox->setStandardButtons(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
    KGuiItem::assign(buttonBox->button(QDialogButtonBox::Ok), KStandardGuiItem::ok());
    KGuiItem::assign(buttonBox->button(QDialogButtonBox::Cancel), KStandardGuiItem::cancel());
    connect(buttonBox, SIGNAL(accepted()), this, SLOT(accept()));
    connect(buttonBox, SIGNAL(rejected()), this, SLOT(reject()));
 
    d->m_aboutData = aboutData;
    d->m_process = 0;
    KGuiItem::assign(buttonBox->button(QDialogButtonBox::Cancel), KStandardGuiItem::close());
 
    QLabel *tmpLabel;
    QVBoxLayout *lay = new QVBoxLayout(this);
 
    KTitleWidget *title = new KTitleWidget(this);
    title->setText(i18n("Submit Bug Report"));
 
#if KWIDGETSADDONS_VERSION_MAJOR > 5 || (KWIDGETSADDONS_VERSION_MAJOR == 5 && KWIDGETSADDONS_VERSION_MINOR >= 72)
    title->setIcon(KisIconUtils::loadIcon(QStringLiteral("tools-report-bug")));
#else
    title->setPixmap(KisIconUtils::loadIcon(QStringLiteral("tools-report-bug")).pixmap(32));
#endif
 
    lay->addWidget(title);
 
    QGridLayout *glay = new QGridLayout();
    lay->addLayout(glay);
 
    int row = 0;
 
    // Program name
    QString qwtstr = i18n("The application for which you wish to submit a bug report - if incorrect, please use the Report Bug menu item of the correct application");
    tmpLabel = new QLabel(i18n("Application: "), this);
    glay->addWidget(tmpLabel, row, 0);
    tmpLabel->setWhatsThis(qwtstr);
    d->lblApplicationName = new QLabel(this);
    d->lblApplicationName->setWhatsThis(qwtstr);
 
    d->appname = d->m_aboutData.productName();
    d->lblApplicationName->setText(d->appname);
 
    glay->addWidget(d->lblApplicationName, row, 1);
 
    tmpLabel->setWhatsThis(qwtstr);
 
    // Version
    qwtstr = i18n("The version of this application - please make sure that no newer version is available before sending a bug report");
    tmpLabel = new QLabel(i18n("Version:"), this);
    glay->addWidget(tmpLabel, ++row, 0);
    tmpLabel->setWhatsThis(qwtstr);
    d->m_strVersion = d->m_aboutData.version();
    if (d->m_strVersion.isEmpty()) {
        d->m_strVersion = i18n("no version set (programmer error)");
    }
    d->m_version = new QLabel(d->m_strVersion, this);
    d->m_version->setTextInteractionFlags(Qt::TextBrowserInteraction);
    //glay->addWidget( d->m_version, row, 1 );
    glay->addWidget(d->m_version, row, 1, 1, 2);
    d->m_version->setWhatsThis(qwtstr);
 
    tmpLabel = new QLabel(i18n("OS:"), this);
    glay->addWidget(tmpLabel, ++row, 0);
    d->os = SystemInformation::operatingSystemVersion();
 
    tmpLabel = new QLabel(d->os, this);
    tmpLabel->setTextInteractionFlags(Qt::TextBrowserInteraction);
    glay->addWidget(tmpLabel, row, 1, 1, 2);
 
    // Point to the web form
 
    lay->addSpacing(10);
    QString text = i18n("<qt>"
                        "<p>Please read <b><a href=\"https://docs.krita.org/en/untranslatable_pages/reporting_bugs.html\">this guide</a></b> for reporting bugs first!</p>"
                        "<p>To submit a bug report, click on the button below. This will open a web browser "
                        "window on <a href=\"https://bugs.kde.org\">https://bugs.kde.org</a> where you will find "
                        "a form to fill in. </p>"
                        "<p><b>Please paste the following information into the bug report!</b></p>"
                        "</qt>");
    QLabel *label = new QLabel(text, this);
    label->setOpenExternalLinks(true);
    label->setTextInteractionFlags(Qt::LinksAccessibleByMouse | Qt::LinksAccessibleByKeyboard);
    label->setWordWrap(true);
    lay->addWidget(label);
    lay->addSpacing(10);
 
    QByteArray additionalInformation;
    QFile sysinfo(QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + "/krita-sysinfo.log");
    if (sysinfo.exists()) {
        sysinfo.open(QFile::ReadOnly);
        additionalInformation += sysinfo.readAll();
        sysinfo.close();
    }
 
    additionalInformation += "\n---------------------\n";
 
    QFile log(QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + "/krita.log");
    if (log.exists()) {
        log.open(QFile::ReadOnly);
        additionalInformation += log.readAll();
        log.close();
    }
 
    additionalInformation += "\n---------------------\n";
 
    QFile crashes(QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + "/kritacrash.log");
    if (crashes.exists()) {
        crashes.open(QFile::ReadOnly);
        additionalInformation += crashes.readAll();
        crashes.close();
    }
 
    QTextEdit *buginfo = new QTextEdit(this);
    buginfo->setText(QString::fromUtf8(additionalInformation));
    lay->addWidget(buginfo);
 
    QClipboard *clipboard = QGuiApplication::clipboard();
    clipboard->setText(QString::fromUtf8(additionalInformation));
 
    d->_k_updateUrl();
 
    QPushButton *okButton = buttonBox->button(QDialogButtonBox::Ok);
    okButton->setText(i18n("&Submit Bug Report"));
    okButton->setIcon(KisIconUtils::loadIcon(QStringLiteral("tools-report-bug")));
    lay->addWidget(buttonBox);
    setMinimumHeight(sizeHint().height() + 20);   // WORKAROUND: prevent "cropped" qcombobox
}
 
KisKBugReport::~KisKBugReport()
{
    delete d;
}
 
void KisKBugReportPrivate::_k_updateUrl()
{
    url = QUrl(QStringLiteral("https://bugs.kde.org/enter_bug.cgi"));
    QUrlQuery query;
    query.addQueryItem(QStringLiteral("format"), QLatin1String("guided"));    // use the guided form
 
    // the string format is product/component, where component is optional
    QStringList list = QStringList() << appname;
    query.addQueryItem(QStringLiteral("product"), list[0]);
    if (list.size() == 2) {
        query.addQueryItem(QStringLiteral("component"), list[1]);
    }
 
    query.addQueryItem(QStringLiteral("version"), m_strVersion);
 
    // TODO: guess and fill OS(sys_os) and Platform(rep_platform) fields
#ifdef Q_OS_WIN
    query.addQueryItem(QStringLiteral("op_sys"), QStringLiteral("MS Windows"));
    query.addQueryItem(QStringLiteral("rep_platform"), QStringLiteral("MS Windows"));
#endif
 
    url.setQuery(query);
}
 
void KisKBugReport::accept()
{
    QDesktopServices::openUrl(d->url);
}
 
 
#include "moc_kbugreport.cpp"