705 lines
18 KiB
JavaScript
705 lines
18 KiB
JavaScript
/* jslint node: true */
|
|
'use strict';
|
|
|
|
// ENiGMA½
|
|
var MCIViewFactory = require('./mci_view_factory.js').MCIViewFactory;
|
|
var menuUtil = require('./menu_util.js');
|
|
//var Log = require('./logger.js').log;
|
|
var Config = require('./config.js').config;
|
|
var asset = require('./asset.js');
|
|
var ansi = require('./ansi_term.js');
|
|
|
|
var events = require('events');
|
|
var util = require('util');
|
|
var assert = require('assert');
|
|
var async = require('async');
|
|
var _ = require('lodash');
|
|
var paths = require('path');
|
|
|
|
exports.ViewController = ViewController;
|
|
|
|
var MCI_REGEXP = /([A-Z]{2})([0-9]{1,2})/;
|
|
|
|
function ViewController(options) {
|
|
assert(_.isObject(options));
|
|
assert(_.isObject(options.client));
|
|
|
|
|
|
events.EventEmitter.call(this);
|
|
|
|
var self = this;
|
|
|
|
this.client = options.client;
|
|
this.views = {}; // map of ID -> view
|
|
this.formId = options.formId || 0;
|
|
this.mciViewFactory = new MCIViewFactory(this.client); // :TODO: can this not be a singleton?
|
|
this.noInput = _.isBoolean(options.noInput) ? options.noInput : false;
|
|
|
|
this.actionKeyMap = {};
|
|
|
|
this.clientKeyPressHandler = function(ch, key) {
|
|
//
|
|
// Process key presses treating form submit mapped keys special.
|
|
// Everything else is forwarded on to the focused View, if any.
|
|
//
|
|
if(key) {
|
|
var actionForKey = self.actionKeyMap[key.name];
|
|
if(actionForKey) {
|
|
if(_.isNumber(actionForKey)) {
|
|
//
|
|
// Key works on behalf of a view -- switch focus & submit
|
|
//
|
|
self.switchFocus(actionForKey);
|
|
self.submitForm();
|
|
} else if(_.isString(actionForKey)) {
|
|
// :TODO: Populate formData here?
|
|
// :TODO: Populate actionBlock here -- that is, the actionKey entry... or
|
|
// really we just need |extraArgs| to be present, if any
|
|
menuUtil.handleAction(self.client, { }, { action : actionForKey } );
|
|
}
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
if(self.focusedView && self.focusedView.acceptsInput) {
|
|
self.focusedView.onKeyPress(ch, key);
|
|
}
|
|
};
|
|
|
|
this.viewActionListener = function(action) {
|
|
switch(action) {
|
|
case 'next' :
|
|
self.emit('action', { view : this, action : action });
|
|
self.nextFocus();
|
|
break;
|
|
|
|
case 'accept' :
|
|
if(self.focusedView && self.focusedView.submit) {
|
|
self.submitForm();
|
|
} else {
|
|
self.nextFocus();
|
|
}
|
|
break;
|
|
}
|
|
};
|
|
|
|
this.submitForm = function() {
|
|
self.emit('submit', this.getFormData());
|
|
};
|
|
|
|
this.getLogFriendlyFormData = function(formData) {
|
|
// :TODO: these fields should be part of menu.json sensitiveMembers[]
|
|
var safeFormData = _.cloneDeep(formData);
|
|
if(safeFormData.value.password) {
|
|
safeFormData.value.password = '*****';
|
|
}
|
|
if(safeFormData.value.passwordConfirm) {
|
|
safeFormData.value.passwordConfirm = '*****';
|
|
}
|
|
return safeFormData;
|
|
};
|
|
|
|
this.switchFocusEvent = function(event, view) {
|
|
if(self.emitSwitchFocus) {
|
|
return;
|
|
}
|
|
|
|
self.emitSwitchFocus = true;
|
|
self.emit(event, view);
|
|
self.emitSwitchFocus = false;
|
|
};
|
|
|
|
this.createViewsFromMCI = function(mciMap, cb) {
|
|
async.each(Object.keys(mciMap), function entry(name, nextItem) {
|
|
var mci = mciMap[name];
|
|
var view = self.mciViewFactory.createFromMCI(mci);
|
|
|
|
if(view && false === self.noInput) {
|
|
view.on('action', self.viewActionListener);
|
|
|
|
self.addView(view);
|
|
}
|
|
|
|
nextItem(null);
|
|
},
|
|
function complete(err) {
|
|
self.setViewOrder();
|
|
cb(err);
|
|
});
|
|
};
|
|
|
|
// :TODO: move this elsewhere
|
|
this.setViewPropertiesFromMCIConf = function(view, conf) {
|
|
|
|
var propAsset;
|
|
var propValue;
|
|
|
|
function callModuleMethod(path) {
|
|
if('' === paths.extname(path)) {
|
|
path += '.js';
|
|
}
|
|
|
|
try {
|
|
var methodMod = require(path);
|
|
// :TODO: fix formData & extraArgs
|
|
return methodMod[propAsset.asset](self.client.currentMenuModule, {}, {} );
|
|
} catch(e) {
|
|
self.client.log.error( { error : e.toString(), methodName : propAsset.asset }, 'Failed to execute asset method');
|
|
}
|
|
}
|
|
|
|
for(var propName in conf) {
|
|
propAsset = asset.getViewPropertyAsset(conf[propName]);
|
|
if(propAsset) {
|
|
switch(propAsset.type) {
|
|
case 'config' :
|
|
propValue = asset.resolveConfigAsset(conf[propName]);
|
|
break;
|
|
|
|
// :TODO: handle @art (e.g. text : @art ...)
|
|
|
|
case 'method' :
|
|
case 'systemMethod' :
|
|
if(_.isString(propAsset.location)) {
|
|
|
|
} else {
|
|
if('systemMethod' === propAsset.type) {
|
|
// :TODO:
|
|
} else {
|
|
// local to current module
|
|
var currentModule = self.client.currentMenuModule;
|
|
if(_.isFunction(currentModule.menuMethods[propAsset.asset])) {
|
|
// :TODO: Fix formData & extraArgs... this all needs general processing
|
|
propValue = currentModule.menuMethods[propAsset.asset]({}, {});//formData, conf.extraArgs);
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
/*case 'method' :
|
|
case 'systemMethod' :
|
|
if(_.isString(actionAsset.location)) {
|
|
callModuleMenuMethod(paths.join(Config.paths.mods, actionAsset.location));
|
|
} else {
|
|
if('systemMethod' === actionAsset.type) {
|
|
// :TODO: Need to pass optional args here -- conf.extraArgs and args between e.g. ()
|
|
// :TODO: Probably better as system_method.js
|
|
callModuleMenuMethod(paths.join(__dirname, 'system_menu_method.js'));
|
|
} else {
|
|
// local to current module
|
|
var currentModule = client.currentMenuModule;
|
|
if(_.isFunction(currentModule.menuMethods[actionAsset.asset])) {
|
|
currentModule.menuMethods[actionAsset.asset](formData, conf.extraArgs);
|
|
}
|
|
}
|
|
}*/
|
|
break;
|
|
|
|
default :
|
|
propValue = propValue = conf[propName];
|
|
break;
|
|
}
|
|
} else {
|
|
propValue = conf[propName];
|
|
}
|
|
|
|
if(!_.isUndefined(propValue)) {
|
|
view.setPropertyValue(propName, propValue);
|
|
}
|
|
}
|
|
};
|
|
|
|
this.applyViewConfig = function(config, cb) {
|
|
var highestId = 1;
|
|
var submitId;
|
|
var initialFocusId = 1;
|
|
|
|
async.each(Object.keys(config.mci), function entry(mci, nextItem) {
|
|
var mciMatch = mci.match(MCI_REGEXP); // :TODO: How to handle auto-generated IDs????
|
|
|
|
var viewId = parseInt(mciMatch[2]);
|
|
assert(!isNaN(viewId));
|
|
|
|
if(viewId > highestId) {
|
|
highestId = viewId;
|
|
}
|
|
|
|
var view = self.getView(viewId);
|
|
|
|
if(!view) {
|
|
self.client.log.warn( { viewId : viewId }, 'Cannot find view');
|
|
nextItem(null);
|
|
return;
|
|
}
|
|
|
|
var mciConf = config.mci[mci];
|
|
|
|
self.setViewPropertiesFromMCIConf(view, mciConf);
|
|
|
|
if(mciConf.focus) {
|
|
initialFocusId = viewId;
|
|
}
|
|
|
|
nextItem(null);
|
|
},
|
|
function complete(err) {
|
|
// default to highest ID if no 'submit' entry present
|
|
if(!submitId) {
|
|
self.getView(highestId).submit = true;
|
|
}
|
|
|
|
cb(err, { initialFocusId : initialFocusId } );
|
|
});
|
|
};
|
|
|
|
if(!options.detached) {
|
|
this.attachClientEvents();
|
|
}
|
|
}
|
|
|
|
util.inherits(ViewController, events.EventEmitter);
|
|
|
|
ViewController.prototype.attachClientEvents = function() {
|
|
if(this.attached) {
|
|
return;
|
|
}
|
|
|
|
var self = this;
|
|
|
|
this.client.on('key press', this.clientKeyPressHandler);
|
|
|
|
Object.keys(this.views).forEach(function vid(i) {
|
|
// remove, then add to ensure we only have one listener
|
|
self.views[i].removeListener('action', self.viewActionListener);
|
|
self.views[i].on('action', self.viewActionListener);
|
|
});
|
|
|
|
this.attached = true;
|
|
};
|
|
|
|
ViewController.prototype.detachClientEvents = function() {
|
|
if(!this.attached) {
|
|
return;
|
|
}
|
|
|
|
this.client.removeListener('key press', this.clientKeyPressHandler);
|
|
|
|
for(var id in this.views) {
|
|
this.views[id].removeAllListeners();
|
|
}
|
|
|
|
this.attached = false;
|
|
};
|
|
|
|
ViewController.prototype.viewExists = function(id) {
|
|
return id in this.views;
|
|
};
|
|
|
|
ViewController.prototype.addView = function(view) {
|
|
assert(!this.viewExists(view.id), 'View with ID ' + view.id + ' already exists');
|
|
|
|
this.views[view.id] = view;
|
|
};
|
|
|
|
ViewController.prototype.getView = function(id) {
|
|
return this.views[id];
|
|
};
|
|
|
|
ViewController.prototype.getFocusedView = function() {
|
|
return this.focusedView;
|
|
};
|
|
|
|
ViewController.prototype.setFocus = function(focused) {
|
|
if(focused) {
|
|
this.attachClientEvents();
|
|
} else {
|
|
this.detachClientEvents();
|
|
}
|
|
};
|
|
|
|
ViewController.prototype.switchFocus = function(id) {
|
|
this.setFocus(true); // ensure events are attached
|
|
|
|
if(this.focusedView && this.focusedView.acceptsFocus) {
|
|
this.switchFocusEvent('leave', this.focusedView);
|
|
this.focusedView.setFocus(false);
|
|
}
|
|
|
|
var view = this.getView(id);
|
|
if(view && view.acceptsFocus) {
|
|
this.switchFocusEvent('return', view);
|
|
|
|
this.focusedView = view;
|
|
this.focusedView.setFocus(true);
|
|
}
|
|
};
|
|
|
|
ViewController.prototype.nextFocus = function() {
|
|
if(!this.focusedView) {
|
|
this.switchFocus(this.views[this.firstId].id);
|
|
} else {
|
|
var nextId = this.views[this.focusedView.id].nextId;
|
|
this.switchFocus(nextId);
|
|
}
|
|
};
|
|
|
|
ViewController.prototype.setViewOrder = function(order) {
|
|
var viewIdOrder = order || [];
|
|
|
|
if(0 === viewIdOrder.length) {
|
|
for(var id in this.views) {
|
|
if(this.views[id].acceptsFocus) {
|
|
viewIdOrder.push(id);
|
|
}
|
|
}
|
|
|
|
viewIdOrder.sort(function intSort(a, b) {
|
|
return a - b;
|
|
});
|
|
}
|
|
|
|
if(viewIdOrder.length > 0) {
|
|
var view;
|
|
var count = viewIdOrder.length - 1;
|
|
for(var i = 0; i < count; ++i) {
|
|
this.views[viewIdOrder[i]].nextId = viewIdOrder[i + 1];
|
|
}
|
|
|
|
this.firstId = viewIdOrder[0];
|
|
var lastId = viewIdOrder.length > 1 ? viewIdOrder[viewIdOrder.length - 1] : this.firstId;
|
|
this.views[lastId].nextId = this.firstId;
|
|
}
|
|
};
|
|
|
|
ViewController.prototype.redrawAll = function(initialFocusId) {
|
|
this.client.term.rawWrite(ansi.hideCursor());
|
|
|
|
for(var id in this.views) {
|
|
if(initialFocusId === id) {
|
|
continue; // will draw @ focus
|
|
}
|
|
this.views[id].redraw();
|
|
}
|
|
|
|
this.client.term.rawWrite(ansi.showCursor());
|
|
};
|
|
|
|
ViewController.prototype.loadFromPromptConfig = function(options, cb) {
|
|
assert(_.isObject(options));
|
|
assert(_.isObject(options.mciMap));
|
|
|
|
var self = this;
|
|
var promptName = _.isString(options.promptName) ? options.promptName : self.client.currentMenuModule.menuConfig.prompt;
|
|
var promptConfig = _.isObject(options.config) ? options.config : self.client.currentMenuModule.menuConfig.promptConfig;
|
|
var initialFocusId = 1; // default to first
|
|
|
|
async.waterfall(
|
|
[
|
|
function createViewsFromMCI(callback) {
|
|
self.createViewsFromMCI(options.mciMap, function viewsCreated(err) {
|
|
callback(err);
|
|
});
|
|
},
|
|
function applyThemeCustomization(callback) {
|
|
if(_.isObject(promptConfig)) {
|
|
menuUtil.applyThemeCustomization({
|
|
name : promptName,//self.client.currentMenuModule.menuConfig.prompt,
|
|
type : "prompts",
|
|
client : self.client,
|
|
configMci : promptConfig.mci,
|
|
});
|
|
}
|
|
callback(null);
|
|
},
|
|
function applyViewConfiguration(callback) {
|
|
if(_.isObject(promptConfig.mci)) {
|
|
self.applyViewConfig(promptConfig, function configApplied(err, info) {
|
|
initialFocusId = info.initialFocusId;
|
|
callback(err);
|
|
});
|
|
} else {
|
|
callback(null);
|
|
}
|
|
},
|
|
function prepareFormSubmission(callback) {
|
|
if(false === self.noInput) {
|
|
self.on('submit', function promptSubmit(formData) {
|
|
self.client.log.trace( { formData : self.getLogFriendlyFormData(formData) }, 'Prompt submit');
|
|
|
|
menuUtil.handleAction(self.client, formData, self.client.currentMenuModule.menuConfig);
|
|
});
|
|
}
|
|
|
|
callback(null);
|
|
},
|
|
function drawAllViews(callback) {
|
|
self.redrawAll(initialFocusId);
|
|
callback(null);
|
|
},
|
|
function setInitialViewFocus(callback) {
|
|
if(initialFocusId) {
|
|
self.switchFocus(initialFocusId);
|
|
}
|
|
callback(null);
|
|
}
|
|
],
|
|
function complete(err) {
|
|
cb(err);
|
|
}
|
|
);
|
|
};
|
|
|
|
ViewController.prototype.loadFromMenuConfig = function(options, cb) {
|
|
assert(_.isObject(options));
|
|
assert(_.isObject(options.mciMap));
|
|
|
|
var self = this;
|
|
var formIdKey = options.formId ? options.formId.toString() : '0';
|
|
var initialFocusId = 1; // default to first
|
|
var formConfig;
|
|
|
|
// :TODO: honor options.withoutForm
|
|
|
|
// method for comparing submitted form data to configuration entries
|
|
var actionBlockValueComparator = function(formValue, actionValue) {
|
|
//
|
|
// For a match to occur, one of the following must be true:
|
|
//
|
|
// * actionValue is a Object:
|
|
// a) All key/values must exactly match
|
|
// b) value is null; The key (view ID or "argName") must be present
|
|
// in formValue. This is a wildcard/any match.
|
|
// * actionValue is a Number: This represents a view ID that
|
|
// must be present in formValue.
|
|
// * actionValue is a string: This represents a view with
|
|
// "argName" set that must be present in formValue.
|
|
//
|
|
if(_.isNumber(actionValue) || _.isString(actionValue)) {
|
|
if(_.isUndefined(formValue[actionValue])) {
|
|
return false;
|
|
}
|
|
} else {
|
|
var actionValueKeys = Object.keys(actionValue);
|
|
for(var i = 0; i < actionValueKeys.length; ++i) {
|
|
var viewId = actionValueKeys[i];
|
|
if(!_.has(formValue, viewId)) {
|
|
return false;
|
|
}
|
|
|
|
if(null !== actionValue[viewId] && actionValue[viewId] !== formValue[viewId]) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
self.client.log.trace( { formValue : formValue, actionValue : actionValue }, 'Action match');
|
|
return true;
|
|
};
|
|
|
|
async.waterfall(
|
|
[
|
|
function findMatchingFormConfig(callback) {
|
|
menuUtil.getFormConfigByIDAndMap(self.client.currentMenuModule.menuConfig, formIdKey, options.mciMap, function matchingConfig(err, fc) {
|
|
formConfig = fc;
|
|
|
|
if(err) {
|
|
// non-fatal
|
|
self.client.log.trace(
|
|
{ error : err, mci : Object.keys(options.mciMap), formId : formIdKey },
|
|
'Unable to find matching form configuration');
|
|
}
|
|
|
|
callback(null);
|
|
});
|
|
},
|
|
function createViews(callback) {
|
|
self.createViewsFromMCI(options.mciMap, function viewsCreated(err) {
|
|
callback(err);
|
|
});
|
|
},
|
|
function applyThemeCustomization(callback) {
|
|
if(_.isObject(formConfig)) {
|
|
menuUtil.applyThemeCustomization({
|
|
name : self.client.currentMenuModule.menuName,
|
|
type : 'menus',
|
|
client : self.client,
|
|
configMci : formConfig.mci,
|
|
});
|
|
}
|
|
|
|
callback(null);
|
|
},
|
|
function applyViewConfiguration(callback) {
|
|
if(_.isObject(formConfig)) {
|
|
self.applyViewConfig(formConfig, function configApplied(err, info) {
|
|
initialFocusId = info.initialFocusId;
|
|
callback(err);
|
|
});
|
|
} else {
|
|
callback(null);
|
|
}
|
|
},
|
|
function prepareFormSubmission(callback) {
|
|
if(!_.isObject(formConfig) || !_.isObject(formConfig.submit)) {
|
|
callback(null);
|
|
return;
|
|
}
|
|
|
|
self.on('submit', function formSubmit(formData) {
|
|
|
|
self.client.log.trace( { formData : self.getLogFriendlyFormData(formData) }, 'Form submit');
|
|
|
|
//
|
|
// Locate configuration for this form ID
|
|
//
|
|
var confForFormId;
|
|
if(_.isObject(formConfig.submit[formData.submitId])) {
|
|
confForFormId = formConfig.submit[formData.submitId];
|
|
} else if(_.isObject(formConfig.submit['*'])) {
|
|
confForFormId = formConfig.submit['*'];
|
|
} else {
|
|
// no configuration for this submitId
|
|
self.client.log.debug( { formId : formData.submitId }, 'No configuration for form ID');
|
|
return;
|
|
}
|
|
|
|
//
|
|
// Locate a matching action block based on the submitted data
|
|
//
|
|
for(var c = 0; c < confForFormId.length; ++c) {
|
|
var actionBlock = confForFormId[c];
|
|
|
|
if(_.isEqual(formData.value, actionBlock.value, actionBlockValueComparator)) {
|
|
menuUtil.handleAction(self.client, formData, actionBlock);
|
|
break; // there an only be one...
|
|
}
|
|
}
|
|
});
|
|
|
|
callback(null);
|
|
},
|
|
function loadActionKeys(callback) {
|
|
if(!_.isObject(formConfig) || !_.isArray(formConfig.actionKeys)) {
|
|
callback(null);
|
|
return;
|
|
}
|
|
|
|
var actionKeyEntry;
|
|
formConfig.actionKeys.forEach(function akEntry(ak) {
|
|
//
|
|
// * 'keys' must be present and be an array of key names
|
|
// * If 'viewId' is present, key(s) will focus & submit on behalf
|
|
// of the specified view.
|
|
// * If 'action' is present, that action will be procesed when
|
|
// triggered by key(s)
|
|
//
|
|
// Ultimately, we'll create a map of key -> { viewId | action }
|
|
//
|
|
// :TODO: allow for args to be passed along with action as well...
|
|
if(!_.isArray(ak.keys)) {
|
|
return;
|
|
}
|
|
|
|
if(_.isNumber(ak.viewId)) {
|
|
actionKeyEntry = ak.viewId;
|
|
} else if(_.isString(ak.action)) {
|
|
actionKeyEntry = ak.action;
|
|
} else {
|
|
return;
|
|
}
|
|
|
|
ak.keys.forEach(function actionKeyName(kn) {
|
|
self.actionKeyMap[kn] = actionKeyEntry;
|
|
});
|
|
});
|
|
|
|
callback(null);
|
|
},
|
|
function drawAllViews(callback) {
|
|
self.redrawAll(initialFocusId);
|
|
callback(null);
|
|
},
|
|
function setInitialViewFocus(callback) {
|
|
if(initialFocusId) {
|
|
self.switchFocus(initialFocusId);
|
|
}
|
|
callback(null);
|
|
}
|
|
],
|
|
function complete(err) {
|
|
if(_.isFunction(cb)) {
|
|
cb(err);
|
|
}
|
|
}
|
|
);
|
|
};
|
|
|
|
ViewController.prototype.formatMCIString = function(format) {
|
|
var self = this;
|
|
var view;
|
|
|
|
return format.replace(/{(\d+)}/g, function replacer(match, number) {
|
|
view = self.getView(number);
|
|
|
|
if(!view) {
|
|
return match;
|
|
}
|
|
|
|
return view.getData();
|
|
});
|
|
};
|
|
|
|
ViewController.prototype.getFormData = function() {
|
|
/*
|
|
Example form data:
|
|
{
|
|
id : 0,
|
|
submitId : 1,
|
|
value : {
|
|
"1" : "hurp",
|
|
"2" : [ 'a', 'b', ... ],
|
|
"3" 2,
|
|
"pants" : "no way"
|
|
}
|
|
|
|
}
|
|
*/
|
|
var formData = {
|
|
id : this.formId,
|
|
submitId : this.focusedView.id,
|
|
value : {},
|
|
};
|
|
|
|
var viewData;
|
|
var view;
|
|
for(var id in this.views) {
|
|
try {
|
|
view = this.views[id];
|
|
viewData = view.getData();
|
|
if(!_.isUndefined(viewData)) {
|
|
if(_.isString(view.submitArgName)) {
|
|
formData.value[view.submitArgName] = viewData;
|
|
} else {
|
|
formData.value[id] = viewData;
|
|
}
|
|
}
|
|
} catch(e) {
|
|
this.client.log.error(e); // :TODO: Log better ;)
|
|
}
|
|
}
|
|
|
|
return formData;
|
|
}
|
|
|
|
/*
|
|
ViewController.prototype.formatMenuArgs = function(args) {
|
|
var self = this;
|
|
|
|
return _.mapValues(args, function val(value) {
|
|
if('string' === typeof value) {
|
|
return self.formatMCIString(value);
|
|
}
|
|
return value;
|
|
});
|
|
};
|
|
*/ |