forked from molecule-ai/molecule-core
Forked clean from public hackathon repo (Starfire-AgentTeam, BSL 1.1) with full rebrand to Molecule AI under github.com/Molecule-AI/molecule-monorepo. Brand: Starfire → Molecule AI. Slug: starfire / agent-molecule → molecule. Env vars: STARFIRE_* → MOLECULE_*. Go module: github.com/agent-molecule/platform → github.com/Molecule-AI/molecule-monorepo/platform. Python packages: starfire_plugin → molecule_plugin, starfire_agent → molecule_agent. DB: agentmolecule → molecule. History truncated; see public repo for prior commits and contributor attribution. Verified green: go test -race ./... (platform), pytest (workspace-template 1129 + sdk 132), vitest (canvas 352), build (mcp). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
982 lines
35 KiB
Go
982 lines
35 KiB
Go
package handlers
|
|
|
|
import (
|
|
"archive/tar"
|
|
"bytes"
|
|
"compress/gzip"
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"log"
|
|
"net/http"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/Molecule-AI/molecule-monorepo/platform/internal/db"
|
|
"github.com/Molecule-AI/molecule-monorepo/platform/internal/envx"
|
|
"github.com/Molecule-AI/molecule-monorepo/platform/internal/plugins"
|
|
"github.com/Molecule-AI/molecule-monorepo/platform/internal/provisioner"
|
|
"github.com/Molecule-AI/molecule-monorepo/platform/internal/wsauth"
|
|
"github.com/docker/docker/api/types/container"
|
|
"github.com/docker/docker/client"
|
|
"github.com/docker/docker/pkg/stdcopy"
|
|
"github.com/gin-gonic/gin"
|
|
"gopkg.in/yaml.v3"
|
|
)
|
|
|
|
// Install-layer defaults. Overridable via env for deployments whose
|
|
// plugin sources are fast (or slow) enough to warrant different caps.
|
|
const (
|
|
defaultInstallBodyMaxBytes = 64 * 1024 // 64 KiB JSON body cap
|
|
defaultInstallFetchTimeout = 5 * time.Minute // per-fetch deadline
|
|
defaultInstallMaxDirBytes = 100 * 1024 * 1024 // 100 MiB staged tree
|
|
)
|
|
|
|
// httpErr is the typed error returned by Install helpers. The handler
|
|
// matches it with errors.As and emits the attached status + body. Using
|
|
// a typed error instead of a 5-value tuple keeps helper signatures Go-
|
|
// idiomatic and makes them testable without a gin.Context.
|
|
type httpErr struct {
|
|
Status int
|
|
Body gin.H
|
|
}
|
|
|
|
func (e *httpErr) Error() string {
|
|
return fmt.Sprintf("%d: %v", e.Status, e.Body)
|
|
}
|
|
|
|
// newHTTPErr constructs an *httpErr without the caller worrying about
|
|
// pointer receivers. Keeps call sites terse.
|
|
func newHTTPErr(status int, body gin.H) *httpErr { return &httpErr{Status: status, Body: body} }
|
|
|
|
// installLimitsLogOnce gates the single operator-facing log line
|
|
// describing the effective install caps + timeout. sync.Once guarantees
|
|
// exactly one emission per process lifetime, regardless of how many
|
|
// PluginsHandler instances are constructed. Safe to call from any
|
|
// goroutine.
|
|
var installLimitsLogOnce sync.Once
|
|
|
|
// logInstallLimitsOnce writes the effective install limits to `w`,
|
|
// exactly once per process. Taking the writer as a parameter (instead
|
|
// of a package-level var) removes the last piece of mutable global
|
|
// state from this file — production passes os.Stderr, tests pass a
|
|
// bytes.Buffer with no t.Cleanup dance.
|
|
func logInstallLimitsOnce(w io.Writer) {
|
|
installLimitsLogOnce.Do(func() {
|
|
fmt.Fprintf(w,
|
|
"Plugin install limits: body=%d bytes timeout=%s staged=%d bytes\n",
|
|
envx.Int64("PLUGIN_INSTALL_BODY_MAX_BYTES", defaultInstallBodyMaxBytes),
|
|
envx.Duration("PLUGIN_INSTALL_FETCH_TIMEOUT", defaultInstallFetchTimeout),
|
|
envx.Int64("PLUGIN_INSTALL_MAX_DIR_BYTES", defaultInstallMaxDirBytes),
|
|
)
|
|
})
|
|
}
|
|
|
|
// dirSize returns the total bytes of files under dir. Short-circuits
|
|
// as soon as the byte limit is exceeded so pathological inputs don't
|
|
// run the full walk.
|
|
func dirSize(dir string, limit int64) (int64, error) {
|
|
var total int64
|
|
err := filepath.Walk(dir, func(path string, info os.FileInfo, walkErr error) error {
|
|
if walkErr != nil {
|
|
return walkErr
|
|
}
|
|
if !info.IsDir() {
|
|
total += info.Size()
|
|
if total > limit {
|
|
return fmt.Errorf("staged plugin exceeds cap of %d bytes", limit)
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
return total, err
|
|
}
|
|
|
|
// validatePluginName ensures the name is safe (no path traversal).
|
|
func validatePluginName(name string) error {
|
|
if name == "" {
|
|
return fmt.Errorf("plugin name is required")
|
|
}
|
|
if strings.Contains(name, "/") || strings.Contains(name, "\\") || strings.Contains(name, "..") {
|
|
return fmt.Errorf("invalid plugin name: must not contain path separators or '..'")
|
|
}
|
|
if name != filepath.Base(name) {
|
|
return fmt.Errorf("invalid plugin name")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// RuntimeLookup resolves a workspace's runtime identifier by ID. The
|
|
// handler uses this to filter the plugin registry to compatible plugins
|
|
// without needing a direct DB dependency. A nil lookup disables
|
|
// workspace-scoped filtering (handler falls back to unfiltered list).
|
|
type RuntimeLookup func(workspaceID string) (string, error)
|
|
|
|
// PluginsHandler manages the plugin registry and per-workspace plugin installation.
|
|
type PluginsHandler struct {
|
|
pluginsDir string // host path to plugins/ registry
|
|
docker *client.Client // Docker client for container operations
|
|
restartFunc func(string) // auto-restart workspace after install/uninstall
|
|
runtimeLookup RuntimeLookup // workspace_id → runtime (optional)
|
|
sources *plugins.Registry // pluggable install sources (local, github, clawhub, …)
|
|
}
|
|
|
|
// NewPluginsHandler constructs a PluginsHandler with the default source
|
|
// registry (local + github resolvers). Deployments can add more schemes
|
|
// via WithSourceResolver before routes are wired — e.g. a private
|
|
// enterprise registry or ClawHub. Logs the effective install limits
|
|
// exactly once per process on first construction.
|
|
func NewPluginsHandler(pluginsDir string, docker *client.Client, restartFunc func(string)) *PluginsHandler {
|
|
sources := plugins.NewRegistry()
|
|
sources.Register(plugins.NewLocalResolver(pluginsDir))
|
|
sources.Register(plugins.NewGithubResolver())
|
|
logInstallLimitsOnce(os.Stderr)
|
|
return &PluginsHandler{
|
|
pluginsDir: pluginsDir,
|
|
docker: docker,
|
|
restartFunc: restartFunc,
|
|
sources: sources,
|
|
}
|
|
}
|
|
|
|
// WithSourceResolver registers a custom source resolver (e.g. a ClawHub
|
|
// client) alongside the defaults. Call during router wiring, before the
|
|
// first request. Chainable.
|
|
func (h *PluginsHandler) WithSourceResolver(resolver plugins.SourceResolver) *PluginsHandler {
|
|
h.sources.Register(resolver)
|
|
return h
|
|
}
|
|
|
|
// WithRuntimeLookup installs a workspace-runtime resolver. Used by the
|
|
// router during wiring so tests don't need a real DB.
|
|
func (h *PluginsHandler) WithRuntimeLookup(lookup RuntimeLookup) *PluginsHandler {
|
|
h.runtimeLookup = lookup
|
|
return h
|
|
}
|
|
|
|
// pluginInfo is the API response for a plugin.
|
|
type pluginInfo struct {
|
|
Name string `json:"name"`
|
|
Version string `json:"version"`
|
|
Description string `json:"description"`
|
|
Author string `json:"author"`
|
|
Tags []string `json:"tags"`
|
|
Skills []string `json:"skills"`
|
|
// Runtimes declares which workspace runtimes this plugin ships an adaptor
|
|
// for. Empty means "unspecified" — the canvas still allows install (the
|
|
// raw-drop fallback surfaces a warning at install time). Runtime names
|
|
// use underscore form (e.g. "claude_code").
|
|
Runtimes []string `json:"runtimes"`
|
|
// SupportedOnRuntime is populated by ListInstalled/compatibility only.
|
|
// When a workspace changes runtime, plugins whose manifest doesn't
|
|
// declare the new runtime become inert (files present, tools unwired).
|
|
// The canvas reads this to grey out rows.
|
|
// Pointer so the field is omitted on endpoints that don't compute it.
|
|
SupportedOnRuntime *bool `json:"supported_on_runtime,omitempty"`
|
|
}
|
|
|
|
// supportsRuntime returns true if the plugin declares support for the given
|
|
// runtime OR if it declares no runtimes at all (treat as "unspecified, try it").
|
|
// Comparison is normalized — "claude-code" and "claude_code" are equal.
|
|
func (p pluginInfo) supportsRuntime(runtime string) bool {
|
|
if len(p.Runtimes) == 0 {
|
|
return true
|
|
}
|
|
want := strings.ReplaceAll(runtime, "-", "_")
|
|
for _, r := range p.Runtimes {
|
|
if strings.ReplaceAll(r, "-", "_") == want {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// ListRegistry handles GET /plugins — lists all available plugins from the registry.
|
|
// Supports optional ?runtime=<name> query param to filter to plugins that
|
|
// declare support for the given runtime. Plugins with no declared
|
|
// `runtimes` field are treated as "unspecified, try it" and included.
|
|
func (h *PluginsHandler) ListRegistry(c *gin.Context) {
|
|
runtime := c.Query("runtime")
|
|
c.JSON(http.StatusOK, h.listRegistryFiltered(runtime))
|
|
}
|
|
|
|
// listRegistryFiltered is the shared read-plus-filter path used by both
|
|
// /plugins and /workspaces/:id/plugins/available.
|
|
func (h *PluginsHandler) listRegistryFiltered(runtime string) []pluginInfo {
|
|
plugins := []pluginInfo{}
|
|
entries, err := os.ReadDir(h.pluginsDir)
|
|
if err != nil {
|
|
return plugins
|
|
}
|
|
for _, e := range entries {
|
|
if !e.IsDir() {
|
|
continue
|
|
}
|
|
info := h.readPluginManifest(filepath.Join(h.pluginsDir, e.Name()), e.Name())
|
|
if runtime != "" && !info.supportsRuntime(runtime) {
|
|
continue
|
|
}
|
|
plugins = append(plugins, info)
|
|
}
|
|
return plugins
|
|
}
|
|
|
|
// ListSources handles GET /plugins/sources — returns the list of
|
|
// registered install-source schemes so clients can show users which
|
|
// kinds of plugin sources they can install from.
|
|
func (h *PluginsHandler) ListSources(c *gin.Context) {
|
|
c.JSON(http.StatusOK, gin.H{"schemes": h.sources.Schemes()})
|
|
}
|
|
|
|
// ListAvailableForWorkspace handles GET /workspaces/:id/plugins/available —
|
|
// returns plugins from the registry filtered to those supported by the
|
|
// workspace's runtime. If no runtime lookup is wired, falls back to the
|
|
// full registry.
|
|
func (h *PluginsHandler) ListAvailableForWorkspace(c *gin.Context) {
|
|
workspaceID := c.Param("id")
|
|
runtime := ""
|
|
if h.runtimeLookup != nil {
|
|
if r, err := h.runtimeLookup(workspaceID); err == nil {
|
|
runtime = r
|
|
}
|
|
}
|
|
c.JSON(http.StatusOK, h.listRegistryFiltered(runtime))
|
|
}
|
|
|
|
// ListInstalled handles GET /workspaces/:id/plugins — lists plugins installed in the workspace.
|
|
func (h *PluginsHandler) ListInstalled(c *gin.Context) {
|
|
workspaceID := c.Param("id")
|
|
ctx := c.Request.Context()
|
|
plugins := []pluginInfo{}
|
|
|
|
containerName := h.findRunningContainer(ctx, workspaceID)
|
|
if containerName == "" {
|
|
c.JSON(http.StatusOK, plugins)
|
|
return
|
|
}
|
|
|
|
// List directories in /configs/plugins/
|
|
output, err := h.execInContainer(ctx, containerName, []string{
|
|
"sh", "-c", "ls -1 /configs/plugins/ 2>/dev/null || true",
|
|
})
|
|
if err != nil {
|
|
c.JSON(http.StatusOK, plugins)
|
|
return
|
|
}
|
|
|
|
for _, name := range strings.Split(output, "\n") {
|
|
name = strings.TrimSpace(name)
|
|
if name == "" || validatePluginName(name) != nil {
|
|
continue
|
|
}
|
|
// Try to read manifest from container (safe: name is validated)
|
|
manifestOutput, err := h.execInContainer(ctx, containerName, []string{
|
|
"cat", fmt.Sprintf("/configs/plugins/%s/plugin.yaml", name),
|
|
})
|
|
if err != nil || manifestOutput == "" {
|
|
plugins = append(plugins, pluginInfo{Name: name})
|
|
continue
|
|
}
|
|
info := parseManifestYAML(name, []byte(manifestOutput))
|
|
plugins = append(plugins, info)
|
|
}
|
|
|
|
// Annotate each installed plugin with whether it still supports the
|
|
// workspace's current runtime. Lets the canvas grey out plugins that
|
|
// went inert after a runtime change.
|
|
if h.runtimeLookup != nil {
|
|
if runtime, err := h.runtimeLookup(workspaceID); err == nil && runtime != "" {
|
|
for i := range plugins {
|
|
ok := plugins[i].supportsRuntime(runtime)
|
|
plugins[i].SupportedOnRuntime = &ok
|
|
}
|
|
}
|
|
}
|
|
|
|
c.JSON(http.StatusOK, plugins)
|
|
}
|
|
|
|
// CheckRuntimeCompatibility handles GET /workspaces/:id/plugins/compatibility?runtime=<name>
|
|
// — preflight for runtime changes. Reports which installed plugins would
|
|
// become inert if the workspace switched to <runtime>. Canvas uses this
|
|
// to show a confirm dialog before applying the change.
|
|
func (h *PluginsHandler) CheckRuntimeCompatibility(c *gin.Context) {
|
|
workspaceID := c.Param("id")
|
|
targetRuntime := c.Query("runtime")
|
|
ctx := c.Request.Context()
|
|
|
|
if targetRuntime == "" {
|
|
c.JSON(http.StatusBadRequest, gin.H{"error": "runtime query parameter is required"})
|
|
return
|
|
}
|
|
|
|
containerName := h.findRunningContainer(ctx, workspaceID)
|
|
if containerName == "" {
|
|
// Workspace not running — nothing installed yet, trivially compatible.
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"target_runtime": targetRuntime,
|
|
"compatible": []pluginInfo{},
|
|
"incompatible": []pluginInfo{},
|
|
"all_compatible": true,
|
|
})
|
|
return
|
|
}
|
|
|
|
output, err := h.execInContainer(ctx, containerName, []string{
|
|
"sh", "-c", "ls -1 /configs/plugins/ 2>/dev/null || true",
|
|
})
|
|
if err != nil {
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to list installed plugins"})
|
|
return
|
|
}
|
|
|
|
compatible := []pluginInfo{}
|
|
incompatible := []pluginInfo{}
|
|
for _, name := range strings.Split(output, "\n") {
|
|
name = strings.TrimSpace(name)
|
|
if name == "" || validatePluginName(name) != nil {
|
|
continue
|
|
}
|
|
manifestOutput, err := h.execInContainer(ctx, containerName, []string{
|
|
"cat", fmt.Sprintf("/configs/plugins/%s/plugin.yaml", name),
|
|
})
|
|
var info pluginInfo
|
|
if err != nil || manifestOutput == "" {
|
|
info = pluginInfo{Name: name}
|
|
} else {
|
|
info = parseManifestYAML(name, []byte(manifestOutput))
|
|
}
|
|
if info.supportsRuntime(targetRuntime) {
|
|
compatible = append(compatible, info)
|
|
} else {
|
|
incompatible = append(incompatible, info)
|
|
}
|
|
}
|
|
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"target_runtime": targetRuntime,
|
|
"compatible": compatible,
|
|
"incompatible": incompatible,
|
|
"all_compatible": len(incompatible) == 0,
|
|
})
|
|
}
|
|
|
|
// Install handles POST /workspaces/:id/plugins — installs a plugin.
|
|
//
|
|
// Body: {"source": "<scheme>://<spec>"}
|
|
//
|
|
// - {"source": "local://my-plugin"} → install from platform registry
|
|
// - {"source": "github://owner/repo"} → install from GitHub
|
|
// - {"source": "github://owner/repo#v1.2.0"} → pinned ref
|
|
// - {"source": "clawhub://sonoscli@1.2.0"} → when a ClawHub resolver is registered
|
|
//
|
|
// The shape of the plugin (agentskills.io format, MCP server, DeepAgents
|
|
// sub-agent, …) is orthogonal and handled by the per-runtime adapter
|
|
// inside the workspace at startup.
|
|
// installRequest is the decoded, validated payload a caller submits.
|
|
// Held out as its own type so resolveAndStage is testable without a
|
|
// gin.Context; the handler just decodes into this shape.
|
|
type installRequest struct {
|
|
Source string `json:"source"`
|
|
}
|
|
|
|
// stageResult bundles the outputs of resolveAndStage for the caller.
|
|
// Avoids a 5-value tuple return.
|
|
type stageResult struct {
|
|
StagedDir string
|
|
PluginName string
|
|
Source plugins.Source
|
|
}
|
|
|
|
func (h *PluginsHandler) Install(c *gin.Context) {
|
|
workspaceID := c.Param("id")
|
|
// Cap the JSON body so a pathological POST can't exhaust parser memory.
|
|
bodyMax := envx.Int64("PLUGIN_INSTALL_BODY_MAX_BYTES", defaultInstallBodyMaxBytes)
|
|
c.Request.Body = http.MaxBytesReader(c.Writer, c.Request.Body, bodyMax)
|
|
|
|
// Bound the whole install (fetch + copy) so a slow/malicious source
|
|
// can't tie up an HTTP handler goroutine indefinitely. Overridable
|
|
// via PLUGIN_INSTALL_FETCH_TIMEOUT (duration string, e.g. "10m").
|
|
timeout := envx.Duration("PLUGIN_INSTALL_FETCH_TIMEOUT", defaultInstallFetchTimeout)
|
|
ctx, cancel := context.WithTimeout(c.Request.Context(), timeout)
|
|
defer cancel()
|
|
|
|
var req installRequest
|
|
if err := c.ShouldBindJSON(&req); err != nil {
|
|
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
|
|
return
|
|
}
|
|
|
|
result, err := h.resolveAndStage(ctx, req)
|
|
if err != nil {
|
|
var he *httpErr
|
|
if errors.As(err, &he) {
|
|
c.JSON(he.Status, he.Body)
|
|
return
|
|
}
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
|
return
|
|
}
|
|
// On success, we own stagedDir cleanup. On error, resolveAndStage
|
|
// has already cleaned it up (and its returned result is nil).
|
|
defer os.RemoveAll(result.StagedDir)
|
|
|
|
if err := h.deliverToContainer(ctx, workspaceID, result); err != nil {
|
|
var he *httpErr
|
|
if errors.As(err, &he) {
|
|
c.JSON(he.Status, he.Body)
|
|
return
|
|
}
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
|
return
|
|
}
|
|
|
|
log.Printf("Plugin install: %s via %s → workspace %s (restarting)", result.PluginName, result.Source.Scheme, workspaceID)
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"status": "installed",
|
|
"plugin": result.PluginName,
|
|
"source": result.Source.Raw(),
|
|
})
|
|
}
|
|
|
|
// resolveAndStage parses a validated request, dispatches to the right
|
|
// SourceResolver, fetches the plugin into a temp dir, and validates the
|
|
// returned name + staged size.
|
|
//
|
|
// On any error the staging tempdir (if created) is removed before return,
|
|
// and the returned *stageResult is nil. Callers own cleanup of
|
|
// result.StagedDir on success via defer os.RemoveAll.
|
|
func (h *PluginsHandler) resolveAndStage(ctx context.Context, req installRequest) (*stageResult, error) {
|
|
if req.Source == "" {
|
|
return nil, newHTTPErr(http.StatusBadRequest, gin.H{
|
|
"error": "'source' is required (e.g. \"local://my-plugin\" or \"github://owner/repo\")",
|
|
})
|
|
}
|
|
|
|
source, err := plugins.ParseSource(req.Source)
|
|
if err != nil {
|
|
return nil, newHTTPErr(http.StatusBadRequest, gin.H{"error": err.Error()})
|
|
}
|
|
resolver, err := h.sources.Resolve(source)
|
|
if err != nil {
|
|
return nil, newHTTPErr(http.StatusBadRequest, gin.H{
|
|
"error": err.Error(),
|
|
"available_schemes": h.sources.Schemes(),
|
|
})
|
|
}
|
|
// Front-run obvious input validation for local sources so path-
|
|
// traversal attempts yield 400 rather than a resolver-level 502.
|
|
if source.Scheme == "local" {
|
|
if err := validatePluginName(source.Spec); err != nil {
|
|
return nil, newHTTPErr(http.StatusBadRequest, gin.H{"error": err.Error()})
|
|
}
|
|
}
|
|
|
|
stagedDir, err := os.MkdirTemp("", "molecule-plugin-fetch-*")
|
|
if err != nil {
|
|
return nil, newHTTPErr(http.StatusInternalServerError, gin.H{"error": "failed to create staging dir"})
|
|
}
|
|
// From here, we own stagedDir. Every error path below removes it
|
|
// before returning; the caller's defer takes over on success.
|
|
cleanup := func() { _ = os.RemoveAll(stagedDir) }
|
|
|
|
pluginName, err := resolver.Fetch(ctx, source.Spec, stagedDir)
|
|
if err != nil {
|
|
cleanup()
|
|
log.Printf("Plugin install: resolver %s failed for %s: %v", source.Scheme, source.Spec, err)
|
|
status := http.StatusBadGateway
|
|
if errors.Is(err, plugins.ErrPluginNotFound) {
|
|
status = http.StatusNotFound
|
|
} else if errors.Is(err, context.DeadlineExceeded) {
|
|
status = http.StatusGatewayTimeout
|
|
}
|
|
return nil, newHTTPErr(status, gin.H{
|
|
"error": fmt.Sprintf("failed to fetch plugin from %s: %v", source.Scheme, err),
|
|
"source": source.Raw(),
|
|
})
|
|
}
|
|
if err := validatePluginName(pluginName); err != nil {
|
|
cleanup()
|
|
return nil, newHTTPErr(http.StatusBadRequest, gin.H{
|
|
"error": fmt.Sprintf("resolver returned invalid plugin name %q: %v", pluginName, err),
|
|
"source": source.Raw(),
|
|
})
|
|
}
|
|
limit := envx.Int64("PLUGIN_INSTALL_MAX_DIR_BYTES", defaultInstallMaxDirBytes)
|
|
if _, err := dirSize(stagedDir, limit); err != nil {
|
|
cleanup()
|
|
return nil, newHTTPErr(http.StatusRequestEntityTooLarge, gin.H{
|
|
"error": err.Error(),
|
|
"source": source.Raw(),
|
|
})
|
|
}
|
|
return &stageResult{StagedDir: stagedDir, PluginName: pluginName, Source: source}, nil
|
|
}
|
|
|
|
// deliverToContainer copies the staged plugin dir into the workspace
|
|
// container, chowns it for the agent user, and triggers a restart.
|
|
// Returns a typed *httpErr on failure; nil on success.
|
|
func (h *PluginsHandler) deliverToContainer(ctx context.Context, workspaceID string, r *stageResult) error {
|
|
containerName := h.findRunningContainer(ctx, workspaceID)
|
|
if containerName == "" {
|
|
return newHTTPErr(http.StatusServiceUnavailable, gin.H{"error": "workspace container not running"})
|
|
}
|
|
if err := h.copyPluginToContainer(ctx, containerName, r.StagedDir, r.PluginName); err != nil {
|
|
log.Printf("Plugin install: failed to copy %s to %s: %v", r.PluginName, workspaceID, err)
|
|
return newHTTPErr(http.StatusInternalServerError, gin.H{"error": "failed to copy plugin to container"})
|
|
}
|
|
h.execAsRoot(ctx, containerName, []string{
|
|
"chown", "-R", "1000:1000", "/configs/plugins/" + r.PluginName,
|
|
})
|
|
if h.restartFunc != nil {
|
|
go h.restartFunc(workspaceID)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Uninstall handles DELETE /workspaces/:id/plugins/:name — removes a plugin.
|
|
func (h *PluginsHandler) Uninstall(c *gin.Context) {
|
|
workspaceID := c.Param("id")
|
|
pluginName := c.Param("name")
|
|
ctx := c.Request.Context()
|
|
|
|
if err := validatePluginName(pluginName); err != nil {
|
|
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
|
|
return
|
|
}
|
|
|
|
containerName := h.findRunningContainer(ctx, workspaceID)
|
|
if containerName == "" {
|
|
c.JSON(http.StatusServiceUnavailable, gin.H{"error": "workspace container not running"})
|
|
return
|
|
}
|
|
|
|
// Read the plugin's manifest BEFORE deletion to learn which skill dirs
|
|
// it owns, so we can clean them out of /configs/skills/ and avoid the
|
|
// auto-restart re-mounting them. Issue #106.
|
|
skillNames := h.readPluginSkillsFromContainer(ctx, containerName, pluginName)
|
|
|
|
// 1. Strip plugin's rule/fragment markers from CLAUDE.md (mirrors
|
|
// AgentskillsAdaptor.uninstall lines 184-188). Best-effort: if
|
|
// the user edited CLAUDE.md, our marker stays untouched.
|
|
h.stripPluginMarkersFromMemory(ctx, containerName, pluginName)
|
|
|
|
// 2. Remove copied skill dirs declared in the plugin's plugin.yaml.
|
|
for _, skill := range skillNames {
|
|
if err := validatePluginName(skill); err != nil {
|
|
// Defensive: a malformed skill name in plugin.yaml shouldn't
|
|
// turn into a path-traversal exec. Just skip it.
|
|
log.Printf("Plugin uninstall: skipping invalid skill name %q in %s: %v", skill, pluginName, err)
|
|
continue
|
|
}
|
|
_, _ = h.execAsRoot(ctx, containerName, []string{
|
|
"rm", "-rf", "/configs/skills/" + skill,
|
|
})
|
|
}
|
|
|
|
// 3. Delete the plugin directory itself (as root to handle file ownership).
|
|
_, err := h.execAsRoot(ctx, containerName, []string{
|
|
"rm", "-rf", "/configs/plugins/" + pluginName,
|
|
})
|
|
if err != nil {
|
|
log.Printf("Plugin uninstall: failed to remove %s from %s: %v", pluginName, workspaceID, err)
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to remove plugin"})
|
|
return
|
|
}
|
|
|
|
// Verify deletion before restart
|
|
h.execInContainer(ctx, containerName, []string{"sync"})
|
|
|
|
// Auto-restart (small delay to ensure fs writes are flushed)
|
|
if h.restartFunc != nil {
|
|
go func() {
|
|
time.Sleep(2 * time.Second)
|
|
h.restartFunc(workspaceID)
|
|
}()
|
|
}
|
|
|
|
log.Printf("Plugin uninstall: %s from workspace %s (restarting)", pluginName, workspaceID)
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"status": "uninstalled",
|
|
"plugin": pluginName,
|
|
})
|
|
}
|
|
|
|
// --- helpers ---
|
|
|
|
// readPluginSkillsFromContainer reads /configs/plugins/<name>/plugin.yaml
|
|
// from the running container and returns the `skills:` list. Returns an
|
|
// empty slice if the file is missing or unparseable — uninstall must keep
|
|
// running even if the manifest is gone (already half-deleted, etc.).
|
|
func (h *PluginsHandler) readPluginSkillsFromContainer(ctx context.Context, containerName, pluginName string) []string {
|
|
out, err := h.execInContainer(ctx, containerName, []string{
|
|
"cat", "/configs/plugins/" + pluginName + "/plugin.yaml",
|
|
})
|
|
if err != nil || len(out) == 0 {
|
|
return nil
|
|
}
|
|
info := parseManifestYAML(pluginName, []byte(out))
|
|
return info.Skills
|
|
}
|
|
|
|
// stripPluginMarkersFromMemory rewrites /configs/CLAUDE.md (the runtime's
|
|
// memory file) in-place, removing any block whose marker line starts with
|
|
// `# Plugin: <name> /` — mirrors AgentskillsAdaptor.uninstall's stripping
|
|
// logic so install/uninstall are symmetric. Best-effort: silent on read or
|
|
// write failure, since the rest of uninstall must still succeed.
|
|
func (h *PluginsHandler) stripPluginMarkersFromMemory(ctx context.Context, containerName, pluginName string) {
|
|
// Use sed via bash -c for atomic in-place delete: drop the marker line
|
|
// and the blank line that follows it (install adds a leading blank line
|
|
// before the marker via append_to_memory). Three sed passes mirror the
|
|
// install layout: leading blank, marker line, then we also strip empty
|
|
// trailing markers from older installs that didn't add the prefix blank.
|
|
// Falls through silently if CLAUDE.md doesn't exist (fresh workspace).
|
|
marker := "# Plugin: " + pluginName + " /"
|
|
// AgentskillsAdaptor.append_to_memory writes blocks of the shape:
|
|
// # Plugin: <name> / rule: foo.md
|
|
// <blank>
|
|
// <content lines…>
|
|
// separated from the next block by a single blank line. We strip from
|
|
// our marker up to (but not including) the next `# Plugin:` line of
|
|
// any plugin (which marks the boundary), or EOF. Other plugins'
|
|
// blocks and surrounding user content stay intact.
|
|
// Block layout per AgentskillsAdaptor: marker line, one blank, content
|
|
// lines, then a terminating blank (or EOF, or the next plugin's marker).
|
|
// We track blanks-seen-since-marker: the 2nd blank ends our skip; any
|
|
// `# Plugin: ` line also ends our skip (handles back-to-back blocks).
|
|
script := fmt.Sprintf(
|
|
`awk 'BEGIN{skip=0; blanks=0} /^%s/{skip=1; blanks=0; next} skip==1 && /^[[:space:]]*$/{blanks++; if(blanks>=2){skip=0; print; next} next} /^# Plugin: /{if(skip==1)skip=0} skip==1{next} {print}' /configs/CLAUDE.md > /tmp/claude.new && mv /tmp/claude.new /configs/CLAUDE.md`,
|
|
regexpEscapeForAwk(marker),
|
|
)
|
|
_, _ = h.execAsRoot(ctx, containerName, []string{"bash", "-c", script})
|
|
}
|
|
|
|
// regexpEscapeForAwk escapes characters that have special meaning inside an
|
|
// awk ERE pattern. Plugin names go through validatePluginName so the input
|
|
// is already restricted to [A-Za-z0-9_-], but the literal `# Plugin: …/`
|
|
// prefix and a future relaxation of validatePluginName both motivate
|
|
// escaping defensively.
|
|
func regexpEscapeForAwk(s string) string {
|
|
// `/` is the regex delimiter in awk's /.../ syntax — must be escaped
|
|
// alongside the standard regex specials.
|
|
specials := `\^$.|?*+()[]{}/`
|
|
var b strings.Builder
|
|
for _, r := range s {
|
|
if strings.ContainsRune(specials, r) {
|
|
b.WriteByte('\\')
|
|
}
|
|
b.WriteRune(r)
|
|
}
|
|
return b.String()
|
|
}
|
|
|
|
func (h *PluginsHandler) readPluginManifest(pluginPath, fallbackName string) pluginInfo {
|
|
data, err := os.ReadFile(filepath.Join(pluginPath, "plugin.yaml"))
|
|
if err != nil {
|
|
return pluginInfo{Name: fallbackName}
|
|
}
|
|
return parseManifestYAML(fallbackName, data)
|
|
}
|
|
|
|
// parseManifestYAML parses plugin.yaml bytes into pluginInfo.
|
|
func parseManifestYAML(fallbackName string, data []byte) pluginInfo {
|
|
info := pluginInfo{Name: fallbackName}
|
|
var raw map[string]interface{}
|
|
if yaml.Unmarshal(data, &raw) != nil {
|
|
return info
|
|
}
|
|
info.Version = strDefault(raw, "version", "")
|
|
info.Description = strDefault(raw, "description", "")
|
|
info.Author = strDefault(raw, "author", "")
|
|
if tags, ok := raw["tags"].([]interface{}); ok {
|
|
for _, t := range tags {
|
|
if s, ok := t.(string); ok {
|
|
info.Tags = append(info.Tags, s)
|
|
}
|
|
}
|
|
}
|
|
if skills, ok := raw["skills"].([]interface{}); ok {
|
|
for _, s := range skills {
|
|
if str, ok := s.(string); ok {
|
|
info.Skills = append(info.Skills, str)
|
|
}
|
|
}
|
|
}
|
|
if runtimes, ok := raw["runtimes"].([]interface{}); ok {
|
|
for _, r := range runtimes {
|
|
if str, ok := r.(string); ok {
|
|
info.Runtimes = append(info.Runtimes, str)
|
|
}
|
|
}
|
|
}
|
|
return info
|
|
}
|
|
|
|
func strDefault(m map[string]interface{}, key, fallback string) string {
|
|
if v, ok := m[key]; ok {
|
|
if s, ok := v.(string); ok {
|
|
return s
|
|
}
|
|
}
|
|
return fallback
|
|
}
|
|
|
|
func (h *PluginsHandler) findRunningContainer(ctx context.Context, workspaceID string) string {
|
|
if h.docker == nil {
|
|
return ""
|
|
}
|
|
name := provisioner.ContainerName(workspaceID)
|
|
info, err := h.docker.ContainerInspect(ctx, name)
|
|
if err == nil && info.State.Running {
|
|
return name
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func (h *PluginsHandler) execAsRoot(ctx context.Context, containerName string, cmd []string) (string, error) {
|
|
return h.execInContainerAs(ctx, containerName, "root", cmd)
|
|
}
|
|
|
|
func (h *PluginsHandler) execInContainer(ctx context.Context, containerName string, cmd []string) (string, error) {
|
|
return h.execInContainerAs(ctx, containerName, "", cmd)
|
|
}
|
|
|
|
func (h *PluginsHandler) execInContainerAs(ctx context.Context, containerName, user string, cmd []string) (string, error) {
|
|
execCfg := container.ExecOptions{
|
|
Cmd: cmd,
|
|
AttachStdout: true,
|
|
AttachStderr: true,
|
|
User: user,
|
|
}
|
|
execID, err := h.docker.ContainerExecCreate(ctx, containerName, execCfg)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
resp, err := h.docker.ContainerExecAttach(ctx, execID.ID, container.ExecAttachOptions{})
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer resp.Close()
|
|
var stdout bytes.Buffer
|
|
stdcopy.StdCopy(&stdout, io.Discard, resp.Reader)
|
|
return strings.TrimSpace(stdout.String()), nil
|
|
}
|
|
|
|
// copyPluginToContainer creates a tar from a host directory and copies it into /configs/plugins/<name>/.
|
|
// The tar entries are prefixed with plugins/<name>/ so Docker creates the directory structure.
|
|
func (h *PluginsHandler) copyPluginToContainer(ctx context.Context, containerName, hostDir, pluginName string) error {
|
|
var buf bytes.Buffer
|
|
tw := tar.NewWriter(&buf)
|
|
|
|
err := filepath.Walk(hostDir, func(path string, info os.FileInfo, err error) error {
|
|
if err != nil {
|
|
return err
|
|
}
|
|
rel, err := filepath.Rel(hostDir, path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
header, err := tar.FileInfoHeader(info, "")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// Prefix: plugins/<pluginName>/<rel> → extracts under /configs/
|
|
header.Name = filepath.Join("plugins", pluginName, rel)
|
|
|
|
if err := tw.WriteHeader(header); err != nil {
|
|
return err
|
|
}
|
|
if !info.IsDir() {
|
|
data, err := os.ReadFile(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if _, err := tw.Write(data); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
return fmt.Errorf("failed to create tar from %s: %w", hostDir, err)
|
|
}
|
|
if err := tw.Close(); err != nil {
|
|
return fmt.Errorf("failed to close tar: %w", err)
|
|
}
|
|
|
|
// Copy to /configs — the tar's plugins/<name>/ prefix creates the directory
|
|
return h.docker.CopyToContainer(ctx, containerName, "/configs", &buf, container.CopyToContainerOptions{})
|
|
}
|
|
|
|
// Download handles GET /workspaces/:id/plugins/:name/download?source=<scheme://spec>
|
|
//
|
|
// Phase 30.3 — stream the named plugin as a gzipped tarball so remote
|
|
// agents can pull and unpack locally. Replaces the Docker-exec install
|
|
// path for `runtime='external'` workspaces.
|
|
//
|
|
// The `source` query parameter is optional. When omitted we default to
|
|
// `local://<name>` (the platform's curated registry). When set, any
|
|
// registered scheme works — `github://owner/repo`, future `clawhub://…`,
|
|
// etc. — which lets a workspace install plugins from upstream repos
|
|
// without the platform pre-staging them.
|
|
//
|
|
// Auth: requires the workspace's bearer token (same shape as 30.2). A
|
|
// plugin tarball often ships rule text + skill files that reference
|
|
// internal APIs, so we prefer fail-closed on DB errors to prevent a
|
|
// hiccup from turning this into an unauth'd download endpoint.
|
|
func (h *PluginsHandler) Download(c *gin.Context) {
|
|
workspaceID := c.Param("id")
|
|
pluginName := c.Param("name")
|
|
ctx := c.Request.Context()
|
|
|
|
if err := validatePluginName(pluginName); err != nil {
|
|
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
|
|
return
|
|
}
|
|
|
|
// Auth gate — workspace token required (fail-closed on DB errors).
|
|
hasLive, hlErr := wsauth.HasAnyLiveToken(ctx, db.DB, workspaceID)
|
|
if hlErr != nil {
|
|
log.Printf("wsauth: plugin.Download HasAnyLiveToken(%s) failed: %v", workspaceID, hlErr)
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": "auth check failed"})
|
|
return
|
|
}
|
|
if hasLive {
|
|
tok := wsauth.BearerTokenFromHeader(c.GetHeader("Authorization"))
|
|
if tok == "" {
|
|
c.JSON(http.StatusUnauthorized, gin.H{"error": "missing workspace auth token"})
|
|
return
|
|
}
|
|
if err := wsauth.ValidateToken(ctx, db.DB, workspaceID, tok); err != nil {
|
|
c.JSON(http.StatusUnauthorized, gin.H{"error": "invalid workspace auth token"})
|
|
return
|
|
}
|
|
}
|
|
|
|
// Resolve source — default to local://<name> when caller doesn't
|
|
// specify. This is the common case: pulling a platform-curated
|
|
// plugin by its canonical name.
|
|
source := c.Query("source")
|
|
if source == "" {
|
|
source = "local://" + pluginName
|
|
}
|
|
|
|
// Reuse the existing install-layer bounds so download shares
|
|
// fetch-timeout, body limits, and staged-dir size caps with Install.
|
|
timeout := envx.Duration("PLUGIN_INSTALL_FETCH_TIMEOUT", defaultInstallFetchTimeout)
|
|
fetchCtx, cancel := context.WithTimeout(ctx, timeout)
|
|
defer cancel()
|
|
|
|
result, err := h.resolveAndStage(fetchCtx, installRequest{Source: source})
|
|
if err != nil {
|
|
var he *httpErr
|
|
if errors.As(err, &he) {
|
|
c.JSON(he.Status, he.Body)
|
|
return
|
|
}
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
|
return
|
|
}
|
|
defer os.RemoveAll(result.StagedDir)
|
|
|
|
// Sanity: resolved plugin name must match the URL path param.
|
|
// Resolvers can return a plugin.yaml-derived name that differs
|
|
// from the URL segment; reject the mismatch rather than ship a
|
|
// tarball labeled "foo" that actually contains plugin "bar".
|
|
if result.PluginName != pluginName {
|
|
c.JSON(http.StatusBadRequest, gin.H{
|
|
"error": fmt.Sprintf("source resolved to plugin %q but URL requested %q", result.PluginName, pluginName),
|
|
"resolved_name": result.PluginName,
|
|
"requested_name": pluginName,
|
|
})
|
|
return
|
|
}
|
|
|
|
// Buffer the full tar.gz before writing any response bytes. This lets
|
|
// us emit a clean 5xx if tar packing fails — previously, a partial
|
|
// stream surfaced as HTTP 200 + truncated body, which made remote
|
|
// agents fail at unpack time with cryptic gzip errors instead of
|
|
// distinguishing "platform borked" from "network glitch".
|
|
//
|
|
// Plugin sizes are bounded by PLUGIN_INSTALL_MAX_DIR_BYTES (default
|
|
// 100 MiB) which `resolveAndStage` already validated — buffering at
|
|
// that scale is acceptable. If we ever raise the cap above ~500 MiB,
|
|
// switch to a temp file backed io.ReadSeeker and use http.ServeContent.
|
|
var buf bytes.Buffer
|
|
gz := gzip.NewWriter(&buf)
|
|
tw := tar.NewWriter(gz)
|
|
if err := streamDirAsTar(result.StagedDir, tw); err != nil {
|
|
log.Printf("plugin.Download: tar pack failed for %s: %v", pluginName, err)
|
|
c.JSON(http.StatusInternalServerError, gin.H{
|
|
"error": "failed to pack plugin",
|
|
"plugin": pluginName,
|
|
})
|
|
return
|
|
}
|
|
if err := tw.Close(); err != nil {
|
|
log.Printf("plugin.Download: tar close failed for %s: %v", pluginName, err)
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to finalize tar"})
|
|
return
|
|
}
|
|
if err := gz.Close(); err != nil {
|
|
log.Printf("plugin.Download: gzip close failed for %s: %v", pluginName, err)
|
|
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to finalize gzip"})
|
|
return
|
|
}
|
|
|
|
c.Header("Content-Type", "application/gzip")
|
|
c.Header("Content-Disposition", fmt.Sprintf(`attachment; filename="%s.tar.gz"`, pluginName))
|
|
c.Header("Content-Length", fmt.Sprintf("%d", buf.Len()))
|
|
c.Header("X-Plugin-Name", pluginName)
|
|
c.Header("X-Plugin-Source", result.Source.Raw())
|
|
if _, err := c.Writer.Write(buf.Bytes()); err != nil {
|
|
log.Printf("plugin.Download: response write failed for %s: %v", pluginName, err)
|
|
}
|
|
}
|
|
|
|
// streamDirAsTar writes every regular file + dir under `root` to the tar
|
|
// writer, using paths relative to root so the caller's unpack produces
|
|
// `<name>/<original-layout>` without any leading tempdir components.
|
|
// Symlinks are skipped intentionally — they would usually point outside
|
|
// the staged tree and we don't want to expose platform filesystem paths.
|
|
func streamDirAsTar(root string, tw *tar.Writer) error {
|
|
return filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if info.Mode()&os.ModeSymlink != 0 {
|
|
return nil // skip symlinks — see doc comment
|
|
}
|
|
rel, err := filepath.Rel(root, path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if rel == "." {
|
|
return nil
|
|
}
|
|
hdr, err := tar.FileInfoHeader(info, "")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
hdr.Name = rel
|
|
if err := tw.WriteHeader(hdr); err != nil {
|
|
return err
|
|
}
|
|
if !info.Mode().IsRegular() {
|
|
return nil
|
|
}
|
|
f, err := os.Open(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer f.Close()
|
|
_, err = io.Copy(tw, f)
|
|
return err
|
|
})
|
|
}
|