mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-17 15:47:14 +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:
Grigoriy
@@ -0,0 +1,215 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
|
||||
import {
|
||||
formatTokens,
|
||||
mergeSelection,
|
||||
parseTokens,
|
||||
selectionFromValue,
|
||||
tokenFor,
|
||||
} from '@/lib/xray/geoTokens';
|
||||
|
||||
const siteKnown = new Set(['geosite:google', 'geosite:google@ads', 'geosite:cn', 'ext:my_rules.dat:corp']);
|
||||
const ipKnown = new Set(['geoip:cn', 'geoip:private', 'ext:my_ips.dat:office']);
|
||||
|
||||
describe('parseTokens / formatTokens', () => {
|
||||
const cases: Array<[string, string, string[]]> = [
|
||||
['empty value', '', []],
|
||||
['single token', 'geosite:google', ['geosite:google']],
|
||||
['trims and drops blanks', ' geosite:google , , google.com ,', ['geosite:google', 'google.com']],
|
||||
['keeps negation', '!geoip:cn, 10.0.0.0/8', ['!geoip:cn', '10.0.0.0/8']],
|
||||
];
|
||||
|
||||
it.each(cases)('%s', (_name, value, expected) => {
|
||||
expect(parseTokens(value)).toEqual(expected);
|
||||
});
|
||||
|
||||
it('joins with a comma and a space', () => {
|
||||
expect(formatTokens(['geosite:google', 'google.com'])).toBe('geosite:google, google.com');
|
||||
expect(formatTokens([])).toBe('');
|
||||
});
|
||||
});
|
||||
|
||||
describe('tokenFor', () => {
|
||||
const cases: Array<[string, string, string, 'site' | 'ip', string]> = [
|
||||
['default site database uses the geosite shorthand', 'geosite.dat', 'google', 'site', 'geosite:google'],
|
||||
['default ip database uses the geoip shorthand', 'geoip.dat', 'cn', 'ip', 'geoip:cn'],
|
||||
['custom site database falls back to ext', 'my_rules.dat', 'corp', 'site', 'ext:my_rules.dat:corp'],
|
||||
['custom ip database falls back to ext', 'my_ips.dat', 'office', 'ip', 'ext:my_ips.dat:office'],
|
||||
['ip kind on the site database is not shorthand', 'geosite.dat', 'cn', 'ip', 'ext:geosite.dat:cn'],
|
||||
['site kind on the ip database is not shorthand', 'geoip.dat', 'cn', 'site', 'ext:geoip.dat:cn'],
|
||||
];
|
||||
|
||||
it.each(cases)('%s', (_name, file, code, kind, expected) => {
|
||||
expect(tokenFor(file, code, kind)).toBe(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('selectionFromValue', () => {
|
||||
const cases: Array<[string, string, ReadonlySet<string>, string[]]> = [
|
||||
['empty value selects nothing', '', siteKnown, []],
|
||||
['plain values are not selectable', 'google.com, keyword:ads', siteKnown, []],
|
||||
['picks known tokens only', 'google.com, geosite:google, geosite:blabla', siteKnown, ['geosite:google']],
|
||||
[
|
||||
'keeps the value order',
|
||||
'geosite:cn, google.com, geosite:google',
|
||||
siteKnown,
|
||||
['geosite:cn', 'geosite:google'],
|
||||
],
|
||||
['drops duplicates', 'geosite:google, geosite:google', siteKnown, ['geosite:google']],
|
||||
['attributes are distinct tokens', 'geosite:google@ads', siteKnown, ['geosite:google@ads']],
|
||||
['ext tokens are selectable', 'ext:my_rules.dat:corp, ext:other.dat:x', siteKnown, ['ext:my_rules.dat:corp']],
|
||||
['negated ip tokens stay unselected', '!geoip:cn, geoip:private', ipKnown, ['geoip:private']],
|
||||
];
|
||||
|
||||
it.each(cases)('%s', (_name, value, known, expected) => {
|
||||
expect(selectionFromValue(value, known)).toEqual(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('mergeSelection', () => {
|
||||
const cases: Array<[string, string, string[], ReadonlySet<string>, string]> = [
|
||||
['adds to an empty field', '', ['geosite:google'], siteKnown, 'geosite:google'],
|
||||
[
|
||||
'adds after a plain domain',
|
||||
'google.com',
|
||||
['geosite:cn'],
|
||||
siteKnown,
|
||||
'google.com, geosite:cn',
|
||||
],
|
||||
[
|
||||
'keeps plain and unknown tokens when a category is unchecked',
|
||||
'google.com, geosite:google, geosite:blabla',
|
||||
[],
|
||||
siteKnown,
|
||||
'google.com, geosite:blabla',
|
||||
],
|
||||
[
|
||||
'unchecking one known token leaves the other known token',
|
||||
'geosite:google, geosite:cn',
|
||||
['geosite:cn'],
|
||||
siteKnown,
|
||||
'geosite:cn',
|
||||
],
|
||||
[
|
||||
'preserves the original order of surviving tokens',
|
||||
'geosite:cn, google.com, geosite:google',
|
||||
['geosite:google', 'geosite:cn'],
|
||||
siteKnown,
|
||||
'geosite:cn, google.com, geosite:google',
|
||||
],
|
||||
[
|
||||
'appends new selections in selection order',
|
||||
'google.com',
|
||||
['geosite:cn', 'geosite:google'],
|
||||
siteKnown,
|
||||
'google.com, geosite:cn, geosite:google',
|
||||
],
|
||||
[
|
||||
'never duplicates an already present token',
|
||||
'geosite:google, google.com',
|
||||
['geosite:google'],
|
||||
siteKnown,
|
||||
'geosite:google, google.com',
|
||||
],
|
||||
[
|
||||
'collapses duplicates already in the field',
|
||||
'google.com, google.com, geosite:google',
|
||||
['geosite:google'],
|
||||
siteKnown,
|
||||
'google.com, geosite:google',
|
||||
],
|
||||
[
|
||||
'handles ext tokens like shorthand ones',
|
||||
'ext:my_rules.dat:corp, google.com',
|
||||
[],
|
||||
siteKnown,
|
||||
'google.com',
|
||||
],
|
||||
[
|
||||
'adds an ext token from a custom database',
|
||||
'10.0.0.0/8',
|
||||
['ext:my_ips.dat:office'],
|
||||
ipKnown,
|
||||
'10.0.0.0/8, ext:my_ips.dat:office',
|
||||
],
|
||||
[
|
||||
'leaves a negated ip token untouched while dropping a plain one',
|
||||
'!geoip:cn, geoip:private, 192.168.0.0/16',
|
||||
[],
|
||||
ipKnown,
|
||||
'!geoip:cn, 192.168.0.0/16',
|
||||
],
|
||||
[
|
||||
'adds a geoip token next to an existing negation',
|
||||
'!geoip:cn',
|
||||
['geoip:private'],
|
||||
ipKnown,
|
||||
'!geoip:cn, geoip:private',
|
||||
],
|
||||
[
|
||||
'ignores whitespace around field tokens',
|
||||
' google.com , geosite:google ',
|
||||
['geosite:google'],
|
||||
siteKnown,
|
||||
'google.com, geosite:google',
|
||||
],
|
||||
['clearing every known token can empty the field', 'geosite:google', [], siteKnown, ''],
|
||||
];
|
||||
|
||||
it.each(cases)('%s', (_name, value, selected, known, expected) => {
|
||||
expect(mergeSelection(value, selected, known)).toBe(expected);
|
||||
});
|
||||
|
||||
it('round-trips with selectionFromValue', () => {
|
||||
const value = mergeSelection('google.com, geosite:blabla', ['geosite:google', 'geosite:cn'], siteKnown);
|
||||
expect(value).toBe('google.com, geosite:blabla, geosite:google, geosite:cn');
|
||||
expect(selectionFromValue(value, siteKnown)).toEqual(['geosite:google', 'geosite:cn']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('token matching tolerates the spellings Xray accepts', () => {
|
||||
const cases: Array<[string, string, string[], string]> = [
|
||||
[
|
||||
'an uppercase token is recognised instead of duplicated',
|
||||
'GEOSITE:GOOGLE',
|
||||
['geosite:google'],
|
||||
'GEOSITE:GOOGLE',
|
||||
],
|
||||
[
|
||||
'the long ext form of a default database is the same token as its shorthand',
|
||||
'ext:geosite.dat:google',
|
||||
['geosite:google'],
|
||||
'ext:geosite.dat:google',
|
||||
],
|
||||
[
|
||||
'clearing a category written in its long form removes it',
|
||||
'google.com, ext:geosite.dat:google',
|
||||
[],
|
||||
'google.com',
|
||||
],
|
||||
[
|
||||
'clearing a category written in uppercase removes it',
|
||||
'GEOSITE:GOOGLE, google.com',
|
||||
[],
|
||||
'google.com',
|
||||
],
|
||||
[
|
||||
'a token from a database that was never opened survives untouched',
|
||||
'ext:other.dat:x, geosite:google',
|
||||
['geosite:cn'],
|
||||
'ext:other.dat:x, geosite:cn',
|
||||
],
|
||||
['a value of separators alone collapses to empty', ',,, ,', [], ''],
|
||||
];
|
||||
|
||||
it.each(cases)('%s', (_name, value, selected, expected) => {
|
||||
expect(mergeSelection(value, selected, siteKnown)).toBe(expected);
|
||||
});
|
||||
|
||||
it('seeds the selection from tokens written in another spelling', () => {
|
||||
expect(selectionFromValue('GEOSITE:GOOGLE, ext:geosite.dat:cn', siteKnown)).toEqual([
|
||||
'GEOSITE:GOOGLE',
|
||||
'ext:geosite.dat:cn',
|
||||
]);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user