mirror of
https://github.com/SagerNet/sing-box.git
synced 2024-11-25 10:01:30 +00:00
111 lines
3.2 KiB
Go
111 lines
3.2 KiB
Go
package deprecated
|
|
|
|
import (
|
|
"github.com/sagernet/sing-box/common/badversion"
|
|
C "github.com/sagernet/sing-box/constant"
|
|
F "github.com/sagernet/sing/common/format"
|
|
|
|
"golang.org/x/mod/semver"
|
|
)
|
|
|
|
type Note struct {
|
|
Name string
|
|
Description string
|
|
DeprecatedVersion string
|
|
ScheduledVersion string
|
|
EnvName string
|
|
MigrationLink string
|
|
}
|
|
|
|
func (n Note) Impending() bool {
|
|
if n.ScheduledVersion == "" {
|
|
return false
|
|
}
|
|
if !semver.IsValid("v" + C.Version) {
|
|
return false
|
|
}
|
|
versionCurrent := badversion.Parse(C.Version)
|
|
versionMinor := badversion.Parse(n.ScheduledVersion).Minor - versionCurrent.Minor
|
|
if versionCurrent.PreReleaseIdentifier == "" && versionMinor < 0 {
|
|
panic("invalid deprecated note: " + n.Name)
|
|
}
|
|
return versionMinor <= 1
|
|
}
|
|
|
|
func (n Note) Message() string {
|
|
return F.ToString(
|
|
n.Description, " is deprecated in sing-box ", n.DeprecatedVersion,
|
|
" and will be removed in sing-box ", n.ScheduledVersion, ", please checkout documentation for migration.",
|
|
)
|
|
}
|
|
|
|
func (n Note) MessageWithLink() string {
|
|
return F.ToString(
|
|
n.Description, " is deprecated in sing-box ", n.DeprecatedVersion,
|
|
" and will be removed in sing-box ", n.ScheduledVersion, ", checkout documentation for migration: ", n.MigrationLink,
|
|
)
|
|
}
|
|
|
|
var OptionBadMatchSource = Note{
|
|
Name: "bad-match-source",
|
|
Description: "legacy match source rule item",
|
|
DeprecatedVersion: "1.10.0",
|
|
ScheduledVersion: "1.11.0",
|
|
EnvName: "BAD_MATCH_SOURCE",
|
|
MigrationLink: "https://sing-box.sagernet.org/deprecated/#match-source-rule-items-are-renamed",
|
|
}
|
|
|
|
var OptionGEOIP = Note{
|
|
Name: "geoip",
|
|
Description: "geoip database",
|
|
DeprecatedVersion: "1.8.0",
|
|
ScheduledVersion: "1.12.0",
|
|
EnvName: "GEOIP",
|
|
MigrationLink: "https://sing-box.sagernet.org/migration/#migrate-geoip-to-rule-sets",
|
|
}
|
|
|
|
var OptionGEOSITE = Note{
|
|
Name: "geosite",
|
|
Description: "geosite database",
|
|
DeprecatedVersion: "1.8.0",
|
|
ScheduledVersion: "1.12.0",
|
|
EnvName: "GEOSITE",
|
|
MigrationLink: "https://sing-box.sagernet.org/migration/#migrate-geosite-to-rule-sets",
|
|
}
|
|
|
|
var OptionTUNAddressX = Note{
|
|
Name: "tun-address-x",
|
|
Description: "legacy tun address fields",
|
|
DeprecatedVersion: "1.10.0",
|
|
ScheduledVersion: "1.12.0",
|
|
EnvName: "TUN_ADDRESS_X",
|
|
MigrationLink: "https://sing-box.sagernet.org/migration/#tun-address-fields-are-merged",
|
|
}
|
|
|
|
var OptionSpecialOutbounds = Note{
|
|
Name: "special-outbounds",
|
|
Description: "legacy special outbounds",
|
|
DeprecatedVersion: "1.11.0",
|
|
ScheduledVersion: "1.13.0",
|
|
EnvName: "SPECIAL_OUTBOUNDS",
|
|
MigrationLink: "https://sing-box.sagernet.org/migration/#migrate-legacy-special-outbounds-to-rule-actions",
|
|
}
|
|
|
|
var OptionInboundOptions = Note{
|
|
Name: "inbound-options",
|
|
Description: "legacy inbound fields",
|
|
DeprecatedVersion: "1.11.0",
|
|
ScheduledVersion: "1.13.0",
|
|
EnvName: "INBOUND_OPTIONS",
|
|
MigrationLink: "https://sing-box.sagernet.org/migration/#migrate-legacy-special-outbounds-to-rule-actions",
|
|
}
|
|
|
|
var Options = []Note{
|
|
OptionBadMatchSource,
|
|
OptionGEOIP,
|
|
OptionGEOSITE,
|
|
OptionTUNAddressX,
|
|
OptionSpecialOutbounds,
|
|
OptionInboundOptions,
|
|
}
|