koa-serve-index
Version:
Serve directory listings for koa
405 lines (335 loc) • 13.6 kB
JavaScript
/*!
* serve-index
* Copyright(c) 2011 Sencha Inc.
* Copyright(c) 2011 TJ Holowaychuk
* Copyright(c) 2014 Douglas Christopher Wilson yiminghe@gmail.com
* MIT Licensed
*/
// TODO: arrow key navigation
// TODO: make icons extensible
/**
* Module dependencies.
*/
var accepts = require('accepts');
var debug = require('debug')('koa-serve-index');
var http = require('http')
, fs = require('fs')
, path = require('path')
, normalize = path.normalize
, sep = path.sep
, extname = path.extname
, join = path.join;
var Batch = require('batch');
var parseUrl = require('parseurl');
var resolve = path.resolve;
/*!
* Icon cache.
*/
var cache = {};
/*!
* Default template.
*/
var defaultTemplate = join(__dirname, 'public', 'directory.html');
/*!
* Stylesheet.
*/
var defaultStylesheet = join(__dirname, 'public', 'style.css');
/**
* Media types and the map for content negotiation.
*/
var mediaTypes = [
'text/html',
'text/plain',
'application/json'
];
var mediaType = {
'text/html': 'html',
'text/plain': 'plain',
'application/json': 'json'
};
/**
* Serve directory listings with the given `root` path.
*
* See Readme.md for documentation of options.
*
* @param {String} path
* @param {Object} options
* @return {Function} middleware
* @api public
*/
exports = module.exports = function serveIndex(root, options) {
options = options || {};
// root required
if (!root) throw new TypeError('serveIndex() root path required');
// resolve root to absolute
root = resolve(root);
var hidden = options.hidden
, icons = options.icons
, view = options.view || 'tiles'
, filter = options.filter
, template = options.template || defaultTemplate
, stylesheet = options.stylesheet || defaultStylesheet
, fileSort = options.fileSort || defaultFileSort;
return function *serveIndex(next) {
var method = this.method;
var req = this.request;
var res = this.response;
if (method !== 'GET' && method !== 'HEAD') {
yield *next;
var status = 405;
if (req.method === 'OPTIONS') {
status = 200;
}
this.status = status;
this.set('Allow', 'GET, HEAD, OPTIONS');
return;
}
// parse URLs
var url = parseUrl(req);
var originalUrl = parseUrl.original(req);
var dir = decodeURIComponent(url.pathname)
, path = resolve(root, '.' + dir)
, originalDir = decodeURIComponent(originalUrl.pathname);
var showUp = resolve(path) !== root;
// null byte(s), bad request
if (~path.indexOf('\0')) return createError(this, 400);
// malicious path
if (path.substr(0, root.length) !== root) {
debug('malicious path "%s"', path);
return createError(this, 403);
}
// check if we have a directory
debug('stat "%s"', path);
var stat;
try {
stat = fs.statSync(path);
} catch (err) {
if (err && err.code === 'ENOENT') {
yield *next;
return;
}
err.status = err.code === 'ENAMETOOLONG'
? 414
: 500;
throw err;
}
if (!stat.isDirectory()) {
yield *next;
return;
}
// fetch files
debug('readdir "%s"', path);
var files = fs.readdirSync(path);
if (!hidden) files = removeHidden(files);
if (filter) files = files.filter(function(file, i, files) {
return filter(file, i, files, originalDir);
});
files.sort();
// content-negotiation
var accept = accepts(req);
var type = accept.types(mediaTypes);
// not acceptable
if (!type) return createError(this, 406);
exports[mediaType[type]](req, res, files, next, originalDir, showUp, icons, path, view, template, stylesheet, fileSort);
};
};
/**
* Respond with text/html.
*/
exports.html = function (req, res, files, next, dir, showUp, icons, path, view, template, stylesheet, fileSort) {
var str = fs.readFileSync(template, 'utf8');
var style = fs.readFileSync(stylesheet, 'utf8');
stat(path, files, function (err, stats) {
files = files.map(function (file, i) {
return { name: file, stat: stats[i] };
});
files.sort(fileSort);
if (showUp) files.unshift({ name: '..' });
str = str
.replace('{style}', style.concat(iconStyle(files, icons)))
.replace('{files}', html(files, dir, icons, view))
.replace('{directory}', dir)
.replace('{linked-path}', htmlPath(dir));
var buf = new Buffer(str, 'utf8');
res.set('Content-Type', 'text/html; charset=utf-8');
res.set('Content-Length', buf.length);
res.body = (buf);
});
};
/**
* Respond with application/json.
*/
exports.json = function (req, res, files) {
var body = JSON.stringify(files);
var buf = new Buffer(body, 'utf8');
res.set('Content-Type', 'application/json; charset=utf-8');
res.set('Content-Length', buf.length);
res.body = (buf);
};
/**
* Respond with text/plain.
*/
exports.plain = function (req, res, files) {
var body = files.join('\n') + '\n';
var buf = new Buffer(body, 'utf8');
res.set('Content-Type', 'text/plain; charset=utf-8');
res.set('Content-Length', buf.length);
res.body = (buf);
};
/**
* Generate an `Error` from the given status `code`
* and optional `msg`.
*/
function createError(context, code, msg) {
msg = msg || http.STATUS_CODES[code];
context.throw(code, msg);
}
/**
* Sort function for with directories first.
*/
function defaultFileSort(a, b) {
return Number(b.stat && b.stat.isDirectory()) - Number(a.stat && a.stat.isDirectory()) ||
String(a.name).toLocaleLowerCase().localeCompare(String(b.name).toLocaleLowerCase());
}
/**
* Map html `dir`, returning a linked path.
*/
function htmlPath(dir) {
var curr = [];
return dir.split('/').map(function (part) {
curr.push(encodeURIComponent(part));
return part ? '<a href="' + curr.join('/') + '">' + part + '</a>' : '';
}).join(' / ');
}
/**
* Load icon images, return css string.
*/
function iconStyle(files, useIcons) {
if (!useIcons) return '';
var className;
var i;
var icon;
var list = [];
var rules = {};
var selector;
var selectors = {};
var style = '';
for (i = 0; i < files.length; i++) {
var file = files[i];
var isDir = '..' == file.name || (file.stat && file.stat.isDirectory());
icon = isDir ? icons.folder : icons[extname(file.name)] || icons.default;
var ext = extname(file.name);
className = 'icon-' + (isDir ? 'directory' : (icons[ext] ? ext.substring(1) : 'default'));
selector = '#files .' + className + ' .name';
if (!rules[icon]) {
rules[icon] = 'background-image: url(data:image/png;base64,' + load(icon) + ');'
selectors[icon] = [];
list.push(icon);
}
if (!~selectors[icon].indexOf(selector)) {
selectors[icon].push(selector);
}
}
for (i = 0; i < list.length; i++) {
icon = list[i];
style += selectors[icon].join(',\n') + ' {\n ' + rules[icon] + '\n}\n';
}
return style;
}
/**
* Map html `files`, returning an html unordered list.
*/
function html(files, dir, useIcons, view) {
return '<ul id="files" class="view-' + view + '">'
+ (view == 'details' ? (
'<li class="header">'
+ '<span class="name">Name</span>'
+ '<span class="size">Size</span>'
+ '<span class="date">Modified</span>'
+ '</li>') : '')
+ files.map(function (file) {
var isDir = '..' == file.name || (file.stat && file.stat.isDirectory())
, classes = []
, path = dir.split('/').map(function (c) {
return encodeURIComponent(c);
});
if (useIcons) {
var ext = extname(file.name);
ext = isDir ? '.directory' : (icons[ext] ? ext : '.default');
classes.push('icon');
classes.push('icon-' + ext.substring(1));
}
path.push(encodeURIComponent(file.name));
var date = file.stat && file.name !== '..'
? file.stat.mtime.toDateString() + ' ' + file.stat.mtime.toLocaleTimeString()
: '';
var size = file.stat && !isDir
? file.stat.size
: '';
return '<li><a href="'
+ normalizeSlashes(normalize(path.join('/')))
+ '" class="'
+ classes.join(' ') + '"'
+ ' title="' + file.name + '">'
+ '<span class="name">' + file.name + '</span>'
+ '<span class="size">' + size + '</span>'
+ '<span class="date">' + date + '</span>'
+ '</a></li>';
}).join('\n') + '</ul>';
}
/**
* Load and cache the given `icon`.
*
* @param {String} icon
* @return {String}
* @api private
*/
function load(icon) {
if (cache[icon]) return cache[icon];
return cache[icon] = fs.readFileSync(__dirname + '/public/icons/' + icon, 'base64');
}
/**
* Normalizes the path separator from system separator
* to URL separator, aka `/`.
*
* @param {String} path
* @return {String}
* @api private
*/
function normalizeSlashes(path) {
return path.split(sep).join('/');
};
/**
* Filter "hidden" `files`, aka files
* beginning with a `.`.
*
* @param {Array} files
* @return {Array}
* @api private
*/
function removeHidden(files) {
return files.filter(function (file) {
return '.' != file[0];
});
}
/**
* Stat all files and return array of stat
* in same order.
*/
function stat(dir, files, cb) {
var batch = new Batch();
batch.concurrency(10);
files.forEach(function (file) {
batch.push(function (done) {
var stat = fs.statSync(join(dir, file));
done(null, stat || null);
});
});
batch.end(cb);
}
/**
* Icon map.
*/
var icons = {
'.js': 'page_white_code_red.png', '.json': 'page_white_code.png', '.c': 'page_white_c.png', '.h': 'page_white_h.png', '.cc': 'page_white_cplusplus.png', '.php': 'page_white_php.png', '.rb': 'page_white_ruby.png', '.erb': 'page_white_ruby.png', '.cpp': 'page_white_cplusplus.png', '.as': 'page_white_actionscript.png', '.cfm': 'page_white_coldfusion.png', '.cs': 'page_white_csharp.png', '.java': 'page_white_cup.png', '.jsp': 'page_white_cup.png', '.dll': 'page_white_gear.png', '.ini': 'page_white_gear.png', '.asp': 'page_white_code.png', '.aspx': 'page_white_code.png', '.clj': 'page_white_code.png', '.css': 'page_white_code.png', '.sass': 'page_white_code.png', '.scss': 'page_white_code.png', '.less': 'page_white_code.png', '.htm': 'page_white_code.png', '.html': 'page_white_code.png', '.xhtml': 'page_white_code.png', '.lua': 'page_white_code.png', '.m': 'page_white_code.png', '.pl': 'page_white_code.png', '.py': 'page_white_code.png', '.vb': 'page_white_code.png', '.vbs': 'page_white_code.png', '.xml': 'page_white_code.png', '.yaws': 'page_white_code.png', '.map': 'map.png', '.app': 'application_xp.png', '.exe': 'application_xp.png', '.bat': 'application_xp_terminal.png', '.cgi': 'application_xp_terminal.png', '.sh': 'application_xp_terminal.png', '.avi': 'film.png', '.flv': 'film.png', '.mv4': 'film.png', '.mov': 'film.png', '.mp4': 'film.png', '.mpeg': 'film.png', '.mpg': 'film.png', '.ogv': 'film.png', '.rm': 'film.png', '.webm': 'film.png', '.wmv': 'film.png', '.fnt': 'font.png', '.otf': 'font.png', '.ttf': 'font.png', '.woff': 'font.png', '.bmp': 'image.png', '.gif': 'image.png', '.ico': 'image.png', '.jpeg': 'image.png', '.jpg': 'image.png', '.png': 'image.png', '.psd': 'page_white_picture.png', '.xcf': 'page_white_picture.png', '.pdf': 'page_white_acrobat.png', '.swf': 'page_white_flash.png', '.ai': 'page_white_vector.png', '.eps': 'page_white_vector.png', '.ps': 'page_white_vector.png', '.svg': 'page_white_vector.png', '.ods': 'page_white_excel.png', '.xls': 'page_white_excel.png', '.xlsx': 'page_white_excel.png', '.odp': 'page_white_powerpoint.png', '.ppt': 'page_white_powerpoint.png', '.pptx': 'page_white_powerpoint.png', '.md': 'page_white_text.png', '.srt': 'page_white_text.png', '.txt': 'page_white_text.png', '.doc': 'page_white_word.png', '.docx': 'page_white_word.png', '.odt': 'page_white_word.png', '.rtf': 'page_white_word.png', '.dmg': 'drive.png', '.iso': 'cd.png', '.7z': 'box.png', '.apk': 'box.png', '.bz2': 'box.png', '.cab': 'box.png', '.deb': 'box.png', '.gz': 'box.png', '.jar': 'box.png', '.lz': 'box.png', '.lzma': 'box.png', '.msi': 'box.png', '.pkg': 'box.png', '.rar': 'box.png', '.rpm': 'box.png', '.tar': 'box.png', '.tbz2': 'box.png', '.tgz': 'box.png', '.tlz': 'box.png', '.xz': 'box.png', '.zip': 'box.png', '.accdb': 'page_white_database.png', '.db': 'page_white_database.png', '.dbf': 'page_white_database.png', '.mdb': 'page_white_database.png', '.pdb': 'page_white_database.png', '.sql': 'page_white_database.png', '.gam': 'controller.png', '.rom': 'controller.png', '.sav': 'controller.png', 'folder': 'folder.png', 'default': 'page_white.png'
};