Merge branch 'qr' of github.com:HARDY8118/http-server into qr

Author: HARDY8118

.github/ISSUE_TEMPLATE

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!-- Describe the issue briefly here. -->
+
+#### Environment Versions
+
+1. OS Type
+1. Node version: `$ node --version`
+1. http-server version: `$ http-server --version`
+
+#### Steps to reproduce
+
+<!-- Include the actual command -->
+
+1. ...
+2. ...
+3. ...
+
+#### Expected result
+
+...
+
+#### Actual result
+
+<!-- Include full output and/or stack trace -->
+
+...
+
+#### Other information
+
+<!-- Include related issues, suggestions for a fix or further debug information, etc. -->

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+#### What's the problem this feature will solve?
+
+<!-- What are you trying to do, that you are unable to achieve with http-server as it currently stands? -->
+
+#### Describe the solution you'd like
+
+<!-- A clear and concise description of what you want to happen. -->
+
+<!-- Provide examples of real-world use cases that this would enable and how it solves the problem described above. -->
+
+#### Alternative Solutions
+
+<!-- Have you tried to workaround the problem using http-server or other tools? Or a different approach to solving this issue? Please elaborate here. -->
+
+#### Additional context
+
+<!-- Add any other context, links, etc. about the feature here. -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,23 @@
+<!--- Describe the changes here. --->
+
+##### Relevant issues
+
+<!--
+    Link to the issue(s) this pull request fixes here, if applicable: "Fixes #xxx" or "Resolves #xxx"
+    
+    If your PR fixes multiple issues, list them individually like "Fixes #xx1, fixes #xx2, fixes #xx3". This is a quirk of how GitHub links issues.
+-->
+
+##### Contributor checklist
+
+- [ ] Provide tests for the changes (unless documentation-only)
+- [ ] Documented any new features, CLI switches, etc. (if applicable)
+    - [ ] Server `--help` output
+    - [ ] README.md
+    - [ ] doc/http-server.1 (use the same format as other entries)
+- [ ] The pull request is being made against the `master` branch
+
+##### Maintainer checklist
+
+- [ ] Assign a version triage tag
+- [ ] Approve tests if applicable

.github/PULL_REQUEST_TEMPLATE

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x]
+        node-version: [12.x, 14.x, 16.x]
         os: [ubuntu-latest, macOS-latest, windows-latest]
 
     steps:

.github/PULL_REQUEST_TEMPLATE.md

@@ -58,9 +58,11 @@ This will install `http-server` globally so that it may be run from the command
 |`-U` or `--utc` |Use UTC time format in log messages.| |
 |`--log-ip` |Enable logging of the client's IP address |`false` |
 |`-P` or `--proxy` |Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | |
+|`--proxy-options` Pass proxy [options](https://github.com/http-party/node-http-proxy#options) using nested dotted objects. e.g.: --proxy-options.secure false
+
 |`--username` |Username for basic authentication | |
 |`--password` |Password for basic authentication | |
-|`-S` or `--ssl` |Enable https.| |
+|`-S`, `--tls` or `--ssl` |Enable secure request serving with TLS/SSL (HTTPS)|`false`|
 |`-C` or `--cert` |Path to ssl cert file |`cert.pem` | 
 |`-K` or `--key` |Path to ssl key file |`key.pem` |
 |`--qr-code` |Show QR code for public IP | |,

.github/workflows/node.js.yml

@@ -2,14 +2,17 @@
 
 'use strict';
 
-var colors = require('colors/safe'),
-  os = require('os'),
-  httpServer = require('../lib/http-server'),
-  portfinder = require('portfinder'),
-  opener = require('opener'),
-  fs = require('fs'),
-  argv = require('minimist')(process.argv.slice(2)),
-  qrcode = require('qrcode-terminal');
+var colors     = require('colors/safe'),
+    os         = require('os'),
+    httpServer = require('../lib/http-server'),
+    portfinder = require('portfinder'),
+    opener     = require('opener'),
+    fs         = require('fs');
+var argv = require('minimist')(process.argv.slice(2), {
+  alias: {
+    tls: 'ssl'
+  }
+});
 var ifaces = os.networkInterfaces();
 var plainIp;
 
@@ -40,7 +43,8 @@ if (argv.h || argv.help) {
     '  -U --utc     Use UTC time format in log messages.',
     '  --log-ip     Enable logging of the client\'s IP address',
     '',
-    '  -P --proxy         Fallback proxy if the request cannot be resolved. e.g.: http://someurl.com',
+    '  -P --proxy       Fallback proxy if the request cannot be resolved. e.g.: http://someurl.com',
+    '  --proxy-options  Pass options to proxy using nested dotted objects. e.g.: --proxy-options.secure false',
     '',
     '  --username   Username for basic authentication [none]',
     '               Can also be specified with the env variable NODE_HTTP_SERVER_USERNAME',
@@ -62,12 +66,26 @@ if (argv.h || argv.help) {
 }
 
 var port = argv.p || argv.port || parseInt(process.env.PORT, 10),
-  host = argv.a || '0.0.0.0',
-  ssl = argv.S || argv.ssl,
-  proxy = argv.P || argv.proxy,
-  utc = argv.U || argv.utc,
-  version = argv.v || argv.version,
-  logger;
+    host = argv.a || '0.0.0.0',
+    tls = argv.S || argv.tls,
+    proxy = argv.P || argv.proxy,
+    proxyOptions = argv['proxy-options'],
+    utc = argv.U || argv.utc,
+    version = argv.v || argv.version,
+    logger;
+
+var proxyOptionsBooleanProps = [
+  'ws', 'xfwd', 'secure', 'toProxy', 'prependPath', 'ignorePath', 'changeOrigin',
+  'preserveHeaderKeyCase', 'followRedirects', 'selfHandleResponse'
+];
+
+if (proxyOptions) {
+  Object.keys(proxyOptions).forEach(function (key) {
+    if (proxyOptionsBooleanProps.indexOf(key) > -1) {
+      proxyOptions[key] = proxyOptions[key].toLowerCase() === 'true';
+    }
+  });
+}
 
 if (!argv.s && !argv.silent) {
   logger = {
@@ -130,6 +148,7 @@ function listen(port) {
     ext: argv.e || argv.ext,
     logFn: logger.request,
     proxy: proxy,
+    proxyOptions: proxyOptions,
     showDotfiles: argv.dotfiles,
     mimetypes: argv.mimetypes,
     username: argv.username || process.env.NODE_HTTP_SERVER_USERNAME,
@@ -144,7 +163,7 @@ function listen(port) {
     }
   }
 
-  if (ssl) {
+  if (tls) {
     options.https = {
       cert: argv.C || argv.cert || 'cert.pem',
       key: argv.K || argv.key || 'key.pem'
@@ -167,24 +186,26 @@ function listen(port) {
 
   var server = httpServer.createServer(options);
   server.listen(port, host, function () {
-    var protocol = ssl ? 'https://' : 'http://';
+    var protocol = tls ? 'https://' : 'http://';
 
-    logger.info([colors.yellow('Starting up http-server, serving '),
-    colors.cyan(server.root),
-    ssl ? (colors.yellow(' through') + colors.cyan(' https')) : ''
+    logger.info([
+      colors.yellow('Starting up http-server, serving '),
+      colors.cyan(server.root),
+      tls ? (colors.yellow(' through') + colors.cyan(' https')) : ''
     ].join(''));
 
     logger.info([colors.yellow('\nhttp-server version: '), colors.cyan(require('../package.json').version)].join(''));
 
-    logger.info([colors.yellow('\nhttp-server settings: '),
-    ([colors.yellow('CORS: '), argv.cors ? colors.cyan(argv.cors) : colors.red('disabled')].join('')),
-    ([colors.yellow('Cache: '), argv.c ? (argv.c === '-1' ? colors.red('disabled') : colors.cyan(argv.c + ' seconds')) : colors.cyan('3600 seconds')].join('')),
-    ([colors.yellow('Connection Timeout: '), argv.t === '0' ? colors.red('disabled') : (argv.t ? colors.cyan(argv.t + ' seconds') : colors.cyan('120 seconds'))].join('')),
-    ([colors.yellow('Directory Listings: '), argv.d ? colors.red('not visible') : colors.cyan('visible')].join('')),
-    ([colors.yellow('AutoIndex: '), argv.i ? colors.red('not visible') : colors.cyan('visible')].join('')),
-    ([colors.yellow('Serve GZIP Files: '), argv.g || argv.gzip ? colors.cyan('true') : colors.red('false')].join('')),
-    ([colors.yellow('Serve Brotli Files: '), argv.b || argv.brotli ? colors.cyan('true') : colors.red('false')].join('')),
-    ([colors.yellow('Default File Extension: '), argv.e ? colors.cyan(argv.e) : (argv.ext ? colors.cyan(argv.ext) : colors.red('none'))].join(''))
+    logger.info([
+      colors.yellow('\nhttp-server settings: '),
+      ([colors.yellow('CORS: '), argv.cors ? colors.cyan(argv.cors) : colors.red('disabled')].join('')),
+      ([colors.yellow('Cache: '), argv.c ? (argv.c === '-1' ? colors.red('disabled') : colors.cyan(argv.c + ' seconds')) : colors.cyan('3600 seconds')].join('')),
+      ([colors.yellow('Connection Timeout: '), argv.t === '0' ? colors.red('disabled') : (argv.t ? colors.cyan(argv.t + ' seconds') : colors.cyan('120 seconds'))].join('')),
+      ([colors.yellow('Directory Listings: '), argv.d ? colors.red('not visible') : colors.cyan('visible')].join('')),
+      ([colors.yellow('AutoIndex: '), argv.i ? colors.red('not visible') : colors.cyan('visible')].join('')),
+      ([colors.yellow('Serve GZIP Files: '), argv.g || argv.gzip ? colors.cyan('true') : colors.red('false')].join('')),
+      ([colors.yellow('Serve Brotli Files: '), argv.b || argv.brotli ? colors.cyan('true') : colors.red('false')].join('')),
+      ([colors.yellow('Default File Extension: '), argv.e ? colors.cyan(argv.e) : (argv.ext ? colors.cyan(argv.ext) : colors.red('none'))].join(''))
     ].join('\n'));
 
     logger.info(colors.yellow('\nAvailable on:'));
@@ -203,7 +224,12 @@ function listen(port) {
     }
 
     if (typeof proxy === 'string') {
-      logger.info('Unhandled requests will be served from: ' + proxy);
+      if (proxyOptions) {
+        logger.info('Unhandled requests will be served from: ' + proxy + '. Options: ' + JSON.stringify(proxyOptions));
+      }
+      else {
+        logger.info('Unhandled requests will be served from: ' + proxy);
+      }
     }
     if (options.showQR) {
       qrcode.generate(plainIp, { small: true }, function (qr) {

README.md

@@ -85,6 +85,10 @@ Enable logging of the client IP address.
 .BI \-P ", " \-\-proxy
 Fallback proxy if the request cannot be resolved.
 
+.TP
+.BI \-\-proxy\-options
+Pass proxy options using nested dotted objects.
+
 .TP
 .BI \-\-username " " \fIUSERNAME\fR
 Username for basic authentication.
@@ -98,7 +102,7 @@ Can also be specified with the environment variable NODE_HTTP_SERVER_PASSWORD.
 Defaults to none.
 
 .TP
-.BI \-S ", " \-\-ssl
+.BI \-S ", " \-\-tls ", " \-\-ssl
 Enable https.
 
 .TP

bin/http-server

@@ -55,7 +55,7 @@ function shouldCompressBrotli(req) {
 
 function hasGzipId12(gzipped, cb) {
   const stream = fs.createReadStream(gzipped, { start: 0, end: 1 });
-  let buffer = Buffer('');
+  let buffer = Buffer.from('');
   let hasBeenCalled = false;
 
   stream.on('data', (chunk) => {
@@ -318,6 +318,9 @@ module.exports = function createMiddleware(_dir, _options) {
       stream.on('error', (err) => {
         status['500'](res, next, { error: err });
       });
+      stream.on('close', () => {
+        stream.destroy();
+      })
     }