colin/wireplumber
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

m-lua-scripting: wrap every script in a WpPlugin and expose async activation api

Browse Source 
This allows scripts to declare when they have finished their loading,
so we can now also know when wireplumber is done loading and ready to
handle clients

Related to !313
This commit is contained in:
George Kiagiadakis
2022-04-06 18:11:17 +03:00
parent 031bc65c20
commit ecb6100b77
7 changed files with 387 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
modules/module-lua-scripting/module.c
View File

@@ -10,6 +10,8 @@
#include <wplua/wplua.h>
#include <pipewire/keys.h>
#include "script.h"
void wp_lua_scripting_api_init (lua_State *L);
gboolean wp_lua_scripting_load_configuration (const gchar * conf_file,
WpCore * core, GError ** error);
@@ -18,41 +20,10 @@ struct _WpLuaScriptingPlugin
{
WpComponentLoader parent;
GArray *scripts;
WpCore *export_core;
GPtrArray *scripts; /* element-type: WpPlugin* */
lua_State *L;
};
struct ScriptData
{
gchar *filename;
GVariant *args;
};
static void
script_data_clear (struct ScriptData * d)
{
g_clear_pointer (&d->filename, g_free);
g_clear_pointer (&d->args, g_variant_unref);
}
static gboolean
execute_script (lua_State *L, struct ScriptData * s, GError ** error)
{
int nargs = 0;
nargs += wplua_push_sandbox (L);
if (!wplua_load_path (L, s->filename, error)) {
lua_pop (L, nargs);
return FALSE;
}
if (s->args) {
wplua_gvariant_to_lua (L, s->args);
nargs++;
}
return wplua_pcall (L, nargs, 0, error);
}
static int
wp_lua_scripting_package_loader (lua_State *L)
{
@@ -119,8 +90,7 @@ G_DEFINE_TYPE (WpLuaScriptingPlugin, wp_lua_scripting_plugin,
static void
wp_lua_scripting_plugin_init (WpLuaScriptingPlugin * self)
{
self->scripts = g_array_new (FALSE, TRUE, sizeof (struct ScriptData));
g_array_set_clear_func (self->scripts, (GDestroyNotify) script_data_clear);
self->scripts = g_ptr_array_new_with_free_func (g_object_unref);
}
static void
@@ -128,7 +98,7 @@ wp_lua_scripting_plugin_finalize (GObject * object)
{
WpLuaScriptingPlugin * self = WP_LUA_SCRIPTING_PLUGIN (object);
g_clear_pointer (&self->scripts, g_array_unref);
g_clear_pointer (&self->scripts, g_ptr_array_unref);
G_OBJECT_CLASS (wp_lua_scripting_plugin_parent_class)->finalize (object);
}
@@ -138,12 +108,7 @@ wp_lua_scripting_plugin_enable (WpPlugin * plugin, WpTransition * transition)
{
WpLuaScriptingPlugin * self = WP_LUA_SCRIPTING_PLUGIN (plugin);
g_autoptr (WpCore) core = wp_object_get_core (WP_OBJECT (plugin));
/* initialize secondary connection to pipewire */
self->export_core =
g_object_get_data (G_OBJECT (core), "wireplumber.export-core");
if (self->export_core)
g_object_ref (self->export_core);
WpCore *export_core;
/* init lua engine */
self->L = wplua_new ();
@@ -152,23 +117,25 @@ wp_lua_scripting_plugin_enable (WpPlugin * plugin, WpTransition * transition)
lua_pushlightuserdata (self->L, core);
lua_settable (self->L, LUA_REGISTRYINDEX);
lua_pushliteral (self->L, "wireplumber_export_core");
lua_pushlightuserdata (self->L, self->export_core);
lua_settable (self->L, LUA_REGISTRYINDEX);
/* initialize secondary connection to pipewire */
export_core = g_object_get_data (G_OBJECT (core), "wireplumber.export-core");
if (export_core) {
lua_pushliteral (self->L, "wireplumber_export_core");
wplua_pushobject (self->L, export_core);
lua_settable (self->L, LUA_REGISTRYINDEX);
}
wp_lua_scripting_api_init (self->L);
wp_lua_scripting_enable_package_searcher (self->L);
wplua_enable_sandbox (self->L, WP_LUA_SANDBOX_ISOLATE_ENV);
/* execute scripts that were queued in for loading */
/* register scripts that were queued in for loading */
for (guint i = 0; i < self->scripts->len; i++) {
GError * error = NULL;
struct ScriptData * s = &g_array_index (self->scripts, struct ScriptData, i);
if (!execute_script (self->L, s, &error)) {
wp_transition_return_error (transition, error);
return;
}
WpPlugin *script = g_ptr_array_index (self->scripts, i);
g_object_set (script, "lua-engine", self->L, NULL);
wp_plugin_register (g_object_ref (script));
}
g_ptr_array_set_size (self->scripts, 0);
wp_object_update_features (WP_OBJECT (self), WP_PLUGIN_FEATURE_ENABLED, 0);
}
@@ -177,9 +144,7 @@ static void
wp_lua_scripting_plugin_disable (WpPlugin * plugin)
{
WpLuaScriptingPlugin * self = WP_LUA_SCRIPTING_PLUGIN (plugin);
g_clear_pointer (&self->L, wplua_unref);
g_clear_object (&self->export_core);
}
static gboolean
@@ -190,8 +155,12 @@ wp_lua_scripting_plugin_supports_type (WpComponentLoader * cl,
}
static gchar *
find_script (const gchar * script, gboolean daemon)
find_script (const gchar * script, WpCore *core)
{
g_autoptr (WpProperties) p = wp_core_get_properties (core);
const gchar *str = wp_properties_get (p, "wireplumber.daemon");
gboolean daemon = !g_strcmp0 (str, "true");
if ((!daemon || g_path_is_absolute (script)) &&
g_file_test (script, G_FILE_TEST_IS_REGULAR))
return g_strdup (script);
@@ -212,25 +181,34 @@ wp_lua_scripting_plugin_load (WpComponentLoader * cl, const gchar * component,
/* interpret component as a script */
if (!g_strcmp0 (type, "script/lua")) {
g_autoptr (WpProperties) p = wp_core_get_properties (core);
const gchar *str = wp_properties_get (p, "wireplumber.daemon");
gboolean daemon = !g_strcmp0 (str, "true");
g_autofree gchar *filename = NULL;
g_autofree gchar *pluginname = NULL;
g_autoptr (WpPlugin) script = NULL;
struct ScriptData s = {0};
s.filename = find_script (component, daemon);
if (!s.filename) {
filename = find_script (component, core);
if (!filename) {
g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
"Could not locate script '%s'", component);
return FALSE;
}
if (args && g_variant_is_of_type (args, G_VARIANT_TYPE_VARDICT))
s.args = g_variant_ref (args);
pluginname = g_strdup_printf ("script:%s", component);
/* keep in a list and delay loading until the plugin is enabled */
g_array_append_val (self->scripts, s);
return self->L ? execute_script (self->L, &s, error) : TRUE;
script = g_object_new (WP_TYPE_LUA_SCRIPT,
"core", core,
"name", pluginname,
"filename", filename,
"arguments", args,
NULL);
if (self->L) {
g_object_set (script, "lua-engine", self->L, NULL);
wp_plugin_register (g_steal_pointer (&script));
} else {
/* keep in a list and delay registering until the plugin is enabled */
g_ptr_array_add (self->scripts, g_steal_pointer (&script));
}
return TRUE;
}
/* interpret component as a configuration file */
else if (!g_strcmp0 (type, "config/lua")) {