Sync with master

Author: NuSkooler

.gitignore

@@ -1,7 +1,7 @@
 #	Don't check in SSH keys!
 *.pem
 
-#	Various directories
+#	Exclude User-Customized Directories
 config/
 db/
 drop/
@@ -11,5 +11,13 @@ mail/
 node_modules/
 docs/_site/
 docs/.sass-cache/
-
 docs/.jekyll-cache/
+
+#   Ignore Web Assets not included with enigma-bbs
+www/*
+www/assets/*
+!www/otp_register_template.html
+!www/reset_password.template.html
+
+#   Runtime Environment
+.venv

README.md

@@ -8,7 +8,7 @@ ENiGMA½ is a modern BBS software with a nostalgic flair!
 Below are just some of the features ENiGMA½ supports out of the box:
  * **Multi platform** — Anywhere [Node.js](https://nodejs.org/) runs likely works (known to work under Linux, FreeBSD, OpenBSD, OS X and Windows)
  * Unlimited multi node support (for all those BBS "callers"!)
- * **Highly customizable** via [HJSON](http://hjson.org/) based configuration, menus, and themes in addition to JavaScript based [mods](./docs/_docs/modding/existing-mods.md)
+ * **Highly customizable** via [HJSON](https://hjson.github.io/) based configuration, menus, and themes in addition to JavaScript based [mods](./docs/_docs/modding/existing-mods.md)
  * [MCI support](./docs/_docs/art/mci.md) for lightbars, toggles, input areas, and so on plus many other other bells and whistles
  * Telnet, **SSH**, and both secure and non-secure [WebSocket](https://en.wikipedia.org/wiki/WebSocket) access built in! Additional servers are easy to implement
  * [CP437](http://www.ascii-codes.com/) and UTF-8 output
@@ -87,31 +87,9 @@ ENiGMA has been tested with many terminals. However, the following are suggested
 * Alpha for the [FTN-style configuration guide](https://medium.com/@alpha_11845/setting-up-ftn-style-message-networks-with-enigma%C2%BD-bbs-709b22a1ae0d)!
 * Huge shout out to [cognitivegears ](https://github.com/cognitivegears) for the various fixes, improvements, and **removing the need for cursor position reports** providing a much better terminal experience!
 
-...and so many others! This project would be nothing without the BBS and artscene communities!
+...and so many others! This project would be nothing without the BBS and art scene communities!
+
+[![Star History Chart](https://api.star-history.com/svg?repos=nuskooler/enigma-bbs&type=Date)](https://star-history.com/#nuskooler/enigma-bbs&Date)
 
 ## License
-Released under the [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause) license:
-
-Copyright (c) 2015-2024, Bryan D. Ashby
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Released under [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause). See [LICENSE.TXT](LICENSE.TXT)

autoexec.sh

@@ -0,0 +1,93 @@
+#!/usr/bin/env bash
+
+# Environment
+ENIGMA_INSTALL_DIR=${ENIGMA_INSTALL_DIR:=$HOME/enigma-bbs}
+AUTOEXEC_LOGFILE="$ENIGMA_INSTALL_DIR/logs/autoexec.log"
+TIME_FORMAT=`date "+%Y-%m-%d %H:%M:%S"`
+
+# Mise en place
+export PATH="$HOME/.local/bin:$PATH"
+export PATH="$HOME/.local/share/mise/shims:$PATH"
+export PATH="$HOME/.local/share/mise/installs/python/latest/bin:$PATH"
+
+# Environment Versions
+ENIGMA_NODE_VERSION=${ENIGMA_NODE_VERSION:=$(toml get --toml-path=$ENIGMA_INSTALL_DIR/mise.toml tools.node)}
+ENIGMA_PYTHON_VERSION=${ENIGMA_PYTHON_VERSION:=$(toml get --toml-path=$ENIGMA_INSTALL_DIR/mise.toml tools.python)}
+
+# Validate Environment
+DEPENDENCIES_VALIDATED=1
+
+# Shared Functions
+log() {
+    echo "${TIME_FORMAT} " "$*" >> $AUTOEXEC_LOGFILE
+}
+
+# If this is a first run, the log path will not yet exist and must be created
+if [ ! -d "$ENIGMA_INSTALL_DIR/logs" ]
+then
+    mkdir -p $ENIGMA_INSTALL_DIR/logs
+fi
+
+log "START:"
+log "- PATH: $PATH"
+log "- CURRENT DIR: ${PWD##}"
+
+if ! command -v "mise" 2>&1 >/dev/null
+then
+    log "mise is not in your PATH"
+    log "ERROR END"
+    exit 1
+fi
+
+if ! command -v "node" 2>&1 >/dev/null
+then
+    log "Node environment is not in your PATH"
+    log "ERROR END"
+    exit 1
+else
+    NODE_VERSION=$(node --version | tee /dev/null)
+    log "- NODE VERSION: $NODE_VERSION"
+    if [[ $NODE_VERSION != "v$ENIGMA_NODE_VERSION."* ]]; then
+        log "Node version found in your PATH is $NODE_VERSION, was expecting v$ENIGMA_NODE_VERSION.*; you may encounter compatibility issues"
+        DEPENDENCIES_VALIDATED=0
+    fi
+fi
+
+if ! command -v "python" 2>&1 >/dev/null
+then
+    log "Python environment is not in your PATH"
+    log "ERROR END"
+    exit 1
+else
+    PYTHON_VERSION=$(python --version | tee /dev/null)
+    log "- PYTHON VERSION: $PYTHON_VERSION"
+    if [[ $PYTHON_VERSION != "Python $ENIGMA_PYTHON_VERSION"* ]]; then
+        log "Python version found in your PATH is $PYTHON_VERSION, was expecting Python $ENIGMA_PYTHON_VERSION.*; you may encounter compatibility issues"
+        DEPENDENCIES_VALIDATED=0
+    fi
+fi
+
+# Validate whether we are good to Start
+if [ "$DEPENDENCIES_VALIDATED" == "0" ]; then
+    if [ -v ENIGMA_IGNORE_DEPENDENCIES ] && [ "${ENIGMA_IGNORE_DEPENDENCIES}" == "1" ]; then
+        log "ENIGMA_IGNORE_DEPENDENCIES=1 detected, starting up..."
+    else
+        log "NOTE: Please re-run with 'ENIGMA_IGNORE_DEPENDENCIES=1 /path/to/autoexec.sh' to force startup"
+        log "ERROR END"
+        exit 1
+    fi
+fi
+
+# Start BBS
+log "Starting ENiGMA½"
+~/enigma-bbs/main.js
+result=$?
+
+# Determine whether a Startup Crash Occurred
+# if [ $result -eq 0 ]; then
+# 	# TODO: Notify via SMS / Email of Startup Failure
+# fi
+
+log "ENiGMA½ exited with $result"
+log "END"
+exit $result

core/bbs.js

@@ -85,23 +85,18 @@ function main() {
                     //  then it's a fatal error
                     //
                     if (err) {
+                        errorDisplayed = true;
+                        console.error(`Configuration error: ${err.message}`); //  eslint-disable-line no-console
+
                         if ('ENOENT' === err.code) {
-                            if (configPathSupplied) {
-                                console.error(
-                                    'Configuration file does not exist: ' + configFile
-                                );
-                            } else {
-                                configPathSupplied = null; //  make non-fatal; we'll go with defaults
-                            }
-                        } else {
-                            errorDisplayed = true;
-                            console.error(`Configuration error: ${err.message}`); //  eslint-disable-line no-console
-                            if (err.hint) {
-                                console.error(`Hint: ${err.hint}`);
-                            }
-                            if (err.configPath) {
-                                console.error(`Note: ${err.configPath}`);
-                            }
+                            console.error("\nConfiguration file does not exist: '{configFile}'\n\nIf this is a new installation please run './oputil.js config new' from the enigma-bbs directory");
+                        }
+
+                        if (err.hint) {
+                            console.error(`Hint: ${err.hint}`);
+                        }
+                        if (err.configPath) {
+                            console.error(`Note: ${err.configPath}`);
                         }
                     }
                     return callback(err);
@@ -134,7 +129,7 @@ function main() {
 
             if (err && !errorDisplayed) {
                 console.error('Error initializing: ' + util.inspect(err));
-                return process.exit();
+                return process.exit(1);
             }
         }
     );

core/goldmine.js

@@ -25,8 +25,8 @@ exports.getModule = class GoldmineModule extends MenuModule {
         this.setConfigWithExtraArgs(options);
 
         //  http://goldminebbs.com/
-        this.config.host = this.config.host || '165.232.153.209';
-        this.config.rloginPort = this.config.rloginPort || 513;
+        this.config.host = this.config.host || 'goldminedoors.com';
+        this.config.rloginPort = this.config.rloginPort || 2513;
     }
 
     initSequence() {

core/oputil/oputil_config.js

@@ -297,6 +297,14 @@ function catCurrentConfig() {
             keepWsc: false === argv.comments ? false : true,
         });
 
+        if (argv.meow) {
+            console.info(
+`    /\\_/\\
+   ( o.o )
+    > ^ < ... mrow...`);
+            return;
+        }
+        
         console.log(hjson.stringify(config, hjsonOpts));
     } catch (e) {
         if ('ENOENT' == e.code) {

core/oputil/oputil_help.js

@@ -20,6 +20,7 @@ Commands:
   config                    Configuration management
   fb                        File base management
   mb                        Message base management
+  ssh                       SSH key management
 `,
     User: `usage: oputil.js user <action> [<arguments>]
 
@@ -101,7 +102,7 @@ Actions:
   cat                      Write current configuration to stdout
 
 cat arguments:
-  --no-color               Disable color
+  --no-colors              Disable color
   --no-comments            Strip any comments
 `,
     FileBase: `usage: oputil.js fb <action> [<arguments>]
@@ -219,6 +220,11 @@ qwk-export arguments:
                               TIMESTAMP.
   --no-qwke                   Disable QWKE extensions.
   --no-synchronet             Disable Synchronet style extensions.
+`,
+    SSH: `usage: oputil.js ssh <action>
+
+Actions:
+  create                      Create new SSH Keys
 `,
 });
 

core/oputil/oputil_main.js

@@ -10,6 +10,7 @@ const handleFileBaseCommand = require('./oputil_file_base.js').handleFileBaseCom
 const handleMessageBaseCommand =
     require('./oputil_message_base.js').handleMessageBaseCommand;
 const handleConfigCommand = require('./oputil_config.js').handleConfigCommand;
+const handleSSHKeyCommand = require('./oputil_ssh_key.js').handleSSHKeyCommand;
 const getHelpFor = require('./oputil_help.js').getHelpFor;
 
 module.exports = function () {
@@ -32,6 +33,8 @@ module.exports = function () {
             return handleFileBaseCommand();
         case 'mb':
             return handleMessageBaseCommand();
+        case 'ssh':
+            return handleSSHKeyCommand();
         default:
             return printUsageAndSetExitCode(getHelpFor('General'), ExitCodes.BAD_COMMAND);
     }