Refactor: new write strategy (#58)

2026-01-28 17:41:54 +08:00 · 2025-01-29 03:58:49 +08:00
parent 6606d5cb01
commit b22079f5eb
17 changed files with 1096 additions and 673 deletions
--- a/Build/lib/writing-strategy/adguardhome.ts
+++ b/Build/lib/writing-strategy/adguardhome.ts
@@ -0,0 +1,107 @@
+import { escapeStringRegexp } from 'foxts/escape-string-regexp';
+import { BaseWriteStrategy } from './base';
+import { noop } from 'foxts/noop';
+import { notSupported } from '../misc';
+
+export class AdGuardHome extends BaseWriteStrategy {
+  // readonly type = 'domainset';
+  readonly fileExtension = 'txt';
+  readonly type = '';
+
+  protected result: string[] = [];
+
+  // eslint-disable-next-line @typescript-eslint/class-methods-use-this -- abstract method
+  withPadding(title: string, description: string[] | readonly string[], date: Date, content: string[]): string[] {
+    return [
+      `! Title: ${title}`,
+      '! Last modified: ' + date.toUTCString(),
+      '! Expires: 6 hours',
+      '! License: https://github.com/SukkaW/Surge/blob/master/LICENSE',
+      '! Homepage: https://github.com/SukkaW/Surge',
+      `! Description: ${description.join(' ')}`,
+      '!',
+      ...content,
+      '! EOF'
+    ];
+  }
+
+  writeDomain(domain: string): void {
+    this.result.push(`|${domain}^`);
+  }
+
+  // const whitelistArray = sortDomains(Array.from(whitelist));
+  // for (let i = 0, len = whitelistArray.length; i < len; i++) {
+  //   const domain = whitelistArray[i];
+  //   if (domain[0] === '.') {
+  //     results.push(`@@||${domain.slice(1)}^`);
+  //   } else {
+  //     results.push(`@@|${domain}^`);
+  //   }
+  // }
+
+  writeDomainSuffix(domain: string): void {
+    this.result.push(`||${domain}^`);
+  }
+
+  writeDomainKeywords(keywords: Set<string>): void {
+    for (const keyword of keywords) {
+      // Use regex to match keyword
+      this.result.push(`/${escapeStringRegexp(keyword)}/`);
+    }
+  }
+
+  writeDomainWildcards(wildcards: Set<string>): void {
+    for (const wildcard of wildcards) {
+      const processed = wildcard.replaceAll('?', '*');
+      if (processed.startsWith('*.')) {
+        this.result.push(`||${processed.slice(2)}^`);
+      } else {
+        this.result.push(`|${processed}^`);
+      }
+    }
+  }
+
+  writeUserAgents = noop;
+  writeProcessNames = noop;
+  writeProcessPaths = noop;
+  writeUrlRegexes = noop;
+  writeIpCidrs(ipGroup: string[], noResolve: boolean): void {
+    if (noResolve) {
+      // When IP is provided to AdGuardHome, any domain resolve to those IP will be blocked
+      // So we can't do noResolve
+      return;
+    }
+    for (const ipcidr of ipGroup) {
+      if (ipcidr.endsWith('/32')) {
+        this.result.push(`||${ipcidr.slice(0, -3)}`);
+        /* else if (ipcidr.endsWith('.0/24')) {
+          results.push(`||${ipcidr.slice(0, -6)}.*`);
+        } */
+      } else {
+        this.result.push(`||${ipcidr}^`);
+      }
+    }
+  }
+
+  writeIpCidr6s(ipGroup: string[], noResolve: boolean): void {
+    if (noResolve) {
+      // When IP is provided to AdGuardHome, any domain resolve to those IP will be blocked
+      // So we can't do noResolve
+      return;
+    }
+    for (const ipcidr of ipGroup) {
+      if (ipcidr.endsWith('/128')) {
+        this.result.push(`||${ipcidr.slice(0, -4)}`);
+      } else {
+        this.result.push(`||${ipcidr}`);
+      }
+    }
+  };
+
+  writeGeoip = notSupported('writeGeoip');
+  writeIpAsns = notSupported('writeIpAsns');
+  writeSourceIpCidrs = notSupported('writeSourceIpCidrs');
+  writeSourcePorts = notSupported('writeSourcePorts');
+  writeDestinationPorts = noop;
+  writeOtherRules = noop;
+}