1. module serve-index
   1. function serve-index (root, options)
   2. function serve-index.html (req, res, files, next, dir, showUp, icons, path, view, template, stylesheet)
   3. function serve-index.json (req, res, files)
   4. function serve-index.plain (req, res, files)

module serve-index

function serve-index (root, options)

• description and source-code

  function serveIndex(root, options) {
    var opts = options || {};
  
    // root required
    if (!root) {
      throw new TypeError('serveIndex() root path required');
    }
  
    // resolve root to absolute and normalize
    var rootPath = normalize(resolve(root) + sep);
  
    var filter = opts.filter;
    var hidden = opts.hidden;
    var icons = opts.icons;
    var stylesheet = opts.stylesheet || defaultStylesheet;
    var template = opts.template || defaultTemplate;
    var view = opts.view || 'tiles';
  
    return function (req, res, next) {
      if (req.method !== 'GET' && req.method !== 'HEAD') {
        res.statusCode = 'OPTIONS' === req.method ? 200 : 405;
        res.setHeader('Allow', 'GET, HEAD, OPTIONS');
        res.setHeader('Content-Length', '0');
        res.end();
        return;
      }
  
      // parse URLs
      var url = parseUrl(req);
      var originalUrl = parseUrl.original(req);
      var dir = decodeURIComponent(url.pathname);
      var originalDir = decodeURIComponent(originalUrl.pathname);
  
      // join / normalize from root dir
      var path = normalize(join(rootPath, dir));
  
      // null byte(s), bad request
      if (~path.indexOf('\0')) return next(createError(400));
  
      // malicious path
      if ((path + sep).substr(0, rootPath.length) !== rootPath) {
        debug('malicious path "%s"', path);
        return next(createError(403));
      }
  
      // determine ".." display
      var showUp = normalize(resolve(path) + sep) !== rootPath;
  
      // check if we have a directory
      debug('stat "%s"', path);
      fs.stat(path, function(err, stat){
        if (err && err.code === 'ENOENT') {
          return next();
        }
  
        if (err) {
          err.status = err.code === 'ENAMETOOLONG'
            ? 414
            : 500;
          return next(err);
        }
  
        if (!stat.isDirectory()) return next();
  
        // fetch files
        debug('readdir "%s"', path);
        fs.readdir(path, function(err, files){
          if (err) return next(err);
          if (!hidden) files = removeHidden(files);
          if (filter) files = files.filter(function(filename, index, list) {
            return filter(filename, index, list, path);
          });
          files.sort();
  
          // content-negotiation
          var accept = accepts(req);
          var type = accept.type(mediaTypes);
  
          // not acceptable
          if (!type) return next(createError(406));
          serveIndex[mediaType[type]](req, res, files, next, originalDir, showUp, icons, path, view, template, stylesheet);
        });
      });
    };
  }

• example usage

  n/a

function serve-index.html (req, res, files, next, dir, showUp, icons, path, view, template, stylesheet)

• description and source-code

  function _html(req, res, files, next, dir, showUp, icons, path, view, template, stylesheet) {
    var render = typeof template !== 'function'
      ? createHtmlRender(template)
      : template
  
    if (showUp) {
      files.unshift('..');
    }
  
    // stat all files
    stat(path, files, function (err, stats) {
      if (err) return next(err);
  
      // combine the stats into the file list
      var fileList = files.map(function (file, i) {
        return { name: file, stat: stats[i] };
      });
  
      // sort file list
      fileList.sort(fileSort);
  
      // read stylesheet
      fs.readFile(stylesheet, 'utf8', function (err, style) {
        if (err) return next(err);
  
        // create locals for rendering
        var locals = {
          directory: dir,
          displayIcons: Boolean(icons),
          fileList: fileList,
          path: path,
          style: style,
          viewName: view
        };
  
        // render html
        render(locals, function (err, body) {
          if (err) return next(err);
  
          var buf = new Buffer(body, 'utf8');
          res.setHeader('Content-Type', 'text/html; charset=utf-8');
          res.setHeader('Content-Length', buf.length);
          res.end(buf);
        });
      });
    });
  }

• example usage

  n/a

function serve-index.json (req, res, files)

• description and source-code

  function _json(req, res, files) {
    var body = JSON.stringify(files);
    var buf = new Buffer(body, 'utf8');
  
    res.setHeader('Content-Type', 'application/json; charset=utf-8');
    res.setHeader('Content-Length', buf.length);
    res.end(buf);
  }

• example usage

  n/a

function serve-index.plain (req, res, files)

• description and source-code

  function _plain(req, res, files) {
    var body = files.join('\n') + '\n';
    var buf = new Buffer(body, 'utf8');
  
    res.setHeader('Content-Type', 'text/plain; charset=utf-8');
    res.setHeader('Content-Length', buf.length);
    res.end(buf);
  }

• example usage

  n/a