1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
25 #if !defined Q_OS_WIN && !defined Q_OS_MAC
26 # include <sys/types.h>
27 # include <sys/time.h>
28 # include <sys/resource.h>
31 #include <QCoreApplication>
35 #include <QHostAddress>
36 #include <QLibraryInfo>
39 #include <QTranslator>
42 #include "bufferinfo.h"
49 #include "syncableobject.h"
52 #include "../../version.h"
54 Quassel *Quassel::instance()
56 static Quassel instance;
63 // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
64 signal(SIGTERM, handleSignal);
65 signal(SIGINT, handleSignal);
67 // SIGHUP is used to reload configuration (i.e. SSL certificates)
68 // Windows does not support SIGHUP
69 signal(SIGHUP, handleSignal);
76 if (instance()->_initialized)
77 return true; // allow multiple invocations because of MonolithicApplication
79 if (instance()->_handleCrashes) {
80 // we have crashhandler for win32 and unix (based on execinfo).
81 #if defined(Q_OS_WIN) || defined(HAVE_EXECINFO)
83 // we only handle crashes ourselves if coredumps are disabled
84 struct rlimit *limit = (rlimit *)malloc(sizeof(struct rlimit));
85 int rc = getrlimit(RLIMIT_CORE, limit);
87 if (rc == -1 || !((long)limit->rlim_cur > 0 || limit->rlim_cur == RLIM_INFINITY)) {
88 # endif /* Q_OS_WIN */
89 signal(SIGABRT, handleSignal);
90 signal(SIGSEGV, handleSignal);
92 signal(SIGBUS, handleSignal);
95 # endif /* Q_OS_WIN */
96 #endif /* Q_OS_WIN || HAVE_EXECINFO */
99 instance()->_initialized = true;
100 qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
102 instance()->setupEnvironment();
103 instance()->registerMetaTypes();
105 Network::setDefaultCodecForServer("ISO-8859-1");
106 Network::setDefaultCodecForEncoding("UTF-8");
107 Network::setDefaultCodecForDecoding("ISO-8859-15");
109 if (isOptionSet("help")) {
110 instance()->_cliParser->usage();
114 if (isOptionSet("version")) {
115 std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
120 if (Quassel::runMode() != Quassel::ClientOnly) {
121 if (isOptionSet("loglevel")) {
122 QString level = optionValue("loglevel");
124 if (level == "Debug")
125 setLogLevel(DebugLevel);
126 else if (level == "Info")
127 setLogLevel(InfoLevel);
128 else if (level == "Warning")
129 setLogLevel(WarningLevel);
130 else if (level == "Error")
131 setLogLevel(ErrorLevel);
133 qWarning() << qPrintable(tr("Invalid log level %1; supported are Debug|Info|Warning|Error").arg(level));
138 QString logfilename = optionValue("logfile");
139 if (!logfilename.isEmpty()) {
140 instance()->_logFile.reset(new QFile{logfilename});
141 if (!logFile()->open(QIODevice::Append | QIODevice::Text)) {
142 qWarning() << "Could not open log file" << logfilename << ":" << logFile()->errorString();
143 instance()->_logFile.reset();
147 instance()->_logToSyslog = isOptionSet("syslog");
155 void Quassel::destroy()
159 instance()->_logFile.reset();
164 void Quassel::registerQuitHandler(QuitHandler handler)
166 instance()->_quitHandlers.emplace_back(std::move(handler));
171 if (_quitHandlers.empty()) {
172 QCoreApplication::quit();
175 for (auto &&handler : _quitHandlers) {
182 void Quassel::registerReloadHandler(ReloadHandler handler)
184 instance()->_reloadHandlers.emplace_back(std::move(handler));
188 bool Quassel::reloadConfig()
191 for (auto &&handler : _reloadHandlers) {
192 result = result && handler();
198 //! Register our custom types with Qt's Meta Object System.
199 /** This makes them available for QVariant and in signals/slots, among other things.
202 void Quassel::registerMetaTypes()
205 qRegisterMetaType<Message>("Message");
206 qRegisterMetaType<BufferInfo>("BufferInfo");
207 qRegisterMetaType<NetworkInfo>("NetworkInfo");
208 qRegisterMetaType<Network::Server>("Network::Server");
209 qRegisterMetaType<Identity>("Identity");
211 qRegisterMetaTypeStreamOperators<Message>("Message");
212 qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
213 qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
214 qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
215 qRegisterMetaTypeStreamOperators<Identity>("Identity");
217 qRegisterMetaType<IdentityId>("IdentityId");
218 qRegisterMetaType<BufferId>("BufferId");
219 qRegisterMetaType<NetworkId>("NetworkId");
220 qRegisterMetaType<UserId>("UserId");
221 qRegisterMetaType<AccountId>("AccountId");
222 qRegisterMetaType<MsgId>("MsgId");
224 qRegisterMetaType<QHostAddress>("QHostAddress");
225 qRegisterMetaTypeStreamOperators<QHostAddress>("QHostAddress");
226 qRegisterMetaType<QUuid>("QUuid");
227 qRegisterMetaTypeStreamOperators<QUuid>("QUuid");
229 qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
230 qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
231 qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
232 qRegisterMetaTypeStreamOperators<UserId>("UserId");
233 qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
234 qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
236 qRegisterMetaType<Protocol::SessionState>("Protocol::SessionState");
237 qRegisterMetaType<PeerPtr>("PeerPtr");
238 qRegisterMetaTypeStreamOperators<PeerPtr>("PeerPtr");
240 // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
241 if (!QMetaType::type("QVariant")) {
242 qRegisterMetaType<QVariant>("QVariant");
243 qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
248 void Quassel::setupEnvironment()
250 // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
251 // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard
252 // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to
253 // hack extra search paths into various places.
255 QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
256 if (xdgDataVar.isEmpty())
257 xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
259 QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
261 // Add our install prefix (if we're not in a bindir, this just adds the current workdir)
262 QString appDir = QCoreApplication::applicationDirPath();
263 int binpos = appDir.lastIndexOf("/bin");
265 appDir.replace(binpos, 4, "/share");
266 xdgDirs.append(appDir);
267 // Also append apps/quassel, this is only for QIconLoader to find icons there
268 xdgDirs.append(appDir + "/apps/quassel");
270 xdgDirs.append(appDir); // build directory is always the last fallback
272 xdgDirs.removeDuplicates();
274 qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":")));
279 void Quassel::setupBuildInfo()
282 buildInfo.applicationName = "quassel";
283 buildInfo.coreApplicationName = "quasselcore";
284 buildInfo.clientApplicationName = "quasselclient";
285 buildInfo.organizationName = "Quassel Project";
286 buildInfo.organizationDomain = "quassel-irc.org";
288 buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
290 buildInfo.baseVersion = QUASSEL_VERSION_STRING;
291 buildInfo.generatedVersion = GIT_DESCRIBE;
293 // Check if we got a commit hash
294 if (!QString(GIT_HEAD).isEmpty()) {
295 buildInfo.commitHash = GIT_HEAD;
297 date.setTime_t(GIT_COMMIT_DATE);
298 buildInfo.commitDate = date.toString();
300 else if (!QString(DIST_HASH).contains("Format")) {
301 buildInfo.commitHash = DIST_HASH;
302 buildInfo.commitDate = QString(DIST_DATE);
305 // create a nice version string
306 if (buildInfo.generatedVersion.isEmpty()) {
307 if (!buildInfo.commitHash.isEmpty()) {
309 buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}
310 .arg(buildInfo.baseVersion)
311 .arg(buildInfo.commitHash.left(7));
312 buildInfo.fancyVersionString = QString{"v%1 (dist-<a href=\"https://github.com/quassel/quassel/commit/%3\">%2</a>)"}
313 .arg(buildInfo.baseVersion)
314 .arg(buildInfo.commitHash.left(7))
315 .arg(buildInfo.commitHash);
318 // we only have a base version :(
319 buildInfo.plainVersionString = QString{"v%1 (unknown revision)"}.arg(buildInfo.baseVersion);
323 // analyze what we got from git-describe
324 static const QRegExp rx{"(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$"};
325 if (rx.exactMatch(buildInfo.generatedVersion)) {
326 QString distance = rx.cap(2) == "0" ? QString{} : QString{"%1+%2 "}.arg(rx.cap(1), rx.cap(2));
327 buildInfo.plainVersionString = QString{"v%1 (%2git-%3%4)"}.arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4));
328 if (!buildInfo.commitHash.isEmpty()) {
329 buildInfo.fancyVersionString = QString{"v%1 (%2git-<a href=\"https://github.com/quassel/quassel/commit/%5\">%3</a>%4)"}
330 .arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), buildInfo.commitHash);
334 buildInfo.plainVersionString = QString{"v%1 (invalid revision)"}.arg(buildInfo.baseVersion);
337 if (buildInfo.fancyVersionString.isEmpty()) {
338 buildInfo.fancyVersionString = buildInfo.plainVersionString;
341 instance()->_buildInfo = std::move(buildInfo);
345 const Quassel::BuildInfo &Quassel::buildInfo()
347 return instance()->_buildInfo;
351 //! Signal handler for graceful shutdown.
352 void Quassel::handleSignal(int sig)
357 qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
361 // Windows does not support SIGHUP
363 // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for
364 // graceful reloading of processes.
365 quInfo() << "Caught signal" << SIGHUP << "- reloading configuration";
366 if (instance()->reloadConfig()) {
367 quInfo() << "Successfully reloaded configuration";
376 instance()->logBacktrace(instance()->coreDumpFileName());
384 void Quassel::disableCrashHandler()
386 instance()->_handleCrashes = false;
390 Quassel::RunMode Quassel::runMode() {
391 return instance()->_runMode;
395 void Quassel::setRunMode(RunMode runMode)
397 instance()->_runMode = runMode;
401 void Quassel::setCliParser(std::shared_ptr<AbstractCliParser> parser)
403 instance()->_cliParser = std::move(parser);
407 QString Quassel::optionValue(const QString &key)
409 return instance()->_cliParser ? instance()->_cliParser->value(key) : QString{};
413 bool Quassel::isOptionSet(const QString &key)
415 return instance()->_cliParser ? instance()->_cliParser->isSet(key) : false;
419 Quassel::LogLevel Quassel::logLevel()
421 return instance()->_logLevel;
425 void Quassel::setLogLevel(LogLevel logLevel)
427 instance()->_logLevel = logLevel;
431 QFile *Quassel::logFile() {
432 return instance()->_logFile.get();
436 bool Quassel::logToSyslog()
438 return instance()->_logToSyslog;
442 void Quassel::logFatalMessage(const char *msg)
447 QFile dumpFile(instance()->coreDumpFileName());
448 dumpFile.open(QIODevice::Append);
449 QTextStream dumpStream(&dumpFile);
451 dumpStream << "Fatal: " << msg << '\n';
458 const QString &Quassel::coreDumpFileName()
460 if (_coreDumpFileName.isEmpty()) {
461 QDir configDir(configDirPath());
462 _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
463 QFile dumpFile(_coreDumpFileName);
464 dumpFile.open(QIODevice::Append);
465 QTextStream dumpStream(&dumpFile);
466 dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
467 qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
471 return _coreDumpFileName;
475 QString Quassel::configDirPath()
477 if (!instance()->_configDirPath.isEmpty())
478 return instance()->_configDirPath;
481 if (isOptionSet("datadir")) {
482 qWarning() << "Obsolete option --datadir used!";
483 path = Quassel::optionValue("datadir");
485 else if (isOptionSet("configdir")) {
486 path = Quassel::optionValue("configdir");
490 // On Mac, the path is always the same
491 path = QDir::homePath() + "/Library/Application Support/Quassel/";
493 // We abuse QSettings to find us a sensible path on the other platforms
495 // don't use the registry
496 QSettings::Format format = QSettings::IniFormat;
498 QSettings::Format format = QSettings::NativeFormat;
500 QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
501 QFileInfo fileInfo(s.fileName());
502 path = fileInfo.dir().absolutePath();
503 #endif /* Q_OS_MAC */
506 if (!path.endsWith(QDir::separator()) && !path.endsWith('/'))
507 path += QDir::separator();
510 if (!qDir.exists(path)) {
511 if (!qDir.mkpath(path)) {
512 qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
517 instance()->_configDirPath = path;
523 void Quassel::setDataDirPaths(const QStringList &paths) {
524 instance()->_dataDirPaths = paths;
528 QStringList Quassel::dataDirPaths()
530 return instance()->_dataDirPaths;
534 QStringList Quassel::findDataDirPaths()
537 // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
538 // want to stay consistent.
540 QStringList dataDirNames;
542 dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
543 << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
544 << QCoreApplication::applicationDirPath();
545 #elif defined Q_OS_MAC
546 dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
547 << QCoreApplication::applicationDirPath();
551 // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share
552 // This should thus come first.
553 QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
554 if (xdgDataHome.isEmpty())
555 xdgDataHome = QDir::homePath() + QLatin1String("/.local/share");
556 dataDirNames << xdgDataHome;
558 // Now whatever is configured through XDG_DATA_DIRS
559 QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
560 if (xdgDataDirs.isEmpty())
561 dataDirNames << "/usr/local/share" << "/usr/share";
563 dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
565 // Just in case, also check our install prefix
566 dataDirNames << QCoreApplication::applicationDirPath() + "/../share";
568 // Normalize and append our application name
569 for (int i = 0; i < dataDirNames.count(); i++)
570 dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/";
574 // Add resource path and workdir just in case.
575 // Workdir should have precedence
576 dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/");
577 dataDirNames.append(":/data/");
579 // Append trailing '/' and check for existence
580 auto iter = dataDirNames.begin();
581 while (iter != dataDirNames.end()) {
582 if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
583 iter->append(QDir::separator());
584 if (!QFile::exists(*iter))
585 iter = dataDirNames.erase(iter);
590 dataDirNames.removeDuplicates();
596 QString Quassel::findDataFilePath(const QString &fileName)
598 QStringList dataDirs = dataDirPaths();
599 foreach(QString dataDir, dataDirs) {
600 QString path = dataDir + fileName;
601 if (QFile::exists(path))
608 QStringList Quassel::scriptDirPaths()
610 QStringList res(configDirPath() + "scripts/");
611 foreach(QString path, dataDirPaths())
612 res << path + "scripts/";
617 QString Quassel::translationDirPath()
619 if (instance()->_translationDirPath.isEmpty()) {
620 // We support only one translation dir; fallback mechanisms wouldn't work else.
621 // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
622 foreach(const QString &dir, dataDirPaths()) {
623 if (QFile::exists(dir + "translations/")) {
624 instance()->_translationDirPath = dir + "translations/";
628 if (instance()->_translationDirPath.isEmpty())
629 instance()->_translationDirPath = ":/i18n/";
631 return instance()->_translationDirPath;
635 void Quassel::loadTranslation(const QLocale &locale)
637 QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
638 QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
641 qApp->removeTranslator(qtTranslator);
642 if (quasselTranslator)
643 qApp->removeTranslator(quasselTranslator);
645 // We use QLocale::C to indicate that we don't want a translation
646 if (locale.language() == QLocale::C)
649 qtTranslator = new QTranslator(qApp);
650 qtTranslator->setObjectName("QtTr");
651 qApp->installTranslator(qtTranslator);
653 quasselTranslator = new QTranslator(qApp);
654 quasselTranslator->setObjectName("QuasselTr");
655 qApp->installTranslator(quasselTranslator);
657 #if QT_VERSION >= 0x040800 && !defined Q_OS_MAC
658 bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
660 qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
661 quasselTranslator->load(locale, QString(""), translationDirPath());
663 bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
665 qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
666 quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
671 // ---- Quassel::Features ---------------------------------------------------------------------------------------------
673 Quassel::Features::Features()
675 QStringList features;
677 // TODO Qt5: Use QMetaEnum::fromType()
678 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
679 _features.resize(featureEnum.keyCount(), true); // enable all known features to true
683 Quassel::Features::Features(const QStringList &features, LegacyFeatures legacyFeatures)
685 // TODO Qt5: Use QMetaEnum::fromType()
686 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
687 _features.resize(featureEnum.keyCount(), false);
689 for (auto &&feature : features) {
690 int i = featureEnum.keyToValue(qPrintable(feature));
695 _unknownFeatures << feature;
699 if (legacyFeatures) {
700 // TODO Qt5: Use QMetaEnum::fromType()
701 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
702 for (quint32 mask = 0x0001; mask <= 0x8000; mask <<=1) {
703 if (static_cast<quint32>(legacyFeatures) & mask) {
704 int i = featureEnum.keyToValue(legacyFeatureEnum.valueToKey(mask));
714 bool Quassel::Features::isEnabled(Feature feature) const
716 size_t i = static_cast<size_t>(feature);
717 return i < _features.size() ? _features[i] : false;
721 QStringList Quassel::Features::toStringList(bool enabled) const
724 // TODO Qt5: Use QMetaEnum::fromType()
725 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
726 for (quint32 i = 0; i < _features.size(); ++i) {
727 if (_features[i] == enabled) {
728 result << featureEnum.key(i);
735 Quassel::LegacyFeatures Quassel::Features::toLegacyFeatures() const
737 // TODO Qt5: Use LegacyFeatures (flag operators for enum classes not supported in Qt4)
739 // TODO Qt5: Use QMetaEnum::fromType()
740 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
741 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
743 for (quint32 i = 0; i < _features.size(); ++i) {
745 int v = legacyFeatureEnum.keyToValue(featureEnum.key(i));
751 return static_cast<LegacyFeatures>(result);
755 QStringList Quassel::Features::unknownFeatures() const
757 return _unknownFeatures;