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}}
63 void Quassel::init(RunMode runMode)
67 qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
69 setupSignalHandling();
73 Network::setDefaultCodecForServer("UTF-8");
74 Network::setDefaultCodecForEncoding("UTF-8");
75 Network::setDefaultCodecForDecoding("ISO-8859-15");
77 if (isOptionSet("help")) {
78 instance()->_cliParser->usage();
82 if (isOptionSet("version")) {
83 std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
87 // Don't keep a debug log on the core
88 logger()->setup(runMode != RunMode::CoreOnly);
92 Logger *Quassel::logger() const
98 void Quassel::registerQuitHandler(QuitHandler handler)
100 instance()->_quitHandlers.emplace_back(std::move(handler));
105 // Protect against multiple invocations (e.g. triggered by MainWin::closeEvent())
108 quInfo() << "Quitting...";
109 if (_quitHandlers.empty()) {
110 QCoreApplication::quit();
113 // Note: We expect one of the registered handlers to call QCoreApplication::quit()
114 for (auto &&handler : _quitHandlers) {
122 void Quassel::registerReloadHandler(ReloadHandler handler)
124 instance()->_reloadHandlers.emplace_back(std::move(handler));
128 bool Quassel::reloadConfig()
131 for (auto &&handler : _reloadHandlers) {
132 result = result && handler();
138 //! Register our custom types with Qt's Meta Object System.
139 /** This makes them available for QVariant and in signals/slots, among other things.
142 void Quassel::registerMetaTypes()
145 qRegisterMetaType<Message>("Message");
146 qRegisterMetaType<BufferInfo>("BufferInfo");
147 qRegisterMetaType<NetworkInfo>("NetworkInfo");
148 qRegisterMetaType<Network::Server>("Network::Server");
149 qRegisterMetaType<Identity>("Identity");
151 qRegisterMetaTypeStreamOperators<Message>("Message");
152 qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
153 qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
154 qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
155 qRegisterMetaTypeStreamOperators<Identity>("Identity");
157 qRegisterMetaType<IdentityId>("IdentityId");
158 qRegisterMetaType<BufferId>("BufferId");
159 qRegisterMetaType<NetworkId>("NetworkId");
160 qRegisterMetaType<UserId>("UserId");
161 qRegisterMetaType<AccountId>("AccountId");
162 qRegisterMetaType<MsgId>("MsgId");
164 qRegisterMetaType<QHostAddress>("QHostAddress");
165 qRegisterMetaTypeStreamOperators<QHostAddress>("QHostAddress");
166 qRegisterMetaType<QUuid>("QUuid");
167 qRegisterMetaTypeStreamOperators<QUuid>("QUuid");
169 qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
170 qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
171 qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
172 qRegisterMetaTypeStreamOperators<UserId>("UserId");
173 qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
174 qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
176 qRegisterMetaType<Protocol::SessionState>("Protocol::SessionState");
177 qRegisterMetaType<PeerPtr>("PeerPtr");
178 qRegisterMetaTypeStreamOperators<PeerPtr>("PeerPtr");
180 // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
181 if (!QMetaType::type("QVariant")) {
182 qRegisterMetaType<QVariant>("QVariant");
183 qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
188 void Quassel::setupEnvironment()
190 // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
191 // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard
192 // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to
193 // hack extra search paths into various places.
195 QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
196 if (xdgDataVar.isEmpty())
197 xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
199 QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
201 // Add our install prefix (if we're not in a bindir, this just adds the current workdir)
202 QString appDir = QCoreApplication::applicationDirPath();
203 int binpos = appDir.lastIndexOf("/bin");
205 appDir.replace(binpos, 4, "/share");
206 xdgDirs.append(appDir);
207 // Also append apps/quassel, this is only for QIconLoader to find icons there
208 xdgDirs.append(appDir + "/apps/quassel");
210 xdgDirs.append(appDir); // build directory is always the last fallback
212 xdgDirs.removeDuplicates();
214 qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":")));
219 void Quassel::setupBuildInfo()
222 buildInfo.applicationName = "quassel";
223 buildInfo.coreApplicationName = "quasselcore";
224 buildInfo.clientApplicationName = "quasselclient";
225 buildInfo.organizationName = "Quassel Project";
226 buildInfo.organizationDomain = "quassel-irc.org";
228 buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
230 buildInfo.baseVersion = QUASSEL_VERSION_STRING;
231 buildInfo.generatedVersion = GIT_DESCRIBE;
233 // Check if we got a commit hash
234 if (!QString(GIT_HEAD).isEmpty()) {
235 buildInfo.commitHash = GIT_HEAD;
236 // Set to Unix epoch, wrapped as a string for backwards-compatibility
237 buildInfo.commitDate = QString::number(GIT_COMMIT_DATE);
239 else if (!QString(DIST_HASH).contains("Format")) {
240 buildInfo.commitHash = DIST_HASH;
241 // Leave as Unix epoch if set as Unix epoch, but don't force this for
242 // backwards-compatibility with existing packaging/release tools that might set strings.
243 buildInfo.commitDate = QString(DIST_DATE);
246 // create a nice version string
247 if (buildInfo.generatedVersion.isEmpty()) {
248 if (!buildInfo.commitHash.isEmpty()) {
250 buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}
251 .arg(buildInfo.baseVersion)
252 .arg(buildInfo.commitHash.left(7));
253 buildInfo.fancyVersionString = QString{"v%1 (dist-<a href=\"https://github.com/quassel/quassel/commit/%3\">%2</a>)"}
254 .arg(buildInfo.baseVersion)
255 .arg(buildInfo.commitHash.left(7))
256 .arg(buildInfo.commitHash);
259 // we only have a base version :(
260 buildInfo.plainVersionString = QString{"v%1 (unknown revision)"}.arg(buildInfo.baseVersion);
264 // analyze what we got from git-describe
265 static const QRegExp rx{"(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$"};
266 if (rx.exactMatch(buildInfo.generatedVersion)) {
267 QString distance = rx.cap(2) == "0" ? QString{} : QString{"%1+%2 "}.arg(rx.cap(1), rx.cap(2));
268 buildInfo.plainVersionString = QString{"v%1 (%2git-%3%4)"}.arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4));
269 if (!buildInfo.commitHash.isEmpty()) {
270 buildInfo.fancyVersionString = QString{"v%1 (%2git-<a href=\"https://github.com/quassel/quassel/commit/%5\">%3</a>%4)"}
271 .arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), buildInfo.commitHash);
275 buildInfo.plainVersionString = QString{"v%1 (invalid revision)"}.arg(buildInfo.baseVersion);
278 if (buildInfo.fancyVersionString.isEmpty()) {
279 buildInfo.fancyVersionString = buildInfo.plainVersionString;
282 instance()->_buildInfo = std::move(buildInfo);
286 const Quassel::BuildInfo &Quassel::buildInfo()
288 return instance()->_buildInfo;
292 void Quassel::setupSignalHandling()
295 _signalWatcher = new PosixSignalWatcher(this);
297 _signalWatcher = new WindowsSignalWatcher(this);
299 connect(_signalWatcher, SIGNAL(handleSignal(AbstractSignalWatcher::Action)), this, SLOT(handleSignal(AbstractSignalWatcher::Action)));
303 void Quassel::handleSignal(AbstractSignalWatcher::Action action)
306 case AbstractSignalWatcher::Action::Reload:
307 // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for graceful reloading of processes.
308 if (!_reloadHandlers.empty()) {
309 quInfo() << "Reloading configuration";
310 if (reloadConfig()) {
311 quInfo() << "Successfully reloaded configuration";
315 case AbstractSignalWatcher::Action::Terminate:
320 quInfo() << "Already shutting down, ignoring signal";
323 case AbstractSignalWatcher::Action::HandleCrash:
324 logBacktrace(instance()->coreDumpFileName());
330 Quassel::RunMode Quassel::runMode() {
331 return instance()->_runMode;
335 void Quassel::setCliParser(std::shared_ptr<AbstractCliParser> parser)
337 instance()->_cliParser = std::move(parser);
341 QString Quassel::optionValue(const QString &key)
343 return instance()->_cliParser ? instance()->_cliParser->value(key) : QString{};
347 bool Quassel::isOptionSet(const QString &key)
349 return instance()->_cliParser ? instance()->_cliParser->isSet(key) : false;
353 const QString &Quassel::coreDumpFileName()
355 if (_coreDumpFileName.isEmpty()) {
356 QDir configDir(configDirPath());
357 _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
358 QFile dumpFile(_coreDumpFileName);
359 dumpFile.open(QIODevice::Append);
360 QTextStream dumpStream(&dumpFile);
361 dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
362 qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
366 return _coreDumpFileName;
370 QString Quassel::configDirPath()
372 if (!instance()->_configDirPath.isEmpty())
373 return instance()->_configDirPath;
376 if (isOptionSet("datadir")) {
377 qWarning() << "Obsolete option --datadir used!";
378 path = Quassel::optionValue("datadir");
380 else if (isOptionSet("configdir")) {
381 path = Quassel::optionValue("configdir");
385 // On Mac, the path is always the same
386 path = QDir::homePath() + "/Library/Application Support/Quassel/";
388 // We abuse QSettings to find us a sensible path on the other platforms
390 // don't use the registry
391 QSettings::Format format = QSettings::IniFormat;
393 QSettings::Format format = QSettings::NativeFormat;
395 QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
396 QFileInfo fileInfo(s.fileName());
397 path = fileInfo.dir().absolutePath();
398 #endif /* Q_OS_MAC */
401 path = QFileInfo{path}.absoluteFilePath();
403 if (!path.endsWith(QDir::separator()) && !path.endsWith('/'))
404 path += QDir::separator();
407 if (!qDir.exists(path)) {
408 if (!qDir.mkpath(path)) {
409 qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
414 instance()->_configDirPath = path;
419 void Quassel::setDataDirPaths(const QStringList &paths) {
420 instance()->_dataDirPaths = paths;
424 QStringList Quassel::dataDirPaths()
426 return instance()->_dataDirPaths;
430 QStringList Quassel::findDataDirPaths()
433 // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
434 // want to stay consistent.
436 QStringList dataDirNames;
438 dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
439 << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
440 << QCoreApplication::applicationDirPath();
441 #elif defined Q_OS_MAC
442 dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
443 << QCoreApplication::applicationDirPath();
447 // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share
448 // This should thus come first.
449 QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
450 if (xdgDataHome.isEmpty())
451 xdgDataHome = QDir::homePath() + QLatin1String("/.local/share");
452 dataDirNames << xdgDataHome;
454 // Now whatever is configured through XDG_DATA_DIRS
455 QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
456 if (xdgDataDirs.isEmpty())
457 dataDirNames << "/usr/local/share" << "/usr/share";
459 dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
461 // Just in case, also check our install prefix
462 dataDirNames << QCoreApplication::applicationDirPath() + "/../share";
464 // Normalize and append our application name
465 for (int i = 0; i < dataDirNames.count(); i++)
466 dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/";
470 // Add resource path and workdir just in case.
471 // Workdir should have precedence
472 dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/");
473 dataDirNames.append(":/data/");
475 // Append trailing '/' and check for existence
476 auto iter = dataDirNames.begin();
477 while (iter != dataDirNames.end()) {
478 if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
479 iter->append(QDir::separator());
480 if (!QFile::exists(*iter))
481 iter = dataDirNames.erase(iter);
486 dataDirNames.removeDuplicates();
492 QString Quassel::findDataFilePath(const QString &fileName)
494 QStringList dataDirs = dataDirPaths();
495 foreach(QString dataDir, dataDirs) {
496 QString path = dataDir + fileName;
497 if (QFile::exists(path))
504 QStringList Quassel::scriptDirPaths()
506 QStringList res(configDirPath() + "scripts/");
507 foreach(QString path, dataDirPaths())
508 res << path + "scripts/";
513 QString Quassel::translationDirPath()
515 if (instance()->_translationDirPath.isEmpty()) {
516 // We support only one translation dir; fallback mechanisms wouldn't work else.
517 // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
518 foreach(const QString &dir, dataDirPaths()) {
519 if (QFile::exists(dir + "translations/")) {
520 instance()->_translationDirPath = dir + "translations/";
524 if (instance()->_translationDirPath.isEmpty())
525 instance()->_translationDirPath = ":/i18n/";
527 return instance()->_translationDirPath;
531 void Quassel::loadTranslation(const QLocale &locale)
533 QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
534 QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
537 qApp->removeTranslator(qtTranslator);
538 if (quasselTranslator)
539 qApp->removeTranslator(quasselTranslator);
541 // We use QLocale::C to indicate that we don't want a translation
542 if (locale.language() == QLocale::C)
545 qtTranslator = new QTranslator(qApp);
546 qtTranslator->setObjectName("QtTr");
547 qApp->installTranslator(qtTranslator);
549 quasselTranslator = new QTranslator(qApp);
550 quasselTranslator->setObjectName("QuasselTr");
551 qApp->installTranslator(quasselTranslator);
554 bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
556 qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
557 quasselTranslator->load(locale, QString(""), translationDirPath());
559 bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
561 qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
562 quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
567 // ---- Quassel::Features ---------------------------------------------------------------------------------------------
569 Quassel::Features::Features()
571 QStringList features;
573 // TODO Qt5: Use QMetaEnum::fromType()
574 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
575 _features.resize(featureEnum.keyCount(), true); // enable all known features to true
579 Quassel::Features::Features(const QStringList &features, LegacyFeatures legacyFeatures)
581 // TODO Qt5: Use QMetaEnum::fromType()
582 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
583 _features.resize(featureEnum.keyCount(), false);
585 for (auto &&feature : features) {
586 int i = featureEnum.keyToValue(qPrintable(feature));
591 _unknownFeatures << feature;
595 if (legacyFeatures) {
596 // TODO Qt5: Use QMetaEnum::fromType()
597 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
598 for (quint32 mask = 0x0001; mask <= 0x8000; mask <<=1) {
599 if (static_cast<quint32>(legacyFeatures) & mask) {
600 int i = featureEnum.keyToValue(legacyFeatureEnum.valueToKey(mask));
610 bool Quassel::Features::isEnabled(Feature feature) const
612 size_t i = static_cast<size_t>(feature);
613 return i < _features.size() ? _features[i] : false;
617 QStringList Quassel::Features::toStringList(bool enabled) const
619 // Check if any feature is enabled
620 if (!enabled && std::all_of(_features.cbegin(), _features.cend(), [](bool feature) { return !feature; })) {
621 return QStringList{} << "NoFeatures";
626 // TODO Qt5: Use QMetaEnum::fromType()
627 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
628 for (quint32 i = 0; i < _features.size(); ++i) {
629 if (_features[i] == enabled) {
630 result << featureEnum.key(i);
637 Quassel::LegacyFeatures Quassel::Features::toLegacyFeatures() const
639 // TODO Qt5: Use LegacyFeatures (flag operators for enum classes not supported in Qt4)
641 // TODO Qt5: Use QMetaEnum::fromType()
642 auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature"));
643 auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature"));
645 for (quint32 i = 0; i < _features.size(); ++i) {
647 int v = legacyFeatureEnum.keyToValue(featureEnum.key(i));
653 return static_cast<LegacyFeatures>(result);
657 QStringList Quassel::Features::unknownFeatures() const
659 return _unknownFeatures;