Move modules in mods into /core

core/abracadabra.js

@@ -0,0 +1,197 @@
+/* jslint node: true */
+'use strict';
+
+const MenuModule		= require('./menu_module.js').MenuModule;
+const DropFile			= require('./dropfile.js').DropFile;
+const door				= require('./door.js');
+const theme				= require('./theme.js');
+const ansi				= require('./ansi_term.js');
+
+const async				= require('async');
+const assert			= require('assert');
+const paths				= require('path');
+const _					= require('lodash');
+const mkdirs			= require('fs-extra').mkdirs;
+
+//	:TODO: This should really be a system module... needs a little work to allow for such
+
+const activeDoorNodeInstances = {};
+
+exports.moduleInfo = {
+	name	: 'Abracadabra',
+	desc	: 'External BBS Door Module',
+	author	: 'NuSkooler',
+};
+
+/*
+	Example configuration for LORD under DOSEMU:
+
+	{
+		config: {
+			name: PimpWars
+			dropFileType: DORINFO
+			cmd: qemu-system-i386
+			args: [
+				"-localtime",
+				"freedos.img",
+				"-chardev",
+				"socket,port={srvPort},nowait,host=localhost,id=s0",
+				"-device",
+				"isa-serial,chardev=s0"
+			]
+			io: socket
+		}
+	}
+
+	listen: socket | stdio
+
+	{
+		"config" : {
+			"name"			: "LORD",
+			"dropFileType"	: "DOOR",
+			"cmd"			: "/usr/bin/dosemu",
+			"args"			: [ "-quiet", "-f", "/etc/dosemu/dosemu.conf", "X:\\PW\\START.BAT {dropfile} {node}" ] ],
+			"nodeMax"		: 32,
+			"tooManyArt"	: "toomany-lord.ans"
+		}
+	}
+
+	:TODO: See Mystic & others for other arg options that we may need to support
+*/
+
+exports.getModule = class AbracadabraModule extends MenuModule {
+	constructor(options) {
+		super(options);
+
+		this.config = options.menuConfig.config;
+		//	:TODO: MenuModule.validateConfig(cb) -- validate config section gracefully instead of asserts! -- { key : type, key2 : type2, ... }
+		assert(_.isString(this.config.name, 		'Config \'name\' is required'));
+		assert(_.isString(this.config.dropFileType,	'Config \'dropFileType\' is required'));
+		assert(_.isString(this.config.cmd,			'Config \'cmd\' is required'));
+
+		this.config.nodeMax		= this.config.nodeMax || 0;
+		this.config.args		= this.config.args || [];
+	}
+
+	/*
+		:TODO:
+		* disconnecting wile door is open leaves dosemu
+		* http://bbslink.net/sysop.php support
+		* Font support ala all other menus... or does this just work?
+	*/
+
+	initSequence() {
+		const self = this;
+
+		async.series(
+			[
+				function validateNodeCount(callback) {
+					if(self.config.nodeMax > 0 &&
+						_.isNumber(activeDoorNodeInstances[self.config.name]) && 
+						activeDoorNodeInstances[self.config.name] + 1 > self.config.nodeMax)
+					{
+						self.client.log.info( 
+							{ 
+								name		: self.config.name,
+								activeCount : activeDoorNodeInstances[self.config.name]
+							},
+							'Too many active instances');
+
+						if(_.isString(self.config.tooManyArt)) {
+							theme.displayThemeArt( { client : self.client, name : self.config.tooManyArt }, function displayed() {
+								self.pausePrompt( () => {
+									callback(new Error('Too many active instances'));
+								});
+							});
+						} else {
+							self.client.term.write('\nToo many active instances. Try again later.\n');
+
+							//	:TODO: Use MenuModule.pausePrompt()
+							self.pausePrompt( () => {
+								callback(new Error('Too many active instances'));
+							});
+						}
+					} else {
+						//	:TODO: JS elegant way to do this?
+						if(activeDoorNodeInstances[self.config.name]) {
+							activeDoorNodeInstances[self.config.name] += 1;
+						} else {
+							activeDoorNodeInstances[self.config.name] = 1;
+						}
+						
+						callback(null);
+					}
+				},
+				function generateDropfile(callback) {					
+					self.dropFile	= new DropFile(self.client, self.config.dropFileType);
+					var fullPath	= self.dropFile.fullPath;
+
+					mkdirs(paths.dirname(fullPath), function dirCreated(err) {
+						if(err) {
+							callback(err);
+						} else {
+							self.dropFile.createFile(function created(err) {
+								callback(err);
+							});
+						}
+					});
+				}
+			],
+			function complete(err) {
+				if(err) {
+					self.client.log.warn( { error : err.toString() }, 'Could not start door');
+					self.lastError = err;
+					self.prevMenu();
+				} else {
+					self.finishedLoading();
+				}
+			}
+		);
+	}
+
+	runDoor() {
+
+		const exeInfo = {
+			cmd			: this.config.cmd,
+			args		: this.config.args,
+			io			: this.config.io || 'stdio',
+			encoding	: this.config.encoding || this.client.term.outputEncoding,
+			dropFile	: this.dropFile.fileName,
+			node		: this.client.node,
+			//inhSocket	: this.client.output._handle.fd,
+		};
+
+		const doorInstance = new door.Door(this.client, exeInfo);
+
+		doorInstance.once('finished', () => {
+			//
+			//	Try to clean up various settings such as scroll regions that may
+			//	have been set within the door
+			//
+			this.client.term.rawWrite(
+				ansi.normal() +
+				ansi.goto(this.client.term.termHeight, this.client.term.termWidth) +
+				ansi.setScrollRegion() +
+				ansi.goto(this.client.term.termHeight, 0) +
+				'\r\n\r\n'
+			);
+
+			this.prevMenu();
+		});
+
+		this.client.term.write(ansi.resetScreen());
+
+		doorInstance.run();
+	}
+
+	leave() {
+		super.leave();
+		if(!this.lastError) {
+			activeDoorNodeInstances[this.config.name] -= 1;
+		}
+	}
+
+	finishedLoading() {
+		this.runDoor();
+	}
+};