Merge branch 'select-account-from-cli' of https://github.com/justjanne/quassel
[quassel.git] / src / common / logger.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2019 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 COMMON_EXPORT LogEntry
54     {
55         QDateTime timeStamp;
56         LogLevel logLevel;
57         QString message;
58
59         /**
60          * Gets this log entry in a printable format, with timestamp and log level
61          *
62          * @return the log entry, formatted with timestamp and log level
63          */
64         QString toString() const;
65     };
66
67     /**
68      * Initial setup, to be called ones command line options are available.
69      *
70      * Sets up the log file if appropriate. Outputs the log messages already accumulated since
71      * construction. If @c keepMessages is false, deletes the accumulated messages afterwards,
72      * and won't store further ones.
73      *
74      * @param keepMessages Whether messages should be kept
75      * @throws ExitException, if command line options are invalid
76      */
77     void setup(bool keepMessages);
78
79     /**
80      * Accesses the stores log messages, e.g. for consumption by DebugLogWidget.
81      *
82      * @returns The accumuates log messages
83      */
84     std::vector<Logger::LogEntry> messages() const;
85
86     static void messageHandler(QtMsgType type, const QMessageLogContext& context, const QString& message);
87
88     /**
89      * Takes the given message with the given log level, formats it and emits the @a messageLogged() signal.
90      *
91      * @note This method is thread-safe.
92      *
93      * @param logLevel The log leve of the message
94      * @param message  The message
95      */
96     void handleMessage(LogLevel logLevel, const QString& message);
97
98 signals:
99     /**
100      * Emitted whenever a message was logged.
101      *
102      * @param message The message that was logged
103      */
104     void messageLogged(const Logger::LogEntry& message);
105
106 private slots:
107     void onMessageLogged(const Logger::LogEntry& message);
108
109 private:
110     void handleMessage(QtMsgType type, const QString& message);
111     void outputMessage(const LogEntry& message);
112
113 private:
114     LogLevel _outputLevel{LogLevel::Info};
115     QFile _logFile;
116     bool _syslogEnabled{false};
117
118     std::vector<LogEntry> _messages;
119     bool _keepMessages{true};
120     bool _initialized{false};
121     QByteArray _prgname;
122 };
123
124 Q_DECLARE_METATYPE(Logger::LogEntry)