slugify-url/index.js

Maps urls to simplified strings usable as filenames

"use strict";

module.exports = slugify_url;

var defaultOptions = {
	slashChar: '!',
	maxLength: 100,
	unixOnly: false,  /* if true do not care for windows compatibility.. any non / char is ok */
	skipProtocol: true,
	skipUserPass: true
};

function getOptions(_options) {
	if (typeof(_options) !== 'object') {
		return defaultOptions;
	}

	var options = {};
	for (var _key in defaultOptions) {
		if (typeof(_options[_key]) !== 'undefined') {
			options[_key] = _options[_key];
		} else {
			options[_key] = defaultOptions[_key];
		}
	}
	return options;
}

function slugify_url(url, _options) {
	/* Must be a string representation of an URL */
	if (typeof(url) !== 'string') {
		return null;
	}

	var sanitized = url;
	var options = getOptions(_options);
	
	/* skip protocol part */
	if (options.skipProtocol) {
		sanitized = sanitized.replace(/^[\w]+:\/\//, '');
	}
	
	/* skip user/pass part */
	if (options.skipUserPass) {
		sanitized = sanitized.replace(/[\w\-_\.]+(:[^@]+)?@/, '');
	}
	
	/* replace slashes with slashChar */
	sanitized = sanitized.replace(/\//g, options.slashChar);
	
	/* replace windows invalid chars with slashChar */
	/* based on http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29  */
	if (!options.unixOnly) {
		sanitized = sanitized.replace(/[<>:"/\\|?*]/g, options.slashChar);
	}

	/* replace multiple occurences of the slashChar with just one */
	if (options.slashChar.length > 0) {
		sanitized = sanitized.replace(new RegExp('['+options.slashChar+']{2,}','g'),options.slashChar);
	}

	/* make sure we don't leave any slashChar in the end*/
	if (options.slashChar.length > 0) {
		sanitized = sanitized.replace(new RegExp('['+options.slashChar+']$'),'');
	}
	
	/* truncate to max length */
	sanitized = sanitized.substr(0, options.maxLength);

	return sanitized;
}