config

type AdministratorConfig struct {
	Email string `yaml:"Email" default:"admin@ppanel.dev"`
	// Password seeds the first administrator. Left empty, a random one is
	// generated and printed once at the first start. Once the administrator
	// exists it seeds nothing, only sits in the file in clear, and the start
	// flags it: remove it from the file then.
	Password string `yaml:"Password,omitempty"`
}

type Boot struct {
	Host  string `yaml:"Host" default:"0.0.0.0"`
	Port  int    `yaml:"Port" default:"8080"`
	Debug bool   `yaml:"Debug" default:"false"`
	// TrustedProxies lists the reverse proxies (IP addresses or CIDRs) whose
	// X-Forwarded-For and X-Real-IP headers name the real client. Empty means
	// DefaultTrustedProxies; the entry "private" stands for those networks in a
	// longer list, and ["none"] trusts no header at all.
	TrustedProxies []string `yaml:"TrustedProxies"`
	// AllowedOrigins lists the browser origins CORS admits, as scheme://host[:port].
	// Empty keeps the permissive default of reflecting the request's Origin.
	AllowedOrigins []string            `yaml:"AllowedOrigins"`
	HTTP           HTTPConfig          `yaml:"HTTP"`
	GeoIP          GeoIPConfig         `yaml:"GeoIP"`
	AppLocation    string              `yaml:"AppLocation" default:"Asia/Shanghai"`
	Transport      TransportConfig     `yaml:"Transport"`
	TLS            TLS                 `yaml:"TLS"`
	JwtAuth        JwtAuth             `yaml:"JwtAuth"`
	Logger         logger.LogConf      `yaml:"Logger"`
	Trace          trace.Config        `yaml:"Trace"`
	Database       orm.Config          `yaml:"Database"`
	MySQL          *orm.Config         `yaml:"MySQL,omitempty"` // Deprecated: use Database.
	Redis          RedisConfig         `yaml:"Redis"`
	EdgeSubscribe  EdgeSubscribeConfig `yaml:"EdgeSubscribe"`
	Administrator  AdministratorConfig `yaml:"Administrator"`
}

type Config struct {
	Boot    `yaml:",inline"`
	Runtime `yaml:",inline"`
}

type Currency struct {
	Unit      string `yaml:"Unit" default:"USD"`
	Symbol    string `yaml:"Symbol" default:"$"`
	AccessKey string `yaml:"AccessKey" default:""`
}

type DeviceConfig struct {
	Enable         bool   `yaml:"enable" default:"true"`
	ShowAds        bool   `yaml:"show_ads"`
	EnableSecurity bool   `yaml:"enable_security"`
	OnlyRealDevice bool   `yaml:"only_real_device"`
	SecuritySecret string `yaml:"security_secret"`
}

type EdgeSubscribeAccessKey struct {
	ID     string `yaml:"ID"`
	Secret string `yaml:"Secret"`
}

type EdgeSubscribeConfig struct {
	Enabled             bool                     `yaml:"Enabled" default:"false"`
	MaxClockSkewSeconds int64                    `yaml:"MaxClockSkewSeconds" default:"300"`
	Keys                []EdgeSubscribeAccessKey `yaml:"Keys"`
}

type EmailConfig struct {
	Enable                     bool   `yaml:"Enable" default:"true"`
	Platform                   string `yaml:"platform"`
	PlatformConfig             string `yaml:"platform_config"`
	EnableVerify               bool   `yaml:"enable_verify"`
	EnableNotify               bool   `yaml:"enable_notify"`
	EnableDomainSuffix         bool   `yaml:"enable_domain_suffix"`
	DomainSuffixList           string `yaml:"domain_suffix_list"`
	VerifyEmailTemplate        string `yaml:"verify_email_template"`
	ExpirationEmailTemplate    string `yaml:"expiration_email_template"`
	MaintenanceEmailTemplate   string `yaml:"maintenance_email_template"`
	TrafficExceedEmailTemplate string `yaml:"traffic_exceed_email_template"`
	// Subjects pair with the templates above. They are copied from the email
	// auth method config by field name (internal/infra/mapping), so the
	// fields must keep the names they have there; empty means the queued
	// fallback subject is used.
	VerifyEmailSubject        string `yaml:"verify_email_subject"`
	ExpirationEmailSubject    string `yaml:"expiration_email_subject"`
	MaintenanceEmailSubject   string `yaml:"maintenance_email_subject"`
	TrafficExceedEmailSubject string `yaml:"traffic_exceed_email_subject"`
}

type File struct {
	Host           string              `yaml:"Host" default:"0.0.0.0"`
	Port           int                 `yaml:"Port" default:"8080"`
	Transport      TransportConfig     `yaml:"Transport"`
	TLS            TLS                 `yaml:"TLS"`
	Debug          bool                `yaml:"Debug" default:"false"`
	TrustedProxies []string            `yaml:"TrustedProxies"`
	AllowedOrigins []string            `yaml:"AllowedOrigins"`
	HTTP           HTTPConfig          `yaml:"HTTP"`
	GeoIP          GeoIPConfig         `yaml:"GeoIP"`
	JwtAuth        JwtAuth             `yaml:"JwtAuth"`
	Logger         logger.LogConf      `yaml:"Logger"`
	Trace          trace.Config        `yaml:"Trace"`
	Database       orm.Config          `yaml:"Database"`
	MySQL          *orm.Config         `yaml:"MySQL,omitempty"` // Deprecated: use Database.
	Redis          RedisConfig         `yaml:"Redis"`
	EdgeSubscribe  EdgeSubscribeConfig `yaml:"EdgeSubscribe"`
	// AppLocation survives the installation's rewrite of the file: the new
	// database's session zone is set from it.
	AppLocation   string              `yaml:"AppLocation" default:"Asia/Shanghai"`
	Administrator AdministratorConfig `yaml:"Administrator"`
}

type GeoIPConfig struct {
	// Path of the GeoLite2-City.mmdb file.
	Path string `yaml:"Path" default:"./cache/GeoLite2-City.mmdb"`
	// Download fetches the database from DownloadURL (the built-in mirror when
	// empty) when Path is missing.
	Download    bool   `yaml:"Download" default:"true"`
	DownloadURL string `yaml:"DownloadURL" default:""`
	// SHA256 is the hex digest the file must have; empty skips the check.
	SHA256 string `yaml:"SHA256" default:""`
	// Required makes a missing or invalid database fatal at start-up; by
	// default the server starts without geolocation and logs the reason.
	Required bool `yaml:"Required" default:"false"`
}

type HTTPConfig struct {
	ReadTimeoutSeconds int `yaml:"ReadTimeoutSeconds" default:"180"`
	// WriteTimeoutSeconds 0 leaves response writes unbounded, which the
	// streaming endpoints (order events over SSE, WebSocket) need.
	WriteTimeoutSeconds int `yaml:"WriteTimeoutSeconds" default:"0"`
	IdleTimeoutSeconds  int `yaml:"IdleTimeoutSeconds" default:"180"`
	MaxRequestBodyMB    int `yaml:"MaxRequestBodyMB" default:"4"`
}

type InviteConfig struct {
	ForcedInvite       bool   `yaml:"ForcedInvite" default:"false"`
	ReferralPercentage int64  `yaml:"ReferralPercentage" default:"0"`
	OnlyFirstPurchase  bool   `yaml:"OnlyFirstPurchase" default:"false"`
	WithdrawalMethod   string `yaml:"WithdrawalMethod" default:""`
}

type JwtAuth struct {
	AccessSecret string `yaml:"AccessSecret"`
	AccessExpire int64  `yaml:"AccessExpire" default:"604800"`
}

type Log struct {
	AutoClear bool  `yaml:"AutoClear" default:"true"`
	ClearDays int64 `yaml:"ClearDays" default:"7"`
}

type MobileConfig struct {
	Enable          bool     `yaml:"Enable" default:"true"`
	Platform        string   `yaml:"platform"`
	PlatformConfig  string   `yaml:"platform_config"`
	EnableVerify    bool     `yaml:"enable_verify"`
	EnableWhitelist bool     `yaml:"enable_whitelist"`
	Whitelist       []string `yaml:"whitelist"`
}

type NodeConfig struct {
	NodeSecret             string         `yaml:"NodeSecret" default:""`
	NodePullInterval       int64          `yaml:"NodePullInterval" default:"60"`
	NodePushInterval       int64          `yaml:"NodePushInterval" default:"60"`
	TrafficReportThreshold int64          `yaml:"TrafficReportThreshold" default:"0"`
	IPStrategy             string         `yaml:"IPStrategy" default:""`
	DNS                    []NodeDNS      `yaml:"DNS"`
	Block                  []string       `yaml:"Block" `
	Outbound               []NodeOutbound `yaml:"Outbound"`
}

type NodeDBConfig struct {
	NodeSecret             string
	NodePullInterval       int64
	NodePushInterval       int64
	TrafficReportThreshold int64
	IPStrategy             string
	DNS                    string
	Block                  string
	Outbound               string
}

type NodeDNS struct {
	Proto      string   `json:"proto"`
	Address    string   `json:"address"`
	ServerName string   `json:"server_name,omitempty"`
	Domains    []string `json:"domains"`
}

type NodeOutbound struct {
	Name                 string   `json:"name"`
	Protocol             string   `json:"protocol"`
	Address              string   `json:"address"`
	Port                 int64    `json:"port"`
	User                 string   `json:"user,omitempty"`
	Password             string   `json:"password"`
	UUID                 string   `json:"uuid,omitempty"`
	Cipher               string   `json:"cipher,omitempty"`
	Plugin               string   `json:"plugin,omitempty"`
	PluginOptions        any      `json:"plugin_opts,omitempty"`
	Security             string   `json:"security,omitempty"`
	SNI                  string   `json:"sni,omitempty"`
	ALPN                 []string `json:"alpn,omitempty"`
	AllowInsecure        bool     `json:"allow_insecure,omitempty"`
	Fingerprint          string   `json:"fingerprint,omitempty"`
	Transport            string   `json:"transport,omitempty"`
	Host                 string   `json:"host,omitempty"`
	Path                 string   `json:"path,omitempty"`
	ServiceName          string   `json:"service_name,omitempty"`
	XHTTPMode            string   `json:"xhttp_mode,omitempty"`
	XHTTPExtra           string   `json:"xhttp_extra,omitempty"`
	Flow                 string   `json:"flow,omitempty"`
	Encryption           string   `json:"encryption,omitempty"`
	EncryptionMode       string   `json:"encryption_mode,omitempty"`
	EncryptionRTT        string   `json:"encryption_rtt,omitempty"`
	EncryptionTicket     string   `json:"encryption_ticket,omitempty"`
	EncryptionPadding    string   `json:"encryption_client_padding,omitempty"`
	EncryptionPassword   string   `json:"encryption_password,omitempty"`
	Multiplex            string   `json:"multiplex,omitempty"`
	UoT                  bool     `json:"uot,omitempty"`
	UoTVersion           int      `json:"uot_version,omitempty"`
	CongestionController string   `json:"congestion_controller,omitempty"`
	UDPStream            bool     `json:"udp_stream,omitempty"`
	ReduceRtt            bool     `json:"reduce_rtt,omitempty"`
	Heartbeat            int      `json:"heartbeat,omitempty"`
	RealityPublicKey     string   `json:"reality_public_key,omitempty"`
	RealityShortId       string   `json:"reality_short_id,omitempty"`
	SpiderX              string   `json:"spider_x,omitempty"`
	Settings             string   `json:"settings,omitempty"`
	StreamSettings       string   `json:"stream_settings,omitempty"`
	Rules                []string `json:"rules"`
}

type RedisConfig struct {
	Host string `yaml:"Host" default:"localhost:6379"`
	Pass string `yaml:"Pass" default:""`
	DB   int    `yaml:"DB" default:"0"`
	// QueueDB is the Redis database of the asynq task queue, shared by the
	// producer, the consumer and the scheduler. It defaults to the database
	// the server always used, so an upgrade keeps its queued tasks; give
	// every deployment sharing one Redis its own value.
	QueueDB int `yaml:"QueueDB" default:"5"`
}

type RegisterConfig struct {
	StopRegister            bool   `yaml:"StopRegister" default:"false"`
	EnableTrial             bool   `yaml:"EnableTrial" default:"false"`
	TrialSubscribe          int64  `yaml:"TrialSubscribe" default:"0"`
	TrialTime               int64  `yaml:"TrialTime" default:"0"`
	TrialTimeUnit           string `yaml:"TrialTimeUnit" default:""`
	IpRegisterLimit         int64  `yaml:"IpRegisterLimit" default:"0"`
	IpRegisterLimitDuration int64  `yaml:"IpRegisterLimitDuration" default:"0"`
	EnableIpRegisterLimit   bool   `yaml:"EnableIpRegisterLimit" default:"false"`
}

type Runtime struct {
	Site       SiteConfig      `yaml:"Site"`
	Node       NodeConfig      `yaml:"Node"`
	Mobile     MobileConfig    `yaml:"Mobile"`
	Email      EmailConfig     `yaml:"Email"`
	Device     DeviceConfig    `yaml:"device"`
	Verify     Verify          `yaml:"Verify"`
	VerifyCode VerifyCode      `yaml:"VerifyCode"`
	Register   RegisterConfig  `yaml:"Register"`
	Subscribe  SubscribeConfig `yaml:"Subscribe"`
	Invite     InviteConfig    `yaml:"Invite"`
	Telegram   Telegram        `yaml:"Telegram"`
	Log        Log             `yaml:"Log"`
	Currency   Currency        `yaml:"Currency"`
}

type SettingError struct {
	Key  string
	Type string
	Err  error
}

type SiteConfig struct {
	Host       string `yaml:"Host" default:""`
	SiteName   string `yaml:"SiteName" default:""`
	SiteDesc   string `yaml:"SiteDesc" default:""`
	SiteLogo   string `yaml:"SiteLogo" default:""`
	Keywords   string `yaml:"Keywords" default:""`
	CustomHTML string `yaml:"CustomHTML" default:""`
	CustomData string `yaml:"CustomData" default:""`
}

type SubscribeConfig struct {
	SingleModel           bool   `yaml:"SingleModel" default:"false"`
	SubscribePath         string `yaml:"SubscribePath" default:"/v1/subscribe/config"`
	SubscribeDomain       string `yaml:"SubscribeDomain" default:""`
	PanDomain             bool   `yaml:"PanDomain" default:"false"`
	UserAgentLimit        bool   `yaml:"UserAgentLimit" default:"false"`
	UserAgentList         string `yaml:"UserAgentList" default:""`
	ShowTutorial          bool   `yaml:"ShowTutorial" default:"true"`
	ProfileUpdateInterval int64  `yaml:"ProfileUpdateInterval" default:"0"`
	ProfileWebPageURL     string `yaml:"ProfileWebPageURL" default:""`
}

type SystemConfigEntry interface {
	ConfigKey() string
	ConfigValue() string
	ConfigType() string
}

type TLS struct {
	Enable   bool   `yaml:"Enable" default:"false"`
	CertFile string `yaml:"CertFile" default:""`
	KeyFile  string `yaml:"KeyFile" default:""`
}

type Telegram struct {
	Enable        bool   `yaml:"Enable" default:"false"`
	BotID         int64  `yaml:"BotID" default:""`
	BotName       string `yaml:"BotName" default:""`
	BotToken      string `yaml:"BotToken" default:""`
	EnableNotify  bool   `yaml:"EnableNotify" default:"false"`
	WebHookDomain string `yaml:"WebHookDomain" default:""`
	// GroupChatID is the validated administrators' group; zero when the
	// group is unconfigured or failed validation, which disables every
	// group-side feature (admin commands, topics, notifications).
	GroupChatID int64 `yaml:"GroupChatID" default:"0"`
}

type TransportConfig struct {
	Driver string `yaml:"Driver" default:"hertz"`
}

type Verify struct {
	TurnstileSiteKey    string `yaml:"TurnstileSiteKey" default:""`
	TurnstileSecret     string `yaml:"TurnstileSecret" default:""`
	LoginVerify         bool   `yaml:"LoginVerify" default:"false"`
	RegisterVerify      bool   `yaml:"RegisterVerify" default:"false"`
	ResetPasswordVerify bool   `yaml:"ResetPasswordVerify" default:"false"`
}

type VerifyCode struct {
	ExpireTime int64 `yaml:"ExpireTime" default:"300"`
	Limit      int64 `yaml:"Limit" default:"15"`
	Interval   int64 `yaml:"Interval" default:"60"`
}