X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Flogger.h;h=7752a74add9e9a05068a0e22042d187b3bd24d3f;hp=910c555dc08232514c834481a95069bd2e4cc596;hb=ab7ef4d24f62b5848b628482b7762ebfc0b53e1a;hpb=695758015a80eb8c158a9ac4c0f1c0b547e70df3 diff --git a/src/common/logger.h b/src/common/logger.h index 910c555d..7752a74a 100644 --- a/src/common/logger.h +++ b/src/common/logger.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2015 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -18,59 +18,95 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef LOGGER_H -#define LOGGER_H +#pragma once -#include -#include +#include -#include "quassel.h" -#include "types.h" +#include +#include +#include +#include +#include -class Logger +/** + * The Logger class encapsulates the various configured logging backends. + */ +class Logger : public QObject { + Q_OBJECT + public: - inline Logger(Quassel::LogLevel level) : _stream(&_buffer, QIODevice::WriteOnly), _logLevel(level) {} - ~Logger(); + Logger(QObject *parent = nullptr); + ~Logger() override; -#if QT_VERSION < 0x050000 - static void logMessage(QtMsgType type, const char *msg); -#else - static void logMessage(QtMsgType, const QMessageLogContext&, const QString&); -#endif + enum class LogLevel { + Debug, + Info, + Warning, + Error, + Fatal + }; - template - inline Logger &operator<<(const T &value) { _stream << value << " "; return *this; } - inline Logger &operator<<(const QStringList &t) { _stream << t.join(" ") << " "; return *this; } - inline Logger &operator<<(bool t) { _stream << (t ? "true" : "false") << " "; return *this; } + struct LogEntry { + QDateTime timeStamp; + LogLevel logLevel; + QString message; + }; -private: - void log(); - QTextStream _stream; - QString _buffer; - Quassel::LogLevel _logLevel; -}; + /** + * Initial setup, to be called ones command line options are available. + * + * Sets up the log file if appropriate. Outputs the log messages already accumulated since + * construction. If @c keepMessages is false, deletes the accumulated messages afterwards, + * and won't store further ones. + * + * @param keepMessages Whether messages should be kept + * @returns true, if initialization was successful + */ + bool setup(bool keepMessages); + /** + * Accesses the stores log messages, e.g. for consumption by DebugLogWidget. + * + * @returns The accumuates log messages + */ + std::vector messages() const; -class quInfo : public Logger -{ -public: - inline quInfo() : Logger(Quassel::InfoLevel) {} -}; + static void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &message); + /** + * Takes the given message with the given log level, formats it and emits the @a messageLogged() signal. + * + * @note This method is thread-safe. + * + * @param logLevel The log leve of the message + * @param message The message + */ + void handleMessage(LogLevel logLevel, const QString &message); -class quWarning : public Logger -{ -public: - inline quWarning() : Logger(Quassel::WarningLevel) {} -}; +signals: + /** + * Emitted whenever a message was logged. + * + * @param message The message that was logged + */ + void messageLogged(const Logger::LogEntry &message); +private slots: + void onMessageLogged(const Logger::LogEntry &message); -class quError : public Logger -{ -public: - inline quError() : Logger(Quassel::ErrorLevel) {} -}; +private: + void handleMessage(QtMsgType type, const QString &message); + void outputMessage(const LogEntry &message); + +private: + LogLevel _outputLevel{LogLevel::Info}; + QFile _logFile; + bool _syslogEnabled{false}; + std::vector _messages; + bool _keepMessages{true}; + bool _initialized{false}; +}; -#endif +Q_DECLARE_METATYPE(Logger::LogEntry)