627 lines
17 KiB
JavaScript
627 lines
17 KiB
JavaScript
/* jslint node: true */
|
|
'use strict';
|
|
|
|
// ENiGMA½
|
|
const miscUtil = require('./misc_util.js');
|
|
|
|
// deps
|
|
const fs = require('fs');
|
|
const paths = require('path');
|
|
const async = require('async');
|
|
const _ = require('lodash');
|
|
const hjson = require('hjson');
|
|
const assert = require('assert');
|
|
|
|
exports.init = init;
|
|
exports.getDefaultPath = getDefaultPath;
|
|
|
|
function hasMessageConferenceAndArea(config) {
|
|
assert(_.isObject(config.messageConferences)); // we create one ourself!
|
|
|
|
const nonInternalConfs = Object.keys(config.messageConferences).filter(confTag => {
|
|
return 'system_internal' !== confTag;
|
|
});
|
|
|
|
if(0 === nonInternalConfs.length) {
|
|
return false;
|
|
}
|
|
|
|
// :TODO: there is likely a better/cleaner way of doing this
|
|
|
|
let result = false;
|
|
_.forEach(nonInternalConfs, confTag => {
|
|
if(_.has(config.messageConferences[confTag], 'areas') &&
|
|
Object.keys(config.messageConferences[confTag].areas) > 0)
|
|
{
|
|
result = true;
|
|
return false; // stop iteration
|
|
}
|
|
});
|
|
|
|
return result;
|
|
}
|
|
|
|
function init(configPath, options, cb) {
|
|
if(!cb && _.isFunction(options)) {
|
|
cb = options;
|
|
options = {};
|
|
}
|
|
|
|
async.waterfall(
|
|
[
|
|
function loadUserConfig(callback) {
|
|
if(!_.isString(configPath)) {
|
|
return callback(null, { } );
|
|
}
|
|
|
|
fs.readFile(configPath, { encoding : 'utf8' }, (err, configData) => {
|
|
if(err) {
|
|
return callback(err);
|
|
}
|
|
|
|
let configJson;
|
|
try {
|
|
configJson = hjson.parse(configData, options);
|
|
} catch(e) {
|
|
return callback(e);
|
|
}
|
|
|
|
return callback(null, configJson);
|
|
});
|
|
},
|
|
function mergeWithDefaultConfig(configJson, callback) {
|
|
|
|
const mergedConfig = _.mergeWith(
|
|
getDefaultConfig(),
|
|
configJson, (conf1, conf2) => {
|
|
// Arrays should always concat
|
|
if(_.isArray(conf1)) {
|
|
// :TODO: look for collisions & override dupes
|
|
return conf1.concat(conf2);
|
|
}
|
|
}
|
|
);
|
|
|
|
return callback(null, mergedConfig);
|
|
},
|
|
function validate(mergedConfig, callback) {
|
|
//
|
|
// Various sections must now exist in config
|
|
//
|
|
// :TODO: Logic is broken here:
|
|
if(hasMessageConferenceAndArea(mergedConfig)) {
|
|
var msgAreasErr = new Error('Please create at least one message conference and area!');
|
|
msgAreasErr.code = 'EBADCONFIG';
|
|
return callback(msgAreasErr);
|
|
} else {
|
|
return callback(null, mergedConfig);
|
|
}
|
|
}
|
|
],
|
|
function complete(err, mergedConfig) {
|
|
exports.config = mergedConfig;
|
|
return cb(err);
|
|
}
|
|
);
|
|
}
|
|
|
|
function getDefaultPath() {
|
|
const base = miscUtil.resolvePath('~/');
|
|
if(base) {
|
|
// e.g. /home/users/joeuser/.config/enigma-bbs/config.hjson
|
|
return paths.join(base, '.config', 'enigma-bbs', 'config.hjson');
|
|
}
|
|
}
|
|
|
|
function getDefaultConfig() {
|
|
return {
|
|
general : {
|
|
boardName : 'Another Fine ENiGMA½ BBS',
|
|
|
|
closedSystem : false, // is the system closed to new users?
|
|
|
|
loginAttempts : 3,
|
|
|
|
menuFile : 'menu.hjson', // Override to use something else, e.g. demo.hjson. Can be a full path (defaults to ./mods)
|
|
promptFile : 'prompt.hjson', // Override to use soemthing else, e.g. myprompt.hjson. Can be a full path (defaults to ./mods)
|
|
},
|
|
|
|
// :TODO: see notes below about 'theme' section - move this!
|
|
preLoginTheme : 'luciano_blocktronics',
|
|
|
|
users : {
|
|
usernameMin : 2,
|
|
usernameMax : 16, // Note that FidoNet wants 36 max
|
|
usernamePattern : '^[A-Za-z0-9~!@#$%^&*()\\-\\_+ ]+$',
|
|
|
|
passwordMin : 6,
|
|
passwordMax : 128,
|
|
|
|
realNameMax : 32,
|
|
locationMax : 32,
|
|
affilsMax : 32,
|
|
emailMax : 255,
|
|
webMax : 255,
|
|
|
|
requireActivation : false, // require SysOp activation? false = auto-activate
|
|
invalidUsernames : [],
|
|
|
|
groups : [ 'users', 'sysops' ], // built in groups
|
|
defaultGroups : [ 'users' ], // default groups new users belong to
|
|
|
|
newUserNames : [ 'new', 'apply' ], // Names reserved for applying
|
|
|
|
// :TODO: Mystic uses TRASHCAN.DAT for this -- is there a reason to support something like that?
|
|
badUserNames : [ 'sysop', 'admin', 'administrator', 'root', 'all' ],
|
|
},
|
|
|
|
// :TODO: better name for "defaults"... which is redundant here!
|
|
/*
|
|
Concept
|
|
"theme" : {
|
|
"default" : "defaultThemeName", // or "*"
|
|
"preLogin" : "*",
|
|
"passwordChar" : "*",
|
|
...
|
|
}
|
|
*/
|
|
defaults : {
|
|
theme : 'luciano_blocktronics',
|
|
passwordChar : '*', // TODO: move to user ?
|
|
dateFormat : {
|
|
short : 'MM/DD/YYYY',
|
|
},
|
|
timeFormat : {
|
|
short : 'h:mm a',
|
|
},
|
|
dateTimeFormat : {
|
|
short : 'MM/DD/YYYY h:mm a',
|
|
}
|
|
},
|
|
|
|
menus : {
|
|
cls : true, // Clear screen before each menu by default?
|
|
},
|
|
|
|
paths : {
|
|
mods : paths.join(__dirname, './../mods/'),
|
|
loginServers : paths.join(__dirname, './servers/login/'),
|
|
contentServers : paths.join(__dirname, './servers/content/'),
|
|
|
|
scannerTossers : paths.join(__dirname, './scanner_tossers/'),
|
|
mailers : paths.join(__dirname, './mailers/') ,
|
|
|
|
art : paths.join(__dirname, './../mods/art/'),
|
|
themes : paths.join(__dirname, './../mods/themes/'),
|
|
logs : paths.join(__dirname, './../logs/'), // :TODO: set up based on system, e.g. /var/logs/enigmabbs or such
|
|
db : paths.join(__dirname, './../db/'),
|
|
modsDb : paths.join(__dirname, './../db/mods/'),
|
|
dropFiles : paths.join(__dirname, './../dropfiles/'), // + "/node<x>/
|
|
misc : paths.join(__dirname, './../misc/'),
|
|
},
|
|
|
|
loginServers : {
|
|
telnet : {
|
|
port : 8888,
|
|
enabled : true,
|
|
firstMenu : 'telnetConnected',
|
|
},
|
|
ssh : {
|
|
port : 8889,
|
|
enabled : false, // defualt to false as PK/pass in config.hjson are required
|
|
|
|
//
|
|
// Private key in PEM format
|
|
//
|
|
// Generating your PK:
|
|
// > openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
|
|
//
|
|
// Then, set servers.ssh.privateKeyPass to the password you use above
|
|
// in your config.hjson
|
|
//
|
|
privateKeyPem : paths.join(__dirname, './../misc/ssh_private_key.pem'),
|
|
firstMenu : 'sshConnected',
|
|
firstMenuNewUser : 'sshConnectedNewUser',
|
|
}
|
|
},
|
|
|
|
contentServers : {
|
|
web : {
|
|
domain : 'another-fine-enigma-bbs.org',
|
|
|
|
staticRoot : paths.join(__dirname, './../www'),
|
|
|
|
resetPassword : {
|
|
//
|
|
// The following templates have these variables available to them:
|
|
//
|
|
// * %BOARDNAME% : Name of BBS
|
|
// * %USERNAME% : Username of whom to reset password
|
|
// * %TOKEN% : Reset token
|
|
// * %RESET_URL% : In case of email, the link to follow for reset. In case of landing page,
|
|
// URL to POST submit reset form.
|
|
|
|
// templates for pw reset *email*
|
|
resetPassEmailText : paths.join(__dirname, '../misc/reset_password_email.template.txt'), // plain text version
|
|
resetPassEmailHtml : paths.join(__dirname, '../misc/reset_password_email.template.html'), // HTML version
|
|
|
|
// tempalte for pw reset *landing page*
|
|
//
|
|
resetPageTemplate : paths.join(__dirname, './../www/reset_password.template.html'),
|
|
},
|
|
|
|
http : {
|
|
enabled : false,
|
|
port : 8080,
|
|
},
|
|
https : {
|
|
enabled : false,
|
|
port : 8443,
|
|
certPem : paths.join(__dirname, './../misc/https_cert.pem'),
|
|
keyPem : paths.join(__dirname, './../misc/https_cert_key.pem'),
|
|
}
|
|
}
|
|
},
|
|
|
|
archives : {
|
|
archivers : {
|
|
'7Zip' : {
|
|
compress : {
|
|
cmd : '7za',
|
|
args : [ 'a', '-tzip', '{archivePath}', '{fileList}' ],
|
|
},
|
|
decompress : {
|
|
cmd : '7za',
|
|
args : [ 'e', '-o{extractPath}', '{archivePath}' ] // :TODO: should be 'x'?
|
|
},
|
|
list : {
|
|
cmd : '7za',
|
|
args : [ 'l', '{archivePath}' ],
|
|
entryMatch : '^[0-9]{4}-[0-9]{2}-[0-9]{2}\\s[0-9]{2}:[0-9]{2}:[0-9]{2}\\s[A-Za-z\\.]{5}\\s+([0-9]+)\\s+[0-9]+\\s+([^\\r\\n]+)$',
|
|
},
|
|
extract : {
|
|
cmd : '7za',
|
|
args : [ 'e', '-o{extractPath}', '{archivePath}', '{fileList}' ],
|
|
},
|
|
},
|
|
|
|
Lha : {
|
|
//
|
|
// 'lha' command can be obtained from:
|
|
// * apt-get: lhasa
|
|
//
|
|
// (compress not currently supported)
|
|
//
|
|
decompress : {
|
|
cmd : 'lha',
|
|
args : [ '-ew={extractPath}', '{archivePath}' ],
|
|
},
|
|
list : {
|
|
cmd : 'lha',
|
|
args : [ '-l', '{archivePath}' ],
|
|
entryMatch : '^[\\[a-z\\]]+(?:\\s+[0-9]+\\s+[0-9]+|\\s+)([0-9]+)\\s+[0-9]{2}\\.[0-9]\\%\\s+[A-Za-z]{3}\\s+[0-9]{1,2}\\s+[0-9]{4}\\s+([^\\r\\n]+)$',
|
|
},
|
|
extract : {
|
|
cmd : 'lha',
|
|
args : [ '-ew={extractPath}', '{archivePath}', '{fileList}' ]
|
|
}
|
|
},
|
|
|
|
Arj : {
|
|
//
|
|
// 'arj' command can be obtained from:
|
|
// * apt-get: arj
|
|
//
|
|
decompress : {
|
|
cmd : 'arj',
|
|
args : [ 'x', '{archivePath}', '{extractPath}' ],
|
|
},
|
|
list : {
|
|
cmd : 'arj',
|
|
args : [ 'l', '{archivePath}' ],
|
|
entryMatch : '^([^\\s]+)\\s+([0-9]+)\\s+[0-9]+\\s[0-9\\.]+\\s+[0-9]{2}\\-[0-9]{2}\\-[0-9]{2}\\s[0-9]{2}\\:[0-9]{2}\\:[0-9]{2}\\s+(?:[^\\r\\n]+)$',
|
|
entryGroupOrder : { // defaults to { byteSize : 1, fileName : 2 }
|
|
fileName : 1,
|
|
byteSize : 2,
|
|
}
|
|
},
|
|
extract : {
|
|
cmd : 'arj',
|
|
args : [ 'e', '{archivePath}', '{extractPath}', '{fileList}' ],
|
|
}
|
|
},
|
|
|
|
Rar : {
|
|
decompress : {
|
|
cmd : 'unrar',
|
|
args : [ 'x', '{archivePath}', '{extractPath}' ],
|
|
},
|
|
list : {
|
|
cmd : 'unrar',
|
|
args : [ 'l', '{archivePath}' ],
|
|
entryMatch : '^\\s+[\\.A-Z]+\\s+([\\d]+)\\s{2}[0-9]{2}\\-[0-9]{2}\\-[0-9]{2}\\s[0-9]{2}\\:[0-9]{2}\\s{2}([^\\r\\n]+)$',
|
|
},
|
|
extract : {
|
|
cmd : 'unrar',
|
|
args : [ 'e', '{archivePath}', '{extractPath}', '{fileList}' ],
|
|
}
|
|
}
|
|
},
|
|
|
|
formats : {
|
|
//
|
|
// Resources
|
|
// * http://www.garykessler.net/library/file_sigs.html
|
|
//
|
|
zip : {
|
|
sig : '504b0304',
|
|
offset : 0,
|
|
exts : [ 'zip' ],
|
|
handler : '7Zip',
|
|
desc : 'ZIP Archive',
|
|
},
|
|
'7z' : {
|
|
sig : '377abcaf271c',
|
|
offset : 0,
|
|
exts : [ '7z' ],
|
|
handler : '7Zip',
|
|
desc : '7-Zip Archive',
|
|
},
|
|
arj : {
|
|
sig : '60ea',
|
|
offset : 0,
|
|
exts : [ 'arj' ],
|
|
handler : 'Arj',
|
|
desc : 'ARJ Archive',
|
|
},
|
|
rar : {
|
|
sig : '526172211a0700',
|
|
offset : 0,
|
|
exts : [ 'rar' ],
|
|
handler : 'Rar',
|
|
desc : 'RAR Archive',
|
|
},
|
|
gzip : {
|
|
sig : '1f8b',
|
|
offset : 0,
|
|
exts : [ 'gz' ],
|
|
handler : '7Zip',
|
|
desc : 'Gzip Archive',
|
|
},
|
|
bzip : {
|
|
sig : '425a68',
|
|
offset : 0,
|
|
exts : [ 'bz2' ],
|
|
handler : '7Zip',
|
|
desc : 'BZip2 Archive',
|
|
},
|
|
lzh : {
|
|
sig : '2d6c68',
|
|
offset : 2,
|
|
exts : [ 'lzh', 'ice' ],
|
|
handler : 'Lha',
|
|
desc : 'LHArc Archive',
|
|
}
|
|
}
|
|
},
|
|
|
|
fileTransferProtocols : {
|
|
//
|
|
// See http://www.synchro.net/docs/sexyz.txt for information on SEXYZ
|
|
//
|
|
zmodem8kSexyz : {
|
|
name : 'ZModem 8k (SEXYZ)',
|
|
type : 'external',
|
|
sort : 1,
|
|
external : {
|
|
// :TODO: Look into shipping sexyz binaries or at least hosting them somewhere for common systems
|
|
sendCmd : 'sexyz',
|
|
sendArgs : [ '-telnet', '-8', 'sz', '@{fileListPath}' ],
|
|
recvCmd : 'sexyz',
|
|
recvArgs : [ '-telnet', '-8', 'rz', '{uploadDir}' ],
|
|
recvArgsNonBatch : [ '-telnet', '-8', 'rz', '{fileName}' ],
|
|
}
|
|
},
|
|
|
|
xmodemSexyz : {
|
|
name : 'XModem (SEXYZ)',
|
|
type : 'external',
|
|
sort : 3,
|
|
external : {
|
|
sendCmd : 'sexyz',
|
|
sendArgs : [ '-telnet', 'sX', '@{fileListPath}' ],
|
|
recvCmd : 'sexyz',
|
|
recvArgsNonBatch : [ '-telnet', 'rC', '{fileName}' ]
|
|
}
|
|
},
|
|
|
|
ymodemSexyz : {
|
|
name : 'YModem (SEXYZ)',
|
|
type : 'external',
|
|
sort : 4,
|
|
external : {
|
|
sendCmd : 'sexyz',
|
|
sendArgs : [ '-telnet', 'sY', '@{fileListPath}' ],
|
|
recvCmd : 'sexyz',
|
|
recvArgs : [ '-telnet', 'ry', '{uploadDir}' ],
|
|
}
|
|
},
|
|
|
|
zmodem8kSz : {
|
|
name : 'ZModem 8k',
|
|
type : 'external',
|
|
sort : 2,
|
|
external : {
|
|
sendCmd : 'sz', // Avail on Debian/Ubuntu based systems as the package "lrzsz"
|
|
sendArgs : [
|
|
// :TODO: try -q
|
|
'--zmodem', '--try-8k', '--binary', '--restricted', '{filePaths}'
|
|
],
|
|
recvCmd : 'rz', // Avail on Debian/Ubuntu based systems as the package "lrzsz"
|
|
recvArgs : [
|
|
'--zmodem', '--binary', '--restricted', '--keep-uppercase', // dumps to CWD which is set to {uploadDir}
|
|
],
|
|
// :TODO: can we not just use --escape ?
|
|
escapeTelnet : true, // set to true to escape Telnet codes such as IAC
|
|
}
|
|
}
|
|
},
|
|
|
|
messageAreaDefaults : {
|
|
//
|
|
// The following can be override per-area as well
|
|
//
|
|
maxMessages : 1024, // 0 = unlimited
|
|
maxAgeDays : 0, // 0 = unlimited
|
|
},
|
|
|
|
messageConferences : {
|
|
system_internal : {
|
|
name : 'System Internal',
|
|
desc : 'Built in conference for private messages, bulletins, etc.',
|
|
|
|
areas : {
|
|
private_mail : {
|
|
name : 'Private Mail',
|
|
desc : 'Private user to user mail/email',
|
|
},
|
|
|
|
local_bulletin : {
|
|
name : 'System Bulletins',
|
|
desc : 'Bulletin messages for all users',
|
|
}
|
|
}
|
|
}
|
|
},
|
|
|
|
scannerTossers : {
|
|
ftn_bso : {
|
|
paths : {
|
|
outbound : paths.join(__dirname, './../mail/ftn_out/'),
|
|
inbound : paths.join(__dirname, './../mail/ftn_in/'),
|
|
secInbound : paths.join(__dirname, './../mail/ftn_secin/'),
|
|
reject : paths.join(__dirname, './../mail/reject/'), // bad pkt, bundles, TIC attachments that fail any check, etc.
|
|
// set 'retain' to a valid path to keep good pkt files
|
|
},
|
|
|
|
//
|
|
// Packet and (ArcMail) bundle target sizes are just that: targets.
|
|
// Actual sizes may be slightly larger when we must place a full
|
|
// PKT contents *somewhere*
|
|
//
|
|
packetTargetByteSize : 512000, // 512k, before placing messages in a new pkt
|
|
bundleTargetByteSize : 2048000, // 2M, before creating another archive
|
|
|
|
tic : {
|
|
secureInOnly : true, // only bring in from secure inbound (|secInbound| path, password protected)
|
|
uploadBy : 'ENiGMA TIC', // default upload by username (override @ network)
|
|
allowReplace : false, // use "Replaces" TIC field
|
|
}
|
|
}
|
|
},
|
|
|
|
fileBase: {
|
|
// areas with an explicit |storageDir| will be stored relative to |areaStoragePrefix|:
|
|
areaStoragePrefix : paths.join(__dirname, './../file_base/'),
|
|
|
|
maxDescFileByteSize : 471859, // ~1/4 MB
|
|
maxDescLongFileByteSize : 524288, // 1/2 MB
|
|
|
|
fileNamePatterns: {
|
|
// These are NOT case sensitive
|
|
// FILE_ID.DIZ - https://en.wikipedia.org/wiki/FILE_ID.DIZ
|
|
desc : [
|
|
'^[^/\]*FILE_ID\.DIZ$', '^[^/\]*DESC\.SDI$', '^[^/\]*DESCRIPT\.ION$', '^[^/\]*FILE\.DES$', '^[^/\]*FILE\.SDI$', '^[^/\]*DISK\.ID$'
|
|
],
|
|
|
|
// common README filename - https://en.wikipedia.org/wiki/README
|
|
descLong : [
|
|
'^[^/\]*\.NFO$', '^[^/\]*README\.1ST$', '^[^/\]*README\.NOW$', '^[^/\]*README\.TXT$', '^[^/\]*READ\.ME$', '^[^/\]*README$', '^[^/\]*README\.md$'
|
|
],
|
|
},
|
|
|
|
yearEstPatterns: [
|
|
//
|
|
// Patterns should produce the year in the first submatch.
|
|
// The extracted year may be YY or YYYY
|
|
//
|
|
'\\b((?:[1-2][0-9][0-9]{2}))[\\-\\/\\.][0-3]?[0-9][\\-\\/\\.][0-3]?[0-9]|[0-3]?[0-9][\\-\\/\\.][0-3]?[0-9][\\-\\/\\.]((?:[0-9]{2})?[0-9]{2})\\b', // yyyy-mm-dd, m/d/yyyy, mm-dd-yyyy, etc.
|
|
"\\b('[1789][0-9])\\b", // eslint-disable-line quotes
|
|
'\\b[0-3]?[0-9][\\-\\/\\.](?:jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec|january|february|march|april|may|june|july|august|september|october|november|december)[\\-\\/\\.]((?:[0-9]{2})?[0-9]{2})\\b',
|
|
'\\b(?:jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec|january|february|march|april|may|june|july|august|september|october|november|december),?\\s[0-9]+(?:st|nd|rd|th)?,?\\s((?:[0-9]{2})?[0-9]{2})\\b', // November 29th, 1997
|
|
// :TODO: DD/MMM/YY, DD/MMMM/YY, DD/MMM/YYYY, etc.
|
|
// :TODO: "Copyright YYYY someone"
|
|
],
|
|
|
|
web : {
|
|
path : '/f/',
|
|
routePath : '/f/[a-zA-Z0-9]+$',
|
|
expireMinutes : 1440, // 1 day
|
|
},
|
|
|
|
//
|
|
// File area storage location tag/value pairs.
|
|
// Non-absolute paths are relative to |areaStoragePrefix|.
|
|
//
|
|
storageTags : {
|
|
sys_msg_attach : 'msg_attach',
|
|
},
|
|
|
|
areas: {
|
|
system_message_attachment : {
|
|
name : 'Message attachments',
|
|
desc : 'File attachments to messages',
|
|
storageTags : 'sys_msg_attach', // may be string or array of strings
|
|
}
|
|
}
|
|
},
|
|
|
|
eventScheduler : {
|
|
|
|
events : {
|
|
trimMessageAreas : {
|
|
// may optionally use [or ]@watch:/path/to/file
|
|
schedule : 'every 24 hours',
|
|
|
|
// action:
|
|
// - @method:path/to/module.js:theMethodName
|
|
// (path is relative to engima base dir)
|
|
//
|
|
// - @execute:/path/to/something/executable.sh
|
|
//
|
|
action : '@method:core/message_area.js:trimMessageAreasScheduledEvent',
|
|
},
|
|
|
|
forgotPasswordMaintenance : {
|
|
schedule : 'every 24 hours',
|
|
action : '@method:core/web_password_reset.js:performMaintenanceTask',
|
|
args : [ '24 hours' ] // items older than this will be removed
|
|
}
|
|
}
|
|
},
|
|
|
|
misc : {
|
|
preAuthIdleLogoutSeconds : 60 * 3, // 2m
|
|
idleLogoutSeconds : 60 * 6, // 6m
|
|
},
|
|
|
|
logging : {
|
|
level : 'debug',
|
|
|
|
rotatingFile : { // set to 'disabled' or false to disable
|
|
type : 'rotating-file',
|
|
fileName : 'enigma-bbs.log',
|
|
period : '1d',
|
|
count : 3,
|
|
level : 'debug',
|
|
}
|
|
|
|
// :TODO: syslog - https://github.com/mcavage/node-bunyan-syslog
|
|
},
|
|
|
|
debug : {
|
|
assertsEnabled : false,
|
|
}
|
|
};
|
|
}
|