Clash.Meta/rules/provider/provider.go

154 lines
3.2 KiB
Go
Raw Normal View History

package provider
2021-12-02 22:56:17 +08:00
import (
"encoding/json"
"github.com/Dreamacro/clash/component/resource"
2021-12-02 22:56:17 +08:00
C "github.com/Dreamacro/clash/constant"
P "github.com/Dreamacro/clash/constant/provider"
2022-05-26 17:47:05 +08:00
"gopkg.in/yaml.v3"
2021-12-02 22:56:17 +08:00
"runtime"
"time"
)
var (
2021-12-07 20:49:39 +08:00
ruleProviders = map[string]P.RuleProvider{}
2021-12-02 22:56:17 +08:00
)
type ruleSetProvider struct {
*resource.Fetcher[any]
2022-03-26 18:34:15 +08:00
behavior P.RuleType
strategy ruleStrategy
2021-12-02 22:56:17 +08:00
}
type RuleSetProvider struct {
*ruleSetProvider
}
type RulePayload struct {
/**
key: Domain or IP Cidr
value: Rule type or is empty
*/
Rules []string `yaml:"payload"`
Rules2 []string `yaml:"rules"`
2021-12-02 22:56:17 +08:00
}
2022-03-26 18:34:15 +08:00
type ruleStrategy interface {
Match(metadata *C.Metadata) bool
Count() int
ShouldResolveIP() bool
OnUpdate(rules []string)
}
2021-12-07 20:49:39 +08:00
func RuleProviders() map[string]P.RuleProvider {
2021-12-02 22:56:17 +08:00
return ruleProviders
}
2021-12-07 20:49:39 +08:00
func SetRuleProvider(ruleProvider P.RuleProvider) {
2021-12-02 22:56:17 +08:00
if ruleProvider != nil {
2021-12-07 20:49:39 +08:00
ruleProviders[(ruleProvider).Name()] = ruleProvider
2021-12-02 22:56:17 +08:00
}
}
func (rp *ruleSetProvider) Type() P.ProviderType {
return P.Rule
}
func (rp *ruleSetProvider) Initial() error {
elm, err := rp.Fetcher.Initial()
2021-12-02 22:56:17 +08:00
if err != nil {
return err
}
rp.OnUpdate(elm)
return nil
2021-12-02 22:56:17 +08:00
}
func (rp *ruleSetProvider) Update() error {
elm, same, err := rp.Fetcher.Update()
2021-12-02 22:56:17 +08:00
if err == nil && !same {
rp.OnUpdate(elm)
return nil
2021-12-02 22:56:17 +08:00
}
return err
}
func (rp *ruleSetProvider) Behavior() P.RuleType {
return rp.behavior
}
func (rp *ruleSetProvider) Match(metadata *C.Metadata) bool {
2022-03-26 18:34:15 +08:00
return rp.strategy != nil && rp.strategy.Match(metadata)
2021-12-02 22:56:17 +08:00
}
func (rp *ruleSetProvider) ShouldResolveIP() bool {
2022-03-26 18:34:15 +08:00
return rp.strategy.ShouldResolveIP()
2021-12-02 22:56:17 +08:00
}
func (rp *ruleSetProvider) AsRule(adaptor string) C.Rule {
panic("implement me")
}
func (rp *ruleSetProvider) MarshalJSON() ([]byte, error) {
return json.Marshal(
map[string]interface{}{
"behavior": rp.behavior.String(),
"name": rp.Name(),
2022-03-26 18:34:15 +08:00
"ruleCount": rp.strategy.Count(),
2021-12-02 22:56:17 +08:00
"type": rp.Type().String(),
"updatedAt": rp.UpdatedAt,
2021-12-02 22:56:17 +08:00
"vehicleType": rp.VehicleType().String(),
})
}
func NewRuleSetProvider(name string, behavior P.RuleType, interval time.Duration, vehicle P.Vehicle,
parse func(tp, payload, target string, params []string) (parsed C.Rule, parseErr error)) P.RuleProvider {
2021-12-02 22:56:17 +08:00
rp := &ruleSetProvider{
behavior: behavior,
}
onUpdate := func(elm interface{}) {
2021-12-02 22:56:17 +08:00
rulesRaw := elm.([]string)
2022-03-26 18:34:15 +08:00
rp.strategy.OnUpdate(rulesRaw)
2021-12-02 22:56:17 +08:00
}
fetcher := resource.NewFetcher(name, interval, vehicle, rulesParse, onUpdate)
rp.Fetcher = fetcher
rp.strategy = newStrategy(behavior, parse)
2022-03-26 18:34:15 +08:00
2021-12-02 22:56:17 +08:00
wrapper := &RuleSetProvider{
rp,
}
final := func(provider *RuleSetProvider) { _ = rp.Fetcher.Destroy() }
2022-05-08 00:04:16 +08:00
runtime.SetFinalizer(wrapper, final)
2021-12-02 22:56:17 +08:00
return wrapper
}
func newStrategy(behavior P.RuleType, parse func(tp, payload, target string, params []string) (parsed C.Rule, parseErr error)) ruleStrategy {
2021-12-02 22:56:17 +08:00
switch behavior {
case P.Domain:
2022-03-26 18:34:15 +08:00
strategy := NewDomainStrategy()
return strategy
2021-12-02 22:56:17 +08:00
case P.IPCIDR:
2022-03-26 18:34:15 +08:00
strategy := NewIPCidrStrategy()
return strategy
2021-12-02 22:56:17 +08:00
case P.Classical:
strategy := NewClassicalStrategy(parse)
2022-03-26 18:34:15 +08:00
return strategy
2021-12-02 22:56:17 +08:00
default:
2022-03-26 18:34:15 +08:00
return nil
2021-12-02 22:56:17 +08:00
}
}
func rulesParse(buf []byte) (any, error) {
2022-03-26 18:34:15 +08:00
rulePayload := RulePayload{}
err := yaml.Unmarshal(buf, &rulePayload)
if err != nil {
return nil, err
2021-12-02 22:56:17 +08:00
}
return append(rulePayload.Rules, rulePayload.Rules2...), nil
2021-12-02 22:56:17 +08:00
}