Merge lp:~azzar1/compiz/dont-crash-if-gsettings-key-not-found into lp:compiz/0.9.13

[Andrea Azzarone]

Don't crash if gsettings key is not found. Default value will be used.

[lp:~azzar1/compiz/dont-crash-if-gsettings-key-not-found]

4073. By Andrea Azzarone on 2016-07-26

Unref the schema.

4074. By Andrea Azzarone on 2016-07-26

Avoid NULL unref.

4075. By Andrea Azzarone on 2016-07-26

Fix typo.

[Marco Trevisan (Treviño) (3v1n0)]

+1

review: Approve

=== modified file 'compizconfig/gsettings/gsettings_backend_shared/ccs_gsettings_interface_wrapper.c'
--- compizconfig/gsettings/gsettings_backend_shared/ccs_gsettings_interface_wrapper.c	2013-05-13 13:23:20 +0000
+++ compizconfig/gsettings/gsettings_backend_shared/ccs_gsettings_interface_wrapper.c	2016-07-26 15:08:17 +0000
@@ -15,25 +15,49 @@
 #define GSETTINGS_WRAPPER_PRIVATE(w) \
     CCSGSettingsWrapperPrivate *gswPrivate = (CCSGSettingsWrapperPrivate *) ccsObjectGetPrivate (w);
 
+static Bool keyIsValid (GSettings *settings, const char *key)
+{
+    GSettingsSchema *schema;
+    Bool valid = FALSE;
+
+    if (!settings)
+        return valid;
+
+    g_object_get (settings, "settings-schema", &schema, NULL);
+
+    if (schema)
+    {
+	valid = g_settings_schema_has_key (schema, key);
+	g_settings_schema_unref (schema);
+    }
+
+    return valid;
+}
+
 static GVariant * ccsGSettingsWrapperGetValueDefault (CCSGSettingsWrapper *wrapper, const char *key)
 {
     GSETTINGS_WRAPPER_PRIVATE (wrapper);
 
-    return g_settings_get_value (gswPrivate->settings, key);
+    if (keyIsValid (gswPrivate->settings, key))
+	return g_settings_get_value (gswPrivate->settings, key);
+    else
+	return NULL;
 }
 
 static void ccsGSettingsWrapperSetValueDefault (CCSGSettingsWrapper *wrapper, const char *key, GVariant *variant)
 {
     GSETTINGS_WRAPPER_PRIVATE (wrapper);
 
-    g_settings_set_value (gswPrivate->settings, key, variant);
+    if (keyIsValid (gswPrivate->settings, key))
+	g_settings_set_value (gswPrivate->settings, key, variant);
 }
 
 static void ccsGSettingsWrapperResetKeyDefault (CCSGSettingsWrapper *wrapper, const char *key)
 {
     GSETTINGS_WRAPPER_PRIVATE (wrapper);
 
-    g_settings_reset (gswPrivate->settings, key);
+    if (keyIsValid (gswPrivate->settings, key))
+	g_settings_reset (gswPrivate->settings, key);
 }
 
 static char ** ccsGSettingsWrapperListKeysDefault (CCSGSettingsWrapper *wrapper)

=== modified file 'compizconfig/gsettings/gsettings_backend_shared/gsettings_util.c'
--- compizconfig/gsettings/gsettings_backend_shared/gsettings_util.c	2013-05-13 13:23:20 +0000
+++ compizconfig/gsettings/gsettings_backend_shared/gsettings_util.c	2016-07-26 15:08:17 +0000
@@ -452,24 +452,24 @@
 }
 
 Bool
-checkReadVariantIsValid (GVariant *gsettingsValue, CCSSettingType type, const gchar *pathName)
+checkReadVariantIsValid (GVariant *gsettingsValue, CCSSettingType type, const gchar *pathName, const gchar *key)
 {
     /* first check if the key is set */
     if (!gsettingsValue)
     {
-	ccsWarning ("There is no key at the path %s. "
-		"Settings from this path won't be read. Try to remove "
-		"that value so that operation can continue properly.",
-		pathName);
+	ccsWarning ("There is no key '%s' at the path %s. "
+		"Settings from this path won't be read. Default value will be used."
+		"Ensure this setting is available or the setting backend is properly configured.",
+		key, pathName);
 	return FALSE;
     }
 
     if (!variantIsValidForCCSType (gsettingsValue, type))
     {
-	ccsWarning ("There is an unsupported value at path %s. "
-		"Settings from this path won't be read. Try to remove "
-		"that value so that operation can continue properly.",
-		pathName);
+	ccsWarning ("There is an unsupported value for key '%s' at path %s. "
+		"Settings from this path won't be read. Default value will be used. "
+		"Ensure this setting is available or the setting backend is properly configured.",
+		key, pathName);
 	return FALSE;
     }
 
@@ -481,9 +481,10 @@
 {
     GVariant *gsettingsValue = ccsGSettingsWrapperGetValue (settings, key);
 
-    if (!checkReadVariantIsValid (gsettingsValue, type, pathName))
+    if (!checkReadVariantIsValid (gsettingsValue, type, pathName, key))
     {
-	g_variant_unref (gsettingsValue);
+	if (gsettingsValue)
+	    g_variant_unref (gsettingsValue);
 	return NULL;
     }
 

=== modified file 'compizconfig/gsettings/gsettings_backend_shared/gsettings_util.h'
--- compizconfig/gsettings/gsettings_backend_shared/gsettings_util.h	2012-11-13 15:51:59 +0000
+++ compizconfig/gsettings/gsettings_backend_shared/gsettings_util.h	2016-07-26 15:08:17 +0000
@@ -109,7 +109,7 @@
 getNameForCCSSetting (CCSSetting *setting);
 
 Bool
-checkReadVariantIsValid (GVariant *gsettingsValue, CCSSettingType type, const gchar *pathName);
+checkReadVariantIsValid (GVariant *gsettingsValue, CCSSettingType type, const gchar *pathName, const gchar *key);
 
 GVariant *
 getVariantAtKey (CCSGSettingsWrapper *settings, const char *key, const char *pathName, CCSSettingType type);

=== modified file 'compizconfig/gsettings/tests/test_gsettings_tests.cpp'
--- compizconfig/gsettings/tests/test_gsettings_tests.cpp	2013-05-13 15:49:42 +0000
+++ compizconfig/gsettings/tests/test_gsettings_tests.cpp	2016-07-26 15:08:17 +0000
@@ -1207,14 +1207,14 @@
 
 TEST_F(CCSGSettingsTestIndependent, TestReadVariantIsValidNULL)
 {
-    EXPECT_FALSE (checkReadVariantIsValid (NULL, TypeNum, "foo/bar"));
+    EXPECT_FALSE (checkReadVariantIsValid (NULL, TypeNum, "foo/bar", "key"));
 }
 
 TEST_F(CCSGSettingsTestIndependent, TestReadVariantIsValidTypeBad)
 {
     GVariant *v = g_variant_new ("i", 1);
 
-    EXPECT_FALSE (checkReadVariantIsValid (v, TypeString, "foo/bar"));
+    EXPECT_FALSE (checkReadVariantIsValid (v, TypeString, "foo/bar", "key"));
 
     g_variant_unref (v);
 }
@@ -1223,7 +1223,7 @@
 {
     GVariant *v = g_variant_new ("i", 1);
 
-    EXPECT_TRUE (checkReadVariantIsValid (v, TypeInt, "foo/bar"));
+    EXPECT_TRUE (checkReadVariantIsValid (v, TypeInt, "foo/bar", "key"));
 
     g_variant_unref (v);
 }