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 "common-export.h"
  24
  25 #include <vector>
  26
  27 #include <QDateTime>
  28 #include <QFile>
  29 #include <QMetaType>
  30 #include <QObject>
  31 #include <QString>
  32
  33 /**
  34  * The Logger class encapsulates the various configured logging backends.
  35  */
  36 class COMMON_EXPORT Logger : public QObject
  37 {
  38     Q_OBJECT
  39
  40 public:
  41     Logger(QObject* parent = nullptr);
  42     ~Logger() override;
  43
  44     enum class LogLevel
  45     {
  46         Debug,
  47         Info,
  48         Warning,
  49         Error,
  50         Fatal
  51     };
  52
  53     struct LogEntry
  54     {
  55         QDateTime timeStamp;
  56         LogLevel logLevel;
  57         QString message;
  58     };
  59
  60     /**
  61      * Initial setup, to be called ones command line options are available.
  62      *
  63      * Sets up the log file if appropriate. Outputs the log messages already accumulated since
  64      * construction. If @c keepMessages is false, deletes the accumulated messages afterwards,
  65      * and won't store further ones.
  66      *
  67      * @param keepMessages Whether messages should be kept
  68      * @throws ExitException, if command line options are invalid
  69      */
  70     void setup(bool keepMessages);
  71
  72     /**
  73      * Accesses the stores log messages, e.g. for consumption by DebugLogWidget.
  74      *
  75      * @returns The accumuates log messages
  76      */
  77     std::vector<Logger::LogEntry> messages() const;
  78
  79     static void messageHandler(QtMsgType type, const QMessageLogContext& context, const QString& message);
  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)