mirror of
https://github.com/SukkaW/Surge.git
synced 2025-12-12 17:20:35 +08:00
564 lines
16 KiB
TypeScript
564 lines
16 KiB
TypeScript
import type { Span } from '../../trace';
|
|
import { HostnameSmolTrie } from '../trie';
|
|
import { invariant, not } from 'foxts/guard';
|
|
import picocolors from 'picocolors';
|
|
import fs from 'node:fs';
|
|
import { writeFile } from '../misc';
|
|
import { fastStringArrayJoin } from 'foxts/fast-string-array-join';
|
|
import { readFileByLine } from '../fetch-text-by-line';
|
|
import { asyncWriteToStream } from 'foxts/async-write-to-stream';
|
|
import type { BaseWriteStrategy } from '../writing-strategy/base';
|
|
import { merge as mergeCidr } from 'fast-cidr-tools';
|
|
import { createRetrieKeywordFilter as createKeywordFilter } from 'foxts/retrie';
|
|
import path from 'node:path';
|
|
import { SurgeMitmSgmodule } from '../writing-strategy/surge';
|
|
|
|
export class FileOutput {
|
|
protected strategies: Array<BaseWriteStrategy | false> = [];
|
|
|
|
public domainTrie = new HostnameSmolTrie(null);
|
|
protected domainKeywords = new Set<string>();
|
|
protected domainWildcard = new Set<string>();
|
|
protected userAgent = new Set<string>();
|
|
protected processName = new Set<string>();
|
|
protected processPath = new Set<string>();
|
|
protected urlRegex = new Set<string>();
|
|
protected ipcidr = new Set<string>();
|
|
protected ipcidrNoResolve = new Set<string>();
|
|
protected ipasn = new Set<string>();
|
|
protected ipasnNoResolve = new Set<string>();
|
|
protected ipcidr6 = new Set<string>();
|
|
protected ipcidr6NoResolve = new Set<string>();
|
|
protected geoip = new Set<string>();
|
|
protected groipNoResolve = new Set<string>();
|
|
|
|
protected sourceIpOrCidr = new Set<string>();
|
|
protected sourcePort = new Set<string>();
|
|
protected destPort = new Set<string>();
|
|
|
|
protected otherRules: string[] = [];
|
|
|
|
private pendingPromise: Promise<any> | null = null;
|
|
|
|
whitelistDomain = (domain: string) => {
|
|
this.domainTrie.whitelist(domain);
|
|
return this;
|
|
};
|
|
|
|
protected readonly span: Span;
|
|
|
|
constructor($span: Span, protected readonly id: string) {
|
|
this.span = $span.traceChild('RuleOutput#' + id);
|
|
}
|
|
|
|
protected title: string | null = null;
|
|
withTitle(title: string) {
|
|
this.title = title;
|
|
return this;
|
|
}
|
|
|
|
public withStrategies(strategies: Array<BaseWriteStrategy | false>) {
|
|
this.strategies = strategies;
|
|
return this;
|
|
}
|
|
|
|
withExtraStrategies(strategy: BaseWriteStrategy | false) {
|
|
if (strategy) {
|
|
this.strategies.push(strategy);
|
|
}
|
|
}
|
|
|
|
protected description: string[] | readonly string[] | null = null;
|
|
withDescription(description: string[] | readonly string[]) {
|
|
this.description = description;
|
|
return this;
|
|
}
|
|
|
|
protected date = new Date();
|
|
withDate(date: Date) {
|
|
this.date = date;
|
|
return this;
|
|
}
|
|
|
|
addDomain(domain: string) {
|
|
this.domainTrie.add(domain);
|
|
return this;
|
|
}
|
|
|
|
bulkAddDomain(domains: Array<string | null>) {
|
|
let d: string | null;
|
|
for (let i = 0, len = domains.length; i < len; i++) {
|
|
d = domains[i];
|
|
if (d !== null) {
|
|
this.domainTrie.add(d, false, null, 0);
|
|
}
|
|
}
|
|
return this;
|
|
}
|
|
|
|
addDomainSuffix(domain: string, lineFromDot = domain[0] === '.') {
|
|
this.domainTrie.add(domain, true, lineFromDot ? 1 : 0);
|
|
return this;
|
|
}
|
|
|
|
bulkAddDomainSuffix(domains: string[]) {
|
|
for (let i = 0, len = domains.length; i < len; i++) {
|
|
this.addDomainSuffix(domains[i]);
|
|
}
|
|
return this;
|
|
}
|
|
|
|
addDomainKeyword(keyword: string) {
|
|
this.domainKeywords.add(keyword);
|
|
return this;
|
|
}
|
|
|
|
addIPASN(asn: string) {
|
|
this.ipasn.add(asn);
|
|
return this;
|
|
}
|
|
|
|
bulkAddIPASN(asns: string[]) {
|
|
for (let i = 0, len = asns.length; i < len; i++) {
|
|
this.ipasn.add(asns[i]);
|
|
}
|
|
return this;
|
|
}
|
|
|
|
private async addFromDomainsetPromise(source: AsyncIterable<string> | Iterable<string> | string[]) {
|
|
for await (const line of source) {
|
|
if (line[0] === '.') {
|
|
this.addDomainSuffix(line, true);
|
|
} else {
|
|
this.domainTrie.add(line, false, null, 0);
|
|
}
|
|
}
|
|
}
|
|
|
|
addFromDomainset(source: AsyncIterable<string> | Iterable<string> | string[]) {
|
|
this.pendingPromise = (this.pendingPromise ||= Promise.resolve()).then(() => this.addFromDomainsetPromise(source));
|
|
return this;
|
|
}
|
|
|
|
private async addFromRulesetPromise(source: AsyncIterable<string> | Iterable<string>) {
|
|
for await (const line of source) {
|
|
const splitted = line.split(',');
|
|
const type = splitted[0];
|
|
const value = splitted[1];
|
|
const arg = splitted[2];
|
|
|
|
switch (type) {
|
|
case 'DOMAIN':
|
|
this.domainTrie.add(value, false, null, 0);
|
|
break;
|
|
case 'DOMAIN-SUFFIX':
|
|
this.addDomainSuffix(value, false);
|
|
break;
|
|
case 'DOMAIN-KEYWORD':
|
|
this.addDomainKeyword(value);
|
|
break;
|
|
case 'DOMAIN-WILDCARD':
|
|
this.domainWildcard.add(value);
|
|
break;
|
|
case 'USER-AGENT':
|
|
this.userAgent.add(value);
|
|
break;
|
|
case 'PROCESS-NAME':
|
|
if (value.includes('/') || value.includes('\\')) {
|
|
this.processPath.add(value);
|
|
} else {
|
|
this.processName.add(value);
|
|
}
|
|
break;
|
|
case 'URL-REGEX': {
|
|
const [, ...rest] = splitted;
|
|
this.urlRegex.add(rest.join(','));
|
|
break;
|
|
}
|
|
case 'IP-CIDR':
|
|
(arg === 'no-resolve' ? this.ipcidrNoResolve : this.ipcidr).add(value);
|
|
break;
|
|
case 'IP-CIDR6':
|
|
(arg === 'no-resolve' ? this.ipcidr6NoResolve : this.ipcidr6).add(value);
|
|
break;
|
|
case 'IP-ASN':
|
|
(arg === 'no-resolve' ? this.ipasnNoResolve : this.ipasn).add(value);
|
|
break;
|
|
case 'GEOIP':
|
|
(arg === 'no-resolve' ? this.groipNoResolve : this.geoip).add(value);
|
|
break;
|
|
case 'SRC-IP':
|
|
this.sourceIpOrCidr.add(value);
|
|
break;
|
|
case 'SRC-PORT':
|
|
this.sourcePort.add(value);
|
|
break;
|
|
case 'DEST-PORT':
|
|
this.destPort.add(value);
|
|
break;
|
|
default:
|
|
this.otherRules.push(line);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
addFromRuleset(source: AsyncIterable<string> | Iterable<string> | Promise<Iterable<string>>) {
|
|
if (this.pendingPromise) {
|
|
this.pendingPromise = this.pendingPromise.then(() => source);
|
|
} else {
|
|
this.pendingPromise = Promise.resolve(source);
|
|
}
|
|
this.pendingPromise = this.pendingPromise.then((source) => this.addFromRulesetPromise(source));
|
|
return this;
|
|
}
|
|
|
|
static readonly ipToCidr = (ip: string, version: 4 | 6) => {
|
|
if (ip.includes('/')) return ip;
|
|
if (version === 4) {
|
|
return ip + '/32';
|
|
}
|
|
return ip + '/128';
|
|
};
|
|
|
|
bulkAddCIDR4(cidrs: string[]) {
|
|
for (let i = 0, len = cidrs.length; i < len; i++) {
|
|
this.ipcidr.add(FileOutput.ipToCidr(cidrs[i], 4));
|
|
}
|
|
return this;
|
|
}
|
|
|
|
bulkAddCIDR4NoResolve(cidrs: string[]) {
|
|
for (let i = 0, len = cidrs.length; i < len; i++) {
|
|
this.ipcidrNoResolve.add(FileOutput.ipToCidr(cidrs[i], 4));
|
|
}
|
|
return this;
|
|
}
|
|
|
|
bulkAddCIDR6(cidrs: string[]) {
|
|
for (let i = 0, len = cidrs.length; i < len; i++) {
|
|
this.ipcidr6.add(FileOutput.ipToCidr(cidrs[i], 6));
|
|
}
|
|
return this;
|
|
}
|
|
|
|
bulkAddCIDR6NoResolve(cidrs: string[]) {
|
|
for (let i = 0, len = cidrs.length; i < len; i++) {
|
|
this.ipcidr6NoResolve.add(FileOutput.ipToCidr(cidrs[i], 6));
|
|
}
|
|
return this;
|
|
}
|
|
|
|
async done() {
|
|
await this.pendingPromise;
|
|
this.pendingPromise = null;
|
|
return this;
|
|
}
|
|
|
|
// private guardPendingPromise() {
|
|
// // reverse invariant
|
|
// if (this.pendingPromise !== null) {
|
|
// console.trace('Pending promise:', this.pendingPromise);
|
|
// throw new Error('You should call done() before calling this method');
|
|
// }
|
|
// }
|
|
|
|
// async writeClash(outputDir?: null | string) {
|
|
// await this.done();
|
|
|
|
// invariant(this.title, 'Missing title');
|
|
// invariant(this.description, 'Missing description');
|
|
|
|
// return compareAndWriteFile(
|
|
// this.span,
|
|
// withBannerArray(
|
|
// this.title,
|
|
// this.description,
|
|
// this.date,
|
|
// this.clash()
|
|
// ),
|
|
// path.join(outputDir ?? OUTPUT_CLASH_DIR, this.type, this.id + '.txt')
|
|
// );
|
|
// }
|
|
private strategiesWritten = false;
|
|
|
|
private async writeToStrategies() {
|
|
if (this.strategiesWritten) {
|
|
throw new Error('Strategies already written');
|
|
}
|
|
|
|
this.strategiesWritten = true;
|
|
|
|
await this.done();
|
|
|
|
const kwfilter = createKeywordFilter(Array.from(this.domainKeywords));
|
|
|
|
if (this.strategies.filter(not(false)).length === 0) {
|
|
throw new Error('No strategies to write ' + this.id);
|
|
}
|
|
|
|
this.domainTrie.dumpWithoutDot((domain, includeAllSubdomain) => {
|
|
if (kwfilter(domain)) {
|
|
return;
|
|
}
|
|
|
|
for (let i = 0, len = this.strategies.length; i < len; i++) {
|
|
const strategy = this.strategies[i];
|
|
if (strategy) {
|
|
if (includeAllSubdomain) {
|
|
strategy.writeDomainSuffix(domain);
|
|
} else {
|
|
strategy.writeDomain(domain);
|
|
}
|
|
}
|
|
}
|
|
}, true);
|
|
|
|
for (let i = 0, len = this.strategies.length; i < len; i++) {
|
|
const strategy = this.strategies[i];
|
|
if (!strategy) continue;
|
|
|
|
if (this.domainKeywords.size) {
|
|
strategy.writeDomainKeywords(this.domainKeywords);
|
|
}
|
|
if (this.domainWildcard.size) {
|
|
strategy.writeDomainWildcards(this.domainWildcard);
|
|
}
|
|
if (this.userAgent.size) {
|
|
strategy.writeUserAgents(this.userAgent);
|
|
}
|
|
if (this.processName.size) {
|
|
strategy.writeProcessNames(this.processName);
|
|
}
|
|
if (this.processPath.size) {
|
|
strategy.writeProcessPaths(this.processPath);
|
|
}
|
|
}
|
|
|
|
if (this.sourceIpOrCidr.size) {
|
|
const sourceIpOrCidr = Array.from(this.sourceIpOrCidr);
|
|
for (let i = 0, len = this.strategies.length; i < len; i++) {
|
|
const strategy = this.strategies[i];
|
|
if (strategy) {
|
|
strategy.writeSourceIpCidrs(sourceIpOrCidr);
|
|
}
|
|
}
|
|
}
|
|
|
|
for (let i = 0, len = this.strategies.length; i < len; i++) {
|
|
const strategy = this.strategies[i];
|
|
if (strategy) {
|
|
if (this.sourcePort.size) {
|
|
strategy.writeSourcePorts(this.sourcePort);
|
|
}
|
|
if (this.destPort.size) {
|
|
strategy.writeDestinationPorts(this.destPort);
|
|
}
|
|
if (this.otherRules.length) {
|
|
strategy.writeOtherRules(this.otherRules);
|
|
}
|
|
if (this.urlRegex.size) {
|
|
strategy.writeUrlRegexes(this.urlRegex);
|
|
}
|
|
}
|
|
}
|
|
|
|
let ipcidr: string[] | null = null;
|
|
let ipcidrNoResolve: string[] | null = null;
|
|
let ipcidr6: string[] | null = null;
|
|
let ipcidr6NoResolve: string[] | null = null;
|
|
|
|
if (this.ipcidr.size) {
|
|
ipcidr = mergeCidr(Array.from(this.ipcidr), true);
|
|
}
|
|
if (this.ipcidrNoResolve.size) {
|
|
ipcidrNoResolve = mergeCidr(Array.from(this.ipcidrNoResolve), true);
|
|
}
|
|
if (this.ipcidr6.size) {
|
|
ipcidr6 = Array.from(this.ipcidr6);
|
|
}
|
|
if (this.ipcidr6NoResolve.size) {
|
|
ipcidr6NoResolve = Array.from(this.ipcidr6NoResolve);
|
|
}
|
|
|
|
for (let i = 0, len = this.strategies.length; i < len; i++) {
|
|
const strategy = this.strategies[i];
|
|
if (strategy) {
|
|
// no-resolve
|
|
if (ipcidrNoResolve?.length) {
|
|
strategy.writeIpCidrs(ipcidrNoResolve, true);
|
|
}
|
|
if (ipcidr6NoResolve?.length) {
|
|
strategy.writeIpCidr6s(ipcidr6NoResolve, true);
|
|
}
|
|
if (this.ipasnNoResolve.size) {
|
|
strategy.writeIpAsns(this.ipasnNoResolve, true);
|
|
}
|
|
if (this.groipNoResolve.size) {
|
|
strategy.writeGeoip(this.groipNoResolve, true);
|
|
}
|
|
|
|
// triggers DNS resolution
|
|
if (ipcidr?.length) {
|
|
strategy.writeIpCidrs(ipcidr, false);
|
|
}
|
|
if (ipcidr6?.length) {
|
|
strategy.writeIpCidr6s(ipcidr6, false);
|
|
}
|
|
if (this.ipasn.size) {
|
|
strategy.writeIpAsns(this.ipasn, false);
|
|
}
|
|
if (this.geoip.size) {
|
|
strategy.writeGeoip(this.geoip, false);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
write(): Promise<void> {
|
|
return this.span.traceChildAsync('write all', async (childSpan) => {
|
|
const promises: Array<Promise<void> | void> = [];
|
|
|
|
await childSpan.traceChildAsync('write to strategies', this.writeToStrategies.bind(this));
|
|
|
|
invariant(this.title, 'Missing title');
|
|
invariant(this.description, 'Missing description');
|
|
|
|
for (let i = 0, len = this.strategies.length; i < len; i++) {
|
|
const strategy = this.strategies[i];
|
|
if (strategy) {
|
|
const basename = (strategy.overwriteFilename || this.id) + '.' + strategy.fileExtension;
|
|
promises.push(strategy.output(
|
|
childSpan,
|
|
this.title,
|
|
this.description,
|
|
this.date,
|
|
path.join(
|
|
strategy.outputDir,
|
|
strategy.type
|
|
? path.join(strategy.type, basename)
|
|
: basename
|
|
)
|
|
));
|
|
}
|
|
}
|
|
|
|
await Promise.all(promises);
|
|
});
|
|
}
|
|
|
|
async compile(): Promise<Array<string[] | null>> {
|
|
await this.writeToStrategies();
|
|
|
|
return this.strategies.reduce<Array<string[] | null>>((acc, strategy) => {
|
|
if (strategy) {
|
|
acc.push(strategy.content);
|
|
} else {
|
|
acc.push(null);
|
|
}
|
|
return acc;
|
|
}, []);
|
|
}
|
|
|
|
withMitmSgmodulePath(moduleName: string | null) {
|
|
if (moduleName) {
|
|
this.withExtraStrategies(new SurgeMitmSgmodule(moduleName));
|
|
}
|
|
return this;
|
|
}
|
|
}
|
|
|
|
export async function fileEqual(linesA: string[], source: AsyncIterable<string> | Iterable<string>): Promise<boolean> {
|
|
if (linesA.length === 0) {
|
|
return false;
|
|
}
|
|
|
|
const linesABound = linesA.length - 1;
|
|
|
|
let index = -1;
|
|
for await (const lineB of source) {
|
|
index++;
|
|
|
|
if (index > linesABound) {
|
|
return (index === linesA.length && lineB.length === 0);
|
|
}
|
|
|
|
const lineA = linesA[index];
|
|
|
|
if (lineA.length === 0 && lineB.length === 0) {
|
|
continue;
|
|
}
|
|
|
|
// not both line are empty
|
|
if (lineA.length === 0 || lineB.length === 0) {
|
|
return false;
|
|
}
|
|
|
|
const firstCharA = lineA.charCodeAt(0);
|
|
const firstCharB = lineB.charCodeAt(0);
|
|
|
|
if (firstCharA !== firstCharB) {
|
|
return false;
|
|
}
|
|
|
|
if (firstCharA === 35 /* # */ && firstCharB === 35 /* # */) {
|
|
continue;
|
|
}
|
|
// adguard conf
|
|
if (firstCharA === 33 /* ! */ && firstCharB === 33 /* ! */) {
|
|
continue;
|
|
}
|
|
|
|
if (
|
|
firstCharA === 47 /* / */ && firstCharB === 47 /* / */
|
|
&& lineA[1] === '/' && lineB[1] === '/'
|
|
&& lineA[3] === '#' && lineB[3] === '#'
|
|
) {
|
|
continue;
|
|
}
|
|
|
|
if (lineA !== lineB) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// The file becomes larger
|
|
return !(index < linesABound);
|
|
}
|
|
|
|
export async function compareAndWriteFile(span: Span, linesA: string[], filePath: string) {
|
|
const linesALen = linesA.length;
|
|
|
|
const isEqual = await span.traceChildAsync(`compare ${filePath}`, async () => {
|
|
if (fs.existsSync(filePath)) {
|
|
return fileEqual(linesA, readFileByLine(filePath));
|
|
}
|
|
|
|
console.log(`${filePath} does not exists, writing...`);
|
|
return false;
|
|
});
|
|
|
|
if (isEqual) {
|
|
console.log(picocolors.gray(picocolors.dim(`same content, bail out writing: ${filePath}`)));
|
|
return;
|
|
}
|
|
|
|
await span.traceChildAsync(`writing ${filePath}`, async () => {
|
|
// The default highwater mark is normally 16384,
|
|
// So we make sure direct write to file if the content is
|
|
// most likely less than 500 lines
|
|
if (linesALen < 500) {
|
|
return writeFile(filePath, fastStringArrayJoin(linesA, '\n') + '\n');
|
|
}
|
|
|
|
const writeStream = fs.createWriteStream(filePath);
|
|
for (let i = 0; i < linesALen; i++) {
|
|
const p = asyncWriteToStream(writeStream, linesA[i] + '\n');
|
|
// eslint-disable-next-line no-await-in-loop -- stream high water mark
|
|
if (p) await p;
|
|
}
|
|
|
|
writeStream.end();
|
|
});
|
|
}
|