whistle.easy-proxy 1.0.0

package/lib/cli/upstream-editor.js

@@ -0,0 +1,218 @@
+/**
+ * 上游代理配置编辑器解析模块
+ * 纯函数：parse / format / validate / buildEditContent
+ *
+ * 文本格式约定：
+ *   - 每个代理占一块，第1行=名称，第2行=URL，第3行起=域名列表
+ *   - 多个代理之间用空行分隔
+ *   - 以 # 开头的行是注释（整行），会被忽略
+ *   - 支持 \r\n 和 \n 换行
+ */
+
+// ---- 工具函数 ----
+
+/**
+ * 域名去重（不区分大小写，保留首次出现的原写形式）
+ * @param {string[]} domains
+ * @returns {string[]}
+ */
+function dedupeDomains(domains) {
+  const seen = new Set();
+  const result = [];
+  for (const d of domains) {
+    const key = d.toLowerCase();
+    if (!seen.has(key)) {
+      seen.add(key);
+      result.push(d);
+    }
+  }
+  return result;
+}
+
+/**
+ * 将文本分割为「原始行号 + 内容」的数组，同时处理 \r\n 和注释过滤
+ * 保留原始行号用于错误提示
+ * @param {string} text
+ * @returns {Array<{lineNo: number, content: string}>}
+ */
+function splitLinesWithNumbers(text) {
+  const rawLines = text.replace(/\r/g, '').split('\n');
+  const result = [];
+  for (let i = 0; i < rawLines.length; i++) {
+    const line = rawLines[i].trim();
+    // 过滤整行注释
+    if (line.startsWith('#')) continue;
+    result.push({ lineNo: i + 1, content: line });
+  }
+  return result;
+}
+
+// ---- 核心函数 ----
+
+/**
+ * 解析文本格式的上游代理配置
+ * @param {string} text - 编辑器中的文本内容
+ * @returns {Array<{name: string, url: string, domains: string[]}>}
+ * @throws {Error} 格式错误时抛出，错误信息包含具体位置和原因
+ */
+function parse(text) {
+  if (!text || !text.trim()) return [];
+
+  const lines = splitLinesWithNumbers(text);
+  const proxies = [];
+  let i = 0;
+
+  while (i < lines.length) {
+    // 跳过连续空行
+    if (lines[i].content === '') {
+      i++;
+      continue;
+    }
+
+    // 第 1 行：代理名称
+    const nameLine = lines[i];
+    const name = nameLine.content;
+    if (!name) {
+      throw new Error(`第 ${nameLine.lineNo} 行: 代理名称不能为空`);
+    }
+    i++;
+
+    // 第 2 行：代理 URL
+    if (i >= lines.length || lines[i].content === '') {
+      throw new Error(`第 ${nameLine.lineNo} 行: 代理 "${name}" 缺少 URL`);
+    }
+    const urlLine = lines[i];
+    const url = urlLine.content;
+    if (!/^https?:\/\//i.test(url)) {
+      throw new Error(`第 ${urlLine.lineNo} 行: 代理 URL 必须以 http:// 或 https:// 开头`);
+    }
+    i++;
+
+    // 第 3 行起：域名列表（直到空行或结尾）
+    const domains = [];
+    while (i < lines.length && lines[i].content !== '') {
+      const domain = lines[i].content;
+      domains.push(domain);
+      i++;
+    }
+
+    proxies.push({
+      name,
+      url,
+      domains: dedupeDomains(domains),
+    });
+  }
+
+  // 名称唯一性校验（不区分大小写）
+  const nameSet = new Set();
+  for (const p of proxies) {
+    const key = p.name.toLowerCase();
+    if (nameSet.has(key)) {
+      throw new Error(`代理名称重复: "${p.name}"（名称不区分大小写）`);
+    }
+    nameSet.add(key);
+  }
+
+  return proxies;
+}
+
+/**
+ * 将代理数组格式化为文本（不含注释头部）
+ * @param {Array<{name: string, url: string, domains: string[]}>} proxies
+ * @returns {string}
+ */
+function format(proxies) {
+  if (!proxies || proxies.length === 0) return '';
+
+  const blocks = proxies.map((p) => {
+    const lines = [p.name, p.url];
+    if (p.domains && p.domains.length > 0) {
+      lines.push(...p.domains);
+    }
+    return lines.join('\n');
+  });
+
+  return blocks.join('\n\n');
+}
+
+/**
+ * 校验代理数组合法性
+ * @param {Array<{name: string, url: string, domains: string[]}>} proxies
+ * @returns {Array} 返回校验后的 proxies（域名已去重）
+ * @throws {Error} 校验失败时抛出
+ */
+function validate(proxies) {
+  if (!Array.isArray(proxies)) {
+    throw new Error('代理配置必须是数组');
+  }
+
+  const nameSet = new Set();
+
+  return proxies.map((proxy, idx) => {
+    const position = `第 ${idx + 1} 个代理`;
+
+    // 名称校验
+    const name = (proxy.name || '').trim();
+    if (!name) {
+      throw new Error(`${position}: 代理名称不能为空`);
+    }
+
+    // URL 校验
+    const url = (proxy.url || '').trim();
+    if (!url) {
+      throw new Error(`${position}: 代理 URL 不能为空`);
+    }
+    if (!/^https?:\/\//i.test(url)) {
+      throw new Error(`${position}: 代理 URL 必须以 http:// 或 https:// 开头`);
+    }
+
+    // 名称唯一性（不区分大小写）
+    const key = name.toLowerCase();
+    if (nameSet.has(key)) {
+      throw new Error(`代理名称重复: "${name}"（名称不区分大小写）`);
+    }
+    nameSet.add(key);
+
+    // 域名 trim + 去重
+    const domains = dedupeDomains(
+      (proxy.domains || []).map((d) => (d || '').trim()).filter(Boolean),
+    );
+
+    return { name, url, domains };
+  });
+}
+
+/**
+ * 构建编辑器内容（带注释头部 + 当前配置）
+ * @param {Array<{name: string, url: string, domains: string[]}>} proxies
+ * @returns {string}
+ */
+function buildEditContent(proxies) {
+  const header = [
+    '# EasyProxy 上游代理配置',
+    '# 格式说明：',
+    '#   - 每个代理占一块，第一行是代理名称，第二行是代理地址，第三行起是域名列表',
+    '#   - 多个代理之间用空行分隔',
+    '#   - 以 # 开头的行是注释，会被忽略',
+    '# 示例：',
+    '#   corp-proxy',
+    '#   http://10.0.0.1:8080',
+    '#   github.com',
+    '#   google.com',
+    '#',
+    '#   home-proxy',
+    '#   http://192.168.1.100:3128',
+    '#   internal.company.com',
+  ].join('\n');
+
+  const body = format(proxies);
+  if (!body) return header + '\n';
+  return header + '\n\n' + body;
+}
+
+module.exports = {
+  parse,
+  format,
+  validate,
+  buildEditContent,
+};

package/lib/cli/upstream-proxy.js

@@ -0,0 +1,74 @@
+const _fs = require('node:fs');
+const _path = require('node:path');
+
+const { loadConfig, saveConfig } = require('../config');
+
+const RULESET_NAME = 'upstream-proxies';
+
+function loadProxies() {
+  try {
+    const config = loadConfig(null);
+    return Array.isArray(config.upstreamProxies) ? config.upstreamProxies : [];
+  } catch (e) {
+    console.warn('读取上游代理配置失败:', e.message);
+    return [];
+  }
+}
+
+function saveProxies(proxies) {
+  try {
+    const config = loadConfig(null);
+    config.upstreamProxies = proxies;
+    saveConfig(null, config);
+  } catch (e) {
+    console.warn('保存上游代理配置失败:', e.message);
+  }
+}
+
+/**
+ * 将代理 URL 转换为 whistle 代理格式
+ * 使用 proxy:// 协议格式，支持 HTTP 和 HTTPS CONNECT 隧道
+ */
+function toProxyProtocol(url) {
+  return url.replace(/^https?:\/\//, 'proxy://');
+}
+
+/**
+ * 根据配置生成 whistle 规则文本
+ */
+function generateRules(proxies) {
+  const lines = ['# EasyProxy 上游代理规则（自动生成，请勿手动编辑）'];
+  let hasRules = false;
+  proxies.forEach((proxy) => {
+    const proxyUrl = toProxyProtocol(proxy.url);
+    proxy.domains.forEach((domain) => {
+      lines.push(`${domain} ${proxyUrl}`);
+      hasRules = true;
+    });
+  });
+  if (!hasRules) {
+    lines.push('# (暂无规则 — 使用 easy-proxy proxy upstream edit 添加)');
+  }
+  return lines.join('\n');
+}
+
+/**
+ * 同步上游代理规则到 whistle
+ * 需要 whistle 运行中，通过 rule-api 写入规则集到系统规则分组
+ */
+async function syncToWhistle(ruleApi, proxies) {
+  const list = proxies || loadProxies();
+  const rules = generateRules(list);
+  await ruleApi.createGroup(ruleApi.SYSTEM_GROUP);
+  await ruleApi.addRuleset(RULESET_NAME, rules, ruleApi.SYSTEM_GROUP);
+  await ruleApi.selectRuleset(RULESET_NAME, rules);
+}
+
+module.exports = {
+  RULESET_NAME,
+  loadProxies,
+  saveProxies,
+  toProxyProtocol,
+  generateRules,
+  syncToWhistle,
+};

package/lib/config.js

@@ -0,0 +1,204 @@
+const fs = require('node:fs');
+const path = require('node:path');
+const os = require('node:os');
+
+const { debug } = require('./debug');
+
+const HOME = os.homedir();
+const CONFIG_DIR = path.join(HOME, '.easy-proxy');
+const CONFIG_FILE = 'config.json';
+const CONFIG_PATH = path.join(CONFIG_DIR, CONFIG_FILE);
+
+const defaultRules = require('./plugin/default-rules');
+
+const DEFAULT_CONFIG = {
+  enabled: true,
+  interceptEnabled: true,
+  interceptRules: defaultRules,
+  doh: { bootstrapIp: '8.8.8.8', host: 'dns.google', path: '/resolve', port: 443 },
+  ipCacheTtl: 600,
+  sniRewrite: { enabled: false, defaultSni: null, sniMap: {} },
+  hosts: [],
+  upstreamProxies: [],
+  proxyBypassDomains: null,
+};
+
+function ensureDir() {
+  try {
+    fs.mkdirSync(CONFIG_DIR, { recursive: true });
+  } catch (e) {
+    debug('ensureDir failed:', e.message);
+  }
+}
+
+/**
+ * 读取配置文件。文件是唯一数据源，whistle storage 仅做同步备份。
+ */
+function loadConfig(options) {
+  ensureDir();
+
+  let fileConfig = null;
+  try {
+    if (fs.existsSync(CONFIG_PATH)) {
+      fileConfig = JSON.parse(fs.readFileSync(CONFIG_PATH, 'utf8'));
+    }
+  } catch (e) {
+    debug('loadConfig: parse config file failed:', e.message);
+    fileConfig = null;
+  }
+
+  if (fileConfig) {
+    // 有文件 → 同步到 whistle storage（备份）
+    try {
+      if (options?.storage) {
+        options.storage.setProperty('config', JSON.stringify(fileConfig));
+      }
+    } catch (e) {
+      debug('loadConfig: sync to whistle storage failed:', e.message);
+    }
+    const merged = deepMerge(JSON.parse(JSON.stringify(DEFAULT_CONFIG)), fileConfig);
+    const errors = validateConfig(merged);
+    if (errors.length > 0) {
+      console.warn('配置验证警告:', errors.join(', '));
+    }
+    return merged;
+  }
+
+  // 文件不存在 → 尝试从 whistle storage 恢复
+  let stored = null;
+  if (options?.storage) {
+    try {
+      const raw = options.storage.getProperty('config');
+      if (raw) stored = JSON.parse(raw);
+    } catch (e) {
+      debug('loadConfig: read from whistle storage failed:', e.message);
+    }
+  }
+
+  if (stored) {
+    try {
+      ensureDir();
+      fs.writeFileSync(CONFIG_PATH, JSON.stringify(stored, null, 2));
+    } catch (e) {
+      debug('loadConfig: restore config from whistle storage to file failed:', e.message);
+    }
+  }
+
+  return deepMerge(JSON.parse(JSON.stringify(DEFAULT_CONFIG)), stored || {});
+}
+
+function saveConfig(options, config) {
+  ensureDir();
+  const text = JSON.stringify(config, null, 2);
+  try {
+    if (options?.storage) {
+      options.storage.setProperty('config', text);
+    }
+  } catch (e) {
+    debug('saveConfig: sync to whistle storage failed:', e.message);
+  }
+  try {
+    fs.writeFileSync(CONFIG_PATH, text);
+  } catch (e) {
+    debug('saveConfig: write config file failed:', e.message);
+  }
+}
+
+function deepMerge(base, over) {
+  if (Array.isArray(base)) return Array.isArray(over) ? over : base;
+  if (base && typeof base === 'object') {
+    const out = Object.assign({}, base);
+    Object.keys(over || {}).forEach((k) => {
+      out[k] = k in out ? deepMerge(out[k], over[k]) : over[k];
+    });
+    return out;
+  }
+  return over === undefined ? base : over;
+}
+
+function validateConfig(config) {
+  const errors = [];
+
+  if (typeof config.enabled !== 'boolean') {
+    errors.push('enabled 必须是布尔值');
+  }
+
+  if (config.doh) {
+    if (typeof config.doh !== 'object') {
+      errors.push('doh 必须是对象');
+    } else {
+      if (config.doh.bootstrapIp && typeof config.doh.bootstrapIp !== 'string') {
+        errors.push('doh.bootstrapIp 必须是字符串');
+      }
+      if (config.doh.host && typeof config.doh.host !== 'string') {
+        errors.push('doh.host 必须是字符串');
+      }
+      if (config.doh.path && typeof config.doh.path !== 'string') {
+        errors.push('doh.path 必须是字符串');
+      }
+      if (config.doh.port && typeof config.doh.port !== 'number') {
+        errors.push('doh.port 必须是数字');
+      }
+    }
+  }
+
+  if (config.ipCacheTtl && typeof config.ipCacheTtl !== 'number') {
+    errors.push('ipCacheTtl 必须是数字');
+  }
+
+  if (config.sniRewrite) {
+    if (typeof config.sniRewrite !== 'object') {
+      errors.push('sniRewrite 必须是对象');
+    } else {
+      if (config.sniRewrite.enabled && typeof config.sniRewrite.enabled !== 'boolean') {
+        errors.push('sniRewrite.enabled 必须是布尔值');
+      }
+      if (config.sniRewrite.defaultSni && typeof config.sniRewrite.defaultSni !== 'string') {
+        errors.push('sniRewrite.defaultSni 必须是字符串');
+      }
+      if (config.sniRewrite.sniMap && typeof config.sniRewrite.sniMap !== 'object') {
+        errors.push('sniRewrite.sniMap 必须是对象');
+      }
+    }
+  }
+
+  if (config.hosts && !Array.isArray(config.hosts)) {
+    errors.push('hosts 必须是数组');
+  }
+
+  if (config.upstreamProxies && !Array.isArray(config.upstreamProxies)) {
+    errors.push('upstreamProxies 必须是数组');
+  }
+
+  if (config.proxyBypassDomains && !Array.isArray(config.proxyBypassDomains)) {
+    errors.push('proxyBypassDomains 必须是数组');
+  }
+
+  if (config.interceptEnabled !== undefined && typeof config.interceptEnabled !== 'boolean') {
+    errors.push('interceptEnabled 必须是布尔值');
+  }
+
+  if (config.interceptRules !== undefined && config.interceptRules !== null) {
+    if (typeof config.interceptRules !== 'object' || Array.isArray(config.interceptRules)) {
+      errors.push('interceptRules 必须是对象');
+    }
+  }
+
+  return errors;
+}
+
+// 从 rules-file.js 重新导出规则集操作
+const { listRulesets, getRuleset, saveRuleset, deleteRuleset } = require('./cli/rules-file');
+
+module.exports = {
+  DEFAULT_CONFIG,
+  CONFIG_PATH,
+  loadConfig,
+  saveConfig,
+  deepMerge,
+  validateConfig,
+  listRulesets,
+  getRuleset,
+  saveRuleset,
+  deleteRuleset,
+};

package/lib/debug.js

@@ -0,0 +1,17 @@
+/**
+ * 简单的 debug 日志工具
+ * 通过环境变量 EASY_PROXY_DEBUG=1 开启
+ */
+
+const DEBUG_ENABLED = process.env.EASY_PROXY_DEBUG === '1';
+
+function debug(...args) {
+  if (DEBUG_ENABLED) {
+    console.error('[DEBUG]', ...args);
+  }
+}
+
+module.exports = {
+  debug,
+  DEBUG_ENABLED,
+};

package/lib/network-utils.js

@@ -0,0 +1,56 @@
+const os = require('node:os');
+const http = require('node:http');
+
+/**
+ * Get the primary LAN IPv4 address.
+ */
+function getLocalIp() {
+  const interfaces = os.networkInterfaces();
+  for (const name of Object.keys(interfaces)) {
+    const addrs = interfaces[name];
+    if (!addrs) continue;
+    for (const addr of addrs) {
+      if (addr.family === 'IPv4' && !addr.internal) {
+        return addr.address;
+      }
+    }
+  }
+  return '127.0.0.1';
+}
+
+/**
+ * Check network latency in ms.
+ * @param {number} [port] - proxy port, omit for direct connection
+ */
+function checkDelay(port) {
+  const CHECK_HOST = 'www.msftconnecttest.com';
+  const CHECK_PATH = '/connecttest.txt';
+
+  return new Promise((resolve, reject) => {
+    const startTime = Date.now();
+    const options = {
+      path: CHECK_PATH,
+      headers: { Host: CHECK_HOST },
+      port: 80,
+      host: CHECK_HOST,
+    };
+
+    if (port) {
+      options.port = port;
+      options.host = '127.0.0.1';
+    }
+
+    const req = http.get(options, (res) => {
+      if (res.statusCode === 200) {
+        res.resume();
+        resolve(Date.now() - startTime);
+      } else {
+        res.resume();
+        reject(new Error(`HTTP ${res.statusCode}`));
+      }
+    });
+    req.on('error', reject);
+  });
+}
+
+module.exports = { getLocalIp, checkDelay };

package/lib/plugin/default-hosts.js

@@ -0,0 +1,48 @@
+/**
+ * GitHub-related domains that EasyProxy accelerates.
+ *
+ * `domains` supports two forms:
+ *   - exact host:   "github.com"
+ *   - wildcard:     "*.githubusercontent.com"  (matches single-label subdomain)
+ *
+ * `curated` is a FALLBACK IP list used only when DoH resolution fails.
+ * These values should be refreshed periodically (GitHub/Fastly rotate IP ranges).
+ * The plugin prefers live DoH resolution at runtime.
+ */
+module.exports = {
+  domains: [
+    'github.com',
+    'api.github.com',
+    'gist.github.com',
+    'raw.githubusercontent.com',
+    'gist.githubusercontent.com',
+    'cloud.githubusercontent.com',
+    'camo.githubusercontent.com',
+    'avatars.githubusercontent.com',
+    'avatars0.githubusercontent.com',
+    'avatars1.githubusercontent.com',
+    'avatars2.githubusercontent.com',
+    'avatars3.githubusercontent.com',
+    'user-images.githubusercontent.com',
+    'media.githubusercontent.com',
+    'objects.githubusercontent.com',
+    'codeload.github.com',
+    'github.githubassets.com',
+    'assets-cdn.github.com',
+    'collector.github.com',
+    'desktop.githubusercontent.com',
+    'vignette.githubusercontent.com',
+    'pipelines.actions.githubusercontent.com',
+    '*.github.io',
+  ],
+
+  curated: {
+    'github.com': ['20.205.243.166', '140.82.121.4'],
+    'api.github.com': ['20.205.243.166', '140.82.121.5'],
+    'raw.githubusercontent.com': ['185.199.108.133', '185.199.109.133'],
+    'objects.githubusercontent.com': ['185.199.108.133', '185.199.109.133'],
+    'avatars.githubusercontent.com': ['185.199.108.133', '185.199.109.133'],
+    'github.githubassets.com': ['185.199.108.153', '185.199.109.153'],
+    'codeload.github.com': ['20.205.243.166', '140.82.121.10'],
+  },
+};