Mimetype

ChangeLog.md

@@ -1,3 +1,12 @@
+2015/05/13 Version 0.8.2
+- Updated dev depedencies and fixed all failing tests
+
+2015/05/12 Version 0.8.1
+- Fixed an issue where .types file is in another directory that the root directory
+
+2015/05/11 Version 0.8.0
+- Add ability to define custom mime-types, inline or with Apache .types file
+
 2015/05/09 Version 0.7.6
 - Fix double encoding in directory listings
 

README.md

@@ -1,4 +1,4 @@
-# Ecstatic [![build status](https://secure.travis-ci.org/jfhbrook/node-ecstatic.png)](http://travis-ci.org/jfhbrook/node-ecstatic)
+# Ecstatic [![build status](https://secure.travis-ci.org/jfhbrook/node-ecstatic.png)](http://travis-ci.org/jfhbrook/node-ecstatic) [![dependencies status](https://david-dm.org/jfhbrook/node-ecstatic.svg)](https://david-dm.org/jfhbrook/node-ecstatic)
 
 ![](http://imgur.com/vhub5.png)
 
@@ -72,7 +72,9 @@ var opts = {
              si            : false,
              defaultExt    : 'html',
              gzip          : false,
-             serverHeader  : true
+             serverHeader  : true,
+             contentType   : 'application/octet-stream',
+             mimeTypes     : undefined
            }
 ```
 
@@ -139,6 +141,13 @@ on all responses served by ecstatic.
 Set `opts.contentType` in order to change default Content-Type header value.
 Defaults to **application/octet-stream**.
 
+### `opts.mimeTypes`
+
+Add new or override one or more mime-types. This affects the HTTP Content-Type header.
+Can either be a path to a [`.types`](http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types) file or an object hash of type(s).
+
+    ecstatic({ mimeType: { 'mime-type': ['file_extension', 'file_extension'] } })
+
 ### `opts.handleError`
 
 Turn **off** handleErrors to allow fall-through with `opts.handleError === false`, Defaults to **true**.

lib/ecstatic.js

@@ -31,6 +31,17 @@ var ecstatic = module.exports = function (dir, options) {
   opts.root = dir;
   if (defaultExt && /^\./.test(defaultExt)) defaultExt = defaultExt.replace(/^\./, '');
 
+  // Support hashes and .types files in mimeTypes @since 0.8
+  if (opts.mimeTypes) {
+    if (typeof opts.mimeTypes === 'string') {
+      //TODO: should handleError have any effect here?
+      mime.load(opts.mimeTypes); // will throw if path is wrong as intended
+    } else if (typeof opts.mimeTypes === 'object') {
+      mime.define(opts.mimeTypes);
+    }
+  }
+
+
   return function middleware (req, res, next) {
 
     // Strip any null bytes from the url
@@ -188,7 +199,7 @@ var ecstatic = module.exports = function (dir, options) {
           status['500'](res, next, { error: err });
         });
         res.on('close', function () {
-           fstream.destroy(); 
+           fstream.destroy();
         });
         res.writeHead(206, {
           'Content-Range': 'bytes ' + start + '-' + end + '/' + total,

lib/ecstatic/opts.js

@@ -10,15 +10,20 @@ module.exports = function (opts) {
       gzip = false,
       defaultExt = '.html',
       handleError = true,
-      serverHeader = true;
-      contentType = 'application/octet-stream';
+      serverHeader = true,
+      contentType = 'application/octet-stream',
+      mimeTypes;
+
+  function isDeclared(k) {
+    return typeof opts[k] !== 'undefined' && opts[k] !== null;
+  }
 
   if (opts) {
     [
       'autoIndex',
       'autoindex'
     ].some(function (k) {
-      if (typeof opts[k] !== 'undefined' && opts[k] !== null) {
+      if (isDeclared(k)) {
         autoIndex = opts[k];
         return true;
       }
@@ -28,7 +33,7 @@ module.exports = function (opts) {
       'showDir',
       'showdir'
     ].some(function (k) {
-      if (typeof opts[k] !== 'undefined' && opts[k] !== null) {
+      if (isDeclared(k)) {
         showDir = opts[k];
         return true;
       }
@@ -39,7 +44,7 @@ module.exports = function (opts) {
       'humanreadable',
       'human-readable'
     ].some(function (k) {
-      if (typeof opts[k] !== 'undefined' && opts[k] !== null) {
+      if (isDeclared(k)) {
         humanReadable = opts[k];
         return true;
       }
@@ -49,7 +54,7 @@ module.exports = function (opts) {
       'si',
       'index'
     ].some(function (k) {
-      if (typeof opts[k] !== 'undefined' && opts[k] !== null) {
+      if (isDeclared(k)) {
         si = opts[k];
         return true;
       }
@@ -76,32 +81,48 @@ module.exports = function (opts) {
       'handleError',
       'handleerror'
     ].some(function (k) {
-        if (typeof opts[k] !== 'undefined' && opts[k] !== null) {
-            handleError = opts[k];
-            return true;
-        }
+      if (isDeclared(k)) {
+        handleError = opts[k];
+        return true;
+      }
     });
 
     [
       'serverHeader',
       'serverheader',
       'server-header'
     ].some(function (k) {
-        if (typeof opts[k] !== 'undefined' && opts[k] !== null) {
-            serverHeader = opts[k];
-            return true;
-        }
+      if (isDeclared(k)) {
+        serverHeader = opts[k];
+        return true;
+      }
     });
 
     [
       'contentType',
       'contenttype',
       'content-type'
     ].some(function (k) {
-        if (typeof opts[k] !== 'undefined' && opts[k] !== null) {
-            contentType = opts[k];
-            return true;
-        }
+      if (isDeclared(k)) {
+        contentType = opts[k];
+        return true;
+      }
+    });
+
+    [
+      'mimetype',
+      'mimetypes',
+      'mimeType',
+      'mimeTypes',
+      'mime-type',
+      'mime-types',
+      'mime-Type',
+      'mime-Types'
+    ].some(function (k) {
+      if (isDeclared(k)) {
+        mimeTypes = opts[k];
+        return true;
+      }
     });
 
   }
@@ -117,6 +138,7 @@ module.exports = function (opts) {
     gzip: gzip,
     handleError: handleError,
     serverHeader: serverHeader,
-    contentType: contentType
+    contentType: contentType,
+    mimeTypes: mimeTypes
   };
 };

package.json

@@ -2,7 +2,7 @@
   "author": "Joshua Holbrook <josh@nodejitsu.com> (http://jesusabdullah.net)",
   "name": "ecstatic",
   "description": "A simple static file server middleware that works with both Express and Flatiron",
-  "version": "0.7.6",
+  "version": "0.8.2",
   "homepage": "https://github.com/jfhbrook/node-ecstatic",
   "repository": {
     "type": "git",
@@ -28,10 +28,11 @@
     "url-join": "0.0.1"
   },
   "devDependencies": {
-    "tap": "^0.4.13",
+    "eol": "^0.2.0",
+    "express": "^4.12.3",
+    "mkdirp": "^0.5.0",
     "request": "^2.49.0",
-    "express": "^3.0.6",
-    "union": "^0.3.8",
-    "mkdirp": "^0.5.0"
+    "tap": "^1.0.3",
+    "union": "^0.4.4"
   }
 }

test/content-type.js

@@ -1,26 +1,28 @@
 var test = require('tap').test,
-    ecstatic = require('../'),
     http = require('http'),
-    request = require('request');
+    request = require('request'),
+    ecstatic = require('../');
 
 test('default default contentType', function(t) {
-  var server = http.createServer(ecstatic({
-    root: __dirname + '/public/',
-    contentType: 'text/plain'
-  }));
+  try {
+    var server = http.createServer(ecstatic({
+      root: __dirname + '/public/',
+      contentType: 'text/plain'
+    }));
+  } catch (e) {
+    t.fail(e.message);
+    t.end();
+  }
 
   t.plan(3);
 
-  t.on('end', function() { server.close(); });
-
   server.listen(0, function() {
     var port = server.address().port;
     request.get('http://localhost:' + port + '/f_f', function(err, res, body) {
       t.ifError(err);
       t.equal(res.statusCode, 200);
       t.equal(res.headers['content-type'], 'text/plain; charset=UTF-8');
-      t.end();
+      server.close(function() { t.end(); });
     });
   });
 });
-

test/core-error.js

@@ -11,7 +11,7 @@ var root = __dirname + '/public',
 
 mkdirp.sync(root + '/emptyDir');
 
-var cases = require('./common-cases-error');
+var cases = require('./secret/common-cases-error');
 
 test('core', function (t) {
   var filenames = Object.keys(cases);

test/core.js

@@ -4,14 +4,15 @@ var test = require('tap').test,
     request = require('request'),
     mkdirp = require('mkdirp'),
     fs = require('fs'),
-    path = require('path');
+    path = require('path'),
+    eol = require('eol');
 
 var root = __dirname + '/public',
     baseDir = 'base';
 
 mkdirp.sync(root + '/emptyDir');
 
-var cases = require('./common-cases');
+var cases = require('./secret/common-cases');
 
 test('core', function (t) {
   var filenames = Object.keys(cases);
@@ -52,11 +53,11 @@ test('core', function (t) {
         }
 
         if (r.body !== undefined) {
-          t.equal(body, r.body, 'body for `' + file + '`');
+          t.equal(eol.lf(body), r.body, 'body for `' + file + '`');
         }
 
         if (r.location !== undefined) {
-          t.equal(res.headers.location, path.join('/', baseDir, r.location), 'location for `' + file + '`');
+          t.equal(path.normalize(res.headers.location), path.join('/', baseDir, r.location), 'location for `' + file + '`');
         }
 
         if (--pending === 0) {

test/custom-content-type-file-secret.js

@@ -0,0 +1,28 @@
+var test = require('tap').test,
+    http = require('http'),
+    request = require('request'),
+    ecstatic = require('../');
+
+test('custom contentType via .types file', function(t) {
+  try {
+    var server = http.createServer(ecstatic({
+      root: __dirname + '/public/',
+      mimetypes: __dirname + '/secret/custom_mime_type.types'
+    }));
+  } catch (e) {
+    t.fail(e.message);
+    t.end();
+  }
+
+  t.plan(3)
+
+  server.listen(0, function() {
+    var port = server.address().port;
+    request.get('http://localhost:' + port + '/custom_mime_type.opml', function(err, res, body) {
+      t.ifError(err);
+      t.equal(res.statusCode, 200, 'custom_mime_type.opml should be found');
+      t.equal(res.headers['content-type'], 'application/secret; charset=utf-8');
+      server.close(function() { t.end(); });
+    });
+  });
+});

test/custom-content-type-file.js

@@ -0,0 +1,45 @@
+var test = require('tap').test,
+    http = require('http'),
+    request = require('request'),
+    ecstatic = require('../');
+
+function setup(opts) {
+  return http.createServer(ecstatic(opts));
+}
+
+test('throws when custom contentType .types file does not exist', function(t) {
+  t.plan(1);
+
+  t.throws(
+    setup.bind(null, {
+      root: __dirname + '/public/',
+      mimeTypes: 'this_file_does_not_exist.types'
+    })
+  );
+
+});
+
+test('custom contentType via .types file', function(t) {
+  try {
+    var server = setup({
+      root: __dirname + '/public',
+      'mime-types': __dirname + '/public/custom_mime_type.types'
+    });
+  } catch (e) {
+    t.fail(e.message);
+    t.end();
+  }
+
+  t.plan(3)
+
+  server.listen(0, function() {
+    var port = server.address().port;
+
+    request.get('http://localhost:' + port + '/custom_mime_type.opml', function(err, res, body) {
+      t.ifError(err);
+      t.equal(res.statusCode, 200, 'custom_mime_type.opml should be found');
+      t.equal(res.headers['content-type'], 'application/foo; charset=utf-8');
+      server.close(function() { t.end(); });
+    });
+  });
+});