FIX(client): settings_version on global level

Author: Hartmnt

src/mumble/JSONSerialization.cpp

@@ -6,6 +6,7 @@
 #include "JSONSerialization.h"
 #include "Cert.h"
 #include "SettingsMacros.h"
+#include "Global.h"
 
 
 template< typename T, bool isEnum > struct SaveValueConverter {
@@ -91,11 +92,7 @@ void load(const nlohmann::json &json, const char *category, const SettingsKey &k
 	load(categoryJSON, key, variable, defaultValue, useDefault);
 }
 
-
-
 void to_json(nlohmann::json &j, const Settings &settings) {
-	j[SettingsKeys::SETTINGS_VERSION_KEY] = 1;
-
 	const Settings defaultValues;
 
 #define PROCESS(category, key, variable)                          \
@@ -172,12 +169,10 @@ void migrateSettings(nlohmann::json &json, int settingsVersion) {
 }
 
 void from_json(const nlohmann::json &j, Settings &settings) {
-	int settingsVersion = j.at(SettingsKeys::SETTINGS_VERSION_KEY).get< int >();
-
 	// Copy since we might have to make modifications
 	nlohmann::json json = j;
 
-	migrateSettings(json, settingsVersion);
+	migrateSettings(json, Global::get().profiles.settings_version);
 
 #define PROCESS(category, key, variable) \
 	load(json, #category, SettingsKeys::key, settings.variable, settings.variable, true);
@@ -242,16 +237,40 @@ void from_json(const nlohmann::json &j, OverlaySettings &settings) {
 }
 
 
-void to_json(nlohmann::json &j, const Profiles &settings) {
-#define PROCESS(category, key, variable) save(j, SettingsKeys::key, settings.variable);
+void to_json(nlohmann::json &j, const Profiles &profiles) {
+	j[SettingsKeys::SETTINGS_VERSION_KEY] = Profiles::s_current_settings_version;
+
+#define PROCESS(category, key, variable) save(j, SettingsKeys::key, profiles.variable);
 
 	PROCESS_ALL_PROFILE_SETTINGS
 
 #undef PROCESS
 }
 
-void from_json(const nlohmann::json &j, Profiles &settings) {
-#define PROCESS(category, key, variable) load(j, SettingsKeys::key, settings.variable, settings.variable, true);
+void migrateProfiles(nlohmann::json &json, int settingsVersion) {
+	if (settingsVersion < 2) {
+		// The file does not contain profiles yet, because it is old.
+		// We convert the existing json to the s_default_profile_name profile.
+		qWarning("Migrating settings file to default profile");
+
+		nlohmann::json defaultProfile = json;
+		nlohmann::json profiles      = nlohmann::json::object({ { Profiles::s_default_profile_name, defaultProfile } });
+		json[SettingsKeys::PROFILES] = profiles;
+	}
+}
+
+void from_json(const nlohmann::json &j, Profiles &profiles) {
+	profiles.settings_version = 0;
+	if (j.contains(SettingsKeys::SETTINGS_VERSION_KEY)) {
+		profiles.settings_version = j.at(SettingsKeys::SETTINGS_VERSION_KEY).get< int >();
+	}
+
+	// Copy since we might have to make modifications
+	nlohmann::json json = j;
+
+	migrateProfiles(json, Global::get().profiles.settings_version);
+
+#define PROCESS(category, key, variable) load(json, SettingsKeys::key, profiles.variable, profiles.variable, true);
 
 	PROCESS_ALL_PROFILE_SETTINGS
 

src/mumble/Settings.cpp

@@ -265,17 +265,8 @@ void Settings::load(const QString &path) {
 	nlohmann::json settingsJSON;
 	try {
 		stream >> settingsJSON;
-
-		if (settingsJSON.contains(SettingsKeys::ACTIVE_PROFILE)) {
-			settingsJSON.get_to(Global::get().profiles);
-			loadProfile();
-		} else {
-			// The file does not contain the key "SettingsKeys::ACTIVE_PROFILE"
-			// We assume the JSON file does not contain any profiles, because it is
-			// old. We load the file raw instead and convert it to the s_default_profile_name profile.
-			qWarning("Migrating settings file to 'default' profile");
-			settingsJSON.get_to(*this);
-		}
+		settingsJSON.get_to(Global::get().profiles);
+		loadProfile();
 
 		if (!mumbleQuitNormally) {
 			// These settings were saved without Mumble quitting normally afterwards. In order to prevent loading
@@ -447,6 +438,7 @@ std::size_t qHash(const ChannelTarget &target) {
 }
 
 const QString Profiles::s_default_profile_name = QLatin1String("default");
+const int Profiles::s_current_settings_version = 2;
 
 const QString Settings::cqsDefaultPushClickOn  = QLatin1String(":/on.ogg");
 const QString Settings::cqsDefaultPushClickOff = QLatin1String(":/off.ogg");

src/mumble/Settings.h

@@ -190,7 +190,9 @@ struct OverlaySettings {
 
 struct Profiles {
 	static const QString s_default_profile_name;
+	static const int s_current_settings_version;
 
+	int settings_version                  = s_current_settings_version;
 	QString activeProfileName             = s_default_profile_name;
 	QMap< QString, Settings > allProfiles = {};
 };