/***************************************************************************
- * Copyright (C) 2005 by the Quassel Project *
+ * Copyright (C) 2005-2020 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* 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 <iostream>
+
+#ifdef HAVE_SYSLOG
+# include <syslog.h>
+#endif
+
+#include <QByteArray>
+#include <QDateTime>
+#include <QDebug>
+#include <QFile>
+
#include "logger.h"
+#include "quassel.h"
+#include "types.h"
-#include <iostream>
+namespace {
+
+QByteArray msgWithTime(const Logger::LogEntry& msg)
+{
+ return (msg.toString() + "\n").toUtf8();
+}
+
+} // namespace
+
+Logger::Logger(QObject* parent)
+ : QObject(parent)
+{
+ static bool registered = []() {
+ qRegisterMetaType<LogEntry>();
+ 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::LogEntry> 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;
-Logger::~Logger() {
- qInstallMsgHandler(0);
+ 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;
+
+ // Now that we've setup our logging backends, output pending messages
+ for (auto&& message : _messages) {
+ outputMessage(message);
+ }
+ if (!_keepMessages) {
+ _messages.clear();
+ }
+}
+
+void Logger::messageHandler(QtMsgType type, const QMessageLogContext&, const QString& message)
+{
+ Quassel::instance()->logger()->handleMessage(type, message);
}
-void messageHandler(QtMsgType type, const char *msg) {
- switch (type) {
+void Logger::handleMessage(QtMsgType type, const QString& msg)
+{
+ switch (type) {
case QtDebugMsg:
- std::cerr << "[DEBUG] " << msg << "\n";
- break;
+ handleMessage(LogLevel::Debug, msg);
+ break;
+ case QtInfoMsg:
+ handleMessage(LogLevel::Info, msg);
+ break;
case QtWarningMsg:
- std::cerr << "[WARNING] " << msg << "\n";
- break;
+ handleMessage(LogLevel::Warning, msg);
+ break;
case QtCriticalMsg:
- std::cerr << "[CRITICAL] " << msg << "\n";
- break;
+ handleMessage(LogLevel::Error, msg);
+ break;
case QtFatalMsg:
- std::cerr << "[FATAL] " << msg << "\n";
- abort(); // deliberately core dump
- }
+ handleMessage(LogLevel::Fatal, msg);
+ break;
+ }
+}
+
+void Logger::handleMessage(LogLevel level, const QString& msg)
+{
+ // Use signal connection to make this method thread-safe
+ emit messageLogged({QDateTime::currentDateTime(), level, msg});
}
-Logger::Logger() {
- qInstallMsgHandler(messageHandler);
+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
+}
+
+
+QString Logger::LogEntry::toString() const
+{
+ QString levelString;
+
+ switch (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 timeStamp.toString("yyyy-MM-dd hh:mm:ss ") + levelString + message;
}