obs-studio/frontend/utility/CrashHandler.hpp

/******************************************************************************
    Copyright (C) 2025 by Patrick Heyer <[email protected]>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/

#pragma once

#include <utility/RemoteTextThread.hpp>

#include <util/base.h>

#include <QObject>
#include <QThread>
#include <QUuid>

#include <chrono>
#include <filesystem>

namespace OBS {

enum class PlatformType { InvalidPlatform, Windows, macOS, Linux, FreeBSD };

using Clock = std::chrono::system_clock;
using TimePoint = std::chrono::time_point<Clock>;

class CrashHandler : public QObject {
	Q_OBJECT

private:
	QUuid appLaunchUUID_;
	std::filesystem::path crashSentinelFile_;

	TimePoint lastCrashUploadTime_;
	std::filesystem::path lastCrashLogFile_;
	std::string lastCrashLogFileName_;
	std::string lastCrashLogURL_;

	bool isSentinelPresent_ = false;
	bool isActiveCrashHandler_ = false;

	std::unique_ptr<RemoteTextThread> crashLogUploadThread_;

public:
	CrashHandler() = default;
	CrashHandler(QUuid appLaunchUUID);
	CrashHandler(const CrashHandler &other) = delete;
	CrashHandler &operator=(const CrashHandler &other) = delete;
	CrashHandler(CrashHandler &&other) noexcept;
	CrashHandler &operator=(CrashHandler &&other) noexcept;

	~CrashHandler();

	bool hasUncleanShutdown();
	bool hasNewCrashLog();
	std::filesystem::path getCrashLogDirectory() const;
	void uploadLastCrashLog();

	enum class CrashLogUpdateResult { InvalidResult, NotAvailable, NotUpdated, Updated };

private:
	void checkCrashState();
	void setupSentinel();
	std::filesystem::path findLastCrashLog() const;

	CrashLogUpdateResult updateLocalCrashLogState();
	void updateCrashLogFromConfig();
	void saveCrashLogToConfig();
	void uploadCrashLogToServer();
	void handleExistingCrashLogUpload();

	PlatformType getPlatformType() const;

private slots:
	void crashLogUploadResultHandler(const QString &uploadResult, const QString &error);

	// FIXME: Turn into private slot once OBSBasic does not handle application shutdown duties anymore.
public slots:
	void applicationShutdownHandler() noexcept;

signals:
	void crashLogUploadStarted() const;
	void crashLogUploadFailed(const QString &errorMessage) const;
	void crashLogUploadFinished(const QString &crashLogURL) const;
};
} // namespace OBS