Sync up with master

.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,32 @@
+{
+    "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"
+            ]
+        }
+    }
+}

.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

@@ -10,5 +10,4 @@ logs/
 mail/
 node_modules/
 docs/_site/
-docs/.sass-cache/
+docs/.sass-cache/
-.vscode/

.vscode/extensions.json

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

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // 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

@@ -17,6 +17,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
 * New `NewUserPrePersist` system event available to developers to 'hook' account creation and add their own properties/etc.
 * The signature for `viewValidationListener`'s callback has changed: It is now `(err, newFocusId)`. To ignore a validation error, implementors can simply call the callback with a `null` error, else they should forward it on.
 * The Menu Flag `popParent` has been removed and `noHistory` has been updated to work as expected. In general things should "Just Work", but do see [UPGRADE](UPGRADE.md) for additional details.
+* 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

core/achievement.js

@@ -505,9 +505,9 @@ class Achievements {
     getFormatObject(info) {
         return {
             userName: info.user.username,
-            userRealName: info.user.properties[UserProps.RealName],
+            userRealName: info.user.realName(false) || 'N/A',
-            userLocation: info.user.properties[UserProps.Location],
+            userLocation: info.user.properties[UserProps.Location] || 'N/A',
-            userAffils: info.user.properties[UserProps.Affiliations],
+            userAffils: info.user.properties[UserProps.Affiliations] || 'N/A',
             nodeId: info.client.node,
             title: info.details.title,
             //text            : info.global ? info.details.globalText : info.details.text,

core/ansi_escape_parser.js

@@ -24,7 +24,7 @@ function ANSIEscapeParser(options) {
     this.graphicRendition = {};
 
     this.parseState = {
-        re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsu])/g, //  eslint-disable-line no-control-regex
+        re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsutEFGST])/g, //  eslint-disable-line no-control-regex
     };
 
     options = miscUtil.valueWithDefault(options, {
@@ -231,7 +231,7 @@ function ANSIEscapeParser(options) {
         self.parseState = {
             //  ignore anything past EOF marker, if any
             buffer: input.split(String.fromCharCode(0x1a), 1)[0],
-            re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsu])/g, //  eslint-disable-line no-control-regex
+            re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsutEFGST])/g, //  eslint-disable-line no-control-regex
             stop: false,
         };
     };

core/art.js

@@ -41,13 +41,13 @@ const SUPPORTED_ART_TYPES = {
 };
 
 function getFontNameFromSAUCE(sauce) {
-    if (sauce.Character) {
+    if (sauce && sauce.Character) {
         return sauce.Character.fontName;
     }
 }
 
 function getWidthFromSAUCE(sauce) {
-    if (sauce.Character) {
+    if (sauce && sauce.Character) {
         let sauceWidth = _.toNumber(sauce.Character.characterWidth);
         if (!_.isNaN(sauceWidth) && sauceWidth > 0) {
             return sauceWidth;

core/client_connections.js

@@ -87,7 +87,7 @@ function getActiveConnectionList(
         //
         entry.text = ac.user?.username || 'N/A';
         entry.userName = ac.user?.username || 'N/A';
-        entry.realName = ac.user?.getProperty(UserProps.RealName) || 'N/A';
+        entry.realName = ac.user?.realName(false) || 'N/A';
         entry.location = ac.user?.getProperty(UserProps.Location) || 'N/A';
         entry.affils = entry.affiliation =
             ac.user?.getProperty(UserProps.Affiliations) || 'N/A';

core/fse.js

@@ -1017,11 +1017,7 @@ exports.FullScreenEditorModule =
                                     const area = getMessageAreaByTag(self.messageAreaTag);
                                     if (fromView !== undefined) {
                                         if (area && area.realNames) {
-                                            fromView.setText(
+                                            fromView.setText(self.client.user.realName());
-                                                self.client.user.properties[
-                                                    UserProps.RealName
-                                                ] || self.client.user.username
-                                            );
                                         } else {
                                             fromView.setText(self.client.user.username);
                                         }

core/my_messages.js

@@ -4,7 +4,6 @@
 //  ENiGMA½
 const { MenuModule, MenuFlags } = require('./menu_module');
 const Message = require('./message.js');
-const UserProps = require('./user_property.js');
 const { filterMessageListByReadACS } = require('./message_area.js');
 
 exports.moduleInfo = {
@@ -21,10 +20,7 @@ exports.getModule = class MyMessagesModule extends MenuModule {
 
     initSequence() {
         const filter = {
-            toUserName: [
+            toUserName: [this.client.user.username, this.client.user.realName()],
-                this.client.user.username,
-                this.client.user.getProperty(UserProps.RealName),
-            ],
             sort: 'modTimestamp',
             resultType: 'messageList',
             limit: 1024 * 16, //  we want some sort of limit...

core/nua.js

@@ -13,6 +13,7 @@ const UserProps = require('./user_property.js');
 
 //  deps
 const _ = require('lodash');
+const moment = require('moment');
 
 exports.moduleInfo = {
     name: 'NUA',
@@ -95,15 +96,15 @@ exports.getModule = class NewUserAppModule extends MenuModule {
                 areaTag = areaTag || '';
 
                 newUser.properties = {
-                    [UserProps.RealName]: formData.value.realName,
+                    [UserProps.RealName]: formData.value.realName || '',
                     [UserProps.Birthdate]: getISOTimestampString(
-                        formData.value.birthdate
+                        formData.value.birthdate || moment()
                     ),
-                    [UserProps.Sex]: formData.value.sex,
+                    [UserProps.Sex]: formData.value.sex || '',
-                    [UserProps.Location]: formData.value.location,
+                    [UserProps.Location]: formData.value.location || '',
-                    [UserProps.Affiliations]: formData.value.affils,
+                    [UserProps.Affiliations]: formData.value.affils || '',
-                    [UserProps.EmailAddress]: formData.value.email,
+                    [UserProps.EmailAddress]: formData.value.email || '',
-                    [UserProps.WebAddress]: formData.value.web,
+                    [UserProps.WebAddress]: formData.value.web || '',
                     [UserProps.AccountCreated]: getISOTimestampString(),
 
                     [UserProps.MessageConfTag]: confTag,

core/user.js

@@ -128,18 +128,29 @@ module.exports = class User {
         return isMember;
     }
 
-    getSanitizedName(type = 'username') {
+    realName(withUsernameFallback = true) {
-        let name;
+        const realName = this.getProperty(UserProps.RealName);
-        switch (type) {
+        if (realName) {
-            case 'real':
+            return realName;
-                name = this.getProperty(UserProps.RealName) || this.username;
-                break;
-            default:
-                name = this.username;
         }
+        if (withUsernameFallback) {
+            return this.username;
+        }
+    }
+
+    getSanitizedName(type = 'username') {
+        const name = 'real' === type ? this.realName(true) : this.username;
         return sanatizeFilename(name) || `user${this.userId.toString()}`;
     }
 
+    emailAddress() {
+        const email = this.getProperty(UserProps.EmailAddress);
+        if (email) {
+            const realName = this.realName(false);
+            return realName ? `${realName} <${email}>` : email;
+        }
+    }
+
     isAvailable() {
         return (this.statusFlags & User.StatusFlags.NotAvailable) == 0;
     }

core/user_2fa_otp_web_register.js

@@ -95,9 +95,7 @@ module.exports = class User2FA_OTPWebRegister {
                     }
 
                     const message = {
-                        to: `${
+                        to: user.emailAddress(),
-                            user.getProperty(UserProps.RealName) || user.username
-                        } <${user.getProperty(UserProps.EmailAddress)}>`,
                         //  from will be filled in
                         subject: '2-Factor Authentication Registration',
                         text: textTemplate,

core/user_config.js

@@ -116,15 +116,15 @@ exports.getModule = class UserConfigModule extends MenuModule {
                 formData = _.clone(formData);
 
                 const newProperties = {
-                    [UserProps.RealName]: formData.value.realName,
+                    [UserProps.RealName]: formData.value.realName || '',
                     [UserProps.Birthdate]: getISOTimestampString(
-                        formData.value.birthdate
+                        formData.value.birthdate || moment()
                     ),
-                    [UserProps.Sex]: formData.value.sex,
+                    [UserProps.Sex]: formData.value.sex || '',
-                    [UserProps.Location]: formData.value.location,
+                    [UserProps.Location]: formData.value.location || '',
-                    [UserProps.Affiliations]: formData.value.affils,
+                    [UserProps.Affiliations]: formData.value.affils || '',
-                    [UserProps.EmailAddress]: formData.value.email,
+                    [UserProps.EmailAddress]: formData.value.email || '',
-                    [UserProps.WebAddress]: formData.value.web,
+                    [UserProps.WebAddress]: formData.value.web || '',
                     [UserProps.TermHeight]: formData.value.termHeight.toString(),
                     [UserProps.ThemeId]:
                         self.availThemeInfo[formData.value.theme].themeId,
@@ -237,7 +237,7 @@ exports.getModule = class UserConfigModule extends MenuModule {
                         self.setViewText(
                             'menu',
                             MciCodeIds.RealName,
-                            user.properties[UserProps.RealName]
+                            user.realName(false) || ''
                         );
                         self.setViewText(
                             'menu',

core/web_password_reset.js

@@ -146,9 +146,7 @@ class WebPasswordReset {
                     }
 
                     const message = {
-                        to: `${user.properties[UserProps.RealName] || user.username} <${
+                        to: user.emailAddress(),
-                            user.properties[UserProps.EmailAddress]
-                        }>`,
                         //  from will be filled in
                         subject: 'Forgot Password',
                         text: textTemplate,

core/wfc.js

@@ -506,9 +506,7 @@ exports.getModule = class WaitingForCallerModule extends MenuModule {
 
             //  Current
             currentUserName: this.client.user.username,
-            currentUserRealName:
+            currentUserRealName: this.client.user.realName(false) || 'N/A',
-                this.client.user.getProperty(UserProps.RealName) ||
-                this.client.user.username,
             availIndicator: availIndicator,
             visIndicator: visIndicator,
             lastLoginUserName: lastLoginStats.userName,

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/Gemfile.lock

@@ -6,8 +6,8 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
+    addressable (2.8.5)
-      public_suffix (>= 2.0.2, < 5.0)
+      public_suffix (>= 2.0.2, < 6.0)
     colorator (1.1.0)
     concurrent-ruby (1.2.2)
     cssminify2 (2.0.1)
@@ -19,14 +19,14 @@ GEM
     ffi (1.15.5)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
-    html-pipeline (2.14.0)
+    html-pipeline (2.14.3)
       activesupport (>= 2)
       nokogiri (>= 1.4)
     htmlcompressor (0.4.0)
     http_parser.rb (0.8.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jekyll (4.2.1)
+    jekyll (4.2.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -49,7 +49,7 @@ GEM
       uglifier (~> 4.1)
     jekyll-relative-links (0.6.1)
       jekyll (>= 3.3, < 5.0)
-    jekyll-sass-converter (2.1.0)
+    jekyll-sass-converter (2.2.0)
       sassc (> 2.0.1, < 3.0)
     jekyll-seo-tag (2.7.1)
       jekyll (>= 3.8, < 5.0)
@@ -64,30 +64,30 @@ GEM
       gemoji (~> 3.0)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.6.1)
+    json (2.6.3)
     json-minify (0.0.3)
       json (> 0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    liquid (4.0.3)
+    liquid (4.0.4)
-    listen (3.7.1)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
     minitest (5.19.0)
-    nokogiri (1.14.3-x86_64-linux)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.6)
+    public_suffix (5.0.3)
-    racc (1.6.2)
+    racc (1.7.1)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.5)
+    rexml (3.2.6)
-    rouge (3.28.0)
+    rouge (3.30.0)
     safe_yaml (1.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
@@ -98,6 +98,7 @@ GEM
     uglifier (4.2.0)
       execjs (>= 0.3.0, < 3)
     unicode-display_width (1.8.0)
+    webrick (1.8.1)
 
 PLATFORMS
   x86_64-linux
@@ -111,6 +112,7 @@ DEPENDENCIES
   jekyll-theme-hacker (~> 0.2.0)
   jemoji (~> 0.12.0)
   tzinfo-data
+  webrick
 
 BUNDLED WITH
-   2.3.5
+   2.4.19

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.