/***************************************************************************
- * Copyright (C) 2005-2018 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 *
#include <algorithm>
#include <iostream>
-#include <signal.h>
-#if !defined Q_OS_WIN && !defined Q_OS_MAC
-# include <sys/types.h>
-# include <sys/time.h>
-# include <sys/resource.h>
-#endif
-
#include <QCoreApplication>
#include <QDateTime>
#include <QDir>
#include "bufferinfo.h"
#include "identity.h"
#include "logger.h"
-#include "logmessage.h"
#include "message.h"
#include "network.h"
#include "peer.h"
#include "protocol.h"
#include "syncableobject.h"
#include "types.h"
+#include "version.h"
-#include "../../version.h"
+#ifndef Q_OS_WIN
+# include "posixsignalwatcher.h"
+#else
+# include "windowssignalwatcher.h"
+#endif
Quassel::Quassel()
: Singleton<Quassel>{this}
, _logger{new Logger{this}}
{
+#ifdef EMBED_DATA
+ Q_INIT_RESOURCE(i18n);
+#endif
}
-
-bool Quassel::init()
+void Quassel::init(RunMode runMode)
{
- if (instance()->_initialized)
- return true; // allow multiple invocations because of MonolithicApplication
+ _runMode = runMode;
- // Setup signal handling
- // TODO: Don't use unsafe methods, see handleSignal()
+ qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
- // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
- signal(SIGTERM, handleSignal);
- signal(SIGINT, handleSignal);
-#ifndef Q_OS_WIN
- // SIGHUP is used to reload configuration (i.e. SSL certificates)
- // Windows does not support SIGHUP
- signal(SIGHUP, handleSignal);
-#endif
+ setupSignalHandling();
+ setupEnvironment();
+ registerMetaTypes();
- if (instance()->_handleCrashes) {
- // we have crashhandler for win32 and unix (based on execinfo).
-#if defined(Q_OS_WIN) || defined(HAVE_EXECINFO)
-# ifndef Q_OS_WIN
- // we only handle crashes ourselves if coredumps are disabled
- struct rlimit *limit = (rlimit *)malloc(sizeof(struct rlimit));
- int rc = getrlimit(RLIMIT_CORE, limit);
-
- if (rc == -1 || !((long)limit->rlim_cur > 0 || limit->rlim_cur == RLIM_INFINITY)) {
-# endif /* Q_OS_WIN */
- signal(SIGABRT, handleSignal);
- signal(SIGSEGV, handleSignal);
-# ifndef Q_OS_WIN
- signal(SIGBUS, handleSignal);
- }
- free(limit);
-# endif /* Q_OS_WIN */
-#endif /* Q_OS_WIN || HAVE_EXECINFO */
- }
+ // Initial translation (may be overridden in UI settings)
+ loadTranslation(QLocale::system());
- instance()->_initialized = true;
- qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
+ setupCliParser();
- instance()->setupEnvironment();
- instance()->registerMetaTypes();
+ // Don't keep a debug log on the core
+ logger()->setup(runMode != RunMode::CoreOnly);
Network::setDefaultCodecForServer("UTF-8");
Network::setDefaultCodecForEncoding("UTF-8");
Network::setDefaultCodecForDecoding("ISO-8859-15");
-
- if (isOptionSet("help")) {
- instance()->_cliParser->usage();
- return false;
- }
-
- if (isOptionSet("version")) {
- std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
- return false;
- }
-
- // Don't keep a debug log on the core
- return instance()->logger()->setup(runMode() != RunMode::CoreOnly);
}
-
-Logger *Quassel::logger() const
+Logger* Quassel::logger() const
{
return _logger;
}
-
void Quassel::registerQuitHandler(QuitHandler handler)
{
instance()->_quitHandlers.emplace_back(std::move(handler));
void Quassel::quit()
{
- if (_quitHandlers.empty()) {
- QCoreApplication::quit();
- }
- else {
- for (auto &&handler : _quitHandlers) {
- handler();
+ // Protect against multiple invocations (e.g. triggered by MainWin::closeEvent())
+ if (!_quitting) {
+ _quitting = true;
+ qInfo() << "Quitting...";
+ if (_quitHandlers.empty()) {
+ QCoreApplication::quit();
+ }
+ else {
+ // Note: We expect one of the registered handlers to call QCoreApplication::quit()
+ for (auto&& handler : _quitHandlers) {
+ handler();
+ }
}
}
}
-
void Quassel::registerReloadHandler(ReloadHandler handler)
{
instance()->_reloadHandlers.emplace_back(std::move(handler));
}
-
bool Quassel::reloadConfig()
{
bool result{true};
- for (auto &&handler : _reloadHandlers) {
+ for (auto&& handler : _reloadHandlers) {
result = result && handler();
}
return result;
}
-
//! Register our custom types with Qt's Meta Object System.
/** This makes them available for QVariant and in signals/slots, among other things.
-*
-*/
+ *
+ */
void Quassel::registerMetaTypes()
{
// Complex types
}
}
-
void Quassel::setupEnvironment()
{
// On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
#ifdef Q_OS_UNIX
QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
if (xdgDataVar.isEmpty())
- xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
+ xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
xdgDirs.append(appDir);
// Also append apps/quassel, this is only for QIconLoader to find icons there
xdgDirs.append(appDir + "/apps/quassel");
- } else
+ }
+ else
xdgDirs.append(appDir); // build directory is always the last fallback
xdgDirs.removeDuplicates();
#endif
}
-
void Quassel::setupBuildInfo()
{
BuildInfo buildInfo;
buildInfo.organizationName = "Quassel Project";
buildInfo.organizationDomain = "quassel-irc.org";
- buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
+ buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
buildInfo.baseVersion = QUASSEL_VERSION_STRING;
buildInfo.generatedVersion = GIT_DESCRIBE;
if (buildInfo.generatedVersion.isEmpty()) {
if (!buildInfo.commitHash.isEmpty()) {
// dist version
- buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}
- .arg(buildInfo.baseVersion)
- .arg(buildInfo.commitHash.left(7));
+ buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}.arg(buildInfo.baseVersion).arg(buildInfo.commitHash.left(7));
buildInfo.fancyVersionString = QString{"v%1 (dist-<a href=\"https://github.com/quassel/quassel/commit/%3\">%2</a>)"}
.arg(buildInfo.baseVersion)
.arg(buildInfo.commitHash.left(7))
instance()->_buildInfo = std::move(buildInfo);
}
-
-const Quassel::BuildInfo &Quassel::buildInfo()
+const Quassel::BuildInfo& Quassel::buildInfo()
{
return instance()->_buildInfo;
}
+void Quassel::setupSignalHandling()
+{
+#ifndef Q_OS_WIN
+ _signalWatcher = new PosixSignalWatcher(this);
+#else
+ _signalWatcher = new WindowsSignalWatcher(this);
+#endif
+ connect(_signalWatcher, &AbstractSignalWatcher::handleSignal, this, &Quassel::handleSignal);
+}
-//! Signal handler for graceful shutdown.
-//! @todo: Ensure this doesn't use unsafe methods (it does currently)
-//! cf. QSocketNotifier, UnixSignalWatcher
-void Quassel::handleSignal(int sig)
+void Quassel::handleSignal(AbstractSignalWatcher::Action action)
{
- switch (sig) {
- case SIGTERM:
- case SIGINT:
- qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
- instance()->quit();
+ switch (action) {
+ case AbstractSignalWatcher::Action::Reload:
+ // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for graceful reloading of processes.
+ if (!_reloadHandlers.empty()) {
+ qInfo() << "Reloading configuration";
+ if (reloadConfig()) {
+ qInfo() << "Successfully reloaded configuration";
+ }
+ }
break;
-#ifndef Q_OS_WIN
-// Windows does not support SIGHUP
- case SIGHUP:
- // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for
- // graceful reloading of processes.
- quInfo() << "Caught signal" << SIGHUP << "- reloading configuration";
- if (instance()->reloadConfig()) {
- quInfo() << "Successfully reloaded configuration";
+ case AbstractSignalWatcher::Action::Terminate:
+ if (!_quitting) {
+ quit();
+ }
+ else {
+ qInfo() << "Already shutting down, ignoring signal";
}
break;
-#endif
- case SIGABRT:
- case SIGSEGV:
-#ifndef Q_OS_WIN
- case SIGBUS:
-#endif
- instance()->logBacktrace(instance()->coreDumpFileName());
+ case AbstractSignalWatcher::Action::HandleCrash:
+ logBacktrace(instance()->coreDumpFileName());
exit(EXIT_FAILURE);
- default:
- ;
}
}
-
-void Quassel::disableCrashHandler()
+Quassel::RunMode Quassel::runMode()
{
- instance()->_handleCrashes = false;
+ return instance()->_runMode;
}
+void Quassel::setupCliParser()
+{
+ QList<QCommandLineOption> options;
-Quassel::RunMode Quassel::runMode() {
- return instance()->_runMode;
-}
+ // General options
+ /// @todo Bring back --datadir to specify the database location independent of config
+ if (runMode() == RunMode::ClientOnly) {
+ options += {{"c", "configdir"}, tr("Specify the directory holding the client configuration."), tr("path")};
+ }
+ else {
+ options += {{"c", "configdir"},
+ tr("Specify the directory holding configuration files, the SQlite database and the SSL certificate."),
+ tr("path")};
+ }
+ // Client options
+ if (runMode() != RunMode::CoreOnly) {
+ options += {
+ {"icontheme", tr("Override the system icon theme ('breeze' is recommended)."), tr("theme")},
+ {"qss", tr("Load a custom application stylesheet."), tr("file.qss")},
+ {"hidewindow", tr("Start the client minimized to the system tray.")},
+ {"account", tr("Account id to connect to on startup."), tr("account"), "0"},
+ };
+ }
-void Quassel::setRunMode(RunMode runMode)
-{
- instance()->_runMode = runMode;
-}
+ // Core options
+ if (runMode() != RunMode::ClientOnly) {
+ options += {
+ {"listen", tr("The address(es) quasselcore will listen on."), tr("<address>[,<address>[,...]]"), "::,0.0.0.0"},
+ {{"p", "port"}, tr("The port quasselcore will listen at."), tr("port"), "4242"},
+ {{"n", "norestore"}, tr("Don't restore last core's state.")},
+ {"config-from-environment", tr("Load configuration from environment variables.")},
+ {"select-backend", tr("Switch storage backend (migrating data if possible)."), tr("backendidentifier")},
+ {"select-authenticator", tr("Select authentication backend."), tr("authidentifier")},
+ {"add-user", tr("Starts an interactive session to add a new core user.")},
+ {"change-userpass",
+ tr("Starts an interactive session to change the password of the user identified by <username>."),
+ tr("username")},
+ {"strict-ident", tr("Use users' quasselcore username as ident reply. Ignores each user's configured ident setting.")},
+ {"ident-daemon", tr("Enable internal ident daemon.")},
+ {"ident-port",
+ tr("The port quasselcore will listen at for ident requests. Only meaningful with --ident-daemon."),
+ tr("port"),
+ "10113"},
+ {"ident-listen", tr("The address(es) quasselcore will listen on for ident requests. Same format as --listen."), tr("<address>[,...]"), "::1,127.0.0.1"},
+ {"oidentd", tr("Enable oidentd integration. In most cases you should also enable --strict-ident.")},
+ {"oidentd-conffile", tr("Set path to oidentd configuration file."), tr("file")},
+ {"proxy-cidr", tr("Set IP range from which proxy protocol definitions are allowed"), tr("<address>[,...]"), "::1,127.0.0.1"},
+ {"require-ssl", tr("Require SSL for remote (non-loopback) client connections.")},
+ {"ssl-cert", tr("Specify the path to the SSL certificate."), tr("path"), "configdir/quasselCert.pem"},
+ {"ssl-key", tr("Specify the path to the SSL key."), tr("path"), "ssl-cert-path"},
+ {"metrics-daemon", tr("Enable metrics API.")},
+ {"metrics-port", tr("The port quasselcore will listen at for metrics requests. Only meaningful with --metrics-daemon."), tr("port"), "9558"},
+ {"metrics-listen", tr("The address(es) quasselcore will listen on for metrics requests. Same format as --listen."), tr("<address>[,...]"), "::1,127.0.0.1"}
+ };
+ }
+ // Logging options
+ options += {
+ {{"L", "loglevel"}, tr("Supports one of Debug|Info|Warning|Error; default is Info."), tr("level"), "Info"},
+ {{"l", "logfile"}, tr("Log to a file."), "path"},
+#ifdef HAVE_SYSLOG
+ {"syslog", tr("Log to syslog.")},
+#endif
+ };
+
+ // Debug options
+ options += {{"d", "debug"}, tr("Enable debug output.")};
+ if (runMode() != RunMode::CoreOnly) {
+ options += {
+ {"debugbufferswitches", tr("Enables debugging for bufferswitches.")},
+ {"debugmodel", tr("Enables debugging for models.")},
+ };
+ }
+ if (runMode() != RunMode::ClientOnly) {
+ options += {
+ {"debug-irc", tr("Enable logging of all raw IRC messages to debug log, including passwords! In most cases you should also set --loglevel Debug")},
+ {"debug-irc-id", tr("Limit raw IRC logging to this network ID. Implies --debug-irc"), tr("database network ID"), "-1"},
+ {"debug-irc-parsed", tr("Enable logging of all parsed IRC messages to debug log, including passwords! In most cases you should also set --loglevel Debug")},
+ {"debug-irc-parsed-id", tr("Limit parsed IRC logging to this network ID. Implies --debug-irc-parsed"), tr("database network ID"), "-1"},
+ };
+ }
-void Quassel::setCliParser(std::shared_ptr<AbstractCliParser> parser)
-{
- instance()->_cliParser = std::move(parser);
-}
+ _cliParser.addOptions(options);
+ _cliParser.addHelpOption();
+ _cliParser.addVersionOption();
+ _cliParser.setApplicationDescription(tr("Quassel IRC is a modern, distributed IRC client."));
+ // This will call ::exit() for --help, --version and in case of errors
+ _cliParser.process(*QCoreApplication::instance());
+}
-QString Quassel::optionValue(const QString &key)
+QString Quassel::optionValue(const QString& key)
{
- return instance()->_cliParser ? instance()->_cliParser->value(key) : QString{};
+ return instance()->_cliParser.value(key);
}
-
-bool Quassel::isOptionSet(const QString &key)
+bool Quassel::isOptionSet(const QString& key)
{
- return instance()->_cliParser ? instance()->_cliParser->isSet(key) : false;
+ return instance()->_cliParser.isSet(key);
}
-
-const QString &Quassel::coreDumpFileName()
+const QString& Quassel::coreDumpFileName()
{
if (_coreDumpFileName.isEmpty()) {
QDir configDir(configDirPath());
- _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
+ _coreDumpFileName = configDir.absoluteFilePath(
+ QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
QFile dumpFile(_coreDumpFileName);
dumpFile.open(QIODevice::Append);
QTextStream dumpStream(&dumpFile);
return _coreDumpFileName;
}
-
QString Quassel::configDirPath()
{
if (!instance()->_configDirPath.isEmpty())
return instance()->_configDirPath;
QString path;
- if (isOptionSet("datadir")) {
- qWarning() << "Obsolete option --datadir used!";
- path = Quassel::optionValue("datadir");
- }
- else if (isOptionSet("configdir")) {
+ if (isOptionSet("configdir")) {
path = Quassel::optionValue("configdir");
}
else {
path = QDir::homePath() + "/Library/Application Support/Quassel/";
#else
// We abuse QSettings to find us a sensible path on the other platforms
-# ifdef Q_OS_WIN
+# ifdef Q_OS_WIN
// don't use the registry
QSettings::Format format = QSettings::IniFormat;
-# else
+# else
QSettings::Format format = QSettings::NativeFormat;
-# endif
+# endif
QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
QFileInfo fileInfo(s.fileName());
path = fileInfo.dir().absolutePath();
return path;
}
-
-void Quassel::setDataDirPaths(const QStringList &paths) {
- instance()->_dataDirPaths = paths;
-}
-
-
QStringList Quassel::dataDirPaths()
{
- return instance()->_dataDirPaths;
-}
+ if (!instance()->_dataDirPaths.isEmpty())
+ return instance()->_dataDirPaths;
-
-QStringList Quassel::findDataDirPaths()
-{
- // TODO Qt5
- // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
- // want to stay consistent.
+ // TODO: Migrate to QStandardPaths (will require moving of the sqlite database,
+ // or a fallback for it being in the config dir)
QStringList dataDirNames;
#ifdef Q_OS_WIN
- dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
- << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
- << QCoreApplication::applicationDirPath();
+ dataDirNames << QCoreApplication::applicationDirPath() + "/data/quassel/"
+ << qgetenv("APPDATA") + QCoreApplication::organizationDomain() << QCoreApplication::applicationDirPath();
#elif defined Q_OS_MAC
- dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
- << QCoreApplication::applicationDirPath();
+ dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/" << QCoreApplication::applicationDirPath();
#else
// Linux et al
// Now whatever is configured through XDG_DATA_DIRS
QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
if (xdgDataDirs.isEmpty())
- dataDirNames << "/usr/local/share" << "/usr/share";
+ dataDirNames << "/usr/local/share"
+ << "/usr/share";
else
dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
dataDirNames.removeDuplicates();
+ instance()->_dataDirPaths = dataDirNames;
return dataDirNames;
}
-
-QString Quassel::findDataFilePath(const QString &fileName)
+QString Quassel::findDataFilePath(const QString& fileName)
{
QStringList dataDirs = dataDirPaths();
- foreach(QString dataDir, dataDirs) {
+ foreach (QString dataDir, dataDirs) {
QString path = dataDir + fileName;
if (QFile::exists(path))
return path;
return QString();
}
-
QStringList Quassel::scriptDirPaths()
{
QStringList res(configDirPath() + "scripts/");
- foreach(QString path, dataDirPaths())
- res << path + "scripts/";
+ foreach (QString path, dataDirPaths())
+ res << path + "scripts/";
return res;
}
-
QString Quassel::translationDirPath()
{
if (instance()->_translationDirPath.isEmpty()) {
// We support only one translation dir; fallback mechanisms wouldn't work else.
// This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
- foreach(const QString &dir, dataDirPaths()) {
+ foreach (const QString& dir, dataDirPaths()) {
if (QFile::exists(dir + "translations/")) {
instance()->_translationDirPath = dir + "translations/";
break;
return instance()->_translationDirPath;
}
-
-void Quassel::loadTranslation(const QLocale &locale)
+void Quassel::loadTranslation(const QLocale& locale)
{
- QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
- QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
+ auto* qtTranslator = QCoreApplication::instance()->findChild<QTranslator*>("QtTr");
+ auto* quasselTranslator = QCoreApplication::instance()->findChild<QTranslator*>("QuasselTr");
if (qtTranslator)
qApp->removeTranslator(qtTranslator);
qtTranslator = new QTranslator(qApp);
qtTranslator->setObjectName("QtTr");
- qApp->installTranslator(qtTranslator);
quasselTranslator = new QTranslator(qApp);
quasselTranslator->setObjectName("QuasselTr");
- qApp->installTranslator(quasselTranslator);
-#if QT_VERSION >= 0x040800 && !defined Q_OS_MAC
+#ifndef Q_OS_MAC
bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
if (!success)
qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
#endif
-}
+ qApp->installTranslator(quasselTranslator);
+ qApp->installTranslator(qtTranslator);
+}
// ---- Quassel::Features ---------------------------------------------------------------------------------------------
_features.resize(featureEnum.keyCount(), true); // enable all known features to true
}
-
-Quassel::Features::Features(const QStringList &features, LegacyFeatures legacyFeatures)
+Quassel::Features::Features(const QStringList& features, LegacyFeatures legacyFeatures)
{
// TODO Qt5: Use QMetaEnum::fromType()
auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
_features.resize(featureEnum.keyCount(), false);
- for (auto &&feature : features) {
+ for (auto&& feature : features) {
int i = featureEnum.keyToValue(qPrintable(feature));
if (i >= 0) {
_features[i] = true;
if (legacyFeatures) {
// TODO Qt5: Use QMetaEnum::fromType()
auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
- for (quint32 mask = 0x0001; mask <= 0x8000; mask <<=1) {
+ for (quint32 mask = 0x0001; mask <= 0x8000; mask <<= 1) {
if (static_cast<quint32>(legacyFeatures) & mask) {
int i = featureEnum.keyToValue(legacyFeatureEnum.valueToKey(mask));
if (i >= 0) {
}
}
-
bool Quassel::Features::isEnabled(Feature feature) const
{
- size_t i = static_cast<size_t>(feature);
+ auto i = static_cast<size_t>(feature);
return i < _features.size() ? _features[i] : false;
}
-
QStringList Quassel::Features::toStringList(bool enabled) const
{
// Check if any feature is enabled
return result;
}
-
Quassel::LegacyFeatures Quassel::Features::toLegacyFeatures() const
{
// TODO Qt5: Use LegacyFeatures (flag operators for enum classes not supported in Qt4)
return static_cast<LegacyFeatures>(result);
}
-
QStringList Quassel::Features::unknownFeatures() const
{
return _unknownFeatures;