loc/lib/strategy/path.js

lightweight simple translation module with dynamic json storage

/**
 * Stragety =  path
 * example: `http://localhost:3000/de-CH/rest/of/the/path` or `http://suuper.com/en/path-to-the-end`
 * in this case the locale would be `de-CH` or `en`
 */
exports.name = 'path';

var utils = require('../utils');
var pattern = exports.pattern = new RegExp('^\\/' + utils.languagePattern + '\\/');

/**
 * gets the locale from the given strategy
 *
 * @param {Object} req    connect / express request object
 * @return {String|false}     Locale if the locale was found with the given strategy, otherwise false.
 */
exports.getLocaleFrom = function(req) {
	if (!req || !req.path) return false;

	// simplified and more general (bigger) pattern than the following spec:
	// http://www.ietf.org/rfc/rfc1766.txt  				(obsolete)
	// http://www.rfc-editor.org/rfc/rfc4647.txt 		(fallback Page 11)
	// http://www.rfc-editor.org/rfc/rfc5646.txt 		(blabla)
	// http://www.rfc-editor.org/rfc/bcp/bcp47.txt 	(case insensitive Page 5; definition: Page 3-5)
	// regex: /^\/([a-zA-Z]{1,3}(?:-(?:[a-zA-Z0-9]{2,8}))*)\//
	if (pattern.test(req.path)) {
		var locale = RegExp.$1;
		return locale;
	}
	return false;
}

/**
 * Stores the locale to the given strategy.
 * Note: not all strategies have to implement this. Most likely this is suitable for cookie or session strategy.
 *
 * @param {Object} req    connect / express request object
 * @param {String} locale the locale like `en` or `de-CH`
 * @return {Boolean}        true if stored sucessfully, otherwise false
 */
exports.storeLocaleTo = function(req, res, locale) {
	console.error('i18n path strategy. function storeLocaleTo not implemented');
}