path: root/plugin/singbox/srs_in.go

package singbox

import (
	"encoding/json"
	"fmt"
	"io"
	"log"
	"net/http"
	"os"
	"path/filepath"
	"regexp"
	"strings"

	"github.com/Loyalsoldier/geoip/lib"
	"github.com/sagernet/sing-box/common/srs"
)

const (
	TypeSRSIn = "singboxSRS"
	DescSRSIn = "Convert sing-box SRS data to other formats"
)

func init() {
	lib.RegisterInputConfigCreator(TypeSRSIn, func(action lib.Action, data json.RawMessage) (lib.InputConverter, error) {
		return NewSRSInFromBytes(action, data)
	})
	lib.RegisterInputConverter(TypeSRSIn, &srs_in{
		Description: DescSRSIn,
	})
}

type srs_in struct {
	Type        string
	Action      lib.Action
	Description string
	Name        string
	URI         string
	InputDir    string
	Want        map[string]bool
	OnlyIPType  lib.IPType
}

func NewSRSIn(action lib.Action, opts ...lib.InputOption) lib.InputConverter {
	s := &srs_in{
		Type:        TypeSRSIn,
		Action:      action,
		Description: DescSRSIn,
	}

	for _, opt := range opts {
		if opt != nil {
			opt(s)
		}
	}

	if strings.TrimSpace(s.InputDir) == "" && (strings.TrimSpace(s.Name) == "" || strings.TrimSpace(s.URI) == "") {
		log.Fatalf("❌ [type %s | action %s] missing name or uri or inputDir", TypeSRSIn, s.Action)
	}

	return s
}

func WithNameAndURI(name, uri string) lib.InputOption {
	return func(s lib.InputConverter) {
		name = strings.TrimSpace(name)
		uri = strings.TrimSpace(uri)
		// Validation is performed after all options are applied in NewSRSIn.
		s.(*srs_in).Name = name
		s.(*srs_in).URI = uri
	}
}

func WithInputDir(dir string) lib.InputOption {
	return func(s lib.InputConverter) {
		dir = strings.TrimSpace(dir)
		// Validation is performed after all options are applied in NewSRSIn.
		s.(*srs_in).InputDir = dir
	}
}

func WithInputWantedList(lists []string) lib.InputOption {
	return func(s lib.InputConverter) {
		wantList := make(map[string]bool)
		for _, want := range lists {
			if want = strings.ToUpper(strings.TrimSpace(want)); want != "" {
				wantList[want] = true
			}
		}

		s.(*srs_in).Want = wantList
	}
}

func WithInputOnlyIPType(onlyIPType lib.IPType) lib.InputOption {
	return func(s lib.InputConverter) {
		s.(*srs_in).OnlyIPType = onlyIPType
	}
}

func NewSRSInFromBytes(action lib.Action, data []byte) (lib.InputConverter, error) {
	var tmp struct {
		Name       string     `json:"name"`
		URI        string     `json:"uri"`
		InputDir   string     `json:"inputDir"`
		Want       []string   `json:"wantedList"`
		OnlyIPType lib.IPType `json:"onlyIPType"`
	}

	if len(data) > 0 {
		if err := json.Unmarshal(data, &tmp); err != nil {
			return nil, err
		}
	}

	return NewSRSIn(
		action,
		WithNameAndURI(tmp.Name, tmp.URI),
		WithInputDir(tmp.InputDir),
		WithInputWantedList(tmp.Want),
		WithInputOnlyIPType(tmp.OnlyIPType),
	), nil
}

func (s *srs_in) GetType() string {
	return s.Type
}

func (s *srs_in) GetAction() lib.Action {
	return s.Action
}

func (s *srs_in) GetDescription() string {
	return s.Description
}

func (s *srs_in) Input(container lib.Container) (lib.Container, error) {
	entries := make(map[string]*lib.Entry)
	var err error

	switch {
	case s.InputDir != "":
		err = s.walkDir(s.InputDir, entries)
	case s.Name != "" && s.URI != "":
		switch {
		case strings.HasPrefix(strings.ToLower(s.URI), "http://"), strings.HasPrefix(strings.ToLower(s.URI), "https://"):
			err = s.walkRemoteFile(s.URI, s.Name, entries)
		default:
			err = s.walkLocalFile(s.URI, s.Name, entries)
		}
	default:
		return nil, fmt.Errorf("❌ [type %s | action %s] config missing argument inputDir or name or uri", s.Type, s.Action)
	}

	if err != nil {
		return nil, err
	}

	if len(entries) == 0 {
		return nil, fmt.Errorf("❌ [type %s | action %s] no entry is generated", s.Type, s.Action)
	}

	ignoreIPType := lib.GetIgnoreIPType(s.OnlyIPType)

	for _, entry := range entries {
		switch s.Action {
		case lib.ActionAdd:
			if err := container.Add(entry, ignoreIPType); err != nil {
				return nil, err
			}
		case lib.ActionRemove:
			if err := container.Remove(entry, lib.CaseRemovePrefix, ignoreIPType); err != nil {
				return nil, err
			}
		default:
			return nil, lib.ErrUnknownAction
		}
	}

	return container, nil
}

func (s *srs_in) walkDir(dir string, entries map[string]*lib.Entry) error {
	err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}
		if info.IsDir() {
			return nil
		}

		if err := s.walkLocalFile(path, "", entries); err != nil {
			return err
		}

		return nil
	})

	return err
}

func (s *srs_in) walkLocalFile(path, name string, entries map[string]*lib.Entry) error {
	entryName := ""
	name = strings.TrimSpace(name)
	if name != "" {
		entryName = name
	} else {
		entryName = filepath.Base(path)

		// check filename
		if !regexp.MustCompile(`^[a-zA-Z0-9_.\-]+$`).MatchString(entryName) {
			return fmt.Errorf("❌ [type %s | action %s] filename %s cannot be entry name, please remove special characters in it", s.Type, s.Action, entryName)
		}

		// remove file extension but not hidden files of which filename starts with "."
		dotIndex := strings.LastIndex(entryName, ".")
		if dotIndex > 0 {
			entryName = entryName[:dotIndex]
		}
	}

	entryName = strings.ToUpper(entryName)
	if _, found := entries[entryName]; found {
		return fmt.Errorf("❌ [type %s | action %s] found duplicated list %s", s.Type, s.Action, entryName)
	}

	file, err := os.Open(path)
	if err != nil {
		return err
	}
	defer file.Close()

	if err := s.generateEntries(entryName, file, entries); err != nil {
		return err
	}

	return nil
}

func (s *srs_in) walkRemoteFile(url, name string, entries map[string]*lib.Entry) error {
	resp, err := http.Get(url)
	if err != nil {
		return err
	}
	defer resp.Body.Close()

	if resp.StatusCode != 200 {
		return fmt.Errorf("❌ [type %s | action %s] failed to get remote file %s, http status code %d", s.Type, s.Action, url, resp.StatusCode)
	}

	if err := s.generateEntries(name, resp.Body, entries); err != nil {
		return err
	}

	return nil
}

func (s *srs_in) generateEntries(name string, reader io.Reader, entries map[string]*lib.Entry) error {
	name = strings.ToUpper(name)

	if len(s.Want) > 0 && !s.Want[name] {
		return nil
	}

	entry, found := entries[name]
	if !found {
		entry = lib.NewEntry(name)
	}

	plainRuleSet, err := srs.Read(reader, true)
	if err != nil {
		return err
	}

	for _, rule := range plainRuleSet.Options.Rules {
		for _, cidrStr := range rule.DefaultOptions.IPCIDR {
			if err := entry.AddPrefix(cidrStr); err != nil {
				return err
			}
		}
	}

	entries[name] = entry
	return nil
}