types

type AccessControlConfig struct {
	// 允许的 IP/CIDR 列表 (allow)
	Allow []string `form:"allow" json:"allow"`

	// 拒绝的 IP/CIDR 列表 (deny)
	Deny []string `form:"deny" json:"deny"`
}

type BasicAuth struct {
	Path     string `json:"path"`      // 生效路径前缀，"/" 表示整站
	UserFile string `json:"user_file"` // htpasswd 文件路径
}

type CacheConfig struct {
	// 缓存时长，状态码 -> 时长，如: {"200 302": "10m", "404": "1m", "any": "5m"}
	Valid map[string]string `form:"valid" json:"valid"`

	// 不缓存条件 (proxy_cache_bypass + proxy_no_cache)
	// 常用值: "$cookie_nocache", "$arg_nocache", "$http_pragma", "$http_authorization"
	NoCacheConditions []string `form:"no_cache_conditions" json:"no_cache_conditions"`

	// 过期缓存使用策略 (proxy_cache_use_stale)
	// 可选值: "error", "timeout", "updating", "http_500", "http_502", "http_503", "http_504"
	UseStale []string `form:"use_stale" json:"use_stale"`

	// 后台更新 (proxy_cache_background_update)
	BackgroundUpdate bool `form:"background_update" json:"background_update"`

	// 缓存锁 (proxy_cache_lock)，防止缓存击穿
	Lock bool `form:"lock" json:"lock"`

	// 最小请求次数 (proxy_cache_min_uses)，请求 N 次后才缓存
	MinUses int `form:"min_uses" json:"min_uses"`

	// 缓存方法 (proxy_cache_methods)，默认 GET HEAD
	Methods []string `form:"methods" json:"methods"`

	// 自定义缓存键 (proxy_cache_key)
	Key string `form:"key" json:"key"`
}

type ConfigScope string

type Dialect interface {
	Service() string
	ConfigTest() string
	// HTMLDir 默认页目录，存放 index.html、stop.html 与 404.html
	HTMLDir() string
	ConfigFile() string
	PanelACMEConf() string
	Features() Features
	HTTPSListenArgs() []string
	ErrorPageConf() string
	PHPCacheConf() string
	SPAConf() string
	// LSCacheConf 站点级 LiteSpeed 页面缓存片段，name 为站点名
	LSCacheConf(name string) string
	// StatConf 访问统计片段，shared 为共享级、site 为站点级，不支持统计时都为空
	StatConf(name string) (shared, site string)
	// DefaultSiteConf 内置默认站点的独立配置文件，没有时为空
	DefaultSiteConf() string
	// WriteDefaultSite 写入内置默认站点配置，asDefault 为 false 时把默认位让给某个站点
	WriteDefaultSite(asDefault bool) error
	HTPasswdLine(username, password string) string
	// RewritesDir 伪静态预置目录名，语法相同的服务器可共用
	RewritesDir() string
	// BeforeReload 重载前的准备工作，如重建全局配置
	BeforeReload() error

	NewStaticVhost(configDir string) (StaticVhost, error)
	NewPHPVhost(configDir string) (PHPVhost, error)
	NewProxyVhost(configDir string) (ProxyVhost, error)

	// 以下方法的 bool 返回值表示配置是否变化，未变化则跳过重载
	// WriteSiteChallenge 向网站 acme 配置文件投放一个 HTTP-01 验证
	WriteSiteChallenge(conf, path, token string) (bool, error)
	// RemoveSiteChallenge 移除网站 acme 配置文件中的一个 HTTP-01 验证
	RemoveSiteChallenge(conf, path, token string) (bool, error)
	// WritePanelChallenge 写入面板独立验证站点，用于 80 端口已被 Web 服务器占用时签发面板证书
	WritePanelChallenge(conf string, names []string, tokens map[string]string) (bool, error)
	RemovePanelChallenge(conf string) (bool, error)
}

type Features struct {
	IPv6Listen  bool // 站点额外监听 IPv6 地址
	Stat        bool // 访问统计
	DefaultSite bool // 默认站点切换
	LSCache     bool // LiteSpeed 页面缓存
}

type IncludeFile struct {
	Path    string   `json:"path"`    // 文件路径
	Comment []string `json:"comment"` // 注释说明
}

type Listen struct {
	Address string   `form:"address" json:"address"` // 监听地址，如: "80", "0.0.0.0:80", "[::]:443"
	Args    []string `form:"args" json:"args"`       // 其他参数，如: ["default_server", "ssl", "quic"]
}

type LocationKind uint8

type PHPVhost interface {
	Vhost
	VhostPHP
	VhostRedirect
}

type Proxy struct {
	Location          string                `form:"location" json:"location" validate:"required"`             // 匹配路径，如: "/", "/api", "~ ^/api/v[0-9]+/"
	Pass              string                `form:"pass" json:"pass" validate:"required"`                     // 代理地址，如: "http://example.com", "http://backend"
	Host              string                `form:"host" json:"host"`                                         // 代理 Host，如: "example.com"
	SNI               string                `form:"sni" json:"sni"`                                           // 代理 SNI，如: "example.com"
	Cache             *CacheConfig          `form:"cache" json:"cache"`                                       // 缓存配置，nil 表示禁用缓存
	Buffering         bool                  `form:"buffering" json:"buffering"`                               // 是否启用缓冲
	Resolver          []string              `form:"resolver" json:"resolver"`                                 // 自定义 DNS 解析器配置，如: ["8.8.8.8", "ipv6=off"]
	ResolverTimeout   time.Duration         `form:"resolver_timeout" json:"resolver_timeout"`                 // DNS 解析超时时间，如: 5 * time.Second
	Headers           map[string]string     `form:"headers" json:"headers"`                                   // 自定义请求头，如: map["X-Custom-Header"] = "value"
	Replaces          map[string]string     `form:"replaces" json:"replaces"`                                 // 响应内容替换，如: map["/old"] = "/new"
	HTTPVersion       string                `form:"http_version" json:"http_version" validate:"in:1.0,1.1,2"` // HTTP 协议版本 (proxy_http_version)，可选: "1.0", "1.1", "2"
	Timeout           *TimeoutConfig        `form:"timeout" json:"timeout"`                                   // 超时配置
	Retry             *RetryConfig          `form:"retry" json:"retry"`                                       // 重试配置
	ClientMaxBodySize int64                 `form:"client_max_body_size" json:"client_max_body_size"`         // 请求体大小限制 (client_max_body_size)，单位字节，0 表示使用全局配置
	SSLBackend        *SSLBackendConfig     `form:"ssl_backend" json:"ssl_backend"`                           // SSL 后端验证配置
	ResponseHeaders   *ResponseHeaderConfig `form:"response_headers" json:"response_headers"`                 // 响应头修改配置
	AccessControl     *AccessControlConfig  `form:"access_control" json:"access_control"`                     // IP 访问控制配置
}

type ProxyVhost interface {
	Vhost
	VhostRedirect
	VhostProxy
}

type RateLimit struct {
	PerServer int `json:"per_server"` // 站点最大并发数 (limit_conn perserver X)
	PerIP     int `json:"per_ip"`     // 单 IP 最大并发数 (limit_conn perip X)
	Rate      int `json:"rate"`       // 流量限制，单位 KB (limit_rate Xk)
}

type RealIP struct {
	From      []string `json:"from"`      // 可信 IP 来源列表 (set_real_ip_from)
	Header    string   `json:"header"`    // 真实 IP 头 (real_ip_header)，如: X-Real-IP, X-Forwarded-For
	Recursive bool     `json:"recursive"` // 递归搜索 (real_ip_recursive)
}

type Redirect struct {
	Type       RedirectType `json:"type"`        // 重定向类型
	From       string       `json:"from"`        // 源地址，如: "example.com", "http://example.com", "/old"
	To         string       `json:"to"`          // 目标地址，如: "https://example.com"
	KeepURI    bool         `json:"keep_uri"`    // 是否保持 URI 不变（即保留请求参数）
	StatusCode int          `json:"status_code"` // 自定义状态码，如: 301, 302, 307, 308，默认 308
}

type RedirectType string

type ResponseHeaderConfig struct {
	// 隐藏的响应头 (proxy_hide_header)
	Hide []string `form:"hide" json:"hide"`

	// 添加的响应头 (add_header)，key -> value
	// 值可以包含变量，如 $upstream_cache_status
	Add map[string]string `form:"add" json:"add"`
}

type RetryConfig struct {
	// 触发重试的条件 (proxy_next_upstream)
	// 可选值: "error", "timeout", "invalid_header", "http_500", "http_502", "http_503", "http_504", "http_429", "non_idempotent", "off"
	Conditions []string `form:"conditions" json:"conditions"`

	// 最大重试次数 (proxy_next_upstream_tries)，0 表示不限制
	Tries int `form:"tries" json:"tries"`

	// 重试超时时间 (proxy_next_upstream_timeout)，0 表示不限制
	Timeout time.Duration `form:"timeout" json:"timeout"`
}

type SSLBackendConfig struct {
	Verify             bool   `form:"verify" json:"verify"`                           // proxy_ssl_verify on/off
	TrustedCertificate string `form:"trusted_certificate" json:"trusted_certificate"` // proxy_ssl_trusted_certificate 路径
	VerifyDepth        int    `form:"verify_depth" json:"verify_depth"`               // proxy_ssl_verify_depth，默认 1
}

type SSLConfig struct {
	Cert      string   `json:"cert"`      // 证书路径
	Key       string   `json:"key"`       // 私钥路径
	Protocols []string `json:"protocols"` // 支持的协议，如: ["TLSv1.2", "TLSv1.3"]

	// 高级选项
	HSTS         bool   `json:"hsts"`          // HTTP 严格传输安全
	OCSP         bool   `json:"ocsp"`          // OCSP Stapling
	HTTPRedirect bool   `json:"http_redirect"` // HTTP 强制跳转 HTTPS
	AltSvc       string `json:"alt_svc"`       // Alt-Svc 配置，如: 'h3=":443"; ma=86400'
}

type StaticVhost interface {
	Vhost
	VhostRedirect
}

type TimeoutConfig struct {
	Connect time.Duration `form:"connect" json:"connect"` // proxy_connect_timeout，默认 60s
	Read    time.Duration `form:"read" json:"read"`       // proxy_read_timeout，默认 60s
	Send    time.Duration `form:"send" json:"send"`       // proxy_send_timeout，默认 60s
}

type Upstream struct {
	Name            string            `form:"name" json:"name" validate:"required"`       // 上游名称，如: "backend"
	Servers         map[string]string `form:"servers" json:"servers" validate:"required"` // 上游服务器及配置，如: map["server1"] = "weight=5 resolve"
	Algo            string            `form:"algo" json:"algo"`                           // 负载均衡算法，如: "least_conn", "ip_hash"
	Keepalive       int               `form:"keepalive" json:"keepalive"`                 // 保持连接数，如: 32
	Resolver        []string          `form:"resolver" json:"resolver"`                   // 自定义 DNS 解析器配置，如: ["8.8.8.8", "ipv6=off"]
	ResolverTimeout time.Duration     `form:"resolver_timeout" json:"resolver_timeout"`   // DNS 解析超时时间，如: 5 * time.Second
}

type VarMap struct {
	// contains filtered or unexported fields
}

type Vhost interface {
	Enable() bool
	SetEnable(enable bool) error

	// Default 是否为默认站点，承接未匹配任何域名的请求
	Default() bool
	SetDefault(enable bool) error

	Listen() []Listen
	SetListen(listen []Listen) error

	// ServerName 取服务器名称，如: ["example.com", "www.example.com"]
	ServerName() []string
	SetServerName(serverName []string) error

	// Index 取默认首页，如: ["index.php", "index.html"]
	Index() []string
	SetIndex(index []string) error

	// Root 取网站根目录，如: "/opt/ace/sites/example/public"
	Root() string
	SetRoot(root string) error

	Includes() []IncludeFile
	SetIncludes(includes []IncludeFile) error

	// AccessLog 取访问日志路径，如: "/opt/ace/sites/example/log/access.log"
	AccessLog() string
	SetAccessLog(accessLog string) error

	// ErrorLog 取错误日志路径，如: "/opt/ace/sites/example/log/error.log"
	ErrorLog() string
	SetErrorLog(errorLog string) error

	Save() error
	Reset() error

	SSL() bool
	SSLConfig() *SSLConfig
	SetSSLConfig(cfg *SSLConfig) error
	ClearSSL() error

	RateLimit() *RateLimit
	SetRateLimit(limit *RateLimit) error
	ClearRateLimit() error

	BasicAuth() []BasicAuth
	SetBasicAuth(auths []BasicAuth) error
	ClearBasicAuth() error

	RealIP() *RealIP
	SetRealIP(realIP *RealIP) error
	ClearRealIP() error

	Config(name string, scope ConfigScope) string
	// SetConfig 设置指定名称的配置内容，自动添加生成标记注释
	SetConfig(name string, scope ConfigScope, content string) error
	// SetRawConfig 设置配置内容但不添加生成标记注释（用于用户可编辑的片段）
	SetRawConfig(name string, scope ConfigScope, content string) error
	RemoveConfig(name string, scope ConfigScope) error
}

type VhostPHP interface {
	// PHP 取 PHP 版本，如: 84, 81, 80, 0 表示未启用 PHP
	PHP() uint
	SetPHP(version uint) error
}

type VhostProxy interface {
	Proxies() []Proxy
	SetProxies(proxies []Proxy) error
	ClearProxies() error

	Upstreams() []Upstream
	SetUpstreams(upstreams []Upstream) error
	ClearUpstreams() error
}

type VhostRedirect interface {
	Redirects() []Redirect
	SetRedirects(redirects []Redirect) error
}