X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Flogger.cpp;h=d17e18226c40694850be7ac4de79a3af3a91053d;hp=17c473b5a1643052606524e79d04c979c4a97890;hb=c18e611a6b8c07049cc82b2dcdb5b138d9a6dd43;hpb=034708a59ca1ee3195263a90941a2b145c520fef diff --git a/src/common/logger.cpp b/src/common/logger.cpp index 17c473b5..d17e1822 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,65 +15,232 @@ * 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" -#include -#include -#include +namespace { + +QByteArray msgWithTime(const Logger::LogEntry& msg) +{ + QString levelString; + + switch (msg.logLevel) { + case Logger::LogLevel::Debug: + levelString = "[Debug] "; + break; + case Logger::LogLevel::Info: + levelString = "[Info ] "; + break; + case Logger::LogLevel::Warning: + levelString = "[Warn ] "; + break; + case Logger::LogLevel::Error: + levelString = "[Error] "; + break; + case Logger::LogLevel::Fatal: + levelString = "[FATAL] "; + break; + } + + return (msg.timeStamp.toString("yyyy-MM-dd hh:mm:ss ") + levelString + 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"); + + Quassel::RunMode mode = Quassel::runMode(); + Quassel::BuildInfo info = Quassel::buildInfo(); + QString prgname = info.applicationName; + + if (mode == Quassel::RunMode::ClientOnly) { + prgname = info.clientApplicationName; + } else if (mode == Quassel::RunMode::CoreOnly) { + prgname = info.coreApplicationName; + } + + _prgname = prgname.toLocal8Bit(); + + // set up options, program name, and facility for later calls to syslog(3) + if (_syslogEnabled) { + openlog(_prgname.constData(), LOG_PID, LOG_USER); + } +#endif + + _initialized = true; -Logger::~Logger() { - QDateTime date = QDateTime::currentDateTime(); - if(_logLevel == DebugLevel) _buffer.prepend("Debug: "); - else if (_logLevel == InfoLevel) _buffer.prepend("Info: "); - else if (_logLevel == WarningLevel) _buffer.prepend("Warning: "); - else if (_logLevel == ErrorLevel) _buffer.prepend("Error: "); - _buffer.prepend(date.toString("yyyy-MM-dd hh:mm:ss ")); - log(); + // 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; - - // 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')); - } - } - out << _buffer << endl; - if(file.isOpen()) file.close(); +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 QtInfoMsg: + handleMessage(LogLevel::Info, msg); + break; + case QtWarningMsg: + handleMessage(LogLevel::Warning, msg); + break; + case QtCriticalMsg: + handleMessage(LogLevel::Error, msg); + break; + case QtFatalMsg: + handleMessage(LogLevel::Fatal, msg); + break; + } +} -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::handleMessage(LogLevel level, const QString& msg) +{ + // Use signal connection to make this method thread-safe + emit messageLogged({QDateTime::currentDateTime(), level, 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::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 }