summaryrefslogtreecommitdiffstats
path: root/depends/settings
diff options
context:
space:
mode:
authorPetr Mrázek <peterix@gmail.com>2013-08-17 13:40:51 +0200
committerPetr Mrázek <peterix@gmail.com>2013-08-17 13:40:51 +0200
commit253067c782955380bbf66ac0475dc954375b1ff4 (patch)
treeca97e231fd3a764256d95b5fc8d08fc25ff72161 /depends/settings
parent77e80665422c4e97e2286418ab55e20c4030023b (diff)
downloadMultiMC-253067c782955380bbf66ac0475dc954375b1ff4.tar
MultiMC-253067c782955380bbf66ac0475dc954375b1ff4.tar.gz
MultiMC-253067c782955380bbf66ac0475dc954375b1ff4.tar.lz
MultiMC-253067c782955380bbf66ac0475dc954375b1ff4.tar.xz
MultiMC-253067c782955380bbf66ac0475dc954375b1ff4.zip
Move all the things (YES. Move them.)
Also, implemented some basic modlist logic, to be wired up.
Diffstat (limited to 'depends/settings')
-rw-r--r--depends/settings/CMakeLists.txt51
-rw-r--r--depends/settings/include/basicsettingsobject.h44
-rw-r--r--depends/settings/include/inifile.h38
-rw-r--r--depends/settings/include/inisettingsobject.h60
-rw-r--r--depends/settings/include/keyring.h92
-rw-r--r--depends/settings/include/libsettings_config.h27
-rw-r--r--depends/settings/include/overridesetting.h43
-rw-r--r--depends/settings/include/setting.h114
-rw-r--r--depends/settings/include/settingsobject.h192
-rw-r--r--depends/settings/src/basicsettingsobject.cpp46
-rw-r--r--depends/settings/src/inifile.cpp86
-rw-r--r--depends/settings/src/inisettingsobject.cpp62
-rw-r--r--depends/settings/src/keyring.cpp63
-rw-r--r--depends/settings/src/overridesetting.cpp30
-rw-r--r--depends/settings/src/setting.cpp54
-rw-r--r--depends/settings/src/settingsobject.cpp144
-rw-r--r--depends/settings/src/stubkeyring.cpp104
-rw-r--r--depends/settings/src/stubkeyring.h41
18 files changed, 1291 insertions, 0 deletions
diff --git a/depends/settings/CMakeLists.txt b/depends/settings/CMakeLists.txt
new file mode 100644
index 00000000..e5aae0b7
--- /dev/null
+++ b/depends/settings/CMakeLists.txt
@@ -0,0 +1,51 @@
+project(libSettings)
+
+# Find Qt
+find_package(Qt5Core REQUIRED)
+
+# Include Qt headers.
+include_directories(${Qt5Base_INCLUDE_DIRS})
+include_directories(${Qt5Network_INCLUDE_DIRS})
+
+SET(LIBSETTINGS_HEADERS
+include/libsettings_config.h
+
+include/inifile.h
+
+include/settingsobject.h
+include/setting.h
+include/overridesetting.h
+
+include/basicsettingsobject.h
+include/inisettingsobject.h
+
+include/keyring.h
+)
+
+SET(LIBSETTINGS_HEADERS_PRIVATE
+src/stubkeyring.h
+)
+
+SET(LIBSETTINGS_SOURCES
+src/inifile.cpp
+
+src/settingsobject.cpp
+src/setting.cpp
+src/overridesetting.cpp
+
+src/basicsettingsobject.cpp
+src/inisettingsobject.cpp
+
+src/keyring.cpp
+src/stubkeyring.cpp
+)
+
+# Set the include dir path.
+SET(LIBSETTINGS_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include" PARENT_SCOPE)
+include_directories(${LIBSETTINGS_INCLUDE_DIR})
+
+add_definitions(-DLIBSETTINGS_LIBRARY)
+
+add_library(libSettings SHARED ${LIBSETTINGS_SOURCES} ${LIBSETTINGS_HEADERS} ${LIBSETTINGS_HEADERS_PRIVATE})
+qt5_use_modules(libSettings Core)
+target_link_libraries(libSettings)
diff --git a/depends/settings/include/basicsettingsobject.h b/depends/settings/include/basicsettingsobject.h
new file mode 100644
index 00000000..b7e5851d
--- /dev/null
+++ b/depends/settings/include/basicsettingsobject.h
@@ -0,0 +1,44 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef BASICSETTINGSOBJECT_H
+#define BASICSETTINGSOBJECT_H
+
+#include <QObject>
+#include <QSettings>
+
+#include "settingsobject.h"
+
+#include "libsettings_config.h"
+
+/*!
+ * \brief A settings object that stores its settings in a QSettings object.
+ */
+class LIBSETTINGS_EXPORT BasicSettingsObject : public SettingsObject
+{
+ Q_OBJECT
+public:
+ explicit BasicSettingsObject(QObject *parent = 0);
+
+protected slots:
+ virtual void changeSetting(const Setting &setting, QVariant value);
+
+protected:
+ virtual QVariant retrieveValue(const Setting &setting);
+
+ QSettings config;
+};
+
+#endif // BASICSETTINGSOBJECT_H
diff --git a/depends/settings/include/inifile.h b/depends/settings/include/inifile.h
new file mode 100644
index 00000000..94467832
--- /dev/null
+++ b/depends/settings/include/inifile.h
@@ -0,0 +1,38 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef INIFILE_H
+#define INIFILE_H
+
+#include <QMap>
+#include <QString>
+#include <QVariant>
+
+#include "libsettings_config.h"
+
+// Sectionless INI parser (for instance config files)
+class LIBSETTINGS_EXPORT INIFile : public QMap<QString, QVariant>
+{
+public:
+ explicit INIFile();
+
+ bool loadFile(QString fileName);
+ bool saveFile(QString fileName);
+
+ QVariant get(QString key, QVariant def) const;
+ void set(QString key, QVariant val);
+};
+
+#endif // INIFILE_H
diff --git a/depends/settings/include/inisettingsobject.h b/depends/settings/include/inisettingsobject.h
new file mode 100644
index 00000000..03d6fe05
--- /dev/null
+++ b/depends/settings/include/inisettingsobject.h
@@ -0,0 +1,60 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef INISETTINGSOBJECT_H
+#define INISETTINGSOBJECT_H
+
+#include <QObject>
+
+#include "inifile.h"
+
+#include "settingsobject.h"
+
+#include "libutil_config.h"
+
+/*!
+ * \brief A settings object that stores its settings in an INIFile.
+ */
+class LIBSETTINGS_EXPORT INISettingsObject : public SettingsObject
+{
+ Q_OBJECT
+public:
+ explicit INISettingsObject(const QString &path, QObject *parent = 0);
+
+ /*!
+ * \brief Gets the path to the INI file.
+ * \return The path to the INI file.
+ */
+ virtual QString filePath() const { return m_filePath; }
+
+ /*!
+ * \brief Sets the path to the INI file and reloads it.
+ * \param filePath The INI file's new path.
+ */
+ virtual void setFilePath(const QString &filePath);
+
+protected slots:
+ virtual void changeSetting(const Setting &setting, QVariant value);
+ virtual void resetSetting ( const Setting& setting );
+
+protected:
+ virtual QVariant retrieveValue(const Setting &setting);
+
+ INIFile m_ini;
+
+ QString m_filePath;
+};
+
+#endif // INISETTINGSOBJECT_H
diff --git a/depends/settings/include/keyring.h b/depends/settings/include/keyring.h
new file mode 100644
index 00000000..299b14b0
--- /dev/null
+++ b/depends/settings/include/keyring.h
@@ -0,0 +1,92 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Authors: Orochimarufan <orochimarufan.x3@gmail.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef KEYRING_H
+#define KEYRING_H
+
+#include <QString>
+
+#include "libsettings_config.h"
+
+/**
+ * @file libsettings/include/keyring.h
+ * Access to System Keyrings
+ */
+
+/**
+ * @brief The Keyring class
+ * the System Keyring/Keychain/Wallet/Vault/etc
+ */
+class LIBSETTINGS_EXPORT Keyring
+{
+public:
+ /**
+ * @brief the System Keyring instance
+ * @return the Keyring instance
+ */
+ static Keyring *instance();
+
+ /**
+ * @brief store a password in the Keyring
+ * @param service the service name
+ * @param username the account name
+ * @param password the password to store
+ * @return success
+ */
+ virtual bool storePassword(QString service, QString username, QString password) = 0;
+
+ /**
+ * @brief get a password from the Keyring
+ * @param service the service name
+ * @param username the account name
+ * @return the password (success=!isNull())
+ */
+ virtual QString getPassword(QString service, QString username) = 0;
+
+ /**
+ * @brief lookup a password
+ * @param service the service name
+ * @param username the account name
+ * @return wether the password is available
+ */
+ virtual bool hasPassword(QString service, QString username) = 0;
+
+ /**
+ * @brief get a list of all stored accounts.
+ * @param service the service name
+ * @return
+ */
+ virtual QStringList getStoredAccounts(QString service) = 0;
+
+ /**
+ * @brief Remove the specified account from storage
+ * @param service the service name
+ * @param username the account name
+ * @return
+ */
+ virtual void removeStoredAccount(QString service, QString username) = 0;
+
+protected:
+ /// fall back to StubKeyring if false
+ virtual bool isValid() { return false; }
+
+private:
+ static Keyring *m_instance;
+ static void destroy();
+};
+
+#endif // KEYRING_H
diff --git a/depends/settings/include/libsettings_config.h b/depends/settings/include/libsettings_config.h
new file mode 100644
index 00000000..dc8e6228
--- /dev/null
+++ b/depends/settings/include/libsettings_config.h
@@ -0,0 +1,27 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef LIBINSTANCE_CONFIG_H
+#define LIBINSTANCE_CONFIG_H
+
+#include <QtCore/QtGlobal>
+
+#ifdef LIBSETTINGS_LIBRARY
+# define LIBSETTINGS_EXPORT Q_DECL_EXPORT
+#else
+# define LIBSETTINGS_EXPORT Q_DECL_IMPORT
+#endif
+
+#endif // LIBINSTANCE_CONFIG_H
diff --git a/depends/settings/include/overridesetting.h b/depends/settings/include/overridesetting.h
new file mode 100644
index 00000000..58bb6d40
--- /dev/null
+++ b/depends/settings/include/overridesetting.h
@@ -0,0 +1,43 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef OVERRIDESETTING_H
+#define OVERRIDESETTING_H
+
+#include <QObject>
+
+#include "setting.h"
+
+#include "libsettings_config.h"
+
+/*!
+ * \brief A setting that 'overrides another.'
+ * This means that the setting's default value will be the value of another setting.
+ * The other setting can be (and usually is) a part of a different SettingsObject
+ * than this one.
+ */
+class LIBSETTINGS_EXPORT OverrideSetting : public Setting
+{
+ Q_OBJECT
+public:
+ explicit OverrideSetting(const QString &name, Setting *other, QObject *parent = 0);
+
+ virtual QVariant defValue() const;
+
+protected:
+ Setting *m_other;
+};
+
+#endif // OVERRIDESETTING_H
diff --git a/depends/settings/include/setting.h b/depends/settings/include/setting.h
new file mode 100644
index 00000000..a161ab50
--- /dev/null
+++ b/depends/settings/include/setting.h
@@ -0,0 +1,114 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef SETTING_H
+#define SETTING_H
+
+#include <QObject>
+#include <QVariant>
+
+#include "libsettings_config.h"
+
+class SettingsObject;
+
+/*!
+ *
+ */
+class LIBSETTINGS_EXPORT Setting : public QObject
+{
+ Q_OBJECT
+public:
+ /*!
+ * \brief Constructs a new Setting object with the given parent.
+ * \param parent The Setting's parent object.
+ */
+ explicit Setting(QString id, QVariant defVal = QVariant(), QObject *parent = 0);
+
+ /*!
+ * \brief Gets this setting's ID.
+ * This is used to refer to the setting within the application.
+ * \warning Changing the ID while the setting is registered with a SettingsObject results in undefined behavior.
+ * \return The ID of the setting.
+ */
+ virtual QString id() const { return m_id; }
+
+ /*!
+ * \brief Gets this setting's config file key.
+ * This is used to store the setting's value in the config file. It is usually
+ * the same as the setting's ID, but it can be different.
+ * \return The setting's config file key.
+ */
+ virtual QString configKey() const { return id(); }
+
+ /*!
+ * \brief Gets this setting's value as a QVariant.
+ * This is done by calling the SettingsObject's retrieveValue() function.
+ * If this Setting doesn't have a SettingsObject, this returns an invalid QVariant.
+ * \return QVariant containing this setting's value.
+ * \sa value()
+ */
+ virtual QVariant get() const;
+
+ /*!
+ * \brief Gets this setting's actual value (I.E. not as a QVariant).
+ * This function is just shorthand for get().value<T>()
+ * \return The setting's actual value.
+ */
+ template<typename T>
+ inline T value() const { return get().value<T>(); }
+
+
+ /*!
+ * \brief Gets this setting's default value.
+ * \return The default value of this setting.
+ */
+ virtual QVariant defValue() const;
+
+signals:
+ /*!
+ * \brief Signal emitted when this Setting object's value changes.
+ * \param setting A reference to the Setting that changed.
+ * \param value This Setting object's new value.
+ */
+ void settingChanged(const Setting &setting, QVariant value);
+
+ /*!
+ * \brief Signal emitted when this Setting object's value resets to default.
+ * \param setting A reference to the Setting that changed.
+ */
+ void settingReset(const Setting &setting);
+
+public slots:
+ /*!
+ * \brief Changes the setting's value.
+ * This is done by emitting the settingChanged() signal which will then be
+ * handled by the SettingsObject object and cause the setting to change.
+ * \param value The new value.
+ */
+ virtual void set(QVariant value);
+
+ /*!
+ * \brief Reset the setting to default
+ * This is done by emitting the settingReset() signal which will then be
+ * handled by the SettingsObject object and cause the setting to change.
+ * \param value The new value.
+ */
+ virtual void reset();
+protected:
+ QString m_id;
+ QVariant m_defVal;
+};
+
+#endif // SETTING_H
diff --git a/depends/settings/include/settingsobject.h b/depends/settings/include/settingsobject.h
new file mode 100644
index 00000000..a2f03699
--- /dev/null
+++ b/depends/settings/include/settingsobject.h
@@ -0,0 +1,192 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef SETTINGSOBJECT_H
+#define SETTINGSOBJECT_H
+
+#include <QObject>
+#include <QMap>
+
+#include "libsettings_config.h"
+
+class Setting;
+
+/*!
+ * \brief The SettingsObject handles communicating settings between the application and a settings file.
+ * The class keeps a list of Setting objects. Each Setting object represents one
+ * of the application's settings. These Setting objects are registered with
+ * a SettingsObject and can be managed similarly to the way a list works.
+ *
+ * \author Andrew Okin
+ * \date 2/22/2013
+ *
+ * \sa Setting
+ */
+class LIBSETTINGS_EXPORT SettingsObject : public QObject
+{
+ Q_OBJECT
+public:
+ explicit SettingsObject(QObject *parent = 0);
+
+ /*!
+ * \brief Registers the given setting with this SettingsObject and connects the necessary signals.
+ * This will fail if there is already a setting with the same ID as
+ * the one that is being registered.
+ * \note Registering a setting object causes the SettingsObject to take ownership
+ * of the object. This means that setting's parent will be set to the object
+ * it was registered with. Because the object it was registered with has taken
+ * ownership, it becomes responsible for managing that setting object's memory.
+ * \warning Do \b not delete the setting after registering it.
+ * \param setting A pointer to the setting that will be registered.
+ * \return True if successful. False if registry failed.
+ */
+ virtual bool registerSetting(Setting *setting);
+
+ /*!
+ * \brief Unregisters the given setting from this SettingsObject and disconnects its signals.
+ * \note This does not delete the setting. Furthermore, when the setting is
+ * unregistered, the SettingsObject drops ownership of the setting. This means
+ * that if you unregister a setting, its parent is set to null and you become
+ * responsible for freeing its memory.
+ * \param setting The setting to unregister.
+ */
+ virtual void unregisterSetting(Setting *setting);
+
+
+ /*!
+ * \brief Gets the setting with the given ID.
+ * \param id The ID of the setting to get.
+ * \return A pointer to the setting with the given ID.
+ * Returns null if there is no setting with the given ID.
+ * \sa operator []()
+ */
+ virtual Setting *getSetting(const QString &id) const;
+
+ /*!
+ * \brief Same as getSetting()
+ * \param id The ID of the setting to get.
+ * \return A pointer to the setting with the given ID.
+ * \sa getSetting()
+ */
+ inline Setting *operator [](const QString &id) { return getSetting(id); }
+
+
+ /*!
+ * \brief Gets the value of the setting with the given ID.
+ * \param id The ID of the setting to get.
+ * \return The setting's value as a QVariant.
+ * If no setting with the given ID exists, returns an invalid QVariant.
+ */
+ virtual QVariant get(const QString &id) const;
+
+ /*!
+ * \brief Sets the value of the setting with the given ID.
+ * If no setting with the given ID exists, returns false and logs to qDebug
+ * \param id The ID of the setting to change.
+ * \param value The new value of the setting.
+ * \return True if successful, false if it failed.
+ */
+ virtual bool set(const QString &id, QVariant value);
+
+ /*!
+ * \brief Reverts the setting with the given ID to default.
+ * \param id The ID of the setting to reset.
+ */
+ virtual void reset(const QString &id) const;
+
+ /*!
+ * \brief Gets a QList with pointers to all of the registered settings.
+ * The order of the entries in the list is undefined.
+ * \return A QList with pointers to all registered settings.
+ */
+ virtual QList<Setting *> getSettings();
+
+ /*!
+ * \brief Checks if this SettingsObject contains a setting with the given ID.
+ * \param id The ID to check for.
+ * \return True if the SettingsObject has a setting with the given ID.
+ */
+ virtual bool contains(const QString &id);
+
+signals:
+ /*!
+ * \brief Signal emitted when one of this SettingsObject object's settings changes.
+ * This is usually just connected directly to each Setting object's
+ * settingChanged() signals.
+ * \param setting A reference to the Setting object that changed.
+ * \param value The Setting object's new value.
+ */
+ void settingChanged(const Setting &setting, QVariant value);
+
+ /*!
+ * \brief Signal emitted when one of this SettingsObject object's settings resets.
+ * This is usually just connected directly to each Setting object's
+ * settingReset() signals.
+ * \param setting A reference to the Setting object that changed.
+ */
+ void settingReset(const Setting &setting);
+
+protected slots:
+ /*!
+ * \brief Changes a setting.
+ * This slot is usually connected to each Setting object's
+ * settingChanged() signal. The signal is emitted, causing this slot
+ * to update the setting's value in the config file.
+ * \param setting A reference to the Setting object that changed.
+ * \param value The setting's new value.
+ */
+ virtual void changeSetting(const Setting &setting, QVariant value) = 0;
+
+ /*!
+ * \brief Resets a setting.
+ * This slot is usually connected to each Setting object's
+ * settingReset() signal. The signal is emitted, causing this slot
+ * to update the setting's value in the config file.
+ * \param setting A reference to the Setting object that changed.
+ */
+ virtual void resetSetting(const Setting &setting) = 0;
+
+protected:
+ /*!
+ * \brief Connects the necessary signals to the given Setting.
+ * \param setting The setting to connect.
+ */
+ virtual void connectSignals(const Setting &setting);
+
+ /*!
+ * \brief Disconnects signals from the given Setting.
+ * \param setting The setting to disconnect.
+ */
+ virtual void disconnectSignals(const Setting &setting);
+
+ /*!
+ * \brief Function used by Setting objects to get their values from the SettingsObject.
+ * \param setting The
+ * \return
+ */
+ virtual QVariant retrieveValue(const Setting &setting) = 0;
+
+ friend class Setting;
+
+private:
+ QMap<QString, Setting *> m_settings;
+};
+
+/*!
+ * \brief A global settings object.
+ */
+LIBSETTINGS_EXPORT extern SettingsObject *globalSettings;
+
+#endif // SETTINGSOBJECT_H
diff --git a/depends/settings/src/basicsettingsobject.cpp b/depends/settings/src/basicsettingsobject.cpp
new file mode 100644
index 00000000..484928c8
--- /dev/null
+++ b/depends/settings/src/basicsettingsobject.cpp
@@ -0,0 +1,46 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "include/basicsettingsobject.h"
+#include "include/setting.h"
+
+BasicSettingsObject::BasicSettingsObject(QObject *parent) :
+ SettingsObject(parent)
+{
+
+}
+
+void BasicSettingsObject::changeSetting(const Setting &setting, QVariant value)
+{
+ if (contains(setting.id()))
+ {
+ if(value.isValid())
+ config.setValue(setting.configKey(), value);
+ else
+ config.remove(setting.configKey());
+ }
+}
+
+QVariant BasicSettingsObject::retrieveValue(const Setting &setting)
+{
+ if (contains(setting.id()))
+ {
+ return config.value(setting.configKey());
+ }
+ else
+ {
+ return QVariant();
+ }
+}
diff --git a/depends/settings/src/inifile.cpp b/depends/settings/src/inifile.cpp
new file mode 100644
index 00000000..43545a4a
--- /dev/null
+++ b/depends/settings/src/inifile.cpp
@@ -0,0 +1,86 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "include/inifile.h"
+
+#include <QFile>
+#include <QTextStream>
+#include <QStringList>
+
+INIFile::INIFile()
+{
+
+}
+
+bool INIFile::saveFile(QString fileName)
+{
+ // TODO Handle errors.
+ QFile file(fileName);
+ file.open(QIODevice::WriteOnly);
+ QTextStream out(&file);
+
+ for (Iterator iter = begin(); iter != end(); iter++)
+ {
+ out << iter.key() << "=" << iter.value().toString() << "\n";
+ }
+
+ return true;
+}
+
+bool INIFile::loadFile(QString fileName)
+{
+ // TODO Handle errors.
+ QFile file(fileName);
+ file.open(QIODevice::ReadOnly);
+ QTextStream in(&file);
+
+ QStringList lines = in.readAll().split('\n');
+ for (int i = 0; i < lines.count(); i++)
+ {
+ QString & lineRaw = lines[i];
+ // Ignore comments.
+ QString line = lineRaw.left(lineRaw.indexOf('#')).trimmed();
+
+ int eqPos = line.indexOf('=');
+ if(eqPos == -1)
+ continue;
+ QString key = line.left(eqPos).trimmed();
+ QString valueStr = line.right(line.length() - eqPos - 1).trimmed();
+
+ QVariant value(valueStr);
+ /*
+ QString dbg = key;
+ dbg += " = ";
+ dbg += valueStr;
+ qDebug(dbg.toLocal8Bit());
+ */
+ this->operator [](key) = value;
+ }
+
+ return true;
+}
+
+QVariant INIFile::get(QString key, QVariant def) const
+{
+ if (!this->contains(key))
+ return def;
+ else
+ return this->operator [](key);
+}
+
+void INIFile::set(QString key, QVariant val)
+{
+ this->operator [](key) = val;
+}
diff --git a/depends/settings/src/inisettingsobject.cpp b/depends/settings/src/inisettingsobject.cpp
new file mode 100644
index 00000000..854421b6
--- /dev/null
+++ b/depends/settings/src/inisettingsobject.cpp
@@ -0,0 +1,62 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "include/inisettingsobject.h"
+#include "include/setting.h"
+
+INISettingsObject::INISettingsObject(const QString &path, QObject *parent) :
+ SettingsObject(parent)
+{
+ m_filePath = path;
+ m_ini.loadFile(path);
+}
+
+void INISettingsObject::setFilePath(const QString &filePath)
+{
+ m_filePath = filePath;
+}
+
+void INISettingsObject::changeSetting(const Setting &setting, QVariant value)
+{
+ if (contains(setting.id()))
+ {
+ if(value.isValid())
+ m_ini.set(setting.configKey(), value);
+ else
+ m_ini.remove(setting.configKey());
+ m_ini.saveFile(m_filePath);
+ }
+}
+
+void INISettingsObject::resetSetting ( const Setting& setting )
+{
+ if (contains(setting.id()))
+ {
+ m_ini.remove(setting.configKey());
+ m_ini.saveFile(m_filePath);
+ }
+}
+
+QVariant INISettingsObject::retrieveValue(const Setting &setting)
+{
+ if (contains(setting.id()))
+ {
+ return m_ini.get(setting.configKey(), QVariant());
+ }
+ else
+ {
+ return QVariant();
+ }
+}
diff --git a/depends/settings/src/keyring.cpp b/depends/settings/src/keyring.cpp
new file mode 100644
index 00000000..9eaba684
--- /dev/null
+++ b/depends/settings/src/keyring.cpp
@@ -0,0 +1,63 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Authors: Orochimarufan <orochimarufan.x3@gmail.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "include/keyring.h"
+
+#include "osutils.h"
+
+#include "stubkeyring.h"
+
+// system specific keyrings
+/*#if defined(OSX)
+class OSXKeychain;
+#define KEYRING OSXKeychain
+#elif defined(LINUX)
+class XDGKeyring;
+#define KEYRING XDGKeyring
+#elif defined(WINDOWS)
+class Win32Keystore;
+#define KEYRING Win32Keystore
+#else
+#pragma message Keyrings are not supported on your os. Falling back to the insecure StubKeyring
+#endif*/
+
+Keyring *Keyring::instance()
+{
+ if (m_instance == nullptr)
+ {
+#ifdef KEYRING
+ m_instance = new KEYRING();
+ if (!m_instance->isValid())
+ {
+ qWarning("Could not create SystemKeyring! falling back to StubKeyring.");
+ m_instance = new StubKeyring();
+ }
+#else
+ qWarning("Keyrings are not supported on your OS. Fallback StubKeyring is insecure!");
+ m_instance = new StubKeyring();
+#endif
+ atexit(Keyring::destroy);
+ }
+ return m_instance;
+}
+
+void Keyring::destroy()
+{
+ delete m_instance;
+}
+
+Keyring *Keyring::m_instance;
diff --git a/depends/settings/src/overridesetting.cpp b/depends/settings/src/overridesetting.cpp
new file mode 100644
index 00000000..eafb298f
--- /dev/null
+++ b/depends/settings/src/overridesetting.cpp
@@ -0,0 +1,30 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "include/overridesetting.h"
+
+OverrideSetting::OverrideSetting(const QString &name, Setting *other, QObject *parent) :
+ Setting(name, QVariant(), parent)
+{
+ m_other = other;
+}
+
+QVariant OverrideSetting::defValue() const
+{
+ if (m_other)
+ return m_other->get();
+ else
+ return QVariant();
+}
diff --git a/depends/settings/src/setting.cpp b/depends/settings/src/setting.cpp
new file mode 100644
index 00000000..8e60af06
--- /dev/null
+++ b/depends/settings/src/setting.cpp
@@ -0,0 +1,54 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "include/setting.h"
+#include "include/settingsobject.h"
+
+Setting::Setting(QString id, QVariant defVal, QObject *parent) :
+ QObject(parent), m_id(id), m_defVal(defVal)
+{
+
+}
+
+QVariant Setting::get() const
+{
+ SettingsObject *sbase = qobject_cast<SettingsObject *>(parent());
+ if (!sbase)
+ {
+ return defValue();
+ }
+ else
+ {
+ QVariant test = sbase->retrieveValue(*this);
+ if(!test.isValid())
+ return defValue();
+ return test;
+ }
+}
+
+QVariant Setting::defValue() const
+{
+ return m_defVal;
+}
+
+void Setting::set(QVariant value)
+{
+ emit settingChanged(*this, value);
+}
+
+void Setting::reset()
+{
+ emit settingReset(*this);
+}
diff --git a/depends/settings/src/settingsobject.cpp b/depends/settings/src/settingsobject.cpp
new file mode 100644
index 00000000..bf7b8825
--- /dev/null
+++ b/depends/settings/src/settingsobject.cpp
@@ -0,0 +1,144 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "include/settingsobject.h"
+#include "include/setting.h"
+
+#include <QVariant>
+
+SettingsObject *globalSettings;
+
+SettingsObject::SettingsObject(QObject *parent) :
+ QObject(parent)
+{
+
+}
+
+bool SettingsObject::registerSetting(Setting *setting)
+{
+ // Check if setting is null or we already have a setting with the same ID.
+ if (!setting)
+ {
+ qDebug(QString("Failed to register setting. Setting is null.").
+ arg(setting->id()).toUtf8());
+ return false; // Fail
+ }
+
+ if (contains(setting->id()))
+ {
+ qDebug(QString("Failed to register setting %1. ID already exists.").
+ arg(setting->id()).toUtf8());
+ return false; // Fail
+ }
+
+ m_settings.insert(setting->id(), setting);
+ setting->setParent(this); // Take ownership.
+
+ // Connect signals.
+ connectSignals(*setting);
+
+ // qDebug(QString("Registered setting %1.").arg(setting->id()).toUtf8());
+ return true;
+}
+
+void SettingsObject::unregisterSetting(Setting *setting)
+{
+ if (!setting || !m_settings.contains(setting->id()))
+ return; // We can't unregister something that's not registered.
+
+ m_settings.remove(setting->id());
+
+ // Disconnect signals.
+ disconnectSignals(*setting);
+
+ setting->setParent(NULL); // Drop ownership.
+}
+
+
+Setting *SettingsObject::getSetting(const QString &id) const
+{
+ // Make sure there is a setting with the given ID.
+ if (!m_settings.contains(id))
+ return NULL;
+
+ return m_settings[id];
+}
+
+QVariant SettingsObject::get(const QString &id) const
+{
+ Setting *setting = getSetting(id);
+ return (setting ? setting->get() : QVariant());
+}
+
+bool SettingsObject::set(const QString &id, QVariant value)
+{
+ Setting *setting = getSetting(id);
+ if (!setting)
+ {
+ qDebug(QString("Error changing setting %1. Setting doesn't exist.").
+ arg(id).toUtf8());
+ return false;
+ }
+ else
+ {
+ setting->set(value);
+ return true;
+ }
+}
+
+void SettingsObject::reset(const QString &id) const
+{
+ Setting *setting = getSetting(id);
+ if(setting)
+ setting->reset();
+}
+
+
+QList<Setting *> SettingsObject::getSettings()
+{
+ return m_settings.values();
+}
+
+bool SettingsObject::contains(const QString &id)
+{
+ return m_settings.contains(id);
+}
+
+
+void SettingsObject::connectSignals(const Setting &setting)
+{
+ connect(&setting, SIGNAL(settingChanged(const Setting &, QVariant)),
+ SLOT(changeSetting(const Setting &, QVariant)));
+ connect(&setting, SIGNAL(settingChanged(const Setting &, QVariant)),
+ SIGNAL(settingChanged(const Setting &, QVariant)));
+
+ connect(&setting, SIGNAL(settingReset(Setting)),
+ SLOT(resetSetting(const Setting &)));
+ connect(&setting, SIGNAL(settingReset(Setting)),
+ SIGNAL(settingReset(const Setting &)));
+}
+
+void SettingsObject::disconnectSignals(const Setting &setting)
+{
+ setting.disconnect(SIGNAL(settingChanged(const Setting &, QVariant)),
+ this, SLOT(changeSetting(const Setting &, QVariant)));
+ setting.disconnect(SIGNAL(settingChanged(const Setting &, QVariant)),
+ this, SIGNAL(settingChanged(const Setting &, QVariant)));
+
+ setting.disconnect(SIGNAL(settingReset(const Setting &, QVariant)),
+ this, SLOT(resetSetting(const Setting &, QVariant)));
+ setting.disconnect(SIGNAL(settingReset(const Setting &, QVariant)),
+ this, SIGNAL(settingReset(const Setting &, QVariant)));
+}
diff --git a/depends/settings/src/stubkeyring.cpp b/depends/settings/src/stubkeyring.cpp
new file mode 100644
index 00000000..cf814d2f
--- /dev/null
+++ b/depends/settings/src/stubkeyring.cpp
@@ -0,0 +1,104 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Authors: Orochimarufan <orochimarufan.x3@gmail.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "stubkeyring.h"
+
+#include <QStringList>
+
+// Scrambling
+// this is NOT SAFE, but it's not plain either.
+int scrambler = 0x9586309;
+
+QString scramble(QString in_)
+{
+ QByteArray in = in_.toUtf8();
+ QByteArray out;
+ for (int i = 0; i<in.length(); i++)
+ out.append(in.at(i) ^ scrambler);
+ return QString::fromUtf8(out);
+}
+
+inline QString base64(QString in)
+{
+ return QString(in.toUtf8().toBase64());
+}
+inline QString unbase64(QString in)
+{
+ return QString::fromUtf8(QByteArray::fromBase64(in.toLatin1()));
+}
+
+inline QString scramble64(QString in)
+{
+ return base64(scramble(in));
+}
+inline QString unscramble64(QString in)
+{
+ return scramble(unbase64(in));
+}
+
+// StubKeyring implementation
+inline QString generateKey(QString service, QString username)
+{
+ return QString("%1/%2").arg(base64(service)).arg(scramble64(username));
+}
+
+bool StubKeyring::storePassword(QString service, QString username, QString password)
+{
+ m_settings.setValue(generateKey(service, username), scramble64(password));
+ return true;
+}
+
+QString StubKeyring::getPassword(QString service, QString username)
+{
+ QString key = generateKey(service, username);
+ if (!m_settings.contains(key))
+ return QString();
+ return unscramble64(m_settings.value(key).toString());
+}
+
+bool StubKeyring::hasPassword(QString service, QString username)
+{
+ return m_settings.contains(generateKey(service, username));
+}
+
+QStringList StubKeyring::getStoredAccounts(QString service)
+{
+ service = base64(service).append('/');
+ QStringList out;
+ QStringList in(m_settings.allKeys());
+ QStringListIterator it(in);
+ while(it.hasNext())
+ {
+ QString c = it.next();
+ if (c.startsWith(service))
+ out << unscramble64(c.mid(service.length()));
+ }
+ return out;
+}
+
+void StubKeyring::removeStoredAccount ( QString service, QString username )
+{
+ QString key = generateKey(service, username);
+ m_settings.remove(key);
+}
+
+//FIXME: this needs tweaking/changes for user account level storage
+StubKeyring::StubKeyring() :
+// m_settings(QSettings::UserScope, "Orochimarufan", "Keyring")
+ m_settings("keyring.cfg", QSettings::IniFormat)
+{
+}
diff --git a/depends/settings/src/stubkeyring.h b/depends/settings/src/stubkeyring.h
new file mode 100644
index 00000000..45791c85
--- /dev/null
+++ b/depends/settings/src/stubkeyring.h
@@ -0,0 +1,41 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Authors: Orochimarufan <orochimarufan.x3@gmail.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef STUBKEYRING_H
+#define STUBKEYRING_H
+
+#include "include/keyring.h"
+
+#include <QSettings>
+
+class StubKeyring : public Keyring
+{
+public:
+ virtual bool storePassword(QString service, QString username, QString password);
+ virtual QString getPassword(QString service, QString username);
+ virtual bool hasPassword(QString service, QString username);
+ virtual QStringList getStoredAccounts(QString service);
+ virtual void removeStoredAccount(QString service, QString username);
+private:
+ friend class Keyring;
+ explicit StubKeyring();
+ virtual bool isValid() { return true; }
+
+ QSettings m_settings;
+};
+
+#endif // STUBKEYRING_H