X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fquassel.cpp;h=03cf739ad146cfe02ec357e735a4555e8cd45b26;hp=4be4db16daf50ec876434d168853fcf310153c7c;hb=8582c2ad5708a1972c85bea1cf8d81ad3ece4814;hpb=ab16c77fe03b73a863d9b52b11919bcbac903f58 diff --git a/src/common/quassel.cpp b/src/common/quassel.cpp index 4be4db16..03cf739a 100644 --- a/src/common/quassel.cpp +++ b/src/common/quassel.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-09 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,378 +15,706 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ #include "quassel.h" +#include #include -#include #include #include +#include #include +#include #include +#include #include #include +#include -#include "message.h" +#include "bufferinfo.h" #include "identity.h" +#include "logger.h" +#include "logmessage.h" +#include "message.h" #include "network.h" -#include "bufferinfo.h" -#include "types.h" +#include "peer.h" +#include "protocol.h" #include "syncableobject.h" +#include "types.h" +#include "version.h" -Quassel::BuildInfo Quassel::_buildInfo; -AbstractCliParser *Quassel::_cliParser = 0; -Quassel::RunMode Quassel::_runMode; -QString Quassel::_configDirPath; -QString Quassel::_translationDirPath; -QStringList Quassel::_dataDirPaths; -bool Quassel::_initialized = false; -bool Quassel::DEBUG = false; -QString Quassel::_coreDumpFileName; - -Quassel::Quassel() { - // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel. - signal(SIGTERM, handleSignal); - signal(SIGINT, handleSignal); - - // we have crashhandler for win32 and unix (based on execinfo). - // on mac os we use it's integrated backtrace generator -#if defined(Q_OS_WIN32) || (defined(HAVE_EXECINFO) && !defined(Q_OS_MAC)) - signal(SIGABRT, handleSignal); - signal(SIGSEGV, handleSignal); -# ifndef Q_OS_WIN32 - signal(SIGBUS, handleSignal); -# endif +#ifndef Q_OS_WIN +# include "posixsignalwatcher.h" +#else +# include "windowssignalwatcher.h" +#endif + +Quassel::Quassel() + : Singleton{this} + , _logger{new Logger{this}} +{ +#ifdef EMBED_DATA + Q_INIT_RESOURCE(i18n); #endif } -Quassel::~Quassel() { - delete _cliParser; + +void Quassel::init(RunMode runMode) +{ + _runMode = runMode; + + qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime())); + + setupSignalHandling(); + setupEnvironment(); + registerMetaTypes(); + + // Initial translation (may be overridden in UI settings) + loadTranslation(QLocale::system()); + + setupCliParser(); + + // Don't keep a debug log on the core + logger()->setup(runMode != RunMode::CoreOnly); + + Network::setDefaultCodecForServer("UTF-8"); + Network::setDefaultCodecForEncoding("UTF-8"); + Network::setDefaultCodecForDecoding("ISO-8859-15"); } -bool Quassel::init() { - if(_initialized) - return true; // allow multiple invocations because of MonolithicApplication - _initialized = true; - qsrand(QTime(0,0,0).secsTo(QTime::currentTime())); +Logger *Quassel::logger() const +{ + return _logger; +} + + +void Quassel::registerQuitHandler(QuitHandler handler) +{ + instance()->_quitHandlers.emplace_back(std::move(handler)); +} - registerMetaTypes(); +void Quassel::quit() +{ + // Protect against multiple invocations (e.g. triggered by MainWin::closeEvent()) + if (!_quitting) { + _quitting = true; + quInfo() << "Quitting..."; + if (_quitHandlers.empty()) { + QCoreApplication::quit(); + } + else { + // Note: We expect one of the registered handlers to call QCoreApplication::quit() + for (auto &&handler : _quitHandlers) { + handler(); + } + } + } +} - Network::setDefaultCodecForServer("ISO-8859-1"); - Network::setDefaultCodecForEncoding("UTF-8"); - Network::setDefaultCodecForDecoding("ISO-8859-15"); - if(isOptionSet("help")) { - cliParser()->usage(); - return false; - } +void Quassel::registerReloadHandler(ReloadHandler handler) +{ + instance()->_reloadHandlers.emplace_back(std::move(handler)); +} - if(isOptionSet("version")) { - std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl; - return false; - } - DEBUG = isOptionSet("debug"); - return true; +bool Quassel::reloadConfig() +{ + bool result{true}; + for (auto &&handler : _reloadHandlers) { + result = result && handler(); + } + return result; } + //! Register our custom types with Qt's Meta Object System. /** This makes them available for QVariant and in signals/slots, among other things. * */ -void Quassel::registerMetaTypes() { - // Complex types - qRegisterMetaType("QVariant"); - qRegisterMetaType("Message"); - qRegisterMetaType("BufferInfo"); - qRegisterMetaType("NetworkInfo"); - qRegisterMetaType("Network::Server"); - qRegisterMetaType("Identity"); - qRegisterMetaType("Network::ConnectionState"); - - qRegisterMetaTypeStreamOperators("QVariant"); - qRegisterMetaTypeStreamOperators("Message"); - qRegisterMetaTypeStreamOperators("BufferInfo"); - qRegisterMetaTypeStreamOperators("NetworkInfo"); - qRegisterMetaTypeStreamOperators("Network::Server"); - qRegisterMetaTypeStreamOperators("Identity"); - qRegisterMetaTypeStreamOperators("Network::ConnectionState"); - - qRegisterMetaType("IdentityId"); - qRegisterMetaType("BufferId"); - qRegisterMetaType("NetworkId"); - qRegisterMetaType("UserId"); - qRegisterMetaType("AccountId"); - qRegisterMetaType("MsgId"); - - qRegisterMetaTypeStreamOperators("IdentityId"); - qRegisterMetaTypeStreamOperators("BufferId"); - qRegisterMetaTypeStreamOperators("NetworkId"); - qRegisterMetaTypeStreamOperators("UserId"); - qRegisterMetaTypeStreamOperators("AccountId"); - qRegisterMetaTypeStreamOperators("MsgId"); +void Quassel::registerMetaTypes() +{ + // Complex types + qRegisterMetaType("Message"); + qRegisterMetaType("BufferInfo"); + qRegisterMetaType("NetworkInfo"); + qRegisterMetaType("Network::Server"); + qRegisterMetaType("Identity"); + + qRegisterMetaTypeStreamOperators("Message"); + qRegisterMetaTypeStreamOperators("BufferInfo"); + qRegisterMetaTypeStreamOperators("NetworkInfo"); + qRegisterMetaTypeStreamOperators("Network::Server"); + qRegisterMetaTypeStreamOperators("Identity"); + + qRegisterMetaType("IdentityId"); + qRegisterMetaType("BufferId"); + qRegisterMetaType("NetworkId"); + qRegisterMetaType("UserId"); + qRegisterMetaType("AccountId"); + qRegisterMetaType("MsgId"); + + qRegisterMetaType("QHostAddress"); + qRegisterMetaTypeStreamOperators("QHostAddress"); + qRegisterMetaType("QUuid"); + qRegisterMetaTypeStreamOperators("QUuid"); + + qRegisterMetaTypeStreamOperators("IdentityId"); + qRegisterMetaTypeStreamOperators("BufferId"); + qRegisterMetaTypeStreamOperators("NetworkId"); + qRegisterMetaTypeStreamOperators("UserId"); + qRegisterMetaTypeStreamOperators("AccountId"); + qRegisterMetaTypeStreamOperators("MsgId"); + + qRegisterMetaType("Protocol::SessionState"); + qRegisterMetaType("PeerPtr"); + qRegisterMetaTypeStreamOperators("PeerPtr"); + + // Versions of Qt prior to 4.7 didn't define QVariant as a meta type + if (!QMetaType::type("QVariant")) { + qRegisterMetaType("QVariant"); + qRegisterMetaTypeStreamOperators("QVariant"); + } +} + + +void Quassel::setupEnvironment() +{ + // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This + // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard + // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to + // hack extra search paths into various places. +#ifdef Q_OS_UNIX + QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS")); + if (xdgDataVar.isEmpty()) + xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults + + QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts); + + // Add our install prefix (if we're not in a bindir, this just adds the current workdir) + QString appDir = QCoreApplication::applicationDirPath(); + int binpos = appDir.lastIndexOf("/bin"); + if (binpos >= 0) { + appDir.replace(binpos, 4, "/share"); + xdgDirs.append(appDir); + // Also append apps/quassel, this is only for QIconLoader to find icons there + xdgDirs.append(appDir + "/apps/quassel"); + } else + xdgDirs.append(appDir); // build directory is always the last fallback + + xdgDirs.removeDuplicates(); + + qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":"))); +#endif } -void Quassel::setupBuildInfo(const QString &generated) { - _buildInfo.applicationName = "Quassel IRC"; - _buildInfo.coreApplicationName = "quasselcore"; - _buildInfo.clientApplicationName = "quasselclient"; - _buildInfo.organizationName = "Quassel Project"; - _buildInfo.organizationDomain = "quassel-irc.org"; - - QStringList gen = generated.split(','); - Q_ASSERT(gen.count() == 10); - _buildInfo.baseVersion = gen[0]; - _buildInfo.generatedVersion = gen[1]; - _buildInfo.isSourceDirty = !gen[2].isEmpty(); - _buildInfo.commitHash = gen[3]; - _buildInfo.commitDate = gen[4].toUInt(); - _buildInfo.protocolVersion = gen[5].toUInt(); - _buildInfo.clientNeedsProtocol = gen[6].toUInt(); - _buildInfo.coreNeedsProtocol = gen[7].toUInt(); - _buildInfo.buildDate = QString("%1 %2").arg(gen[8], gen[9]); - // create a nice version string - if(_buildInfo.generatedVersion.isEmpty()) { - if(!_buildInfo.commitHash.isEmpty()) { - // dist version - _buildInfo.plainVersionString = QString("v%1 (dist-%2)") - .arg(_buildInfo.baseVersion) - .arg(_buildInfo.commitHash.left(7)); - _buildInfo.fancyVersionString - = QString("v%1 (dist-%2)") - .arg(_buildInfo.baseVersion) - .arg(_buildInfo.commitHash.left(7)) - .arg(_buildInfo.commitHash); - } else { - // we only have a base version :( - _buildInfo.plainVersionString = QString("v%1 (unknown rev)").arg(_buildInfo.baseVersion); + +void Quassel::setupBuildInfo() +{ + BuildInfo buildInfo; + buildInfo.applicationName = "quassel"; + buildInfo.coreApplicationName = "quasselcore"; + buildInfo.clientApplicationName = "quasselclient"; + buildInfo.organizationName = "Quassel Project"; + buildInfo.organizationDomain = "quassel-irc.org"; + + buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed + + buildInfo.baseVersion = QUASSEL_VERSION_STRING; + buildInfo.generatedVersion = GIT_DESCRIBE; + + // Check if we got a commit hash + if (!QString(GIT_HEAD).isEmpty()) { + buildInfo.commitHash = GIT_HEAD; + // Set to Unix epoch, wrapped as a string for backwards-compatibility + buildInfo.commitDate = QString::number(GIT_COMMIT_DATE); + } + else if (!QString(DIST_HASH).contains("Format")) { + buildInfo.commitHash = DIST_HASH; + // Leave as Unix epoch if set as Unix epoch, but don't force this for + // backwards-compatibility with existing packaging/release tools that might set strings. + buildInfo.commitDate = QString(DIST_DATE); + } + + // create a nice version string + if (buildInfo.generatedVersion.isEmpty()) { + if (!buildInfo.commitHash.isEmpty()) { + // dist version + buildInfo.plainVersionString = QString{"v%1 (dist-%2)"} + .arg(buildInfo.baseVersion) + .arg(buildInfo.commitHash.left(7)); + buildInfo.fancyVersionString = QString{"v%1 (dist-%2)"} + .arg(buildInfo.baseVersion) + .arg(buildInfo.commitHash.left(7)) + .arg(buildInfo.commitHash); + } + else { + // we only have a base version :( + buildInfo.plainVersionString = QString{"v%1 (unknown revision)"}.arg(buildInfo.baseVersion); + } } - } else { - // analyze what we got from git-describe - QRegExp rx("(.*)-(\\d+)-g([0-9a-f]+)$"); - if(rx.exactMatch(_buildInfo.generatedVersion)) { - QString distance = rx.cap(2) == "0" ? QString() : QString(" [+%1]").arg(rx.cap(2)); - _buildInfo.plainVersionString = QString("v%1%2 (git-%3%4)") - .arg(rx.cap(1), distance, rx.cap(3)) - .arg(_buildInfo.isSourceDirty ? "*" : ""); - if(!_buildInfo.commitHash.isEmpty()) { - _buildInfo.fancyVersionString = QString("v%1%2 (git-%3%4)") - .arg(rx.cap(1), distance, rx.cap(3)) - .arg(_buildInfo.isSourceDirty ? "*" : "") - .arg(_buildInfo.commitHash); - } - } else { - _buildInfo.plainVersionString = QString("v%1 (invalid rev)").arg(_buildInfo.baseVersion); + else { + // analyze what we got from git-describe + static const QRegExp rx{"(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$"}; + if (rx.exactMatch(buildInfo.generatedVersion)) { + QString distance = rx.cap(2) == "0" ? QString{} : QString{"%1+%2 "}.arg(rx.cap(1), rx.cap(2)); + buildInfo.plainVersionString = QString{"v%1 (%2git-%3%4)"}.arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4)); + if (!buildInfo.commitHash.isEmpty()) { + buildInfo.fancyVersionString = QString{"v%1 (%2git-%3%4)"} + .arg(buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), buildInfo.commitHash); + } + } + else { + buildInfo.plainVersionString = QString{"v%1 (invalid revision)"}.arg(buildInfo.baseVersion); + } } - } - if(_buildInfo.fancyVersionString.isEmpty()) - _buildInfo.fancyVersionString = _buildInfo.plainVersionString; + if (buildInfo.fancyVersionString.isEmpty()) { + buildInfo.fancyVersionString = buildInfo.plainVersionString; + } + + instance()->_buildInfo = std::move(buildInfo); } -//! Signal handler for graceful shutdown. -void Quassel::handleSignal(int sig) { - switch(sig) { - case SIGTERM: - case SIGINT: - qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig))); - QCoreApplication::quit(); - break; - case SIGABRT: - case SIGSEGV: -#ifndef Q_OS_WIN32 - case SIGBUS: -#endif - logBacktrace(coreDumpFileName()); - exit(EXIT_FAILURE); - break; - default: - break; - } + +const Quassel::BuildInfo &Quassel::buildInfo() +{ + return instance()->_buildInfo; } -void Quassel::logFatalMessage(const char *msg) { -#ifdef Q_OS_MAC - Q_UNUSED(msg) + +void Quassel::setupSignalHandling() +{ +#ifndef Q_OS_WIN + _signalWatcher = new PosixSignalWatcher(this); #else - QFile dumpFile(coreDumpFileName()); - dumpFile.open(QIODevice::Append); - QTextStream dumpStream(&dumpFile); + _signalWatcher = new WindowsSignalWatcher(this); +#endif + connect(_signalWatcher, SIGNAL(handleSignal(AbstractSignalWatcher::Action)), this, SLOT(handleSignal(AbstractSignalWatcher::Action))); +} - dumpStream << "Fatal: " << msg << '\n'; - dumpStream.flush(); - dumpFile.close(); + +void Quassel::handleSignal(AbstractSignalWatcher::Action action) +{ + switch (action) { + case AbstractSignalWatcher::Action::Reload: + // Most applications use this as the 'configuration reload' command, e.g. nginx uses it for graceful reloading of processes. + if (!_reloadHandlers.empty()) { + quInfo() << "Reloading configuration"; + if (reloadConfig()) { + quInfo() << "Successfully reloaded configuration"; + } + } + break; + case AbstractSignalWatcher::Action::Terminate: + if (!_quitting) { + quit(); + } + else { + quInfo() << "Already shutting down, ignoring signal"; + } + break; + case AbstractSignalWatcher::Action::HandleCrash: + logBacktrace(instance()->coreDumpFileName()); + exit(EXIT_FAILURE); + } +} + + +Quassel::RunMode Quassel::runMode() { + return instance()->_runMode; +} + + +void Quassel::setupCliParser() +{ + QList options; + + // General options + /// @todo Bring back --datadir to specify the database location independent of config + if (runMode() == RunMode::ClientOnly) { + options += {{"c", "configdir"}, tr("Specify the directory holding the client configuration."), tr("path")}; + } + else { + options += {{"c", "configdir"}, tr("Specify the directory holding configuration files, the SQlite database and the SSL certificate."), tr("path")}; + } + + // Client options + if (runMode() != RunMode::CoreOnly) { + options += { + {"icontheme", tr("Override the system icon theme ('breeze' is recommended)."), tr("theme")}, + {"qss", tr("Load a custom application stylesheet."), tr("file.qss")}, + {"hidewindow", tr("Start the client minimized to the system tray.")}, + }; + } + + // Core options + if (runMode() != RunMode::ClientOnly) { + options += { + {"listen", tr("The address(es) quasselcore will listen on."), tr("
[,
[,...]]"), "::,0.0.0.0"}, + {{"p", "port"}, tr("The port quasselcore will listen at."), tr("port"), "4242"}, + {{"n", "norestore"}, tr("Don't restore last core's state.")}, + {"config-from-environment", tr("Load configuration from environment variables.")}, + {"select-backend", tr("Switch storage backend (migrating data if possible)."), tr("backendidentifier")}, + {"select-authenticator", tr("Select authentication backend."), tr("authidentifier")}, + {"add-user", tr("Starts an interactive session to add a new core user.")}, + {"change-userpass", tr("Starts an interactive session to change the password of the user identified by ."), tr("username")}, + {"strict-ident", tr("Use users' quasselcore username as ident reply. Ignores each user's configured ident setting.")}, + {"ident-daemon", tr("Enable internal ident daemon.")}, + {"ident-port", tr("The port quasselcore will listen at for ident requests. Only meaningful with --ident-daemon."), tr("port"), "10113"}, + {"oidentd", tr("Enable oidentd integration. In most cases you should also enable --strict-ident.")}, + {"oidentd-conffile", tr("Set path to oidentd configuration file."), tr("file")}, +#ifdef HAVE_SSL + {"require-ssl", tr("Require SSL for remote (non-loopback) client connections.")}, + {"ssl-cert", tr("Specify the path to the SSL certificate."), tr("path"), "configdir/quasselCert.pem"}, + {"ssl-key", tr("Specify the path to the SSL key."), tr("path"), "ssl-cert-path"}, #endif + }; + } + + // Logging options + options += { + {{"L", "loglevel"}, tr("Supports one of Debug|Info|Warning|Error; default is Info."), tr("level"), "Info"}, + {{"l", "logfile"}, tr("Log to a file."), "path"}, +#ifdef HAVE_SYSLOG + {"syslog", tr("Log to syslog.")}, +#endif + }; + + // Debug options + options += {{"d", "debug"}, tr("Enable debug output.")}; + if (runMode() != RunMode::CoreOnly) { + options += { + {"debugbufferswitches", tr("Enables debugging for bufferswitches.")}, + {"debugmodel", tr("Enables debugging for models.")}, + }; + } + if (runMode() != RunMode::ClientOnly) { + options += { + {"debug-irc", tr("Enable logging of all raw IRC messages to debug log, including passwords! In most cases you should also set --loglevel Debug")}, + {"debug-irc-id", tr("Limit raw IRC logging to this network ID. Implies --debug-irc"), tr("database network ID"), "-1"}, + }; + } + + _cliParser.addOptions(options); + _cliParser.addHelpOption(); + _cliParser.addVersionOption(); + _cliParser.setApplicationDescription(tr("Quassel IRC is a modern, distributed IRC client.")); + + // This will call ::exit() for --help, --version and in case of errors + _cliParser.process(*QCoreApplication::instance()); } -const QString &Quassel::coreDumpFileName() { - if(_coreDumpFileName.isEmpty()) { - QDir configDir(configDirPath()); - _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm"))); - QFile dumpFile(_coreDumpFileName); - dumpFile.open(QIODevice::Append); - QTextStream dumpStream(&dumpFile); - dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n'; - qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash; - dumpStream.flush(); - dumpFile.close(); - } - return _coreDumpFileName; + +QString Quassel::optionValue(const QString &key) +{ + return instance()->_cliParser.value(key); } -QString Quassel::configDirPath() { - if(!_configDirPath.isEmpty()) - return _configDirPath; - if(Quassel::isOptionSet("datadir")) { - qWarning() << "Obsolete option --datadir used!"; - _configDirPath = Quassel::optionValue("datadir"); - } else if(Quassel::isOptionSet("configdir")) { - _configDirPath = Quassel::optionValue("configdir"); - } else { +bool Quassel::isOptionSet(const QString &key) +{ + return instance()->_cliParser.isSet(key); +} + + +const QString &Quassel::coreDumpFileName() +{ + if (_coreDumpFileName.isEmpty()) { + QDir configDir(configDirPath()); + _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm"))); + QFile dumpFile(_coreDumpFileName); + dumpFile.open(QIODevice::Append); + QTextStream dumpStream(&dumpFile); + dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n'; + qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash; + dumpStream.flush(); + dumpFile.close(); + } + return _coreDumpFileName; +} -#ifdef Q_WS_MAC - // On Mac, the path is always the same - _configDirPath = QDir::homePath() + "/Library/Application Support/Quassel/"; + +QString Quassel::configDirPath() +{ + if (!instance()->_configDirPath.isEmpty()) + return instance()->_configDirPath; + + QString path; + if (isOptionSet("configdir")) { + path = Quassel::optionValue("configdir"); + } + else { +#ifdef Q_OS_MAC + // On Mac, the path is always the same + path = QDir::homePath() + "/Library/Application Support/Quassel/"; #else - // We abuse QSettings to find us a sensible path on the other platforms -# ifdef Q_WS_WIN - // don't use the registry - QSettings::Format format = QSettings::IniFormat; + // We abuse QSettings to find us a sensible path on the other platforms +# ifdef Q_OS_WIN + // don't use the registry + QSettings::Format format = QSettings::IniFormat; # else - QSettings::Format format = QSettings::NativeFormat; + QSettings::Format format = QSettings::NativeFormat; # endif - QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName); - QFileInfo fileInfo(s.fileName()); - _configDirPath = fileInfo.dir().absolutePath(); -#endif /* Q_WS_MAC */ - } - - if(!_configDirPath.endsWith(QDir::separator()) && !_configDirPath.endsWith('/')) - _configDirPath += QDir::separator(); - - QDir qDir(_configDirPath); - if(!qDir.exists(_configDirPath)) { - if(!qDir.mkpath(_configDirPath)) { - qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath()); - return QString(); + QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName); + QFileInfo fileInfo(s.fileName()); + path = fileInfo.dir().absolutePath(); +#endif /* Q_OS_MAC */ } - } - return _configDirPath; -} + path = QFileInfo{path}.absoluteFilePath(); + + if (!path.endsWith(QDir::separator()) && !path.endsWith('/')) + path += QDir::separator(); + + QDir qDir{path}; + if (!qDir.exists(path)) { + if (!qDir.mkpath(path)) { + qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath()); + return {}; + } + } -QStringList Quassel::dataDirPaths() { - return _dataDirPaths; + instance()->_configDirPath = path; + return path; } -QStringList Quassel::findDataDirPaths() const { - QStringList dataDirNames = QString(qgetenv("XDG_DATA_DIRS")).split(':', QString::SkipEmptyParts); - if(!dataDirNames.isEmpty()) { - for(int i = 0; i < dataDirNames.count(); i++) - dataDirNames[i].append("/apps/quassel/"); - } else { - // Provide a fallback -#ifdef Q_OS_WIN32 +QStringList Quassel::dataDirPaths() +{ + if (!instance()->_dataDirPaths.isEmpty()) + return instance()->_dataDirPaths; + + // TODO: Migrate to QStandardPaths (will require moving of the sqlite database, + // or a fallback for it being in the config dir) + + QStringList dataDirNames; +#ifdef Q_OS_WIN dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/" << qgetenv("APPDATA") + QCoreApplication::organizationDomain() << QCoreApplication::applicationDirPath(); - } -#elif defined Q_WS_MAC +#elif defined Q_OS_MAC dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/" << QCoreApplication::applicationDirPath(); - } #else - dataDirNames.append("/usr/share/apps/quassel/"); - } - // on UNIX, we always check our install prefix - QString appDir = QCoreApplication::applicationDirPath(); - int binpos = appDir.lastIndexOf("/bin"); - if(binpos >= 0) { - appDir.replace(binpos, 4, "/share"); - appDir.append("/apps/quassel/"); - if(!dataDirNames.contains(appDir)) - dataDirNames.append(appDir); - } + // Linux et al + + // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share + // This should thus come first. + QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME")); + if (xdgDataHome.isEmpty()) + xdgDataHome = QDir::homePath() + QLatin1String("/.local/share"); + dataDirNames << xdgDataHome; + + // Now whatever is configured through XDG_DATA_DIRS + QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS")); + if (xdgDataDirs.isEmpty()) + dataDirNames << "/usr/local/share" << "/usr/share"; + else + dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts); + + // Just in case, also check our install prefix + dataDirNames << QCoreApplication::applicationDirPath() + "/../share"; + + // Normalize and append our application name + for (int i = 0; i < dataDirNames.count(); i++) + dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/"; + #endif - // add resource path and workdir just in case - dataDirNames << QCoreApplication::applicationDirPath() + "/data/" - << ":/data/"; - - // append trailing '/' and check for existence - QStringList::Iterator iter = dataDirNames.begin(); - while(iter != dataDirNames.end()) { - if(!iter->endsWith(QDir::separator()) && !iter->endsWith('/')) - iter->append(QDir::separator()); - if(!QFile::exists(*iter)) - iter = dataDirNames.erase(iter); - else - ++iter; - } + // Add resource path and workdir just in case. + // Workdir should have precedence + dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/"); + dataDirNames.append(":/data/"); + + // Append trailing '/' and check for existence + auto iter = dataDirNames.begin(); + while (iter != dataDirNames.end()) { + if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/')) + iter->append(QDir::separator()); + if (!QFile::exists(*iter)) + iter = dataDirNames.erase(iter); + else + ++iter; + } - return dataDirNames; + dataDirNames.removeDuplicates(); + + instance()->_dataDirPaths = dataDirNames; + return dataDirNames; } -QString Quassel::findDataFilePath(const QString &fileName) { - QStringList dataDirs = dataDirPaths(); - foreach(QString dataDir, dataDirs) { - QString path = dataDir + fileName; - if(QFile::exists(path)) - return path; - } - return QString(); + +QString Quassel::findDataFilePath(const QString &fileName) +{ + QStringList dataDirs = dataDirPaths(); + foreach(QString dataDir, dataDirs) { + QString path = dataDir + fileName; + if (QFile::exists(path)) + return path; + } + return QString(); } -QStringList Quassel::scriptDirPaths() { - QStringList res(configDirPath() + "scripts/"); - foreach(QString path, dataDirPaths()) + +QStringList Quassel::scriptDirPaths() +{ + QStringList res(configDirPath() + "scripts/"); + foreach(QString path, dataDirPaths()) res << path + "scripts/"; - return res; + return res; } -QString Quassel::translationDirPath() { - if(_translationDirPath.isEmpty()) { - // We support only one translation dir; fallback mechanisms wouldn't work else. - // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered. - foreach(const QString &dir, dataDirPaths()) { - if(QFile::exists(dir + "translations/")) { - _translationDirPath = dir + "translations/"; - break; - } + +QString Quassel::translationDirPath() +{ + if (instance()->_translationDirPath.isEmpty()) { + // We support only one translation dir; fallback mechanisms wouldn't work else. + // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered. + foreach(const QString &dir, dataDirPaths()) { + if (QFile::exists(dir + "translations/")) { + instance()->_translationDirPath = dir + "translations/"; + break; + } + } + if (instance()->_translationDirPath.isEmpty()) + instance()->_translationDirPath = ":/i18n/"; } - if(_translationDirPath.isEmpty()) - _translationDirPath = ":/i18n/"; - } - return _translationDirPath; + return instance()->_translationDirPath; } -void Quassel::loadTranslation(const QLocale &locale) { - QTranslator *qtTranslator = QCoreApplication::instance()->findChild("QtTr"); - QTranslator *quasselTranslator = QCoreApplication::instance()->findChild("QuasselTr"); - if(!qtTranslator) { +void Quassel::loadTranslation(const QLocale &locale) +{ + auto *qtTranslator = QCoreApplication::instance()->findChild("QtTr"); + auto *quasselTranslator = QCoreApplication::instance()->findChild("QuasselTr"); + + if (qtTranslator) + qApp->removeTranslator(qtTranslator); + if (quasselTranslator) + qApp->removeTranslator(quasselTranslator); + + // We use QLocale::C to indicate that we don't want a translation + if (locale.language() == QLocale::C) + return; + qtTranslator = new QTranslator(qApp); qtTranslator->setObjectName("QtTr"); - qApp->installTranslator(qtTranslator); - } - if(!quasselTranslator) { + quasselTranslator = new QTranslator(qApp); quasselTranslator->setObjectName("QuasselTr"); + +#ifndef Q_OS_MAC + bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath()); + if (!success) + qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath)); + quasselTranslator->load(locale, QString(""), translationDirPath()); +#else + bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath()); + if (!success) + qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath)); + quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath()); +#endif + qApp->installTranslator(quasselTranslator); - } + qApp->installTranslator(qtTranslator); +} + + +// ---- Quassel::Features --------------------------------------------------------------------------------------------- + +Quassel::Features::Features() +{ + QStringList features; + + // TODO Qt5: Use QMetaEnum::fromType() + auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature")); + _features.resize(featureEnum.keyCount(), true); // enable all known features to true +} + + +Quassel::Features::Features(const QStringList &features, LegacyFeatures legacyFeatures) +{ + // TODO Qt5: Use QMetaEnum::fromType() + auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature")); + _features.resize(featureEnum.keyCount(), false); + + for (auto &&feature : features) { + int i = featureEnum.keyToValue(qPrintable(feature)); + if (i >= 0) { + _features[i] = true; + } + else { + _unknownFeatures << feature; + } + } - QLocale::setDefault(locale); + if (legacyFeatures) { + // TODO Qt5: Use QMetaEnum::fromType() + auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature")); + for (quint32 mask = 0x0001; mask <= 0x8000; mask <<=1) { + if (static_cast(legacyFeatures) & mask) { + int i = featureEnum.keyToValue(legacyFeatureEnum.valueToKey(mask)); + if (i >= 0) { + _features[i] = true; + } + } + } + } +} + + +bool Quassel::Features::isEnabled(Feature feature) const +{ + auto i = static_cast(feature); + return i < _features.size() ? _features[i] : false; +} + + +QStringList Quassel::Features::toStringList(bool enabled) const +{ + // Check if any feature is enabled + if (!enabled && std::all_of(_features.cbegin(), _features.cend(), [](bool feature) { return !feature; })) { + return QStringList{} << "NoFeatures"; + } + + QStringList result; + + // TODO Qt5: Use QMetaEnum::fromType() + auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature")); + for (quint32 i = 0; i < _features.size(); ++i) { + if (_features[i] == enabled) { + result << featureEnum.key(i); + } + } + return result; +} + + +Quassel::LegacyFeatures Quassel::Features::toLegacyFeatures() const +{ + // TODO Qt5: Use LegacyFeatures (flag operators for enum classes not supported in Qt4) + quint32 result{0}; + // TODO Qt5: Use QMetaEnum::fromType() + auto featureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("Feature")); + auto legacyFeatureEnum = Quassel::staticMetaObject.enumerator(Quassel::staticMetaObject.indexOfEnumerator("LegacyFeature")); + + for (quint32 i = 0; i < _features.size(); ++i) { + if (_features[i]) { + int v = legacyFeatureEnum.keyToValue(featureEnum.key(i)); + if (v >= 0) { + result |= v; + } + } + } + return static_cast(result); +} - if(locale.language() == QLocale::C) - return; - bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath()); - if(!success) - qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath)); - quasselTranslator->load(QString("quassel_%1").arg(locale.name()), translationDirPath()); +QStringList Quassel::Features::unknownFeatures() const +{ + return _unknownFeatures; }