Add --ftp option to for directory listing (python http.server style)

Author: Unitech

CHANGELOG.md

@@ -24,6 +24,7 @@
 - Fix [object Object] env vars leaked to fork mode subprocesses #6073
 - Rewrite TreeKill: single ps call + in-memory tree build, eliminates race conditions #6084
 - Fix Windows home path: use os.homedir() instead of HOMEPATH/HOMEDRIVE env vars #6106
+- Add --ftp option to `pm2 serve` for directory listing (python http.server style)
 
 ## 6.0.14
 

lib/API.js

@@ -974,6 +974,7 @@ class API {
           PM2_SERVE_HOST: serve.host,
           PM2_SERVE_PATH: serve.path,
           PM2_SERVE_SPA: serve.spa,
+          PM2_SERVE_FTP: serve.ftp,
           PM2_SERVE_DIRECTORY: serve.directory,
           PM2_SERVE_BASIC_AUTH: serve.basic_auth !== undefined,
           PM2_SERVE_BASIC_AUTH_USERNAME: serve.basic_auth ? serve.basic_auth.username : null,

lib/API/Extra.js

@@ -570,6 +570,7 @@ module.exports = function(CLI) {
     opts.env.PM2_SERVE_PORT = servePort;
     opts.env.PM2_SERVE_PATH = servePath;
     opts.env.PM2_SERVE_SPA = opts.spa;
+    opts.env.PM2_SERVE_FTP = opts.ftp || false;
     if (opts.basicAuthUsername && opts.basicAuthPassword) {
       opts.env.PM2_SERVE_BASIC_AUTH = 'true';
       opts.env.PM2_SERVE_BASIC_AUTH_USERNAME = opts.basicAuthUsername;

lib/API/Serve.js

@@ -198,6 +198,7 @@ var options = {
   host: process.env.PM2_SERVE_HOST || process.argv[4] || '0.0.0.0',
   path: path.resolve(process.env.PM2_SERVE_PATH || process.argv[2] || '.'),
   spa: process.env.PM2_SERVE_SPA === 'true',
+  ftp: process.env.PM2_SERVE_FTP === 'true',
   homepage: process.env.PM2_SERVE_HOMEPAGE || '/index.html',
   basic_auth: process.env.PM2_SERVE_BASIC_AUTH === 'true' ? {
     username: process.env.PM2_SERVE_BASIC_AUTH_USERNAME,
@@ -249,10 +250,6 @@ http.createServer(function (request, response) {
 function serveFile(uri, request, response) {
   var file = decodeURIComponent(new URL(uri || request.url, 'http://localhost').pathname);
 
-  if (file === '/' || file === '') {
-    file = options.homepage;
-    request.wantHomepage = true;
-  }
   var filePath = path.resolve(options.path + file);
 
   // since we call filesystem directly so we need to verify that the
@@ -262,6 +259,136 @@ function serveFile(uri, request, response) {
     return response.end('403 Forbidden');
   }
 
+  fs.stat(filePath, function (err, stats) {
+    if (!err && stats.isDirectory()) {
+      if (options.ftp) {
+        // In ftp mode, try index.html first, fall back to directory listing
+        var indexPath = path.join(filePath, 'index.html');
+        fs.access(indexPath, fs.constants.R_OK, function (err) {
+          if (!err) {
+            return serveStaticFile(indexPath, file + '/index.html', request, response);
+          }
+          return serveDirectoryListing(filePath, file, response);
+        });
+        return;
+      }
+      // Not ftp mode: serve homepage
+      if (file === '/' || file === '') {
+        file = options.homepage;
+        request.wantHomepage = true;
+        filePath = path.resolve(options.path + file);
+      }
+    } else if (file === '/' || file === '') {
+      file = options.homepage;
+      request.wantHomepage = true;
+      filePath = path.resolve(options.path + file);
+    }
+    serveStaticFile(filePath, file, request, response);
+  });
+}
+
+function formatFileSize(bytes) {
+  if (bytes < 1024) return bytes + 'B';
+  if (bytes < 1024 * 1024) return (bytes / 1024).toFixed(1) + 'K';
+  if (bytes < 1024 * 1024 * 1024) return (bytes / (1024 * 1024)).toFixed(1) + 'M';
+  return (bytes / (1024 * 1024 * 1024)).toFixed(1) + 'G';
+}
+
+function serveDirectoryListing(dirPath, urlPath, response) {
+  fs.readdir(dirPath, function (err, entries) {
+    if (err) {
+      response.writeHead(500);
+      return response.end('Error reading directory');
+    }
+
+    // Ensure urlPath ends with /
+    if (urlPath && urlPath[urlPath.length - 1] !== '/') urlPath += '/';
+    if (!urlPath) urlPath = '/';
+
+    var pending = entries.length;
+    var items = [];
+
+    if (pending === 0) {
+      return renderDirectoryListing(dirPath, urlPath, items, response);
+    }
+
+    entries.forEach(function (entry) {
+      // Skip dotfiles
+      if (entry[0] === '.') {
+        if (--pending === 0) renderDirectoryListing(dirPath, urlPath, items, response);
+        return;
+      }
+      fs.stat(path.join(dirPath, entry), function (err, stats) {
+        if (!err) {
+          items.push({
+            name: entry,
+            isDir: stats.isDirectory(),
+            size: stats.size,
+            mtime: stats.mtime
+          });
+        }
+        if (--pending === 0) renderDirectoryListing(dirPath, urlPath, items, response);
+      });
+    });
+  });
+}
+
+function renderDirectoryListing(dirPath, urlPath, items, response) {
+  // Directories first, then files, alphabetical within each group
+  items.sort(function (a, b) {
+    if (a.isDir !== b.isDir) return a.isDir ? -1 : 1;
+    return a.name.localeCompare(b.name);
+  });
+
+  var escHtml = function(s) { return s.replace(/&/g,'&amp;').replace(/</g,'&lt;').replace(/>/g,'&gt;').replace(/"/g,'&quot;'); };
+
+  var rows = '';
+
+  // Parent directory link (unless at root)
+  if (urlPath !== '/') {
+    rows += '<tr><td class="name"><a href="../">../</a></td><td class="size">-</td><td class="mtime">-</td></tr>\n';
+  }
+
+  items.forEach(function (item) {
+    var displayName = item.isDir ? item.name + '/' : item.name;
+    var href = encodeURIComponent(item.name) + (item.isDir ? '/' : '');
+    var size = item.isDir ? '-' : formatFileSize(item.size);
+    var mtime = item.mtime.toISOString().replace('T', ' ').slice(0, 19);
+    rows += '<tr>'
+      + '<td class="name"><a href="' + escHtml(href) + '">' + escHtml(displayName) + '</a></td>'
+      + '<td class="size">' + size + '</td>'
+      + '<td class="mtime">' + mtime + '</td>'
+      + '</tr>\n';
+  });
+
+  var html = '<!DOCTYPE html>\n<html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width">'
+    + '<title>Index of ' + escHtml(urlPath) + '</title>'
+    + '<style>'
+    + 'body{font-family:monospace;margin:20px;background:#1e1e1e;color:#ccc}'
+    + 'h1{font-size:1.2em;border-bottom:1px solid #444;padding-bottom:8px}'
+    + 'table{border-collapse:collapse;width:100%}'
+    + 'th,td{text-align:left;padding:4px 12px}'
+    + 'th{border-bottom:2px solid #444;font-size:0.9em;color:#888}'
+    + 'tr:hover{background:#2a2a2a}'
+    + '.size,.mtime{white-space:nowrap}'
+    + '.size{text-align:right}'
+    + 'a{color:#58a6ff;text-decoration:none}'
+    + 'a:hover{text-decoration:underline}'
+    + '</style></head><body>'
+    + '<h1>Index of ' + escHtml(urlPath) + '</h1>'
+    + '<table><thead><tr><th>Name</th><th class="size">Size</th><th>Last Modified</th></tr></thead>'
+    + '<tbody>' + rows + '</tbody></table>'
+    + '</body></html>';
+
+  response.writeHead(200, {
+    'Content-Type': 'text/html',
+    'Access-Control-Allow-Origin': '*',
+    'Access-Control-Allow-Methods': 'GET'
+  });
+  response.end(html, 'utf-8');
+}
+
+function serveStaticFile(filePath, file, request, response) {
   var contentType = contentTypes[filePath.split('.').pop().toLowerCase()] || 'text/plain';
 
   fs.readFile(filePath, function (error, content) {

lib/binaries/CLI.js

@@ -997,6 +997,7 @@ commander.command('serve [path] [port]')
   .alias('expose')
   .option('--port [port]', 'specify port to listen to')
   .option('--spa', 'always serving index.html on inexistant sub path')
+  .option('--ftp', 'directory listing like python http.server')
   .option('--basic-auth-username [username]', 'set basic auth username')
   .option('--basic-auth-password [password]', 'set basic auth password')
   .option('--monitor [frontend-app]', 'frontend app monitoring (auto integrate snippet on html files)')