slashify/index.js

Express/Connect middleware to handle trailing slashes with options

var qs = require('querystring');
var url = require('fast-url-parser');
var join = require('path').join;
var fileExists = require('file-exists');

module.exports = function (options) {
  options = options || {};
  
  var root = options.root || './';
  var indexFile = options.index || 'index.html';
  var leaveOnDirectory = (options.directory === false) ? false : true;
  
  if (options.exists) fileExists = options.exists;
  
  return function (req, res, next) {
    var pathname = url.parse(req.url).pathname;
    
    // Don't remove tailing slash on directory index file
    if (leaveOnDirectory && isDirectoryIndex() && !hasTrailingSlash()) {
      return redirect(join(pathname, '/')); 
    }
    
    if (leaveOnDirectory && isDirectoryIndex()) {
      return next();
    }
    
    if (pathname !== '/' && hasTrailingSlash()) {
      return redirect(pathname.substring(0, pathname.length - 1));
    }
    
    // no redirect needed
    next();
    
    function redirect (redirectUrl) {
      var query = qs.stringify(req.query);
      
      redirectUrl += (query) ? '?' + query : '';
      res.writeHead(301, {Location: redirectUrl});
      res.end();
    }
    
    function isDirectoryIndex () {
      return fileExists(join(root, req.url.split('?')[0], indexFile));
    }
    
    function hasTrailingSlash () {
      return pathname.substr(-1) === '/';
    }
  };
};