Merge branch 'master' into 479-nua-optional-fields

.devcontainer/Dockerfile

@@ -0,0 +1,9 @@
+FROM library/node:lts-bookworm
+
+ARG DEBIAN_FRONTEND=noninteractive
+RUN apt update \
+    && apt install -y --no-install-recommends sudo telnet \
+    && apt autoremove -y \
+    && rm -rf /var/lib/apt/lists/* \
+    && echo "node ALL=(ALL) NOPASSWD: ALL" >/etc/sudoers.d/node \
+    && chmod 0440 /etc/sudoers.d/node

.devcontainer/devcontainer.json

@@ -0,0 +1,24 @@
+{
+  "name": "Basic Node.js",
+  "build": { "dockerfile": "Dockerfile" },
+"remoteUser": "root",
+"forwardPorts": [8888, 4000],
+"postCreateCommand": "gem install jekyll bundler && /bin/rm -rf node_modules && npm install && cd docs && bundle install && cd ..",
+"features": {
+	"ghcr.io/devcontainers/features/python:1": {
+		"installTools": true,
+		"version": "latest"
+	},
+	"ghcr.io/devcontainers-contrib/features/curl-apt-get:1": {},
+	"ghcr.io/jungaretti/features/ripgrep:1": {},
+	"ghcr.io/warrenbuckley/codespace-features/sqlite:1": {},
+	"ghcr.io/devcontainers/features/ruby:1": {
+		"version": "3.1"
+	}
+},
+"customizations": {
+	"vscode": {
+		"extensions": ["ms-azuretools.vscode-docker","alexcvzz.vscode-sqlite","yzhang.markdown-all-in-one", "DavidAnson.vscode-markdownlint", "christian-kohler.npm-intellisense", "dbaeumer.vscode-eslint", "bierner.markdown-yaml-preamble"]
+	}
+}
+}

.dockerignore

@@ -0,0 +1,12 @@
+node_modules
+package-lock.json
+yarn.lock
+
+filebase
+db
+drop
+file_base
+logs
+mail
+docs/_site
+docs/.sass-cache

.gitattributes

@@ -6,3 +6,13 @@
 *.TXT	eol=crlf
 *.diz	eol=crlf
 *.DIZ	eol=crlf
+
+# Don't mess with shell script line endings
+*.sh text eol=lf
+
+# Same thing for optutil.js which functions as a shell script
+optutil.js text eol=lf
+
+# The devcontainer is also unix
+.devcontainer/Dockerfile text eol=lf
+.devcontainer/devcontainer.json text eol=lf

.gitignore

@@ -11,4 +11,3 @@ mail/
 node_modules/
 docs/_site/
 docs/.sass-cache/
-.vscode/

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "ms-vscode-remote.remote-containers",
+        "laktak.hjson"
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/main.js"
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,26 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Start Jekyll (ENiGMA½ documentation server)",
+            "command": "cd docs && bundle exec jekyll serve",
+            "isBackground": true,
+            "type": "shell"
+        },
+        {
+            "label": "(re)build Jekyll bundles",
+            "command": "cd docs && bundle install",
+            "type": "shell"
+        },
+        {
+            "label": "(re)build node modules",
+            "command": "/bin/rm -rf node_modules && npm install",
+            "type": "shell"
+        },
+        {
+            "label": "ENiGMA½ new configuration",
+            "command": "./oputil.js config new",
+            "type": "shell"
+        }
+    ]
+}

WHATSNEW.md

@@ -10,6 +10,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
 * CombatNet has shut down, so the module (`combatnet.js`) has been removed.
 * The Menu Flag `popParent` has been removed and `noHistory` has been updated to work as expected. In general things should "Just Work", but check your `menu.hjson` entries if you see menu stack issues.
 * Various New User Application (NUA) properties are now optional. If you would like to reduce the information users are required, remove optional fields from NUA artwork and collect less. These properties will be stored as "" (empty). Optional properties are as follows: Real name, Birth date, Sex, Location, Affiliations (Affils), Email, and Web address.
+* Art handling has been changed to respect the art width contained in SAUCE when present in the case where the terminal width is greater than the art width. This fixes art files that assume wrapping at 80 columns on wide (mostly new utf8) terminals.
 
 ## 0.0.13-beta
 * **Note for contributors**: ENiGMA has switched to [Prettier](https://prettier.io) for formatting/style. Please see [CONTRIBUTING](CONTRIBUTING.md) and the Prettier website for more information.

core/ansi_escape_parser.js

@@ -37,6 +37,12 @@ function ANSIEscapeParser(options) {
     this.mciReplaceChar = miscUtil.valueWithDefault(options.mciReplaceChar, '');
     this.termHeight = miscUtil.valueWithDefault(options.termHeight, 25);
     this.termWidth = miscUtil.valueWithDefault(options.termWidth, 80);
+    this.breakWidth = this.termWidth;
+    // toNumber takes care of null, undefined etc as well.
+    let artWidth = _.toNumber(options.artWidth);
+    if(!(_.isNaN(artWidth)) && artWidth > 0 && artWidth < this.breakWidth) {
+        this.breakWidth = options.artWidth;
+    }
     this.trailingLF = miscUtil.valueWithDefault(options.trailingLF, 'default');
 
     this.row = Math.min(options?.startRow ?? 1, this.termHeight);
@@ -90,8 +96,8 @@ function ANSIEscapeParser(options) {
 
             switch (charCode) {
                 case CR:
-                    self.emit('literal', text.slice(start, pos));
+                    self.emit('literal', text.slice(start, pos + 1));
-                    start = pos;
+                    start = pos + 1;
 
                     self.column = 1;
 
@@ -105,8 +111,8 @@ function ANSIEscapeParser(options) {
                         self.column = 1;
                     }
 
-                    self.emit('literal', text.slice(start, pos));
+                    self.emit('literal', text.slice(start, pos + 1));
-                    start = pos;
+                    start = pos + 1;
 
                     self.row += 1;
 
@@ -114,13 +120,16 @@ function ANSIEscapeParser(options) {
                     break;
 
                 default:
-                    if (self.column === self.termWidth) {
+                    if (self.column === self.breakWidth) {
                         self.emit('literal', text.slice(start, pos + 1));
                         start = pos + 1;
 
+                        // If we hit breakWidth before termWidth then we need to force the terminal to go to the next line.
+                        if(self.column < self.termWidth) {
+                            self.emit('literal', '\r\n');
+                        }
                         self.column = 1;
                         self.row += 1;
-
                         self.positionUpdated();
                     } else {
                         self.column += 1;
@@ -135,7 +144,7 @@ function ANSIEscapeParser(options) {
         //
         //  Finalize this chunk
         //
-        if (self.column > self.termWidth) {
+        if (self.column > self.breakWidth) {
             self.column = 1;
             self.row += 1;
 

core/art.js

@@ -41,11 +41,21 @@ const SUPPORTED_ART_TYPES = {
 };
 
 function getFontNameFromSAUCE(sauce) {
-    if (sauce.Character) {
+    if (sauce && sauce.Character) {
         return sauce.Character.fontName;
     }
 }
 
+function getWidthFromSAUCE(sauce) {
+    if (sauce && sauce.Character) {
+        let sauceWidth = _.toNumber(sauce.Character.characterWidth);
+        if(!(_.isNaN(sauceWidth)) && sauceWidth > 0) {
+            return sauceWidth;
+        }
+    }
+    return null;
+}
+
 function sliceAtEOF(data, eofMarker) {
     let eof = data.length;
     const stopPos = Math.max(data.length - 256, 0); //  256 = 2 * sizeof(SAUCE)
@@ -274,6 +284,7 @@ function display(client, art, options, cb) {
         mciReplaceChar: options.mciReplaceChar,
         termHeight: client.term.termHeight,
         termWidth: client.term.termWidth,
+        artWidth: getWidthFromSAUCE(options.sauce),
         trailingLF: options.trailingLF,
         startRow: options.startRow,
     });

docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:14-buster-slim
+FROM node:18-buster-slim
 
 LABEL maintainer="dave@force9.org"
 
@@ -21,8 +21,10 @@ RUN apt-get update \
     lhasa \
     unrar-free \
     p7zip-full \
+    dos2unix \
+    && npm install -g npm@latest \
     && npm install -g pm2 \
-    && cd /enigma-bbs && npm install --only=production \
+    && cd /enigma-bbs && npm install \
     && pm2 start main.js \
     && mkdir -p /enigma-bbs-pre/art \
     && mkdir /enigma-bbs-pre/mods \
@@ -37,6 +39,7 @@ RUN apt-get update \
 
 # sexyz
 COPY docker/bin/sexyz /usr/local/bin
+RUN dos2unix /enigma-bbs/docker/bin/docker-entrypoint.sh && apt-get remove dos2unix -y
 RUN chmod +x /enigma-bbs/docker/bin/docker-entrypoint.sh
 
 # enigma storage mounts

docs/Gemfile

@@ -30,3 +30,4 @@ end
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
+gem "webrick"

docs/_config.yml

@@ -54,6 +54,7 @@ collections:
       - installation/network.md
       - installation/testing.md
       - installation/production.md
+      - installation/development.md
       - configuration/creating-config.md
       - configuration/sysop-setup.md
       - configuration/config-files.md

docs/_docs/installation/development.md

@@ -0,0 +1,38 @@
+---
+layout: page
+title: Development Environment Setup
+---
+_Note:_ This is only useful for people who are looking to contribute to the ENiGMA½ source base itself. Those that are just setting up a new BBS system do not need this section.
+
+The easiest way to get started with development on ENiGMA½ is via the pre-configured Visual Studio Code remote docker container environment. This setup will download and configure everything needed with minimal interaction. It also works cross-platform.
+
+* Install [Visual Studio Code](https://code.visualstudio.com/download)
+* Install [Docker](https://docs.docker.com/engine/install/)
+* Clone the [ENiGMA½](https://github.com/NuSkooler/enigma-bbs) repository.
+* Choose "Open Folder" from Visual Studio Code and open the location where you cloned the repository.
+
+That's it! Visual Studio Code should prompt you for everything else that is needed, including some useful extensions for development.
+
+## Tasks
+
+Once it completes, there are a few tasks and run-configs that are useful.  Open up the command pallete and search/choose "Tasks> Run Task". From there you can run the following tasks:
+
+### Start Jekyll (ENiGMA½ documentation server)
+
+This task will start the Jekyll server to perform local testing of changes to documentation. After running this task, open a browser to (http://localhost:4000/enigma-bbs/) to see the documentation.
+
+### (re)build Jekyll bundles
+
+When the image is created the Jekyll bundles are installed, so in general there shouldn't be much need to run this task. This is available however in case soemthing goes wrong or you are working on the Jekyll setup itself.
+
+### (re)build node modules
+
+Used to re-generate the node modules. Generally shouldn't be necessary unless something is broken or you are adding/changing versions of dependencies.
+
+### ENiGMA½ new configuration
+
+This task executes `oputil.js` in order to create a new BBS configuration (useful if you have just checked out the code and haven't setup any configuration yet.)
+
+## Run / Debug config
+
+There is also a default "Launch Program" config (hotkey access via F5 / Ctrl-Shift-D.) This will launch ENiGMA½. Once it has launched, access the system via telnet, port 8888 as usual.

docs/_docs/installation/docker.md

@@ -71,5 +71,9 @@ Customising the Docker image is easy!
 1. Clone the ENiGMA-BBS source.
 2. Build the image
 ```bash
-docker build -f ./docker/Dockerfile .
+docker build -t enigmabbs -f ./docker/Dockerfile .
+```
+3. Run the image
+```bash
+docker run -it -p 8888:8888 --name "ENiGMABBS" -v "$(pwd)/config:/enigma-bbs/config" -v "$(pwd)/db:/enigma-bbs/db" -v "$(pwd)/logs:/enigma-bbs/logs" -v "$(pwd)/filebase:/enigma-bbs/filebase" -v "$(pwd)/art:/enigma-bbs/art" -v "$(pwd)/mods:/enigma-bbs/mods" -v "$(pwd)/mail:/mail" enigmabbs
 ```