src/common/logger.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include <vector>
  24
  25 #include <QDateTime>
  26 #include <QFile>
  27 #include <QMetaType>
  28 #include <QObject>
  29 #include <QString>
  30
  31 /**
  32  * The Logger class encapsulates the various configured logging backends.
  33  */
  34 class Logger : public QObject
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     Logger(QObject *parent = nullptr);
  40     ~Logger() override;
  41
  42     enum class LogLevel {
  43         Debug,
  44         Info,
  45         Warning,
  46         Error,
  47         Fatal
  48     };
  49
  50     struct LogEntry {
  51         QDateTime timeStamp;
  52         LogLevel logLevel;
  53         QString message;
  54     };
  55
  56     /**
  57      * Initial setup, to be called ones command line options are available.
  58      *
  59      * Sets up the log file if appropriate. Outputs the log messages already accumulated since
  60      * construction. If @c keepMessages is false, deletes the accumulated messages afterwards,
  61      * and won't store further ones.
  62      *
  63      * @param keepMessages Whether messages should be kept
  64      * @returns true, if initialization was successful
  65      */
  66     bool setup(bool keepMessages);
  67
  68     /**
  69      * Accesses the stores log messages, e.g. for consumption by DebugLogWidget.
  70      *
  71      * @returns The accumuates log messages
  72      */
  73     std::vector<Logger::LogEntry> messages() const;
  74
  75 #if QT_VERSION < 0x050000
  76     static void messageHandler(QtMsgType type, const char *message);
  77 #else
  78     static void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &message);
  79 #endif
  80
  81     /**
  82      * Takes the given message with the given log level, formats it and emits the @a messageLogged() signal.
  83      *
  84      * @note This method is thread-safe.
  85      *
  86      * @param logLevel The log leve of the message
  87      * @param message  The message
  88      */
  89     void handleMessage(LogLevel logLevel, const QString &message);
  90
  91 signals:
  92     /**
  93      * Emitted whenever a message was logged.
  94      *
  95      * @param message The message that was logged
  96      */
  97     void messageLogged(const Logger::LogEntry &message);
  98
  99 private slots:
 100     void onMessageLogged(const Logger::LogEntry &message);
 101
 102 private:
 103     void handleMessage(QtMsgType type, const QString &message);
 104     void outputMessage(const LogEntry &message);
 105
 106 private:
 107     LogLevel _outputLevel{LogLevel::Info};
 108     QFile _logFile;
 109     bool _syslogEnabled{false};
 110
 111     std::vector<LogEntry> _messages;
 112     bool _keepMessages{true};
 113     bool _initialized{false};
 114 };
 115
 116 Q_DECLARE_METATYPE(Logger::LogEntry)