dc4c5b7841
A `smarthome` block points Maven at a Home Assistant instance. She reads its entity states to answer "что включено дома?", and every controllable device becomes a PROPOSED row in the existing act allowlist — cmd ["smarthome",<entity_id>,<service>], scope smarthome:<domain> — so nothing new had to be invented for the mutating half. ProposeTool/EnableTool/DisableTool, tool.Matcher and the confirm turn are untouched; one branch in Executor.Exec routes such a row to the client instead of exec, and "smarthome" is never run as a binary. This is the same trick overnight/mcp-tools used for #251, on purpose. Discovery only ever PROPOSES, and every control row is destructive=true: there is no read-only way to turn the heating off, so flipping something in his flat always costs a confirm turn and always had to be enabled by hand on /tools, behind step-up. The entity and the service come from the row he enabled, never from the utterance — Exec drops the spoken tail for a house row. A router that misheard can pick the wrong lamp; it cannot compose a target of its own. The service is checked against the domain's table on the way out too, so a hand-edited cmd column cannot reach an arbitrary Home Assistant service. set_brightness and set_temperature are deliberately absent: a spoken number the router got wrong is a wrong act on real hardware, and on/off is the whole of what a voice turn can defend. The read side is a query source ("home", before calendar and the recall passes) so "что нового дома?" is not answered from an old note. Its matcher needs a house marker plus an ask plus a device word and bails out on weather wording, because "какая температура на улице?" belongs to the weather source. Off unless configured: the block is dark without "enabled": true, and applyDefaults normalises a disabled block to nil so "off" stays in one place. deploy/mavend.json carries it disabled, with the token as ${HA_TOKEN}. NOT shipped, and not faked: MQTT / Zigbee2MQTT (plan steps 2 and 5) and the sensor-to-fact and presence-probe pipelines. There is no broker and no Home Assistant anywhere on this network — 8123 and 1883 are closed on every host in 192.168.1.0/24 — the module tree is vendored so a paho dependency cannot be added offline, and Home Assistant already fronts Zigbee2MQTT where it exists. Writing a sensor pipeline with no sensor to test it against would be a guess. Vikunja #256
209 lines
7.9 KiB
Go
209 lines
7.9 KiB
Go
// Package tool is maven's act executor: it runs the ENABLED tools from the
|
|
// store's allowlist, and drafts 'proposed' scaffolds for acts that aren't on
|
|
// it yet.
|
|
//
|
|
// Boundary discipline (DESIGN.md § "Tool registration — drafting is suggest,
|
|
// enabling is act"):
|
|
//
|
|
// - The store is the allowlist. Only status='enabled' rows run. A verb not
|
|
// on it → refuse ("not on the list → refuse, don't improvise") and draft a
|
|
// 'proposed' scaffold instead. Enabling a proposal is a human act on an
|
|
// authed surface (mavweb), gated at AuthStepUp — never the voice path, so
|
|
// a compromised router can't grant itself a capability.
|
|
// - Args are passed as argv, NEVER through a shell. STT text lands as
|
|
// positional arguments to Cmd; there is no `sh -c`, so "restart nginx;
|
|
// rm -rf" can't inject — the tail is one argv element to the named binary.
|
|
// - An enabled row whose cmd is ["smarthome", "<entity_id>", "<service>"] is
|
|
// a Home Assistant service call instead of a process (Vikunja #256), by
|
|
// exactly the same trick and under exactly the same rules. Control rows are
|
|
// always destructive, so flipping something in his flat always costs a
|
|
// confirm turn.
|
|
// - An enabled row whose cmd is ["mcp", "<server>", "<tool>"] is a call to a
|
|
// configured MCP server instead of a process (Vikunja #251). It goes
|
|
// through every rule above unchanged — enabled, and confirmed if it
|
|
// mutates — because the store is still the allowlist; only the dispatch at
|
|
// the bottom of Exec differs.
|
|
// - Destructive tools don't run on first hearing: Exec returns ErrNeedsConfirm
|
|
// and the handler runs a confirm turn ("выполнить X? да/нет"); only a
|
|
// confirmed re-Exec runs them. A gate assumes a fully-formed action, which
|
|
// an enabled+matched act is (DESIGN.md § "Confirmation is not one
|
|
// mechanism").
|
|
package tool
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"log"
|
|
"os/exec"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/kami/maven/internal/ipc"
|
|
"github.com/kami/maven/internal/mcp"
|
|
"github.com/kami/maven/internal/router"
|
|
"github.com/kami/maven/internal/smarthome"
|
|
)
|
|
|
|
// API — the narrow slice of ipc.CoreAPI the executor and matcher need. Backed
|
|
// in-process by the daemon's store adapter (a direct sqlite query per call —
|
|
// acts are rare, personal-scale; no cache).
|
|
type API interface {
|
|
LookupTool(ctx context.Context, name string) (ipc.Tool, error)
|
|
ListTools(ctx context.Context, status string) ([]ipc.Tool, error)
|
|
ProposeTool(ctx context.Context, name, utterance, scope string, ts time.Time) (bool, error)
|
|
}
|
|
|
|
var (
|
|
// ErrNotEnabled — the fn isn't an enabled tool (absent, or still proposed).
|
|
ErrNotEnabled = errors.New("tool not on the enabled allowlist")
|
|
// ErrNeedsConfirm — the fn is enabled but destructive; needs a confirm turn.
|
|
ErrNeedsConfirm = errors.New("destructive tool needs confirmation")
|
|
)
|
|
|
|
// MCPCaller is the seam for an act that is an MCP tool call rather than a
|
|
// process (Vikunja #251). internal/mcp.Manager satisfies it via CallPositional.
|
|
// nil ⇒ MCP is not configured, and an MCP row refuses to run rather than
|
|
// silently doing nothing.
|
|
type MCPCaller interface {
|
|
CallPositional(ctx context.Context, server, tool string, args []string) (string, error)
|
|
}
|
|
|
|
// HomeCaller is the seam for an act that is a Home Assistant service call
|
|
// rather than a process (Vikunja #256). internal/smarthome.Client satisfies it.
|
|
// nil ⇒ the house is not configured, and a house row refuses to run rather than
|
|
// silently doing nothing.
|
|
type HomeCaller interface {
|
|
CallService(ctx context.Context, entityID, service string) (string, error)
|
|
}
|
|
|
|
// Executor runs enabled tools. run is the exec seam (default: real process);
|
|
// tests swap it. timeout bounds each invocation.
|
|
type Executor struct {
|
|
api API
|
|
timeout time.Duration
|
|
run func(ctx context.Context, argv []string) (string, error)
|
|
mcp MCPCaller
|
|
home HomeCaller
|
|
}
|
|
|
|
// NewExecutor builds the executor. timeout<=0 defaults to 30s.
|
|
func NewExecutor(api API, timeout time.Duration) *Executor {
|
|
if timeout <= 0 {
|
|
timeout = 30 * time.Second
|
|
}
|
|
return &Executor{api: api, timeout: timeout, run: runProcess}
|
|
}
|
|
|
|
// WithMCP attaches the MCP caller. Called once at wiring time when the mcp
|
|
// config block is present; without it, a row whose cmd is ["mcp", …] refuses.
|
|
func (e *Executor) WithMCP(m MCPCaller) *Executor {
|
|
e.mcp = m
|
|
return e
|
|
}
|
|
|
|
// WithHome attaches the Home Assistant caller. Called once at wiring time when
|
|
// the smarthome block is enabled; without it, a row whose cmd is
|
|
// ["smarthome", …] refuses.
|
|
func (e *Executor) WithHome(h HomeCaller) *Executor {
|
|
e.home = h
|
|
return e
|
|
}
|
|
|
|
// Exec looks up name in the store and runs Cmd+args as argv (no shell).
|
|
// confirmed=true is the second turn of a destructive act (the user said "да");
|
|
// it bypasses the ErrNeedsConfirm gate. Non-enabled ⇒ ErrNotEnabled; a
|
|
// destructive tool with confirmed=false ⇒ ErrNeedsConfirm.
|
|
func (e *Executor) Exec(ctx context.Context, name string, args []string, confirmed bool) (string, error) {
|
|
t, err := e.api.LookupTool(ctx, name)
|
|
if errors.Is(err, ipc.ErrToolNotFound) {
|
|
return "", ErrNotEnabled
|
|
}
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
if t.Status != "enabled" {
|
|
return "", ErrNotEnabled
|
|
}
|
|
if t.Destructive && !confirmed {
|
|
return "", ErrNeedsConfirm
|
|
}
|
|
// An MCP row is a call to a configured server, not a process. Everything
|
|
// above still applied: it had to be enabled, and a mutating one had to be
|
|
// confirmed. Only the dispatch differs.
|
|
if server, remote, ok := mcp.ParseCmd(t.Cmd); ok {
|
|
if e.mcp == nil {
|
|
return "", ErrNotEnabled
|
|
}
|
|
ctx, cancel := context.WithTimeout(ctx, e.timeout)
|
|
defer cancel()
|
|
return e.mcp.CallPositional(ctx, server, remote, args)
|
|
}
|
|
// A house row is a Home Assistant service call, not a process (Vikunja
|
|
// #256). Same story: enabled, and confirmed — every control row is
|
|
// destructive, because there is no read-only way to turn the heating off.
|
|
// The spoken args are dropped on purpose: the entity and the service come
|
|
// from the row Kami enabled, so a router that misheard can pick the wrong
|
|
// row but can never compose a target of its own.
|
|
if entityID, service, ok := smarthome.ParseCmd(t.Cmd); ok {
|
|
if e.home == nil {
|
|
return "", ErrNotEnabled
|
|
}
|
|
ctx, cancel := context.WithTimeout(ctx, e.timeout)
|
|
defer cancel()
|
|
return e.home.CallService(ctx, entityID, service)
|
|
}
|
|
argv := append(append([]string(nil), t.Cmd...), args...)
|
|
if len(argv) == 0 {
|
|
return "", ErrNotEnabled
|
|
}
|
|
ctx, cancel := context.WithTimeout(ctx, e.timeout)
|
|
defer cancel()
|
|
return e.run(ctx, argv)
|
|
}
|
|
|
|
func runProcess(ctx context.Context, argv []string) (string, error) {
|
|
cmd := exec.CommandContext(ctx, argv[0], argv[1:]...)
|
|
var buf bytes.Buffer
|
|
cmd.Stdout = &buf
|
|
cmd.Stderr = &buf
|
|
err := cmd.Run()
|
|
out := strings.TrimSpace(buf.String())
|
|
if err != nil {
|
|
return out, fmt.Errorf("run %v: %w", argv, err)
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// Matcher — a router.ActMatcher whose allowlist is the live set of enabled
|
|
// tool names (one source of truth with the executor). Match delegates to the
|
|
// router's default prefix logic over the current names. The interface's Match
|
|
// has no ctx, so it queries with a background context — an in-process sqlite
|
|
// read on the daemon.
|
|
type Matcher struct{ api API }
|
|
|
|
// NewMatcher builds a store-backed act matcher.
|
|
func NewMatcher(api API) *Matcher { return &Matcher{api: api} }
|
|
|
|
func (m *Matcher) names() []string {
|
|
ts, err := m.api.ListTools(context.Background(), "enabled")
|
|
if err != nil {
|
|
log.Printf("tool: list enabled tools: %v", err)
|
|
return nil
|
|
}
|
|
names := make([]string, len(ts))
|
|
for i, t := range ts {
|
|
names[i] = t.Name
|
|
}
|
|
return names
|
|
}
|
|
|
|
// Allowlist — the enabled verbs (for stage-0 grammar wiring / introspection).
|
|
func (m *Matcher) Allowlist() []string { return m.names() }
|
|
|
|
// Match — longest-verb-first prefix match over the live enabled allowlist.
|
|
func (m *Matcher) Match(utterance string) (string, []string, bool) {
|
|
return router.DefaultActMatcher{Fns: m.names()}.Match(utterance)
|
|
}
|