Skip to content

Take control over your live stream video by running it yourself. Streaming + chat out of the box.

feat(plugins): add owncast.config.get() for manifest-declared config

Gabe Kangas49f187630e4b
diff --git a/services/plugins/hostfns.go b/services/plugins/hostfns.go
index ef2d706315..d40234653c 100644
--- a/services/plugins/hostfns.go
+++ b/services/plugins/hostfns.go
@@ -287,6 +287,12 @@ type HostEnv struct {
Socials func() []SocialHandle // server.read
Emotes func() []Emote // server.read
Federation func() FederationInfo // server.read
+ // ConfigValue resolves an admin-set override for one of the plugin's
+ // manifest-declared config keys (owncast.config.get). Returns the override
+ // value and true when the admin has set one; false to fall back to the
+ // manifest's declared default. Optional; nil → defaults only (the common
+ // case until an admin edits the value).
+ ConfigValue func(pluginName, key string) (any, bool)
// WriteVideoConfig applies a partial video/transcoding configuration
// change. Returns an error the plugin can see if the host rejects the
// config (e.g. an invalid variant). videoconfig.write permission required.
@@ -399,6 +405,10 @@ func BuildHostFunctions(env *HostEnv, manifest *Manifest) []extism.HostFunction
// is benign — whatever the callback does still needs its own permissions —
// and TimerHub's per-plugin caps bound abuse.
fns = append(fns, hostTimerSet(env, manifest.Slug), hostTimerClear(env, manifest.Slug))
+
+ // Config is ambient too: reading the plugin's own manifest-declared config
+ // (admin override, else declared default) is benign and needs no grant.
+ fns = append(fns, hostConfigGet(env, manifest))
if granted[PermUIModify] {
fns = append(fns,
hostAddActions(env, manifest),
@@ -734,6 +744,53 @@ func hostServerSocials(env *HostEnv) extism.HostFunction {
return fn
}
+// hostConfigGet returns the effective value of a manifest-declared config key
+// as JSON: the admin-set override when present, otherwise the manifest's
+// declared default. Returns 0 (→ undefined in the guest) for an unknown key or
+// a declared key with no override and no default.
+func hostConfigGet(env *HostEnv, manifest *Manifest) extism.HostFunction {
+ fn := extism.NewHostFunctionWithStack(
+ "owncast_config_get",
+ func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) {
+ key, err := p.ReadString(stack[0])
+ if err != nil {
+ stack[0] = 0
+ return
+ }
+ field, declared := manifest.Config[key]
+ if !declared {
+ stack[0] = 0
+ return
+ }
+ value := field.Default
+ if env.ConfigValue != nil {
+ if override, ok := env.ConfigValue(manifest.Slug, key); ok {
+ value = override
+ }
+ }
+ if value == nil {
+ stack[0] = 0
+ return
+ }
+ data, err := json.Marshal(value)
+ if err != nil {
+ stack[0] = 0
+ return
+ }
+ offset, err := p.WriteBytes(data)
+ if err != nil {
+ stack[0] = 0
+ return
+ }
+ stack[0] = offset
+ },
+ []extism.ValueType{extism.ValueTypePTR},
+ []extism.ValueType{extism.ValueTypePTR},
+ )
+ fn.SetNamespace("extism:host/user")
+ return fn
+}
+
func hostServerEmotes(env *HostEnv) extism.HostFunction {
fn := extism.NewHostFunctionWithStack(
"owncast_server_emotes",
diff --git a/services/plugins/plugin-contract.json b/services/plugins/plugin-contract.json
index 4800363fc6..d42823991a 100644
--- a/services/plugins/plugin-contract.json
+++ b/services/plugins/plugin-contract.json
@@ -26,6 +26,7 @@
"owncast_chat_clients",
"owncast_chat_history",
"owncast_clear_actions",
+ "owncast_config_get",
"owncast_delete_message",
"owncast_emit_event",
"owncast_fediverse_post",