moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* New menu stack functional 

* @systemMethod:fallbackMenu -> @systemMethod:prevMenu
* Lots of cleanup of gotoMenuModule() -> MenuModule.gotoMenu()
* Lots of cleanup of fallbackMenuModule() -> MenuModule.prevMenu()
* Lots of cleanup of 'next' processing -> MenuModule.nextMenu()
* Clean up CPU strings a bit more
This commit is contained in:
Bryan Ashby 2015-11-03 23:15:49 -07:00
parent 15ce69e02c
commit f7a7423b32
11 changed files with 86 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
core/bbs.js
View File

@ -224,9 +224,9 @@ function startListening() {
}); });
client.on('idle timeout', function idleTimeout() { client.on('idle timeout', function idleTimeout() {
client.log.info('User idle timeout expired'); client.log.info('User idle timeout expired');
client.gotoMenuModule( { name : 'idleLogoff' }, function goMenuRes(err) { client.menuStack.goto('idleLogoff', function goMenuRes(err) {
if(err) { if(err) {
// likely just doesn't exist // likely just doesn't exist
client.term.write('\nIdle timeout expired. Goodbye!\n'); client.term.write('\nIdle timeout expired. Goodbye!\n');

109
core/client.js
View File

@ -94,7 +94,7 @@ function Client(input, output) {
this.user = new user.User(); this.user = new user.User();
this.currentTheme = { info : { name : 'N/A', description : 'None' } }; this.currentTheme = { info : { name : 'N/A', description : 'None' } };
this.lastKeyPressMs = Date.now(); this.lastKeyPressMs = Date.now();
this.menuStack = new MenuStack(); this.menuStack = new MenuStack(this);
Object.defineProperty(this, 'node', { Object.defineProperty(this, 'node', {
get : function() { get : function() {
@ -102,6 +102,12 @@ function Client(input, output) {
} }
}); });
Object.defineProperty(this, 'currentMenuModule', {
get : function() {
return self.menuStack.getCurrentModule();
}
});
// //
// Peek at incoming |data| and emit events for any special // Peek at incoming |data| and emit events for any special
@ -373,20 +379,6 @@ function Client(input, output) {
} }
}); });
}); });
self.detachCurrentMenuModule = function() {
if(self.currentMenuModule) {
var savedState = self.currentMenuModule.getSaveState();
self.currentMenuModule.leave();
self.lastMenuModuleInfo = self.currentMenuModuleInfo;
self.lastMenuModuleInfo.savedState = savedState;
self.currentMenuModule = null;
}
};
} }
require('util').inherits(Client, stream); require('util').inherits(Client, stream);
@ -423,7 +415,7 @@ Client.prototype.startIdleMonitor = function() {
}; };
Client.prototype.end = function () { Client.prototype.end = function () {
this.detachCurrentMenuModule(); this.menuStack.getCurrentModule().leave();
clearInterval(this.idleCheck); clearInterval(this.idleCheck);
@ -456,94 +448,15 @@ Client.prototype.address = function() {
return this.input.address(); return this.input.address();
}; };
// :TODO: remove these deprecated wrappers:
Client.prototype.gotoMenuModule = function(options, cb) { Client.prototype.gotoMenuModule = function(options, cb) {
var self = this; this.menuStack.goto(options.name, options, cb);
assert(_.isString(options.name), 'Missing options.name');
// Assign a default missing module handler callback if none was provided
var callbackOnErrorOnly = !_.isFunction(cb);
cb = miscUtil.valueWithDefault(cb, self.defaultHandlerMissingMod());
self.detachCurrentMenuModule();
var loadOptions = {
name : options.name,
client : self,
extraArgs : options.extraArgs,
};
menuUtil.loadMenu(loadOptions, function menuModuleLoaded(err, modInst) {
if(err) {
cb(err);
} else {
self.log.debug( { menuName : options.name }, 'Goto menu module');
self.currentMenuModule = modInst; // :TODO: should probably be before enter() above
self.currentMenuModuleInfo = {
// :TODO: This is quite the hack... doesn't seem right...
menuName : self.currentMenuModule.menuName,
extraArgs : options.extraArgs,
}
if(options.savedState) {
modInst.restoreSavedState(options.savedState);
}
modInst.enter(self);
if(!callbackOnErrorOnly) {
cb(null);
}
}
});
}; };
Client.prototype.fallbackMenuModule = function(options, cb) { Client.prototype.fallbackMenuModule = function(options, cb) {
var self = this; this.menuStack.prev(cb);
var modOpts;
if(_.isString(self.currentMenuModule.menuConfig.fallback)) {
modOpts = {
name : self.currentMenuModule.menuConfig.fallback,
extraArgs : options.extraArgs,
};
} else if(self.lastMenuModuleInfo) {
modOpts = {
name : self.lastMenuModuleInfo.menuName,
extraArgs : self.lastMenuModuleInfo.extraArgs,
savedState : self.lastMenuModuleInfo.savedState,
};
}
if(modOpts) {
self.gotoMenuModule(modOpts, cb);
} else {
cb(new Error('Nothing to fallback to!'));
}
}; };
/*
Client.prototype.fallbackMenuModule = function(cb) {
var self = this;
if(self.lastMenuModuleInfo) {
var modOpts = {
name : self.lastMenuModuleInfo.menuName,
extraArgs : self.lastMenuModuleInfo.extraArgs,
savedState : self.lastMenuModuleInfo.savedState,
};
self.gotoMenuModule(modOpts, cb);
} else {
cb(new Error('Nothing to fallback to!'));
}
};
*/
/////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////
// Default error handlers // Default error handlers
/////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////

2
core/connect.js
View File

@ -123,7 +123,7 @@ function connectEntry(client, nextMenu) {
displayBanner(term); displayBanner(term);
setTimeout(function onTimeout() { setTimeout(function onTimeout() {
client.gotoMenuModule( { name : nextMenu } ); client.menuStack.goto(nextMenu);
}, 500); }, 500);
}); });
} }

26
core/menu_module.js
View File

@ -131,7 +131,7 @@ function MenuModule(options) {
} }
self.finishedLoading(); self.finishedLoading();
self.nextMenu(); self.autoNextMenu();
} }
); );
}; };
@ -144,14 +144,12 @@ function MenuModule(options) {
return _.isNumber(self.menuConfig.options.nextTimeout); return _.isNumber(self.menuConfig.options.nextTimeout);
}; };
this.nextMenu = function() { this.autoNextMenu = function() {
function goNext() { function goNext() {
if(_.isString(self.menuConfig.next)) { if(_.isString(self.menuConfig.next)) {
menuUtil.handleNext(self.client, self.menuConfig.next); menuUtil.handleNext(self.client, self.menuConfig.next);
} else { } else {
self.client.fallbackMenuModule( { }, function fallback(err) { self.prevMenu();
// :TODO: this seems sloppy... look into further
});
} }
} }
@ -217,15 +215,15 @@ MenuModule.prototype.restoreSavedState = function(savedState) {
}; };
MenuModule.prototype.nextMenu = function(cb) { MenuModule.prototype.nextMenu = function(cb) {
self.client.menuStack.next(cb); this.client.menuStack.next(cb);
}; };
MenuModule.prototype.prevMenu = function(cb) { MenuModule.prototype.prevMenu = function(cb) {
self.client.menuStack.prev(cb); this.client.menuStack.prev(cb);
}; };
MenuModule.prototype.gotoMenu = function(name, options, cb) { MenuModule.prototype.gotoMenu = function(name, options, cb) {
self.client.menuStack.goto(name, options, cb); this.client.menuStack.goto(name, options, cb);
}; };
MenuModule.prototype.leave = function() { MenuModule.prototype.leave = function() {
@ -302,16 +300,4 @@ MenuModule.prototype.standardMCIReadyHandler = function(mciData, cb) {
}; };
MenuModule.prototype.finishedLoading = function() { MenuModule.prototype.finishedLoading = function() {
/*
var self = this;
if(_.isNumber(this.menuConfig.options.nextTimeout) &&
_.isString(this.menuConfig.next))
{
setTimeout(function nextTimeout() {
menuUtil.handleNext(self.client, self.menuConfig.next);
//self.client.gotoMenuModule( { name : self.menuConfig.next } );
}, this.menuConfig.options.nextTimeout);
}
*/
}; };

56
core/menu_stack.js
View File

@ -5,6 +5,7 @@
var loadMenu = require('./menu_util.js').loadMenu; var loadMenu = require('./menu_util.js').loadMenu;
var _ = require('lodash'); var _ = require('lodash');
var assert = require('assert');
/* /*
MenuStack(client) MenuStack(client)
@ -21,7 +22,8 @@ MenuModule
*/ */
// :TODO: Clean up client attach/detach/etc. // :TODO: Clean up client attach/detach/etc.
// :TODO: Cleanup up client currentMenuModule related stuff (all over!). Make this a property that returns .menuStack.getCurrentModule() // :TODO: gotoMenuModule() -> MenuModule.gotoMenu()
// :TODO: fallbackMenuModule() -> MenuModule.prevMenu()
module.exports = MenuStack; module.exports = MenuStack;
@ -39,6 +41,12 @@ function MenuStack(client) {
return self.stack.pop(); return self.stack.pop();
}; };
this.peekPrev = function() {
if(this.stackSize() > 1) {
return self.stack[self.stack.length - 2];
}
};
this.top = function() { this.top = function() {
if(self.stackSize() > 0) { if(self.stackSize() > 0) {
return self.stack[self.stack.length - 1]; return self.stack[self.stack.length - 1];
@ -52,23 +60,27 @@ function MenuStack(client) {
MenuStack.prototype.next = function(cb) { MenuStack.prototype.next = function(cb) {
var currentModuleInfo = this.top(); var currentModuleInfo = this.top();
assert(currentModuleInfo, 'Empty menu stack!');
if(!_.isString(currentModuleInfo.menuConfig.next)) { var menuConfig = currentModuleInfo.instance.menuConfig;
this.log.error('No \'next\' member in menu config!');
if(!_.isString(menuConfig.next)) {
cb(new Error('No \'next\' member in menu config!'));
return; return;
} }
if(current.menuConfig.next === currentModuleInfo.name) { if(menuConfig.next === currentModuleInfo.name) {
this.log.warn('Menu config \'next\' specifies current menu!'); cb(new Error('Menu config \'next\' specifies current menu!'));
return; return;
} }
this.goto(current.menuConfig.next, { }, cb); this.goto(menuConfig.next, { }, cb);
}; };
MenuStack.prototype.prev = function(cb) { MenuStack.prototype.prev = function(cb) {
var previousModuleInfo = this.pop(); this.pop().instance.leave(); // leave & remove current
var previousModuleInfo = this.pop(); // get previous
if(previousModuleInfo) { if(previousModuleInfo) {
this.goto(previousModuleInfo.name, { extraArgs : previousModuleInfo.extraArgs, savedState : previousModuleInfo.savedState }, cb); this.goto(previousModuleInfo.name, { extraArgs : previousModuleInfo.extraArgs, savedState : previousModuleInfo.savedState }, cb);
} else { } else {
@ -77,17 +89,17 @@ MenuStack.prototype.prev = function(cb) {
}; };
MenuStack.prototype.goto = function(name, options, cb) { MenuStack.prototype.goto = function(name, options, cb) {
var currentModuleInfo = this.menuStack.top(); var currentModuleInfo = this.top();
if(!cb && _.isFunction(options)) {
cb = options;
}
var self = this; var self = this;
if(currentModuleInfo && name === currentModuleInfo.name) { if(currentModuleInfo && name === currentModuleInfo.name) {
var err = new Error('Already at supplied menu!');
self.client.log.warn( { menuName : name, error : err.toString() }, 'Cannot go to menu');
if(cb) { if(cb) {
cb(err); // non-fatal cb(new Error('Already at supplied menu!'));
} }
return; return;
} }
@ -95,14 +107,18 @@ MenuStack.prototype.goto = function(name, options, cb) {
var loadOpts = { var loadOpts = {
name : name, name : name,
client : self.client, client : self.client,
extraArgs : options.extraArgs,
}; };
if(options) {
loadOpts.extraArgs = options.extraArgs;
}
loadMenu(loadOpts, function menuLoaded(err, modInst) { loadMenu(loadOpts, function menuLoaded(err, modInst) {
if(err) { if(err) {
var errCb = cb || self.defaultHandlerMissingMod(); var errCb = cb || self.defaultHandlerMissingMod();
errCb(err); errCb(err);
} else { } else {
// :TODO: Move this log to caller
self.client.log.debug( { menuName : name }, 'Goto menu module'); self.client.log.debug( { menuName : name }, 'Goto menu module');
if(currentModuleInfo) { if(currentModuleInfo) {
@ -112,19 +128,23 @@ MenuStack.prototype.goto = function(name, options, cb) {
currentModuleInfo.instance.leave(); currentModuleInfo.instance.leave();
} }
self.push( { self.push({
name : name, name : name,
instance : modInst, instance : modInst,
extraArgs : options.extraArgs, extraArgs : loadOpts.extraArgs,
}); });
// restore previous state if requested // restore previous state if requested
if(options.savedState) { if(options && options.savedState) {
modInst.restoreSavedState(options.savedState); modInst.restoreSavedState(options.savedState);
} }
modInst.enter(self.client); modInst.enter(self.client);
self.client.log.trace(
{ stack : _.map(self.stack, function(si) { return si.name; } ) },
'Updated menu stack');
if(cb) { if(cb) {
cb(null); cb(null);
} }

10
core/menu_util.js
View File

@ -214,7 +214,7 @@ function handleAction(client, formData, conf) {
break; break;
case 'menu' : case 'menu' :
client.gotoMenuModule( { name : actionAsset.asset, formData : formData, extraArgs : conf.extraArgs } ); client.currentMenuModule.gotoMenu(actionAsset.asset, { formData : formData, extraArgs : conf.extraArgs } );
break; break;
} }
} }
@ -231,7 +231,7 @@ function handleNext(client, nextSpec, conf) {
case 'method' : case 'method' :
case 'systemMethod' : case 'systemMethod' :
if(_.isString(nextAsset.location)) { if(_.isString(nextAsset.location)) {
callModuleMenuMethod(client, nextAsset, paths.join(Config.paths.mods, actionAsset.location), {}, extraArgs); callModuleMenuMethod(client, nextAsset, paths.join(Config.paths.mods, nextAsset.location), {}, extraArgs);
} else { } else {
if('systemMethod' === nextAsset.type) { if('systemMethod' === nextAsset.type) {
// :TODO: see other notes about system_menu_method.js here // :TODO: see other notes about system_menu_method.js here
@ -239,15 +239,15 @@ function handleNext(client, nextSpec, conf) {
} else { } else {
// local to current module // local to current module
var currentModule = client.currentMenuModule; var currentModule = client.currentMenuModule;
if(_.isFunction(currentModule.menuMethods[actionAsset.asset])) { if(_.isFunction(currentModule.menuMethods[nextAsset.asset])) {
currentModule.menuMethods[actionAsset.asset]( { }, extraArgs ); currentModule.menuMethods[nextAsset.asset]( { }, extraArgs );
} }
} }
} }
break; break;
case 'menu' : case 'menu' :
client.gotoMenuModule( { name : nextAsset.asset, extraArgs : extraArgs } ); client.currentMenuModule.gotoMenu(nextAsset.asset, { extraArgs : extraArgs } );
break; break;
default : default :

29
core/message_area.js
View File

@ -14,7 +14,6 @@ exports.getDefaultMessageArea = getDefaultMessageArea;
exports.getMessageAreaByName = getMessageAreaByName; exports.getMessageAreaByName = getMessageAreaByName;
exports.changeMessageArea = changeMessageArea; exports.changeMessageArea = changeMessageArea;
exports.getMessageListForArea = getMessageListForArea; exports.getMessageListForArea = getMessageListForArea;
exports.gotoMsgAreaFSEModuleForMessage = gotoMsgAreaFSEModuleForMessage;
exports.getMessageAreaLastReadId = getMessageAreaLastReadId; exports.getMessageAreaLastReadId = getMessageAreaLastReadId;
exports.updateMessageAreaLastReadId = updateMessageAreaLastReadId; exports.updateMessageAreaLastReadId = updateMessageAreaLastReadId;
@ -158,34 +157,6 @@ function getMessageListForArea(options, areaName, cb) {
); );
} }
function gotoMsgAreaFSEModuleForMessage(options, cb) {
// options.client
// options.msgAreaName
// options.messageUuid
// options.moduleName
// options.msgNumber
// options.msgTotal
var msg = new Message();
msg.load( { uuid : options.messageUuid, user : options.client.user }, function loaded(err) {
if(err) {
cb(err);
} else {
var modOpts = {
name : options.moduleName,
extraArgs : {
message : msg,
messageAreaName : options.msgAreaName,
messageNumber : options.msgNumber,
messageTotal : options.msgTotal,
},
};
options.client.gotoMenuModule(modOpts, cb);
}
});
}
function getMessageAreaLastReadId(userId, areaName, cb) { function getMessageAreaLastReadId(userId, areaName, cb) {
msgDb.get( msgDb.get(
'SELECT message_id ' + 'SELECT message_id ' +

5
core/predefined_mci.js
View File

@ -96,9 +96,12 @@ function getPredefinedMCIValue(client, code) {
// //
// Clean up CPU strings a bit for better display // Clean up CPU strings a bit for better display
// //
return os.cpus()[0].model.replace(/\s+(?= )|\(R\)|\(TM\)|processor|CPU/g, ''); return os.cpus()[0].model.replace(/\(R\)|\(TM\)|processor|CPU/g, '')
.replace(/\s+(?= )/g, '');
}, },
// :TODO: MCI for core count, e.g. os.cpus().length
// :TODO: cpu load average (over N seconds): http://stackoverflow.com/questions/9565912/convert-the-output-of-os-cpus-in-node-js-to-percentage // :TODO: cpu load average (over N seconds): http://stackoverflow.com/questions/9565912/convert-the-output-of-os-cpus-in-node-js-to-percentage
// :TODO: Node version/info // :TODO: Node version/info

10
core/system_menu_method.js
View File

@ -14,7 +14,7 @@ var iconv = require('iconv-lite');
exports.login = login; exports.login = login;
exports.logoff = logoff; exports.logoff = logoff;
exports.fallbackMenu = fallbackMenu; exports.prevMenu = prevMenu;
function login(callingMenu, formData, extraArgs) { function login(callingMenu, formData, extraArgs) {
var client = callingMenu.client; var client = callingMenu.client;
@ -49,7 +49,7 @@ function login(callingMenu, formData, extraArgs) {
} else { } else {
// success! // success!
client.gotoMenuModule( { name : callingMenu.menuConfig.next } ); callingMenu.nextMenu();
} }
}); });
} }
@ -74,10 +74,10 @@ function logoff(callingMenu, formData, extraArgs) {
}, 500); }, 500);
} }
function fallbackMenu(callingMenu, formData, extraArgs) { function prevMenu(callingMenu, formData, extraArgs) {
callingMenu.client.fallbackMenuModule( { extraArgs : extraArgs }, function result(err) { callingMenu.prevMenu(function result(err) {
if(err) { if(err) {
callingMenu.client.log.error( { error : err }, 'Error attempting to fallback!'); callingMenu.client.log.error( { error : err.toString() }, 'Error attempting to fallback!');
} }
}); });
} }

26
mods/menu.hjson
View File

@ -107,7 +107,7 @@
actionKeys: [ actionKeys: [
{ {
keys: [ "escape" ] keys: [ "escape" ]
action: @menu:matrix action: @systemMethod:prevMenu
} }
] ]
} }
@ -192,7 +192,7 @@
} }
{ {
value: { "submission" : 1 } value: { "submission" : 1 }
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
] ]
} }
@ -200,7 +200,7 @@
actionKeys: [ actionKeys: [
{ {
keys: [ "escape" ] keys: [ "escape" ]
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
] ]
} }
@ -278,7 +278,7 @@
} }
{ {
value: { "submission" : 1 } value: { "submission" : 1 }
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
] ]
} }
@ -286,7 +286,7 @@
actionKeys: [ actionKeys: [
{ {
keys: [ "escape" ] keys: [ "escape" ]
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
] ]
} }
@ -524,7 +524,7 @@
actionKeys: [ actionKeys: [
{ {
keys: [ "escape", "q", "shift + q" ] keys: [ "escape", "q", "shift + q" ]
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
] ]
} }
@ -580,7 +580,7 @@
} }
{ {
value: { command: "Q" } value: { command: "Q" }
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
{ {
value: { command: "1" } value: { command: "1" }
@ -646,7 +646,7 @@
} }
{ {
value: { command: "Q" } value: { command: "Q" }
action: @menu:mainMenu action: @systemMethod:prevMenu
} }
{ {
value: { command: "G" } value: { command: "G" }
@ -681,7 +681,7 @@
actionKeys: [ actionKeys: [
{ {
keys: [ "escape", "q", "shift + q" ] keys: [ "escape", "q", "shift + q" ]
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
] ]
} }
@ -714,7 +714,7 @@
actionKeys: [ actionKeys: [
{ {
keys: [ "escape", "q", "shift + q" ] keys: [ "escape", "q", "shift + q" ]
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
] ]
} }
@ -821,7 +821,7 @@
} }
{ {
keys: [ "escape", "q", "shift + q" ] keys: [ "escape", "q", "shift + q" ]
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
{ {
keys: [ "?" ] keys: [ "?" ]
@ -911,7 +911,7 @@
} }
{ {
value: { 1: 1 } value: { 1: 1 }
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
{ {
value: { 1: 2 }, value: { 1: 2 },
@ -935,7 +935,7 @@
} }
{ {
keys: [ "d", "shift + d" ] keys: [ "d", "shift + d" ]
action: @systemMethod:fallbackMenu action: @systemMethod:prevMenu
} }
{ {
keys: [ "q", "shift + q" ] keys: [ "q", "shift + q" ]

2
mods/msg_list.js
View File

@ -68,7 +68,7 @@ function MessageListModule(options) {
} }
}; };
self.client.gotoMenuModule(modOpts); self.gotoMenu(config.menuViewPost || 'messageAreaViewPost', modOpts);
} }
} }
}; };