Files
silo-server/internal/api/handlers/plugins.go
T

1369 lines
46 KiB
Go

package handlers
import (
"bytes"
"context"
"encoding/json"
"errors"
"io"
"log/slog"
"net/http"
"os"
"strconv"
"strings"
"time"
"github.com/go-chi/chi/v5"
pluginv1 "github.com/Silo-Server/silo-plugin-sdk/pkg/pluginproto/silo/plugin/v1"
apimw "github.com/Silo-Server/silo-server/internal/api/middleware"
"github.com/Silo-Server/silo-server/internal/metadata"
"github.com/Silo-Server/silo-server/internal/pluginhost"
"github.com/Silo-Server/silo-server/internal/plugins"
)
const maxPluginUploadSize = 256 << 20
type PluginHandler struct {
repositories *plugins.RepositoryStore
installations *plugins.InstallationStore
configs *plugins.RuntimeConfigStore
service *plugins.Service
userConfig *plugins.UserConfigStore
proxy *plugins.HTTPProxy
chainRepo *metadata.ChainRepository
imageResolver *metadata.PluginImageResolver
}
func NewPluginHandler(
repositories *plugins.RepositoryStore,
installations *plugins.InstallationStore,
configs *plugins.RuntimeConfigStore,
service *plugins.Service,
userConfig *plugins.UserConfigStore,
proxy *plugins.HTTPProxy,
chainRepo *metadata.ChainRepository,
imageResolver *metadata.PluginImageResolver,
) *PluginHandler {
return &PluginHandler{
repositories: repositories,
installations: installations,
configs: configs,
service: service,
userConfig: userConfig,
proxy: proxy,
chainRepo: chainRepo,
imageResolver: imageResolver,
}
}
type pluginRepositoryRequest struct {
URL string `json:"url"`
DisplayName string `json:"display_name"`
Enabled *bool `json:"enabled,omitempty"`
}
type pluginInstallationCreateRequest struct {
RepositoryID *int `json:"repository_id,omitempty"`
PluginID string `json:"plugin_id,omitempty"`
Version string `json:"version,omitempty"`
ArchiveURL string `json:"archive_url,omitempty"`
}
type pluginInstallationUpdateRequest struct {
Enabled *bool `json:"enabled,omitempty"`
UpdatePolicy *string `json:"update_policy,omitempty"`
}
type pluginConfigRequest struct {
Key string `json:"key"`
Value map[string]any `json:"value"`
}
type pluginAuthBindingRequest struct {
CapabilityID string `json:"capability_id"`
Enabled bool `json:"enabled"`
DisplayOrder int `json:"display_order"`
AutoProvision bool `json:"auto_provision"`
DefaultLogin bool `json:"default_login"`
}
type pluginTaskBindingRequest struct {
Enabled bool `json:"enabled"`
Trigger map[string]any `json:"trigger"`
}
type userPluginSettingsRequest struct {
Values map[string]string `json:"values"`
}
type pluginRepositoryResponse struct {
ID int `json:"id"`
URL string `json:"url"`
DisplayName string `json:"display_name"`
Enabled bool `json:"enabled"`
LastFetchedAt *time.Time `json:"last_fetched_at,omitempty"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
type pluginCatalogResponse struct {
RepositoryID int `json:"repository_id"`
PluginID string `json:"plugin_id"`
Version string `json:"version"`
ArchiveURL string `json:"archive_url"`
Capabilities []pluginCapabilityJSON `json:"capabilities"`
GlobalConfigSchema []pluginConfigSchemaJSON `json:"global_config_schema"`
UserConfigSchema []pluginConfigSchemaJSON `json:"user_config_schema"`
Routes []pluginRouteJSON `json:"routes"`
Assets []pluginAssetJSON `json:"assets"`
Metadata map[string]any `json:"metadata,omitempty"`
}
type pluginInstallationResponse struct {
ID int `json:"id"`
RepositoryID *int `json:"repository_id,omitempty"`
PluginID string `json:"plugin_id"`
Version string `json:"version"`
InstallPath string `json:"install_path"`
Enabled bool `json:"enabled"`
UpdatePolicy string `json:"update_policy"`
AvailableVersion *string `json:"available_version,omitempty"`
Capabilities []pluginCapabilityJSON `json:"capabilities"`
GlobalConfigSchema []pluginConfigSchemaJSON `json:"global_config_schema"`
UserConfigSchema []pluginConfigSchemaJSON `json:"user_config_schema"`
Routes []pluginRouteJSON `json:"routes"`
Assets []pluginAssetJSON `json:"assets"`
Metadata map[string]any `json:"metadata,omitempty"`
GlobalConfigs []pluginConfigValueJSON `json:"global_configs"`
AuthBindings []pluginAuthBindingJSON `json:"auth_bindings"`
TaskBindings []pluginTaskBindingJSON `json:"task_bindings"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
type pluginConfigSchemaJSON struct {
Key string `json:"key"`
Title string `json:"title"`
Description string `json:"description"`
JSONSchema string `json:"json_schema"`
Required bool `json:"required"`
AdminForm *pluginAdminFormJSON `json:"admin_form,omitempty"`
}
type pluginAdminFormJSON struct {
Fields []pluginAdminFormFieldJSON `json:"fields"`
SubmitLabel string `json:"submit_label,omitempty"`
}
type pluginAdminFormFieldJSON struct {
Key string `json:"key"`
Label string `json:"label"`
Description string `json:"description,omitempty"`
Control string `json:"control"`
Placeholder string `json:"placeholder,omitempty"`
Required bool `json:"required"`
Secret bool `json:"secret"`
Multiline bool `json:"multiline"`
DefaultValue any `json:"default_value,omitempty"`
Options []pluginAdminFormOptionJSON `json:"options,omitempty"`
Rows int32 `json:"rows,omitempty"`
}
type pluginAdminFormOptionJSON struct {
Value string `json:"value"`
Label string `json:"label"`
Description string `json:"description,omitempty"`
}
type pluginCapabilityJSON struct {
Type string `json:"type"`
ID string `json:"id"`
DisplayName string `json:"display_name"`
Description string `json:"description"`
Subscriptions []string `json:"subscriptions,omitempty"`
ConfigSchema []pluginConfigSchemaJSON `json:"config_schema,omitempty"`
Metadata map[string]any `json:"metadata,omitempty"`
}
type pluginRouteJSON struct {
ID string `json:"id"`
Method string `json:"method"`
Path string `json:"path"`
Access string `json:"access"`
Navigable bool `json:"navigable"`
NavigationLabel string `json:"navigation_label"`
NavigationKind string `json:"navigation_kind"`
StaticAsset bool `json:"static_asset"`
}
type pluginAssetJSON struct {
Path string `json:"path"`
ContentType string `json:"content_type"`
Integrity string `json:"integrity"`
}
type pluginConfigValueJSON struct {
Key string `json:"key"`
Value map[string]any `json:"value"`
}
type pluginAuthBindingJSON struct {
CapabilityID string `json:"capability_id"`
Enabled bool `json:"enabled"`
DisplayOrder int `json:"display_order"`
AutoProvision bool `json:"auto_provision"`
DefaultLogin bool `json:"default_login"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
type pluginTaskBindingJSON struct {
CapabilityID string `json:"capability_id"`
Enabled bool `json:"enabled"`
Trigger map[string]any `json:"trigger"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
type pluginUserSettingsSummary struct {
ID int `json:"id"`
PluginID string `json:"plugin_id"`
Version string `json:"version"`
UserConfigSchema []pluginConfigSchemaJSON `json:"user_config_schema"`
Routes []pluginRouteJSON `json:"routes"`
Assets []pluginAssetJSON `json:"assets"`
}
type pluginUserSettingsListResponse struct {
Installations []pluginUserSettingsSummary `json:"installations"`
}
type pluginUserSettingsDetailResponse struct {
Installation pluginUserSettingsSummary `json:"installation"`
Values map[string]string `json:"values"`
}
type pluginTaskBindingUpdateResponse struct {
RestartRequired bool `json:"restart_required"`
}
func (h *PluginHandler) HandleListRepositories(w http.ResponseWriter, r *http.Request) {
repositories, err := h.repositories.List(r.Context())
if err != nil {
slog.Error("listing plugin repositories", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to list plugin repositories")
return
}
response := make([]pluginRepositoryResponse, 0, len(repositories))
for _, repository := range repositories {
response = append(response, toPluginRepositoryResponse(repository))
}
writeJSON(w, http.StatusOK, response)
}
func (h *PluginHandler) HandleCreateRepository(w http.ResponseWriter, r *http.Request) {
var req pluginRepositoryRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
if strings.TrimSpace(req.URL) == "" || strings.TrimSpace(req.DisplayName) == "" {
writeError(w, http.StatusBadRequest, "bad_request", "url and display_name are required")
return
}
repository, err := h.repositories.Create(r.Context(), plugins.CreateRepositoryInput{
URL: req.URL,
DisplayName: req.DisplayName,
Enabled: req.Enabled,
})
if err != nil {
slog.Error("creating plugin repository", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to create plugin repository")
return
}
writeJSON(w, http.StatusCreated, toPluginRepositoryResponse(repository))
}
func (h *PluginHandler) HandleUpdateRepository(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid repository ID")
return
}
var req pluginRepositoryRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
input := plugins.UpdateRepositoryInput{
Enabled: req.Enabled,
}
if strings.TrimSpace(req.URL) != "" {
input.URL = &req.URL
}
if strings.TrimSpace(req.DisplayName) != "" {
input.DisplayName = &req.DisplayName
}
if err := h.repositories.Update(r.Context(), id, input); err != nil {
if errors.Is(err, plugins.ErrRepositoryNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin repository not found")
return
}
slog.Error("updating plugin repository", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to update plugin repository")
return
}
repository, err := h.repositories.GetByID(r.Context(), id)
if err != nil {
slog.Error("loading updated plugin repository", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load plugin repository")
return
}
writeJSON(w, http.StatusOK, toPluginRepositoryResponse(repository))
}
func (h *PluginHandler) HandleDeleteRepository(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid repository ID")
return
}
if err := h.repositories.Delete(r.Context(), id); err != nil {
if errors.Is(err, plugins.ErrRepositoryNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin repository not found")
return
}
slog.Error("deleting plugin repository", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to delete plugin repository")
return
}
w.WriteHeader(http.StatusNoContent)
}
func (h *PluginHandler) HandleCatalog(w http.ResponseWriter, r *http.Request) {
entries, err := h.service.FetchCatalog(r.Context())
if err != nil {
slog.Error("fetching plugin catalog", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to fetch plugin catalog")
return
}
response := make([]pluginCatalogResponse, 0, len(entries))
for _, entry := range entries {
response = append(response, pluginCatalogResponse{
RepositoryID: entry.RepositoryID,
PluginID: entry.Manifest.GetPluginId(),
Version: entry.Manifest.GetVersion(),
ArchiveURL: entry.ArchiveURL,
Capabilities: capabilitiesToJSON(entry.Manifest.GetCapabilities()),
GlobalConfigSchema: configSchemasToJSON(entry.Manifest.GetGlobalConfigSchema()),
UserConfigSchema: configSchemasToJSON(entry.Manifest.GetUserConfigSchema()),
Routes: routesToJSON(entry.Manifest.GetHttpRoutes()),
Assets: assetsToJSON(entry.Manifest.GetAssets()),
Metadata: structToMap(entry.Manifest.GetMetadata()),
})
}
writeJSON(w, http.StatusOK, response)
}
func (h *PluginHandler) HandleListInstallations(w http.ResponseWriter, r *http.Request) {
installations, err := h.installations.List(r.Context())
if err != nil {
slog.Error("listing plugin installations", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to list plugin installations")
return
}
response, err := h.buildInstallationResponses(r.Context(), installations)
if err != nil {
slog.Error("building plugin installations response", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to build plugin installation response")
return
}
writeJSON(w, http.StatusOK, response)
}
func (h *PluginHandler) HandleCreateInstallation(w http.ResponseWriter, r *http.Request) {
var req pluginInstallationCreateRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
hasRepositoryFields := req.RepositoryID != nil || strings.TrimSpace(req.PluginID) != "" || strings.TrimSpace(req.Version) != ""
var (
result *plugins.InstallResult
err error
)
switch {
case hasRepositoryFields:
if req.RepositoryID == nil || strings.TrimSpace(req.PluginID) == "" || strings.TrimSpace(req.Version) == "" {
writeError(w, http.StatusBadRequest, "bad_request", "repository_id, plugin_id, and version are required")
return
}
if strings.TrimSpace(req.ArchiveURL) != "" {
writeError(w, http.StatusBadRequest, "bad_request", "archive_url cannot be combined with repository install fields")
return
}
result, err = h.service.InstallCatalog(r.Context(), plugins.InstallCatalogRequest{
RepositoryID: *req.RepositoryID,
PluginID: req.PluginID,
Version: req.Version,
})
default:
if strings.TrimSpace(req.ArchiveURL) == "" {
writeError(w, http.StatusBadRequest, "bad_request", "archive_url is required")
return
}
result, err = h.service.InstallRemote(r.Context(), plugins.InstallArchiveRequest{
ArchiveURL: req.ArchiveURL,
RepositoryID: req.RepositoryID,
})
}
if err != nil {
slog.Error("installing plugin archive", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to install plugin")
return
}
h.syncMetadataProviders(r.Context(), result.Installation)
h.syncImageResolvers(r.Context(), result.Installation)
response, err := h.buildInstallationResponse(r.Context(), result.Installation, result.Manifest)
if err != nil {
slog.Error("building installed plugin response", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to build plugin installation response")
return
}
writeJSON(w, http.StatusCreated, response)
}
func (h *PluginHandler) HandleUploadInstallation(w http.ResponseWriter, r *http.Request) {
r.Body = http.MaxBytesReader(w, r.Body, maxPluginUploadSize)
if err := r.ParseMultipartForm(maxPluginUploadSize); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid plugin upload")
return
}
file, header, err := r.FormFile("archive")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "archive upload is required")
return
}
defer file.Close()
tempFile, err := os.CreateTemp("", "silo-plugin-*.zip")
if err != nil {
slog.Error("creating temp plugin upload file", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to process plugin upload")
return
}
tempPath := tempFile.Name()
defer func() {
_ = tempFile.Close()
_ = os.Remove(tempPath)
}()
if _, err := io.Copy(tempFile, file); err != nil {
slog.Error("writing temp plugin upload file", "filename", header.Filename, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to process plugin upload")
return
}
if err := tempFile.Close(); err != nil {
slog.Error("closing temp plugin upload file", "filename", header.Filename, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to process plugin upload")
return
}
uploadData, err := os.ReadFile(tempPath)
if err != nil {
slog.Error("reading temp plugin upload file", "filename", header.Filename, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to process plugin upload")
return
}
var result *plugins.InstallResult
if isZipUpload(uploadData) {
result, err = h.service.InstallLocal(r.Context(), plugins.InstallArchiveRequest{
ArchivePath: tempPath,
})
} else {
result, err = h.service.InstallBinaryUpload(r.Context(), uploadData)
}
if err != nil {
slog.Error("installing uploaded plugin", "filename", header.Filename, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to install uploaded plugin")
return
}
h.syncMetadataProviders(r.Context(), result.Installation)
h.syncImageResolvers(r.Context(), result.Installation)
response, err := h.buildInstallationResponse(r.Context(), result.Installation, result.Manifest)
if err != nil {
slog.Error("building uploaded plugin response", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to build plugin installation response")
return
}
writeJSON(w, http.StatusCreated, response)
}
// syncMetadataProviders appends any metadata_provider.v1 capabilities from the
// given installation to all existing library chains.
func (h *PluginHandler) syncMetadataProviders(ctx context.Context, installation *plugins.Installation) {
if h.chainRepo == nil {
return
}
caps, err := h.installations.ListCapabilities(ctx, installation.ID)
if err != nil {
slog.Error("listing capabilities for metadata provider sync",
"installation_id", installation.ID, "error", err)
return
}
for _, cap := range caps {
if cap.Type != "metadata_provider.v1" {
continue
}
if err := h.chainRepo.AppendProviderToAllChains(ctx, installation.ID, cap.ID, func(level string) int {
return metadata.LookupDefaultPriority(ctx, h.chainRepo.Pool(), installation.ID, level)
}); err != nil {
slog.Warn("failed to append provider to library chains",
"installation_id", installation.ID,
"capability_id", cap.ID,
"error", err)
}
}
}
// syncImageResolvers registers image resolver sources for any metadata_provider.v1
// capabilities from the given installation so that plugin-prefixed image URLs
// (e.g. "tmdb://poster/abc.jpg") can be resolved at runtime.
func (h *PluginHandler) syncImageResolvers(ctx context.Context, installation *plugins.Installation) {
if h.imageResolver == nil || h.service == nil {
return
}
caps, err := h.installations.ListCapabilities(ctx, installation.ID)
if err != nil {
slog.Error("listing capabilities for image resolver sync",
"installation_id", installation.ID, "error", err)
return
}
for _, cap := range caps {
if cap.Type != "metadata_provider.v1" {
continue
}
source := metadata.NewPluginClientSource(installation.ID, cap.ID, func(
ctx context.Context, installationID int, capabilityID string,
) (metadata.PluginMetadataClient, error) {
return h.service.MetadataProviderClient(ctx, installationID, capabilityID)
})
h.imageResolver.RegisterSource(cap.ID, source)
slog.Info("registered plugin image resolver", "capability_id", cap.ID, "installation_id", installation.ID)
}
}
func isZipUpload(data []byte) bool {
if len(data) < 4 {
return false
}
return bytes.Equal(data[:4], []byte("PK\x03\x04")) ||
bytes.Equal(data[:4], []byte("PK\x05\x06")) ||
bytes.Equal(data[:4], []byte("PK\x07\x08"))
}
func (h *PluginHandler) HandleUpdateInstallation(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
var req pluginInstallationUpdateRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
currentInstallation, err := h.installations.GetByID(r.Context(), id)
if err != nil {
if errors.Is(err, plugins.ErrInstallationNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
return
}
slog.Error("loading current plugin installation", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load plugin installation")
return
}
if req.Enabled != nil && !*req.Enabled && currentInstallation.Enabled && h.service != nil {
if err := h.service.Stop(id); err != nil && !errors.Is(err, pluginhost.ErrClientNotFound) {
slog.Error("stopping plugin before disable", "installation_id", id, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to disable plugin installation")
return
}
}
if err := h.installations.Update(r.Context(), id, plugins.UpdateInstallationInput{
Enabled: req.Enabled,
UpdatePolicy: req.UpdatePolicy,
}); err != nil {
if errors.Is(err, plugins.ErrInstallationNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
return
}
slog.Error("updating plugin installation", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to update plugin installation")
return
}
// Rebuild the event dispatcher's capability-subscriber index whenever the
// enabled state changes (enable or disable).
if req.Enabled != nil && h.service != nil {
h.service.OnLifecycleChange(r.Context())
}
installation, err := h.installations.GetByID(r.Context(), id)
if err != nil {
slog.Error("loading updated plugin installation", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load plugin installation")
return
}
// When a plugin is being enabled, register its image resolvers.
if req.Enabled != nil && *req.Enabled && !currentInstallation.Enabled {
h.syncImageResolvers(r.Context(), installation)
}
response, err := h.buildInstallationResponse(r.Context(), installation, nil)
if err != nil {
slog.Error("building updated plugin installation response", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to build plugin installation response")
return
}
writeJSON(w, http.StatusOK, response)
}
func (h *PluginHandler) HandleApplyUpdate(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
installation, err := h.service.UpdateToAvailableVersion(r.Context(), id)
if err != nil {
if errors.Is(err, plugins.ErrInstallationNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
return
}
slog.Error("apply plugin update", "installation_id", id, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to update plugin")
return
}
h.syncMetadataProviders(r.Context(), installation)
h.syncImageResolvers(r.Context(), installation)
response, err := h.buildInstallationResponse(r.Context(), installation, nil)
if err != nil {
slog.Error("building updated plugin installation response", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to build response")
return
}
writeJSON(w, http.StatusOK, response)
}
func (h *PluginHandler) HandlePutInstallationConfig(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
var req pluginConfigRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
if h.service == nil {
writeError(w, http.StatusInternalServerError, "internal_error", "Plugin service not configured")
return
}
if err := h.service.SetGlobalConfig(r.Context(), id, req.Key, req.Value); err != nil {
var validationErr *plugins.ConfigValidationError
switch {
case errors.As(err, &validationErr):
writeError(w, http.StatusBadRequest, "bad_request", validationErr.Error())
case errors.Is(err, plugins.ErrInstallationNotFound):
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
default:
slog.Error("setting plugin global config", "installation_id", id, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to save plugin config")
}
return
}
w.WriteHeader(http.StatusNoContent)
}
func (h *PluginHandler) HandleTestInstallationConfig(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
if h.service == nil {
writeError(w, http.StatusInternalServerError, "internal_error", "Plugin service not configured")
return
}
var req pluginConfigRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
if strings.TrimSpace(req.Key) == "" {
writeError(w, http.StatusBadRequest, "bad_request", "key is required")
return
}
if err := h.service.TestGlobalConfig(r.Context(), id, req.Key, req.Value); err != nil {
if errors.Is(err, plugins.ErrInstallationNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
return
}
var connectionErr *plugins.ConnectionTestError
if errors.As(err, &connectionErr) {
writeJSON(w, http.StatusOK, connectionCheckResponse{
Success: false,
Message: connectionErr.Error(),
})
return
}
slog.Error("testing plugin config", "installation_id", id, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to test plugin config")
return
}
writeJSON(w, http.StatusOK, connectionCheckResponse{
Success: true,
Message: "Connection successful.",
})
}
func (h *PluginHandler) HandlePutAuthBinding(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
var req pluginAuthBindingRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
if strings.TrimSpace(req.CapabilityID) == "" {
writeError(w, http.StatusBadRequest, "bad_request", "capability_id is required")
return
}
if err := h.configs.UpsertAuthBinding(r.Context(), plugins.AuthBinding{
InstallationID: id,
CapabilityID: req.CapabilityID,
Enabled: req.Enabled,
DisplayOrder: req.DisplayOrder,
AutoProvision: req.AutoProvision,
DefaultLogin: req.DefaultLogin,
}); err != nil {
slog.Error("saving plugin auth binding", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to save auth binding")
return
}
w.WriteHeader(http.StatusNoContent)
}
func (h *PluginHandler) HandlePutTaskBinding(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
capabilityID := chi.URLParam(r, "capability_id")
if strings.TrimSpace(capabilityID) == "" {
writeError(w, http.StatusBadRequest, "bad_request", "capability_id is required")
return
}
var req pluginTaskBindingRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
if err := h.configs.UpsertTaskBinding(r.Context(), plugins.TaskBinding{
InstallationID: id,
CapabilityID: capabilityID,
Enabled: req.Enabled,
Trigger: req.Trigger,
}); err != nil {
slog.Error("saving plugin task binding", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to save task binding")
return
}
writeJSON(w, http.StatusOK, pluginTaskBindingUpdateResponse{RestartRequired: true})
}
func (h *PluginHandler) HandleDeleteInstallation(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
if err := h.installations.Delete(r.Context(), id); err != nil {
if errors.Is(err, plugins.ErrInstallationNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
return
}
slog.Error("deleting plugin installation", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to delete plugin installation")
return
}
// Rebuild the event dispatcher's capability-subscriber index after removal.
if h.service != nil {
h.service.OnLifecycleChange(r.Context())
}
w.WriteHeader(http.StatusNoContent)
}
// manifestHasUserNavigableRoute returns true if the manifest declares any
// navigable HTTP route with navigation_kind="user". Such plugins should
// appear in the user-facing plugin list (and therefore in the user sidebar)
// even if they expose no user_config_schema.
func manifestHasUserNavigableRoute(manifest *pluginv1.PluginManifest) bool {
for _, r := range manifest.GetHttpRoutes() {
if r.GetNavigable() && r.GetNavigationKind() == "user" {
return true
}
}
return false
}
func (h *PluginHandler) HandleListUserPluginSettings(w http.ResponseWriter, r *http.Request) {
installations, err := h.installations.ListEnabled(r.Context())
if err != nil {
slog.Error("listing enabled plugin installations", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to list plugin settings")
return
}
response := pluginUserSettingsListResponse{
Installations: make([]pluginUserSettingsSummary, 0, len(installations)),
}
for _, installation := range installations {
manifest, err := plugins.LoadManifestFile(plugins.InstalledManifestPath(installation.InstallPath))
if err != nil {
slog.Error("loading plugin manifest", "installation_id", installation.ID, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load plugin settings")
return
}
if len(manifest.GetUserConfigSchema()) == 0 && !manifestHasUserNavigableRoute(manifest) {
continue
}
response.Installations = append(response.Installations, toUserPluginSettingsSummary(installation, manifest))
}
writeJSON(w, http.StatusOK, response)
}
func (h *PluginHandler) HandleGetUserPluginSettings(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "installation_id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
installation, manifest, err := h.loadUserConfigInstallation(w, r, id)
if err != nil {
return
}
userID := apimw.GetUserID(r.Context())
values, err := h.userConfig.Get(r.Context(), userID, id)
if err != nil {
slog.Error("loading plugin user config", "installation_id", id, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load plugin settings")
return
}
writeJSON(w, http.StatusOK, pluginUserSettingsDetailResponse{
Installation: toUserPluginSettingsSummary(installation, manifest),
Values: values,
})
}
func (h *PluginHandler) HandlePutUserPluginSettings(w http.ResponseWriter, r *http.Request) {
id, err := parseNamedIDParam(r, "installation_id")
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid installation ID")
return
}
if _, _, err := h.loadUserConfigInstallation(w, r, id); err != nil {
return
}
var req userPluginSettingsRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
userID := apimw.GetUserID(r.Context())
if err := h.userConfig.Set(r.Context(), userID, id, req.Values); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
return
}
w.WriteHeader(http.StatusNoContent)
}
func (h *PluginHandler) loadUserConfigInstallation(
w http.ResponseWriter,
r *http.Request,
installationID int,
) (*plugins.Installation, *pluginv1.PluginManifest, error) {
installation, err := h.installations.GetByID(r.Context(), installationID)
if err != nil {
if errors.Is(err, plugins.ErrInstallationNotFound) {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
return nil, nil, err
}
slog.Error("loading plugin installation", "installation_id", installationID, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load plugin installation")
return nil, nil, err
}
if !installation.Enabled {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation not found")
return nil, nil, plugins.ErrInstallationNotFound
}
manifest, err := h.loadInstallationManifest(r.Context(), installation)
if err != nil {
slog.Error("loading plugin manifest", "installation_id", installationID, "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load plugin settings")
return nil, nil, err
}
if len(manifest.GetUserConfigSchema()) == 0 && !manifestHasUserNavigableRoute(manifest) {
writeError(w, http.StatusNotFound, "not_found", "Plugin installation does not expose user settings")
return nil, nil, plugins.ErrInstallationNotFound
}
return installation, manifest, nil
}
func (h *PluginHandler) buildInstallationResponses(
ctx context.Context,
installations []*plugins.Installation,
) ([]pluginInstallationResponse, error) {
authBindings, err := h.configs.ListAuthBindings(ctx)
if err != nil {
return nil, err
}
taskBindings, err := h.configs.ListTaskBindings(ctx)
if err != nil {
return nil, err
}
response := make([]pluginInstallationResponse, 0, len(installations))
for _, installation := range installations {
item, err := h.buildInstallationResponseWithBindings(
ctx,
installation,
nil,
authBindings,
taskBindings,
)
if err != nil {
return nil, err
}
response = append(response, item)
}
return response, nil
}
func (h *PluginHandler) buildInstallationResponse(
ctx context.Context,
installation *plugins.Installation,
manifest *pluginv1.PluginManifest,
) (pluginInstallationResponse, error) {
authBindings, err := h.configs.ListAuthBindings(ctx)
if err != nil {
return pluginInstallationResponse{}, err
}
taskBindings, err := h.configs.ListTaskBindings(ctx)
if err != nil {
return pluginInstallationResponse{}, err
}
return h.buildInstallationResponseWithBindings(
ctx,
installation,
manifest,
authBindings,
taskBindings,
)
}
func (h *PluginHandler) buildInstallationResponseWithBindings(
ctx context.Context,
installation *plugins.Installation,
manifest *pluginv1.PluginManifest,
authBindings []*plugins.AuthBinding,
taskBindings []*plugins.TaskBinding,
) (pluginInstallationResponse, error) {
if manifest == nil {
var err error
manifest, err = h.loadInstallationManifest(ctx, installation)
if err != nil && !errors.Is(err, plugins.ErrArchiveNotFound) {
return pluginInstallationResponse{}, err
}
}
capabilities, err := h.loadInstallationCapabilities(ctx, installation, manifest)
if err != nil {
return pluginInstallationResponse{}, err
}
configs, err := h.configs.ListGlobalConfigs(ctx, installation.ID)
if err != nil {
return pluginInstallationResponse{}, err
}
var (
globalConfigSchema []pluginConfigSchemaJSON
userConfigSchema []pluginConfigSchemaJSON
routes []pluginRouteJSON
assets []pluginAssetJSON
metadata map[string]any
)
if manifest != nil {
globalConfigSchema = configSchemasToJSON(manifest.GetGlobalConfigSchema())
userConfigSchema = configSchemasToJSON(manifest.GetUserConfigSchema())
routes = routesToJSON(manifest.GetHttpRoutes())
assets = assetsToJSON(manifest.GetAssets())
metadata = structToMap(manifest.GetMetadata())
}
return pluginInstallationResponse{
ID: installation.ID,
RepositoryID: installation.RepositoryID,
PluginID: installation.PluginID,
Version: installation.Version,
InstallPath: installation.InstallPath,
Enabled: installation.Enabled,
UpdatePolicy: installation.UpdatePolicy,
AvailableVersion: installation.AvailableVersion,
Capabilities: capabilities,
GlobalConfigSchema: globalConfigSchema,
UserConfigSchema: userConfigSchema,
Routes: routes,
Assets: assets,
Metadata: metadata,
GlobalConfigs: configValuesToJSON(configs),
AuthBindings: authBindingsForInstallation(installation.ID, authBindings),
TaskBindings: taskBindingsForInstallation(installation.ID, taskBindings),
CreatedAt: installation.CreatedAt,
UpdatedAt: installation.UpdatedAt,
}, nil
}
func toPluginRepositoryResponse(repository *plugins.Repository) pluginRepositoryResponse {
return pluginRepositoryResponse{
ID: repository.ID,
URL: repository.URL,
DisplayName: repository.DisplayName,
Enabled: repository.Enabled,
LastFetchedAt: repository.LastFetchedAt,
CreatedAt: repository.CreatedAt,
UpdatedAt: repository.UpdatedAt,
}
}
func toUserPluginSettingsSummary(
installation *plugins.Installation,
manifest *pluginv1.PluginManifest,
) pluginUserSettingsSummary {
return pluginUserSettingsSummary{
ID: installation.ID,
PluginID: installation.PluginID,
Version: installation.Version,
UserConfigSchema: configSchemasToJSON(manifest.GetUserConfigSchema()),
Routes: routesToJSON(manifest.GetHttpRoutes()),
Assets: assetsToJSON(manifest.GetAssets()),
}
}
func configSchemasToJSON(schemas []*pluginv1.ConfigSchema) []pluginConfigSchemaJSON {
response := make([]pluginConfigSchemaJSON, 0, len(schemas))
for _, schema := range schemas {
if schema == nil {
continue
}
response = append(response, pluginConfigSchemaJSON{
Key: schema.GetKey(),
Title: schema.GetTitle(),
Description: schema.GetDescription(),
JSONSchema: schema.GetJsonSchema(),
Required: schema.GetRequired(),
AdminForm: adminFormToJSON(schema.GetAdminForm()),
})
}
return response
}
func adminFormToJSON(form *pluginv1.AdminFormDescriptor) *pluginAdminFormJSON {
if form == nil {
return nil
}
fields := make([]pluginAdminFormFieldJSON, 0, len(form.GetFields()))
for _, field := range form.GetFields() {
if field == nil {
continue
}
options := make([]pluginAdminFormOptionJSON, 0, len(field.GetOptions()))
for _, option := range field.GetOptions() {
if option == nil {
continue
}
options = append(options, pluginAdminFormOptionJSON{
Value: option.GetValue(),
Label: option.GetLabel(),
Description: option.GetDescription(),
})
}
var defaultValue any
if field.GetDefaultValue() != nil {
defaultValue = field.GetDefaultValue().AsInterface()
}
fields = append(fields, pluginAdminFormFieldJSON{
Key: field.GetKey(),
Label: field.GetLabel(),
Description: field.GetDescription(),
Control: strings.TrimPrefix(field.GetControl().String(), "ADMIN_FORM_CONTROL_"),
Placeholder: field.GetPlaceholder(),
Required: field.GetRequired(),
Secret: field.GetSecret(),
Multiline: field.GetMultiline(),
DefaultValue: defaultValue,
Options: options,
Rows: field.GetRows(),
})
}
return &pluginAdminFormJSON{
Fields: fields,
SubmitLabel: form.GetSubmitLabel(),
}
}
func capabilitiesToJSON(descriptors []*pluginv1.CapabilityDescriptor) []pluginCapabilityJSON {
response := make([]pluginCapabilityJSON, 0, len(descriptors))
for _, descriptor := range descriptors {
if descriptor == nil {
continue
}
response = append(response, pluginCapabilityJSON{
Type: descriptor.GetType(),
ID: descriptor.GetId(),
DisplayName: descriptor.GetDisplayName(),
Description: descriptor.GetDescription(),
Subscriptions: append([]string(nil), descriptor.GetSubscriptions()...),
ConfigSchema: configSchemasToJSON(descriptor.GetConfigSchema()),
Metadata: structToMap(descriptor.GetMetadata()),
})
}
return response
}
func routesToJSON(routes []*pluginv1.HttpRouteDescriptor) []pluginRouteJSON {
response := make([]pluginRouteJSON, 0, len(routes))
for _, route := range routes {
if route == nil {
continue
}
response = append(response, pluginRouteJSON{
ID: route.GetId(),
Method: route.GetMethod(),
Path: route.GetPath(),
Access: route.GetAccess(),
Navigable: route.GetNavigable(),
NavigationLabel: route.GetNavigationLabel(),
NavigationKind: route.GetNavigationKind(),
StaticAsset: route.GetStaticAsset(),
})
}
return response
}
func assetsToJSON(assets []*pluginv1.PackagedAsset) []pluginAssetJSON {
response := make([]pluginAssetJSON, 0, len(assets))
for _, asset := range assets {
if asset == nil {
continue
}
response = append(response, pluginAssetJSON{
Path: asset.GetPath(),
ContentType: asset.GetContentType(),
Integrity: asset.GetIntegrity(),
})
}
return response
}
func configValuesToJSON(configs []*plugins.RuntimeConfig) []pluginConfigValueJSON {
response := make([]pluginConfigValueJSON, 0, len(configs))
for _, config := range configs {
if config == nil {
continue
}
response = append(response, pluginConfigValueJSON{
Key: config.Key,
Value: config.Value,
})
}
return response
}
func authBindingsForInstallation(installationID int, bindings []*plugins.AuthBinding) []pluginAuthBindingJSON {
response := make([]pluginAuthBindingJSON, 0)
for _, binding := range bindings {
if binding == nil || binding.InstallationID != installationID {
continue
}
response = append(response, pluginAuthBindingJSON{
CapabilityID: binding.CapabilityID,
Enabled: binding.Enabled,
DisplayOrder: binding.DisplayOrder,
AutoProvision: binding.AutoProvision,
DefaultLogin: binding.DefaultLogin,
CreatedAt: binding.CreatedAt,
UpdatedAt: binding.UpdatedAt,
})
}
return response
}
func taskBindingsForInstallation(installationID int, bindings []*plugins.TaskBinding) []pluginTaskBindingJSON {
response := make([]pluginTaskBindingJSON, 0)
for _, binding := range bindings {
if binding == nil || binding.InstallationID != installationID {
continue
}
response = append(response, pluginTaskBindingJSON{
CapabilityID: binding.CapabilityID,
Enabled: binding.Enabled,
Trigger: binding.Trigger,
CreatedAt: binding.CreatedAt,
UpdatedAt: binding.UpdatedAt,
})
}
return response
}
func (h *PluginHandler) loadInstallationManifest(
ctx context.Context,
installation *plugins.Installation,
) (*pluginv1.PluginManifest, error) {
if installation == nil {
return nil, errors.New("plugin installation is required")
}
if h.service != nil {
manifest, err := h.service.ManifestForInstallation(ctx, installation.ID)
if err == nil {
return manifest, nil
}
if errors.Is(err, plugins.ErrArchiveNotFound) {
return nil, plugins.ErrArchiveNotFound
}
if !errors.Is(err, plugins.ErrArchiveNotFound) {
return nil, err
}
}
manifest, err := loadPluginManifest(installation)
if err != nil && errors.Is(err, os.ErrNotExist) {
return nil, plugins.ErrArchiveNotFound
}
return manifest, err
}
func (h *PluginHandler) loadInstallationCapabilities(
ctx context.Context,
installation *plugins.Installation,
manifest *pluginv1.PluginManifest,
) ([]pluginCapabilityJSON, error) {
if manifest != nil {
return capabilitiesToJSON(manifest.GetCapabilities()), nil
}
records, err := h.installations.ListCapabilities(ctx, installation.ID)
if err != nil {
return nil, err
}
response := make([]pluginCapabilityJSON, 0, len(records))
for _, record := range records {
descriptor, err := plugins.DecodeCapability(record)
if err != nil {
return nil, err
}
response = append(response, capabilitiesToJSON([]*pluginv1.CapabilityDescriptor{descriptor})...)
}
return response, nil
}
func loadPluginManifest(installation *plugins.Installation) (*pluginv1.PluginManifest, error) {
return plugins.LoadManifestFile(plugins.InstalledManifestPath(installation.InstallPath))
}
func structToMap(value interface{ AsMap() map[string]any }) map[string]any {
if value == nil {
return nil
}
return value.AsMap()
}
func parseNamedIDParam(r *http.Request, name string) (int, error) {
return strconv.Atoi(chi.URLParam(r, name))
}