1 /***************************************************************************
2 * Copyright (C) 2005-2020 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
38 QByteArray msgWithTime(const Logger::LogEntry& msg)
40 return (msg.toString() + "\n").toUtf8();
45 Logger::Logger(QObject* parent)
48 static bool registered = []() {
49 qRegisterMetaType<LogEntry>();
54 connect(this, &Logger::messageLogged, this, &Logger::onMessageLogged);
56 qInstallMessageHandler(Logger::messageHandler);
61 // If we're not initialized yet, output pending messages so they don't get lost
63 for (auto&& message : _messages) {
64 std::cerr << msgWithTime(message).constData();
69 std::vector<Logger::LogEntry> Logger::messages() const
74 void Logger::setup(bool keepMessages)
76 _keepMessages = keepMessages;
78 // Set maximum level for output (we still store/announce all messages for client-side filtering)
79 if (Quassel::isOptionSet("loglevel")) {
80 QString level = Quassel::optionValue("loglevel").toLower();
82 _outputLevel = LogLevel::Debug;
83 else if (level == "info")
84 _outputLevel = LogLevel::Info;
85 else if (level == "warning")
86 _outputLevel = LogLevel::Warning;
87 else if (level == "error")
88 _outputLevel = LogLevel::Error;
90 throw ExitException{EXIT_FAILURE, qPrintable(tr("Invalid log level %1; supported are Debug|Info|Warning|Error").arg(level))};
94 QString logfilename = Quassel::optionValue("logfile");
95 if (!logfilename.isEmpty()) {
96 _logFile.setFileName(logfilename);
97 if (!_logFile.open(QFile::Append | QFile::Unbuffered | QFile::Text)) {
98 qCritical() << qPrintable(tr("Could not open log file \"%1\": %2").arg(logfilename, _logFile.errorString()));
101 if (!_logFile.isOpen()) {
102 if (!_logFile.open(stderr, QFile::WriteOnly | QFile::Unbuffered | QFile::Text)) {
103 qCritical() << qPrintable(tr("Cannot write to stderr: %1").arg(_logFile.errorString()));
108 _syslogEnabled = Quassel::isOptionSet("syslog");
110 Quassel::RunMode mode = Quassel::runMode();
111 Quassel::BuildInfo info = Quassel::buildInfo();
112 QString prgname = info.applicationName;
114 if (mode == Quassel::RunMode::ClientOnly) {
115 prgname = info.clientApplicationName;
116 } else if (mode == Quassel::RunMode::CoreOnly) {
117 prgname = info.coreApplicationName;
120 _prgname = prgname.toLocal8Bit();
122 // set up options, program name, and facility for later calls to syslog(3)
123 if (_syslogEnabled) {
124 openlog(_prgname.constData(), LOG_PID, LOG_USER);
130 // Now that we've setup our logging backends, output pending messages
131 for (auto&& message : _messages) {
132 outputMessage(message);
134 if (!_keepMessages) {
139 void Logger::messageHandler(QtMsgType type, const QMessageLogContext&, const QString& message)
141 Quassel::instance()->logger()->handleMessage(type, message);
144 void Logger::handleMessage(QtMsgType type, const QString& msg)
148 handleMessage(LogLevel::Debug, msg);
151 handleMessage(LogLevel::Info, msg);
154 handleMessage(LogLevel::Warning, msg);
157 handleMessage(LogLevel::Error, msg);
160 handleMessage(LogLevel::Fatal, msg);
165 void Logger::handleMessage(LogLevel level, const QString& msg)
167 // Use signal connection to make this method thread-safe
168 emit messageLogged({QDateTime::currentDateTime(), level, msg});
171 void Logger::onMessageLogged(const LogEntry& message)
174 _messages.push_back(message);
177 // If setup() wasn't called yet, just store the message - will be output later
179 outputMessage(message);
183 void Logger::outputMessage(const LogEntry& message)
185 if (message.logLevel < _outputLevel) {
190 if (_syslogEnabled) {
192 switch (message.logLevel) {
193 case LogLevel::Debug:
199 case LogLevel::Warning:
202 case LogLevel::Error:
205 case LogLevel::Fatal:
208 syslog(prio, "%s", qPrintable(message.message));
212 if (!_logFile.fileName().isEmpty() || !_syslogEnabled) {
213 _logFile.write(msgWithTime(message));
217 // For fatal messages, write log to dump file
218 if (message.logLevel == LogLevel::Fatal) {
219 QFile dumpFile{Quassel::instance()->coreDumpFileName()};
220 if (dumpFile.open(QIODevice::Append)) {
221 dumpFile.write(msgWithTime(message));
229 QString Logger::LogEntry::toString() const
234 case Logger::LogLevel::Debug:
235 levelString = "[Debug] ";
237 case Logger::LogLevel::Info:
238 levelString = "[Info ] ";
240 case Logger::LogLevel::Warning:
241 levelString = "[Warn ] ";
243 case Logger::LogLevel::Error:
244 levelString = "[Error] ";
246 case Logger::LogLevel::Fatal:
247 levelString = "[FATAL] ";
251 return timeStamp.toString("yyyy-MM-dd hh:mm:ss ") + levelString + message;