1 /***************************************************************************
2 * Copyright (C) 2005-2016 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>
38 #include <QTranslator>
41 #include "bufferinfo.h"
48 #include "syncableobject.h"
51 #include "../../version.h"
53 Quassel *Quassel::instance()
55 static Quassel instance;
62 // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
63 signal(SIGTERM, handleSignal);
64 signal(SIGINT, handleSignal);
66 // SIGHUP is used to reload configuration (i.e. SSL certificates)
67 // Windows does not support SIGHUP
68 signal(SIGHUP, handleSignal);
75 if (instance()->_initialized)
76 return true; // allow multiple invocations because of MonolithicApplication
78 if (instance()->_handleCrashes) {
79 // we have crashhandler for win32 and unix (based on execinfo).
80 #if defined(Q_OS_WIN) || defined(HAVE_EXECINFO)
82 // we only handle crashes ourselves if coredumps are disabled
83 struct rlimit *limit = (rlimit *)malloc(sizeof(struct rlimit));
84 int rc = getrlimit(RLIMIT_CORE, limit);
86 if (rc == -1 || !((long)limit->rlim_cur > 0 || limit->rlim_cur == RLIM_INFINITY)) {
87 # endif /* Q_OS_WIN */
88 signal(SIGABRT, handleSignal);
89 signal(SIGSEGV, handleSignal);
91 signal(SIGBUS, handleSignal);
94 # endif /* Q_OS_WIN */
95 #endif /* Q_OS_WIN || HAVE_EXECINFO */
98 instance()->_initialized = true;
99 qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
101 instance()->setupEnvironment();
102 instance()->registerMetaTypes();
104 Network::setDefaultCodecForServer("ISO-8859-1");
105 Network::setDefaultCodecForEncoding("UTF-8");
106 Network::setDefaultCodecForDecoding("ISO-8859-15");
108 if (isOptionSet("help")) {
109 instance()->_cliParser->usage();
113 if (isOptionSet("version")) {
114 std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
119 if (Quassel::runMode() != Quassel::ClientOnly) {
120 if (isOptionSet("loglevel")) {
121 QString level = optionValue("loglevel");
123 if (level == "Debug")
124 setLogLevel(DebugLevel);
125 else if (level == "Info")
126 setLogLevel(InfoLevel);
127 else if (level == "Warning")
128 setLogLevel(WarningLevel);
129 else if (level == "Error")
130 setLogLevel(ErrorLevel);
132 qWarning() << qPrintable(tr("Invalid log level %1; supported are Debug|Info|Warning|Error").arg(level));
137 QString logfilename = optionValue("logfile");
138 if (!logfilename.isEmpty()) {
139 instance()->_logFile.reset(new QFile{logfilename});
140 if (!logFile()->open(QIODevice::Append | QIODevice::Text)) {
141 qWarning() << "Could not open log file" << logfilename << ":" << logFile()->errorString();
142 instance()->_logFile.reset();
146 instance()->_logToSyslog = isOptionSet("syslog");
154 void Quassel::destroy()
158 instance()->_logFile.reset();
163 void Quassel::registerQuitHandler(QuitHandler handler)
165 instance()->_quitHandlers.emplace_back(std::move(handler));
170 if (_quitHandlers.empty()) {
171 QCoreApplication::quit();
174 for (auto &&handler : _quitHandlers) {
181 void Quassel::registerReloadHandler(ReloadHandler handler)
183 instance()->_reloadHandlers.emplace_back(std::move(handler));
187 bool Quassel::reloadConfig()
190 for (auto &&handler : _reloadHandlers) {
191 result = result && handler();
197 //! Register our custom types with Qt's Meta Object System.
198 /** This makes them available for QVariant and in signals/slots, among other things.
201 void Quassel::registerMetaTypes()
204 qRegisterMetaType<Message>("Message");
205 qRegisterMetaType<BufferInfo>("BufferInfo");
206 qRegisterMetaType<NetworkInfo>("NetworkInfo");
207 qRegisterMetaType<Network::Server>("Network::Server");
208 qRegisterMetaType<Identity>("Identity");
210 qRegisterMetaTypeStreamOperators<Message>("Message");
211 qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
212 qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
213 qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
214 qRegisterMetaTypeStreamOperators<Identity>("Identity");
216 qRegisterMetaType<IdentityId>("IdentityId");
217 qRegisterMetaType<BufferId>("BufferId");
218 qRegisterMetaType<NetworkId>("NetworkId");
219 qRegisterMetaType<UserId>("UserId");
220 qRegisterMetaType<AccountId>("AccountId");
221 qRegisterMetaType<MsgId>("MsgId");
223 qRegisterMetaType<QHostAddress>("QHostAddress");
224 qRegisterMetaTypeStreamOperators<QHostAddress>("QHostAddress");
225 qRegisterMetaType<QUuid>("QUuid");
226 qRegisterMetaTypeStreamOperators<QUuid>("QUuid");
228 qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
229 qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
230 qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
231 qRegisterMetaTypeStreamOperators<UserId>("UserId");
232 qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
233 qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
235 qRegisterMetaType<Protocol::SessionState>("Protocol::SessionState");
236 qRegisterMetaType<PeerPtr>("PeerPtr");
237 qRegisterMetaTypeStreamOperators<PeerPtr>("PeerPtr");
239 // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
240 if (!QMetaType::type("QVariant")) {
241 qRegisterMetaType<QVariant>("QVariant");
242 qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
247 void Quassel::setupEnvironment()
249 // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
250 // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard
251 // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to
252 // hack extra search paths into various places.
254 QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
255 if (xdgDataVar.isEmpty())
256 xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
258 QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
260 // Add our install prefix (if we're not in a bindir, this just adds the current workdir)
261 QString appDir = QCoreApplication::applicationDirPath();
262 int binpos = appDir.lastIndexOf("/bin");
264 appDir.replace(binpos, 4, "/share");
265 xdgDirs.append(appDir);
266 // Also append apps/quassel, this is only for QIconLoader to find icons there
267 xdgDirs.append(appDir + "/apps/quassel");
269 xdgDirs.append(appDir); // build directory is always the last fallback
271 xdgDirs.removeDuplicates();
273 qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":")));
278 void Quassel::setupBuildInfo()
281 buildInfo.applicationName = "quassel";
282 buildInfo.coreApplicationName = "quasselcore";
283 buildInfo.clientApplicationName = "quasselclient";
284 buildInfo.organizationName = "Quassel Project";
285 buildInfo.organizationDomain = "quassel-irc.org";
287 buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
289 buildInfo.baseVersion = QUASSEL_VERSION_STRING;
290 buildInfo.generatedVersion = GIT_DESCRIBE;
292 // Check if we got a commit hash
293 if (!QString(GIT_HEAD).isEmpty()) {
294 buildInfo.commitHash = GIT_HEAD;
296 date.setTime_t(GIT_COMMIT_DATE);
297 buildInfo.commitDate = date.toString();
299 else if (!QString(DIST_HASH).contains("Format")) {
300 buildInfo.commitHash = DIST_HASH;
301 buildInfo.commitDate = QString(DIST_DATE);
304 // create a nice version string
305 if (buildInfo.generatedVersion.isEmpty()) {
306 if (!buildInfo.commitHash.isEmpty()) {
308 buildInfo.plainVersionString = QString{"v%1 (dist-%2)"}
309 .arg(buildInfo.baseVersion)
310 .arg(buildInfo.commitHash.left(7));
311 buildInfo.fancyVersionString = QString{"v%1 (dist-<a href=\"https://github.com/quassel/quassel/commit/%3\">%2</a>)"}
312 .arg(buildInfo.baseVersion)
313 .arg(buildInfo.commitHash.left(7))
314 .arg(buildInfo.commitHash);
317 // we only have a base version :(
318 buildInfo.plainVersionString = QString{"v%1 (unknown revision)"}.arg(buildInfo.baseVersion);
322 // analyze what we got from git-describe
323 static const QRegExp rx{"(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$"};
324 if (rx.exactMatch(buildInfo.generatedVersion)) {
325 QString distance = rx.cap(2) == "0" ? QString{} : QString{"%1+%2 "}.arg(rx.cap(1), rx.cap(2));
326 buildInfo.plainVersionString = QString{"v%1 (%2git-%3%4)"}.arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4));
327 if (!buildInfo.commitHash.isEmpty()) {
328 buildInfo.fancyVersionString = QString{"v%1 (%2git-<a href=\"https://github.com/quassel/quassel/commit/%5\">%3</a>%4)"}
329 .arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), buildInfo.commitHash);
333 buildInfo.plainVersionString = QString{"v%1 (invalid revision)"}.arg(buildInfo.baseVersion);
336 if (buildInfo.fancyVersionString.isEmpty()) {
337 buildInfo.fancyVersionString = buildInfo.plainVersionString;
340 instance()->_buildInfo = std::move(buildInfo);
344 const Quassel::BuildInfo &Quassel::buildInfo()
346 return instance()->_buildInfo;
350 //! Signal handler for graceful shutdown.
351 void Quassel::handleSignal(int sig)
356 qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
360 // Windows does not support SIGHUP
362 // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for
363 // graceful reloading of processes.
364 quInfo() << "Caught signal" << SIGHUP << "- reloading configuration";
365 if (instance()->reloadConfig()) {
366 quInfo() << "Successfully reloaded configuration";
375 instance()->logBacktrace(instance()->coreDumpFileName());
383 void Quassel::disableCrashHandler()
385 instance()->_handleCrashes = false;
389 Quassel::RunMode Quassel::runMode() {
390 return instance()->_runMode;
394 void Quassel::setRunMode(RunMode runMode)
396 instance()->_runMode = runMode;
400 void Quassel::setCliParser(std::shared_ptr<AbstractCliParser> parser)
402 instance()->_cliParser = std::move(parser);
406 QString Quassel::optionValue(const QString &key)
408 return instance()->_cliParser ? instance()->_cliParser->value(key) : QString{};
412 bool Quassel::isOptionSet(const QString &key)
414 return instance()->_cliParser ? instance()->_cliParser->isSet(key) : false;
418 Quassel::LogLevel Quassel::logLevel()
420 return instance()->_logLevel;
424 void Quassel::setLogLevel(LogLevel logLevel)
426 instance()->_logLevel = logLevel;
430 QFile *Quassel::logFile() {
431 return instance()->_logFile.get();
435 bool Quassel::logToSyslog()
437 return instance()->_logToSyslog;
441 void Quassel::logFatalMessage(const char *msg)
446 QFile dumpFile(instance()->coreDumpFileName());
447 dumpFile.open(QIODevice::Append);
448 QTextStream dumpStream(&dumpFile);
450 dumpStream << "Fatal: " << msg << '\n';
457 Quassel::Features Quassel::features()
460 for (int i = 1; i <= NumFeatures; i <<= 1)
463 // Disable DCC until it is ready
464 feats &= ~Feature::DccFileTransfer;
470 const QString &Quassel::coreDumpFileName()
472 if (_coreDumpFileName.isEmpty()) {
473 QDir configDir(configDirPath());
474 _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
475 QFile dumpFile(_coreDumpFileName);
476 dumpFile.open(QIODevice::Append);
477 QTextStream dumpStream(&dumpFile);
478 dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
479 qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
483 return _coreDumpFileName;
487 QString Quassel::configDirPath()
489 if (!instance()->_configDirPath.isEmpty())
490 return instance()->_configDirPath;
493 if (isOptionSet("datadir")) {
494 qWarning() << "Obsolete option --datadir used!";
495 path = Quassel::optionValue("datadir");
497 else if (isOptionSet("configdir")) {
498 path = Quassel::optionValue("configdir");
502 // On Mac, the path is always the same
503 path = QDir::homePath() + "/Library/Application Support/Quassel/";
505 // We abuse QSettings to find us a sensible path on the other platforms
507 // don't use the registry
508 QSettings::Format format = QSettings::IniFormat;
510 QSettings::Format format = QSettings::NativeFormat;
512 QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
513 QFileInfo fileInfo(s.fileName());
514 path = fileInfo.dir().absolutePath();
515 #endif /* Q_OS_MAC */
518 if (!path.endsWith(QDir::separator()) && !path.endsWith('/'))
519 path += QDir::separator();
522 if (!qDir.exists(path)) {
523 if (!qDir.mkpath(path)) {
524 qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
529 instance()->_configDirPath = path;
535 void Quassel::setDataDirPaths(const QStringList &paths) {
536 instance()->_dataDirPaths = paths;
540 QStringList Quassel::dataDirPaths()
542 return instance()->_dataDirPaths;
546 QStringList Quassel::findDataDirPaths()
549 // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
550 // want to stay consistent.
552 QStringList dataDirNames;
554 dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
555 << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
556 << QCoreApplication::applicationDirPath();
557 #elif defined Q_OS_MAC
558 dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
559 << QCoreApplication::applicationDirPath();
563 // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share
564 // This should thus come first.
565 QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
566 if (xdgDataHome.isEmpty())
567 xdgDataHome = QDir::homePath() + QLatin1String("/.local/share");
568 dataDirNames << xdgDataHome;
570 // Now whatever is configured through XDG_DATA_DIRS
571 QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
572 if (xdgDataDirs.isEmpty())
573 dataDirNames << "/usr/local/share" << "/usr/share";
575 dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
577 // Just in case, also check our install prefix
578 dataDirNames << QCoreApplication::applicationDirPath() + "/../share";
580 // Normalize and append our application name
581 for (int i = 0; i < dataDirNames.count(); i++)
582 dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/";
586 // Add resource path and workdir just in case.
587 // Workdir should have precedence
588 dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/");
589 dataDirNames.append(":/data/");
591 // Append trailing '/' and check for existence
592 auto iter = dataDirNames.begin();
593 while (iter != dataDirNames.end()) {
594 if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
595 iter->append(QDir::separator());
596 if (!QFile::exists(*iter))
597 iter = dataDirNames.erase(iter);
602 dataDirNames.removeDuplicates();
608 QString Quassel::findDataFilePath(const QString &fileName)
610 QStringList dataDirs = dataDirPaths();
611 foreach(QString dataDir, dataDirs) {
612 QString path = dataDir + fileName;
613 if (QFile::exists(path))
620 QStringList Quassel::scriptDirPaths()
622 QStringList res(configDirPath() + "scripts/");
623 foreach(QString path, dataDirPaths())
624 res << path + "scripts/";
629 QString Quassel::translationDirPath()
631 if (instance()->_translationDirPath.isEmpty()) {
632 // We support only one translation dir; fallback mechanisms wouldn't work else.
633 // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
634 foreach(const QString &dir, dataDirPaths()) {
635 if (QFile::exists(dir + "translations/")) {
636 instance()->_translationDirPath = dir + "translations/";
640 if (instance()->_translationDirPath.isEmpty())
641 instance()->_translationDirPath = ":/i18n/";
643 return instance()->_translationDirPath;
647 void Quassel::loadTranslation(const QLocale &locale)
649 QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
650 QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
653 qApp->removeTranslator(qtTranslator);
654 if (quasselTranslator)
655 qApp->removeTranslator(quasselTranslator);
657 // We use QLocale::C to indicate that we don't want a translation
658 if (locale.language() == QLocale::C)
661 qtTranslator = new QTranslator(qApp);
662 qtTranslator->setObjectName("QtTr");
663 qApp->installTranslator(qtTranslator);
665 quasselTranslator = new QTranslator(qApp);
666 quasselTranslator->setObjectName("QuasselTr");
667 qApp->installTranslator(quasselTranslator);
669 #if QT_VERSION >= 0x040800 && !defined Q_OS_MAC
670 bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
672 qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
673 quasselTranslator->load(locale, QString(""), translationDirPath());
675 bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
677 qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
678 quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());