src/common/logger.cpp

   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 #include <iostream>
  22
  23 #ifdef HAVE_SYSLOG
  24 #    include <syslog.h>
  25 #endif
  26
  27 #include <QByteArray>
  28 #include <QDateTime>
  29 #include <QDebug>
  30 #include <QFile>
  31
  32 #include "logger.h"
  33 #include "quassel.h"
  34 #include "types.h"
  35
  36 namespace {
  37
  38 QByteArray msgWithTime(const Logger::LogEntry& msg)
  39 {
  40     return (msg.timeStamp.toString("yyyy-MM-dd hh:mm:ss ") + msg.message + "\n").toUtf8();
  41 }
  42
  43 }  // namespace
  44
  45 Logger::Logger(QObject* parent)
  46     : QObject(parent)
  47 {
  48     static bool registered = []() {
  49         qRegisterMetaType<LogEntry>();
  50         return true;
  51     }();
  52     Q_UNUSED(registered)
  53
  54     connect(this, &Logger::messageLogged, this, &Logger::onMessageLogged);
  55
  56     qInstallMessageHandler(Logger::messageHandler);
  57 }
  58
  59 Logger::~Logger()
  60 {
  61     // If we're not initialized yet, output pending messages so they don't get lost
  62     if (!_initialized) {
  63         for (auto&& message : _messages) {
  64             std::cerr << msgWithTime(message).constData();
  65         }
  66     }
  67 }
  68
  69 std::vector<Logger::LogEntry> Logger::messages() const
  70 {
  71     return _messages;
  72 }
  73
  74 void Logger::setup(bool keepMessages)
  75 {
  76     _keepMessages = keepMessages;
  77
  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();
  81         if (level == "debug")
  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;
  89         else {
  90             throw ExitException{EXIT_FAILURE, qPrintable(tr("Invalid log level %1; supported are Debug|Info|Warning|Error").arg(level))};
  91         }
  92     }
  93
  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()));
  99         }
 100     }
 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()));
 104         }
 105     }
 106
 107 #ifdef HAVE_SYSLOG
 108     _syslogEnabled = Quassel::isOptionSet("syslog");
 109
 110     // set up options, program name, and facility for later calls to syslog(3)
 111     if (_syslogEnabled)
 112         openlog("quasselcore", LOG_PID, LOG_USER);
 113 #endif
 114
 115     _initialized = true;
 116
 117     // Now that we've setup our logging backends, output pending messages
 118     for (auto&& message : _messages) {
 119         outputMessage(message);
 120     }
 121     if (!_keepMessages) {
 122         _messages.clear();
 123     }
 124 }
 125
 126 void Logger::messageHandler(QtMsgType type, const QMessageLogContext&, const QString& message)
 127 {
 128     Quassel::instance()->logger()->handleMessage(type, message);
 129 }
 130
 131 void Logger::handleMessage(QtMsgType type, const QString& msg)
 132 {
 133     switch (type) {
 134     case QtDebugMsg:
 135         handleMessage(LogLevel::Debug, msg);
 136         break;
 137     case QtInfoMsg:
 138         handleMessage(LogLevel::Info, msg);
 139         break;
 140     case QtWarningMsg:
 141         handleMessage(LogLevel::Warning, msg);
 142         break;
 143     case QtCriticalMsg:
 144         handleMessage(LogLevel::Error, msg);
 145         break;
 146     case QtFatalMsg:
 147         handleMessage(LogLevel::Fatal, msg);
 148         break;
 149     }
 150 }
 151
 152 void Logger::handleMessage(LogLevel level, const QString& msg)
 153 {
 154     QString logString;
 155
 156     // Only add the log level to the message if we do not output to syslog
 157     if (!_syslogEnabled) {
 158         switch (level) {
 159         case LogLevel::Debug:
 160             logString = "[Debug] ";
 161             break;
 162         case LogLevel::Info:
 163             logString = "[Info ] ";
 164             break;
 165         case LogLevel::Warning:
 166             logString = "[Warn ] ";
 167             break;
 168         case LogLevel::Error:
 169             logString = "[Error] ";
 170             break;
 171         case LogLevel::Fatal:
 172             logString = "[FATAL] ";
 173             break;
 174         }
 175     }
 176
 177     // Use signal connection to make this method thread-safe
 178     emit messageLogged({QDateTime::currentDateTime(), level, logString += msg});
 179 }
 180
 181 void Logger::onMessageLogged(const LogEntry& message)
 182 {
 183     if (_keepMessages) {
 184         _messages.push_back(message);
 185     }
 186
 187     // If setup() wasn't called yet, just store the message - will be output later
 188     if (_initialized) {
 189         outputMessage(message);
 190     }
 191 }
 192
 193 void Logger::outputMessage(const LogEntry& message)
 194 {
 195     if (message.logLevel < _outputLevel) {
 196         return;
 197     }
 198
 199 #ifdef HAVE_SYSLOG
 200     if (_syslogEnabled) {
 201         int prio{LOG_INFO};
 202         switch (message.logLevel) {
 203         case LogLevel::Debug:
 204             prio = LOG_DEBUG;
 205             break;
 206         case LogLevel::Info:
 207             prio = LOG_INFO;
 208             break;
 209         case LogLevel::Warning:
 210             prio = LOG_WARNING;
 211             break;
 212         case LogLevel::Error:
 213             prio = LOG_ERR;
 214             break;
 215         case LogLevel::Fatal:
 216             prio = LOG_CRIT;
 217         }
 218         syslog(prio, "%s", qPrintable(message.message));
 219     }
 220 #endif
 221
 222     if (!_logFile.fileName().isEmpty() || !_syslogEnabled) {
 223         _logFile.write(msgWithTime(message));
 224     }
 225
 226 #ifndef Q_OS_MAC
 227     // For fatal messages, write log to dump file
 228     if (message.logLevel == LogLevel::Fatal) {
 229         QFile dumpFile{Quassel::instance()->coreDumpFileName()};
 230         if (dumpFile.open(QIODevice::Append)) {
 231             dumpFile.write(msgWithTime(message));
 232             dumpFile.close();
 233         }
 234     }
 235 #endif
 236 }