enigma-bbs/core/module_util.js

/* jslint node: true */
'use strict';

var Config		= require('./config.js').config;
var miscUtil	= require('./misc_util.js');

var fs 			= require('fs');
var paths		= require('path');
var _			= require('lodash');
var assert		= require('assert');

//	exports
exports.loadModuleEx			= loadModuleEx;
exports.loadModule				= loadModule;
exports.loadModulesForCategory	= loadModulesForCategory;

function loadModuleEx(options, cb) {
	assert(_.isObject(options));
	assert(_.isString(options.name));
	assert(_.isString(options.path));

	var modConfig = _.isObject(Config[options.category]) ? Config[options.category][options.name] : null;

	if(_.isObject(modConfig) && false === modConfig.enabled) {
		cb(new Error('Module "' + options.name + '" is disabled'));
		return;
	}

	try {
		var mod = require(paths.join(options.path, options.name + '.js'));

		if(!_.isObject(mod.moduleInfo)) {
			cb(new Error('Module is missing "moduleInfo" section'));
			return;
		}

		if(!_.isFunction(mod.getModule)) {
			cb(new Error('Invalid or missing "getModule" method for module!'));
			return;
		}

		//	Safe configuration, if any, for convience to the module
		mod.runtime = { config : modConfig };

		cb(null, mod);
	} catch(e) {
		cb(e);
	}
}

function loadModule(name, category, cb) {
	var path = Config.paths[category];

	if(!_.isString(path)) {
		cb(new Error('Not sure where to look for "' + name + '" of category "' + category + '"'));
		return;
	}

	loadModuleEx( { name : name, path : path, category : category }, function loaded(err, mod) {
		cb(err, mod);
	});
}

function loadModulesForCategory(category, cb) {
	var path = Config.paths[category];

	fs.readdir(path, function onFiles(err, files) {
		if(err) {
			cb(err);
			return;
		}

		var filtered = files.filter(function onFilter(file) { return '.js' === paths.extname(file); });
		filtered.forEach(function onFile(file) {
			var modName = paths.basename(file, '.js');
			loadModule(paths.basename(file, '.js'), category, cb);
		});
	});
}