Feat/--dir-overrides-404 flag (#894)

* feat: add 'dir-overrides-404' flag

* tests: add tests

* docs: update documentation

---------

Co-authored-by: Eric Dubé <[email protected]>

Author: JorensM

README.md

@@ -64,6 +64,7 @@ with the provided Dockerfile.
 |`-a`   |Address to use |0.0.0.0|
 |`--base-dir` | Base path to serve files from | `/` |
 |`-d`     |Show directory listings |`true` |
+|`-dir-overrides-404` | Whether `-d` should override magic `404.html` | `false`
 |`-i`   | Display autoIndex | `true` |
 |`-g` or `--gzip` |When enabled it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first.|`false`|
 |`-b` or `--brotli`|When enabled it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. |`false`|

bin/http-server

@@ -30,6 +30,7 @@ if (argv.h || argv.help) {
     '  -p --port    Port to use. If 0, look for open port. [8080]',
     '  -a           Address to use [0.0.0.0] or [::]',
     '  -d           Show directory listings [true]',
+    '  --dir-overrides-404   Whether -d should override magic 404.html [false]',
     '  --base-dir   Base directory to serve files from [/]',
     '  -i           Display autoIndex [true]',
     '  -g --gzip    Serve gzip files when possible [false]',
@@ -163,6 +164,7 @@ function listen(port) {
     cache: argv.c,
     timeout: argv.t,
     showDir: argv.d,
+    dirOverrides404: argv['dir-overrides-404'],
     baseDir: baseDir,
     autoIndex: argv.i,
     gzip: argv.g || argv.gzip,

doc/http-server.1

@@ -33,6 +33,11 @@ Default is 0.0.0.0.
 Show directory listings.
 Default is true.
 
+.TP
+.BI \-d
+Whether -d should override magic 404.html
+Default is false.
+
 .TP
 .BI \-i
 Display autoIndex.

lib/core/aliases.json

@@ -1,6 +1,13 @@
 {
   "autoIndex": [ "autoIndex", "autoindex" ],
   "showDir": [ "showDir", "showdir" ],
+  "dirOverrides404": [
+    "dirOverrides404", 
+    "diroverrides404", 
+    "dir-overrides-404",
+    "listingsOverride404",
+    "listings-override-404"
+  ],
   "showDotfiles": ["showDotfiles", "showdotfiles"],
   "humanReadable": [ "humanReadable", "humanreadable", "human-readable" ],
   "hidePermissions": ["hidePermissions", "hidepermissions", "hide-permissions"],

lib/core/defaults.json

@@ -1,6 +1,7 @@
 {
   "autoIndex": true,
   "showDir": true,
+  "dirOverrides404": false,
   "showDotfiles": true,
   "humanReadable": true,
   "hidePermissions": false,

lib/core/index.js

@@ -364,6 +364,11 @@ module.exports = function createMiddleware(_dir, _options) {
                 url: `${parsed.pathname}.${defaultExt}${(parsed.search) ? parsed.search : ''}`,
                 headers: req.headers,
               }, res, next);
+            } else if (opts.showDir && opts.dirOverrides404) {
+              // If showDir and dirOverrides404 are true, show the directory instead of 404.html
+              req.url = path.dirname(req.url);
+              showDir(opts, stat)(req, res);
+              return;
             } else {
               // Try to serve default ./404.html
               const rawUrl = (handleError ? `/${path.join(baseDir, `404.${defaultExt}`)}` : req.url);
@@ -411,7 +416,6 @@ module.exports = function createMiddleware(_dir, _options) {
                   showDir(opts, stat)(req, res);
                   return;
                 }
-
                 status[403](res, next);
               });
               return;

lib/core/opts.js

@@ -8,6 +8,7 @@ const aliases = require('./aliases.json');
 module.exports = (opts) => {
   let autoIndex = defaults.autoIndex;
   let showDir = defaults.showDir;
+  let dirOverrides404 = defaults.dirOverrides404;
   let showDotfiles = defaults.showDotfiles;
   let humanReadable = defaults.humanReadable;
   let hidePermissions = defaults.hidePermissions;
@@ -70,6 +71,14 @@ module.exports = (opts) => {
       return false;
     });
 
+    aliases.dirOverrides404.some((k) => {
+      if (isDeclared(k)) {
+        dirOverrides404 = opts[k];
+        return true;
+      }
+      return false;
+    });
+
     aliases.showDotfiles.some((k) => {
       if (isDeclared(k)) {
         showDotfiles = opts[k];
@@ -202,6 +211,7 @@ module.exports = (opts) => {
     cache,
     autoIndex,
     showDir,
+    dirOverrides404,
     showDotfiles,
     humanReadable,
     hidePermissions,

lib/http-server.js

@@ -69,6 +69,7 @@ function HttpServer(options) {
         options.cache // in seconds.
   );
   this.showDir = options.showDir !== 'false';
+  this.dirOverrides404 = options.dirOverrides404;
   this.autoIndex = options.autoIndex !== 'false';
   this.showDotfiles = options.showDotfiles;
   this.gzip = options.gzip === true;
@@ -153,6 +154,7 @@ function HttpServer(options) {
       showDotfiles: this.showDotfiles,
       autoIndex: this.autoIndex,
       defaultExt: this.ext,
+      dirOverrides404: this.dirOverrides404,
       gzip: this.gzip,
       brotli: this.brotli,
       forceContentEncoding: this.forceContentEncoding,

package.json

@@ -82,6 +82,10 @@
     {
       "name": "Jade Michael Thornton",
       "email": "[email protected]"
+    },
+    {
+      "name": "Jorens Merenjanu",
+      "email": "[email protected]"
     }
   ],
   "dependencies": {

test/dir-overrides-404.test.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const test = require('tap').test;
+const http = require('http');
+const ecstatic = require('../lib/core');
+const request = require('request');
+const showDir = require('../lib/core/show-dir');
+
+const root = `${__dirname}/public/dir-overrides-404`;
+
+test('server should display directory if -d and --dir-overrides--404 flags are specified', (t) => {
+    // require('portfinder').getPort((err, port) => {
+    try {
+        const server = http.createServer(ecstatic({root, showDir: true, dirOverrides404: true}));
+        // t.plan(2);
+        // t.on('end', () => { server.close(); });
+        server.listen(0, () => {
+            const port = server.address().port;
+            request.get(`http://localhost:${port}/directory/`, (err, res, body) => {
+                if(err) {
+                    t.error(err);
+                }
+                // console.log(body);
+                // console.log(res.statusCode);
+                t.equal(res.statusCode, 200);
+                console.log(body);
+                t.equal(body.includes('Index of /directory/'), true);
+                server.close(() => { t.end(); });
+            });
+        })
+        console.log('d');
+        
+    } catch (e) {
+        t.fail(e.message);
+        t.end();
+    }
+    // });
+});
+
+test('server should display 404.html if -d flag is specified but not --dir-overrides-404', (t) => {
+    try {
+        const server = http.createServer(ecstatic({root, showDir: true, dirOverrides404: false}));
+        // t.plan(2);
+        // t.on('end', () => { server.close(); });
+        server.listen(0, () => {
+            const port = server.address().port;
+            request.get(`http://localhost:${port}/directory/`, (err, res, body) => {
+                if(err) {
+                    t.error(err);
+                }
+                t.equal(res.statusCode, 404);
+                t.equal(body.includes('404file'), true);
+                server.close(() => { t.end(); });
+            });
+        })
+        console.log('d');
+        
+    } catch (e) {
+        t.fail(e.message);
+        t.end();
+    }
+    
+});