mirror of
https://github.com/Wei-Shaw/sub2api.git
synced 2026-10-30 16:23:31 +00:00
Extend the local plugin system's host<->plugin contract with generic, capability-neutral facilities, so transport plugins can be built on top without embedding plugin-specific logic in the host. Host services (plugin dials a broker-provided HostService gRPC): - per-plugin namespaced KV store (key/value size and TTL bounded) - account directory: ListAccounts + ResolveOutboundIdentity, restricted to the accounts a plugin's declared capability already covers - InitHostServices lifecycle hook; plugins that don't implement it run unchanged and are simply offered no host services Read-only runtime status channel: - HealthResponse gains an opaque, plugin-defined status_json produced passively (no config apply, no upstream call, no side effects) - GET /admin/plugins/:id/status (ungated) and the plugin.status UI-bridge verb map to Health, so a status UI can poll live state without a step-up prompt or a "test" side effect - config.test no longer force-shows a host success toast; the plugin UI owns result presentation, so plugins that read status do not spam toasts Document the UI-bridge verb taxonomy (read vs mutate/test gating) and the status contract under pkg/pluginapi.
266 lines
9.8 KiB
Go
266 lines
9.8 KiB
Go
package service
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"time"
|
|
|
|
pluginv1 "github.com/Wei-Shaw/sub2api/pkg/pluginapi/v1"
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/status"
|
|
)
|
|
|
|
// 通用宿主服务(HostService)的资源上限。这些限制与任何具体插件能力无关,
|
|
// 只用于约束单个插件对共享存储的占用,属于防御性护栏而非业务策略。
|
|
const (
|
|
// pluginKVMaxPluginKeyLen 与清单 id 的 maxLength 一致(manifest.schema.json),
|
|
// 确保任何可安装插件的 pluginKey 都能通过校验,不会被误判为不可用。
|
|
pluginKVMaxPluginKeyLen = 160
|
|
pluginKVMaxNamespaceLen = 128
|
|
pluginKVMaxKeyLen = 256
|
|
pluginKVMaxValueBytes = 256 * 1024
|
|
pluginKVMaxListLimit = 1000
|
|
pluginKVDefaultListLimit = 100
|
|
pluginKVMaxTTL = 90 * 24 * time.Hour
|
|
)
|
|
|
|
// PluginKVStore 是宿主向插件提供的通用命名空间键值存储端口。它对存储介质保持中立
|
|
// (由 repository 层用 Redis 等实现),供任何插件持久化跨请求 / 跨副本 / 跨重启的
|
|
// 状态。pluginKey 由宿主根据服务该连接的运行时注入,插件无法伪造,从而保证不同
|
|
// 插件之间命名空间严格隔离。
|
|
type PluginKVStore interface {
|
|
Get(ctx context.Context, pluginKey, namespace, key string) ([]byte, bool, error)
|
|
Set(ctx context.Context, pluginKey, namespace, key string, value []byte, ttl time.Duration) error
|
|
Delete(ctx context.Context, pluginKey, namespace, key string) error
|
|
List(ctx context.Context, pluginKey, namespace, keyPrefix string, limit int) ([]string, error)
|
|
}
|
|
|
|
// PluginOutboundIdentity 是宿主为某账号解析出的、可直接用于出站请求的身份材料:
|
|
// 访问令牌、宿主会附加的出站请求头,以及账号代理。
|
|
type PluginOutboundIdentity struct {
|
|
AccountID int64
|
|
Platform string
|
|
AccountType string
|
|
ProxyURL string
|
|
Token string
|
|
Headers http.Header
|
|
}
|
|
|
|
// PluginAccountDirectory 让插件枚举其能力所覆盖的账号,并按需解析这些账号的出站身份,
|
|
// 无需等待一条真实请求流经插件。这是一项敏感能力(会把账号凭据交给插件进程),因此
|
|
// 宿主只对「其声明能力确实覆盖这些账号」的插件开放(见 PluginManager.buildHostServices)。
|
|
// 实现方自身也必须把返回范围收敛到该能力对应的账号集合。
|
|
type PluginAccountDirectory interface {
|
|
ListPluginAccounts(ctx context.Context, platform, accountType string) ([]int64, error)
|
|
ResolvePluginOutboundIdentity(ctx context.Context, accountID int64) (*PluginOutboundIdentity, error)
|
|
}
|
|
|
|
// pluginHostServiceServer 实现 pluginv1.HostServiceServer,是宿主经 go-plugin broker
|
|
// 反向暴露给单个插件进程的服务端点。它绑定到具体插件的 pluginKey,因此每个运行时都有
|
|
// 自己的实例;所有键值操作都被强制限定在该插件的命名空间内。
|
|
type pluginHostServiceServer struct {
|
|
pluginv1.UnimplementedHostServiceServer
|
|
pluginKey string
|
|
store PluginKVStore
|
|
directory PluginAccountDirectory
|
|
}
|
|
|
|
func newPluginHostServiceServer(pluginKey string, store PluginKVStore, directory PluginAccountDirectory) *pluginHostServiceServer {
|
|
return &pluginHostServiceServer{pluginKey: pluginKey, store: store, directory: directory}
|
|
}
|
|
|
|
func (s *pluginHostServiceServer) ready() bool {
|
|
return s != nil && s.store != nil && isValidPluginKVSegment(s.pluginKey, pluginKVMaxPluginKeyLen)
|
|
}
|
|
|
|
func (s *pluginHostServiceServer) KVGet(ctx context.Context, req *pluginv1.KVGetRequest) (*pluginv1.KVGetResponse, error) {
|
|
if !s.ready() {
|
|
return nil, status.Error(codes.Unavailable, "宿主键值存储不可用")
|
|
}
|
|
if req == nil {
|
|
return nil, status.Error(codes.InvalidArgument, "请求为空")
|
|
}
|
|
if err := validatePluginKVNamespace(req.Namespace); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := validatePluginKVKey(req.Key); err != nil {
|
|
return nil, err
|
|
}
|
|
value, found, err := s.store.Get(ctx, s.pluginKey, req.Namespace, req.Key)
|
|
if err != nil {
|
|
return nil, status.Errorf(codes.Internal, "读取键值失败: %v", err)
|
|
}
|
|
if !found {
|
|
return &pluginv1.KVGetResponse{Found: false}, nil
|
|
}
|
|
return &pluginv1.KVGetResponse{Found: true, Value: value}, nil
|
|
}
|
|
|
|
func (s *pluginHostServiceServer) KVSet(ctx context.Context, req *pluginv1.KVSetRequest) (*pluginv1.KVSetResponse, error) {
|
|
if !s.ready() {
|
|
return nil, status.Error(codes.Unavailable, "宿主键值存储不可用")
|
|
}
|
|
if req == nil {
|
|
return nil, status.Error(codes.InvalidArgument, "请求为空")
|
|
}
|
|
if err := validatePluginKVNamespace(req.Namespace); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := validatePluginKVKey(req.Key); err != nil {
|
|
return nil, err
|
|
}
|
|
if len(req.Value) > pluginKVMaxValueBytes {
|
|
return nil, status.Errorf(codes.InvalidArgument, "值超过 %d 字节上限", pluginKVMaxValueBytes)
|
|
}
|
|
ttl, err := pluginKVTTL(req.TtlSeconds)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if err := s.store.Set(ctx, s.pluginKey, req.Namespace, req.Key, req.Value, ttl); err != nil {
|
|
return nil, status.Errorf(codes.Internal, "写入键值失败: %v", err)
|
|
}
|
|
return &pluginv1.KVSetResponse{}, nil
|
|
}
|
|
|
|
func (s *pluginHostServiceServer) KVDelete(ctx context.Context, req *pluginv1.KVDeleteRequest) (*pluginv1.KVDeleteResponse, error) {
|
|
if !s.ready() {
|
|
return nil, status.Error(codes.Unavailable, "宿主键值存储不可用")
|
|
}
|
|
if req == nil {
|
|
return nil, status.Error(codes.InvalidArgument, "请求为空")
|
|
}
|
|
if err := validatePluginKVNamespace(req.Namespace); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := validatePluginKVKey(req.Key); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := s.store.Delete(ctx, s.pluginKey, req.Namespace, req.Key); err != nil {
|
|
return nil, status.Errorf(codes.Internal, "删除键值失败: %v", err)
|
|
}
|
|
return &pluginv1.KVDeleteResponse{}, nil
|
|
}
|
|
|
|
func (s *pluginHostServiceServer) KVList(ctx context.Context, req *pluginv1.KVListRequest) (*pluginv1.KVListResponse, error) {
|
|
if !s.ready() {
|
|
return nil, status.Error(codes.Unavailable, "宿主键值存储不可用")
|
|
}
|
|
if req == nil {
|
|
return nil, status.Error(codes.InvalidArgument, "请求为空")
|
|
}
|
|
if err := validatePluginKVNamespace(req.Namespace); err != nil {
|
|
return nil, err
|
|
}
|
|
if req.KeyPrefix != "" {
|
|
if err := validatePluginKVKey(req.KeyPrefix); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
limit := int(req.Limit)
|
|
if limit <= 0 {
|
|
limit = pluginKVDefaultListLimit
|
|
}
|
|
if limit > pluginKVMaxListLimit {
|
|
limit = pluginKVMaxListLimit
|
|
}
|
|
keys, err := s.store.List(ctx, s.pluginKey, req.Namespace, req.KeyPrefix, limit)
|
|
if err != nil {
|
|
return nil, status.Errorf(codes.Internal, "列举键值失败: %v", err)
|
|
}
|
|
return &pluginv1.KVListResponse{Keys: keys}, nil
|
|
}
|
|
|
|
func (s *pluginHostServiceServer) ListAccounts(ctx context.Context, req *pluginv1.ListAccountsRequest) (*pluginv1.ListAccountsResponse, error) {
|
|
if s == nil || s.directory == nil {
|
|
return nil, status.Error(codes.Unavailable, "账号目录不可用")
|
|
}
|
|
if req == nil {
|
|
return nil, status.Error(codes.InvalidArgument, "请求为空")
|
|
}
|
|
ids, err := s.directory.ListPluginAccounts(ctx, req.Platform, req.AccountType)
|
|
if err != nil {
|
|
return nil, status.Errorf(codes.Internal, "列举账号失败: %v", err)
|
|
}
|
|
return &pluginv1.ListAccountsResponse{AccountIds: ids}, nil
|
|
}
|
|
|
|
func (s *pluginHostServiceServer) ResolveOutboundIdentity(ctx context.Context, req *pluginv1.ResolveOutboundIdentityRequest) (*pluginv1.ResolveOutboundIdentityResponse, error) {
|
|
if s == nil || s.directory == nil {
|
|
return nil, status.Error(codes.Unavailable, "账号目录不可用")
|
|
}
|
|
if req == nil || req.AccountId <= 0 {
|
|
return nil, status.Error(codes.InvalidArgument, "account_id 无效")
|
|
}
|
|
identity, err := s.directory.ResolvePluginOutboundIdentity(ctx, req.AccountId)
|
|
if err != nil {
|
|
return nil, status.Errorf(codes.Internal, "解析账号出站身份失败: %v", err)
|
|
}
|
|
if identity == nil {
|
|
return &pluginv1.ResolveOutboundIdentityResponse{Found: false}, nil
|
|
}
|
|
return &pluginv1.ResolveOutboundIdentityResponse{
|
|
Found: true,
|
|
AccountId: identity.AccountID,
|
|
Platform: identity.Platform,
|
|
AccountType: identity.AccountType,
|
|
ProxyUrl: identity.ProxyURL,
|
|
Token: identity.Token,
|
|
Headers: headersToPlugin(identity.Headers),
|
|
}, nil
|
|
}
|
|
|
|
func pluginKVTTL(seconds int64) (time.Duration, error) {
|
|
if seconds < 0 {
|
|
return 0, status.Error(codes.InvalidArgument, "ttl_seconds 不能为负")
|
|
}
|
|
if seconds == 0 {
|
|
return 0, nil
|
|
}
|
|
// 先在整数秒上比较上限,避免 seconds*time.Second 溢出 int64 后回绕成负值、
|
|
// 从而绕过上限检查把负 TTL 传给 Redis。
|
|
maxSeconds := int64(pluginKVMaxTTL / time.Second)
|
|
if seconds > maxSeconds {
|
|
return 0, status.Errorf(codes.InvalidArgument, "ttl_seconds 超过上限 %d", maxSeconds)
|
|
}
|
|
return time.Duration(seconds) * time.Second, nil
|
|
}
|
|
|
|
func validatePluginKVNamespace(namespace string) error {
|
|
if namespace == "" {
|
|
return status.Error(codes.InvalidArgument, "namespace 不能为空")
|
|
}
|
|
if !isValidPluginKVSegment(namespace, pluginKVMaxNamespaceLen) {
|
|
return status.Error(codes.InvalidArgument, "namespace 仅允许字母、数字、'.'、'_'、'-' 且长度受限")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func validatePluginKVKey(key string) error {
|
|
if key == "" {
|
|
return status.Error(codes.InvalidArgument, "key 不能为空")
|
|
}
|
|
if !isValidPluginKVSegment(key, pluginKVMaxKeyLen) {
|
|
return status.Error(codes.InvalidArgument, "key 仅允许字母、数字、'.'、'_'、'-' 且长度受限")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// isValidPluginKVSegment 限定命名段字符集为 [A-Za-z0-9._-]。这既避免 Redis glob
|
|
// 元字符(*?[])污染 SCAN,也避免 ':' 破坏内部键结构,从而保证命名空间隔离可靠。
|
|
func isValidPluginKVSegment(value string, maxLen int) bool {
|
|
if value == "" || len(value) > maxLen {
|
|
return false
|
|
}
|
|
for _, r := range value {
|
|
switch {
|
|
case r >= 'a' && r <= 'z':
|
|
case r >= 'A' && r <= 'Z':
|
|
case r >= '0' && r <= '9':
|
|
case r == '.' || r == '_' || r == '-':
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|