whistle 2.9.13 → 2.9.14

package/README.md

@@ -179,6 +179,7 @@ Debugging mode:
 For more details, please visit [install and start](https://avwo.github.io/whistle/install.html)
 
 # Proxing Settings
+> https://wproxy.org/whistle/proxy.html
 ##### configuring server & port
 1. proxying server：127.0.0.1(if whistle is deployed in remote server or virtual machine, change this address to corresponding IP address)
 2. default port：8899(if port 8899 is used already, you can specify new port using `-p` when start. More details can be visited by executing `whistle help` or `w2 help` (only supported in `v0.7.0` and higher version)
@@ -321,6 +322,7 @@ Open [Rules](http://local.whistlejs.com/) tab in whistle, and create a group nam
 
 # Documentation
 1. [Install and start](https://avwo.github.io/whistle/install.html)
+1. [Setting proxy](https://wproxy.org/whistle/proxy.html)
 2. [CLI operation](https://avwo.github.io/whistle/cli.html)
 2. [How to update](https://avwo.github.io/whistle/update.html)
 3. [Quickly start](https://avwo.github.io/whistle/quickstart.html)

package/bin/proxy/cli.js

@@ -0,0 +1,76 @@
+var net = require('net');
+var proxy = require('./index');
+var util = require('../util');
+
+var readConfig = util.readConfig;
+var OFF_RE = /^(?:o|0|-{0,2}off)$/i;
+var BYPASS_RE = /^(?:-{0,2}bypass|-x|-b)$/i;
+var NUM_RE = /^\d+$/;
+var HOST_SUFFIX_RE = /\:(\d+|auto)?$/;
+var HOST_RE = /^[a-z\d_-]+(?:\.[a-z\d_-]+)*$/i;
+
+function getDefaultPort() {
+  var conf = readConfig();
+  conf = conf && conf.options;
+  var port = conf && conf.port;
+  return port > 0 ? port : 8899;
+}
+
+function enableProxy(options) {
+  if (proxy.enableProxy(options)) {
+    util.info('Setting global proxy (' + options.host + ':' + options.port + ') successful.');
+  } else {
+    util.error('Failed to set global proxy (' + options.host + ':' + options.port + ').');
+  }
+}
+
+function disableProxy() {
+  if (proxy.disableProxy()) {
+    util.info('Turn off global proxy successful.');
+  } else {
+    util.error('Failed to turn off global proxy.');
+  }
+}
+
+module.exports = function(argv) {
+  var cmd = argv[0];
+  if (OFF_RE.test(cmd)) {
+    return disableProxy();
+  }
+  var options = {};
+  var skip;
+  argv.forEach(function(arg) {
+    if (skip) {
+      options.bypass = arg;
+      skip = false;
+    } else if (BYPASS_RE.test(arg)) {
+      skip = true;
+    } else if (NUM_RE.test(arg)) {
+      options.port = parseInt(arg, 10) || options.port;
+    } else if (net.isIP(arg)) {
+      options.host = arg || options.host;
+    } else if (HOST_SUFFIX_RE.test(arg)) {
+      var port = RegExp.$1;
+      delete options.port;
+      if (port > 0) {
+        options.port = parseInt(port, 10) || options.port;
+      }
+      var host = arg.slice(0, - port.length - 1);
+      if (host[0] === '[') {
+        host = host.substring(1);
+      }
+      var lastIndex = host.length - 1;
+      if (host[lastIndex] === ']') {
+        host = host.substring(0, lastIndex);
+      }
+      if (host && (net.isIP(host) || HOST_RE.test(host))) {
+        options.host = host || options.host;
+      }
+    }
+  });
+  if (!options.port) {
+    options.port = getDefaultPort();
+  }
+  options.host = options.host || '127.0.0.1';
+  enableProxy(options);
+};

package/bin/proxy/index.d.ts

@@ -0,0 +1,9 @@
+export interface ProxyOptions {
+  host: string;
+  port: number;
+  bypass?: string;
+}
+
+export function enableProxy(options: ProxyOptions): boolean;
+
+export function disableProxy(): boolean;

package/bin/proxy/index.js

@@ -0,0 +1,49 @@
+var os = require('os');
+var net = require('net');
+var mac = require('./mac');
+var win = require('./win');
+
+var platform = os.platform();
+var BYPASS_RE = /^[*a-z\d_-]+(?:\.[*a-z\d_-]+)*$/i;
+
+function getBypass(bypass) {
+  if (!bypass || typeof bypass !== 'string') {
+    return;
+  }
+  var map = {};
+  bypass = bypass.trim().toLowerCase();
+  return bypass.split(/[\s,;]+/).filter(function(host) {
+    if (!map[host] && (host === '<local>' || net.isIP(host) || BYPASS_RE.test(host))) {
+      map[host] = 1;
+      return true;
+    }
+    return false;
+  });
+}
+
+// only support mac & win
+function getProxyMgr() {
+  if (platform === 'win32') {
+    return win;
+  }
+  if (platform === 'darwin') {
+    return mac;
+  }
+  throw new Error('Platform ' + platform + ' is unsupported to set global proxy for now.');
+}
+
+exports.enableProxy = function(options) {
+  var host = options.host.toLowerCase();
+  var enableProxy = getProxyMgr().enableProxy;
+  var bypass = getBypass(options.bypass);
+  return enableProxy({
+    host: host,
+    port: options.port,
+    bypass: bypass
+  });
+};
+
+exports.disableProxy = function() {
+  var disableProxy = getProxyMgr().disableProxy;
+  return disableProxy();
+};

package/bin/proxy/mac/index.js

@@ -0,0 +1,61 @@
+var execSync = require('child_process').execSync;
+var join = require('path').join;
+
+var PROXY_HELPER = join(__dirname, 'Whistle');
+
+function getProxyServer(isSecure) {
+  var str = execSync('networksetup -get' + (isSecure ? 'secure' : '') + 'webproxy "Wi-Fi"') + '';
+  var result = {};
+  str.split(/[\r\n]+/).forEach(function(line) {
+    var index = line.indexOf(':');
+    var key = line.substring(0, index).trim().toLowerCase();
+    var value = line.substring(index + 1).trim().toLowerCase();
+    if (key === 'enabled') {
+      result.enabled = value === 'yes';
+    } else if (key === 'server') {
+      result.host = value;
+    } else if (key === 'port') {
+      result.port = value;
+    }
+  });
+  return result;
+}
+
+function getCurProxy() {
+  return {
+    http: getProxyServer(),
+    https: getProxyServer(true)
+  };
+}
+
+function checkProxy(p1, p2) {
+  if (!p1.enabled) {
+    return false;
+  }
+  return p1.host == p2.host && p1.port == p2.port;
+}
+
+exports.enableProxy = function(options) {
+  var bypass = options.bypass;
+  var port = options.port;
+  if (bypass) {
+    bypass = ' -x "' + bypass + '"';
+  } else {
+    bypass = '';
+  }
+  execSync('\'' + PROXY_HELPER + '\' -m global -p ' + port + ' -r ' + port + ' -s ' + options.host + bypass);
+  try {
+    var curProxy = getCurProxy();
+    return checkProxy(curProxy.http, options) && checkProxy(curProxy.https, options);
+  } catch (e) {}
+  return true;
+};
+
+exports.disableProxy = function() {
+  execSync('\''  + PROXY_HELPER + '\' -m off');
+  try {
+    var curProxy = getCurProxy();
+    return !curProxy.http.enabled && !curProxy.https.enabled;
+  } catch (e) {}
+  return true;
+};

package/bin/proxy/win/index.js

@@ -0,0 +1,32 @@
+var execSync = require('child_process').execSync;
+var join = require('path').join;
+
+var REFRESH_PROXY = join(__dirname, 'refresh');
+var REG_PATH = 'reg add "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings" /v';
+
+function disableProxy() {
+  var proxyCmd = REG_PATH + ' ProxyEnable /t REG_DWORD /d 0 /f';
+  var pacCmd = REG_PATH + ' AutoConfigURL /t REG_DWORD /d 0 /f';
+  var detectCmd = REG_PATH + ' AutoDetect /t REG_DWORD /d 0 /f';
+  execSync(proxyCmd + ' & ' + pacCmd + ' & ' + detectCmd);
+  execSync(REFRESH_PROXY);
+  return true;
+}
+
+exports.enableProxy = function(options) {
+  disableProxy();
+  var bypass = options.bypass;
+  var setCmd = REG_PATH + ' ProxyServer /t REG_SZ /d ' + options.host + ':' + options.port + ' /f';
+  var enableCmd = REG_PATH + ' ProxyEnable /t REG_DWORD /d 1 /f';
+  var cmd = setCmd + ' & ' + enableCmd;
+
+  if (bypass) {
+    bypass = REG_PATH + ' ProxyOverride /t REG_SZ /d "' + bypass.join(';') + '" /f';
+    cmd = cmd + ' & ' + bypass;
+  }
+  execSync(cmd);
+  execSync(REFRESH_PROXY);
+  return true;
+};
+
+exports.disableProxy = disableProxy;

package/bin/status.js

@@ -26,15 +26,15 @@ function showAll(byStop) {
     if (!len) {
       warn('[!] No running whistle.');
     } else {
-      var tips = [byStop ? '[i] Other running whistle:' : '[i] All running whistle:'];
+      var tips = ['[i] All running whistle:'];
       confList.forEach(function(conf, i) {
         ++i;
         var options = conf.options;
-        tips.push('  ' + i + '. port: ' + (options.port || pkg.port)
-          + (options.host ? ', host: ' + options.host : '')
-          + (options.storage ? ', storage: ' + options.storage : '')
-          + (conf.pid ? ', pid: ' + conf.pid : '')
-          + (byStop ? colors.red(' (stop cmd: ' + (options.storage ? 'w2 stop -S ' + options.storage : 'w2 stop') + ')') : ''));
+        tips.push('  ' + i + '.' + (conf.pid ? ' PID: ' + conf.pid + ',' : '')
+          + ' Port: ' + (options.port || pkg.port)
+          + (options.host ? ', Host: ' + options.host : '')
+          + (options.storage ? ', Storage: ' + options.storage : '')
+          + (byStop ? colors.red(' (Stop cmd: ' + (options.storage ? 'w2 stop -S ' + options.storage : 'w2 stop') + ')') : ''));
       });
       byStop && warn('[!] This whistle is not running.');
       info(tips.join('\n'));

package/bin/use.js

@@ -113,7 +113,7 @@ function checkDefault(running, storage, callback) {
 module.exports = function(filepath, storage, force) {
   storage = storage || '';
   var config = readConfig(storage) || '';
-  options = config.options; 
+  options = config.options;
   var pid = options && config.pid;
   var addon = options && options.addon;
   var conf = require('../lib/config');
@@ -151,7 +151,7 @@ module.exports = function(filepath, storage, force) {
             'rules=' + encodeURIComponent(rules)
           ].join('&');
           request(body, function() {
-            info('Setting whistle[' + (options.host || '127.0.0.1') + ':' + port + '] rules successful.');
+            info('Setting whistle (' + (options.host || '127.0.0.1') + ':' + port + ') rules successful.');
           });
         };
         if (force) {

package/bin/whistle.js

@@ -7,6 +7,7 @@ var useRules = require('./use');
 var showStatus = require('./status');
 var util = require('./util');
 var plugin = require('./plugin');
+var setProxy = require('./proxy/cli');
 
 var showUsage = util.showUsage;
 var error = util.error;
@@ -80,15 +81,17 @@ program
   .command('status')
   .description('Show the running status');
 program
-  .command('add [filepath]')
+  .command('add')
   .description('Add rules from local js file (.whistle.js by default)');
+program.command('proxy')
+  .description('Set global proxy');
 program.command('install')
-  .description('Install a whistle plugin');
+  .description('Install whistle plugin');
 program.command('uninstall')
-  .description('Uninstall a whistle plugin');
+  .description('Uninstall whistle plugin');
 program.command('exec')
-  .description('Exec whistle plugin command');
-  
+  .description('Exec whistle plugin cmd');
+
 program
   .option('-D, --baseDir [baseDir]', 'set the configured storage root path', String, undefined)
   .option('-z, --certDir [directory]', 'set custom certificate store directory', String, undefined)
@@ -138,6 +141,8 @@ if (cmd === 'status') {
     storage = argv[4];
   }
   showStatus(all, storage);
+} else if (cmd === 'proxy') {
+  setProxy(Array.prototype.slice.call(argv, 3));
 } else if (/^([a-z]{1,2})?uni(nstall)?$/.test(cmd)) {
   plugin.uninstall(Array.prototype.slice.call(argv, 3));
 } else if (/^([a-z]{1,2})?i(nstall)?$/.test(cmd)) {

package/biz/index.js

@@ -138,7 +138,7 @@ module.exports = function(req, res, next) {
   } else if (localRule = rules.resolveLocalRule(req)) {
     req.url = localRule.url;
     if (localRule.realPort) {
-      req.headers.host = '127.0.0.1:' + localRule.realPort; 
+      req.headers.host = '127.0.0.1:' + localRule.realPort;
       util.transformReq(req, res, localRule.realPort);
     } else {
       handleUIReq(req, res);

package/biz/webui/cgi-bin/util.js

@@ -148,7 +148,7 @@ exports.sendGzip = function(req, res, data) {
         res.json(data);
       } catch (e) {
         res.status(500).send(config.debugMode ?
-          '<pre>' + util.getErrorStack(err) + '</pre>' : 'Internal Server Error');
+          '<pre>' + util.encodeHtml(util.getErrorStack(err)) + '</pre>' : 'Internal Server Error');
       }
       return;
     }

package/biz/webui/htdocs/index.html

@@ -8,6 +8,6 @@
 </head>
 <body style="overscroll-behavior-x: none;">
 <div id="container" class="main"></div>
-<script src="js/index.js?v=2.9.11"></script>
+<script src="js/index.js?v=2.9.14"></script>
 </body>
 </html>