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

New options for launching local doors via the abracadabra module

Browse Source
This commit is contained in:
Bryan Ashby
2022-10-25 10:59:56 -06:00
parent b58c7e7cc6
commit d1f0a12f77
5 changed files with 204 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
core/abracadabra.js
View File

@@ -9,6 +9,7 @@ const ansi = require('./ansi_term.js');
const { Errors } = require('./enig_error.js');
const { trackDoorRunBegin, trackDoorRunEnd } = require('./door_util.js');
const Log = require('./logger').log;
const Config = require('./config.js').get;
// deps
const async = require('async');
@@ -181,6 +182,8 @@ exports.getModule = class AbracadabraModule extends MenuModule {
const exeInfo = {
name: this.config.name,
cmd: this.config.cmd,
preCmd: this.config.preCmd,
preCmdArgs: this.config.preCmdArgs,
cwd: this.config.cwd || paths.dirname(this.config.cmd),
args: this.config.args,
io: this.config.io || 'stdio',
@@ -189,55 +192,86 @@ exports.getModule = class AbracadabraModule extends MenuModule {
env: this.config.env,
};
exeInfo.dropFileDir = DropFile.dropFileDirectory(
Config().paths.dropFiles,
this.client
);
exeInfo.userAreaDir = paths.join(
exeInfo.dropFileDir,
this.client.user.getSanitizedName(),
this.config.name.toLowerCase()
);
if (this.dropFile) {
exeInfo.dropFile = this.dropFile.fileName;
exeInfo.dropFilePath = this.dropFile.fullPath;
}
const doorTracking = trackDoorRunBegin(this.client, this.config.name);
this.doorInstance.run(exeInfo, err => {
this._makeDropDirs([exeInfo.dropFileDir, exeInfo.userAreaDir], err => {
if (err) {
Log.error(`Error running "${this.config.name}": ${err.message}`);
Log.warn(
`Failed creating directory ${exeInfo.dropFilePath}: ${err.message}`
);
}
trackDoorRunEnd(doorTracking);
this.decrementActiveDoorNodeInstances();
const doorTracking = trackDoorRunBegin(this.client, this.config.name);
// Clean up dropfile, if any
if (exeInfo.dropFilePath) {
fs.unlink(exeInfo.dropFilePath, err => {
if (err) {
Log.warn(
{ error: err, path: exeInfo.dropFilePath },
'Failed to remove drop file.'
);
}
});
}
this.doorInstance.run(exeInfo, err => {
if (err) {
Log.error(`Error running "${this.config.name}": ${err.message}`);
}
// client may have disconnected while process was active -
// we're done here if so.
if (!this.client.term.output) {
return;
}
trackDoorRunEnd(doorTracking);
this.decrementActiveDoorNodeInstances();
//
// 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'
);
// Clean up dropfile, if any
if (exeInfo.dropFilePath) {
fs.unlink(exeInfo.dropFilePath, err => {
if (err) {
Log.warn(
{ error: err, path: exeInfo.dropFilePath },
'Failed to remove drop file.'
);
}
});
}
this.autoNextMenu();
// client may have disconnected while process was active -
// we're done here if so.
if (!this.client.term.output) {
return;
}
//
// 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.autoNextMenu();
});
});
}
_makeDropDirs(dirs, cb) {
async.forEach(
dirs,
(dir, nextDir) => {
fs.mkdir(dir, { recursive: true }, nextDir);
},
cb
);
}
leave() {
super.leave();
this.decrementActiveDoorNodeInstances();

181
core/door.js
View File

@@ -11,6 +11,7 @@ const decode = require('iconv-lite').decode;
const createServer = require('net').createServer;
const paths = require('path');
const _ = require('lodash');
const async = require('async');
module.exports = class Door {
constructor(client) {
@@ -67,91 +68,139 @@ module.exports = class Door {
const formatObj = {
dropFile: exeInfo.dropFile,
dropFilePath: exeInfo.dropFilePath,
dropFileDir: exeInfo.dropFileDir,
userAreaDir: exeInfo.userAreaDir,
node: exeInfo.node.toString(),
srvPort: this.sockServer ? this.sockServer.address().port.toString() : '-1',
userId: this.client.user.userId.toString(),
userName: this.client.user.getSanitizedName(),
userNameRaw: this.client.user.username,
termWidth: this.client.term.termWidth,
termHeight: this.client.term.termHeight,
cwd: cwd,
};
const args = exeInfo.args.map(arg => stringFormat(arg, formatObj));
this.client.log.info(
{ cmd: exeInfo.cmd, args, io: this.io },
`Executing external door (${exeInfo.name})`
);
const spawnOptions = {
cols: this.client.term.termWidth,
rows: this.client.term.termHeight,
cwd: cwd,
env: exeInfo.env,
encoding: null, // we want to handle all encoding ourself
};
try {
this.doorPty = pty.spawn(exeInfo.cmd, args, {
cols: this.client.term.termWidth,
rows: this.client.term.termHeight,
cwd: cwd,
env: exeInfo.env,
encoding: null, // we want to handle all encoding ourself
});
} catch (e) {
return cb(e);
}
async.series(
[
callback => {
if (!_.isString(exeInfo.preCmd)) {
return callback(null);
}
//
// PID is launched. Make sure it's killed off if the user disconnects.
//
Events.once(Events.getSystemEvents().ClientDisconnected, evt => {
if (
this.doorPty &&
this.client.session.uniqueId === _.get(evt, 'client.session.uniqueId')
) {
this.client.log.info(
{ pid: this.doorPty.pid },
'User has disconnected; Killing door process.'
);
this.doorPty.kill();
}
});
const preCmdArgs = (exeInfo.preCmdArgs || []).map(arg =>
stringFormat(arg, formatObj)
);
this.client.log.debug(
{ processId: this.doorPty.pid },
'External door process spawned'
);
this.client.log.info(
{ cmd: exeInfo.preCmd, args: preCmdArgs },
`Executing external door pre-command (${exeInfo.name})`
);
if ('stdio' === this.io) {
this.client.log.debug('Using stdio for door I/O');
try {
const prePty = pty.spawn(
exeInfo.preCmd,
preCmdArgs,
spawnOptions
);
this.client.term.output.pipe(this.doorPty);
this.doorPty.onData(this.doorDataHandler.bind(this));
this.doorPty.once('close', () => {
return this.restoreIo(this.doorPty);
});
} else if ('socket' === this.io) {
this.client.log.debug(
{
srvPort: this.sockServer.address().port,
srvSocket: this.sockServerSocket,
prePty.once('exit', exitCode => {
this.client.log.info(
{ exitCode: exitCode },
'Door pre-command exited'
);
return callback(null);
});
} catch (e) {
return callback(e);
}
},
'Using temporary socket server for door I/O'
);
}
callback => {
this.client.log.info(
{ cmd: exeInfo.cmd, args, io: this.io },
`Executing external door (${exeInfo.name})`
);
this.doorPty.once('exit', exitCode => {
this.client.log.info({ exitCode: exitCode }, 'Door exited');
try {
this.doorPty = pty.spawn(exeInfo.cmd, args, spawnOptions);
} catch (e) {
return cb(e);
}
if (this.sockServer) {
this.sockServer.close();
//
// PID is launched. Make sure it's killed off if the user disconnects.
//
Events.once(Events.getSystemEvents().ClientDisconnected, evt => {
if (
this.doorPty &&
this.client.session.uniqueId ===
_.get(evt, 'client.session.uniqueId')
) {
this.client.log.info(
{ pid: this.doorPty.pid },
'User has disconnected; Killing door process.'
);
this.doorPty.kill();
}
});
this.client.log.debug(
{ processId: this.doorPty.pid },
'External door process spawned'
);
if ('stdio' === this.io) {
this.client.log.debug('Using stdio for door I/O');
this.client.term.output.pipe(this.doorPty);
this.doorPty.onData(this.doorDataHandler.bind(this));
this.doorPty.once('close', () => {
return this.restoreIo(this.doorPty);
});
} else if ('socket' === this.io) {
this.client.log.debug(
{
srvPort: this.sockServer.address().port,
srvSocket: this.sockServerSocket,
},
'Using temporary socket server for door I/O'
);
}
this.doorPty.once('exit', exitCode => {
this.client.log.info({ exitCode: exitCode }, 'Door exited');
if (this.sockServer) {
this.sockServer.close();
}
// we may not get a close
if ('stdio' === this.io) {
this.restoreIo(this.doorPty);
}
this.doorPty.removeAllListeners();
delete this.doorPty;
return callback(null);
});
},
],
() => {
return cb(null);
}
// we may not get a close
if ('stdio' === this.io) {
this.restoreIo(this.doorPty);
}
this.doorPty.removeAllListeners();
delete this.doorPty;
return cb(null);
});
);
}
doorDataHandler(data) {

9
core/dropfile.js
View File

@@ -34,8 +34,15 @@ module.exports = class DropFile {
this.baseDir = baseDir;
}
static dropFileDirectory(baseDir, client) {
return paths.join(baseDir, 'node' + client.node);
}
get fullPath() {
return paths.join(this.baseDir, 'node' + this.client.node, this.fileName);
return paths.join(
DropFile.dropFileDirectory(this.baseDir, this.client),
this.fileName
);
}
get fileName() {