Save Core settings synchronously and report errors.
[quassel.git] / src / common / settings.cpp
index 6f2ba0f..cdb152c 100644 (file)
@@ -1,11 +1,11 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by The Quassel Team                             *
+ *   Copyright (C) 2005-2016 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   (at your option) version 3.                                           *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  *   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 <QStringList>
+
 #include "settings.h"
 
+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<QString, QVariant> Settings::settingsCache;
+QHash<QString, SettingsChangeNotifier *> Settings::settingsChangeNotifier;
+
+#ifdef Q_OS_MAC
+#  define create_qsettings QSettings s(QCoreApplication::organizationDomain(), appName)
+#else
+#  define create_qsettings QSettings s(fileName(), format())
+#endif
+
+// Settings::Settings(QString group_, QString appName_)
+//   : group(group_),
+//     appName(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)
+{
+    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;
+}
+
 
-Settings *settings;
+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;
+    }
+}
 
 
-void Settings::init() {
-  curProfile = QObject::tr("Default");
+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);
 }
-/*
-Settings::~Settings() {
-  qDebug() << "destructing";
 
+bool Settings::sync() {
+    create_qsettings;
+    s.sync();
+    switch (s.status()) {
+        case QSettings::NoError:
+            return true;
+        default:
+            return false;
+    }
 }
-*/
 
-void Settings::setProfile(const QString &profile) {
-  curProfile = profile;
+bool Settings::isWritable() {
+    create_qsettings;
+    return s.isWritable();
 }
 
-void Settings::setGuiValue(const QString &key, const QVariant &value) {
-  QSettings s;
-  //s.setValue("GUI/Default/BufferStates/QuakeNet/#quassel/voicedExpanded", true);
-  //QString k = QString("GUI/%1/%2").arg(curProfile).arg(key);
-  s.setValue(QString("GUI/%1/%2").arg(curProfile).arg(key), value);
+QStringList Settings::allLocalKeys()
+{
+    create_qsettings;
+    s.beginGroup(group);
+    QStringList res = s.allKeys();
+    s.endGroup();
+    return res;
 }
 
-QVariant Settings::guiValue(const QString &key, const QVariant &defaultValue) {
-  QSettings s;
-  return s.value(QString("GUI/%1/%2").arg(curProfile).arg(key), defaultValue);
+
+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::setCoreValue(const QString &user, const QString &key, const QVariant &value) {
-  QSettings s;
-  s.setValue(QString("Core/%1/%2").arg(user).arg(key), value);
+
+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;
 }
 
-QVariant Settings::coreValue(const QString &user, const QString &key, const QVariant &defaultValue) {
-  QSettings s;
-  return s.value(QString("Core/%1/%2").arg(user).arg(key), defaultValue);
+
+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);
+    }
 }
 
-QString Settings::curProfile;
+
+const QVariant &Settings::localValue(const QString &key, const QVariant &def)
+{
+    QString normKey = normalizedKey(group, key);
+    if (!isCached(normKey)) {
+        create_qsettings;
+        setCacheValue(normKey, s.value(normKey, def));
+    }
+    return cacheValue(normKey);
+}
+
+bool Settings::localKeyExists(const QString &key)
+{
+    QString normKey = normalizedKey(group, key);
+    if (isCached(normKey))
+        return true;
+
+    create_qsettings;
+    return s.contains(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);
+}