X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Flogger.h;h=f55590c1c696efc1538f5846f5f1440050ac1693;hp=07ae0156d15cb59c3d8af562c1c46c5cac41b34e;hb=01d67be28f1eb983a1bd0b97f13160ffb6b39307;hpb=dadcc49b8d790d4913478e08978da2718bd6f048 diff --git a/src/common/logger.h b/src/common/logger.h index 07ae0156..f55590c1 100644 --- a/src/common/logger.h +++ b/src/common/logger.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005 by the Quassel Project * + * Copyright (C) 2005-2019 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,71 +15,110 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef _LOGGER_H_ -#define _LOGGER_H_ +#pragma once -#include "types.h" +#include "common-export.h" +#include + +#include +#include +#include +#include #include -#include -#include - -class Logger { - public: - enum LogLevel { - DebugLevel, - InfoLevel, - WarningLevel, - ErrorLevel + +/** + * The Logger class encapsulates the various configured logging backends. + */ +class COMMON_EXPORT Logger : public QObject +{ + Q_OBJECT + +public: + Logger(QObject* parent = nullptr); + ~Logger() override; + + enum class LogLevel + { + Debug, + Info, + Warning, + Error, + Fatal }; - inline Logger(LogLevel level) : _stream(new Stream(level)) {} - ~Logger(); - - inline Logger &operator<<(const char* t) { _stream->internalStream << QString::fromAscii(t); return *this; } - inline Logger &operator<<(QChar t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(bool t) { _stream->internalStream << (t ? "true" : "false"); return *this; } - inline Logger &operator<<(char t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(signed short t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(unsigned short t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(signed int t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(unsigned int t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(signed long t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(unsigned long t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(qint64 t) { _stream->internalStream << QString::number(t); return *this; } - inline Logger &operator<<(quint64 t) { _stream->internalStream << QString::number(t); return *this; } - inline Logger &operator<<(float t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(double t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(const QString & t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(const QLatin1String &t) { _stream->internalStream << t.latin1(); return *this; } - inline Logger &operator<<(const QByteArray & t) { _stream->internalStream << t ; return *this; } - inline Logger &operator<<(const void * t) { _stream->internalStream << t; return *this; } - inline Logger &operator<<(const QStringList & t) { _stream->internalStream << t.join(" "); return *this; } - inline Logger &operator<<(const BufferId & t) { _stream->internalStream << QVariant::fromValue(t).toInt(); return *this; } - inline Logger &operator<<(const NetworkId & t) { _stream->internalStream << QVariant::fromValue(t).toInt(); return *this; } - inline Logger &operator<<(const UserId & t) { _stream->internalStream << QVariant::fromValue(t).toInt(); return *this; } - inline Logger &operator<<(const MsgId & t) { _stream->internalStream << QVariant::fromValue(t).toInt(); return *this; } - inline Logger &operator<<(const IdentityId & t) { _stream->internalStream << QVariant::fromValue(t).toInt(); return *this; } - inline Logger &operator<<(const AccountId & t) { _stream->internalStream << QVariant::fromValue(t).toInt(); return *this; } - - void log(); - private: - struct Stream { - Stream(LogLevel level) - : internalStream(&buffer, QIODevice::WriteOnly), - logLevel(level) {} - QTextStream internalStream; - QString buffer; - LogLevel logLevel; - } *_stream; -}; + struct COMMON_EXPORT LogEntry + { + QDateTime timeStamp; + LogLevel logLevel; + QString message; + + /** + * Gets this log entry in a printable format, with timestamp and log level + * + * @return the log entry, formatted with timestamp and log level + */ + QString toString() const; + }; + + /** + * 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 + * @throws ExitException, if command line options are invalid + */ + void setup(bool keepMessages); -inline Logger quDebug() { return Logger(Logger::DebugLevel); } -inline Logger quInfo() { return Logger(Logger::InfoLevel); } -inline Logger quWarning() { return Logger(Logger::WarningLevel); } -inline Logger quError() { return Logger(Logger::ErrorLevel); } + /** + * Accesses the stores log messages, e.g. for consumption by DebugLogWidget. + * + * @returns The accumuates log messages + */ + std::vector messages() const; + + 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); + +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); + +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}; + QByteArray _prgname; +}; -#endif +Q_DECLARE_METATYPE(Logger::LogEntry)