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
68 qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
70 instance()->setupSignalHandling();
71 instance()->setupEnvironment();
72 instance()->registerMetaTypes();
74 instance()->_initialized = true;
76 Network::setDefaultCodecForServer("UTF-8");
77 Network::setDefaultCodecForEncoding("UTF-8");
78 Network::setDefaultCodecForDecoding("ISO-8859-15");
80 if (isOptionSet("help")) {
81 instance()->_cliParser->usage();
85 if (isOptionSet("version")) {
86 std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
90 // Don't keep a debug log on the core
91 return instance()->logger()->setup(runMode() != RunMode::CoreOnly);
95 Logger *Quassel::logger() const
101 void Quassel::registerQuitHandler(QuitHandler handler)
103 instance()->_quitHandlers.emplace_back(std::move(handler));
108 // Protect against multiple invocations (e.g. triggered by MainWin::closeEvent())
111 quInfo() << "Quitting...";
112 if (_quitHandlers.empty()) {
113 QCoreApplication::quit();
116 // Note: We expect one of the registered handlers to call QCoreApplication::quit()
117 for (auto &&handler : _quitHandlers) {
125 void Quassel::registerReloadHandler(ReloadHandler handler)
127 instance()->_reloadHandlers.emplace_back(std::move(handler));
131 bool Quassel::reloadConfig()
134 for (auto &&handler : _reloadHandlers) {
135 result = result && handler();
141 //! Register our custom types with Qt's Meta Object System.
142 /** This makes them available for QVariant and in signals/slots, among other things.
145 void Quassel::registerMetaTypes()
148 qRegisterMetaType<Message>("Message");
149 qRegisterMetaType<BufferInfo>("BufferInfo");
150 qRegisterMetaType<NetworkInfo>("NetworkInfo");
151 qRegisterMetaType<Network::Server>("Network::Server");
152 qRegisterMetaType<Identity>("Identity");
154 qRegisterMetaTypeStreamOperators<Message>("Message");
155 qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
156 qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
157 qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
158 qRegisterMetaTypeStreamOperators<Identity>("Identity");
160 qRegisterMetaType<IdentityId>("IdentityId");
161 qRegisterMetaType<BufferId>("BufferId");
162 qRegisterMetaType<NetworkId>("NetworkId");
163 qRegisterMetaType<UserId>("UserId");
164 qRegisterMetaType<AccountId>("AccountId");
165 qRegisterMetaType<MsgId>("MsgId");
167 qRegisterMetaType<QHostAddress>("QHostAddress");
168 qRegisterMetaTypeStreamOperators<QHostAddress>("QHostAddress");
169 qRegisterMetaType<QUuid>("QUuid");
170 qRegisterMetaTypeStreamOperators<QUuid>("QUuid");
172 qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
173 qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
174 qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
175 qRegisterMetaTypeStreamOperators<UserId>("UserId");
176 qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
177 qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
179 qRegisterMetaType<Protocol::SessionState>("Protocol::SessionState");
180 qRegisterMetaType<PeerPtr>("PeerPtr");
181 qRegisterMetaTypeStreamOperators<PeerPtr>("PeerPtr");
183 // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
184 if (!QMetaType::type("QVariant")) {
185 qRegisterMetaType<QVariant>("QVariant");
186 qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
191 void Quassel::setupEnvironment()
193 // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
194 // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard
195 // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to
196 // hack extra search paths into various places.
198 QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
199 if (xdgDataVar.isEmpty())
200 xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
202 QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
204 // Add our install prefix (if we're not in a bindir, this just adds the current workdir)
205 QString appDir = QCoreApplication::applicationDirPath();
206 int binpos = appDir.lastIndexOf("/bin");
208 appDir.replace(binpos, 4, "/share");
209 xdgDirs.append(appDir);
210 // Also append apps/quassel, this is only for QIconLoader to find icons there
211 xdgDirs.append(appDir + "/apps/quassel");
213 xdgDirs.append(appDir); // build directory is always the last fallback
215 xdgDirs.removeDuplicates();
217 qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":")));
222 void Quassel::setupBuildInfo()
225 buildInfo.applicationName = "quassel";
226 buildInfo.coreApplicationName = "quasselcore";
227 buildInfo.clientApplicationName = "quasselclient";
228 buildInfo.organizationName = "Quassel Project";
229 buildInfo.organizationDomain = "quassel-irc.org";
231 buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
233 buildInfo.baseVersion = QUASSEL_VERSION_STRING;
234 buildInfo.generatedVersion = GIT_DESCRIBE;
236 // Check if we got a commit hash
237 if (!QString(GIT_HEAD).isEmpty()) {
238 buildInfo.commitHash = GIT_HEAD;
239 // Set to Unix epoch, wrapped as a string for backwards-compatibility
240 buildInfo.commitDate = QString::number(GIT_COMMIT_DATE);
242 else if (!QString(DIST_HASH).contains("Format")) {
243 buildInfo.commitHash = DIST_HASH;
244 // Leave as Unix epoch if set as Unix epoch, but don't force this for
245 // backwards-compatibility with existing packaging/release tools that might set strings.
246 buildInfo.commitDate = QString(DIST_DATE);
249 // create a nice version string
250 if (buildInfo.generatedVersion.isEmpty()) {
251 if (!buildInfo.commitHash.isEmpty()) {
253 buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}
254 .arg(buildInfo.baseVersion)
255 .arg(buildInfo.commitHash.left(7));
256 buildInfo.fancyVersionString = QString{"v%1 (dist-<a href=\"https://github.com/quassel/quassel/commit/%3\">%2</a>)"}
257 .arg(buildInfo.baseVersion)
258 .arg(buildInfo.commitHash.left(7))
259 .arg(buildInfo.commitHash);
262 // we only have a base version :(
263 buildInfo.plainVersionString = QString{"v%1 (unknown revision)"}.arg(buildInfo.baseVersion);
267 // analyze what we got from git-describe
268 static const QRegExp rx{"(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$"};
269 if (rx.exactMatch(buildInfo.generatedVersion)) {
270 QString distance = rx.cap(2) == "0" ? QString{} : QString{"%1+%2 "}.arg(rx.cap(1), rx.cap(2));
271 buildInfo.plainVersionString = QString{"v%1 (%2git-%3%4)"}.arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4));
272 if (!buildInfo.commitHash.isEmpty()) {
273 buildInfo.fancyVersionString = QString{"v%1 (%2git-<a href=\"https://github.com/quassel/quassel/commit/%5\">%3</a>%4)"}
274 .arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), buildInfo.commitHash);
278 buildInfo.plainVersionString = QString{"v%1 (invalid revision)"}.arg(buildInfo.baseVersion);
281 if (buildInfo.fancyVersionString.isEmpty()) {
282 buildInfo.fancyVersionString = buildInfo.plainVersionString;
285 instance()->_buildInfo = std::move(buildInfo);
289 const Quassel::BuildInfo &Quassel::buildInfo()
291 return instance()->_buildInfo;
295 void Quassel::setupSignalHandling()
298 _signalWatcher = new PosixSignalWatcher(this);
300 _signalWatcher = new WindowsSignalWatcher(this);
302 connect(_signalWatcher, SIGNAL(handleSignal(AbstractSignalWatcher::Action)), this, SLOT(handleSignal(AbstractSignalWatcher::Action)));
306 void Quassel::handleSignal(AbstractSignalWatcher::Action action)
309 case AbstractSignalWatcher::Action::Reload:
310 // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for graceful reloading of processes.
311 if (!_reloadHandlers.empty()) {
312 quInfo() << "Reloading configuration";
313 if (reloadConfig()) {
314 quInfo() << "Successfully reloaded configuration";
318 case AbstractSignalWatcher::Action::Terminate:
323 quInfo() << "Already shutting down, ignoring signal";
326 case AbstractSignalWatcher::Action::HandleCrash:
327 logBacktrace(instance()->coreDumpFileName());
333 Quassel::RunMode Quassel::runMode() {
334 return instance()->_runMode;
338 void Quassel::setRunMode(RunMode runMode)
340 instance()->_runMode = runMode;
344 void Quassel::setCliParser(std::shared_ptr<AbstractCliParser> parser)
346 instance()->_cliParser = std::move(parser);
350 QString Quassel::optionValue(const QString &key)
352 return instance()->_cliParser ? instance()->_cliParser->value(key) : QString{};
356 bool Quassel::isOptionSet(const QString &key)
358 return instance()->_cliParser ? instance()->_cliParser->isSet(key) : false;
362 const QString &Quassel::coreDumpFileName()
364 if (_coreDumpFileName.isEmpty()) {
365 QDir configDir(configDirPath());
366 _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
367 QFile dumpFile(_coreDumpFileName);
368 dumpFile.open(QIODevice::Append);
369 QTextStream dumpStream(&dumpFile);
370 dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
371 qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
375 return _coreDumpFileName;
379 QString Quassel::configDirPath()
381 if (!instance()->_configDirPath.isEmpty())
382 return instance()->_configDirPath;
385 if (isOptionSet("datadir")) {
386 qWarning() << "Obsolete option --datadir used!";
387 path = Quassel::optionValue("datadir");
389 else if (isOptionSet("configdir")) {
390 path = Quassel::optionValue("configdir");
394 // On Mac, the path is always the same
395 path = QDir::homePath() + "/Library/Application Support/Quassel/";
397 // We abuse QSettings to find us a sensible path on the other platforms
399 // don't use the registry
400 QSettings::Format format = QSettings::IniFormat;
402 QSettings::Format format = QSettings::NativeFormat;
404 QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
405 QFileInfo fileInfo(s.fileName());
406 path = fileInfo.dir().absolutePath();
407 #endif /* Q_OS_MAC */
410 path = QFileInfo{path}.absoluteFilePath();
412 if (!path.endsWith(QDir::separator()) && !path.endsWith('/'))
413 path += QDir::separator();
416 if (!qDir.exists(path)) {
417 if (!qDir.mkpath(path)) {
418 qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
423 instance()->_configDirPath = path;
428 void Quassel::setDataDirPaths(const QStringList &paths) {
429 instance()->_dataDirPaths = paths;
433 QStringList Quassel::dataDirPaths()
435 return instance()->_dataDirPaths;
439 QStringList Quassel::findDataDirPaths()
442 // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
443 // want to stay consistent.
445 QStringList dataDirNames;
447 dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
448 << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
449 << QCoreApplication::applicationDirPath();
450 #elif defined Q_OS_MAC
451 dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
452 << QCoreApplication::applicationDirPath();
456 // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share
457 // This should thus come first.
458 QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
459 if (xdgDataHome.isEmpty())
460 xdgDataHome = QDir::homePath() + QLatin1String("/.local/share");
461 dataDirNames << xdgDataHome;
463 // Now whatever is configured through XDG_DATA_DIRS
464 QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
465 if (xdgDataDirs.isEmpty())
466 dataDirNames << "/usr/local/share" << "/usr/share";
468 dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
470 // Just in case, also check our install prefix
471 dataDirNames << QCoreApplication::applicationDirPath() + "/../share";
473 // Normalize and append our application name
474 for (int i = 0; i < dataDirNames.count(); i++)
475 dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/";
479 // Add resource path and workdir just in case.
480 // Workdir should have precedence
481 dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/");
482 dataDirNames.append(":/data/");
484 // Append trailing '/' and check for existence
485 auto iter = dataDirNames.begin();
486 while (iter != dataDirNames.end()) {
487 if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
488 iter->append(QDir::separator());
489 if (!QFile::exists(*iter))
490 iter = dataDirNames.erase(iter);
495 dataDirNames.removeDuplicates();
501 QString Quassel::findDataFilePath(const QString &fileName)
503 QStringList dataDirs = dataDirPaths();
504 foreach(QString dataDir, dataDirs) {
505 QString path = dataDir + fileName;
506 if (QFile::exists(path))
513 QStringList Quassel::scriptDirPaths()
515 QStringList res(configDirPath() + "scripts/");
516 foreach(QString path, dataDirPaths())
517 res << path + "scripts/";
522 QString Quassel::translationDirPath()
524 if (instance()->_translationDirPath.isEmpty()) {
525 // We support only one translation dir; fallback mechanisms wouldn't work else.
526 // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
527 foreach(const QString &dir, dataDirPaths()) {
528 if (QFile::exists(dir + "translations/")) {
529 instance()->_translationDirPath = dir + "translations/";
533 if (instance()->_translationDirPath.isEmpty())
534 instance()->_translationDirPath = ":/i18n/";
536 return instance()->_translationDirPath;
540 void Quassel::loadTranslation(const QLocale &locale)
542 QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
543 QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
546 qApp->removeTranslator(qtTranslator);
547 if (quasselTranslator)
548 qApp->removeTranslator(quasselTranslator);
550 // We use QLocale::C to indicate that we don't want a translation
551 if (locale.language() == QLocale::C)
554 qtTranslator = new QTranslator(qApp);
555 qtTranslator->setObjectName("QtTr");
556 qApp->installTranslator(qtTranslator);
558 quasselTranslator = new QTranslator(qApp);
559 quasselTranslator->setObjectName("QuasselTr");
560 qApp->installTranslator(quasselTranslator);
562 #if QT_VERSION >= 0x040800 && !defined Q_OS_MAC
563 bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
565 qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
566 quasselTranslator->load(locale, QString(""), translationDirPath());
568 bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
570 qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
571 quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
576 // ---- Quassel::Features ---------------------------------------------------------------------------------------------
578 Quassel::Features::Features()
580 QStringList features;
582 // TODO Qt5: Use QMetaEnum::fromType()
583 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
584 _features.resize(featureEnum.keyCount(), true); // enable all known features to true
588 Quassel::Features::Features(const QStringList &features, LegacyFeatures legacyFeatures)
590 // TODO Qt5: Use QMetaEnum::fromType()
591 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
592 _features.resize(featureEnum.keyCount(), false);
594 for (auto &&feature : features) {
595 int i = featureEnum.keyToValue(qPrintable(feature));
600 _unknownFeatures << feature;
604 if (legacyFeatures) {
605 // TODO Qt5: Use QMetaEnum::fromType()
606 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
607 for (quint32 mask = 0x0001; mask <= 0x8000; mask <<=1) {
608 if (static_cast<quint32>(legacyFeatures) & mask) {
609 int i = featureEnum.keyToValue(legacyFeatureEnum.valueToKey(mask));
619 bool Quassel::Features::isEnabled(Feature feature) const
621 size_t i = static_cast<size_t>(feature);
622 return i < _features.size() ? _features[i] : false;
626 QStringList Quassel::Features::toStringList(bool enabled) const
628 // Check if any feature is enabled
629 if (!enabled && std::all_of(_features.cbegin(), _features.cend(), [](bool feature) { return !feature; })) {
630 return QStringList{} << "NoFeatures";
635 // TODO Qt5: Use QMetaEnum::fromType()
636 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
637 for (quint32 i = 0; i < _features.size(); ++i) {
638 if (_features[i] == enabled) {
639 result << featureEnum.key(i);
646 Quassel::LegacyFeatures Quassel::Features::toLegacyFeatures() const
648 // TODO Qt5: Use LegacyFeatures (flag operators for enum classes not supported in Qt4)
650 // TODO Qt5: Use QMetaEnum::fromType()
651 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
652 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
654 for (quint32 i = 0; i < _features.size(); ++i) {
656 int v = legacyFeatureEnum.keyToValue(featureEnum.key(i));
662 return static_cast<LegacyFeatures>(result);
666 QStringList Quassel::Features::unknownFeatures() const
668 return _unknownFeatures;