mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-16 08:10:58 +00:00
feat(xray): browse geosite/geoip categories from routing rules (#6165)
* feat(xray): browse geosite/geoip categories from routing rules Routing rules made you type category names from memory: nothing showed which categories a database actually contains, what is inside one, or whether a name resolves at all — a typo only surfaced when Xray refused the config. The panel now reads Xray's .dat databases itself and exposes them over four endpoints: databases in the asset folder, a database's categories, one page of a category's rules, and validation of the tokens already in a rule. The reader walks the protobuf wire format directly rather than decoding into Go structs, because a 10 MB geosite.dat holds well over a million domains and materialising them costs ~284 MB where streaming costs ~19 MB. Only the category index is cached, entry pages are scanned on demand, and scans are serialised, so twenty concurrent requests peak at 87 MB instead of 1 GB. A database's type is decided by its contents, not its file name, since custom .dat files are named freely. In the rule form, the source-IP, IP and domain fields gain a database button opening the browser: search over categories, a preview of what a category holds, and a multi-select that merges into the field. Plain domains, CIDRs and categories the panel does not know are left untouched; categories already present come back ticked, and unticking one removes it from the rule. * fix(xray): read geo databases through os.Root and match codes verbatim CodeQL flagged the database read as a path built from a user-supplied value, and it was right about the shape of it. The file name arrives in a request; resolve() rejects traversal and stats the file through an os.Root, but the read itself went through a joined path with os.ReadFile. That left the symlink defence incomplete: the stat could pass while the read followed a link planted — or swapped in — afterwards. Reads now go through the same root, so a request-supplied name never becomes a path this code resolves on its own, and the size limit is applied to the opened file rather than to a separate stat of it. Lookup no longer trims the category code either. It backs the routing-token validator, and the core matches codes verbatim: "geosite: cn" will not start Xray, so repairing that space here hid exactly the typo the validator exists to report. * fix(xray): address review findings on the geo category browser Asset folder. The browser read config.GetBinFolderPath() unconditionally, but the core honours a preset XRAY_LOCATION_ASSET and only falls back to the bin folder (ensureXrayAssetLocation). On an install pointing at a shared asset directory the panel listed an empty folder and reported perfectly valid geosite:/geoip: tokens as missing — the validator warning about a correct config. The directory is now resolved with the core's precedence. Paging. Serving one page read and rescanned the whole database, so walking category-ads-all re-read it per page. The index now records each category's byte range and a page reads only that record through the os.Root handle, with the current category's records held for the duration of a paging session. Profiling that also showed the real cost was not the read but the slice of payload pointers built per call — a category holds a hundred thousand of them — so records are now walked with a callback instead. Ten pages over category-ads-all: 239 MB allocated, now 4.3 MB. Cached failures. Any error from reading a file was latched under the file's size+mtime, so a transient ENOMEM or EMFILE marked a healthy database as damaged until it changed on disk. Only deterministic failures are cached. Wrong kind. A geoip: token typed into a domain field parsed as a plain domain and was waved through, though the core cannot resolve it as one. It is now reported, with its own reason and wording. Frontend. The category filter fed the query key on every keystroke, so each character triggered a request that re-scanned the database; it is debounced now. GeoTokenInput accepts and forwards a ref, so React Hook Form can focus these three fields on a validation error again. A failed validation shows that it failed instead of rendering the same empty state as "no issues". Also drops an unreachable branch in the token-count guard and corrects the categories endpoint docs, where limit is unbounded by default. --------- Co-authored-by: STRENCH0 <17428017+STRENCH0@users.noreply.github.com>
This commit is contained in:
@@ -0,0 +1,156 @@
|
||||
package service
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"os"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"github.com/mhsanaei/3x-ui/v3/internal/config"
|
||||
"github.com/mhsanaei/3x-ui/v3/internal/xray/geodata"
|
||||
)
|
||||
|
||||
// GeodataTokenIssue reports a routing token the running core would reject,
|
||||
// or would silently match nothing against.
|
||||
type GeodataTokenIssue struct {
|
||||
Token string `json:"token" example:"geosite:blabla"`
|
||||
Reason string `json:"reason" example:"categoryMissing"`
|
||||
File string `json:"file,omitempty" example:"geosite.dat"`
|
||||
Code string `json:"code,omitempty" example:"blabla"`
|
||||
}
|
||||
|
||||
const (
|
||||
geodataReasonSyntax = "syntax"
|
||||
geodataReasonFileMissing = "fileMissing"
|
||||
geodataReasonCategoryMissing = "categoryMissing"
|
||||
geodataReasonAttributeMissing = "attributeMissing"
|
||||
geodataReasonWrongKind = "wrongKind"
|
||||
)
|
||||
|
||||
// geodataStores keys the cache by asset directory rather than holding a single
|
||||
// store, so a changed XUI_BIN_FOLDER is picked up instead of being pinned to
|
||||
// whatever the first call saw.
|
||||
var geodataStores sync.Map
|
||||
|
||||
func assetStore() *geodata.Store {
|
||||
dir := assetDir()
|
||||
if cached, ok := geodataStores.Load(dir); ok {
|
||||
return cached.(*geodata.Store)
|
||||
}
|
||||
store, _ := geodataStores.LoadOrStore(dir, geodata.NewStore(dir))
|
||||
return store.(*geodata.Store)
|
||||
}
|
||||
|
||||
// assetDir resolves the folder the running core reads its databases from,
|
||||
// with the same precedence the core itself uses (see ensureXrayAssetLocation
|
||||
// in internal/xray). An install that points XRAY_LOCATION_ASSET at a shared
|
||||
// asset directory would otherwise have the panel browsing an empty bin folder
|
||||
// and reporting perfectly valid geosite:/geoip: tokens as missing.
|
||||
func assetDir() string {
|
||||
for _, key := range [...]string{"XRAY_LOCATION_ASSET", "xray.location.asset"} {
|
||||
if dir := os.Getenv(key); dir != "" {
|
||||
return dir
|
||||
}
|
||||
}
|
||||
return config.GetBinFolderPath()
|
||||
}
|
||||
|
||||
// GeodataService browses the geosite/geoip databases Xray resolves its
|
||||
// geosite:/geoip: routing tokens against.
|
||||
type GeodataService struct{}
|
||||
|
||||
// Files lists the databases available in the Xray asset folder.
|
||||
func (s *GeodataService) Files() ([]geodata.GeoFile, error) {
|
||||
return assetStore().ListFiles()
|
||||
}
|
||||
|
||||
// Categories returns one page of a database's categories.
|
||||
func (s *GeodataService) Categories(file, query string, offset, limit int) (geodata.GeoCategoryPage, error) {
|
||||
return assetStore().Categories(file, query, offset, limit)
|
||||
}
|
||||
|
||||
// Entries returns one page of the rules inside a category.
|
||||
func (s *GeodataService) Entries(file, code, query string, offset, limit int) (geodata.GeoEntryPage, error) {
|
||||
return assetStore().Entries(file, code, query, offset, limit)
|
||||
}
|
||||
|
||||
// Validate reports which of the given routing tokens do not resolve against the
|
||||
// databases on disk. Plain domains and CIDRs are left alone — only tokens that
|
||||
// name a database are looked up.
|
||||
func (s *GeodataService) Validate(isIP bool, tokens []string) []GeodataTokenIssue {
|
||||
kind := geodata.KindSite
|
||||
if isIP {
|
||||
kind = geodata.KindIP
|
||||
}
|
||||
issues := make([]GeodataTokenIssue, 0)
|
||||
for _, token := range tokens {
|
||||
token = strings.TrimSpace(token)
|
||||
if token == "" {
|
||||
continue
|
||||
}
|
||||
reference, err := geodata.ParseReference(token, kind)
|
||||
if err != nil {
|
||||
reason := geodataReasonSyntax
|
||||
if errors.Is(err, geodata.ErrWrongKind) {
|
||||
reason = geodataReasonWrongKind
|
||||
}
|
||||
issues = append(issues, GeodataTokenIssue{Token: token, Reason: reason})
|
||||
continue
|
||||
}
|
||||
if reference.File == "" {
|
||||
continue
|
||||
}
|
||||
category, err := assetStore().Lookup(reference.File, reference.Code)
|
||||
if err != nil {
|
||||
issues = append(issues, GeodataTokenIssue{
|
||||
Token: token,
|
||||
Reason: geodataIssueReason(err),
|
||||
File: reference.File,
|
||||
Code: reference.Code,
|
||||
})
|
||||
continue
|
||||
}
|
||||
if missing := unknownAttributes(category, reference.Attributes); missing != "" {
|
||||
issues = append(issues, GeodataTokenIssue{
|
||||
Token: token,
|
||||
Reason: geodataReasonAttributeMissing,
|
||||
File: reference.File,
|
||||
Code: missing,
|
||||
})
|
||||
}
|
||||
}
|
||||
return issues
|
||||
}
|
||||
|
||||
// unknownAttributes returns the first attribute the category does not carry.
|
||||
// The core accepts such a token, but no domain can satisfy the filter, so the
|
||||
// rule silently matches nothing — worth reporting even though Xray will start.
|
||||
// A leading "!" is accepted either way: some databases ship the negated key
|
||||
// verbatim, and the panel must not guess which convention a database follows.
|
||||
func unknownAttributes(category geodata.GeoCategory, wanted []string) string {
|
||||
if len(wanted) == 0 {
|
||||
return ""
|
||||
}
|
||||
present := make(map[string]struct{}, len(category.Attributes))
|
||||
for _, attribute := range category.Attributes {
|
||||
present[attribute] = struct{}{}
|
||||
present[strings.TrimPrefix(attribute, "!")] = struct{}{}
|
||||
}
|
||||
for _, attribute := range wanted {
|
||||
if _, ok := present[attribute]; ok {
|
||||
continue
|
||||
}
|
||||
if _, ok := present[strings.TrimPrefix(attribute, "!")]; ok {
|
||||
continue
|
||||
}
|
||||
return attribute
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func geodataIssueReason(err error) string {
|
||||
if errors.Is(err, geodata.ErrUnknownCategory) {
|
||||
return geodataReasonCategoryMissing
|
||||
}
|
||||
return geodataReasonFileMissing
|
||||
}
|
||||
Reference in New Issue
Block a user