add checkconf example to template plugin

ElektraInitiative · May 17, 2016 · 9542f02 · 9542f02
1 parent 81a3b5e
commit 9542f02
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/src/libs/tools/src/backendbuilder.cpp b/src/libs/tools/src/backendbuilder.cpp
@@ -431,7 +431,7 @@ void BackendBuilder::addPlugin (PluginSpec const & plugin)
 	{
 		ckdb::Key * errorKey = ckdb::keyNew (0);
 		int checkResult = checkConfFunction (errorKey, newPlugin.getConfig ().getKeySet ());
-		if (checkResult != 0)
+		if (checkResult != 1)
 		{
 			throw PluginConfigInvalid (errorKey);
 		}

diff --git a/src/plugins/template/template.c b/src/plugins/template/template.c
@@ -38,6 +38,7 @@ int elektraTemplateGet (Plugin * handle ELEKTRA_UNUSED, KeySet * returned ELEKTR
 			       keyNew ("system/elektra/modules/template/exports/get", KEY_FUNC, elektraTemplateGet, KEY_END),
 			       keyNew ("system/elektra/modules/template/exports/set", KEY_FUNC, elektraTemplateSet, KEY_END),
 			       keyNew ("system/elektra/modules/template/exports/error", KEY_FUNC, elektraTemplateError, KEY_END),
+			       keyNew ("system/elektra/modules/template/exports/checkconf", KEY_FUNC, elektraTemplateCheckConfig, KEY_END),
 #include ELEKTRA_README (template)
 			       keyNew ("system/elektra/modules/template/infos/version", KEY_VALUE, PLUGINVERSION, KEY_END), KS_END);
 		ksAppend (returned, contract);
@@ -64,6 +65,15 @@ int elektraTemplateError (Plugin * handle ELEKTRA_UNUSED, KeySet * returned ELEK
 	return 1; // success
 }
 
+int elektraTemplateCheckConfig (Key * errorKey, KeySet * conf)
+{
+	// validate plugin configuration
+	// this function is optional
+	// if the export symbol "exports/checkconf" is provided, the function will be called during the mount phase
+
+	return 1; // success
+}
+
 Plugin * ELEKTRA_PLUGIN_EXPORT (template)
 {
 	// clang-format off

diff --git a/src/plugins/template/template.h b/src/plugins/template/template.h
@@ -18,6 +18,7 @@ int elektraTemplateClose (Plugin * handle, Key * errorKey);
 int elektraTemplateGet (Plugin * handle, KeySet * ks, Key * parentKey);
 int elektraTemplateSet (Plugin * handle, KeySet * ks, Key * parentKey);
 int elektraTemplateError (Plugin * handle, KeySet * ks, Key * parentKey);
+int elektraTemplateCheckConfig (Key * errorKey, KeySet * conf);
 
 Plugin * ELEKTRA_PLUGIN_EXPORT (template);