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 ***************************************************************************/
27 #if !defined Q_OS_WIN && !defined Q_OS_MAC
28 # include <sys/types.h>
29 # include <sys/time.h>
30 # include <sys/resource.h>
33 #include <QCoreApplication>
37 #include <QHostAddress>
38 #include <QLibraryInfo>
41 #include <QTranslator>
44 #include "bufferinfo.h"
47 #include "logmessage.h"
52 #include "syncableobject.h"
55 #include "../../version.h"
58 : Singleton<Quassel>{this}
59 , _logger{new Logger{this}}
66 if (instance()->_initialized)
67 return true; // allow multiple invocations because of MonolithicApplication
69 // Setup signal handling
70 // TODO: Don't use unsafe methods, see handleSignal()
72 // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
73 signal(SIGTERM, handleSignal);
74 signal(SIGINT, handleSignal);
76 // SIGHUP is used to reload configuration (i.e. SSL certificates)
77 // Windows does not support SIGHUP
78 signal(SIGHUP, handleSignal);
81 if (instance()->_handleCrashes) {
82 // we have crashhandler for win32 and unix (based on execinfo).
83 #if defined(Q_OS_WIN) || defined(HAVE_EXECINFO)
85 // we only handle crashes ourselves if coredumps are disabled
86 struct rlimit *limit = (rlimit *)malloc(sizeof(struct rlimit));
87 int rc = getrlimit(RLIMIT_CORE, limit);
89 if (rc == -1 || !((long)limit->rlim_cur > 0 || limit->rlim_cur == RLIM_INFINITY)) {
90 # endif /* Q_OS_WIN */
91 signal(SIGABRT, handleSignal);
92 signal(SIGSEGV, handleSignal);
94 signal(SIGBUS, handleSignal);
97 # endif /* Q_OS_WIN */
98 #endif /* Q_OS_WIN || HAVE_EXECINFO */
101 instance()->_initialized = true;
102 qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
104 instance()->setupEnvironment();
105 instance()->registerMetaTypes();
107 Network::setDefaultCodecForServer("UTF-8");
108 Network::setDefaultCodecForEncoding("UTF-8");
109 Network::setDefaultCodecForDecoding("ISO-8859-15");
111 if (isOptionSet("help")) {
112 instance()->_cliParser->usage();
116 if (isOptionSet("version")) {
117 std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
121 // Don't keep a debug log on the core
122 return instance()->logger()->setup(runMode() != RunMode::CoreOnly);
126 Logger *Quassel::logger() const
132 void Quassel::registerQuitHandler(QuitHandler handler)
134 instance()->_quitHandlers.emplace_back(std::move(handler));
139 // Protect against multiple invocations (e.g. triggered by MainWin::closeEvent())
142 if (_quitHandlers.empty()) {
143 QCoreApplication::quit();
146 // Note: We expect one of the registered handlers to call QCoreApplication::quit()
147 for (auto &&handler : _quitHandlers) {
155 void Quassel::registerReloadHandler(ReloadHandler handler)
157 instance()->_reloadHandlers.emplace_back(std::move(handler));
161 bool Quassel::reloadConfig()
164 for (auto &&handler : _reloadHandlers) {
165 result = result && handler();
171 //! Register our custom types with Qt's Meta Object System.
172 /** This makes them available for QVariant and in signals/slots, among other things.
175 void Quassel::registerMetaTypes()
178 qRegisterMetaType<Message>("Message");
179 qRegisterMetaType<BufferInfo>("BufferInfo");
180 qRegisterMetaType<NetworkInfo>("NetworkInfo");
181 qRegisterMetaType<Network::Server>("Network::Server");
182 qRegisterMetaType<Identity>("Identity");
184 qRegisterMetaTypeStreamOperators<Message>("Message");
185 qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
186 qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
187 qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
188 qRegisterMetaTypeStreamOperators<Identity>("Identity");
190 qRegisterMetaType<IdentityId>("IdentityId");
191 qRegisterMetaType<BufferId>("BufferId");
192 qRegisterMetaType<NetworkId>("NetworkId");
193 qRegisterMetaType<UserId>("UserId");
194 qRegisterMetaType<AccountId>("AccountId");
195 qRegisterMetaType<MsgId>("MsgId");
197 qRegisterMetaType<QHostAddress>("QHostAddress");
198 qRegisterMetaTypeStreamOperators<QHostAddress>("QHostAddress");
199 qRegisterMetaType<QUuid>("QUuid");
200 qRegisterMetaTypeStreamOperators<QUuid>("QUuid");
202 qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
203 qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
204 qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
205 qRegisterMetaTypeStreamOperators<UserId>("UserId");
206 qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
207 qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
209 qRegisterMetaType<Protocol::SessionState>("Protocol::SessionState");
210 qRegisterMetaType<PeerPtr>("PeerPtr");
211 qRegisterMetaTypeStreamOperators<PeerPtr>("PeerPtr");
213 // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
214 if (!QMetaType::type("QVariant")) {
215 qRegisterMetaType<QVariant>("QVariant");
216 qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
221 void Quassel::setupEnvironment()
223 // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
224 // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard
225 // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to
226 // hack extra search paths into various places.
228 QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
229 if (xdgDataVar.isEmpty())
230 xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
232 QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
234 // Add our install prefix (if we're not in a bindir, this just adds the current workdir)
235 QString appDir = QCoreApplication::applicationDirPath();
236 int binpos = appDir.lastIndexOf("/bin");
238 appDir.replace(binpos, 4, "/share");
239 xdgDirs.append(appDir);
240 // Also append apps/quassel, this is only for QIconLoader to find icons there
241 xdgDirs.append(appDir + "/apps/quassel");
243 xdgDirs.append(appDir); // build directory is always the last fallback
245 xdgDirs.removeDuplicates();
247 qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":")));
252 void Quassel::setupBuildInfo()
255 buildInfo.applicationName = "quassel";
256 buildInfo.coreApplicationName = "quasselcore";
257 buildInfo.clientApplicationName = "quasselclient";
258 buildInfo.organizationName = "Quassel Project";
259 buildInfo.organizationDomain = "quassel-irc.org";
261 buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
263 buildInfo.baseVersion = QUASSEL_VERSION_STRING;
264 buildInfo.generatedVersion = GIT_DESCRIBE;
266 // Check if we got a commit hash
267 if (!QString(GIT_HEAD).isEmpty()) {
268 buildInfo.commitHash = GIT_HEAD;
269 // Set to Unix epoch, wrapped as a string for backwards-compatibility
270 buildInfo.commitDate = QString::number(GIT_COMMIT_DATE);
272 else if (!QString(DIST_HASH).contains("Format")) {
273 buildInfo.commitHash = DIST_HASH;
274 // Leave as Unix epoch if set as Unix epoch, but don't force this for
275 // backwards-compatibility with existing packaging/release tools that might set strings.
276 buildInfo.commitDate = QString(DIST_DATE);
279 // create a nice version string
280 if (buildInfo.generatedVersion.isEmpty()) {
281 if (!buildInfo.commitHash.isEmpty()) {
283 buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}
284 .arg(buildInfo.baseVersion)
285 .arg(buildInfo.commitHash.left(7));
286 buildInfo.fancyVersionString = QString{"v%1 (dist-<a href=\"https://github.com/quassel/quassel/commit/%3\">%2</a>)"}
287 .arg(buildInfo.baseVersion)
288 .arg(buildInfo.commitHash.left(7))
289 .arg(buildInfo.commitHash);
292 // we only have a base version :(
293 buildInfo.plainVersionString = QString{"v%1 (unknown revision)"}.arg(buildInfo.baseVersion);
297 // analyze what we got from git-describe
298 static const QRegExp rx{"(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$"};
299 if (rx.exactMatch(buildInfo.generatedVersion)) {
300 QString distance = rx.cap(2) == "0" ? QString{} : QString{"%1+%2 "}.arg(rx.cap(1), rx.cap(2));
301 buildInfo.plainVersionString = QString{"v%1 (%2git-%3%4)"}.arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4));
302 if (!buildInfo.commitHash.isEmpty()) {
303 buildInfo.fancyVersionString = QString{"v%1 (%2git-<a href=\"https://github.com/quassel/quassel/commit/%5\">%3</a>%4)"}
304 .arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), buildInfo.commitHash);
308 buildInfo.plainVersionString = QString{"v%1 (invalid revision)"}.arg(buildInfo.baseVersion);
311 if (buildInfo.fancyVersionString.isEmpty()) {
312 buildInfo.fancyVersionString = buildInfo.plainVersionString;
315 instance()->_buildInfo = std::move(buildInfo);
319 const Quassel::BuildInfo &Quassel::buildInfo()
321 return instance()->_buildInfo;
325 //! Signal handler for graceful shutdown.
326 //! @todo: Ensure this doesn't use unsafe methods (it does currently)
327 //! cf. QSocketNotifier, UnixSignalWatcher
328 void Quassel::handleSignal(int sig)
333 qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
337 // Windows does not support SIGHUP
339 // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for
340 // graceful reloading of processes.
341 quInfo() << "Caught signal" << SIGHUP << "- reloading configuration";
342 if (instance()->reloadConfig()) {
343 quInfo() << "Successfully reloaded configuration";
352 instance()->logBacktrace(instance()->coreDumpFileName());
360 void Quassel::disableCrashHandler()
362 instance()->_handleCrashes = false;
366 Quassel::RunMode Quassel::runMode() {
367 return instance()->_runMode;
371 void Quassel::setRunMode(RunMode runMode)
373 instance()->_runMode = runMode;
377 void Quassel::setCliParser(std::shared_ptr<AbstractCliParser> parser)
379 instance()->_cliParser = std::move(parser);
383 QString Quassel::optionValue(const QString &key)
385 return instance()->_cliParser ? instance()->_cliParser->value(key) : QString{};
389 bool Quassel::isOptionSet(const QString &key)
391 return instance()->_cliParser ? instance()->_cliParser->isSet(key) : false;
395 const QString &Quassel::coreDumpFileName()
397 if (_coreDumpFileName.isEmpty()) {
398 QDir configDir(configDirPath());
399 _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
400 QFile dumpFile(_coreDumpFileName);
401 dumpFile.open(QIODevice::Append);
402 QTextStream dumpStream(&dumpFile);
403 dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
404 qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
408 return _coreDumpFileName;
412 QString Quassel::configDirPath()
414 if (!instance()->_configDirPath.isEmpty())
415 return instance()->_configDirPath;
418 if (isOptionSet("datadir")) {
419 qWarning() << "Obsolete option --datadir used!";
420 path = Quassel::optionValue("datadir");
422 else if (isOptionSet("configdir")) {
423 path = Quassel::optionValue("configdir");
427 // On Mac, the path is always the same
428 path = QDir::homePath() + "/Library/Application Support/Quassel/";
430 // We abuse QSettings to find us a sensible path on the other platforms
432 // don't use the registry
433 QSettings::Format format = QSettings::IniFormat;
435 QSettings::Format format = QSettings::NativeFormat;
437 QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
438 QFileInfo fileInfo(s.fileName());
439 path = fileInfo.dir().absolutePath();
440 #endif /* Q_OS_MAC */
443 path = QFileInfo{path}.absoluteFilePath();
445 if (!path.endsWith(QDir::separator()) && !path.endsWith('/'))
446 path += QDir::separator();
449 if (!qDir.exists(path)) {
450 if (!qDir.mkpath(path)) {
451 qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
456 instance()->_configDirPath = path;
461 void Quassel::setDataDirPaths(const QStringList &paths) {
462 instance()->_dataDirPaths = paths;
466 QStringList Quassel::dataDirPaths()
468 return instance()->_dataDirPaths;
472 QStringList Quassel::findDataDirPaths()
475 // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
476 // want to stay consistent.
478 QStringList dataDirNames;
480 dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
481 << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
482 << QCoreApplication::applicationDirPath();
483 #elif defined Q_OS_MAC
484 dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
485 << QCoreApplication::applicationDirPath();
489 // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share
490 // This should thus come first.
491 QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
492 if (xdgDataHome.isEmpty())
493 xdgDataHome = QDir::homePath() + QLatin1String("/.local/share");
494 dataDirNames << xdgDataHome;
496 // Now whatever is configured through XDG_DATA_DIRS
497 QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
498 if (xdgDataDirs.isEmpty())
499 dataDirNames << "/usr/local/share" << "/usr/share";
501 dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
503 // Just in case, also check our install prefix
504 dataDirNames << QCoreApplication::applicationDirPath() + "/../share";
506 // Normalize and append our application name
507 for (int i = 0; i < dataDirNames.count(); i++)
508 dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/";
512 // Add resource path and workdir just in case.
513 // Workdir should have precedence
514 dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/");
515 dataDirNames.append(":/data/");
517 // Append trailing '/' and check for existence
518 auto iter = dataDirNames.begin();
519 while (iter != dataDirNames.end()) {
520 if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
521 iter->append(QDir::separator());
522 if (!QFile::exists(*iter))
523 iter = dataDirNames.erase(iter);
528 dataDirNames.removeDuplicates();
534 QString Quassel::findDataFilePath(const QString &fileName)
536 QStringList dataDirs = dataDirPaths();
537 foreach(QString dataDir, dataDirs) {
538 QString path = dataDir + fileName;
539 if (QFile::exists(path))
546 QStringList Quassel::scriptDirPaths()
548 QStringList res(configDirPath() + "scripts/");
549 foreach(QString path, dataDirPaths())
550 res << path + "scripts/";
555 QString Quassel::translationDirPath()
557 if (instance()->_translationDirPath.isEmpty()) {
558 // We support only one translation dir; fallback mechanisms wouldn't work else.
559 // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
560 foreach(const QString &dir, dataDirPaths()) {
561 if (QFile::exists(dir + "translations/")) {
562 instance()->_translationDirPath = dir + "translations/";
566 if (instance()->_translationDirPath.isEmpty())
567 instance()->_translationDirPath = ":/i18n/";
569 return instance()->_translationDirPath;
573 void Quassel::loadTranslation(const QLocale &locale)
575 QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
576 QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
579 qApp->removeTranslator(qtTranslator);
580 if (quasselTranslator)
581 qApp->removeTranslator(quasselTranslator);
583 // We use QLocale::C to indicate that we don't want a translation
584 if (locale.language() == QLocale::C)
587 qtTranslator = new QTranslator(qApp);
588 qtTranslator->setObjectName("QtTr");
589 qApp->installTranslator(qtTranslator);
591 quasselTranslator = new QTranslator(qApp);
592 quasselTranslator->setObjectName("QuasselTr");
593 qApp->installTranslator(quasselTranslator);
595 #if QT_VERSION >= 0x040800 && !defined Q_OS_MAC
596 bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
598 qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
599 quasselTranslator->load(locale, QString(""), translationDirPath());
601 bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
603 qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
604 quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
609 // ---- Quassel::Features ---------------------------------------------------------------------------------------------
611 Quassel::Features::Features()
613 QStringList features;
615 // TODO Qt5: Use QMetaEnum::fromType()
616 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
617 _features.resize(featureEnum.keyCount(), true); // enable all known features to true
621 Quassel::Features::Features(const QStringList &features, LegacyFeatures legacyFeatures)
623 // TODO Qt5: Use QMetaEnum::fromType()
624 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
625 _features.resize(featureEnum.keyCount(), false);
627 for (auto &&feature : features) {
628 int i = featureEnum.keyToValue(qPrintable(feature));
633 _unknownFeatures << feature;
637 if (legacyFeatures) {
638 // TODO Qt5: Use QMetaEnum::fromType()
639 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
640 for (quint32 mask = 0x0001; mask <= 0x8000; mask <<=1) {
641 if (static_cast<quint32>(legacyFeatures) & mask) {
642 int i = featureEnum.keyToValue(legacyFeatureEnum.valueToKey(mask));
652 bool Quassel::Features::isEnabled(Feature feature) const
654 size_t i = static_cast<size_t>(feature);
655 return i < _features.size() ? _features[i] : false;
659 QStringList Quassel::Features::toStringList(bool enabled) const
661 // Check if any feature is enabled
662 if (!enabled && std::all_of(_features.cbegin(), _features.cend(), [](bool feature) { return !feature; })) {
663 return QStringList{} << "NoFeatures";
668 // TODO Qt5: Use QMetaEnum::fromType()
669 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
670 for (quint32 i = 0; i < _features.size(); ++i) {
671 if (_features[i] == enabled) {
672 result << featureEnum.key(i);
679 Quassel::LegacyFeatures Quassel::Features::toLegacyFeatures() const
681 // TODO Qt5: Use LegacyFeatures (flag operators for enum classes not supported in Qt4)
683 // TODO Qt5: Use QMetaEnum::fromType()
684 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
685 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
687 for (quint32 i = 0; i < _features.size(); ++i) {
689 int v = legacyFeatureEnum.keyToValue(featureEnum.key(i));
695 return static_cast<LegacyFeatures>(result);
699 QStringList Quassel::Features::unknownFeatures() const
701 return _unknownFeatures;