X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsettings.cpp;h=f157d357184345967f0526043bdaaef855f234ee;hp=eb4fc72a7241ae3947b540a4d284a690159f0eb2;hb=2c8434f74c68194d56f2084f637419123e61d18b;hpb=a1d785ae12b3ec04b43e243f3397bb6f8ecf60d5 diff --git a/src/common/settings.cpp b/src/common/settings.cpp index eb4fc72a..f157d357 100644 --- a/src/common/settings.cpp +++ b/src/common/settings.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-08 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,110 +15,288 @@ * 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 -#include #include -#include - -#ifdef Q_WS_QWS -#include -#endif #include "settings.h" -static QHash > __settingsCache__; +const int VERSION = 1; /// Settings version for backwords/forwards incompatible changes + +// 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 -Settings::Settings(QString g, QString applicationName) +QHash Settings::_settingsCache; +QHash Settings::_settingsKeyPersistedCache; +QHash> Settings::_settingsChangeNotifier; -#ifdef Q_WS_MAC - : QSettings(QCoreApplication::organizationDomain(), applicationName), +#ifdef Q_OS_MAC +# define create_qsettings QSettings s(QCoreApplication::organizationDomain(), _appName) #else - : QSettings(QCoreApplication::organizationName(), applicationName), +# define create_qsettings QSettings s(fileName(), format()) #endif - group(g) + +Settings::Settings(QString group, QString appName) + : _group(std::move(group)), _appName(std::move(appName)) +{} + + +void Settings::setGroup(QString group) { + _group = std::move(group); +} + + +QString Settings::keyForNotify(const QString &key) const +{ + return key; +} + + +uint Settings::version() const +{ + // we don't cache this value, and we ignore the group + create_qsettings; + uint ver = s.value("Config/Version", 0).toUInt(); + if (!ver) { + // No version, so create one + s.setValue("Config/Version", VERSION); + return 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(); -/* we need to call the constructor immediately in order to set the path... -#ifndef Q_WS_QWS - QSettings(QCoreApplication::organizationName(), applicationName); + // 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; + // Set the value directly. + s.setValue("Config/VersionMinor", versionMinor); +} + + +QSettings::Format Settings::format() const +{ +#ifdef Q_OS_WIN + return QSettings::IniFormat; #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); - } + return QSettings::NativeFormat; #endif -*/ } -QStringList Settings::allLocalKeys() { - beginGroup(group); - QStringList res = allKeys(); - endGroup(); - return res; + +bool Settings::sync() +{ + create_qsettings; + s.sync(); + switch (s.status()) { + case QSettings::NoError: + return true; + default: + return false; + } } -QStringList Settings::localChildKeys(const QString &rootkey) { - QString g; - if(rootkey.isEmpty()) g = group; - else g = QString("%1/%2").arg(group, rootkey); - beginGroup(g); - QStringList res = childKeys(); - endGroup(); - return res; + +bool Settings::isWritable() const +{ + create_qsettings; + return s.isWritable(); } -QStringList Settings::localChildGroups(const QString &rootkey) { - QString g; - if(rootkey.isEmpty()) g = group; - else g = QString("%1/%2").arg(group, rootkey); - beginGroup(g); - QStringList res = childGroups(); - endGroup(); - return res; + +QStringList Settings::allLocalKeys() const +{ + create_qsettings; + s.beginGroup(_group); + QStringList res = s.allKeys(); + s.endGroup(); + return res; } -void Settings::setLocalValue(const QString &key, const QVariant &data) { - beginGroup(group); - setValue(key, data); - setCacheValue(group, key, data); - endGroup(); + +QStringList Settings::localChildKeys(const QString &rootkey) const +{ + QString g; + if (rootkey.isEmpty()) + g = _group; + else + g = QString("%1/%2").arg(_group, rootkey); + + create_qsettings; + s.beginGroup(g); + QStringList res = s.childKeys(); + s.endGroup(); + return res; } -const QVariant &Settings::localValue(const QString &key, const QVariant &def) { - if(!isCached(group, key)) { - beginGroup(group); - setCacheValue(group, key, value(key, def)); - endGroup(); - } - return cacheValue(group, key); + +QStringList Settings::localChildGroups(const QString &rootkey) const +{ + QString g; + if (rootkey.isEmpty()) + g = _group; + else + g = QString("%1/%2").arg(_group, rootkey); + + create_qsettings; + s.beginGroup(g); + QStringList res = s.childGroups(); + s.endGroup(); + return res; } -void Settings::removeLocalKey(const QString &key) { - beginGroup(group); - remove(key); - endGroup(); + +void Settings::setLocalValue(const QString &key, const QVariant &data) +{ + 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); + } } -void Settings::setCacheValue(const QString &group, const QString &key, const QVariant &data) { - ::__settingsCache__[group][key] = data; +QVariant Settings::localValue(const QString &key, const QVariant &def) const +{ + 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)); + } + 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; } -const QVariant &Settings::cacheValue(const QString &group, const QString &key) { - return ::__settingsCache__[group][key]; + +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); } -bool Settings::isCached(const QString &group, const QString &key) { - return ::__settingsCache__.contains(group) && ::__settingsCache__[group].contains(key); + +void Settings::removeLocalKey(const QString &key) +{ + create_qsettings; + s.beginGroup(_group); + s.remove(key); + s.endGroup(); + 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); }