X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Flogger.cpp;h=2c601fdbfedf0a9e5dd82ec77daebb1862919692;hp=d8da4c7dbe6b69cd14ab796fa3d4eec2c93d9d51;hb=d9026a22f17d5f8b2734cbf0348ad35de5b13f0b;hpb=2deb46a3ce819c709800f1ded9072e62807b9574 diff --git a/src/common/logger.cpp b/src/common/logger.cpp index d8da4c7d..2c601fdb 100644 --- a/src/common/logger.cpp +++ b/src/common/logger.cpp @@ -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,109 +15,222 @@ * 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. * ***************************************************************************/ +#include + +#ifdef HAVE_SYSLOG +# include +#endif + +#include +#include +#include +#include + #include "logger.h" #include "quassel.h" +#include "types.h" -#ifdef HAVE_SYSLOG_H -#include -#else -#include -#include -#include -#endif +namespace { + +QByteArray msgWithTime(const Logger::LogEntry& msg) +{ + return (msg.timeStamp.toString("yyyy-MM-dd hh:mm:ss ") + msg.message + "\n").toUtf8(); +} + +} // namespace + +Logger::Logger(QObject* parent) + : QObject(parent) +{ + static bool registered = []() { + qRegisterMetaType(); + return true; + }(); + Q_UNUSED(registered) + + connect(this, &Logger::messageLogged, this, &Logger::onMessageLogged); + + qInstallMessageHandler(Logger::messageHandler); +} + +Logger::~Logger() +{ + // If we're not initialized yet, output pending messages so they don't get lost + if (!_initialized) { + for (auto&& message : _messages) { + std::cerr << msgWithTime(message).constData(); + } + } +} + +std::vector Logger::messages() const +{ + return _messages; +} + +void Logger::setup(bool keepMessages) +{ + _keepMessages = keepMessages; + + // Set maximum level for output (we still store/announce all messages for client-side filtering) + if (Quassel::isOptionSet("loglevel")) { + QString level = Quassel::optionValue("loglevel").toLower(); + if (level == "debug") + _outputLevel = LogLevel::Debug; + else if (level == "info") + _outputLevel = LogLevel::Info; + else if (level == "warning") + _outputLevel = LogLevel::Warning; + else if (level == "error") + _outputLevel = LogLevel::Error; + else { + throw ExitException{EXIT_FAILURE, qPrintable(tr("Invalid log level %1; supported are Debug|Info|Warning|Error").arg(level))}; + } + } + + QString logfilename = Quassel::optionValue("logfile"); + if (!logfilename.isEmpty()) { + _logFile.setFileName(logfilename); + if (!_logFile.open(QFile::Append | QFile::Unbuffered | QFile::Text)) { + qCritical() << qPrintable(tr("Could not open log file \"%1\": %2").arg(logfilename, _logFile.errorString())); + } + } + if (!_logFile.isOpen()) { + if (!_logFile.open(stderr, QFile::WriteOnly | QFile::Unbuffered | QFile::Text)) { + qCritical() << qPrintable(tr("Cannot write to stderr: %1").arg(_logFile.errorString())); + } + } + +#ifdef HAVE_SYSLOG + _syslogEnabled = Quassel::isOptionSet("syslog"); -Logger::~Logger() { - QDateTime date = QDateTime::currentDateTime(); - - switch (_logLevel) { - case DebugLevel: - _buffer.prepend("Debug: "); - break; - case InfoLevel: - _buffer.prepend("Info: "); - break; - case WarningLevel: - _buffer.prepend("Warning: "); - break; - case ErrorLevel: - _buffer.prepend("Error: "); - break; - default: - Q_ASSERT(_logLevel); // There should be no unknown log level - break; - } -#ifndef HAVE_SYSLOG_H - _buffer.prepend(date.toString("yyyy-MM-dd hh:mm:ss ")); + // set up options, program name, and facility for later calls to syslog(3) + if (_syslogEnabled) + openlog("quasselcore", LOG_PID, LOG_USER); #endif - log(); + + _initialized = true; + + // Now that we've setup our logging backends, output pending messages + for (auto&& message : _messages) { + outputMessage(message); + } + if (!_keepMessages) { + _messages.clear(); + } } -void Logger::log() { - LogLevel lvl; - if (Quassel::optionValue("loglevel") == "Debug") lvl = DebugLevel; - else if (Quassel::optionValue("loglevel") == "Info") lvl = InfoLevel; - else if (Quassel::optionValue("loglevel") == "Warning") lvl = WarningLevel; - else if (Quassel::optionValue("loglevel") == "Error") lvl = ErrorLevel; - else lvl = InfoLevel; - - if(_logLevel < lvl) return; - -#ifdef HAVE_SYSLOG_H - if (Quassel::isOptionSet("syslog")) { - int prio; - switch (lvl) { - case DebugLevel: - prio = LOG_DEBUG; +void Logger::messageHandler(QtMsgType type, const QMessageLogContext&, const QString& message) +{ + Quassel::instance()->logger()->handleMessage(type, message); +} + +void Logger::handleMessage(QtMsgType type, const QString& msg) +{ + switch (type) { + case QtDebugMsg: + handleMessage(LogLevel::Debug, msg); break; - case InfoLevel: - prio = LOG_INFO; + case QtInfoMsg: + handleMessage(LogLevel::Info, msg); break; - case WarningLevel: - prio = LOG_WARNING; + case QtWarningMsg: + handleMessage(LogLevel::Warning, msg); break; - case ErrorLevel: - prio = LOG_ERR; + case QtCriticalMsg: + handleMessage(LogLevel::Error, msg); break; - default: - prio = LOG_INFO; + case QtFatalMsg: + handleMessage(LogLevel::Fatal, msg); break; } - syslog(LOG_USER & prio, "%s", qPrintable(_buffer)); - } -#else - // if we can't open logfile we log to stdout - QTextStream out(stdout); - QFile file; - if(!Quassel::optionValue("logfile").isEmpty()) { - file.setFileName(Quassel::optionValue("logfile")); - if (file.open(QIODevice::Append | QIODevice::Text)) { - out.setDevice(&file); - _buffer.remove(QChar('\n')); +} + +void Logger::handleMessage(LogLevel level, const QString& msg) +{ + QString logString; + + // Only add the log level to the message if we do not output to syslog + if (!_syslogEnabled) { + switch (level) { + case LogLevel::Debug: + logString = "[Debug] "; + break; + case LogLevel::Info: + logString = "[Info ] "; + break; + case LogLevel::Warning: + logString = "[Warn ] "; + break; + case LogLevel::Error: + logString = "[Error] "; + break; + case LogLevel::Fatal: + logString = "[FATAL] "; + break; + } } - } - out << _buffer << endl; - if(file.isOpen()) file.close(); -#endif + + // Use signal connection to make this method thread-safe + emit messageLogged({QDateTime::currentDateTime(), level, logString += msg}); } +void Logger::onMessageLogged(const LogEntry& message) +{ + if (_keepMessages) { + _messages.push_back(message); + } + + // If setup() wasn't called yet, just store the message - will be output later + if (_initialized) { + outputMessage(message); + } +} -void Logger::logMessage(QtMsgType type, const char *msg) { - switch (type) { - case QtDebugMsg: - Logger(Logger::DebugLevel) << msg; - break; - case QtWarningMsg: - Logger(Logger::WarningLevel) << msg; - break; - case QtCriticalMsg: - Logger(Logger::ErrorLevel) << msg; - break; - case QtFatalMsg: - Logger(Logger::ErrorLevel) << msg; - Quassel::logFatalMessage(msg); - return; - } +void Logger::outputMessage(const LogEntry& message) +{ + if (message.logLevel < _outputLevel) { + return; + } + +#ifdef HAVE_SYSLOG + if (_syslogEnabled) { + int prio{LOG_INFO}; + switch (message.logLevel) { + case LogLevel::Debug: + prio = LOG_DEBUG; + break; + case LogLevel::Info: + prio = LOG_INFO; + break; + case LogLevel::Warning: + prio = LOG_WARNING; + break; + case LogLevel::Error: + prio = LOG_ERR; + break; + case LogLevel::Fatal: + prio = LOG_CRIT; + } + syslog(prio, "%s", qPrintable(message.message)); + } +#endif + + if (!_logFile.fileName().isEmpty() || !_syslogEnabled) { + _logFile.write(msgWithTime(message)); + } + +#ifndef Q_OS_MAC + // For fatal messages, write log to dump file + if (message.logLevel == LogLevel::Fatal) { + QFile dumpFile{Quassel::instance()->coreDumpFileName()}; + if (dumpFile.open(QIODevice::Append)) { + dumpFile.write(msgWithTime(message)); + dumpFile.close(); + } + } +#endif }