crash_reporter.h

Go to the documentation of this file.

 
#ifndef CRASH_REPORTER_H
#define CRASH_REPORTER_H
 
#include <QByteArray>
#include <QLoggingCategory>
#include <QString>
#include <QStringList>
#include <libcockatrice/settings/personal_settings.h>
#include <memory>
 
#ifndef COCKATRICE_WITH_CRASH_REPORTING
#define COCKATRICE_WITH_CRASH_REPORTING 0
#endif
 
#ifndef COCKATRICE_SENTRY_DSN
#define COCKATRICE_SENTRY_DSN ""
#endif
 
#ifndef COCKATRICE_SENTRY_RELEASE
#define COCKATRICE_SENTRY_RELEASE ""
#endif
 
class QLockFile;
 
Q_DECLARE_LOGGING_CATEGORY(CrashReportLog);

class CrashReporter
{
public:
    CrashReporter();
    CrashReporter(const CrashReporter &) = delete;
    CrashReporter &operator=(const CrashReporter &) = delete;
    CrashReporter(CrashReporter &&) = delete;
    CrashReporter &operator=(CrashReporter &&) = delete;
    ~CrashReporter();
 
    void init(const QString &dsn,
              const QString &release,
              const QString &databasePath,
              PersonalSettings::CrashReportingMode consentMode);
    [[nodiscard]] bool isReady() const;
    void shutdown();
    void giveConsent();
    void revokeConsent();
    bool sendReport(const QString &redactedPreview, const QString &userNote = QString());

    int attachToPendingCrashEnvelopes(const QString &redactedLogText, const QString &userNoteText);
    static int attachToPendingCrashEnvelopes(const QString &databasePath,
                                             const QString &redactedLogText,
                                             const QString &userNoteText);

    static bool
    appendAttachmentToEnvelope(const QString &envelopePath, const QString &filename, const QByteArray &payload);

    static QStringList pendingEnvelopePaths(const QString &databasePath);

    static bool isReportingEnabled(const QString &dsn, PersonalSettings::CrashReportingMode consentMode);

    static bool isDsnWellFormed(const QString &dsn);

    static QString describeDsn(const QString &dsn);

    static QString describeOriginMismatch(const QString &envelopePath, const QString &currentDsn);

    bool beginSession(const QString &dir);
    void endSession();
 
    static QString sanitizeLogLine(const QString &line);
    static QString redactCockatriceUrls(const QString &line);
 
private:
    bool ready = false;
    QString sentryDatabasePath;
    QString sessionLockPath;
    std::unique_ptr<QLockFile> sessionLock;
};
 
#endif