qetlogger.h

Go to the documentation of this file.

/*
        Copyright 2006-2026 The QElectroTech Team
        This file is part of QElectroTech.
 
        QElectroTech 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.
 
        QElectroTech 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 QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef QETLOGGER_H
#define QETLOGGER_H
 
#include "logring.h"
 
#include <QFile>
#include <QMutex>
#include <QString>
#include <QtGlobal>

class QetLogger
{
        public:
                static constexpr qint64 kMaxFileBytes = 2 * 1024 * 1024; // 2 MiB per file
                static constexpr int kRotationKeep = 4;                  // .1.log .. .4.log
                static constexpr int kMaxMessageBytes = 4096;             // per-message truncation
 
                static QetLogger &instance();

                void init();

                void installCrashHandler();

                void handleMessage(QtMsgType type, const QMessageLogContext &context, const QString &msg);

                void pruneOldLogFiles(int days);

                QVector<QByteArray> ringSnapshot() const {return m_ring.snapshot();}
 
                // --- Step 5: getting the data back out -------------------------

                bool hasPendingCrashDump() const;

                QByteArray pendingCrashDumpContents() const;

                void clearPendingCrashDump();

                QByteArray buildDiagnosticsReport() const;

                static QByteArray redact(const QByteArray &input);
 
        private:
                QetLogger() = default;
                QetLogger(const QetLogger &) = delete;
 
                bool ensureFileOpenLocked();
                void rotateLocked();
                void writeToFile(const QByteArray &line, QtMsgType type);
                QString rotatedPath(int index) const;
                QString crashDumpPath() const;
                QString currentLogFilePath() const;
 
                static QByteArray sanitize(const QByteArray &input);
                static QByteArray truncateMessage(const QByteArray &input, int max_bytes);
                static QByteArray formatLine(QtMsgType type, const QMessageLogContext &context, const QByteArray &sanitized_msg);
 
                bool m_disabled = false;
 
                QString m_log_dir;
                QString m_base_name; // e.g. "20260803", resolved once in init()
 
                QMutex m_file_mutex;
                QFile m_file;
                qint64 m_bytes_written_current_file = 0;
                bool m_file_output_ok = false;
 
                LogRing m_ring;
};
 
#endif // QETLOGGER_H