X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsettings.cpp;h=1fbe04aeca130c82f57cd8dd42e709d24580e565;hp=4363f09116c803fc5f5bf55a08fed3c198f56db3;hb=52209badc8e769e50aa3019b63689dda0e79e9d0;hpb=b65b9f7615165e8700a44d59b7275a55558dd45b diff --git a/src/common/settings.cpp b/src/common/settings.cpp index 4363f091..1fbe04ae 100644 --- a/src/common/settings.cpp +++ b/src/common/settings.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2015 by the Quassel Project * + * Copyright (C) 2005-2019 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -18,61 +18,43 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ +#include "settings.h" + #include -#include "settings.h" +const int VERSION = 1; /// Settings version for backwords/forwards incompatible changes -const int VERSION = 1; +// This is used if no VersionMinor key exists, e.g. upgrading from a Quassel version before this +// change. This shouldn't be increased from 1; instead, change the logic in Core::Core() and +// QtUiApplication::init() to handle upgrading and downgrading. +const int VERSION_MINOR_INITIAL = 1; /// Initial settings version for compatible changes -QHash Settings::settingsCache; -QHash Settings::settingsChangeNotifier; +QHash Settings::_settingsCache; +QHash Settings::_settingsKeyPersistedCache; +QHash> Settings::_settingsChangeNotifier; #ifdef Q_OS_MAC -# define create_qsettings QSettings s(QCoreApplication::organizationDomain(), appName) +# define create_qsettings QSettings s(QCoreApplication::organizationDomain(), _appName) #else -# define create_qsettings QSettings s(fileName(), format()) +# define create_qsettings QSettings s(fileName(), format()) #endif -// Settings::Settings(QString group_, QString appName_) -// : group(group_), -// appName(appName_) -// { +Settings::Settings(QString group, QString appName) + : _group(std::move(group)) + , _appName(std::move(appName)) +{} -// /* we need to call the constructor immediately in order to set the path... -// #ifndef Q_WS_QWS -// QSettings(QCoreApplication::organizationName(), applicationName); -// #else -// // FIXME sandboxDir() is not currently working correctly... -// //if(Qtopia::sandboxDir().isEmpty()) QSettings(); -// //else QSettings(Qtopia::sandboxDir() + "/etc/QuasselIRC.conf", QSettings::NativeFormat); -// // ...so we have to use a workaround: -// QString appPath = QCoreApplication::applicationFilePath(); -// if(appPath.startsWith(Qtopia::packagePath())) { -// QString sandboxPath = appPath.left(Qtopia::packagePath().length() + 32); -// QSettings(sandboxPath + "/etc/QuasselIRC.conf", QSettings::IniFormat); -// qDebug() << sandboxPath + "/etc/QuasselIRC.conf"; -// } else { -// QSettings(QCoreApplication::organizationName(), applicationName); -// } -// #endif -// */ -// } - -void Settings::notify(const QString &key, QObject *receiver, const char *slot) +void Settings::setGroup(QString group) { - QObject::connect(notifier(normalizedKey(group, key)), SIGNAL(valueChanged(const QVariant &)), - receiver, slot); + _group = std::move(group); } - -void Settings::initAndNotify(const QString &key, QObject *receiver, const char *slot, const QVariant &defaultValue) +QString Settings::keyForNotify(const QString& key) const { - notify(key, receiver, slot); - emit notifier(normalizedKey(group, key))->valueChanged(localValue(key, defaultValue)); + return key; } - -uint Settings::version() +uint Settings::version() const { // we don't cache this value, and we ignore the group create_qsettings; @@ -85,24 +67,79 @@ uint Settings::version() return ver; } +uint Settings::versionMinor() const +{ + // Don't cache this value; ignore the group + create_qsettings; + // '0' means new configuration, anything else indicates an existing configuration. Application + // initialization should check this value and manage upgrades/downgrades, e.g. in Core::Core() + // and QtUiApplication::init(). + uint verMinor = s.value("Config/VersionMinor", 0).toUInt(); -QStringList Settings::allLocalKeys() + // As previous Quassel versions didn't implement this, we need to check if any settings other + // than Config/Version exist. If so, assume it's version 1. + if (verMinor == 0 && s.allKeys().count() > 1) { + // More than 1 key exists, but version's never been set. Assume and set version 1. + // const_cast is ok, because setVersionMinor() doesn't actually change this instance + const_cast(this)->setVersionMinor(VERSION_MINOR_INITIAL); + return VERSION_MINOR_INITIAL; + } + else { + return verMinor; + } +} + +void Settings::setVersionMinor(const uint versionMinor) { + // Don't cache this value; ignore the group create_qsettings; - s.beginGroup(group); + // Set the value directly. + s.setValue("Config/VersionMinor", versionMinor); +} + +QSettings::Format Settings::format() const +{ +#ifdef Q_OS_WIN + return QSettings::IniFormat; +#else + return QSettings::NativeFormat; +#endif +} + +bool Settings::sync() +{ + create_qsettings; + s.sync(); + switch (s.status()) { + case QSettings::NoError: + return true; + default: + return false; + } +} + +bool Settings::isWritable() const +{ + create_qsettings; + return s.isWritable(); +} + +QStringList Settings::allLocalKeys() const +{ + create_qsettings; + s.beginGroup(_group); QStringList res = s.allKeys(); s.endGroup(); return res; } - -QStringList Settings::localChildKeys(const QString &rootkey) +QStringList Settings::localChildKeys(const QString& rootkey) const { QString g; if (rootkey.isEmpty()) - g = group; + g = _group; else - g = QString("%1/%2").arg(group, rootkey); + g = QString("%1/%2").arg(_group, rootkey); create_qsettings; s.beginGroup(g); @@ -111,14 +148,13 @@ QStringList Settings::localChildKeys(const QString &rootkey) return res; } - -QStringList Settings::localChildGroups(const QString &rootkey) +QStringList Settings::localChildGroups(const QString& rootkey) const { QString g; if (rootkey.isEmpty()) - g = group; + g = _group; else - g = QString("%1/%2").arg(group, rootkey); + g = QString("%1/%2").arg(_group, rootkey); create_qsettings; s.beginGroup(g); @@ -127,37 +163,117 @@ QStringList Settings::localChildGroups(const QString &rootkey) return res; } - -void Settings::setLocalValue(const QString &key, const QVariant &data) +void Settings::setLocalValue(const QString& key, const QVariant& data) { - QString normKey = normalizedKey(group, key); + QString normKey = normalizedKey(_group, key); create_qsettings; s.setValue(normKey, data); + setCacheKeyPersisted(normKey, true); setCacheValue(normKey, data); if (hasNotifier(normKey)) { emit notifier(normKey)->valueChanged(data); } } - -const QVariant &Settings::localValue(const QString &key, const QVariant &def) +QVariant Settings::localValue(const QString& key, const QVariant& def) const { - QString normKey = normalizedKey(group, key); + QString normKey = normalizedKey(_group, key); if (!isCached(normKey)) { create_qsettings; + // Since we're loading from settings anyways, cache whether or not the key exists on disk + setCacheKeyPersisted(normKey, s.contains(normKey)); + // Cache key value setCacheValue(normKey, s.value(normKey, def)); } - return cacheValue(normKey); + if (cacheKeyPersisted(normKey)) { + return cacheValue(normKey); + } + // Don't return possibly wrong cached values + // A key gets cached with the first default value requested and never changes afterwards + return def; } +bool Settings::localKeyExists(const QString& key) const +{ + QString normKey = normalizedKey(_group, key); + if (!isKeyPersistedCached(normKey)) { + create_qsettings; + // Cache whether or not key exists on disk + // We can't cache key value as we don't know the default + setCacheKeyPersisted(normKey, s.contains(normKey)); + } + + return cacheKeyPersisted(normKey); +} -void Settings::removeLocalKey(const QString &key) +void Settings::removeLocalKey(const QString& key) { create_qsettings; - s.beginGroup(group); + s.beginGroup(_group); s.remove(key); s.endGroup(); - QString normKey = normalizedKey(group, key); - if (isCached(normKey)) - settingsCache.remove(normKey); + QString normKey = normalizedKey(_group, key); + if (isCached(normKey)) { + _settingsCache.remove(normKey); + } + if (isKeyPersistedCached(normKey)) { + _settingsKeyPersistedCache.remove(normKey); + } + if (hasNotifier(normKey)) { + emit notifier(normKey)->valueChanged({}); + } +} + +QString Settings::fileName() const +{ + return Quassel::configDirPath() + _appName + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini")); +} + +QString Settings::normalizedKey(const QString& group, const QString& key) const +{ + if (group.isEmpty()) + return key; + return group + '/' + key; +} + +void Settings::setCacheKeyPersisted(const QString& normKey, bool exists) const +{ + _settingsKeyPersistedCache[normKey] = exists; +} + +bool Settings::cacheKeyPersisted(const QString& normKey) const +{ + return _settingsKeyPersistedCache[normKey]; +} + +bool Settings::isKeyPersistedCached(const QString& normKey) const +{ + return _settingsKeyPersistedCache.contains(normKey); +} + +void Settings::setCacheValue(const QString& normKey, const QVariant& data) const +{ + _settingsCache[normKey] = data; +} + +QVariant Settings::cacheValue(const QString& normKey) const +{ + return _settingsCache[normKey]; +} + +bool Settings::isCached(const QString& normKey) const +{ + return _settingsCache.contains(normKey); +} + +SettingsChangeNotifier* Settings::notifier(const QString& normKey) const +{ + if (!hasNotifier(normKey)) + _settingsChangeNotifier[normKey] = std::make_shared(); + return _settingsChangeNotifier[normKey].get(); +} + +bool Settings::hasNotifier(const QString& normKey) const +{ + return _settingsChangeNotifier.contains(normKey); }