zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-06-07 13:15:28 +02:00
Code Issues Projects Releases Packages Wiki Activity

* Convert MenuModule to ES6 style class

Browse source 
* Convert modules that are MenuModule subclasses to ES6 style classes
* Convert mixins to ES6 style
* Various cleanup
This commit is contained in:
Bryan Ashby 2017-01-25 22:18:05 -07:00
parent 1c03c3021a
commit 99ab60bf77
26 changed files with 2214 additions and 2418 deletions
Download patch file Download diff file Expand all files Collapse all files

21
core/door_party.js
View file

@ -10,28 +10,26 @@ const async = require('async');
const _ = require('lodash'); const _ = require('lodash');
const SSHClient = require('ssh2').Client; const SSHClient = require('ssh2').Client;
exports.getModule = DoorPartyModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'DoorParty', name : 'DoorParty',
desc : 'DoorParty Access Module', desc : 'DoorParty Access Module',
author : 'NuSkooler', author : 'NuSkooler',
}; };
exports.getModule = class DoorPartyModule extends MenuModule {
function DoorPartyModule(options) { constructor(options) {
MenuModule.call(this, options); super(options);
const self = this;
// establish defaults // establish defaults
this.config = options.menuConfig.config; this.config = options.menuConfig.config;
this.config.host = this.config.host || 'dp.throwbackbbs.com'; this.config.host = this.config.host || 'dp.throwbackbbs.com';
this.config.sshPort = this.config.sshPort || 2022; this.config.sshPort = this.config.sshPort || 2022;
this.config.rloginPort = this.config.rloginPort || 513; this.config.rloginPort = this.config.rloginPort || 513;
}
this.initSequence = function() { initSequence() {
let clientTerminated; let clientTerminated;
const self = this;
async.series( async.series(
[ [
@ -125,8 +123,5 @@ function DoorPartyModule(options) {
} }
} }
); );
}; }
};
}
require('util').inherits(DoorPartyModule, MenuModule);

1
core/enig_error.js
View file

@ -28,4 +28,5 @@ exports.Errors = {
AccessDenied : (reason, reasonCode) => new EnigError('Access denied', -32003, reason, reasonCode), AccessDenied : (reason, reasonCode) => new EnigError('Access denied', -32003, reason, reasonCode),
Invalid : (reason, reasonCode) => new EnigError('Invalid', -32004, reason, reasonCode), Invalid : (reason, reasonCode) => new EnigError('Invalid', -32004, reason, reasonCode),
ExternalProcess : (reason, reasonCode) => new EnigError('External process error', -32005, reason, reasonCode), ExternalProcess : (reason, reasonCode) => new EnigError('External process error', -32005, reason, reasonCode),
MissingConfig : (reason, reasonCode) => new EnigError('Missing configuration', -32006, reason, reasonCode),
}; };

651
core/fse.js
View file

@ -12,6 +12,7 @@ const getUserIdAndName = require('./user.js').getUserIdAndName;
const cleanControlCodes = require('./string_util.js').cleanControlCodes; const cleanControlCodes = require('./string_util.js').cleanControlCodes;
const StatLog = require('./stat_log.js'); const StatLog = require('./stat_log.js');
const stringFormat = require('./string_format.js'); const stringFormat = require('./string_format.js');
const MessageAreaConfTempSwitcher = require('./mod_mixins.js').MessageAreaConfTempSwitcher;
// deps // deps
const async = require('async'); const async = require('async');
@ -19,12 +20,6 @@ const assert = require('assert');
const _ = require('lodash'); const _ = require('lodash');
const moment = require('moment'); const moment = require('moment');
exports.FullScreenEditorModule = FullScreenEditorModule;
// :TODO: clean this up:
exports.getModule = FullScreenEditorModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Full Screen Editor (FSE)', name : 'Full Screen Editor (FSE)',
desc : 'A full screen editor/viewer', desc : 'A full screen editor/viewer',
@ -65,7 +60,7 @@ exports.moduleInfo = {
*/ */
var MCICodeIds = { const MciCodeIds = {
ViewModeHeader : { ViewModeHeader : {
From : 1, From : 1,
To : 2, To : 2,
@ -97,11 +92,15 @@ var MCICodeIds = {
}, },
}; };
function FullScreenEditorModule(options) { // :TODO: convert code in this class to newer styles, conventions, etc. There is a lot of experimental stuff here that has better (DRY) alternatives
MenuModule.call(this, options);
var self = this; exports.FullScreenEditorModule = exports.getModule = class FullScreenEditorModule extends MessageAreaConfTempSwitcher(MenuModule) {
var config = this.menuConfig.config;
constructor(options) {
super(options);
const self = this;
const config = this.menuConfig.config;
// //
// menuConfig.config: // menuConfig.config:
@ -142,27 +141,143 @@ function FullScreenEditorModule(options) {
this.isReady = false; this.isReady = false;
this.isEditMode = function() { if(_.has(options, 'extraArgs.message')) {
return 'edit' === self.editorMode; this.setMessage(options.extraArgs.message);
}; } else if(_.has(options, 'extraArgs.replyToMessage')) {
this.replyToMessage = options.extraArgs.replyToMessage;
}
this.isViewMode = function() { this.menuMethods = {
return 'view' === self.editorMode; //
}; // Validation stuff
//
viewValidationListener : function(err, cb) {
var errMsgView = self.viewControllers.header.getView(MciCodeIds.ReplyEditModeHeader.ErrorMsg);
var newFocusViewId;
if(errMsgView) {
if(err) {
errMsgView.setText(err.message);
this.isLocalEmail = function() { if(MciCodeIds.ViewModeHeader.Subject === err.view.getId()) {
return Message.WellKnownAreaTags.Private === self.messageAreaTag; // :TODO: for "area" mode, should probably just bail if this is emtpy (e.g. cancel)
}; }
} else {
errMsgView.clearText();
}
}
cb(newFocusViewId);
},
this.isReply = function() { headerSubmit : function(formData, extraArgs, cb) {
return !_.isUndefined(self.replyToMessage); self.switchToBody();
}; return cb(null);
},
editModeEscPressed : function(formData, extraArgs, cb) {
self.footerMode = 'editor' === self.footerMode ? 'editorMenu' : 'editor';
this.getFooterName = function() { self.switchFooter(function next(err) {
return 'footer' + _.capitalize(self.footerMode); // e.g. 'footerEditor', 'footerEditorMenu', ... if(err) {
}; // :TODO:... what now?
console.log(err)
} else {
switch(self.footerMode) {
case 'editor' :
if(!_.isUndefined(self.viewControllers.footerEditorMenu)) {
//self.viewControllers.footerEditorMenu.setFocus(false);
self.viewControllers.footerEditorMenu.detachClientEvents();
}
self.viewControllers.body.switchFocus(1);
self.observeEditorEvents();
break;
this.getFormId = function(name) { case 'editorMenu' :
self.viewControllers.body.setFocus(false);
self.viewControllers.footerEditorMenu.switchFocus(1);
break;
default : throw new Error('Unexpected mode');
}
}
return cb(null);
});
},
editModeMenuQuote : function(formData, extraArgs, cb) {
self.viewControllers.footerEditorMenu.setFocus(false);
self.displayQuoteBuilder();
return cb(null);
},
appendQuoteEntry: function(formData, extraArgs, cb) {
// :TODO: Dont' use magic # ID's here
var quoteMsgView = self.viewControllers.quoteBuilder.getView(1);
if(self.newQuoteBlock) {
self.newQuoteBlock = false;
quoteMsgView.addText(self.getQuoteByHeader());
}
var quoteText = self.viewControllers.quoteBuilder.getView(3).getItem(formData.value.quote);
quoteMsgView.addText(quoteText);
//
// If this is *not* the last item, advance. Otherwise, do nothing as we
// don't want to jump back to the top and repeat already quoted lines
//
var quoteListView = self.viewControllers.quoteBuilder.getView(3);
if(quoteListView.getData() !== quoteListView.getCount() - 1) {
quoteListView.focusNext();
} else {
self.quoteBuilderFinalize();
}
return cb(null);
},
quoteBuilderEscPressed : function(formData, extraArgs, cb) {
self.quoteBuilderFinalize();
return cb(null);
},
/*
replyDiscard : function(formData, extraArgs) {
// :TODO: need to prompt yes/no
// :TODO: @method for fallback would be better
self.prevMenu();
},
*/
editModeMenuHelp : function(formData, extraArgs, cb) {
self.viewControllers.footerEditorMenu.setFocus(false);
return self.displayHelp(cb);
},
///////////////////////////////////////////////////////////////////////
// View Mode
///////////////////////////////////////////////////////////////////////
viewModeMenuHelp : function(formData, extraArgs, cb) {
self.viewControllers.footerView.setFocus(false);
return self.displayHelp(cb);
}
};
}
isEditMode() {
return 'edit' === this.editorMode;
}
isViewMode() {
return 'view' === this.editorMode;
}
isLocalEmail() {
return Message.WellKnownAreaTags.Private === this.messageAreaTag;
}
isReply() {
return !_.isUndefined(this.replyToMessage);
}
getFooterName() {
return 'footer' + _.capitalize(this.footerMode); // e.g. 'footerEditor', 'footerEditorMenu', ...
}
getFormId(name) {
return { return {
header : 0, header : 0,
body : 1, body : 1,
@ -173,27 +288,13 @@ function FullScreenEditorModule(options) {
help : 50, help : 50,
}[name]; }[name];
}; }
/*ViewModeHeader : {
From : 1,
To : 2,
Subject : 3,
DateTime : 5,
MsgNum : 6,
MsgTotal : 7,
ViewCount : 8,
HashTags : 9,
MessageID : 10,
ReplyToMsgID : 11
},*/
// :TODO: convert to something like this for all view acces: // :TODO: convert to something like this for all view acces:
this.getHeaderViews = function() { getHeaderViews() {
var vc = self.viewControllers.header; var vc = this.viewControllers.header;
if(self.isViewMode()) { if(this.isViewMode()) {
return { return {
from : vc.getView(1), from : vc.getView(1),
to : vc.getView(2), to : vc.getView(2),
@ -205,61 +306,55 @@ function FullScreenEditorModule(options) {
}; };
} }
};
this.setInitialFooterMode = function() {
switch(self.editorMode) {
case 'edit' : self.footerMode = 'editor'; break;
case 'view' : self.footerMode = 'view'; break;
} }
};
this.buildMessage = function() { setInitialFooterMode() {
var headerValues = self.viewControllers.header.getFormData().value; switch(this.editorMode) {
case 'edit' : this.footerMode = 'editor'; break;
case 'view' : this.footerMode = 'view'; break;
}
}
buildMessage() {
var headerValues = this.viewControllers.header.getFormData().value;
var msgOpts = { var msgOpts = {
areaTag : self.messageAreaTag, areaTag : this.messageAreaTag,
toUserName : headerValues.to, toUserName : headerValues.to,
fromUserName : headerValues.from, fromUserName : headerValues.from,
subject : headerValues.subject, subject : headerValues.subject,
message : self.viewControllers.body.getFormData().value.message, message : this.viewControllers.body.getFormData().value.message,
}; };
if(self.isReply()) { if(this.isReply()) {
msgOpts.replyToMsgId = self.replyToMessage.messageId; msgOpts.replyToMsgId = this.replyToMessage.messageId;
} }
self.message = new Message(msgOpts); this.message = new Message(msgOpts);
}; }
/* setMessage(message) {
this.setBodyMessageViewText = function() { this.message = message;
self.bodyMessageView.setText(cleanControlCodes(self.message.message));
};
*/
this.setMessage = function(message) {
self.message = message;
updateMessageAreaLastReadId( updateMessageAreaLastReadId(
self.client.user.userId, self.messageAreaTag, self.message.messageId, () => { this.client.user.userId, this.messageAreaTag, this.message.messageId, () => {
if(self.isReady) { if(this.isReady) {
self.initHeaderViewMode(); this.initHeaderViewMode();
self.initFooterViewMode(); this.initFooterViewMode();
var bodyMessageView = self.viewControllers.body.getView(1); var bodyMessageView = this.viewControllers.body.getView(1);
if(bodyMessageView && _.has(self, 'message.message')) { if(bodyMessageView && _.has(this, 'message.message')) {
//self.setBodyMessageViewText(); bodyMessageView.setText(cleanControlCodes(this.message.message));
bodyMessageView.setText(cleanControlCodes(self.message.message));
//bodyMessageView.redraw();
} }
} }
} }
); );
}; }
getMessage(cb) {
const self = this;
this.getMessage = function(cb) {
async.series( async.series(
[ [
function buildIfNecessary(callback) { function buildIfNecessary(callback) {
@ -295,24 +390,22 @@ function FullScreenEditorModule(options) {
cb(err, self.message); cb(err, self.message);
} }
); );
}; }
this.updateUserStats = function(cb) { updateUserStats(cb) {
if(Message.isPrivateAreaTag(this.message.areaTag)) { if(Message.isPrivateAreaTag(this.message.areaTag)) {
if(cb) { if(cb) {
return cb(null); cb(null);
} }
return; // don't inc stats for private messages
} }
StatLog.incrementUserStat( return StatLog.incrementUserStat(this.client.user, 'post_count', 1, cb);
self.client.user, }
'post_count',
1, redrawFooter(options, cb) {
cb const self = this;
);
};
this.redrawFooter = function(options, cb) {
async.waterfall( async.waterfall(
[ [
function moveToFooterPosition(callback) { function moveToFooterPosition(callback) {
@ -354,10 +447,11 @@ function FullScreenEditorModule(options) {
cb(err, artData); cb(err, artData);
} }
); );
}; }
this.redrawScreen = function(cb) { redrawScreen(cb) {
var comps = [ 'header', 'body' ]; var comps = [ 'header', 'body' ];
const self = this;
var art = self.menuConfig.config.art; var art = self.menuConfig.config.art;
self.client.term.rawWrite(ansi.resetScreen()); self.client.term.rawWrite(ansi.resetScreen());
@ -398,43 +492,44 @@ function FullScreenEditorModule(options) {
cb(err); cb(err);
} }
); );
}; }
switchFooter(cb) {
var footerName = this.getFooterName();
this.switchFooter = function(cb) { this.redrawFooter( { footerName : footerName, clear : true }, (err, artData) => {
var footerName = self.getFooterName();
self.redrawFooter( { footerName : footerName, clear : true }, function artDisplayed(err, artData) {
if(err) { if(err) {
cb(err); cb(err);
return; return;
} }
var formId = self.getFormId(footerName); var formId = this.getFormId(footerName);
if(_.isUndefined(self.viewControllers[footerName])) { if(_.isUndefined(this.viewControllers[footerName])) {
var menuLoadOpts = { var menuLoadOpts = {
callingMenu : self, callingMenu : this,
formId : formId, formId : formId,
mciMap : artData.mciMap mciMap : artData.mciMap
}; };
self.addViewController( this.addViewController(
footerName, footerName,
new ViewController( { client : self.client, formId : formId } ) new ViewController( { client : this.client, formId : formId } )
).loadFromMenuConfig(menuLoadOpts, function footerReady(err) { ).loadFromMenuConfig(menuLoadOpts, err => {
cb(err); cb(err);
}); });
} else { } else {
self.viewControllers[footerName].redrawAll(); this.viewControllers[footerName].redrawAll();
cb(null); cb(null);
} }
}); });
}; }
this.initSequence = function() { initSequence() {
var mciData = { }; var mciData = { };
const self = this;
var art = self.menuConfig.config.art; var art = self.menuConfig.config.art;
assert(_.isObject(art)); assert(_.isObject(art));
async.series( async.series(
@ -488,10 +583,10 @@ function FullScreenEditorModule(options) {
} }
} }
); );
}; }
this.createInitialViews = function(mciData, cb) {
createInitialViews(mciData, cb) {
const self = this;
var menuLoadOpts = { callingMenu : self }; var menuLoadOpts = { callingMenu : self };
async.series( async.series(
@ -596,11 +691,11 @@ function FullScreenEditorModule(options) {
cb(err); cb(err);
} }
); );
}; }
this.mciReadyHandler = function(mciData, cb) { mciReadyHandler(mciData, cb) {
self.createInitialViews(mciData, function viewsCreated(err) { this.createInitialViews(mciData, err => {
// :TODO: Can probably be replaced with @systemMethod:validateUserNameExists when the framework is in // :TODO: Can probably be replaced with @systemMethod:validateUserNameExists when the framework is in
// place - if this is for existing usernames else validate spec // place - if this is for existing usernames else validate spec
@ -620,103 +715,94 @@ function FullScreenEditorModule(options) {
cb(err); cb(err);
}); });
}; }
this.updateEditModePosition = function(pos) { updateEditModePosition(pos) {
if(self.isEditMode()) { if(this.isEditMode()) {
var posView = self.viewControllers.footerEditor.getView(1); var posView = this.viewControllers.footerEditor.getView(1);
if(posView) { if(posView) {
self.client.term.rawWrite(ansi.savePos()); this.client.term.rawWrite(ansi.savePos());
// :TODO: Use new formatting techniques here, e.g. state.cursorPositionRow, cursorPositionCol and cursorPositionFormat
posView.setText(_.padLeft(String(pos.row + 1), 2, '0') + ',' + _.padLeft(String(pos.col + 1), 2, '0')); posView.setText(_.padLeft(String(pos.row + 1), 2, '0') + ',' + _.padLeft(String(pos.col + 1), 2, '0'));
self.client.term.rawWrite(ansi.restorePos()); this.client.term.rawWrite(ansi.restorePos());
}
} }
} }
};
this.updateTextEditMode = function(mode) { updateTextEditMode(mode) {
if(self.isEditMode()) { if(this.isEditMode()) {
var modeView = self.viewControllers.footerEditor.getView(2); var modeView = this.viewControllers.footerEditor.getView(2);
if(modeView) { if(modeView) {
self.client.term.rawWrite(ansi.savePos()); this.client.term.rawWrite(ansi.savePos());
modeView.setText('insert' === mode ? 'INS' : 'OVR'); modeView.setText('insert' === mode ? 'INS' : 'OVR');
self.client.term.rawWrite(ansi.restorePos()); this.client.term.rawWrite(ansi.restorePos());
} }
} }
};
this.setHeaderText = function(id, text) {
var v = self.viewControllers.header.getView(id);
if(v) {
v.setText(text);
} }
};
this.initHeaderViewMode = function() { setHeaderText(id, text) {
assert(_.isObject(self.message)); this.setViewText('header', id, text);
}
self.setHeaderText(MCICodeIds.ViewModeHeader.From, self.message.fromUserName); initHeaderViewMode() {
self.setHeaderText(MCICodeIds.ViewModeHeader.To, self.message.toUserName); assert(_.isObject(this.message));
self.setHeaderText(MCICodeIds.ViewModeHeader.Subject, self.message.subject);
self.setHeaderText(MCICodeIds.ViewModeHeader.DateTime, moment(self.message.modTimestamp).format(self.client.currentTheme.helpers.getDateTimeFormat()));
self.setHeaderText(MCICodeIds.ViewModeHeader.MsgNum, (self.messageIndex + 1).toString());
self.setHeaderText(MCICodeIds.ViewModeHeader.MsgTotal, self.messageTotal.toString());
self.setHeaderText(MCICodeIds.ViewModeHeader.ViewCount, self.message.viewCount);
self.setHeaderText(MCICodeIds.ViewModeHeader.HashTags, 'TODO hash tags');
self.setHeaderText(MCICodeIds.ViewModeHeader.MessageID, self.message.messageId);
self.setHeaderText(MCICodeIds.ViewModeHeader.ReplyToMsgID, self.message.replyToMessageId);
};
this.initHeaderReplyEditMode = function() { this.setHeaderText(MciCodeIds.ViewModeHeader.From, this.message.fromUserName);
assert(_.isObject(self.replyToMessage)); this.setHeaderText(MciCodeIds.ViewModeHeader.To, this.message.toUserName);
this.setHeaderText(MciCodeIds.ViewModeHeader.Subject, this.message.subject);
this.setHeaderText(MciCodeIds.ViewModeHeader.DateTime, moment(this.message.modTimestamp).format(this.client.currentTheme.helpers.getDateTimeFormat()));
this.setHeaderText(MciCodeIds.ViewModeHeader.MsgNum, (this.messageIndex + 1).toString());
this.setHeaderText(MciCodeIds.ViewModeHeader.MsgTotal, this.messageTotal.toString());
this.setHeaderText(MciCodeIds.ViewModeHeader.ViewCount, this.message.viewCount);
this.setHeaderText(MciCodeIds.ViewModeHeader.HashTags, 'TODO hash tags');
this.setHeaderText(MciCodeIds.ViewModeHeader.MessageID, this.message.messageId);
this.setHeaderText(MciCodeIds.ViewModeHeader.ReplyToMsgID, this.message.replyToMessageId);
}
self.setHeaderText(MCICodeIds.ReplyEditModeHeader.To, self.replyToMessage.fromUserName); initHeaderReplyEditMode() {
assert(_.isObject(this.replyToMessage));
this.setHeaderText(MciCodeIds.ReplyEditModeHeader.To, this.replyToMessage.fromUserName);
// //
// We want to prefix the subject with "RE: " only if it's not already // We want to prefix the subject with "RE: " only if it's not already
// that way -- avoid RE: RE: RE: RE: ... // that way -- avoid RE: RE: RE: RE: ...
// //
let newSubj = self.replyToMessage.subject; let newSubj = this.replyToMessage.subject;
if(false === /^RE:\s+/i.test(newSubj)) { if(false === /^RE:\s+/i.test(newSubj)) {
newSubj = `RE: ${newSubj}`; newSubj = `RE: ${newSubj}`;
} }
self.setHeaderText(MCICodeIds.ReplyEditModeHeader.Subject, newSubj); this.setHeaderText(MciCodeIds.ReplyEditModeHeader.Subject, newSubj);
};
this.initFooterViewMode = function() {
function setFooterText(id, text) {
var v = self.viewControllers.footerView.getView(id);
if(v) {
v.setText(text);
}
} }
setFooterText(MCICodeIds.ViewModeFooter.MsgNum, (self.messageIndex + 1).toString()); initFooterViewMode() {
setFooterText(MCICodeIds.ViewModeFooter.MsgTotal, self.messageTotal.toString()); this.setViewText('footerView', MciCodeIds.ViewModeFooter.MsgNum, (this.messageIndex + 1).toString() );
}; this.setViewText('footerView', MciCodeIds.ViewModeFooter.MsgTotal, this.messageTotal.toString() );
}
this.displayHelp = function(cb) { displayHelp(cb) {
self.client.term.rawWrite(ansi.resetScreen()); this.client.term.rawWrite(ansi.resetScreen());
theme.displayThemeArt( theme.displayThemeArt(
{ name : self.menuConfig.config.art.help, client : self.client }, { name : this.menuConfig.config.art.help, client : this.client },
() => { () => {
self.client.waitForKeyPress( () => { this.client.waitForKeyPress( () => {
self.redrawScreen( () => { this.redrawScreen( () => {
self.viewControllers[self.getFooterName()].setFocus(true); this.viewControllers[this.getFooterName()].setFocus(true);
return cb(null); return cb(null);
}); });
}); });
} }
); );
}; }
this.displayQuoteBuilder = function() { displayQuoteBuilder() {
// //
// Clear body area // Clear body area
// //
self.newQuoteBlock = true; this.newQuoteBlock = true;
const self = this;
async.waterfall( async.waterfall(
[ [
@ -772,19 +858,19 @@ function FullScreenEditorModule(options) {
} }
} }
); );
}; }
this.observeEditorEvents = function() { observeEditorEvents() {
var bodyView = self.viewControllers.body.getView(1); const bodyView = this.viewControllers.body.getView(1);
bodyView.on('edit position', function cursorPosUpdate(pos) { bodyView.on('edit position', pos => {
self.updateEditModePosition(pos); this.updateEditModePosition(pos);
}); });
bodyView.on('text edit mode', function textEditMode(mode) { bodyView.on('text edit mode', mode => {
self.updateTextEditMode(mode); this.updateTextEditMode(mode);
}); });
}; }
/* /*
this.observeViewPosition = function() { this.observeViewPosition = function() {
@ -794,43 +880,43 @@ function FullScreenEditorModule(options) {
}; };
*/ */
this.switchToHeader = function() { switchToHeader() {
self.viewControllers.body.setFocus(false); this.viewControllers.body.setFocus(false);
self.viewControllers.header.switchFocus(2); // to this.viewControllers.header.switchFocus(2); // to
}
switchToBody() {
this.viewControllers.header.setFocus(false);
this.viewControllers.body.switchFocus(1);
this.observeEditorEvents();
}; };
this.switchToBody = function() { switchToFooter() {
self.viewControllers.header.setFocus(false); this.viewControllers.header.setFocus(false);
self.viewControllers.body.switchFocus(1); this.viewControllers.body.setFocus(false);
self.observeEditorEvents(); this.viewControllers[this.getFooterName()].switchFocus(1); // HM1
}; }
this.switchToFooter = function() { switchFromQuoteBuilderToBody() {
self.viewControllers.header.setFocus(false); this.viewControllers.quoteBuilder.setFocus(false);
self.viewControllers.body.setFocus(false); var body = this.viewControllers.body.getView(1);
self.viewControllers[self.getFooterName()].switchFocus(1); // HM1
};
this.switchFromQuoteBuilderToBody = function() {
self.viewControllers.quoteBuilder.setFocus(false);
var body = self.viewControllers.body.getView(1);
body.redraw(); body.redraw();
self.viewControllers.body.switchFocus(1); this.viewControllers.body.switchFocus(1);
// :TODO: create method (DRY) // :TODO: create method (DRY)
self.updateTextEditMode(body.getTextEditMode()); this.updateTextEditMode(body.getTextEditMode());
self.updateEditModePosition(body.getEditPosition()); this.updateEditModePosition(body.getEditPosition());
self.observeEditorEvents(); this.observeEditorEvents();
}; }
this.quoteBuilderFinalize = function() { quoteBuilderFinalize() {
// :TODO: fix magic #'s // :TODO: fix magic #'s
var quoteMsgView = self.viewControllers.quoteBuilder.getView(1); var quoteMsgView = this.viewControllers.quoteBuilder.getView(1);
var msgView = self.viewControllers.body.getView(1); var msgView = this.viewControllers.body.getView(1);
var quoteLines = quoteMsgView.getData(); var quoteLines = quoteMsgView.getData();
@ -841,164 +927,43 @@ function FullScreenEditorModule(options) {
quoteMsgView.setText(''); quoteMsgView.setText('');
var footerName = self.getFooterName(); this.footerMode = 'editor';
self.footerMode = 'editor'; this.switchFooter( () => {
this.switchFromQuoteBuilderToBody();
self.switchFooter(function switched(err) {
self.switchFromQuoteBuilderToBody();
}); });
}; }
this.getQuoteByHeader = function() { getQuoteByHeader() {
let quoteFormat = this.menuConfig.config.quoteFormats; let quoteFormat = this.menuConfig.config.quoteFormats;
if(Array.isArray(quoteFormat)) { if(Array.isArray(quoteFormat)) {
quoteFormat = quoteFormat[ Math.floor(Math.random() * quoteFormat.length) ]; quoteFormat = quoteFormat[ Math.floor(Math.random() * quoteFormat.length) ];
} else if(!_.isString(quoteFormat)) { } else if(!_.isString(quoteFormat)) {
quoteFormat = 'On {dateTime} {userName} said...'; quoteFormat = 'On {dateTime} {userName} said...';
} }
const dtFormat = this.menuConfig.config.quoteDateTimeFormat || self.client.currentTheme.helpers.getDateTimeFormat(); const dtFormat = this.menuConfig.config.quoteDateTimeFormat || this.client.currentTheme.helpers.getDateTimeFormat();
return stringFormat(quoteFormat, { return stringFormat(quoteFormat, {
dateTime : moment(self.replyToMessage.modTimestamp).format(dtFormat), dateTime : moment(this.replyToMessage.modTimestamp).format(dtFormat),
userName : self.replyToMessage.fromUserName, userName : this.replyToMessage.fromUserName,
}); });
};
this.menuMethods = {
//
// Validation stuff
//
viewValidationListener : function(err, cb) {
var errMsgView = self.viewControllers.header.getView(MCICodeIds.ReplyEditModeHeader.ErrorMsg);
var newFocusViewId;
if(errMsgView) {
if(err) {
errMsgView.setText(err.message);
if(MCICodeIds.ViewModeHeader.Subject === err.view.getId()) {
// :TODO: for "area" mode, should probably just bail if this is emtpy (e.g. cancel)
}
} else {
errMsgView.clearText();
}
}
cb(newFocusViewId);
},
headerSubmit : function(formData, extraArgs, cb) {
self.switchToBody();
return cb(null);
},
editModeEscPressed : function(formData, extraArgs, cb) {
self.footerMode = 'editor' === self.footerMode ? 'editorMenu' : 'editor';
self.switchFooter(function next(err) {
if(err) {
// :TODO:... what now?
console.log(err)
} else {
switch(self.footerMode) {
case 'editor' :
if(!_.isUndefined(self.viewControllers.footerEditorMenu)) {
//self.viewControllers.footerEditorMenu.setFocus(false);
self.viewControllers.footerEditorMenu.detachClientEvents();
}
self.viewControllers.body.switchFocus(1);
self.observeEditorEvents();
break;
case 'editorMenu' :
self.viewControllers.body.setFocus(false);
self.viewControllers.footerEditorMenu.switchFocus(1);
break;
default : throw new Error('Unexpected mode');
}
} }
return cb(null); enter() {
});
},
editModeMenuQuote : function(formData, extraArgs, cb) {
self.viewControllers.footerEditorMenu.setFocus(false);
self.displayQuoteBuilder();
return cb(null);
},
appendQuoteEntry: function(formData, extraArgs, cb) {
// :TODO: Dont' use magic # ID's here
var quoteMsgView = self.viewControllers.quoteBuilder.getView(1);
if(self.newQuoteBlock) {
self.newQuoteBlock = false;
quoteMsgView.addText(self.getQuoteByHeader());
}
var quoteText = self.viewControllers.quoteBuilder.getView(3).getItem(formData.value.quote);
quoteMsgView.addText(quoteText);
//
// If this is *not* the last item, advance. Otherwise, do nothing as we
// don't want to jump back to the top and repeat already quoted lines
//
var quoteListView = self.viewControllers.quoteBuilder.getView(3);
if(quoteListView.getData() !== quoteListView.getCount() - 1) {
quoteListView.focusNext();
} else {
self.quoteBuilderFinalize();
}
return cb(null);
},
quoteBuilderEscPressed : function(formData, extraArgs, cb) {
self.quoteBuilderFinalize();
return cb(null);
},
/*
replyDiscard : function(formData, extraArgs) {
// :TODO: need to prompt yes/no
// :TODO: @method for fallback would be better
self.prevMenu();
},
*/
editModeMenuHelp : function(formData, extraArgs, cb) {
self.viewControllers.footerEditorMenu.setFocus(false);
return self.displayHelp(cb);
},
///////////////////////////////////////////////////////////////////////
// View Mode
///////////////////////////////////////////////////////////////////////
viewModeMenuHelp : function(formData, extraArgs, cb) {
self.viewControllers.footerView.setFocus(false);
return self.displayHelp(cb);
}
};
if(_.has(options, 'extraArgs.message')) {
this.setMessage(options.extraArgs.message);
} else if(_.has(options, 'extraArgs.replyToMessage')) {
this.replyToMessage = options.extraArgs.replyToMessage;
}
}
require('util').inherits(FullScreenEditorModule, MenuModule);
require('./mod_mixins.js').MessageAreaConfTempSwitcher.call(FullScreenEditorModule.prototype);
FullScreenEditorModule.prototype.enter = function() {
if(this.messageAreaTag) { if(this.messageAreaTag) {
this.tempMessageConfAndAreaSwitch(this.messageAreaTag); this.tempMessageConfAndAreaSwitch(this.messageAreaTag);
} }
FullScreenEditorModule.super_.prototype.enter.call(this); super.enter();
}; }
FullScreenEditorModule.prototype.leave = function() { leave() {
this.tempMessageConfAndAreaRestore(); this.tempMessageConfAndAreaRestore();
FullScreenEditorModule.super_.prototype.leave.call(this); super.leave();
}; }
FullScreenEditorModule.prototype.mciReady = function(mciData, cb) { mciReady(mciData, cb) {
this.mciReadyHandler(mciData, cb); return this.mciReadyHandler(mciData, cb);
}
}; };

407
core/menu_module.js
View file

@ -9,98 +9,42 @@ const menuUtil = require('./menu_util.js');
const Config = require('./config.js').config; const Config = require('./config.js').config;
const stringFormat = require('../core/string_format.js'); const stringFormat = require('../core/string_format.js');
const MultiLineEditTextView = require('../core/multi_line_edit_text_view.js').MultiLineEditTextView; const MultiLineEditTextView = require('../core/multi_line_edit_text_view.js').MultiLineEditTextView;
const Errors = require('../core/enig_error.js').Errors;
// deps // deps
const async = require('async'); const async = require('async');
const assert = require('assert'); const assert = require('assert');
const _ = require('lodash'); const _ = require('lodash');
exports.MenuModule = MenuModule; exports.MenuModule = class MenuModule extends PluginModule {
// :TODO: some of this is a bit off... should pause after finishedLoading() constructor(options) {
super(options);
function MenuModule(options) {
PluginModule.call(this, options);
var self = this;
this.menuName = options.menuName; this.menuName = options.menuName;
this.menuConfig = options.menuConfig; this.menuConfig = options.menuConfig;
this.client = options.client; this.client = options.client;
// :TODO: this and the line below with .config creates empty ({}) objects in the theme --
// ...which we really should not do. If they aren't there already, don't use 'em.
this.menuConfig.options = options.menuConfig.options || {}; this.menuConfig.options = options.menuConfig.options || {};
this.menuMethods = {}; // methods called from @method's this.menuMethods = {}; // methods called from @method's
this.cls = _.isBoolean(this.menuConfig.options.cls) ?
this.menuConfig.options.cls :
Config.menus.cls;
this.menuConfig.config = this.menuConfig.config || {}; this.menuConfig.config = this.menuConfig.config || {};
this.initViewControllers(); this.cls = _.isBoolean(this.menuConfig.options.cls) ? this.menuConfig.options.cls : Config.menus.cls;
this.shouldPause = function() { this.viewControllers = {};
return 'end' === self.menuConfig.options.pause || true === self.menuConfig.options.pause;
};
this.hasNextTimeout = function() {
return _.isNumber(self.menuConfig.options.nextTimeout);
};
this.autoNextMenu = function(cb) {
function goNext() {
if(_.isString(self.menuConfig.next) || _.isArray(self.menuConfig.next)) {
return menuUtil.handleNext(self.client, self.menuConfig.next, {}, cb);
} else {
return self.prevMenu(cb);
}
} }
if(_.has(self.menuConfig, 'runtime.autoNext') && true === self.menuConfig.runtime.autoNext) { enter() {
/*
If 'next' is supplied, we'll use it. Otherwise, utlize fallback which
may be explicit (supplied) or non-explicit (previous menu)
'next' may be a simple asset, or a object with next.asset and
extrArgs
next: assetSpec
-or-
next: {
asset: assetSpec
extraArgs: ...
}
*/
if(self.hasNextTimeout()) {
setTimeout( () => {
return goNext();
}, this.menuConfig.options.nextTimeout);
} else {
goNext();
}
}
};
this.haveNext = function() {
return (_.isString(this.menuConfig.next) || _.isArray(this.menuConfig.next));
};
}
require('util').inherits(MenuModule, PluginModule);
require('./mod_mixins.js').ViewControllerManagement.call(MenuModule.prototype);
MenuModule.prototype.enter = function() {
this.initSequence(); this.initSequence();
}; }
MenuModule.prototype.initSequence = function() { leave() {
var mciData = { }; this.detachViewControllers();
}
initSequence() {
const self = this; const self = this;
const mciData = {};
let pausePosition;
async.series( async.series(
[ [
@ -108,223 +52,242 @@ MenuModule.prototype.initSequence = function() {
self.beforeArt(callback); self.beforeArt(callback);
}, },
function displayMenuArt(callback) { function displayMenuArt(callback) {
if(_.isString(self.menuConfig.art)) { if(!_.isString(self.menuConfig.art)) {
theme.displayThemedAsset( return callback(null);
}
self.displayAsset(
self.menuConfig.art, self.menuConfig.art,
self.client, self.menuConfig.options,
self.menuConfig.options, // can include .font, .trailingLF, etc. (err, artData) => {
function displayed(err, artData) {
if(err) { if(err) {
self.client.log.trace( { art : self.menuConfig.art, error : err.message }, 'Could not display art'); self.client.log.trace('Could not display art', { art : self.menuConfig.art, reason : err.message } );
} else { } else {
mciData.menu = artData.mciMap; mciData.menu = artData.mciMap;
} }
callback(null); // non-fatal
return callback(null); // any errors are non-fatal
} }
); );
} else {
callback(null);
}
}, },
function moveToPromptLocation(callback) { function moveToPromptLocation(callback) {
if(self.menuConfig.prompt) { if(self.menuConfig.prompt) {
// :TODO: fetch and move cursor to prompt location, if supplied. See notes/etc. on placements // :TODO: fetch and move cursor to prompt location, if supplied. See notes/etc. on placements
} }
callback(null); return callback(null);
}, },
function displayPromptArt(callback) { function displayPromptArt(callback) {
if(_.isString(self.menuConfig.prompt)) { if(!_.isString(self.menuConfig.prompt)) {
// If a prompt is specified, we need the configuration return callback(null);
if(!_.isObject(self.menuConfig.promptConfig)) {
callback(new Error('Prompt specified but configuraiton not found!'));
return;
} }
// Prompts *must* have art. If it's missing it's an error if(!_.isObject(self.menuConfig.promptConfig)) {
// :TODO: allow inline prompts in the future, e.g. @inline:memberName -> { "memberName" : { "text" : "stuff", ... } } return callback(Errors.MissingConfig('Prompt specified but no "promptConfig" block found'));
var promptConfig = self.menuConfig.promptConfig; }
theme.displayThemedAsset(
promptConfig.art, self.displayAsset(
self.client, self.menuConfig.promptConfig.art,
self.menuConfig.options, // can include .font, .trailingLF, etc. self.menuConfig.options,
function displayed(err, artData) { (err, artData) => {
if(!err) { if(artData) {
mciData.prompt = artData.mciMap; mciData.prompt = artData.mciMap;
} }
callback(err); return callback(err); // pass err here; prompts *must* have art
});
} else {
callback(null);
} }
);
}, },
function recordCursorPosition(callback) { function recordCursorPosition(callback) {
if(self.shouldPause()) { if(!self.shouldPause()) {
self.client.once('cursor position report', function cpr(pos) { return callback(null); // cursor position not needed
self.afterArtPos = pos;
self.client.log.trace( { position : pos }, 'After art position recorded');
callback(null);
});
self.client.term.write(ansi.queryPos());
} else {
callback(null);
} }
self.client.once('cursor position report', pos => {
pausePosition = { row : pos[0], col : 1 };
self.client.log.trace('After art position recorded', { position : pausePosition } );
return callback(null);
});
self.client.term.rawWrite(ansi.queryPos());
}, },
function afterArtDisplayed(callback) { function afterArtDisplayed(callback) {
self.mciReady(mciData, callback); return self.mciReady(mciData, callback);
}, },
function displayPauseIfRequested(callback) { function displayPauseIfRequested(callback) {
if(self.shouldPause()) { if(!self.shouldPause()) {
self.client.term.write(ansi.goto(self.afterArtPos[0], 1)); return callback(null);
// :TODO: really need a client.term.pause() that uses the correct art/etc.
// :TODO: Use MenuModule.pausePrompt()
theme.displayThemedPause( { client : self.client }, function keyPressed() {
callback(null);
});
} else {
callback(null);
} }
return self.pausePrompt(pausePosition, callback);
}, },
function finishAndNext(callback) { function finishAndNext(callback) {
self.finishedLoading(); self.finishedLoading();
return self.autoNextMenu(callback);
self.autoNextMenu(callback);
} }
], ],
function complete(err) { err => {
if(err) { if(err) {
console.log(err) self.client.log.warn('Error during init sequence', { error : err.message } );
// :TODO: what to do exactly?????
return self.prevMenu( () => { return self.prevMenu( () => { /* dummy */ } );
// dummy
});
} }
} }
); );
};
MenuModule.prototype.getSaveState = function() {
// nothing in base
};
MenuModule.prototype.restoreSavedState = function(/*savedState*/) {
// nothing in base
};
MenuModule.prototype.nextMenu = function(cb) {
//
// If we don't actually have |next|, we'll go previous
//
if(!this.haveNext()) {
return this.prevMenu(cb);
} }
this.client.menuStack.next(cb); beforeArt(cb) {
};
MenuModule.prototype.prevMenu = function(cb) {
this.client.menuStack.prev(cb);
};
MenuModule.prototype.gotoMenu = function(name, options, cb) {
this.client.menuStack.goto(name, options, cb);
};
MenuModule.prototype.popAndGotoMenu = function(name, options, cb) {
this.client.menuStack.pop();
this.client.menuStack.goto(name, options, cb);
};
MenuModule.prototype.leave = function() {
this.detachViewControllers();
};
MenuModule.prototype.beforeArt = function(cb) {
//
// Set emulated baud rate - note that some terminals will display
// part of the ESC sequence here (generally a single 'r') if they
// do not support cterm style baud rates
//
if(_.isNumber(this.menuConfig.options.baudRate)) { if(_.isNumber(this.menuConfig.options.baudRate)) {
this.client.term.write(ansi.setEmulatedBaudRate(this.menuConfig.options.baudRate)); // :TODO: some terminals not supporting cterm style emulated baud rate end up displaying a broken ESC sequence or a single "r" here
this.client.term.rawWrite(ansi.setEmulatedBaudRate(this.menuConfig.options.baudRate));
} }
if(this.cls) { if(this.cls) {
this.client.term.write(ansi.resetScreen()); this.client.term.rawWrite(ansi.resetScreen());
} }
return cb(null); return cb(null);
}; }
MenuModule.prototype.mciReady = function(mciData, cb) { mciReady(mciData, cb) {
// Reserved for sub classes // available for sub-classes
cb(null); return cb(null);
}; }
MenuModule.prototype.standardMCIReadyHandler = function(mciData, cb) { finishedLoading() {
// nothing in base
}
getSaveState() {
// nothing in base
}
restoreSavedState(/*savedState*/) {
// nothing in base
}
getMenuResult() {
// nothing in base
}
nextMenu(cb) {
if(!this.haveNext()) {
return this.prevMenu(cb); // no next, go to prev
}
return this.client.menuStack.next(cb);
}
prevMenu(cb) {
return this.client.menuStack.prev(cb);
}
gotoMenu(name, options, cb) {
return this.client.menuStack.goto(name, options, cb);
}
addViewController(name, vc) {
assert(!this.viewControllers[name], `ViewController by the name of "${name}" already exists!`);
this.viewControllers[name] = vc;
return vc;
}
detachViewControllers() {
Object.keys(this.viewControllers).forEach( name => {
this.viewControllers[name].detachClientEvents();
});
}
shouldPause() {
return ('end' === this.menuConfig.options.pause || true === this.menuConfig.options.pause);
}
hasNextTimeout() {
return _.isNumber(this.menuConfig.options.nextTimeout);
}
haveNext() {
return (_.isString(this.menuConfig.next) || _.isArray(this.menuConfig.next));
}
autoNextMenu(cb) {
const self = this;
function gotoNextMenu() {
if(self.haveNext()) {
return menuUtil.handleNext(self.client, self.menuConfig.next, {}, cb);
} else {
return self.prevMenu(cb);
}
}
if(_.has(this.menuConfig, 'runtime.autoNext') && true === this.menuConfig.runtime.autoNext) {
if(this.hasNextTimeout()) {
setTimeout( () => {
return gotoNextMenu();
}, this.menuConfig.options.nextTimeout);
} else {
return gotoNextMenu();
}
}
}
standardMCIReadyHandler(mciData, cb) {
// //
// A quick rundown: // A quick rundown:
// * We may have mciData.menu, mciData.prompt, or both. // * We may have mciData.menu, mciData.prompt, or both.
// * Prompt form is favored over menu form if both are present. // * Prompt form is favored over menu form if both are present.
// * Standard/prefdefined MCI entries must load both (e.g. %BN is expected to resolve) // * Standard/prefdefined MCI entries must load both (e.g. %BN is expected to resolve)
// //
var self = this; const self = this;
async.series( async.series(
[ [
function addViewControllers(callback) { function addViewControllers(callback) {
_.forEach(mciData, function entry(mciMap, name) { _.forEach(mciData, (mciMap, name) => {
assert('menu' === name || 'prompt' === name); assert('menu' === name || 'prompt' === name);
self.addViewController(name, new ViewController( { client : self.client } )); self.addViewController(name, new ViewController( { client : self.client } ) );
}); });
callback(null);
return callback(null);
}, },
function createMenu(callback) { function createMenu(callback) {
if(self.viewControllers.menu) { if(!self.viewControllers.menu) {
var menuLoadOpts = { return callback(null);
}
const menuLoadOpts = {
mciMap : mciData.menu, mciMap : mciData.menu,
callingMenu : self, callingMenu : self,
withoutForm : _.isObject(mciData.prompt), withoutForm : _.isObject(mciData.prompt),
}; };
self.viewControllers.menu.loadFromMenuConfig(menuLoadOpts, function menuLoaded(err) { self.viewControllers.menu.loadFromMenuConfig(menuLoadOpts, err => {
callback(err); return callback(err);
}); });
} else {
callback(null);
}
}, },
function createPrompt(callback) { function createPrompt(callback) {
if(self.viewControllers.prompt) { if(!self.viewControllers.prompt) {
var promptLoadOpts = { return callback(null);
}
const promptLoadOpts = {
callingMenu : self, callingMenu : self,
mciMap : mciData.prompt, mciMap : mciData.prompt,
}; };
self.viewControllers.prompt.loadFromPromptConfig(promptLoadOpts, function promptLoaded(err) { self.viewControllers.prompt.loadFromPromptConfig(promptLoadOpts, err => {
callback(err); return callback(err);
}); });
} else {
callback(null);
}
} }
], ],
function complete(err) { err => {
cb(err); return cb(err);
} }
); );
}; }
MenuModule.prototype.finishedLoading = function() {
};
MenuModule.prototype.getMenuResult = function() {
// nothing in base
};
MenuModule.prototype.displayAsset = function(name, options, cb) {
displayAsset(name, options, cb) {
if(_.isFunction(options)) { if(_.isFunction(options)) {
cb = options; cb = options;
options = {}; options = {};
@ -344,11 +307,9 @@ MenuModule.prototype.displayAsset = function(name, options, cb) {
} }
} }
); );
}
}; prepViewController(name, formId, artData, cb) {
MenuModule.prototype.prepViewController = function(name, formId, artData, cb) {
if(_.isUndefined(this.viewControllers[name])) { if(_.isUndefined(this.viewControllers[name])) {
const vcOpts = { const vcOpts = {
client : this.client, client : this.client,
@ -368,10 +329,9 @@ MenuModule.prototype.prepViewController = function(name, formId, artData, cb) {
this.viewControllers[name].setFocus(true); this.viewControllers[name].setFocus(true);
return cb(null); return cb(null);
}; }
prepViewControllerWithArt(name, formId, options, cb) {
MenuModule.prototype.prepViewControllerWithArt = function(name, formId, options, cb) {
this.displayAsset( this.displayAsset(
this.menuConfig.config.art[name], this.menuConfig.config.art[name],
options, options,
@ -383,9 +343,9 @@ MenuModule.prototype.prepViewControllerWithArt = function(name, formId, options,
return this.prepViewController(name, formId, artData, cb); return this.prepViewController(name, formId, artData, cb);
} }
); );
}; }
MenuModule.prototype.pausePrompt = function(position, cb) { pausePrompt(position, cb) {
if(!cb && _.isFunction(position)) { if(!cb && _.isFunction(position)) {
cb = position; cb = position;
position = null; position = null;
@ -398,23 +358,23 @@ MenuModule.prototype.pausePrompt = function(position, cb) {
this.client.term.rawWrite(ansi.goto(position.x, position.y)); this.client.term.rawWrite(ansi.goto(position.x, position.y));
} }
theme.displayThemedPause( { client : this.client }, cb); return theme.displayThemedPause( { client : this.client }, cb);
}; }
MenuModule.prototype.setViewText = function(formName, mciId, text, appendMultiline) { setViewText(formName, mciId, text, appendMultiLine) {
const view = this.viewControllers[formName].getView(mciId); const view = this.viewControllers[formName].getView(mciId);
if(!view) { if(!view) {
return; return;
} }
if(appendMultiline && (view instanceof MultiLineEditTextView)) { if(appendMultiLine && (view instanceof MultiLineEditTextView)) {
view.addText(text); view.addText(text);
} else { } else {
view.setText(text); view.setText(text);
} }
}; }
MenuModule.prototype.updateCustomViewTextsWithFilter = function(formName, startId, fmtObj, options) { updateCustomViewTextsWithFilter(formName, startId, fmtObj, options) {
options = options || {}; options = options || {};
let textView; let textView;
@ -437,4 +397,5 @@ MenuModule.prototype.updateCustomViewTextsWithFilter = function(formName, startI
++customMciId; ++customMciId;
} }
}
}; };

39
core/mod_mixins.js
View file

@ -3,54 +3,29 @@
const messageArea = require('../core/message_area.js'); const messageArea = require('../core/message_area.js');
// deps
const assert = require('assert');
// exports.MessageAreaConfTempSwitcher = Sup => class extends Sup {
// A simple mixin for View Controller management
//
exports.ViewControllerManagement = function() {
this.initViewControllers = function() {
this.viewControllers = {};
};
this.detachViewControllers = function() { tempMessageConfAndAreaSwitch(messageAreaTag) {
var self = this;
Object.keys(this.viewControllers).forEach(function vc(name) {
self.viewControllers[name].detachClientEvents();
});
};
this.addViewController = function(name, vc) {
assert(this.viewControllers, 'initViewControllers() has not been called!');
assert(!this.viewControllers[name], 'ViewController by the name of \'' + name + '\' already exists!');
this.viewControllers[name] = vc;
return vc;
};
};
exports.MessageAreaConfTempSwitcher = function() {
this.tempMessageConfAndAreaSwitch = function(messageAreaTag) {
messageAreaTag = messageAreaTag || this.messageAreaTag; messageAreaTag = messageAreaTag || this.messageAreaTag;
if(!messageAreaTag) { if(!messageAreaTag) {
return; // nothing to do! return; // nothing to do!
} }
this.prevMessageConfAndArea = { this.prevMessageConfAndArea = {
confTag : this.client.user.properties.message_conf_tag, confTag : this.client.user.properties.message_conf_tag,
areaTag : this.client.user.properties.message_area_tag, areaTag : this.client.user.properties.message_area_tag,
}; };
if(!messageArea.tempChangeMessageConfAndArea(this.client, this.messageAreaTag)) { if(!messageArea.tempChangeMessageConfAndArea(this.client, this.messageAreaTag)) {
this.client.log.warn( { messageAreaTag : messageArea }, 'Failed to perform temporary message area/conf switch'); this.client.log.warn( { messageAreaTag : messageArea }, 'Failed to perform temporary message area/conf switch');
} }
}; }
this.tempMessageConfAndAreaRestore = function() { tempMessageConfAndAreaRestore() {
if(this.prevMessageConfAndArea) { if(this.prevMessageConfAndArea) {
this.client.user.properties.message_conf_tag = this.prevMessageConfAndArea.confTag; this.client.user.properties.message_conf_tag = this.prevMessageConfAndArea.confTag;
this.client.user.properties.message_area_tag = this.prevMessageConfAndArea.areaTag; this.client.user.properties.message_area_tag = this.prevMessageConfAndArea.areaTag;
} }
}; }
}; };

95
core/new_scan.js
View file

@ -17,8 +17,6 @@ exports.moduleInfo = {
author : 'NuSkooler', author : 'NuSkooler',
}; };
exports.getModule = NewScanModule;
/* /*
* :TODO: * :TODO:
* * User configurable new scan: Area selection (avail from messages area) (sep module) * * User configurable new scan: Area selection (avail from messages area) (sep module)
@ -27,16 +25,14 @@ exports.getModule = NewScanModule;
*/ */
var MciCodeIds = { const MciCodeIds = {
ScanStatusLabel : 1, // TL1 ScanStatusLabel : 1, // TL1
ScanStatusList : 2, // VM2 (appends) ScanStatusList : 2, // VM2 (appends)
}; };
function NewScanModule(options) { exports.getModule = class NewScanModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
super(options);
var self = this;
var config = this.menuConfig.config;
this.newScanFullExit = _.has(options, 'lastMenuResult.fullExit') ? options.lastMenuResult.fullExit : false; this.newScanFullExit = _.has(options, 'lastMenuResult.fullExit') ? options.lastMenuResult.fullExit : false;
@ -44,31 +40,30 @@ function NewScanModule(options) {
this.currentScanAux = {}; this.currentScanAux = {};
// :TODO: Make this conf/area specific: // :TODO: Make this conf/area specific:
const config = this.menuConfig.config;
this.scanStartFmt = config.scanStartFmt || 'Scanning {confName} - {areaName}...'; this.scanStartFmt = config.scanStartFmt || 'Scanning {confName} - {areaName}...';
this.scanFinishNoneFmt = config.scanFinishNoneFmt || 'Nothing new'; this.scanFinishNoneFmt = config.scanFinishNoneFmt || 'Nothing new';
this.scanFinishNewFmt = config.scanFinishNewFmt || '{count} entries found'; this.scanFinishNewFmt = config.scanFinishNewFmt || '{count} entries found';
this.scanCompleteMsg = config.scanCompleteMsg || 'Finished newscan'; this.scanCompleteMsg = config.scanCompleteMsg || 'Finished newscan';
this.updateScanStatus = function(statusText) {
var vc = self.viewControllers.allViews;
var view = vc.getView(MciCodeIds.ScanStatusLabel);
if(view) {
view.setText(statusText);
} }
updateScanStatus(statusText) {
this.setViewText('allViews', MciCodeIds.ScanStatusLabel, statusText);
/*
view = vc.getView(MciCodeIds.ScanStatusList); view = vc.getView(MciCodeIds.ScanStatusList);
// :TODO: MenuView needs appendItem() // :TODO: MenuView needs appendItem()
if(view) { if(view) {
} }
}; */
}
this.newScanMessageConference = function(cb) { newScanMessageConference(cb) {
// lazy init // lazy init
if(!self.sortedMessageConfs) { if(!this.sortedMessageConfs) {
const getAvailOpts = { includeSystemInternal : true }; // find new private messages, bulletins, etc. const getAvailOpts = { includeSystemInternal : true }; // find new private messages, bulletins, etc.
self.sortedMessageConfs = _.map(msgArea.getAvailableMessageConferences(self.client, getAvailOpts), (v, k) => { this.sortedMessageConfs = _.map(msgArea.getAvailableMessageConferences(this.client, getAvailOpts), (v, k) => {
return { return {
confTag : k, confTag : k,
conf : v, conf : v,
@ -80,7 +75,7 @@ function NewScanModule(options) {
// always come first such that we display private mails/etc. before // always come first such that we display private mails/etc. before
// other conferences & areas // other conferences & areas
// //
self.sortedMessageConfs.sort((a, b) => { this.sortedMessageConfs.sort((a, b) => {
if('system_internal' === a.confTag) { if('system_internal' === a.confTag) {
return -1; return -1;
} else { } else {
@ -88,11 +83,12 @@ function NewScanModule(options) {
} }
}); });
self.currentScanAux.conf = self.currentScanAux.conf || 0; this.currentScanAux.conf = this.currentScanAux.conf || 0;
self.currentScanAux.area = self.currentScanAux.area || 0; this.currentScanAux.area = this.currentScanAux.area || 0;
} }
const currentConf = self.sortedMessageConfs[self.currentScanAux.conf]; const currentConf = this.sortedMessageConfs[this.currentScanAux.conf];
const self = this;
async.series( async.series(
[ [
@ -113,19 +109,22 @@ function NewScanModule(options) {
}); });
} }
], ],
cb err => {
return cb(err);
}
); );
}; }
this.newScanMessageArea = function(conf, cb) { newScanMessageArea(conf, cb) {
// :TODO: it would be nice to cache this - must be done by conf! // :TODO: it would be nice to cache this - must be done by conf!
const sortedAreas = msgArea.getSortedAvailMessageAreasByConfTag(conf.confTag, { client : self.client } ); const sortedAreas = msgArea.getSortedAvailMessageAreasByConfTag(conf.confTag, { client : this.client } );
const currentArea = sortedAreas[self.currentScanAux.area]; const currentArea = sortedAreas[this.currentScanAux.area];
// //
// Scan and update index until we find something. If results are found, // Scan and update index until we find something. If results are found,
// we'll goto the list module & show them. // we'll goto the list module & show them.
// //
const self = this;
async.waterfall( async.waterfall(
[ [
function checkAndUpdateIndex(callback) { function checkAndUpdateIndex(callback) {
@ -165,47 +164,45 @@ function NewScanModule(options) {
} }
}; };
return self.gotoMenu(config.newScanMessageList || 'newScanMessageList', nextModuleOpts); return self.gotoMenu(self.menuConfig.config.newScanMessageList || 'newScanMessageList', nextModuleOpts);
} }
], ],
cb // no more areas err => {
return cb(err);
}
); );
}; }
} getSaveState() {
require('util').inherits(NewScanModule, MenuModule);
NewScanModule.prototype.getSaveState = function() {
return { return {
currentStep : this.currentStep, currentStep : this.currentStep,
currentScanAux : this.currentScanAux, currentScanAux : this.currentScanAux,
}; };
}; }
NewScanModule.prototype.restoreSavedState = function(savedState) { restoreSavedState(savedState) {
this.currentStep = savedState.currentStep; this.currentStep = savedState.currentStep;
this.currentScanAux = savedState.currentScanAux; this.currentScanAux = savedState.currentScanAux;
}; }
NewScanModule.prototype.mciReady = function(mciData, cb) {
mciReady(mciData, cb) {
if(this.newScanFullExit) { if(this.newScanFullExit) {
// user has canceled the entire scan @ message list view // user has canceled the entire scan @ message list view
return cb(null); return cb(null);
} }
super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
var self = this; const self = this;
var vc = self.viewControllers.allViews = new ViewController( { client : self.client } ); const vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
// :TODO: display scan step/etc. // :TODO: display scan step/etc.
async.series( async.series(
[ [
function callParentMciReady(callback) {
NewScanModule.super_.prototype.mciReady.call(self, mciData, callback);
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
const loadOpts = { const loadOpts = {
callingMenu : self, callingMenu : self,
@ -227,11 +224,13 @@ NewScanModule.prototype.mciReady = function(mciData, cb) {
} }
} }
], ],
function complete(err) { err => {
if(err) { if(err) {
self.client.log.error( { error : err.toString() }, 'Error during new scan'); self.client.log.error( { error : err.toString() }, 'Error during new scan');
} }
cb(err); return cb(err);
} }
); );
});
}
}; };

41
core/standard_menu.js
View file

@ -1,9 +1,7 @@
/* jslint node: true */ /* jslint node: true */
'use strict'; 'use strict';
var MenuModule = require('./menu_module.js').MenuModule; const MenuModule = require('./menu_module.js').MenuModule;
exports.getModule = StandardMenuModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Standard Menu Module', name : 'Standard Menu Module',
@ -11,30 +9,19 @@ exports.moduleInfo = {
author : 'NuSkooler', author : 'NuSkooler',
}; };
function StandardMenuModule(menuConfig) { exports.getModule = class StandardMenuModule extends MenuModule {
MenuModule.call(this, menuConfig); constructor(options) {
} super(options);
require('util').inherits(StandardMenuModule, MenuModule);
StandardMenuModule.prototype.enter = function() {
StandardMenuModule.super_.prototype.enter.call(this);
};
StandardMenuModule.prototype.beforeArt = function(cb) {
StandardMenuModule.super_.prototype.beforeArt.call(this, cb);
};
StandardMenuModule.prototype.mciReady = function(mciData, cb) {
var self = this;
StandardMenuModule.super_.prototype.mciReady.call(this, mciData, function mciReadyComplete(err) {
if(err) {
cb(err);
} else {
// we do this so other modules can be both customized and still perform standard tasks
StandardMenuModule.super_.prototype.standardMCIReadyHandler.call(self, mciData, cb);
} }
mciReady(mciData, cb) {
super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
// we do this so other modules can be both customized and still perform standard tasks
return this.standardMCIReadyHandler(mciData, cb);
}); });
}
}; };

77
core/user_config.js
View file

@ -1,17 +1,15 @@
/* jslint node: true */ /* jslint node: true */
'use strict'; 'use strict';
var MenuModule = require('./menu_module.js').MenuModule; const MenuModule = require('./menu_module.js').MenuModule;
var ViewController = require('./view_controller.js').ViewController; const ViewController = require('./view_controller.js').ViewController;
var theme = require('./theme.js'); const theme = require('./theme.js');
var sysValidate = require('./system_view_validate.js'); const sysValidate = require('./system_view_validate.js');
var async = require('async'); const async = require('async');
var assert = require('assert'); const assert = require('assert');
var _ = require('lodash'); const _ = require('lodash');
var moment = require('moment'); const moment = require('moment');
exports.getModule = UserConfigModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'User Configuration', name : 'User Configuration',
@ -19,7 +17,7 @@ exports.moduleInfo = {
author : 'NuSkooler', author : 'NuSkooler',
}; };
var MciCodeIds = { const MciCodeIds = {
RealName : 1, RealName : 1,
BirthDate : 2, BirthDate : 2,
Sex : 3, Sex : 3,
@ -37,21 +35,11 @@ var MciCodeIds = {
SaveCancel : 25, SaveCancel : 25,
}; };
function UserConfigModule(options) { exports.getModule = class UserConfigModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
super(options);
var self = this; const self = this;
self.getView = function(viewId) {
return self.viewControllers.menu.getView(viewId);
};
self.setViewText = function(viewId, text) {
var v = self.getView(viewId);
if(v) {
v.setText(text);
}
};
this.menuMethods = { this.menuMethods = {
// //
@ -154,21 +142,24 @@ function UserConfigModule(options) {
}); });
}, },
}; };
} }
require('util').inherits(UserConfigModule, MenuModule); getView(viewId) {
return this.viewControllers.menu.getView(viewId);
}
UserConfigModule.prototype.mciReady = function(mciData, cb) { mciReady(mciData, cb) {
var self = this; super.mciReady(mciData, err => {
var vc = self.viewControllers.menu = new ViewController( { client : self.client} ); if(err) {
return cb(err);
}
var currentThemeIdIndex = 0; const self = this;
const vc = self.viewControllers.menu = new ViewController( { client : self.client} );
let currentThemeIdIndex = 0;
async.series( async.series(
[ [
function callParentMciReady(callback) {
UserConfigModule.super_.prototype.mciReady.call(self, mciData, callback);
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
vc.loadFromMenuConfig( { callingMenu : self, mciMap : mciData.menu }, callback); vc.loadFromMenuConfig( { callingMenu : self, mciMap : mciData.menu }, callback);
}, },
@ -192,14 +183,14 @@ UserConfigModule.prototype.mciReady = function(mciData, cb) {
function populateViews(callback) { function populateViews(callback) {
var user = self.client.user; var user = self.client.user;
self.setViewText(MciCodeIds.RealName, user.properties.real_name); self.setViewText('menu', MciCodeIds.RealName, user.properties.real_name);
self.setViewText(MciCodeIds.BirthDate, moment(user.properties.birthdate).format('YYYYMMDD')); self.setViewText('menu', MciCodeIds.BirthDate, moment(user.properties.birthdate).format('YYYYMMDD'));
self.setViewText(MciCodeIds.Sex, user.properties.sex); self.setViewText('menu', MciCodeIds.Sex, user.properties.sex);
self.setViewText(MciCodeIds.Loc, user.properties.location); self.setViewText('menu', MciCodeIds.Loc, user.properties.location);
self.setViewText(MciCodeIds.Affils, user.properties.affiliation); self.setViewText('menu', MciCodeIds.Affils, user.properties.affiliation);
self.setViewText(MciCodeIds.Email, user.properties.email_address); self.setViewText('menu', MciCodeIds.Email, user.properties.email_address);
self.setViewText(MciCodeIds.Web, user.properties.web_address); self.setViewText('menu', MciCodeIds.Web, user.properties.web_address);
self.setViewText(MciCodeIds.TermHeight, user.properties.term_height.toString()); self.setViewText('menu', MciCodeIds.TermHeight, user.properties.term_height.toString());
var themeView = self.getView(MciCodeIds.Theme); var themeView = self.getView(MciCodeIds.Theme);
@ -225,4 +216,6 @@ UserConfigModule.prototype.mciReady = function(mciData, cb) {
} }
} }
); );
});
}
}; };

83
mods/abracadabra.js
View file

@ -1,23 +1,21 @@
/* jslint node: true */ /* jslint node: true */
'use strict'; 'use strict';
let MenuModule = require('../core/menu_module.js').MenuModule; const MenuModule = require('../core/menu_module.js').MenuModule;
let DropFile = require('../core/dropfile.js').DropFile; const DropFile = require('../core/dropfile.js').DropFile;
let door = require('../core/door.js'); const door = require('../core/door.js');
let theme = require('../core/theme.js'); const theme = require('../core/theme.js');
let ansi = require('../core/ansi_term.js'); const ansi = require('../core/ansi_term.js');
let async = require('async'); const async = require('async');
let assert = require('assert'); const assert = require('assert');
let paths = require('path'); const paths = require('path');
let _ = require('lodash'); const _ = require('lodash');
let mkdirs = require('fs-extra').mkdirs; const mkdirs = require('fs-extra').mkdirs;
// :TODO: This should really be a system module... needs a little work to allow for such // :TODO: This should really be a system module... needs a little work to allow for such
exports.getModule = AbracadabraModule; const activeDoorNodeInstances = {};
let activeDoorNodeInstances = {};
exports.moduleInfo = { exports.moduleInfo = {
name : 'Abracadabra', name : 'Abracadabra',
@ -60,20 +58,20 @@ exports.moduleInfo = {
:TODO: See Mystic & others for other arg options that we may need to support :TODO: See Mystic & others for other arg options that we may need to support
*/ */
function AbracadabraModule(options) {
MenuModule.call(this, options);
let self = this; exports.getModule = class AbracadabraModule extends MenuModule {
constructor(options) {
super(options);
this.config = options.menuConfig.config; this.config = options.menuConfig.config;
// :TODO: MenuModule.validateConfig(cb) -- validate config section gracefully instead of asserts! -- { key : type, key2 : type2, ... }
// :TODO: MenuModule.validateConfig(cb) -- validate config section gracefully instead of asserts!
assert(_.isString(this.config.name, 'Config \'name\' is required')); assert(_.isString(this.config.name, 'Config \'name\' is required'));
assert(_.isString(this.config.dropFileType, 'Config \'dropFileType\' is required')); assert(_.isString(this.config.dropFileType, 'Config \'dropFileType\' is required'));
assert(_.isString(this.config.cmd, 'Config \'cmd\' is required')); assert(_.isString(this.config.cmd, 'Config \'cmd\' is required'));
this.config.nodeMax = this.config.nodeMax || 0; this.config.nodeMax = this.config.nodeMax || 0;
this.config.args = this.config.args || []; this.config.args = this.config.args || [];
}
/* /*
:TODO: :TODO:
@ -82,7 +80,9 @@ function AbracadabraModule(options) {
* Font support ala all other menus... or does this just work? * Font support ala all other menus... or does this just work?
*/ */
this.initSequence = function() { initSequence() {
const self = this;
async.series( async.series(
[ [
function validateNodeCount(callback) { function validateNodeCount(callback) {
@ -148,54 +148,51 @@ function AbracadabraModule(options) {
} }
} }
); );
}; }
this.runDoor = function() { runDoor() {
const exeInfo = { const exeInfo = {
cmd : self.config.cmd, cmd : this.config.cmd,
args : self.config.args, args : this.config.args,
io : self.config.io || 'stdio', io : this.config.io || 'stdio',
encoding : self.config.encoding || self.client.term.outputEncoding, encoding : this.config.encoding || this.client.term.outputEncoding,
dropFile : self.dropFile.fileName, dropFile : this.dropFile.fileName,
node : self.client.node, node : this.client.node,
//inhSocket : self.client.output._handle.fd, //inhSocket : this.client.output._handle.fd,
}; };
const doorInstance = new door.Door(self.client, exeInfo); const doorInstance = new door.Door(this.client, exeInfo);
doorInstance.once('finished', () => { doorInstance.once('finished', () => {
// //
// Try to clean up various settings such as scroll regions that may // Try to clean up various settings such as scroll regions that may
// have been set within the door // have been set within the door
// //
self.client.term.rawWrite( this.client.term.rawWrite(
ansi.normal() + ansi.normal() +
ansi.goto(self.client.term.termHeight, self.client.term.termWidth) + ansi.goto(this.client.term.termHeight, this.client.term.termWidth) +
ansi.setScrollRegion() + ansi.setScrollRegion() +
ansi.goto(self.client.term.termHeight, 0) + ansi.goto(this.client.term.termHeight, 0) +
'\r\n\r\n' '\r\n\r\n'
); );
self.prevMenu(); this.prevMenu();
}); });
self.client.term.write(ansi.resetScreen()); this.client.term.write(ansi.resetScreen());
doorInstance.run(); doorInstance.run();
}; }
}
require('util').inherits(AbracadabraModule, MenuModule);
AbracadabraModule.prototype.leave = function() {
AbracadabraModule.super_.prototype.leave.call(this);
leave() {
super.leave();
if(!this.lastError) { if(!this.lastError) {
activeDoorNodeInstances[this.config.name] -= 1; activeDoorNodeInstances[this.config.name] -= 1;
} }
}; }
AbracadabraModule.prototype.finishedLoading = function() { finishedLoading() {
this.runDoor(); this.runDoor();
}
}; };

33
mods/art_pool.js
View file

@ -1,33 +0,0 @@
/* jslint node: true */
'use strict';
var MenuModule = require('../core/menu_module.js').MenuModule;
exports.getModule = ArtPoolModule;
exports.moduleInfo = {
name : 'Art Pool',
desc : 'Display art from a pool of options',
author : 'NuSkooler',
};
function ArtPoolModule(options) {
MenuModule.call(this, options);
var config = this.menuConfig.config;
//
// :TODO: General idea
// * Break up some of MenuModule initSequence's calls into methods
// * initSequence here basically has general "clear", "next", etc. as per normal
// * Display art -> ooptinal pause -> display more if requested, etc.
// * Finally exit & move on as per normal
}
require('util').inherits(ArtPoolModule, MenuModule);
MessageAreaModule.prototype.mciReady = function(mciData, cb) {
this.standardMCIReadyHandler(mciData, cb);
};

36
mods/bbs_link.js
View file

@ -36,28 +36,26 @@ const packageJson = require('../package.json');
// :TODO: BUG: When a client disconnects, it's not handled very well -- the log is spammed with tons of errors // :TODO: BUG: When a client disconnects, it's not handled very well -- the log is spammed with tons of errors
// :TODO: ENH: Support nodeMax and tooManyArt // :TODO: ENH: Support nodeMax and tooManyArt
exports.getModule = BBSLinkModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'BBSLink', name : 'BBSLink',
desc : 'BBSLink Access Module', desc : 'BBSLink Access Module',
author : 'NuSkooler', author : 'NuSkooler',
}; };
exports.getModule = class BBSLinkModule extends MenuModule {
constructor(options) {
super(options);
function BBSLinkModule(options) {
MenuModule.call(this, options);
var self = this;
this.config = options.menuConfig.config; this.config = options.menuConfig.config;
this.config.host = this.config.host || 'games.bbslink.net'; this.config.host = this.config.host || 'games.bbslink.net';
this.config.port = this.config.port || 23; this.config.port = this.config.port || 23;
}
this.initSequence = function() { initSequence() {
var token; let token;
var randomKey; let randomKey;
var clientTerminated; let clientTerminated;
const self = this;
async.series( async.series(
[ [
@ -180,17 +178,17 @@ function BBSLinkModule(options) {
} }
} }
); );
}; }
this.simpleHttpRequest = function(path, headers, cb) { simpleHttpRequest(path, headers, cb) {
var getOpts = { const getOpts = {
host : this.config.host, host : this.config.host,
path : path, path : path,
headers : headers, headers : headers,
}; };
var req = http.get(getOpts, function response(resp) { const req = http.get(getOpts, function response(resp) {
var data = ''; let data = '';
resp.on('data', function chunk(c) { resp.on('data', function chunk(c) {
data += c; data += c;
@ -205,7 +203,5 @@ function BBSLinkModule(options) {
req.on('error', function reqErr(err) { req.on('error', function reqErr(err) {
cb(err); cb(err);
}); });
}; }
} };
require('util').inherits(BBSLinkModule, MenuModule);

270
mods/bbs_list.js
View file

@ -17,17 +17,13 @@ const _ = require('lodash');
// :TODO: add notes field // :TODO: add notes field
exports.getModule = BBSListModule; const moduleInfo = exports.moduleInfo = {
const moduleInfo = {
name : 'BBS List', name : 'BBS List',
desc : 'List of other BBSes', desc : 'List of other BBSes',
author : 'Andrew Pamment', author : 'Andrew Pamment',
packageName : 'com.magickabbs.enigma.bbslist' packageName : 'com.magickabbs.enigma.bbslist'
}; };
exports.moduleInfo = moduleInfo;
const MciViewIds = { const MciViewIds = {
view : { view : {
BBSList : 1, BBSList : 1,
@ -69,13 +65,106 @@ const SELECTED_MCI_NAME_TO_ENTRY = {
SelectedBBSNotes : 'notes', SelectedBBSNotes : 'notes',
}; };
function BBSListModule(options) { exports.getModule = class BBSListModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
super(options);
const self = this; const self = this;
const config = this.menuConfig.config; this.menuMethods = {
//
// Validators
//
viewValidationListener : function(err, cb) {
const errMsgView = self.viewControllers.add.getView(MciViewIds.add.Error);
if(errMsgView) {
if(err) {
errMsgView.setText(err.message);
} else {
errMsgView.clearText();
}
}
this.initSequence = function() { return cb(null);
},
//
// Key & submit handlers
//
addBBS : function(formData, extraArgs, cb) {
self.displayAddScreen(cb);
},
deleteBBS : function(formData, extraArgs, cb) {
const entriesView = self.viewControllers.view.getView(MciViewIds.view.BBSList);
if(self.entries[self.selectedBBS].submitterUserId !== self.client.user.userId && !self.client.user.isSysOp()) {
// must be owner or +op
return cb(null);
}
const entry = self.entries[self.selectedBBS];
if(!entry) {
return cb(null);
}
self.database.run(
`DELETE FROM bbs_list
WHERE id=?;`,
[ entry.id ],
err => {
if (err) {
self.client.log.error( { err : err }, 'Error deleting from BBS list');
} else {
self.entries.splice(self.selectedBBS, 1);
self.setEntries(entriesView);
if(self.entries.length > 0) {
entriesView.focusPrevious();
}
self.viewControllers.view.redrawAll();
}
return cb(null);
}
);
},
submitBBS : function(formData, extraArgs, cb) {
let ok = true;
[ 'BBSName', 'Sysop', 'Telnet' ].forEach( mciName => {
if('' === self.viewControllers.add.getView(MciViewIds.add[mciName]).getData()) {
ok = false;
}
});
if(!ok) {
// validators should prevent this!
return cb(null);
}
self.database.run(
`INSERT INTO bbs_list (bbs_name, sysop, telnet, www, location, software, submitter_user_id, notes)
VALUES(?, ?, ?, ?, ?, ?, ?, ?);`,
[ formData.value.name, formData.value.sysop, formData.value.telnet, formData.value.www, formData.value.location, formData.value.software, self.client.user.userId, formData.value.notes ],
err => {
if(err) {
self.client.log.error( { err : err }, 'Error adding to BBS list');
}
self.clearAddForm();
self.displayBBSList(true, cb);
}
);
},
cancelSubmit : function(formData, extraArgs, cb) {
self.clearAddForm();
self.displayBBSList(true, cb);
}
};
}
initSequence() {
const self = this;
async.series( async.series(
[ [
function beforeDisplayArt(callback) { function beforeDisplayArt(callback) {
@ -92,39 +181,42 @@ function BBSListModule(options) {
self.finishedLoading(); self.finishedLoading();
} }
); );
}; }
this.drawSelectedEntry = function(entry) { drawSelectedEntry(entry) {
if(!entry) { if(!entry) {
Object.keys(SELECTED_MCI_NAME_TO_ENTRY).forEach(mciName => { Object.keys(SELECTED_MCI_NAME_TO_ENTRY).forEach(mciName => {
self.setViewText(MciViewIds.view[mciName], ''); this.setViewText('view', MciViewIds.view[mciName], '');
}); });
} else { } else {
const youSubmittedFormat = config.youSubmittedFormat || '{submitter} (You!)'; const youSubmittedFormat = this.menuConfig.youSubmittedFormat || '{submitter} (You!)';
Object.keys(SELECTED_MCI_NAME_TO_ENTRY).forEach(mciName => { Object.keys(SELECTED_MCI_NAME_TO_ENTRY).forEach(mciName => {
const t = entry[SELECTED_MCI_NAME_TO_ENTRY[mciName]]; const t = entry[SELECTED_MCI_NAME_TO_ENTRY[mciName]];
if(MciViewIds.view[mciName]) { if(MciViewIds.view[mciName]) {
if('SelectedBBSSubmitter' == mciName && entry.submitterUserId == self.client.user.userId) { if('SelectedBBSSubmitter' == mciName && entry.submitterUserId == this.client.user.userId) {
self.setViewText(MciViewIds.view.SelectedBBSSubmitter, stringFormat(youSubmittedFormat, entry)); this.setViewText('view',MciViewIds.view.SelectedBBSSubmitter, stringFormat(youSubmittedFormat, entry));
} else { } else {
self.setViewText(MciViewIds.view[mciName], t); this.setViewText('view',MciViewIds.view[mciName], t);
} }
} }
}); });
} }
}; }
this.setEntries = function(entriesView) { setEntries(entriesView) {
const config = this.menuConfig.config;
const listFormat = config.listFormat || '{bbsName}'; const listFormat = config.listFormat || '{bbsName}';
const focusListFormat = config.focusListFormat || '{bbsName}'; const focusListFormat = config.focusListFormat || '{bbsName}';
entriesView.setItems(self.entries.map( e => stringFormat(listFormat, e) ) ); entriesView.setItems(this.entries.map( e => stringFormat(listFormat, e) ) );
entriesView.setFocusItems(self.entries.map( e => stringFormat(focusListFormat, e) ) ); entriesView.setFocusItems(this.entries.map( e => stringFormat(focusListFormat, e) ) );
}; }
displayBBSList(clearScreen, cb) {
const self = this;
this.displayBBSList = function(clearScreen, cb) {
async.waterfall( async.waterfall(
[ [
function clearAndDisplayArt(callback) { function clearAndDisplayArt(callback) {
@ -135,7 +227,7 @@ function BBSListModule(options) {
self.client.term.rawWrite(ansi.resetScreen()); self.client.term.rawWrite(ansi.resetScreen());
} }
theme.displayThemedAsset( theme.displayThemedAsset(
config.art.entries, self.menuConfig.config.art.entries,
self.client, self.client,
{ font : self.menuConfig.font, trailingLF : false }, { font : self.menuConfig.font, trailingLF : false },
(err, artData) => { (err, artData) => {
@ -238,9 +330,11 @@ function BBSListModule(options) {
} }
} }
); );
}; }
displayAddScreen(cb) {
const self = this;
this.displayAddScreen = function(cb) {
async.waterfall( async.waterfall(
[ [
function clearAndDisplayArt(callback) { function clearAndDisplayArt(callback) {
@ -248,7 +342,7 @@ function BBSListModule(options) {
self.client.term.rawWrite(ansi.resetScreen()); self.client.term.rawWrite(ansi.resetScreen());
theme.displayThemedAsset( theme.displayThemedAsset(
config.art.add, self.menuConfig.config.art.add,
self.client, self.client,
{ font : self.menuConfig.font }, { font : self.menuConfig.font },
(err, artData) => { (err, artData) => {
@ -284,117 +378,17 @@ function BBSListModule(options) {
} }
} }
); );
}; }
this.clearAddForm = function() { clearAddForm() {
[ 'BBSName', 'Sysop', 'Telnet', 'Www', 'Location', 'Software', 'Error', 'Notes' ].forEach( mciName => { [ 'BBSName', 'Sysop', 'Telnet', 'Www', 'Location', 'Software', 'Error', 'Notes' ].forEach( mciName => {
const v = self.viewControllers.add.getView(MciViewIds.add[mciName]); this.setViewText('add', MciViewIds.add[mciName], '');
if(v) {
v.setText('');
}
}); });
};
this.menuMethods = {
//
// Validators
//
viewValidationListener : function(err, cb) {
const errMsgView = self.viewControllers.add.getView(MciViewIds.add.Error);
if(errMsgView) {
if(err) {
errMsgView.setText(err.message);
} else {
errMsgView.clearText();
}
} }
return cb(null); initDatabase(cb) {
}, const self = this;
//
// Key & submit handlers
//
addBBS : function(formData, extraArgs, cb) {
self.displayAddScreen(cb);
},
deleteBBS : function(formData, extraArgs, cb) {
const entriesView = self.viewControllers.view.getView(MciViewIds.view.BBSList);
if(self.entries[self.selectedBBS].submitterUserId !== self.client.user.userId && !self.client.user.isSysOp()) {
// must be owner or +op
return cb(null);
}
const entry = self.entries[self.selectedBBS];
if(!entry) {
return cb(null);
}
self.database.run(
`DELETE FROM bbs_list
WHERE id=?;`,
[ entry.id ],
err => {
if (err) {
self.client.log.error( { err : err }, 'Error deleting from BBS list');
} else {
self.entries.splice(self.selectedBBS, 1);
self.setEntries(entriesView);
if(self.entries.length > 0) {
entriesView.focusPrevious();
}
self.viewControllers.view.redrawAll();
}
return cb(null);
}
);
},
submitBBS : function(formData, extraArgs, cb) {
let ok = true;
[ 'BBSName', 'Sysop', 'Telnet' ].forEach( mciName => {
if('' === self.viewControllers.add.getView(MciViewIds.add[mciName]).getData()) {
ok = false;
}
});
if(!ok) {
// validators should prevent this!
return cb(null);
}
self.database.run(
`INSERT INTO bbs_list (bbs_name, sysop, telnet, www, location, software, submitter_user_id, notes)
VALUES(?, ?, ?, ?, ?, ?, ?, ?);`,
[ formData.value.name, formData.value.sysop, formData.value.telnet, formData.value.www, formData.value.location, formData.value.software, self.client.user.userId, formData.value.notes ],
err => {
if(err) {
self.client.log.error( { err : err }, 'Error adding to BBS list');
}
self.clearAddForm();
self.displayBBSList(true, cb);
}
);
},
cancelSubmit : function(formData, extraArgs, cb) {
self.clearAddForm();
self.displayBBSList(true, cb);
}
};
this.setViewText = function(id, text) {
var v = self.viewControllers.view.getView(id);
if(v) {
v.setText(text);
}
};
this.initDatabase = function(cb) {
async.series( async.series(
[ [
function openDatabase(callback) { function openDatabase(callback) {
@ -422,15 +416,15 @@ function BBSListModule(options) {
callback(null); callback(null);
} }
], ],
cb err => {
return cb(err);
}
); );
}; }
}
require('util').inherits(BBSListModule, MenuModule); beforeArt(cb) {
super.beforeArt(err => {
BBSListModule.prototype.beforeArt = function(cb) {
BBSListModule.super_.prototype.beforeArt.call(this, err => {
return err ? cb(err) : this.initDatabase(cb); return err ? cb(err) : this.initDatabase(cb);
}); });
}
}; };

5
mods/erc_client.js
View file

@ -1,7 +1,7 @@
/* jslint node: true */ /* jslint node: true */
'use strict'; 'use strict';
var MenuModule = require('../core/menu_module.js').MenuModule; const MenuModule = require('../core/menu_module.js').MenuModule;
const stringFormat = require('../core/string_format.js'); const stringFormat = require('../core/string_format.js');
// deps // deps
@ -33,8 +33,9 @@ var MciViewIds = {
InputArea : 3, InputArea : 3,
}; };
// :TODO: needs converted to ES6 MenuModule subclass
function ErcClientModule(options) { function ErcClientModule(options) {
MenuModule.call(this, options); MenuModule.prototype.ctorShim.call(this, options);
const self = this; const self = this;
this.config = options.menuConfig.config; this.config = options.menuConfig.config;

3
mods/file_base_download_manager.js
View file

@ -80,10 +80,7 @@ exports.getModule = class FileBaseDownloadQueueManager extends MenuModule {
} }
// Simply an empty D/L queue: Present a specialized "empty queue" page // Simply an empty D/L queue: Present a specialized "empty queue" page
// :TODO: This technique can be applied in many areas of the code; probablly need a better name than 'popAndGotoMenu' though
// ...actually, the option to not append to the stack would be better here
return this.gotoMenu(this.menuConfig.config.emptyQueueMenu || 'fileBaseDownloadManagerEmptyQueue'); return this.gotoMenu(this.menuConfig.config.emptyQueueMenu || 'fileBaseDownloadManagerEmptyQueue');
//return this.popAndGotoMenu(this.menuConfig.config.emptyQueueMenu || 'fileBaseDownloadManagerEmptyQueue');
} }
const self = this; const self = this;

23
mods/last_callers.js
View file

@ -32,19 +32,21 @@ exports.moduleInfo = {
packageName : 'codes.l33t.enigma.lastcallers' // :TODO: concept idea for mods packageName : 'codes.l33t.enigma.lastcallers' // :TODO: concept idea for mods
}; };
exports.getModule = LastCallersModule; const MciCodeIds = {
var MciCodeIds = {
CallerList : 1, CallerList : 1,
}; };
function LastCallersModule(options) { exports.getModule = class LastCallersModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
} super(options);
}
require('util').inherits(LastCallersModule, MenuModule); mciReady(mciData, cb) {
super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
LastCallersModule.prototype.mciReady = function(mciData, cb) {
const self = this; const self = this;
const vc = self.viewControllers.allViews = new ViewController( { client : self.client } ); const vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
@ -53,9 +55,6 @@ LastCallersModule.prototype.mciReady = function(mciData, cb) {
async.series( async.series(
[ [
function callParentMciReady(callback) {
LastCallersModule.super_.prototype.mciReady.call(self, mciData, callback);
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
const loadOpts = { const loadOpts = {
callingMenu : self, callingMenu : self,
@ -139,4 +138,6 @@ LastCallersModule.prototype.mciReady = function(mciData, cb) {
cb(err); cb(err);
} }
); );
});
}
}; };

59
mods/msg_area_list.js
View file

@ -14,8 +14,6 @@ const stringFormat = require('../core/string_format.js');
const async = require('async'); const async = require('async');
const _ = require('lodash'); const _ = require('lodash');
exports.getModule = MessageAreaListModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Message Area List', name : 'Message Area List',
desc : 'Module for listing / choosing message areas', desc : 'Module for listing / choosing message areas',
@ -36,28 +34,22 @@ exports.moduleInfo = {
|TI Current time |TI Current time
*/ */
const MCICodesIDs = { const MciViewIds = {
AreaList : 1, AreaList : 1,
SelAreaInfo1 : 2, SelAreaInfo1 : 2,
SelAreaInfo2 : 3, SelAreaInfo2 : 3,
}; };
function MessageAreaListModule(options) { exports.getModule = class MessageAreaListModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
super(options);
var self = this;
this.messageAreas = messageArea.getSortedAvailMessageAreasByConfTag( this.messageAreas = messageArea.getSortedAvailMessageAreasByConfTag(
self.client.user.properties.message_conf_tag, this.client.user.properties.message_conf_tag,
{ client : self.client } { client : this.client }
); );
this.prevMenuOnTimeout = function(timeout, cb) { const self = this;
setTimeout( () => {
self.prevMenu(cb);
}, timeout);
};
this.menuMethods = { this.menuMethods = {
changeArea : function(formData, extraArgs, cb) { changeArea : function(formData, extraArgs, cb) {
if(1 === formData.submitId) { if(1 === formData.submitId) {
@ -100,42 +92,39 @@ function MessageAreaListModule(options) {
} }
} }
}; };
this.setViewText = function(id, text) {
const v = self.viewControllers.areaList.getView(id);
if(v) {
v.setText(text);
} }
};
this.updateGeneralAreaInfoViews = function(areaIndex) { prevMenuOnTimeout(timeout, cb) {
setTimeout( () => {
return this.prevMenu(cb);
}, timeout);
}
updateGeneralAreaInfoViews(areaIndex) {
// :TODO: these concepts have been replaced with the {someKey} style formatting - update me!
/* experimental: not yet avail /* experimental: not yet avail
const areaInfo = self.messageAreas[areaIndex]; const areaInfo = self.messageAreas[areaIndex];
[ MCICodesIDs.SelAreaInfo1, MCICodesIDs.SelAreaInfo2 ].forEach(mciId => { [ MciViewIds.SelAreaInfo1, MciViewIds.SelAreaInfo2 ].forEach(mciId => {
const v = self.viewControllers.areaList.getView(mciId); const v = self.viewControllers.areaList.getView(mciId);
if(v) { if(v) {
v.setFormatObject(areaInfo.area); v.setFormatObject(areaInfo.area);
} }
}); });
*/ */
}; }
} mciReady(mciData, cb) {
super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
require('util').inherits(MessageAreaListModule, MenuModule);
MessageAreaListModule.prototype.mciReady = function(mciData, cb) {
const self = this; const self = this;
const vc = self.viewControllers.areaList = new ViewController( { client : self.client } ); const vc = self.viewControllers.areaList = new ViewController( { client : self.client } );
async.series( async.series(
[ [
function callParentMciReady(callback) {
MessageAreaListModule.super_.prototype.mciReady.call(this, mciData, function parentMciReady(err) {
callback(err);
});
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
const loadOpts = { const loadOpts = {
callingMenu : self, callingMenu : self,
@ -151,7 +140,7 @@ MessageAreaListModule.prototype.mciReady = function(mciData, cb) {
const listFormat = self.menuConfig.config.listFormat || '{index} ) - {name}'; const listFormat = self.menuConfig.config.listFormat || '{index} ) - {name}';
const focusListFormat = self.menuConfig.config.focusListFormat || listFormat; const focusListFormat = self.menuConfig.config.focusListFormat || listFormat;
const areaListView = vc.getView(MCICodesIDs.AreaList); const areaListView = vc.getView(MciViewIds.AreaList);
let i = 1; let i = 1;
areaListView.setItems(_.map(self.messageAreas, v => { areaListView.setItems(_.map(self.messageAreas, v => {
return stringFormat(listFormat, { return stringFormat(listFormat, {
@ -185,4 +174,6 @@ MessageAreaListModule.prototype.mciReady = function(mciData, cb) {
return cb(err); return cb(err);
} }
); );
});
}
}; };

29
mods/msg_area_post_fse.js
View file

@ -1,15 +1,11 @@
/* jslint node: true */ /* jslint node: true */
'use strict'; 'use strict';
let FullScreenEditorModule = require('../core/fse.js').FullScreenEditorModule; const FullScreenEditorModule = require('../core/fse.js').FullScreenEditorModule;
//var Message = require('../core/message.js').Message; const persistMessage = require('../core/message_area.js').persistMessage;
let persistMessage = require('../core/message_area.js').persistMessage;
let user = require('../core/user.js');
let _ = require('lodash'); const _ = require('lodash');
let async = require('async'); const async = require('async');
exports.getModule = AreaPostFSEModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Message Area Post', name : 'Message Area Post',
@ -17,10 +13,11 @@ exports.moduleInfo = {
author : 'NuSkooler', author : 'NuSkooler',
}; };
function AreaPostFSEModule(options) { exports.getModule = class AreaPostFSEModule extends FullScreenEditorModule {
FullScreenEditorModule.call(this, options); constructor(options) {
super(options);
var self = this; const self = this;
// we're posting, so always start with 'edit' mode // we're posting, so always start with 'edit' mode
this.editorMode = 'edit'; this.editorMode = 'edit';
@ -58,15 +55,13 @@ function AreaPostFSEModule(options) {
} }
); );
}; };
} }
require('util').inherits(AreaPostFSEModule, FullScreenEditorModule);
AreaPostFSEModule.prototype.enter = function() {
enter() {
if(_.isString(this.client.user.properties.message_area_tag) && !_.isString(this.messageAreaTag)) { if(_.isString(this.client.user.properties.message_area_tag) && !_.isString(this.messageAreaTag)) {
this.messageAreaTag = this.client.user.properties.message_area_tag; this.messageAreaTag = this.client.user.properties.message_area_tag;
} }
AreaPostFSEModule.super_.prototype.enter.call(this); super.enter();
}
}; };

61
mods/msg_area_view_fse.js
View file

@ -8,18 +8,15 @@ const Message = require('../core/message.js');
// deps // deps
const _ = require('lodash'); const _ = require('lodash');
exports.getModule = AreaViewFSEModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Message Area View', name : 'Message Area View',
desc : 'Module for viewing an area message', desc : 'Module for viewing an area message',
author : 'NuSkooler', author : 'NuSkooler',
}; };
function AreaViewFSEModule(options) { exports.getModule = class AreaViewFSEModule extends FullScreenEditorModule {
FullScreenEditorModule.call(this, options); constructor(options) {
super(options);
const self = this;
this.editorType = 'area'; this.editorType = 'area';
this.editorMode = 'view'; this.editorMode = 'view';
@ -33,7 +30,10 @@ function AreaViewFSEModule(options) {
this.messageIndex = this.messageIndex || 0; this.messageIndex = this.messageIndex || 0;
this.messageTotal = this.messageList.length; this.messageTotal = this.messageList.length;
this.menuMethods.nextMessage = function(formData, extraArgs, cb) { const self = this;
this.menuMethods = {
nextMessage : (formData, extraArgs, cb) => {
if(self.messageIndex + 1 < self.messageList.length) { if(self.messageIndex + 1 < self.messageList.length) {
self.messageIndex++; self.messageIndex++;
@ -41,9 +41,9 @@ function AreaViewFSEModule(options) {
} }
return cb(null); return cb(null);
}; },
this.menuMethods.prevMessage = function(formData, extraArgs, cb) { prevMessage : (formData, extraArgs, cb) => {
if(self.messageIndex > 0) { if(self.messageIndex > 0) {
self.messageIndex--; self.messageIndex--;
@ -51,9 +51,9 @@ function AreaViewFSEModule(options) {
} }
return cb(null); return cb(null);
}; },
this.menuMethods.movementKeyPressed = function(formData, extraArgs, cb) { movementKeyPressed : (formData, extraArgs, cb) => {
const bodyView = self.viewControllers.body.getView(1); // :TODO: use const here vs magic # const bodyView = self.viewControllers.body.getView(1); // :TODO: use const here vs magic #
// :TODO: Create methods for up/down vs using keyPressXXXXX // :TODO: Create methods for up/down vs using keyPressXXXXX
@ -68,10 +68,9 @@ function AreaViewFSEModule(options) {
// visible page off the screen at all .... this should be handled by MLTEV though... // visible page off the screen at all .... this should be handled by MLTEV though...
return cb(null); return cb(null);
},
}; replyMessage : (formData, extraArgs, cb) => {
this.menuMethods.replyMessage = function(formData, extraArgs, cb) {
if(_.isString(extraArgs.menu)) { if(_.isString(extraArgs.menu)) {
const modOpts = { const modOpts = {
extraArgs : { extraArgs : {
@ -85,45 +84,41 @@ function AreaViewFSEModule(options) {
self.client.log(extraArgs, 'Missing extraArgs.menu'); self.client.log(extraArgs, 'Missing extraArgs.menu');
return cb(null); return cb(null);
}
}; };
}
this.loadMessageByUuid = function(uuid, cb) {
loadMessageByUuid(uuid, cb) {
const msg = new Message(); const msg = new Message();
msg.load( { uuid : uuid, user : self.client.user }, () => { msg.load( { uuid : uuid, user : this.client.user }, () => {
self.setMessage(msg); this.setMessage(msg);
if(cb) { if(cb) {
return cb(null); return cb(null);
} }
}); });
}; }
}
require('util').inherits(AreaViewFSEModule, FullScreenEditorModule); finishedLoading() {
AreaViewFSEModule.prototype.finishedLoading = function() {
if(this.messageList.length) {
this.loadMessageByUuid(this.messageList[this.messageIndex].messageUuid); this.loadMessageByUuid(this.messageList[this.messageIndex].messageUuid);
} }
};
AreaViewFSEModule.prototype.getSaveState = function() {
AreaViewFSEModule.super_.prototype.getSaveState.call(this);
getSaveState() {
return { return {
messageList : this.messageList, messageList : this.messageList,
messageIndex : this.messageIndex, messageIndex : this.messageIndex,
messageTotal : this.messageList.length, messageTotal : this.messageList.length,
}; };
}; }
AreaViewFSEModule.prototype.restoreSavedState = function(savedState) {
AreaViewFSEModule.super_.prototype.restoreSavedState.call(this, savedState);
restoreSavedState(savedState) {
this.messageList = savedState.messageList; this.messageList = savedState.messageList;
this.messageIndex = savedState.messageIndex; this.messageIndex = savedState.messageIndex;
this.messageTotal = savedState.messageTotal; this.messageTotal = savedState.messageTotal;
}; }
AreaViewFSEModule.prototype.getMenuResult = function() { getMenuResult() {
return this.messageIndex; return this.messageIndex;
}
}; };

49
mods/msg_conf_list.js
View file

@ -14,15 +14,13 @@ const stringFormat = require('../core/string_format.js');
const async = require('async'); const async = require('async');
const _ = require('lodash'); const _ = require('lodash');
exports.getModule = MessageConfListModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Message Conference List', name : 'Message Conference List',
desc : 'Module for listing / choosing message conferences', desc : 'Module for listing / choosing message conferences',
author : 'NuSkooler', author : 'NuSkooler',
}; };
const MCICodeIDs = { const MciViewIds = {
ConfList : 1, ConfList : 1,
// :TODO: // :TODO:
@ -30,18 +28,12 @@ const MCICodeIDs = {
// //
}; };
function MessageConfListModule(options) { exports.getModule = class MessageConfListModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
super(options);
var self = this; this.messageConfs = messageArea.getSortedAvailMessageConferences(this.client);
const self = this;
this.messageConfs = messageArea.getSortedAvailMessageConferences(self.client);
this.prevMenuOnTimeout = function(timeout, cb) {
setTimeout( () => {
self.prevMenu(cb);
}, timeout);
};
this.menuMethods = { this.menuMethods = {
changeConference : function(formData, extraArgs, cb) { changeConference : function(formData, extraArgs, cb) {
@ -87,26 +79,25 @@ function MessageConfListModule(options) {
} }
} }
}; };
this.setViewText = function(id, text) {
const v = self.viewControllers.areaList.getView(id);
if(v) {
v.setText(text);
} }
};
}
require('util').inherits(MessageConfListModule, MenuModule); prevMenuOnTimeout(timeout, cb) {
setTimeout( () => {
return this.prevMenu(cb);
}, timeout);
}
MessageConfListModule.prototype.mciReady = function(mciData, cb) { mciReady(mciData, cb) {
var self = this; super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
const self = this;
const vc = self.viewControllers.areaList = new ViewController( { client : self.client } ); const vc = self.viewControllers.areaList = new ViewController( { client : self.client } );
async.series( async.series(
[ [
function callParentMciReady(callback) {
MessageConfListModule.super_.prototype.mciReady.call(this, mciData, callback);
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
let loadOpts = { let loadOpts = {
callingMenu : self, callingMenu : self,
@ -120,7 +111,7 @@ MessageConfListModule.prototype.mciReady = function(mciData, cb) {
const listFormat = self.menuConfig.config.listFormat || '{index} ) - {name}'; const listFormat = self.menuConfig.config.listFormat || '{index} ) - {name}';
const focusListFormat = self.menuConfig.config.focusListFormat || listFormat; const focusListFormat = self.menuConfig.config.focusListFormat || listFormat;
const confListView = vc.getView(MCICodeIDs.ConfList); const confListView = vc.getView(MciViewIds.ConfList);
let i = 1; let i = 1;
confListView.setItems(_.map(self.messageConfs, v => { confListView.setItems(_.map(self.messageConfs, v => {
return stringFormat(listFormat, { return stringFormat(listFormat, {
@ -154,4 +145,6 @@ MessageConfListModule.prototype.mciReady = function(mciData, cb) {
cb(err); cb(err);
} }
); );
});
}
}; };

56
mods/msg_list.js
View file

@ -6,6 +6,7 @@ const MenuModule = require('../core/menu_module.js').MenuModule;
const ViewController = require('../core/view_controller.js').ViewController; const ViewController = require('../core/view_controller.js').ViewController;
const messageArea = require('../core/message_area.js'); const messageArea = require('../core/message_area.js');
const stringFormat = require('../core/string_format.js'); const stringFormat = require('../core/string_format.js');
const MessageAreaConfTempSwitcher = require('../core/mod_mixins.js').MessageAreaConfTempSwitcher;
// deps // deps
const async = require('async'); const async = require('async');
@ -28,8 +29,6 @@ const moment = require('moment');
TL2 : Message info 1: { msgNumSelected, msgNumTotal } TL2 : Message info 1: { msgNumSelected, msgNumTotal }
*/ */
exports.getModule = MessageListModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Message List', name : 'Message List',
desc : 'Module for listing/browsing available messages', desc : 'Module for listing/browsing available messages',
@ -41,8 +40,9 @@ const MCICodesIDs = {
MsgInfo1 : 2, // TL2 MsgInfo1 : 2, // TL2
}; };
function MessageListModule(options) { exports.getModule = class MessageListModule extends MessageAreaConfTempSwitcher(MenuModule) {
MenuModule.call(this, options); constructor(options) {
super(options);
const self = this; const self = this;
const config = this.menuConfig.config; const config = this.menuConfig.config;
@ -104,21 +104,10 @@ function MessageListModule(options) {
return self.prevMenu(cb); return self.prevMenu(cb);
} }
}; };
this.setViewText = function(id, text) {
const v = self.viewControllers.allViews.getView(id);
if(v) {
v.setText(text);
} }
};
}
require('util').inherits(MessageListModule, MenuModule); enter() {
super.enter();
require('../core/mod_mixins.js').MessageAreaConfTempSwitcher.call(MessageListModule.prototype);
MessageListModule.prototype.enter = function() {
MessageListModule.super_.prototype.enter.call(this);
// //
// Config can specify |messageAreaTag| else it comes from // Config can specify |messageAreaTag| else it comes from
@ -129,23 +118,24 @@ MessageListModule.prototype.enter = function() {
} else { } else {
this.messageAreaTag = this.client.user.properties.message_area_tag; this.messageAreaTag = this.client.user.properties.message_area_tag;
} }
}; }
MessageListModule.prototype.leave = function() { leave() {
this.tempMessageConfAndAreaRestore(); this.tempMessageConfAndAreaRestore();
super.leave();
}
MessageListModule.super_.prototype.leave.call(this); mciReady(mciData, cb) {
}; super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
MessageListModule.prototype.mciReady = function(mciData, cb) {
const self = this; const self = this;
const vc = self.viewControllers.allViews = new ViewController( { client : self.client } ); const vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
async.series( async.series(
[ [
function callParentMciReady(callback) {
MessageListModule.super_.prototype.mciReady.call(self, mciData, callback);
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
const loadOpts = { const loadOpts = {
callingMenu : self, callingMenu : self,
@ -213,6 +203,7 @@ MessageListModule.prototype.mciReady = function(mciData, cb) {
msgListView.on('index update', idx => { msgListView.on('index update', idx => {
self.setViewText( self.setViewText(
'allViews',
MCICodesIDs.MsgInfo1, MCICodesIDs.MsgInfo1,
stringFormat(messageInfo1Format, { msgNumSelected : (idx + 1), msgNumTotal : self.messageList.length } )); stringFormat(messageInfo1Format, { msgNumSelected : (idx + 1), msgNumTotal : self.messageList.length } ));
}); });
@ -229,6 +220,7 @@ MessageListModule.prototype.mciReady = function(mciData, cb) {
function drawOtherViews(callback) { function drawOtherViews(callback) {
const messageInfo1Format = self.menuConfig.config.messageInfo1Format || '{msgNumSelected} / {msgNumTotal}'; const messageInfo1Format = self.menuConfig.config.messageInfo1Format || '{msgNumSelected} / {msgNumTotal}';
self.setViewText( self.setViewText(
'allViews',
MCICodesIDs.MsgInfo1, MCICodesIDs.MsgInfo1,
stringFormat(messageInfo1Format, { msgNumSelected : self.initialFocusIndex + 1, msgNumTotal : self.messageList.length } )); stringFormat(messageInfo1Format, { msgNumSelected : self.initialFocusIndex + 1, msgNumTotal : self.messageList.length } ));
return callback(null); return callback(null);
@ -241,18 +233,20 @@ MessageListModule.prototype.mciReady = function(mciData, cb) {
return cb(err); return cb(err);
} }
); );
}; });
}
MessageListModule.prototype.getSaveState = function() { getSaveState() {
return { initialFocusIndex : this.initialFocusIndex }; return { initialFocusIndex : this.initialFocusIndex };
}; }
MessageListModule.prototype.restoreSavedState = function(savedState) { restoreSavedState(savedState) {
if(savedState) { if(savedState) {
this.initialFocusIndex = savedState.initialFocusIndex; this.initialFocusIndex = savedState.initialFocusIndex;
} }
}; }
MessageListModule.prototype.getMenuResult = function() { getMenuResult() {
return this.menuResult; return this.menuResult;
}
}; };

17
mods/nua.js
View file

@ -9,8 +9,6 @@ const login = require('../core/system_menu_method.js').login;
const Config = require('../core/config.js').config; const Config = require('../core/config.js').config;
const messageArea = require('../core/message_area.js'); const messageArea = require('../core/message_area.js');
exports.getModule = NewUserAppModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'NUA', name : 'NUA',
desc : 'New User Application', desc : 'New User Application',
@ -23,8 +21,10 @@ const MciViewIds = {
errMsg : 11, errMsg : 11,
}; };
function NewUserAppModule(options) { exports.getModule = class NewUserAppModule extends MenuModule {
MenuModule.call(this, options);
constructor(options) {
super(options);
const self = this; const self = this;
@ -136,10 +136,9 @@ function NewUserAppModule(options) {
}); });
}, },
}; };
} }
require('util').inherits(NewUserAppModule, MenuModule); mciReady(mciData, cb) {
return this.standardMCIReadyHandler(mciData, cb);
NewUserAppModule.prototype.mciReady = function(mciData, cb) { }
this.standardMCIReadyHandler(mciData, cb);
}; };

396
mods/onelinerz.js
View file

@ -31,9 +31,7 @@ exports.moduleInfo = {
packageName : 'codes.l33t.enigma.onelinerz', packageName : 'codes.l33t.enigma.onelinerz',
}; };
exports.getModule = OnelinerzModule; const MciViewIds = {
const MciCodeIds = {
ViewForm : { ViewForm : {
Entries : 1, Entries : 1,
AddPrompt : 2, AddPrompt : 2,
@ -50,185 +48,11 @@ const FormIds = {
Add : 1, Add : 1,
}; };
function OnelinerzModule(options) { exports.getModule = class OnelinerzModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
super(options);
const self = this; const self = this;
const config = this.menuConfig.config;
this.initSequence = function() {
async.series(
[
function beforeDisplayArt(callback) {
self.beforeArt(callback);
},
function display(callback) {
self.displayViewScreen(false, callback);
}
],
err => {
if(err) {
// :TODO: Handle me -- initSequence() should really take a completion callback
}
self.finishedLoading();
}
);
};
this.displayViewScreen = function(clearScreen, cb) {
async.waterfall(
[
function clearAndDisplayArt(callback) {
if(self.viewControllers.add) {
self.viewControllers.add.setFocus(false);
}
if(clearScreen) {
self.client.term.rawWrite(ansi.resetScreen());
}
theme.displayThemedAsset(
config.art.entries,
self.client,
{ font : self.menuConfig.font, trailingLF : false },
(err, artData) => {
return callback(err, artData);
}
);
},
function initOrRedrawViewController(artData, callback) {
if(_.isUndefined(self.viewControllers.add)) {
const vc = self.addViewController(
'view',
new ViewController( { client : self.client, formId : FormIds.View } )
);
const loadOpts = {
callingMenu : self,
mciMap : artData.mciMap,
formId : FormIds.View,
};
return vc.loadFromMenuConfig(loadOpts, callback);
} else {
self.viewControllers.view.setFocus(true);
self.viewControllers.view.getView(MciCodeIds.ViewForm.AddPrompt).redraw();
return callback(null);
}
},
function fetchEntries(callback) {
const entriesView = self.viewControllers.view.getView(MciCodeIds.ViewForm.Entries);
const limit = entriesView.dimens.height;
let entries = [];
self.db.each(
`SELECT *
FROM (
SELECT *
FROM onelinerz
ORDER BY timestamp DESC
LIMIT ${limit}
)
ORDER BY timestamp ASC;`,
(err, row) => {
if(!err) {
row.timestamp = moment(row.timestamp); // convert -> moment
entries.push(row);
}
},
err => {
return callback(err, entriesView, entries);
}
);
},
function populateEntries(entriesView, entries, callback) {
const listFormat = config.listFormat || '{username}@{ts}: {oneliner}';// :TODO: should be userName to be consistent
const tsFormat = config.timestampFormat || 'ddd h:mma';
entriesView.setItems(entries.map( e => {
return stringFormat(listFormat, {
userId : e.user_id,
username : e.user_name,
oneliner : e.oneliner,
ts : e.timestamp.format(tsFormat),
} );
}));
entriesView.redraw();
return callback(null);
},
function finalPrep(callback) {
const promptView = self.viewControllers.view.getView(MciCodeIds.ViewForm.AddPrompt);
promptView.setFocusItemIndex(1); // default to NO
return callback(null);
}
],
err => {
if(cb) {
return cb(err);
}
}
);
};
this.displayAddScreen = function(cb) {
async.waterfall(
[
function clearAndDisplayArt(callback) {
self.viewControllers.view.setFocus(false);
self.client.term.rawWrite(ansi.resetScreen());
theme.displayThemedAsset(
config.art.add,
self.client,
{ font : self.menuConfig.font },
(err, artData) => {
return callback(err, artData);
}
);
},
function initOrRedrawViewController(artData, callback) {
if(_.isUndefined(self.viewControllers.add)) {
const vc = self.addViewController(
'add',
new ViewController( { client : self.client, formId : FormIds.Add } )
);
const loadOpts = {
callingMenu : self,
mciMap : artData.mciMap,
formId : FormIds.Add,
};
return vc.loadFromMenuConfig(loadOpts, callback);
} else {
self.viewControllers.add.setFocus(true);
self.viewControllers.add.redrawAll();
self.viewControllers.add.switchFocus(MciCodeIds.AddForm.NewEntry);
return callback(null);
}
}
],
err => {
if(cb) {
return cb(err);
}
}
);
};
this.clearAddForm = function() {
const newEntryView = self.viewControllers.add.getView(MciCodeIds.AddForm.NewEntry);
const previewView = self.viewControllers.add.getView(MciCodeIds.AddForm.EntryPreview);
newEntryView.setText('');
// preview is optional
if(previewView) {
previewView.setText('');
}
};
this.menuMethods = { this.menuMethods = {
viewAddScreen : function(formData, extraArgs, cb) { viewAddScreen : function(formData, extraArgs, cb) {
@ -259,18 +83,194 @@ function OnelinerzModule(options) {
return self.displayViewScreen(true, cb); // true=cls return self.displayViewScreen(true, cb); // true=cls
} }
}; };
}
initSequence() {
const self = this;
async.series(
[
function beforeDisplayArt(callback) {
return self.beforeArt(callback);
},
function display(callback) {
return self.displayViewScreen(false, callback);
}
],
err => {
if(err) {
// :TODO: Handle me -- initSequence() should really take a completion callback
}
self.finishedLoading();
}
);
}
displayViewScreen(clearScreen, cb) {
const self = this;
async.waterfall(
[
function clearAndDisplayArt(callback) {
if(self.viewControllers.add) {
self.viewControllers.add.setFocus(false);
}
if(clearScreen) {
self.client.term.rawWrite(ansi.resetScreen());
}
theme.displayThemedAsset(
self.menuConfig.config.art.entries,
self.client,
{ font : self.menuConfig.font, trailingLF : false },
(err, artData) => {
return callback(err, artData);
}
);
},
function initOrRedrawViewController(artData, callback) {
if(_.isUndefined(self.viewControllers.add)) {
const vc = self.addViewController(
'view',
new ViewController( { client : self.client, formId : FormIds.View } )
);
const loadOpts = {
callingMenu : self,
mciMap : artData.mciMap,
formId : FormIds.View,
};
return vc.loadFromMenuConfig(loadOpts, callback);
} else {
self.viewControllers.view.setFocus(true);
self.viewControllers.view.getView(MciViewIds.ViewForm.AddPrompt).redraw();
return callback(null);
}
},
function fetchEntries(callback) {
const entriesView = self.viewControllers.view.getView(MciViewIds.ViewForm.Entries);
const limit = entriesView.dimens.height;
let entries = [];
self.db.each(
`SELECT *
FROM (
SELECT *
FROM onelinerz
ORDER BY timestamp DESC
LIMIT ${limit}
)
ORDER BY timestamp ASC;`,
(err, row) => {
if(!err) {
row.timestamp = moment(row.timestamp); // convert -> moment
entries.push(row);
}
},
err => {
return callback(err, entriesView, entries);
}
);
},
function populateEntries(entriesView, entries, callback) {
const listFormat = self.menuConfig.config.listFormat || '{username}@{ts}: {oneliner}';// :TODO: should be userName to be consistent
const tsFormat = self.menuConfig.config.timestampFormat || 'ddd h:mma';
entriesView.setItems(entries.map( e => {
return stringFormat(listFormat, {
userId : e.user_id,
username : e.user_name,
oneliner : e.oneliner,
ts : e.timestamp.format(tsFormat),
} );
}));
entriesView.redraw();
return callback(null);
},
function finalPrep(callback) {
const promptView = self.viewControllers.view.getView(MciViewIds.ViewForm.AddPrompt);
promptView.setFocusItemIndex(1); // default to NO
return callback(null);
}
],
err => {
if(cb) {
return cb(err);
}
}
);
}
displayAddScreen(cb) {
const self = this;
async.waterfall(
[
function clearAndDisplayArt(callback) {
self.viewControllers.view.setFocus(false);
self.client.term.rawWrite(ansi.resetScreen());
theme.displayThemedAsset(
self.menuConfig.config.art.add,
self.client,
{ font : self.menuConfig.font },
(err, artData) => {
return callback(err, artData);
}
);
},
function initOrRedrawViewController(artData, callback) {
if(_.isUndefined(self.viewControllers.add)) {
const vc = self.addViewController(
'add',
new ViewController( { client : self.client, formId : FormIds.Add } )
);
const loadOpts = {
callingMenu : self,
mciMap : artData.mciMap,
formId : FormIds.Add,
};
return vc.loadFromMenuConfig(loadOpts, callback);
} else {
self.viewControllers.add.setFocus(true);
self.viewControllers.add.redrawAll();
self.viewControllers.add.switchFocus(MciViewIds.AddForm.NewEntry);
return callback(null);
}
}
],
err => {
if(cb) {
return cb(err);
}
}
);
}
clearAddForm() {
this.setViewText('add', MciViewIds.AddForm.NewEntry, '');
this.setViewText('add', MciViewIds.AddForm.EntryPreview, '');
}
initDatabase(cb) {
const self = this;
this.initDatabase = function(cb) {
async.series( async.series(
[ [
function openDatabase(callback) { function openDatabase(callback) {
self.db = new sqlite3.Database( self.db = new sqlite3.Database(
getModDatabasePath(exports.moduleInfo), getModDatabasePath(exports.moduleInfo),
callback err => {
return callback(err);
}
); );
}, },
function createTables(callback) { function createTables(callback) {
self.db.serialize( () => {
self.db.run( self.db.run(
`CREATE TABLE IF NOT EXISTS onelinerz ( `CREATE TABLE IF NOT EXISTS onelinerz (
id INTEGER PRIMARY KEY, id INTEGER PRIMARY KEY,
@ -278,17 +278,21 @@ function OnelinerzModule(options) {
user_name VARCHAR NOT NULL, user_name VARCHAR NOT NULL,
oneliner VARCHAR NOT NULL, oneliner VARCHAR NOT NULL,
timestamp DATETIME NOT NULL timestamp DATETIME NOT NULL
)` );`
); ,
err => {
return callback(err);
}); });
callback(null);
} }
], ],
cb err => {
return cb(err);
}
); );
}; }
this.storeNewOneliner = function(oneliner, cb) { storeNewOneliner(oneliner, cb) {
const self = this;
const ts = moment().format('YYYY-MM-DDTHH:mm:ss.SSSZ'); const ts = moment().format('YYYY-MM-DDTHH:mm:ss.SSSZ');
async.series( async.series(
@ -315,15 +319,15 @@ function OnelinerzModule(options) {
); );
} }
], ],
cb err => {
return cb(err);
}
); );
}; }
}
require('util').inherits(OnelinerzModule, MenuModule); beforeArt(cb) {
super.beforeArt(err => {
OnelinerzModule.prototype.beforeArt = function(cb) {
OnelinerzModule.super_.prototype.beforeArt.call(this, err => {
return err ? cb(err) : this.initDatabase(cb); return err ? cb(err) : this.initDatabase(cb);
}); });
}
}; };

21
mods/telnet_bridge.js
View file

@ -27,9 +27,6 @@ const buffers = require('buffers');
*/ */
// :TODO: ENH: Support nodeMax and tooManyArt // :TODO: ENH: Support nodeMax and tooManyArt
exports.getModule = TelnetBridgeModule;
exports.moduleInfo = { exports.moduleInfo = {
name : 'Telnet Bridge', name : 'Telnet Bridge',
desc : 'Connect to other Telnet Systems', desc : 'Connect to other Telnet Systems',
@ -123,18 +120,18 @@ class TelnetClientConnection extends EventEmitter {
} }
exports.getModule = class TelnetBridgeModule extends MenuModule {
constructor(options) {
super(options);
function TelnetBridgeModule(options) {
MenuModule.call(this, options);
const self = this;
this.config = options.menuConfig.config; this.config = options.menuConfig.config;
// defaults // defaults
this.config.port = this.config.port || 23; this.config.port = this.config.port || 23;
}
this.initSequence = function() { initSequence() {
let clientTerminated; let clientTerminated;
const self = this;
async.series( async.series(
[ [
@ -195,7 +192,5 @@ function TelnetBridgeModule(options) {
} }
} }
); );
}; }
} };
require('util').inherits(TelnetBridgeModule, MenuModule);

47
mods/user_list.js
View file

@ -1,15 +1,14 @@
/* jslint node: true */ /* jslint node: true */
'use strict'; 'use strict';
var MenuModule = require('../core/menu_module.js').MenuModule; const MenuModule = require('../core/menu_module.js').MenuModule;
//var userDb = require('../core/database.js').dbs.user; const getUserList = require('../core/user.js').getUserList;
var getUserList = require('../core/user.js').getUserList; const ViewController = require('../core/view_controller.js').ViewController;
var ViewController = require('../core/view_controller.js').ViewController;
const stringFormat = require('../core/string_format.js'); const stringFormat = require('../core/string_format.js');
var moment = require('moment'); const moment = require('moment');
var async = require('async'); const async = require('async');
var _ = require('lodash'); const _ = require('lodash');
/* /*
Available listFormat/focusListFormat object members: Available listFormat/focusListFormat object members:
@ -29,34 +28,32 @@ exports.moduleInfo = {
author : 'NuSkooler', author : 'NuSkooler',
}; };
exports.getModule = UserListModule; const MciViewIds = {
var MciCodeIds = {
UserList : 1, UserList : 1,
}; };
function UserListModule(options) { exports.getModule = class UserListModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
} super(options);
}
require('util').inherits(UserListModule, MenuModule); mciReady(mciData, cb) {
super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
UserListModule.prototype.mciReady = function(mciData, cb) { const self = this;
var self = this; const vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
var vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
var userList = []; let userList = [];
var USER_LIST_OPTS = { const USER_LIST_OPTS = {
properties : [ 'location', 'affiliation', 'last_login_timestamp' ], properties : [ 'location', 'affiliation', 'last_login_timestamp' ],
}; };
async.series( async.series(
[ [
// :TODO: These two functions repeated all over -- need DRY
function callParentMciReady(callback) {
UserListModule.super_.prototype.mciReady.call(self, mciData, callback);
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
var loadOpts = { var loadOpts = {
callingMenu : self, callingMenu : self,
@ -73,7 +70,7 @@ UserListModule.prototype.mciReady = function(mciData, cb) {
}); });
}, },
function populateList(callback) { function populateList(callback) {
var userListView = vc.getView(MciCodeIds.UserList); var userListView = vc.getView(MciViewIds.UserList);
var listFormat = self.menuConfig.config.listFormat || '{userName} - {affils}'; var listFormat = self.menuConfig.config.listFormat || '{userName} - {affils}';
var focusListFormat = self.menuConfig.config.focusListFormat || listFormat; // :TODO: default changed color! var focusListFormat = self.menuConfig.config.focusListFormat || listFormat; // :TODO: default changed color!
@ -110,4 +107,6 @@ UserListModule.prototype.mciReady = function(mciData, cb) {
cb(err); cb(err);
} }
); );
});
}
}; };

25
mods/whos_online.js
View file

@ -18,27 +18,26 @@ exports.moduleInfo = {
packageName : 'codes.l33t.enigma.whosonline' packageName : 'codes.l33t.enigma.whosonline'
}; };
exports.getModule = WhosOnlineModule; const MciViewIds = {
const MciCodeIds = {
OnlineList : 1, OnlineList : 1,
}; };
function WhosOnlineModule(options) { exports.getModule = class WhosOnlineModule extends MenuModule {
MenuModule.call(this, options); constructor(options) {
} super(options);
}
require('util').inherits(WhosOnlineModule, MenuModule); mciReady(mciData, cb) {
super.mciReady(mciData, err => {
if(err) {
return cb(err);
}
WhosOnlineModule.prototype.mciReady = function(mciData, cb) {
const self = this; const self = this;
const vc = self.viewControllers.allViews = new ViewController( { client : self.client } ); const vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
async.series( async.series(
[ [
function callParentMciReady(callback) {
return WhosOnlineModule.super_.prototype.mciReady.call(self, mciData, callback);
},
function loadFromConfig(callback) { function loadFromConfig(callback) {
const loadOpts = { const loadOpts = {
callingMenu : self, callingMenu : self,
@ -49,7 +48,7 @@ WhosOnlineModule.prototype.mciReady = function(mciData, cb) {
return vc.loadFromMenuConfig(loadOpts, callback); return vc.loadFromMenuConfig(loadOpts, callback);
}, },
function populateList(callback) { function populateList(callback) {
const onlineListView = vc.getView(MciCodeIds.OnlineList); const onlineListView = vc.getView(MciViewIds.OnlineList);
const listFormat = self.menuConfig.config.listFormat || '{node} - {userName} - {action} - {timeOn}'; const listFormat = self.menuConfig.config.listFormat || '{node} - {userName} - {action} - {timeOn}';
const nonAuthUser = self.menuConfig.config.nonAuthUser || 'Logging In'; const nonAuthUser = self.menuConfig.config.nonAuthUser || 'Logging In';
const otherUnknown = self.menuConfig.config.otherUnknown || 'N/A'; const otherUnknown = self.menuConfig.config.otherUnknown || 'N/A';
@ -80,4 +79,6 @@ WhosOnlineModule.prototype.mciReady = function(mciData, cb) {
return cb(err); return cb(err);
} }
); );
});
}
}; };

5
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "enigma-bbs", "name": "enigma-bbs",
"version": "0.0.2-alpha", "version": "0.0.3-alpha",
"description": "ENiGMA½ Bulletin Board System", "description": "ENiGMA½ Bulletin Board System",
"author": "Bryan Ashby <bryan@l33t.codes>", "author": "Bryan Ashby <bryan@l33t.codes>",
"license": "BSD-2-Clause", "license": "BSD-2-Clause",
@ -14,7 +14,8 @@
}, },
"keywords": [ "keywords": [
"bbs", "bbs",
"telnet" "telnet",
"retro"
], ],
"dependencies": { "dependencies": {
"async": "^1.5.1", "async": "^1.5.1",