Plugin/xfconf

src/plugins/xfconf/README.md

@@ -13,9 +13,38 @@
 
 This is a storage plugin to mount the xfconf configuration settings.
 
+## Xfconf Terminology
+
+### Property
+
+A property in xfconf is the same as a key in libelektra i.e. it has a name and can hold one or more values.
+
+### Channel
+
+A channel is a type of namespace used in the xfconf library.
+Usually, it is used to separate the properties of different applications which is helpful if different applications rely on a property with the same name but require them to hold different values.
+For example Thunar uses a channel named `thunar`, Xfwm uses a channel named `xfwm4` and so on.
+Keep in mind that channels are only used to separate the properties such as namespaces.
+They are not a security feature i.e. every application has read/write access to every channel.
+
+The list of all channels is stored in the `system:/elektra/modules/xfconf/channels` which is an array of all channel names.
+Channel cannot be explicitly created or removed.
+They only exist in an implicit manner when you pass the `channel=...` argument.
+
+### Locks
+
+Xfconf uses so-called locks to prevent users or applications to set properties to a new value.
+They can be referred as a type of constant.
+As of now, locks cannot be set or unset in xfconf which makes locked properties read-only forever.
+
 ## Dependencies
 
-xfconf from the XFCE project
+The xfconf library from the XFCE project is the main dependency of this plugin.
+Usually, this library is called something such as `xfconf` (Arch, Fedora, `xfconf-devel` for compiling), `libxfconf-0` (Debian, `libxfconf-0-dev` for compmiling) or `xfce4-conf` (FreeBSD) in the package manager.
+As xfconf itself depends on dbus and glib, these are dependecies too but should be installed with the package manager automatically.
+This plugin is tested with the xfconf versions `4.16` and above.
+
+Note that this plugin does not support macOS since Xfce is not commonly used there, Mac Ports only provides a very old version (`4.12`) and Brew does not provide Xfce at all.
 
 ## Usage
 
@@ -27,20 +56,23 @@ The usage is identical to most storage plugins except that the channel option du
 # Backup-and-Restore: user:/tests/xfconf
 
 # mount the xfwm channel
-kdb mount /dev/null /test/xfwm xfconf "channel=xfwm4" 2&>/dev/null
+kdb mount /dev/null /test/xfwm xfconf "channel=xfwm4"
 
 # store old button layout
-set "OLD_LAYOUT=$(kdb get /test/xfwm/general/button_layout 2&>/dev/null)"
+set "OLD_LAYOUT=$(kdb get /test/xfwm/general/button_layout)"
 
 # set only a close button
-kdb set system:/test/xfwm/general/button_layout "C|" 2&>/dev/null
+kdb set system:/test/xfwm/general/button_layout "C|"
 
 # read the new layout
-kdb get /test/xfwm/general/button_layout 2&>/dev/null
+kdb get /test/xfwm/general/button_layout
 #> C|
 
 # restore old layout
-kdb set /test/xfwm/general/button_layout "$OLD_LAYOUT" 2&>/dev/null
+kdb set /test/xfwm/general/button_layout "$OLD_LAYOUT"
+
+# umount the channel
+kdb umount /test/xfwm
 ```
 
 ## Limitations

src/plugins/xfconf/testmod_xfconf.c

@@ -25,7 +25,6 @@ static void test_basics (void)
 	}
 
 	printf ("test basics\n");
-	printf ("open plugin...\n");
 	PLUGIN_OPEN ("xfconf");
 
 	KeySet * ks = ksNew (0, KS_END);

src/plugins/xfconf/xfconf.c

@@ -58,6 +58,38 @@ int elektraXfconfClose (Plugin * handle ELEKTRA_UNUSED, Key * errorKey ELEKTRA_U
 	return ELEKTRA_PLUGIN_STATUS_SUCCESS;
 }
 
+static void appendChannelList (KeySet * keySet)
+{
+	const char * absoluteKeyName = "system:/elektra/modules/xfconf/channels";
+	Key * channelArrayKey = keyNew (absoluteKeyName, KEY_END);
+	gchar ** channels = xfconf_list_channels ();
+	if (channels == NULL)
+	{
+		return;
+	}
+	keySetMeta (channelArrayKey, "array", "");
+	long channelIndex;
+	for (channelIndex = 0; channels[channelIndex] != NULL; channelIndex++)
+	{
+		char * channelKeyName = elektraMalloc ((elektraStrLen (absoluteKeyName) + ELEKTRA_MAX_ARRAY_SIZE + 2) * sizeof (char));
+		channelKeyName[0] = '\0';
+		strcat (channelKeyName, absoluteKeyName);
+		channelKeyName[elektraStrLen (absoluteKeyName) - 1] = '/';
+		elektraWriteArrayNumber (&channelKeyName[elektraStrLen (absoluteKeyName)], channelIndex);
+		Key * currentChannelKey = keyNew (channelKeyName, KEY_VALUE, channels[channelIndex], KEY_END);
+		ksAppendKey (keySet, currentChannelKey);
+	}
+	if (channelIndex > 0)
+	{
+		char * arrayValue = elektraMalloc (ELEKTRA_MAX_ARRAY_SIZE * sizeof (char));
+		elektraWriteArrayNumber (arrayValue, channelIndex - 1);
+		keySetMeta (channelArrayKey, "array", arrayValue);
+	}
+	ksAppendKey (keySet, channelArrayKey);
+
+	g_strfreev (channels);
+}
+
 int elektraXfconfGet (Plugin * handle ELEKTRA_UNUSED, KeySet * returned, Key * parentKey)
 {
 	ELEKTRA_LOG ("issued get\n");
@@ -74,6 +106,7 @@ int elektraXfconfGet (Plugin * handle ELEKTRA_UNUSED, KeySet * returned, Key * p
 #include ELEKTRA_README
 			       keyNew ("system:/elektra/modules/xfconf/infos/version", KEY_VALUE, PLUGINVERSION, KEY_END), KS_END);
 		ksAppend (returned, contract);
+		appendChannelList (returned);
 		ksDel (contract);
 
 		return ELEKTRA_PLUGIN_STATUS_SUCCESS;

tests/shell/check_kdb_internal_check.sh

@@ -47,7 +47,7 @@ for PLUGIN in $ACTUAL_PLUGINS; do
 		continue
 		;;
 	"xfconf")
-		# dbus is not enable on internal checks
+		# dbus is not enabled on internal checks
 		continue
 		;;
 	"spec")