X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsettings.cpp;h=2330f45fed49934ce1e0eb78e770aecefb36d476;hp=2731da26a7f5087e9ac6143f0967ffea6b4a5367;hb=8582c2ad5708a1972c85bea1cf8d81ad3ece4814;hpb=adda0fa0aeef6087045256b250ff30c88ee7dc00 diff --git a/src/common/settings.cpp b/src/common/settings.cpp index 2731da26..2330f45f 100644 --- a/src/common/settings.cpp +++ b/src/common/settings.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,19 +15,25 @@ * 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 "settings.h" -const int VERSION = 1; +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 QHash Settings::settingsCache; +QHash Settings::settingsKeyPersistedCache; QHash Settings::settingsChangeNotifier; -#ifdef Q_WS_MAC +#ifdef Q_OS_MAC # define create_qsettings QSettings s(QCoreApplication::organizationDomain(), appName) #else # define create_qsettings QSettings s(fileName(), format()) @@ -58,84 +64,185 @@ QHash Settings::settingsChangeNotifier; // */ // } -void Settings::notify(const QString &key, QObject *receiver, const char *slot) { - QObject::connect(notifier(normalizedKey(group, key)), SIGNAL(valueChanged(const QVariant &)), - receiver, slot); +void Settings::notify(const QString &key, QObject *receiver, const char *slot) +{ + QObject::connect(notifier(normalizedKey(group, key)), SIGNAL(valueChanged(const QVariant &)), + receiver, slot); +} + + +void Settings::initAndNotify(const QString &key, QObject *receiver, const char *slot, const QVariant &defaultValue) +{ + notify(key, receiver, slot); + emit notifier(normalizedKey(group, key))->valueChanged(localValue(key, defaultValue)); +} + + +uint Settings::version() +{ + // 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::version() { - // 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() +{ + // 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(); + + // 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. + setVersionMinor(VERSION_MINOR_INITIAL); + return VERSION_MINOR_INITIAL; + } else { + return verMinor; + } } -QStringList Settings::allLocalKeys() { - create_qsettings; - s.beginGroup(group); - QStringList res = s.allKeys(); - s.endGroup(); - return res; + +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); +} + + +bool Settings::sync() { + create_qsettings; + s.sync(); + switch (s.status()) { + case QSettings::NoError: + return true; + default: + return false; + } +} + + +bool Settings::isWritable() { + create_qsettings; + return s.isWritable(); } -QStringList Settings::localChildKeys(const QString &rootkey) { - 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; + +QStringList Settings::allLocalKeys() +{ + create_qsettings; + s.beginGroup(group); + QStringList res = s.allKeys(); + s.endGroup(); + return res; } -QStringList Settings::localChildGroups(const QString &rootkey) { - 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; + +QStringList Settings::localChildKeys(const QString &rootkey) +{ + 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; } -void Settings::setLocalValue(const QString &key, const QVariant &data) { - QString normKey = normalizedKey(group, key); - create_qsettings; - s.setValue(normKey, data); - setCacheValue(normKey, data); - if(hasNotifier(normKey)) { - emit notifier(normKey)->valueChanged(data); - } + +QStringList Settings::localChildGroups(const QString &rootkey) +{ + 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; } -const QVariant &Settings::localValue(const QString &key, const QVariant &def) { - QString normKey = normalizedKey(group, key); - if(!isCached(normKey)) { + +void Settings::setLocalValue(const QString &key, const QVariant &data) +{ + QString normKey = normalizedKey(group, key); create_qsettings; - setCacheValue(normKey, s.value(normKey, def)); - } - return cacheValue(normKey); + s.setValue(normKey, data); + setCacheKeyPersisted(normKey, true); + setCacheValue(normKey, data); + if (hasNotifier(normKey)) { + emit notifier(normKey)->valueChanged(data); + } } -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); + +QVariant Settings::localValue(const QString &key, const QVariant &def) +{ + 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); + } else { + // 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) +{ + 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) +{ + 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({}); + } }