src/common/logger.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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
  35 namespace {
  36
  37 QByteArray msgWithTime(const Logger::LogEntry &msg)
  38 {
  39     return (msg.timeStamp.toString("yyyy-MM-dd hh:mm:ss ") + msg.message + "\n").toUtf8();
  40 };
  41
  42 }
  43
  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, SIGNAL(messageLogged(Logger::LogEntry)), this, SLOT(onMessageLogged(Logger::LogEntry)));
  55
  56 #if QT_VERSION < 0x050000
  57     qInstallMsgHandler(Logger::messageHandler);
  58 #else
  59     qInstallMessageHandler(Logger::messageHandler);
  60 #endif
  61 }
  62
  63
  64 Logger::~Logger()
  65 {
  66     // If we're not initialized yet, output pending messages so they don't get lost
  67     if (!_initialized) {
  68         for (auto &&message : _messages) {
  69             std::cerr << msgWithTime(message).constData();
  70         }
  71     }
  72 }
  73
  74
  75 std::vector<Logger::LogEntry> Logger::messages() const
  76 {
  77     return _messages;
  78 }
  79
  80
  81 bool Logger::setup(bool keepMessages)
  82 {
  83     _keepMessages = keepMessages;
  84
  85     // Set maximum level for output (we still store/announce all messages for client-side filtering)
  86     if (Quassel::isOptionSet("loglevel")) {
  87         QString level = Quassel::optionValue("loglevel").toLower();
  88         if (level == "debug")
  89             _outputLevel = LogLevel::Debug;
  90         else if (level == "info")
  91             _outputLevel = LogLevel::Info;
  92         else if (level == "warning")
  93             _outputLevel = LogLevel::Warning;
  94         else if (level == "error")
  95             _outputLevel = LogLevel::Error;
  96         else {
  97             qCritical() << qPrintable(tr("Invalid log level %1; supported are Debug|Info|Warning|Error").arg(level));
  98             return false;
  99         }
 100     }
 101
 102     QString logfilename = Quassel::optionValue("logfile");
 103     if (!logfilename.isEmpty()) {
 104         _logFile.setFileName(logfilename);
 105         if (!_logFile.open(QFile::Append|QFile::Unbuffered|QFile::Text)) {
 106             qCritical() << qPrintable(tr("Could not open log file \"%1\": %2").arg(logfilename, _logFile.errorString()));
 107         }
 108     }
 109     if (!_logFile.isOpen()) {
 110         if (!_logFile.open(stderr, QFile::WriteOnly|QFile::Unbuffered|QFile::Text)) {
 111             qCritical() << qPrintable(tr("Cannot write to stderr: %1").arg(_logFile.errorString()));
 112         }
 113     }
 114
 115 #ifdef HAVE_SYSLOG
 116     _syslogEnabled = Quassel::isOptionSet("syslog");
 117 #endif
 118
 119     _initialized = true;
 120
 121     // Now that we've setup our logging backends, output pending messages
 122     for (auto &&message : _messages) {
 123         outputMessage(message);
 124     }
 125     if (!_keepMessages) {
 126         _messages.clear();
 127     }
 128
 129     return true;
 130 }
 131
 132
 133 #if QT_VERSION < 0x050000
 134 void Logger::messageHandler(QtMsgType type, const char *message)
 135 #else
 136 void Logger::messageHandler(QtMsgType type, const QMessageLogContext &, const QString &message)
 137 #endif
 138 {
 139     Quassel::instance()->logger()->handleMessage(type, message);
 140 }
 141
 142
 143 void Logger::handleMessage(QtMsgType type, const QString &msg)
 144 {
 145     switch (type) {
 146     case QtDebugMsg:
 147         handleMessage(LogLevel::Debug, msg);
 148         break;
 149 #if QT_VERSION >= 0x050500
 150     case QtInfoMsg:
 151         handleMessage(LogLevel::Info, msg);
 152         break;
 153 #endif
 154     case QtWarningMsg:
 155         handleMessage(LogLevel::Warning, msg);
 156         break;
 157     case QtCriticalMsg:
 158         handleMessage(LogLevel::Error, msg);
 159         break;
 160     case QtFatalMsg:
 161         handleMessage(LogLevel::Fatal, msg);
 162         break;
 163     }
 164 }
 165
 166
 167 void Logger::handleMessage(LogLevel level, const QString &msg)
 168 {
 169     QString logString;
 170
 171     switch (level) {
 172     case LogLevel::Debug:
 173         logString = "[Debug] ";
 174         break;
 175     case LogLevel::Info:
 176         logString = "[Info ] ";
 177         break;
 178     case LogLevel::Warning:
 179         logString = "[Warn ] ";
 180         break;
 181     case LogLevel::Error:
 182         logString = "[Error] ";
 183         break;
 184     case LogLevel::Fatal:
 185         logString = "[FATAL] ";
 186         break;
 187     }
 188
 189     // Use signal connection to make this method thread-safe
 190     emit messageLogged({QDateTime::currentDateTime(), level, logString += msg});
 191 }
 192
 193
 194 void Logger::onMessageLogged(const LogEntry &message)
 195 {
 196     if (_keepMessages) {
 197         _messages.push_back(message);
 198     }
 199
 200     // If setup() wasn't called yet, just store the message - will be output later
 201     if (_initialized) {
 202         outputMessage(message);
 203     }
 204 }
 205
 206
 207 void Logger::outputMessage(const LogEntry &message)
 208 {
 209     if (message.logLevel < _outputLevel) {
 210         return;
 211     }
 212
 213 #ifdef HAVE_SYSLOG
 214     if (_syslogEnabled) {
 215         int prio{LOG_INFO};
 216         switch (message.logLevel) {
 217         case LogLevel::Debug:
 218             prio = LOG_DEBUG;
 219             break;
 220         case LogLevel::Info:
 221             prio = LOG_INFO;
 222             break;
 223         case LogLevel::Warning:
 224             prio = LOG_WARNING;
 225             break;
 226         case LogLevel::Error:
 227             prio = LOG_ERR;
 228             break;
 229         case LogLevel::Fatal:
 230             prio = LOG_CRIT;
 231         }
 232         syslog(prio|LOG_USER, "%s", qPrintable(message.message));
 233     }
 234 #endif
 235
 236     if (!_logFile.fileName().isEmpty() || !_syslogEnabled) {
 237         _logFile.write(msgWithTime(message));
 238     }
 239
 240 #ifndef Q_OS_MAC
 241     // For fatal messages, write log to dump file
 242     if (message.logLevel == LogLevel::Fatal) {
 243         QFile dumpFile{Quassel::instance()->coreDumpFileName()};
 244         if (dumpFile.open(QIODevice::Append)) {
 245             dumpFile.write(msgWithTime(message));
 246             dumpFile.close();
 247         }
 248     }
 249 #endif
 250
 251 }