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 ***************************************************************************/
26 #include <QCoreApplication>
30 #include <QHostAddress>
31 #include <QLibraryInfo>
34 #include <QTranslator>
37 #include "bufferinfo.h"
40 #include "logmessage.h"
45 #include "syncableobject.h"
49 # include "posixsignalwatcher.h"
51 # include "windowssignalwatcher.h"
54 #include "../../version.h"
57 : Singleton<Quassel>{this}
58 , _logger{new Logger{this}}
65 if (instance()->_initialized)
66 return true; // allow multiple invocations because of MonolithicApplication
69 // Setup signal handling
70 // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
71 signal(SIGTERM, handleSignal);
72 signal(SIGINT, handleSignal);
74 // SIGHUP is used to reload configuration (i.e. SSL certificates)
75 // Windows does not support SIGHUP
76 signal(SIGHUP, handleSignal);
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 */
100 instance()->setupSignalHandling();
102 instance()->_initialized = true;
103 qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
105 instance()->setupEnvironment();
106 instance()->registerMetaTypes();
108 Network::setDefaultCodecForServer("UTF-8");
109 Network::setDefaultCodecForEncoding("UTF-8");
110 Network::setDefaultCodecForDecoding("ISO-8859-15");
112 if (isOptionSet("help")) {
113 instance()->_cliParser->usage();
117 if (isOptionSet("version")) {
118 std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
122 // Don't keep a debug log on the core
123 return instance()->logger()->setup(runMode() != RunMode::CoreOnly);
127 Logger *Quassel::logger() const
133 void Quassel::registerQuitHandler(QuitHandler handler)
135 instance()->_quitHandlers.emplace_back(std::move(handler));
140 // Protect against multiple invocations (e.g. triggered by MainWin::closeEvent())
143 quInfo() << "Quitting...";
144 if (_quitHandlers.empty()) {
145 QCoreApplication::quit();
148 // Note: We expect one of the registered handlers to call QCoreApplication::quit()
149 for (auto &&handler : _quitHandlers) {
157 void Quassel::registerReloadHandler(ReloadHandler handler)
159 instance()->_reloadHandlers.emplace_back(std::move(handler));
163 bool Quassel::reloadConfig()
166 for (auto &&handler : _reloadHandlers) {
167 result = result && handler();
173 //! Register our custom types with Qt's Meta Object System.
174 /** This makes them available for QVariant and in signals/slots, among other things.
177 void Quassel::registerMetaTypes()
180 qRegisterMetaType<Message>("Message");
181 qRegisterMetaType<BufferInfo>("BufferInfo");
182 qRegisterMetaType<NetworkInfo>("NetworkInfo");
183 qRegisterMetaType<Network::Server>("Network::Server");
184 qRegisterMetaType<Identity>("Identity");
186 qRegisterMetaTypeStreamOperators<Message>("Message");
187 qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
188 qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
189 qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
190 qRegisterMetaTypeStreamOperators<Identity>("Identity");
192 qRegisterMetaType<IdentityId>("IdentityId");
193 qRegisterMetaType<BufferId>("BufferId");
194 qRegisterMetaType<NetworkId>("NetworkId");
195 qRegisterMetaType<UserId>("UserId");
196 qRegisterMetaType<AccountId>("AccountId");
197 qRegisterMetaType<MsgId>("MsgId");
199 qRegisterMetaType<QHostAddress>("QHostAddress");
200 qRegisterMetaTypeStreamOperators<QHostAddress>("QHostAddress");
201 qRegisterMetaType<QUuid>("QUuid");
202 qRegisterMetaTypeStreamOperators<QUuid>("QUuid");
204 qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
205 qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
206 qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
207 qRegisterMetaTypeStreamOperators<UserId>("UserId");
208 qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
209 qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
211 qRegisterMetaType<Protocol::SessionState>("Protocol::SessionState");
212 qRegisterMetaType<PeerPtr>("PeerPtr");
213 qRegisterMetaTypeStreamOperators<PeerPtr>("PeerPtr");
215 // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
216 if (!QMetaType::type("QVariant")) {
217 qRegisterMetaType<QVariant>("QVariant");
218 qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
223 void Quassel::setupEnvironment()
225 // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
226 // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard
227 // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to
228 // hack extra search paths into various places.
230 QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
231 if (xdgDataVar.isEmpty())
232 xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
234 QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
236 // Add our install prefix (if we're not in a bindir, this just adds the current workdir)
237 QString appDir = QCoreApplication::applicationDirPath();
238 int binpos = appDir.lastIndexOf("/bin");
240 appDir.replace(binpos, 4, "/share");
241 xdgDirs.append(appDir);
242 // Also append apps/quassel, this is only for QIconLoader to find icons there
243 xdgDirs.append(appDir + "/apps/quassel");
245 xdgDirs.append(appDir); // build directory is always the last fallback
247 xdgDirs.removeDuplicates();
249 qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":")));
254 void Quassel::setupBuildInfo()
257 buildInfo.applicationName = "quassel";
258 buildInfo.coreApplicationName = "quasselcore";
259 buildInfo.clientApplicationName = "quasselclient";
260 buildInfo.organizationName = "Quassel Project";
261 buildInfo.organizationDomain = "quassel-irc.org";
263 buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
265 buildInfo.baseVersion = QUASSEL_VERSION_STRING;
266 buildInfo.generatedVersion = GIT_DESCRIBE;
268 // Check if we got a commit hash
269 if (!QString(GIT_HEAD).isEmpty()) {
270 buildInfo.commitHash = GIT_HEAD;
271 // Set to Unix epoch, wrapped as a string for backwards-compatibility
272 buildInfo.commitDate = QString::number(GIT_COMMIT_DATE);
274 else if (!QString(DIST_HASH).contains("Format")) {
275 buildInfo.commitHash = DIST_HASH;
276 // Leave as Unix epoch if set as Unix epoch, but don't force this for
277 // backwards-compatibility with existing packaging/release tools that might set strings.
278 buildInfo.commitDate = QString(DIST_DATE);
281 // create a nice version string
282 if (buildInfo.generatedVersion.isEmpty()) {
283 if (!buildInfo.commitHash.isEmpty()) {
285 buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}
286 .arg(buildInfo.baseVersion)
287 .arg(buildInfo.commitHash.left(7));
288 buildInfo.fancyVersionString = QString{"v%1 (dist-<a href=\"https://github.com/quassel/quassel/commit/%3\">%2</a>)"}
289 .arg(buildInfo.baseVersion)
290 .arg(buildInfo.commitHash.left(7))
291 .arg(buildInfo.commitHash);
294 // we only have a base version :(
295 buildInfo.plainVersionString = QString{"v%1 (unknown revision)"}.arg(buildInfo.baseVersion);
299 // analyze what we got from git-describe
300 static const QRegExp rx{"(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$"};
301 if (rx.exactMatch(buildInfo.generatedVersion)) {
302 QString distance = rx.cap(2) == "0" ? QString{} : QString{"%1+%2 "}.arg(rx.cap(1), rx.cap(2));
303 buildInfo.plainVersionString = QString{"v%1 (%2git-%3%4)"}.arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4));
304 if (!buildInfo.commitHash.isEmpty()) {
305 buildInfo.fancyVersionString = QString{"v%1 (%2git-<a href=\"https://github.com/quassel/quassel/commit/%5\">%3</a>%4)"}
306 .arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), buildInfo.commitHash);
310 buildInfo.plainVersionString = QString{"v%1 (invalid revision)"}.arg(buildInfo.baseVersion);
313 if (buildInfo.fancyVersionString.isEmpty()) {
314 buildInfo.fancyVersionString = buildInfo.plainVersionString;
317 instance()->_buildInfo = std::move(buildInfo);
321 const Quassel::BuildInfo &Quassel::buildInfo()
323 return instance()->_buildInfo;
327 void Quassel::setupSignalHandling()
330 _signalWatcher = new PosixSignalWatcher(this);
332 _signalWatcher = new WindowsSignalWatcher(this);
334 connect(_signalWatcher, SIGNAL(handleSignal(AbstractSignalWatcher::Action)), this, SLOT(handleSignal(AbstractSignalWatcher::Action)));
337 void Quassel::handleSignal(AbstractSignalWatcher::Action action)
340 case AbstractSignalWatcher::Action::Reload:
341 // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for graceful reloading of processes.
342 if (!_reloadHandlers.empty()) {
343 quInfo() << "Reloading configuration";
344 if (reloadConfig()) {
345 quInfo() << "Successfully reloaded configuration";
349 case AbstractSignalWatcher::Action::Terminate:
354 quInfo() << "Already shutting down, ignoring signal";
357 case AbstractSignalWatcher::Action::HandleCrash:
358 logBacktrace(instance()->coreDumpFileName());
364 Quassel::RunMode Quassel::runMode() {
365 return instance()->_runMode;
369 void Quassel::setRunMode(RunMode runMode)
371 instance()->_runMode = runMode;
375 void Quassel::setCliParser(std::shared_ptr<AbstractCliParser> parser)
377 instance()->_cliParser = std::move(parser);
381 QString Quassel::optionValue(const QString &key)
383 return instance()->_cliParser ? instance()->_cliParser->value(key) : QString{};
387 bool Quassel::isOptionSet(const QString &key)
389 return instance()->_cliParser ? instance()->_cliParser->isSet(key) : false;
393 const QString &Quassel::coreDumpFileName()
395 if (_coreDumpFileName.isEmpty()) {
396 QDir configDir(configDirPath());
397 _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
398 QFile dumpFile(_coreDumpFileName);
399 dumpFile.open(QIODevice::Append);
400 QTextStream dumpStream(&dumpFile);
401 dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
402 qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
406 return _coreDumpFileName;
410 QString Quassel::configDirPath()
412 if (!instance()->_configDirPath.isEmpty())
413 return instance()->_configDirPath;
416 if (isOptionSet("datadir")) {
417 qWarning() << "Obsolete option --datadir used!";
418 path = Quassel::optionValue("datadir");
420 else if (isOptionSet("configdir")) {
421 path = Quassel::optionValue("configdir");
425 // On Mac, the path is always the same
426 path = QDir::homePath() + "/Library/Application Support/Quassel/";
428 // We abuse QSettings to find us a sensible path on the other platforms
430 // don't use the registry
431 QSettings::Format format = QSettings::IniFormat;
433 QSettings::Format format = QSettings::NativeFormat;
435 QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
436 QFileInfo fileInfo(s.fileName());
437 path = fileInfo.dir().absolutePath();
438 #endif /* Q_OS_MAC */
441 path = QFileInfo{path}.absoluteFilePath();
443 if (!path.endsWith(QDir::separator()) && !path.endsWith('/'))
444 path += QDir::separator();
447 if (!qDir.exists(path)) {
448 if (!qDir.mkpath(path)) {
449 qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
454 instance()->_configDirPath = path;
459 void Quassel::setDataDirPaths(const QStringList &paths) {
460 instance()->_dataDirPaths = paths;
464 QStringList Quassel::dataDirPaths()
466 return instance()->_dataDirPaths;
470 QStringList Quassel::findDataDirPaths()
473 // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
474 // want to stay consistent.
476 QStringList dataDirNames;
478 dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
479 << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
480 << QCoreApplication::applicationDirPath();
481 #elif defined Q_OS_MAC
482 dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
483 << QCoreApplication::applicationDirPath();
487 // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share
488 // This should thus come first.
489 QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
490 if (xdgDataHome.isEmpty())
491 xdgDataHome = QDir::homePath() + QLatin1String("/.local/share");
492 dataDirNames << xdgDataHome;
494 // Now whatever is configured through XDG_DATA_DIRS
495 QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
496 if (xdgDataDirs.isEmpty())
497 dataDirNames << "/usr/local/share" << "/usr/share";
499 dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
501 // Just in case, also check our install prefix
502 dataDirNames << QCoreApplication::applicationDirPath() + "/../share";
504 // Normalize and append our application name
505 for (int i = 0; i < dataDirNames.count(); i++)
506 dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/";
510 // Add resource path and workdir just in case.
511 // Workdir should have precedence
512 dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/");
513 dataDirNames.append(":/data/");
515 // Append trailing '/' and check for existence
516 auto iter = dataDirNames.begin();
517 while (iter != dataDirNames.end()) {
518 if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
519 iter->append(QDir::separator());
520 if (!QFile::exists(*iter))
521 iter = dataDirNames.erase(iter);
526 dataDirNames.removeDuplicates();
532 QString Quassel::findDataFilePath(const QString &fileName)
534 QStringList dataDirs = dataDirPaths();
535 foreach(QString dataDir, dataDirs) {
536 QString path = dataDir + fileName;
537 if (QFile::exists(path))
544 QStringList Quassel::scriptDirPaths()
546 QStringList res(configDirPath() + "scripts/");
547 foreach(QString path, dataDirPaths())
548 res << path + "scripts/";
553 QString Quassel::translationDirPath()
555 if (instance()->_translationDirPath.isEmpty()) {
556 // We support only one translation dir; fallback mechanisms wouldn't work else.
557 // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
558 foreach(const QString &dir, dataDirPaths()) {
559 if (QFile::exists(dir + "translations/")) {
560 instance()->_translationDirPath = dir + "translations/";
564 if (instance()->_translationDirPath.isEmpty())
565 instance()->_translationDirPath = ":/i18n/";
567 return instance()->_translationDirPath;
571 void Quassel::loadTranslation(const QLocale &locale)
573 QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
574 QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
577 qApp->removeTranslator(qtTranslator);
578 if (quasselTranslator)
579 qApp->removeTranslator(quasselTranslator);
581 // We use QLocale::C to indicate that we don't want a translation
582 if (locale.language() == QLocale::C)
585 qtTranslator = new QTranslator(qApp);
586 qtTranslator->setObjectName("QtTr");
587 qApp->installTranslator(qtTranslator);
589 quasselTranslator = new QTranslator(qApp);
590 quasselTranslator->setObjectName("QuasselTr");
591 qApp->installTranslator(quasselTranslator);
593 #if QT_VERSION >= 0x040800 && !defined Q_OS_MAC
594 bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
596 qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
597 quasselTranslator->load(locale, QString(""), translationDirPath());
599 bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
601 qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
602 quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
607 // ---- Quassel::Features ---------------------------------------------------------------------------------------------
609 Quassel::Features::Features()
611 QStringList features;
613 // TODO Qt5: Use QMetaEnum::fromType()
614 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
615 _features.resize(featureEnum.keyCount(), true); // enable all known features to true
619 Quassel::Features::Features(const QStringList &features, LegacyFeatures legacyFeatures)
621 // TODO Qt5: Use QMetaEnum::fromType()
622 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
623 _features.resize(featureEnum.keyCount(), false);
625 for (auto &&feature : features) {
626 int i = featureEnum.keyToValue(qPrintable(feature));
631 _unknownFeatures << feature;
635 if (legacyFeatures) {
636 // TODO Qt5: Use QMetaEnum::fromType()
637 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
638 for (quint32 mask = 0x0001; mask <= 0x8000; mask <<=1) {
639 if (static_cast<quint32>(legacyFeatures) & mask) {
640 int i = featureEnum.keyToValue(legacyFeatureEnum.valueToKey(mask));
650 bool Quassel::Features::isEnabled(Feature feature) const
652 size_t i = static_cast<size_t>(feature);
653 return i < _features.size() ? _features[i] : false;
657 QStringList Quassel::Features::toStringList(bool enabled) const
659 // Check if any feature is enabled
660 if (!enabled && std::all_of(_features.cbegin(), _features.cend(), [](bool feature) { return !feature; })) {
661 return QStringList{} << "NoFeatures";
666 // TODO Qt5: Use QMetaEnum::fromType()
667 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
668 for (quint32 i = 0; i < _features.size(); ++i) {
669 if (_features[i] == enabled) {
670 result << featureEnum.key(i);
677 Quassel::LegacyFeatures Quassel::Features::toLegacyFeatures() const
679 // TODO Qt5: Use LegacyFeatures (flag operators for enum classes not supported in Qt4)
681 // TODO Qt5: Use QMetaEnum::fromType()
682 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
683 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
685 for (quint32 i = 0; i < _features.size(); ++i) {
687 int v = legacyFeatureEnum.keyToValue(featureEnum.key(i));
693 return static_cast<LegacyFeatures>(result);
697 QStringList Quassel::Features::unknownFeatures() const
699 return _unknownFeatures;