Compare commits

...

298 Commits

Author SHA1 Message Date
Bryan Ashby 6aa0c8679f
Merge pull request #520 from NuSkooler/feature/multiarch_docker
Feature/multiarch docker
2023-10-15 17:34:09 -06:00
Nathan Byrd 6b169de3ac Added missing change directory 2023-10-15 20:43:31 +00:00
Nathan Byrd 362f443290 Changed copy to directory location 2023-10-15 20:37:35 +00:00
Nathan Byrd 8a97f79d8c Removed old python package 2023-10-15 20:22:16 +00:00
Nathan Byrd f17bbe7c5a Updated docker support 2023-10-15 20:17:47 +00:00
Bryan Ashby 8c7df1fe75 Oops! 2023-10-12 20:41:59 -06:00
Bryan Ashby b00d5d07dd
Merge pull request #510 from NuSkooler/bugfix/scrolling_updates
Bugfix/scrolling updates
2023-10-12 20:36:54 -06:00
Bryan Ashby bbfef536e0
Merge pull request #489 from NuSkooler/bugfix/node_v20
Updated node-pty to support new node versions
2023-10-12 20:28:00 -06:00
Bryan Ashby 83636cb894 Sync up with master 2023-10-12 20:25:01 -06:00
Bryan Ashby ca985dd2cb Fix onExit(): emits a object containing exitCode and signal 2023-10-12 20:21:49 -06:00
Bryan Ashby b87ff51160 Merge branch 'bugfix/node_v20' of github.com:NuSkooler/enigma-bbs into bugfix/node_v20 2023-10-12 20:06:10 -06:00
Bryan Ashby 746233fa56 Updated lock 2023-10-12 20:05:45 -06:00
Bryan Ashby c84b3ee1c1
Merge pull request #515 from NuSkooler/bugfix/ssh_doc_updates
Updated the SSH version, config, and documentation
2023-10-11 19:43:21 -06:00
Nathan Byrd 270c09eb80 Added a sentence 2023-10-11 00:28:13 +00:00
Nathan Byrd f5b0a8bb60 Updated the SSH version, config, and documentation 2023-10-11 00:19:43 +00:00
Bryan Ashby 1a99153431
Merge pull request #514 from NuSkooler/bugfix/dev_env_python
Small bugfix on dev container startup to lock python version
2023-10-10 16:52:42 -06:00
Nathan Byrd 88a1b0ea69 locked python version to fix startup issue 2023-10-10 20:42:15 +00:00
Nathan Byrd 498c4a6082 Additional API changes 2023-10-10 19:43:58 +00:00
Nathan Byrd 577992bbe5 Changes to API for node-pty 2023-10-10 19:33:25 +00:00
Bryan Ashby db8bd2f80f
Merge pull request #511 from AnthonyHarwood/fse_err_msg_display_tweak
fse err msg display tweak
2023-09-29 12:01:05 -06:00
anthony 0161c22401 clear prior message; msg tweak for empty field 2023-09-28 11:05:10 -05:00
Nathan Byrd 402c5d0156 Merge branch 'master' into bugfix/scrolling_updates 2023-09-27 20:56:04 +00:00
anthony 5998144071 Merge branch 'bugfix/ftn_address_fromString' of https://github.com/AnthonyHarwood/enigma-bbs into bugfix/ftn_address_fromString 2023-09-27 15:52:00 -05:00
anthony d12b0789aa Added checks for undefined 2023-09-27 15:51:33 -05:00
Bryan Ashby a644672de2
Merge pull request #504 from AnthonyHarwood/disallow_posting_empty_msg
Disallow posting empty message
2023-09-26 17:17:18 -06:00
Bryan Ashby b0542cf51e
Merge pull request #508 from NuSkooler/bugfix/doors_socket
Fixed door logic per issue #506
2023-09-26 17:15:04 -06:00
Nathan Byrd 0ca22de6e9 Added back in unused escape codes for backwards compat 2023-09-26 22:02:49 +00:00
Nathan Byrd 394ac465c8 Merge remote-tracking branch 'origin/master' into bugfix/scrolling_updates 2023-09-26 21:50:04 +00:00
anthony 2b6494cfc9 Added checks for undefined 2023-09-26 16:14:10 -05:00
Nathan Byrd dddbad4541
Merge pull request #507 from AnthonyHarwood/bugfix/private_mail_menu_template
Removed extraneous space from private mail config template
2023-09-26 09:09:18 -05:00
Nathan Byrd 1d31b268aa Fixed door logic per issue #506 2023-09-26 14:00:05 +00:00
anthony 0e09ce491c Removed extraneous space from config template 2023-09-26 08:43:23 -05:00
anthony a6196c38ec Disallow posting empty message 2023-09-25 20:25:01 -05:00
Nathan Byrd 450ba65565 Fixed missing ansi codes causing formatting misses 2023-09-24 20:39:57 +00:00
Bryan Ashby fc107f1552
Merge pull request #503 from AnthonyHarwood/bugfix/TextView_clearText
Added code to clear the text
2023-09-22 15:57:19 -06:00
anthony f719499c65 Merge branch 'bugfix/TextView_clearText' of https://github.com/AnthonyHarwood/enigma-bbs into bugfix/TextView_clearText 2023-09-22 14:07:50 -05:00
anthony 75fa2026c0 Added code to clear the text 2023-09-22 14:05:16 -05:00
anthony 5180447e87 Added code to clear the text 2023-09-22 10:33:42 -05:00
Nathan Byrd 72a8546d74 Removed special handling of backspace and form feed 2023-09-22 01:18:38 +00:00
Bryan Ashby 19ee4b0553
Merge pull request #502 from NuSkooler/dependabot/npm_and_yarn/systeminformation-5.21.7
Bump systeminformation from 5.12.3 to 5.21.7
2023-09-21 11:50:26 -06:00
dependabot[bot] d3cf82b563
Bump systeminformation from 5.12.3 to 5.21.7
Bumps [systeminformation](https://github.com/sebhildebrandt/systeminformation) from 5.12.3 to 5.21.7.
- [Changelog](https://github.com/sebhildebrandt/systeminformation/blob/master/CHANGELOG.md)
- [Commits](https://github.com/sebhildebrandt/systeminformation/compare/v5.12.3...v5.21.7)

---
updated-dependencies:
- dependency-name: systeminformation
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-21 17:24:32 +00:00
Nathan Byrd 79a3f4e1ce Handle deleting rows / columns 2023-09-20 23:52:34 +00:00
Nathan Byrd c0c262c971 Added insert and delete rows 2023-09-20 23:30:01 +00:00
Nathan Byrd 826db2d718 Added scrolling. 2023-09-20 23:00:32 +00:00
Nathan Byrd f3c9afc684 Added F and G 2023-09-20 21:40:59 +00:00
Nathan Byrd 372d84f572 Added backspace 2023-09-20 21:23:00 +00:00
Nathan Byrd 8029521399 changed handling of regex 2023-09-20 21:19:03 +00:00
Bryan Ashby 86049353a9
Merge pull request #501 from AnthonyHarwood/fse_cursor_position
fixed incorrect reporting of cursor position
2023-09-20 13:49:35 -06:00
Nathan Byrd 855fabe34d Added additional vt100 codes 2023-09-20 13:44:54 +00:00
anthony 6748b8966e fixed incorrect reporting of cursor position 2023-09-19 13:14:24 -05:00
Nathan Byrd 5712645299 Added additional characters that change position 2023-09-19 01:39:04 +00:00
Nathan Byrd a99b55abb5 Added support for some non-bracket escape sequences 2023-09-19 01:04:36 +00:00
Nathan Byrd d8f45f9147 Removed unused code 2023-09-18 23:36:27 +00:00
Nathan Byrd 08841528e2 Initial versions of new bansi codes 2023-09-18 23:35:44 +00:00
Bryan Ashby 5e120d1749
Merge pull request #498 from NuSkooler/bugfix/fix_art_length
Bugfix/fix art length
2023-09-05 22:50:57 -06:00
Nathan Byrd 06c3d100d7 Updated length for message list 2023-09-05 20:41:40 +00:00
Nathan Byrd 3adbb517e8 Updated art lengths to be 24 lines 2023-09-05 14:55:57 -05:00
Bryan Ashby bfb6a30860
Merge pull request #497 from NuSkooler/bugfix/github_action
Updated Docker action
2023-09-03 21:21:13 -06:00
Nathan Byrd e87e7ad277 Updated Docker action 2023-09-03 21:35:50 -05:00
Bryan Ashby e2bb00b756 Merge branch 'master' of github.com:NuSkooler/enigma-bbs 2023-09-03 11:02:29 -06:00
Bryan Ashby f4a90900ae TIC attachment doc updates 2023-09-03 11:01:43 -06:00
Bryan Ashby b307e791c3
Merge pull request #495 from NuSkooler/bugfix/pablodraw_ansi
Added additional escape control sequences for PabloDraw
2023-09-02 23:02:34 -06:00
Nathan Byrd 6fb77f3a5f Added additional escape control sequences 2023-09-02 23:50:41 -05:00
Bryan Ashby e8441408c0
Merge pull request #493 from NuSkooler/bugfix/Gemfile_lock
Updated Gemfile.lock to fix Github Actions failure
2023-08-30 15:36:48 -06:00
Nathan Byrd 60ee842c71 Updated Gemfile.lock to fix Github Actions failure 2023-08-30 19:14:20 +00:00
Bryan Ashby de918dd338
Merge pull request #480 from NuSkooler/479-nua-optional-fields
Make real name and other properties optional - pass 1
2023-08-29 20:43:14 -06:00
Bryan Ashby 367931cbd6
Merge branch 'master' into 479-nua-optional-fields 2023-08-29 20:43:00 -06:00
Bryan Ashby 1af4a0432b
Merge pull request #492 from NuSkooler/feature/docker_dev
Setup Docker development environment
2023-08-29 20:42:03 -06:00
Nathan Byrd 1bd328452b Added documentation for development setup 2023-08-28 15:39:19 -05:00
Nathan Byrd c2d7abc94e Removed browse task as it won't run without debugging 2023-08-28 14:17:47 -05:00
Nathan Byrd 602d693caf Added additional local extensions 2023-08-28 13:10:38 -05:00
Nathan Byrd 5f0a03638e Added some handy extensions and tasks 2023-08-28 13:08:54 -05:00
Nathan Byrd 8a6506c475 Additional changes needed to run 2023-08-27 19:04:17 -05:00
Bryan Ashby 97ae34a971 Quick fix on SAUCE 2023-08-27 17:31:35 -06:00
Bryan Ashby de339c9c52
Merge pull request #488 from NuSkooler/bugfix/art_width
Fix to display ANSI files with implicit new lines on wide terminals
2023-08-27 17:24:27 -06:00
Nathan Byrd 82c05c6e69 Merge branch 'master' into feature/docker_dev 2023-08-27 12:27:07 -05:00
Nathan Byrd 5ba1ca1464 Initial devcontainer setup 2023-08-27 12:25:36 -05:00
Bryan Ashby 3e1ec4477c
Merge pull request #491 from NuSkooler/feature/docker_dev
Docker Update
2023-08-26 21:11:26 -06:00
Nathan Byrd 13ae7789a5 No need to copy the ephemeral directories 2023-08-26 20:03:48 -05:00
Nathan Byrd 80dcc14a50 Small doc change to add running custom container 2023-08-26 11:05:39 -05:00
Nathan Byrd 1d00482b02 Updated node & added .dockerignore 2023-08-26 10:54:39 -05:00
Nathan Byrd adc2e1ba98 Fixed Dockerfile to run on Windows 2023-08-26 10:37:12 -05:00
Nathan Byrd 8758722b6b Fixed PR review comments 2023-08-25 18:34:45 -05:00
Nathan Byrd 4d70f07fde Updated node-pty to support new node versions 2023-08-25 15:59:35 -05:00
Nathan Byrd bf0bf83053 Small logic change to improve SAUCE handling 2023-08-25 14:38:32 -05:00
Nathan Byrd 7d46607ddc Updated the WHATSNEW to include info about the art change. 2023-08-25 14:33:28 -05:00
Nathan Byrd ccaaa71e23 Make the terminal go to new line if the width of the term is greater than the art width 2023-08-25 14:24:47 -05:00
Nathan Byrd 0b157ddd1b Changed ansi parser to use SAUCE width when available 2023-08-24 18:00:02 -05:00
Bryan Ashby 5a4563c799 PR feedback: Better handling of real name and email 2023-08-24 09:13:29 -06:00
Bryan Ashby 9205aaa9ee Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 479-nua-optional-fields 2023-08-24 08:53:03 -06:00
Bryan Ashby b11ddfc382
Merge pull request #466 from NuSkooler/dependabot/npm_and_yarn/http-cache-semantics-4.1.1
Bump http-cache-semantics from 4.1.0 to 4.1.1
2023-08-23 21:49:25 -06:00
Bryan Ashby 993bdbe484
Merge branch 'master' into dependabot/npm_and_yarn/http-cache-semantics-4.1.1 2023-08-23 21:49:10 -06:00
Bryan Ashby 7b4910c415
Merge pull request #467 from NuSkooler/dependabot/npm_and_yarn/sqlite3-5.1.5
Bump sqlite3 from 5.0.11 to 5.1.5
2023-08-23 21:48:20 -06:00
Bryan Ashby 18678d3e4d
Merge branch 'master' into dependabot/npm_and_yarn/sqlite3-5.1.5 2023-08-23 21:47:47 -06:00
Bryan Ashby c87543c976 Update SQLite to latest 2023-08-23 21:45:08 -06:00
Bryan Ashby 25e4de5384
Merge pull request #484 from NuSkooler/dependabot/npm_and_yarn/word-wrap-1.2.5
Bump word-wrap from 1.2.3 to 1.2.5
2023-08-23 21:38:46 -06:00
Bryan Ashby c6a6c06972
Merge pull request #487 from NuSkooler/menu-stack-and-flags-revamp
Update MenuFlags to work as expected
2023-08-23 19:07:56 -06:00
Bryan Ashby c12deb86ae
Merge pull request #485 from NuSkooler/dependabot/bundler/docs/activesupport-7.0.7.2
Bump activesupport from 7.0.4.1 to 7.0.7.2 in /docs
2023-08-23 19:07:35 -06:00
Bryan Ashby 2d1cbac390
Merge branch 'master' into dependabot/bundler/docs/activesupport-7.0.7.2 2023-08-23 19:07:10 -06:00
Bryan Ashby 08adf7ccb5
Merge pull request #486 from NuSkooler/dependabot/npm_and_yarn/semver-6.3.1
Bump semver from 6.3.0 to 6.3.1
2023-08-23 19:05:38 -06:00
dependabot[bot] 5857f46d11
Bump semver from 6.3.0 to 6.3.1
Bumps [semver](https://github.com/npm/node-semver) from 6.3.0 to 6.3.1.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v6.3.1/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v6.3.0...v6.3.1)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-08-24 01:03:10 +00:00
dependabot[bot] a1242b51aa
Bump activesupport from 7.0.4.1 to 7.0.7.2 in /docs
Bumps [activesupport](https://github.com/rails/rails) from 7.0.4.1 to 7.0.7.2.
- [Release notes](https://github.com/rails/rails/releases)
- [Changelog](https://github.com/rails/rails/blob/v7.0.7.2/activesupport/CHANGELOG.md)
- [Commits](https://github.com/rails/rails/compare/v7.0.4.1...v7.0.7.2)

---
updated-dependencies:
- dependency-name: activesupport
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-08-24 01:03:06 +00:00
Bryan Ashby f32bf090fb
Merge pull request #472 from NuSkooler/dependabot/bundler/docs/nokogiri-1.14.3
Bump nokogiri from 1.13.6 to 1.14.3 in /docs
2023-08-23 19:03:04 -06:00
dependabot[bot] 8e904f589d
Bump word-wrap from 1.2.3 to 1.2.5
Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.5.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](https://github.com/jonschlinkert/word-wrap/compare/1.2.3...1.2.5)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-08-24 01:03:03 +00:00
Bryan Ashby 02f91b2621
Merge pull request #473 from NuSkooler/dependabot/npm_and_yarn/minimatch-3.1.2
Bump minimatch from 3.0.4 to 3.1.2
2023-08-23 19:02:40 -06:00
Bryan Ashby 1cfbf4fb66 Update MenuFlags to work as expected
* 'popParent' has been removed
* 'noHistory' now works as expected
* Mods that explicitly want noHistory can state such in their constructor()
2023-08-23 18:06:48 -06:00
Bryan Ashby 614fa2d096
Merge pull request #482 from NuSkooler/bugfix/missing_image
Fixed bad image path
2023-08-21 19:17:52 -06:00
Nathan Byrd 67b5a8d99f Fixed bad image path 2023-08-21 19:58:16 -05:00
Bryan Ashby f99de19792 Make real name and other properties optional - pass 1 2023-07-24 12:17:47 -06:00
Bryan Ashby 77160434e6
Merge pull request #477 from parkbanks/master
Bugfix to theme.hjson
2023-06-19 11:56:08 -06:00
Parker J. Banks eca900f829
Update theme.hjson
Bugfix, change messageBaseSearchMessageList to messageBaseSearchResultsMessageList to match message_base.in.hjson
2023-06-19 10:43:25 -06:00
Bryan Ashby 9bac4f5e3b
Merge pull request #476 from parkbanks/master
Rumorz display bugfix
2023-05-22 09:09:43 -06:00
Parker J. Banks 8d6de56e91
Rumorz display bugfix
Updates rumorz module to display the N latest rumors, rather than the first N rumors.
2023-05-21 12:09:54 -06:00
Bryan Ashby 78af6fa522 Add oputil mb post command 2023-05-11 12:07:29 -06:00
Bryan Ashby 6ff7d1f545 Add oputil mb list-confs, update with prettier 2023-05-11 08:40:53 -06:00
Bryan Ashby 97cd0c3063 Merge branch 'master' of ssh://numinibsd/git/base/enigma-bbs 2023-04-25 10:24:51 -06:00
Bryan Ashby ac40f63e1f Clone data so it's not invalidated 2023-04-25 10:24:11 -06:00
dependabot[bot] c39cd613ef
Bump minimatch from 3.0.4 to 3.1.2
Bumps [minimatch](https://github.com/isaacs/minimatch) from 3.0.4 to 3.1.2.
- [Release notes](https://github.com/isaacs/minimatch/releases)
- [Changelog](https://github.com/isaacs/minimatch/blob/main/changelog.md)
- [Commits](https://github.com/isaacs/minimatch/compare/v3.0.4...v3.1.2)

---
updated-dependencies:
- dependency-name: minimatch
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-16 20:09:15 +00:00
dependabot[bot] 7cbe619235
Bump nokogiri from 1.13.6 to 1.14.3 in /docs
Bumps [nokogiri](https://github.com/sparklemotion/nokogiri) from 1.13.6 to 1.14.3.
- [Release notes](https://github.com/sparklemotion/nokogiri/releases)
- [Changelog](https://github.com/sparklemotion/nokogiri/blob/main/CHANGELOG.md)
- [Commits](https://github.com/sparklemotion/nokogiri/compare/v1.13.6...v1.14.3)

---
updated-dependencies:
- dependency-name: nokogiri
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-12 06:15:16 +00:00
Bryan Ashby 447be3552c Better error handling 2023-04-08 21:04:40 -06:00
Bryan Ashby a208d91d4b
Merge pull request #470 from stack-fault/master
Fixed PrivMsg delivery + added new server commands
2023-03-31 12:11:45 -06:00
Stack Fault 9a4433ee03 Fixed PrivMsg delivery + added new server commands 2023-03-31 13:46:07 -04:00
dependabot[bot] ddf412d34c
Bump sqlite3 from 5.0.11 to 5.1.5
Bumps [sqlite3](https://github.com/TryGhost/node-sqlite3) from 5.0.11 to 5.1.5.
- [Release notes](https://github.com/TryGhost/node-sqlite3/releases)
- [Commits](https://github.com/TryGhost/node-sqlite3/compare/v5.0.11...v5.1.5)

---
updated-dependencies:
- dependency-name: sqlite3
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-03-13 20:33:51 +00:00
dependabot[bot] 1bf7617404
Bump http-cache-semantics from 4.1.0 to 4.1.1
Bumps [http-cache-semantics](https://github.com/kornelski/http-cache-semantics) from 4.1.0 to 4.1.1.
- [Release notes](https://github.com/kornelski/http-cache-semantics/releases)
- [Commits](https://github.com/kornelski/http-cache-semantics/compare/v4.1.0...v4.1.1)

---
updated-dependencies:
- dependency-name: http-cache-semantics
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-04 15:21:17 +00:00
Bryan Ashby 3319b310d3
Merge pull request #464 from NuSkooler/dependabot/bundler/docs/activesupport-7.0.4.1
Bump activesupport from 7.0.1 to 7.0.4.1 in /docs
2023-01-18 16:05:52 -07:00
dependabot[bot] a5ef7d9da5
Bump activesupport from 7.0.1 to 7.0.4.1 in /docs
Bumps [activesupport](https://github.com/rails/rails) from 7.0.1 to 7.0.4.1.
- [Release notes](https://github.com/rails/rails/releases)
- [Changelog](https://github.com/rails/rails/blob/v7.0.4.1/activesupport/CHANGELOG.md)
- [Commits](https://github.com/rails/rails/compare/v7.0.1...v7.0.4.1)

---
updated-dependencies:
- dependency-name: activesupport
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-18 18:29:34 +00:00
Bryan Ashby 330d7190ff
Merge pull request #463 from NuSkooler/462-remove-no-longer-supported-combatnet
Remove no longer supported CombatNet
2023-01-16 11:07:11 -07:00
Bryan Ashby 30f965d981
Remove no longer supported CombatNet 2023-01-16 11:04:56 -07:00
Bryan Ashby c8dfecbfcc
Merge pull request #458 from NuSkooler/webserver-improvements
Bump version to 0.0.14-beta + major web server updates
2022-12-29 01:08:44 -07:00
Bryan Ashby 6578e55139
Update Web Server docs, remove 'static' requirement 2022-12-29 01:01:09 -07:00
Bryan Ashby c265a44c1a
Bump version to 0.0.14-beta + major web server updates 2022-12-29 00:56:10 -07:00
Bryan Ashby 7f0254701c
Ensure we have a message list 2022-12-14 19:56:43 -07:00
Bryan Ashby a4261d2d36
Fix bad check for missing areas (by tag) 2022-11-27 21:07:56 -07:00
Bryan Ashby d1f0a12f77
New options for launching local doors via the abracadabra module 2022-10-25 10:59:56 -06:00
Bryan Ashby b58c7e7cc6
Fix fsxNet link 2022-10-25 10:49:20 -06:00
Bryan Ashby 433ab17e9f
Update fsxNet links 2022-10-24 12:59:23 -06:00
Bryan Ashby ff616c384f
MenuModule.setConfigWithExtraArgs() 2022-10-13 22:43:41 -06:00
Bryan Ashby 94da8798cf
Merge pull request #454 from NuSkooler/text-label-with-mci-codes
Advanced formatting for TextView / %TL MCI code
2022-10-12 02:28:50 +00:00
Bryan Ashby 32b4c344a8
Fix docs, use node 14 2022-10-10 11:24:16 -06:00
Bryan Ashby a03b071256
Docs on new MCI formatting 2022-10-05 23:40:59 -06:00
Bryan Ashby 065658f6b8
First commit of "advanced" MCI formatting via theme.hjson entries allowing mini-formatting langauge to apply
Example: {BN!styleFirstLower} in 'text' property
2022-10-05 21:46:13 -06:00
Bryan Ashby 1021226020
Nuke %PL - never used, not needed 2022-10-05 21:07:56 -06:00
Bryan Ashby 6710bf8c08
Update docs 2022-10-04 11:19:27 -06:00
Bryan Ashby 091af5adea
More info on WFC in docs 2022-10-02 11:33:44 -06:00
Bryan Ashby c7568ac897
Fix visibility restore at WFC exit 2022-10-02 11:22:23 -06:00
Bryan Ashby 0ef3df047a
Merge branch 'master' of github.com:NuSkooler/enigma-bbs 2022-10-01 17:21:09 -06:00
Bryan Ashby a88cf6c34c
Fix logo 2022-10-01 17:20:55 -06:00
Bryan Ashby b3cf535b9d
Merge pull request #445 from NuSkooler/dependabot/npm_and_yarn/ansi-regex-4.1.1
Bump ansi-regex from 4.1.0 to 4.1.1
2022-10-01 18:29:55 +00:00
Bryan Ashby 73dafdad9f
Test out code scanning 2022-10-01 18:28:06 +00:00
Bryan Ashby fd01223578
Diff paths for README.md is annoying 2022-10-01 12:23:28 -06:00
Bryan Ashby 63514c1290
Le sigh 2022-10-01 12:20:54 -06:00
Bryan Ashby 8efc605a9e
Fix paths... 2022-10-01 12:14:44 -06:00
Bryan Ashby 5f7b81296e
Fix paths 2022-10-01 11:53:40 -06:00
Bryan Ashby cee25a7104
More docs on MenuModule 2022-10-01 11:43:56 -06:00
Bryan Ashby 1025fef346
Doc updates, tidy, group member info 2022-09-30 23:55:40 -06:00
Bryan Ashby d8bc02ce46
Catch timestamp error 2022-09-30 23:55:28 -06:00
Bryan Ashby 6e1c470b69
Merge pull request #451 from NuSkooler/449-nntp-write-access
Initial NNTP write access support

This will now be beta tested on Xibalba
2022-09-26 00:32:33 +00:00
Bryan Ashby 8c92f3cc49
Log IPs 2022-09-25 18:29:00 -06:00
Bryan Ashby c4518c7b94
Tidy/DRY 2022-09-25 14:00:52 -06:00
Bryan Ashby 1626db3d52
Clean up NNTP docs 2022-09-25 10:01:27 -06:00
Bryan Ashby 3155a0cd81
Fix docs 2022-09-25 09:56:16 -06:00
Bryan Ashby 5f6d70e460
Some fixes to NNTP POSTs, logging, etc. 2022-09-23 11:06:33 -06:00
Bryan Ashby 2cb0970a31
Add 'allowPosting' config 2022-09-22 21:24:24 -06:00
Bryan Ashby d2dafc4dbc
Initial NNTP write access support 2022-09-22 21:03:53 -06:00
Bryan Ashby e61be537aa
Minor bug fix 2022-09-21 08:26:52 -06:00
Bryan Ashby 28a94f842c
Update nttp-server dep to v3.1.0 2022-09-20 16:00:25 -06:00
Bryan Ashby c105a2601a
Add by filename support to FileEntry.findFiles() 2022-09-15 12:37:48 -06:00
Bryan Ashby ad44495469
Utility methods 2022-09-14 22:48:56 -06:00
Bryan Ashby a1188fb90c
Handle case where remoteAddress is not yet avail 2022-09-13 13:59:29 -06:00
Bryan Ashby 2a0ae05c45
Bail and log why if door 'io' config is bad 2022-09-08 21:31:01 -06:00
Bryan Ashby 62bcb8055a
Add some scripts and binaries to package - long overdue 2022-09-01 17:52:22 -06:00
Bryan Ashby 695bb40b17
More improved logging around client changes 2022-08-31 11:47:03 -06:00
Bryan Ashby 2d8c896ad4
Handle node status views when client disconnects 2022-08-31 11:46:51 -06:00
Bryan Ashby 8e17897954
Some docs cleanup 2022-08-30 21:57:27 -06:00
Bryan Ashby c06b777d34
Add wfc 2022-08-30 21:27:00 -06:00
Bryan Ashby edfc2f68a4
Fix pre-auth properties in user list 2022-08-23 16:56:40 -06:00
Bryan Ashby 4d6bc98a0f
Fix a dumb :( 2022-08-21 15:43:53 -06:00
Bryan Ashby 7060bf270b
Better debug logs 2022-08-21 15:41:37 -06:00
Bryan Ashby 4a63bc577e
Fix terminology used in code 2022-08-21 14:03:19 -06:00
Bryan Ashby 1f130347d5
Fix missing check 2022-08-21 14:02:47 -06:00
Bryan Ashby 92ca571e40
Update documentation around Gopher config 2022-08-21 13:43:03 -06:00
Bryan Ashby c8df7f3d6b
New easier to manage Gopher include/exclude areas with wildcard support
* Deprecate but still support older format for now
* Add new format allowing easier management
2022-08-21 13:27:32 -06:00
Bryan Ashby 8be8c21aa8
Minor doc tidy 2022-08-19 00:08:41 -06:00
Bryan Ashby d4341bf85f
Doc tidy 2022-08-19 00:03:25 -06:00
Bryan Ashby 94145c043a
Tidy tidy tidy 2022-08-18 14:55:57 -06:00
Bryan Ashby 226c261505
Change sort order for 'lastlogin' and 'created' sorts 2022-08-16 13:45:39 -06:00
dependabot[bot] e5a2044b88
Bump ansi-regex from 4.1.0 to 4.1.1
Bumps [ansi-regex](https://github.com/chalk/ansi-regex) from 4.1.0 to 4.1.1.
- [Release notes](https://github.com/chalk/ansi-regex/releases)
- [Commits](https://github.com/chalk/ansi-regex/compare/v4.1.0...v4.1.1)

---
updated-dependencies:
- dependency-name: ansi-regex
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-08-16 18:20:48 +00:00
Bryan Ashby b971876795
Table output, more fields, and --sort for './oputil.js user list' 2022-08-16 12:19:49 -06:00
Bryan Ashby 5b1c11b1bc
Fix typo 2022-08-15 22:37:28 -06:00
Bryan Ashby b48d133229
Fix some view offsets that broke with CPR removal
* Fix Quote builder
* Fix File Browser details
* Added 'viewOffsets' ability to loadFromMenuConfig() and friends
* Add MenuModule.getCustomViewsWithFilter() -> Array[] of views
* Add ViewController.applyViewOffsets()
2022-08-15 22:23:14 -06:00
Bryan Ashby 56f03ff847
Moar better logging 2022-08-13 18:13:30 -06:00
Bryan Ashby a48f2b4067
Tidy up more log messages 2022-08-13 11:51:11 -06:00
Bryan Ashby 21d0ad9e59
Change scann/toss watch msg again, use access() over exists() 2022-08-13 10:49:44 -06:00
Bryan Ashby 2e159a0cc6
Don't call paths.join() twice in a row here 2022-08-13 10:36:21 -06:00
Bryan Ashby 1d14b187c2
Fix undefined ref 2022-08-12 19:50:41 -06:00
Bryan Ashby 8552e2dd35
Doc updates 2022-08-12 19:21:45 -06:00
Bryan Ashby cc788056ea
Tidy 2022-08-12 14:28:18 -06:00
Bryan Ashby c9d9b5336c
Minor lifecycle cleanup 2022-08-09 15:37:14 -06:00
Bryan Ashby fdfd64976b
Lots more MenuModule info 2022-08-09 14:41:23 -06:00
Bryan Ashby 1402391234
Fix missing code closing in doc 2022-08-08 22:26:18 -06:00
Bryan Ashby ad2d5e379a
More information on MenuModule's 2022-08-08 22:19:20 -06:00
Bryan Ashby 8adb0363e0
Better organization... a little 2022-08-08 20:15:23 -06:00
Bryan Ashby 2cae154977
Update MenuModule docs slightly 2022-08-07 13:06:47 -06:00
Bryan Ashby d13d90e223
Sigh 2022-08-07 11:49:52 -06:00
Bryan Ashby c1f5086db0
Fix a dumb 2022-08-07 11:48:51 -06:00
Bryan Ashby 56c92b7a86
Add basic menu lifecycle image 2022-08-06 22:51:59 -06:00
Bryan Ashby 81595f87e1
Log updates 2022-08-06 21:43:32 -06:00
Bryan Ashby 561f0464f2
README updates 2022-08-06 20:55:02 -06:00
Bryan Ashby ab87ec3936
Fix link 2022-08-06 20:48:25 -06:00
Bryan Ashby 1b3933a9d2
Add TROUBLESHOOTING.md 2022-08-06 20:25:10 -06:00
Bryan Ashby f3d0da2075
Fix dumb bug with 'focusItemAtTop' 2022-08-06 00:43:26 -06:00
Bryan Ashby 695dc3944e
Merge pull request #444 from NuSkooler/various-dep-updates-2022-aug
Various dependency updates including node-sqlite

Resolves
Update node-sqlite to 5.0.2+ #398
2022-08-05 22:59:16 -06:00
Bryan Ashby 8c68e51ecf
Fix typo in 'totalBytes' for WFC stats 2022-08-05 14:45:43 -06:00
Bryan Ashby 59aebf385e
Update sqlite3-trans and node-sqlite to latest versions 2022-08-04 17:40:29 -06:00
Bryan Ashby c2504d903a
Glob minor update 2022-08-04 16:36:09 -06:00
Bryan Ashby 0b18e78a54
Update telnet-socket dep 2022-08-04 16:30:00 -06:00
Bryan Ashby 8f54d0bd7b
Low hanging fruit dep updates 2022-08-04 16:29:29 -06:00
Bryan Ashby 5b7b1a5b74
Update docs slighty, add link 2022-08-04 13:47:49 -06:00
Bryan Ashby 3789de76a4
Add missing WFC help screen 2022-08-04 13:13:37 -06:00
Bryan Ashby cb8ebc780b
Fix typo for status indicators 2022-08-04 13:04:45 -06:00
Bryan Ashby a6f7fe40c6
Merge pull request #431 from NuSkooler/216-waiting-for-caller
#216: Initial Waiting for Caller (WFC) Support
2022-08-04 12:38:14 -06:00
Bryan Ashby 39b3aeaedf Fix bug in ensuring at least default ACS or ACS with 'SC' is used for WFC 2022-08-04 12:24:02 -06:00
Bryan Ashby a4b9253075
Add missing remoteAddress key 2022-08-04 11:38:05 -06:00
Bryan Ashby 95183fd3b3
Cleanup, docs, screen shot of WFC 2022-08-04 11:32:09 -06:00
Bryan Ashby 8a351ecd7d
WFC Luciano Blocktronics theme 2022-08-04 10:52:59 -06:00
Bryan Ashby 7268ca9bd6
Fix a dumb bug with theme switching; Add TODO to clean this up 2022-08-04 10:52:43 -06:00
Bryan Ashby 715202680e
Add Process/enig start ingress/egress bytes stats 2022-08-01 23:09:18 -06:00
Bryan Ashby 044cc24418
Merge with master 2022-08-01 20:54:05 -06:00
Bryan Ashby 50fc29be48
Merge pull request #441 from cognitivegears/feature/Choose_Encoding
Feature/choose encoding
2022-08-01 15:02:37 -06:00
Nathan Byrd 40d38c55d7 Additional documentation change 2022-07-31 13:29:01 -05:00
Nathan Byrd 4baba90fc4 Documentation changes 2022-07-31 13:17:51 -05:00
Nathan Byrd c799f1f73c Code review changes 2022-07-31 12:53:34 -05:00
Nathan Byrd a2e6088238 Added documentation for the new encoding selection function 2022-07-28 16:38:05 -05:00
Nathan Byrd a1d4a90e05 Added system menu method to choose encoding 2022-07-28 15:47:51 -05:00
Bryan Ashby 17ddd73247
Allow for WFC status to be MLTEV 2022-07-17 23:02:08 -06:00
Bryan Ashby e8f6a2f702
Missing defaults 2022-07-16 22:23:34 -06:00
Bryan Ashby 821380fcb5
Template updates 2022-07-16 22:17:25 -06:00
Bryan Ashby 547d21683e
Some minor doc updates 2022-07-16 12:35:39 -06:00
Bryan Ashby e6cceeee3a
Fix drawing issue 2022-07-16 12:35:24 -06:00
Bryan Ashby 9db60c65f5
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2022-07-14 23:24:56 -06:00
Bryan Ashby 0b9b08eded
Merge pull request #436 from NuSkooler/cp437-unless-nix-explicit
Default to CP437 unless we explicitly detect a 'nix' terminal
2022-07-11 23:16:15 -06:00
Bryan Ashby 2040ccd551
Basic selection display 2022-06-23 22:23:11 -06:00
Bryan Ashby 3d50c4e80d
Fix friendly remote address member 2022-06-23 15:06:00 -06:00
Bryan Ashby 1a93ab9be0
Add ability to kick selected node at WFC 2022-06-13 21:53:11 -06:00
Bryan Ashby dde5079414
Tidy 2022-06-12 16:28:29 -06:00
Bryan Ashby 6c99a070d3
Minor cleanup 2022-06-12 15:22:24 -06:00
Bryan Ashby 9172fdda9d
Re-apply some Prettier formatting after merge 2022-06-12 14:12:03 -06:00
Bryan Ashby c93b8cda81
Fix up some merge mistakes 2022-06-12 14:11:36 -06:00
Bryan Ashby e0fca9f8f7
Initial sync up with master after Prettier 2022-06-12 13:57:46 -06:00
Bryan Ashby ba5775adc9
Updates to drawing, additional props, friendly IP addrs, etc. 2022-06-10 16:08:22 -06:00
Bryan Ashby 1ba866f2ca
Add client.friendlyRemoteAddress() for 'clean' remote IP 2022-06-04 17:39:48 -06:00
Bryan Ashby 0b11e629a6
VerticalMenuView 'focusItemAtTop' property, and selection by node ID on WFC
* Add new property to change how focus items are handed in VM
* Select node by node iD (key press) on WFC
2022-06-04 16:32:50 -06:00
Bryan Ashby 3d191a9c6c
Add pages to WFC 2022-06-04 15:37:31 -06:00
Bryan Ashby 2e4df79d52
displayArtAndPrepViewController() is now available in MenuModule and derived classes
* This functionality was common enough to move to MenuModule and can shorthand a good amount of boilerplate code. See code for usage.
2022-06-02 11:12:23 -06:00
Bryan Ashby f02624c14d
Add ability to toggle avail/invis from WFC 2022-05-31 12:28:26 -06:00
Bryan Ashby 2ab50fb670
Add missing docs on new indicators 2022-05-24 20:14:41 -06:00
Bryan Ashby 2b3d5be3d9
Add MCI codes, helpers, and format keys for user availability and visibility
* New MCI codes: IA and IV
* availInicator and visIndicator to WFC format keys
* New helpers for availalbe and visible indicators (see themes)
2022-05-24 19:46:39 -06:00
Bryan Ashby 868e14aa8e
New MCI codes & user status flags support additions
* New MCI and WFC properties for user new private and "addressed to" mail
* Additional support for user status flags in connection lists, etc.
2022-05-11 20:30:25 -06:00
Bryan Ashby 6502f3b55e
Initial support for user status flags (NotAvail, NotVisible, ...) 2022-05-08 22:15:57 -06:00
Bryan Ashby 24491000ad
Update and add missing 'desc' to menu templates 2022-05-08 19:24:38 -06:00
Bryan Ashby 0650756736
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2022-05-08 11:38:42 -06:00
Bryan Ashby 14be645de3
Minor updates 2022-05-08 11:38:03 -06:00
Bryan Ashby f7788fc01c
WFC documentation updates 2022-05-07 17:13:10 -06:00
Bryan Ashby bd28de9a69
Some logging cleanup 2022-05-07 11:47:04 -06:00
Bryan Ashby 18420fd7a7
Additional information in WFC docs 2022-05-07 11:19:18 -06:00
Bryan Ashby 9e5b3369a5
New live stat: Total new users today
* Add NT (Obv/2 throwback) MCI for new users today
* Keep live stat up to date in stat log
* Exposed via WFC
2022-05-07 10:48:40 -06:00
Bryan Ashby bb86f386e9
Currently no required MCI codes 2022-05-04 10:48:31 -06:00
Bryan Ashby 09927a6ec1
Tidy 2022-05-04 10:25:59 -06:00
Bryan Ashby d0db38a544
More docs, total user count MCI and stat 2022-05-01 19:58:00 -06:00
Bryan Ashby 44505f664a
Updates and add start of WFC doc 2022-05-01 17:40:31 -06:00
Bryan Ashby dd7d24f22e
Many WFC related improvements (WIP)
* Update systeminformation to 5.x
* More work on WFC display of basic stats -- nearly complete
* Disable idle timeout when on WFC
2022-05-01 12:41:20 -06:00
Bryan Ashby 193c203a05
Sync up with master 2022-04-29 18:42:50 -06:00
Bryan Ashby 568c94e341
Cleanup and handle stats that are not yet ready 2022-04-12 22:16:42 -06:00
Bryan Ashby 3d070ddf35
Temporary WFC WIP screen 2022-04-08 17:58:48 -06:00
Bryan Ashby 5288f82006
Merge branch '216-waiting-for-caller' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2022-04-08 17:39:48 -06:00
Bryan Ashby 7988938dcc
Sync with master 2022-04-08 17:38:28 -06:00
Bryan Ashby c52e911a75
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2020-12-11 14:31:53 -07:00
Bryan Ashby 3f7b0295ba
Cleanup 2020-12-09 18:54:51 -07:00
Bryan Ashby f5430cb7a6
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2020-12-07 22:36:05 -07:00
Bryan Ashby 7aafb0b0c4
Checkpoint 2020-12-07 19:52:54 -07:00
Bryan Ashby 2c361bf6cc
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2020-11-29 17:08:09 -07:00
Bryan Ashby a64bbb1635
* Don't crash attempting to get desc from menu stack
* Remove ring buffer monitor at WFC exit
2020-11-27 23:01:05 -07:00
Bryan Ashby b075cbae65
Checkpoing on WFC 2020-11-27 22:35:03 -07:00
Bryan Ashby b1f061b478
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2020-11-27 19:53:36 -07:00
Bryan Ashby 9c7fb16196
Last caller information / MCI 2020-11-26 19:51:00 -07:00
Bryan Ashby 3a7f7750ab
Merge from master + add MCI codes
* FT, DD, FB, DB MCI codes and backing system stats
2020-11-26 15:53:34 -07:00
Bryan Ashby 7b32fcfa6c
Merge branch 'master' of ssh://numinibsd/git/base/enigma-bbs into 216-waiting-for-caller 2020-11-22 18:54:56 -07:00
Bryan Ashby 5fb9716dc6
Add some new MCI codes 2020-11-22 18:54:49 -07:00
Bryan Ashby 58c577c4bb
Checkpoint 2020-11-22 12:25:19 -07:00
Bryan Ashby f4e25a76b3
Merge branch 'master' of ssh://numinibsd/git/base/enigma-bbs into 216-waiting-for-caller 2020-11-21 16:51:36 -07:00
Bryan Ashby d6cc53c263
Some more stats 2020-11-09 21:32:34 -07:00
Bryan Ashby 52ae983cb4
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2020-11-09 19:41:04 -07:00
Bryan Ashby e7483569e7
Merge 2020-11-09 19:40:55 -07:00
Bryan Ashby 73d3cf85ce
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 216-waiting-for-caller 2020-11-09 19:38:16 -07:00
Bryan Ashby 89ecbdddb0
Merge branch 'master' of ssh://numinibsd/git/base/enigma-bbs into 216-waiting-for-caller 2020-11-08 17:34:39 -07:00
Bryan Ashby fa2b70dbdb
WIP 2020-09-25 15:41:21 -06:00
Bryan Ashby c53c00c77a
Merge branch 'master' of ssh://numinibsd/git/base/enigma-bbs into 216-waiting-for-caller 2020-07-16 21:34:34 -06:00
Bryan Ashby 28cea6d0c5
Stub 2020-07-13 21:08:25 -06:00
185 changed files with 6447 additions and 2426 deletions

9
.devcontainer/Dockerfile Normal file
View File

@ -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

View File

@ -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": "3.11"
},
"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"]
}
}
}

12
.dockerignore Normal file
View File

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

10
.gitattributes vendored
View File

@ -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

74
.github/workflows/codeql-analysis.yml vendored Normal file
View File

@ -0,0 +1,74 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
push:
branches: [ "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "master" ]
schedule:
- cron: '41 0 * * 5'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
- name: Checkout repository
uses: actions/checkout@v3
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
# Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"

View File

@ -11,25 +11,25 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v3
- name: Login to DockerHub
uses: docker/login-action@v1
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push
uses: docker/build-push-action@v2
uses: docker/build-push-action@v3
with:
tags: enigmabbs/enigma-bbs:latest
file: docker/Dockerfile
platforms: linux/amd64,linux/arm64
platforms: linux/amd64,linux/arm64,linux/arm/v7
push: true

3
.gitignore vendored
View File

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

6
.vscode/extensions.json vendored Normal file
View File

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

26
.vscode/tasks.json vendored Normal file
View File

@ -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"
}
]
}

View File

@ -4,35 +4,37 @@
ENiGMA½ is a modern BBS software with a nostalgic flair!
## Features Available Now
* Multi platform: Anywhere [Node.js](https://nodejs.org/) runs likely works (known to work under Linux, FreeBSD, OpenBSD, OS X and Windows)
## Features
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/modding/existing-mods.md)
* [MCI support](docs/art/mci.md) for lightbars, toggles, input areas, and so on plus many other other bells and whistles
* **Highly customizable** via [HJSON](http://hjson.org/) 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
* [SyncTERM](http://syncterm.bbsdev.net/) style font and baud emulation support. Display PC/DOS and Amiga style artwork as it's intended! In general, ANSI-BBS / [cterm.txt](http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/src/conio/cterm.txt?content-type=text%2Fplain&revision=HEAD) / [bansi.txt](http://www.bbsdocumentary.com/library/PROGRAMS/GRAPHICS/ANSI/bansi.txt) are followed for expected BBS behavior.
* Full [SAUCE](http://www.acid.org/info/sauce/sauce.htm) support.
* Renegade style [pipe color codes](./docs/configuration/colour-codes.md).
* Renegade style [pipe color codes](./docs/_docs/configuration/colour-codes.md).
* [SQLite](http://sqlite.org/) storage of users, message areas, etc.
* Strong [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) backed password encryption.
* Support for 2-Factor Authentication with One-Time-Passwords
* [Door support](docs/modding/door-servers.md) including common dropfile formats for legacy DOS doors. Built in [BBSLink](http://bbslink.net/), [DoorParty](http://forums.throwbackbbs.com/), [Exodus](https://oddnetwork.org/exodus/) and [CombatNet](http://combatnet.us/) support!
* [Bunyan](https://github.com/trentm/node-bunyan) logging!
* [Message networks](docs/messageareas/message-networks.md) with FidoNet Type Network (FTN) + BinkleyTerm Style Outbound (BSO) message import/export. Messages Bases can also be exposed via [Gopher](docs/servers/gopher.md), or [NNTP](docs/servers/nntp.md)!
* [Gazelle](https://github.com/WhatCD/Gazelle) inspired File Bases including fast fully indexed full text search (FTS), #tags, and HTTP(S) temporary download URLs using a built in [web server](docs/servers/web-server.md). Legacy X/Y/Z modem also supported!
* Support for **2-Factor Authentication** with One-Time-Passwords
* [Door support](./docs/_docs/modding/door-servers.md) including common dropfile formats for legacy DOS doors. Built in [BBSLink](http://bbslink.net/), [DoorParty](http://forums.throwbackbbs.com/), and [Exodus](https://oddnetwork.org/exodus/)!
* Structured [Bunyan](https://github.com/trentm/node-bunyan) logging!
* [Message networks](./docs/_docs/messageareas/message-networks.md) with FidoNet Type Network (FTN) + BinkleyTerm Style Outbound (BSO) message import/export. Messages Bases can also be exposed via [Gopher](./docs/_docs/servers/contentservers/gopher.md), or [NNTP](./docs/_docs/servers/contentservers/nntp.md)!
* [Gazelle](https://github.com/WhatCD/Gazelle) inspired File Bases including fast fully indexed full text search (FTS), #tags, and HTTP(S) temporary download URLs using a built in [web server](./docs/_docs/servers/contentservers/web-server.md). Legacy X/Y/Z modem also supported!
* Upload processor supporting [FILE_ID.DIZ](https://en.wikipedia.org/wiki/FILE_ID.DIZ) and [NFO](https://en.wikipedia.org/wiki/.nfo) extraction, year estimation, and more!
* ANSI support in the Full Screen Editor (FSE), file descriptions, etc.
* A built in achievement system. BBSing gamified!
* Expandable **achievement system** — BBSing gamified!
* A remote accessible [Waiting For Caller (WFC)](./docs/_docs/modding/wfc.md)!
...and much much more. Please check out [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) and feel free to request features (or contribute!) features!
## Documentation
[Browse the docs online](https://nuskooler.github.io/enigma-bbs/). Be sure to checkout the [/docs/](./docs/) folder as well for the latest and greatest documentation.
[Browse the docs online](https://nuskooler.github.io/enigma-bbs/). Be sure to checkout the [/docs/](./docs/_docs/) folder as well for the latest and greatest documentation.
## Installation
On most *nix systems simply run the following from your terminal:
```
```bash
curl -o- https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/install.sh | bash
```
@ -47,7 +49,7 @@ If you feel the urge to donate, [you can do so here](https://liberapay.com/NuSko
* See [Discussions](https://github.com/NuSkooler/enigma-bbs/discussions) and [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues)
* **Discussion on a ENiGMA BBS!** (see Boards below)
* IRC: **#enigma-bbs** on **irc.libera.chat:6697(TLS)** ([webchat](https://web.libera.chat/gamja/?channels=#enigma-bbs))
* FSX_ENG on [fsxNet](http://bbs.geek.nz/#fsxNet) or ARK_ENIG on [ArakNet](https://www.araknet.xyz/) available on many fine boards
* `FSX_ENG` on [fsxNet](https://fsxnet.nz) or `ARK_ENIG` on [ArakNet](https://www.araknet.xyz/) available on many fine boards
* Email: bryan -at- l33t.codes
* [Facebook ENiGMA½ group](https://www.facebook.com/groups/enigmabbs/)
@ -75,7 +77,7 @@ ENiGMA has been tested with many terminals. However, the following are suggested
* [Luciano Ayres](http://www.lucianoayres.com.br/) of [Blocktronics](http://blocktronics.org/), creator of the "Mystery Skulls" default ENiGMA½ theme!
* Sudndeath for Xibalba ANSI work!
* Jack Phlash for kick ass ENiGMA½ and Xibalba ASCII (Check out [IMPURE60](http://pc.textmod.es/pack/impure60/)!!)
* Avon of [Agency BBS](http://bbs.geek.nz/) and [fsxNet](http://bbs.geek.nz/#fsxNet) for putting up with my experiments to his system and for FSX_ENG!
* Avon of [Agency BBS](http://bbs.nz/) and [fsxNet](https://fsxnet.nz) for putting up with my experiments to his system and for FSX_ENG!
* Maskreet of [Throwback BBS](http://www.throwbackbbs.com/) hosting [DoorParty](http://forums.throwbackbbs.com/)!
* [Apam](https://github.com/apamment) of [Magicka](https://magickabbs.com/)
* [nail/blocktronics](http://blocktronics.org/tag/nail/) for the [sickmade Xibalba logo](http://pc.textmod.es/pack/blocktronics-420/n-xbalba.ans)!

31
TROUBLESHOOTING.md Normal file
View File

@ -0,0 +1,31 @@
# Troubleshooting
## Installation
### Compiler Issues
Currently a number of ENiGMA½'s NPM dependencies include modules that require C bindings, and thus, may need compiled uf prebuilt binaries are not available on NPM for your system/architecture. This is often the case for older Linux systems, some ARM devices, etc.
**Example**: Compiling `sqlite3` from source with `npm`:
```bash
npm rebuild --build-from-source sqlite3
```
With `yarn`:
```bash
env npm_config_build_from_source=true yarn install sqlite3
```
If you get compiler errors when running `npm install` or `yarn`, you can try rebuilding with compiler overrides.
**Example**: Overriding compilers for `node-pty` compilation:
```bash
env CC=gcc CXX=gcc npm rebuild --build-from-source node-pty
```
## Upgrades
### Missing Menu & Theme Entries
One thing to be sure and check after an update is your menu/prompt HJSON configurations as well as your theme(s). The default templates are updated alongside features, but you may need to merge in fragments missing from your own.
See also [Updating](./docs/_docs/admin/updating.md)

View File

@ -1,6 +1,8 @@
# Introduction
This document covers basic upgrade notes for major ENiGMA½ version updates.
> :information_source: **Be sure to read the version-to-version upgrade notes below** for each upgrade!
# Before Upgrading
* Always back up your system! (See [Administration](./docs/admin/administration.md))
* Seriously, always back up your system!
@ -25,37 +27,49 @@ npm install # or simply 'yarn'
```
# Problems
Report your issue on Xibalba BBS, hop in #enigma-bbs on FreeNode and chat, or
[file a issue on GitHub](https://github.com/NuSkooler/enigma-bbs/issues).
1. Check [TROUBLESHOOTING](TROUBLESHOOTING.md) first.
2. Report your issue on Xibalba BBS, hop in #`enigma-bbs` on FreeNode and chat, or [file a issue on GitHub](https://github.com/NuSkooler/enigma-bbs/issues) if you believe you've found a bug or missing feature.
# Version to Version Notes
> :warning: Be sure to inspect these notes during any upgrades!
# 0.0.12-beta to 0.0.13-beta
## 0.0.13-beta to 0.0.14-beta
* Due to changes to supported algorithms in newer versions of openssl, the default list of supported algorithms for the ssh login server has changed. There are both removed ciphers as well as optional new kex algorithms available now. ***NOTE:*** Changes to supported algorithms are only needed to support keys generated with new versions of openssl, if you already have a ssl key in use you should not have to make any changes to your config.
* Removed ciphers: 'blowfish-cbc', 'arcfour256', 'arcfour128', and 'cast128-cbc'
* Added kex: 'curve25519-sha256', 'curve25519-sha256@libssh.org', 'curve25519-sha256', 'curve25519-sha256@libssh.org', 'ecdh-sha2-nistp256', 'ecdh-sha2-nistp384', 'ecdh-sha2-nistp521'
## 0.0.12-beta to 0.0.13-beta
* To enable the new Waiting for Caller (WFC) support, please see [WFC](docs/modding/wfc.md).
* :exclamation: The SSH server's `ssh2` module has gone through a major upgrade. Existing users will need to comment out two SSH KEX algorithms from their `config.hjson` if present else clients such as NetRunner will not be able to connect over SSH. Comment out `diffie-hellman-group-exchange-sha256` and `diffie-hellman-group-exchange-sha1`
* Gopher configuration change. See [WHATSNEW](WHATSNEW.md)
* All features and changes are backwards compatible. There are a few new configuration options in a new `term` section in the configuration. These are all optional, but include the following options in case you use them:
```hjson
{
{
term: {
// checkUtf8Encoding requires the use of cursor position reports, which are not supported on all terminals.
// Using this with a terminal that does not support cursor position reports results in a 2 second delay
// during the connect process, but provides better autoconfiguration of utf-8
// checkUtf8Encoding requires the use of cursor
// position reports, which are not supported on all terminals.
// Using this with a terminal that does not support cursor
// position reports results in a 2 second delay during the
// connect process, but provides better autoconfiguration of utf-8
checkUtf8Encoding: true
// Checking the ANSI home position also requires the use of cursor position reports, which are not
// supported on all terminals. Using this with a terminal that does not support cursor position reports
// results in a 3 second delay during the connect process, but works around positioning problems with
// Checking the ANSI home position also requires the use of
// cursor position reports, which are not supported on all
/// terminals. Using this with a terminal that does not support
// cursor position reports results in a 3 second delay during
// the connect process, but works around positioning problems with
// non-standard terminals.
checkAnsiHomePosition: true
}
}
```
In addition to these, there are also new options for `term.cp437TermList` and `term.utf8TermList`. Under most circumstances these should not need to be changed. If you want to customize these lists, more information is available in `config_default.js`
# 0.0.11-beta to 0.0.12-beta
## 0.0.11-beta to 0.0.12-beta
* Be aware that `master` is now mainline! This means all `git pull`'s will yield the latest version. See [WHATSNEW](WHATSNEW.md) for more information.
* **BREAKING CHANGE** There is no longer a `prompt.hjson` file. Prompts are now simply part of the menu set in the `prompts` section. If you have an existing system you will need to add your `prompt.hjson` to your `menu.hjson`'s `includes` section at a minimum. Example:
```hjson
@ -74,14 +88,14 @@ In addition to these, there are also new options for `term.cp437TermList` and `t
sqlite3 db/file.sqlite3 < ./misc/update/tables_update_2020-11-29.sql
```
# 0.0.10-alpha to 0.0.11-beta
## 0.0.10-alpha to 0.0.11-beta
* Node.js 12.x LTS is now in use. Follow standard Node.js upgrade procedures (e.g.: `nvm install 12 && nvm use 12`).
# 0.0.9-alpha to 0.0.10-alpha
## 0.0.9-alpha to 0.0.10-alpha
* Security related files such as private keys and certs are now looked for in `config/security` by default.
* Default archive handler for zip files has switched to InfoZip due to a bug in the latest p7Zip packages causing "volume not found" errors. Ensure you have the InfoZip `zip` and `unzip` commands in ENiGMA's path. You can switch back to 7Zip by overriding `archiveHandler` for `application/zip` in your `config.hjson` under `fileTypes` to `7Zip`.
# 0.0.8-alpha to 0.0.9-alpha
## 0.0.8-alpha to 0.0.9-alpha
* Development is now against Node.js 10.x LTS. Follow your standard upgrade path to update to Node 10.x before using 0.0.9-alpha!
* The property `justify` found on various views previously had `left` and `right` values swapped (oops!); you will need to adjust any custom `theme.hjson` that use one or the other and swap them as well.
* Possible breaking changes in FSE: The MCI code `%TL13` for error indicator is now `%TL4`. This is part of a cleanup and standardization on "custom ranges". You may need to update your `theme.hjson` and related artwork.
@ -108,7 +122,7 @@ webSocket: {
* Similar to the last item, `defaults.general.passwordChar` in `theme.hjson` is now just `defaults.passwordChar`.
# 0.0.7-alpha to 0.0.8-alpha
## 0.0.7-alpha to 0.0.8-alpha
ENiGMA 0.0.8-alpha comes with some structure changes:
* Configuration files are defaulted to `./config`. Related, the `--config` option now points to a configuration **directory**
* `./mods/art` has been moved to `./art/general`
@ -125,17 +139,17 @@ With the above changes, you'll need to to at least:
* Move any certificates, pub/private keys, etc. from `./misc` to `./config`
* Specify user modules as `@userModule:my_module_name`
# 0.0.6-alpha to 0.0.7-alpha
## 0.0.6-alpha to 0.0.7-alpha
No issues
# 0.0.5-alpha to 0.0.6-alpha
## 0.0.5-alpha to 0.0.6-alpha
No issues
# 0.0.4-alpha to 0.0.5-alpha
## 0.0.4-alpha to 0.0.5-alpha
No issues
# 0.0.1-alpha to 0.0.4-alpha
## Node.js 6.x+ LTS is now **required**
## 0.0.1-alpha to 0.0.4-alpha
### Node.js 6.x+ LTS is now **required**
You will need to upgrade Node.js to [6.x+](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V6.md). If using [nvm](https://github.com/creationix/nvm) (you should be!) the process will go something like this:
```bash
nvm install 6
@ -145,7 +159,7 @@ nvm alias default 6
### ES6
Newly written code will use ES6 and a lot of code has started the migration process. Of note is the `MenuModule` class. If you have created a mod that inherits from `MenuModule`, you will need to upgrade your class to ES6.
## Manual Database Upgrade
### Manual Database Upgrade
A few upgrades need to be made to your SQLite databases:
```bash
@ -154,8 +168,8 @@ sqlite3 db/message.sqlite
sqlite> INSERT INTO message_fts(message_fts) VALUES('rebuild');
```
## Archiver Changes
### Archiver Changes
If you have overridden or made additions to archivers in your `config.hjson` you will need to update them. See [Archive Configuration](docs/archive.md) and `core/config.js`
## File Base Configuration
### File Base Configuration
As 0.0.4-alpha contains file bases, you'll want to create a suitable configuration if you wish to use the feature. See [File Base Configuration](docs/file_base.md).

View File

@ -1,12 +1,32 @@
# Whats New
This document attempts to track **major** changes and additions in ENiGMA½. For details, see GitHub.
## 0.0.14-beta
* The [Web Server](/docs/_docs/servers/contentservers/web-server.md) has made some possibly breaking changes:
* `/static/` prefixes are no longer required. This was a ugly hack.
* Some internal routes such as those used for password resets live within `/_internal/`.
* Routes for the file base now default to `/_f/` prefixed instead of just `/f/`. If `/f/` is in your `config.hjson` you are encouraged to update it!
* Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established.
* 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.
* Removed terminal `cursor position reports` from most locations in the code. This should greatly increase the number of terminal programs that work with Enigma 1/2. For more information, see [Issue #222](https://github.com/NuSkooler/enigma-bbs/issues/222). This may also resolve other issues, such as [Issue #365](https://github.com/NuSkooler/enigma-bbs/issues/365), and [Issue #320](https://github.com/NuSkooler/enigma-bbs/issues/320). Anyone that previously had terminal incompatibilities please re-check and let us know!
* Bumped up the minimum [Node.js](https://nodejs.org/en/) version to v14. This will allow more expressive Javascript programming syntax with ECMAScript 2020 to improve the development experience.
* Added new configuration options for `term.checkUtf8Encoding`, `term.checkAnsiHomePostion`, `term.cp437TermList`, and `term.utf8TermList`. More information on these options is available in [UPGRADE](UPGRADE.md).
* **New Waiting For Caller (WFC)** support via the `wfc.js` module.
* Added new configuration options for `term.checkUtf8Encoding`, `term.checkAnsiHomePosition`, `term.cp437TermList`, and `term.utf8TermList`. More information on these options is available in [UPGRADE](UPGRADE.md).
* Many new system statistics available via the StatLog such as current and average load, memory, etc.
* Many new MCI codes: `MB`, `MF`, `LA`, `CL`, `UU`, `FT`, `DD`, `FB`, `DB`, `LC`, `LT`, `LD`, and more. See [MCI](./docs/art/mci.md).
* SyncTERM style font support detection.
* Added a system method to support setting the client encoding from menus, `@systemMethod:setClientEncoding`.
* Many additional backward-compatible bug fixes since the first release of 0.0.12-beta. See the [project repository](https://github.com/NuSkooler/enigma-bbs) for more information.
* Deprecated Gopher's `messageConferences` configuration key in favor of a easier to deal with `exposedConfAreas` allowing wildcards and exclusions. See [Gopher](./docs/servers/contentservers/gopher.md).
* NNTP write (aka POST) access support for authenticated users over TLS.
* [Advanced MCI formatting](./docs/art/mci.md#mci-formatting)!
* Additional options in the `abracadabra` module for launching doors. See [Local Doors](./docs/modding/local-doors.md)
## 0.0.12-beta
* The `master` branch has become mainline. What this means to users is `git pull` will always give you the latest and greatest. Make sure to read [Updating](./docs/admin/updating.md) and keep an eye on `WHATSNEW.md` (this file) and [UPGRADE](UPGRADE.md)! See also [ticket #276](https://github.com/NuSkooler/enigma-bbs/issues/276).
@ -16,6 +36,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
* An explicit prompt file previously specified by `general.promptFile` in `config.hjson` is no longer necessary. Instead, this now simply part of the `prompts` section in `menu.hjson`. The default setup still creates a separate prompt HJSON file, but it is `includes`ed in `menu.hjson`. With the removal of prompts the `PromptsChanged` event will no longer be fired.
* New `PV` ACS check for arbitrary user properties. See [ACS](./docs/configuration/acs.md) for details.
* The `message` arg used by `msg_list` has been deprecated. Please starting using `messageIndex` for this purpose. Support for `message` will be removed in the future.
* A number of new MCI codes (see [MCI](./docs/art/mci.md))
* Added ability to export/download messages. This is enabled in the default menu. See `messageAreaViewPost` in [the default message base template](./misc/menu_templates/message_base.in.hjson) and look for the download options (`@method:addToDownloadQueue`, etc.) for details on adding to your system!
* The Gopher server has had a revamp! Standard `gophermap` files are now served along with any other content you configure for your Gopher Hole! A default [gophermap](https://en.wikipedia.org/wiki/Gopher_(protocol)#Source_code_of_a_menu) can be found [in the misc directory](./misc/gophermap) that behaves like the previous implementation. See [Gopher docs](./docs/servers/gopher.md) for more information.
* Default file browser up/down/pageUp/pageDown scrolls description (e.g. FILE_ID.DIZ). If you want to expose this on an existing system see the `fileBaseListEntries` in the default `file_base.in.hjson` template.

View File

@ -187,7 +187,7 @@
}
mci: {
VM1: {
height: 15,
height: 14
width: 50
itemFormat: "|00|11{userName:<17.17}|03{affils:<21.21}|11{location:<19.19}|03{lastLoginTs}"
focusItemFormat: "|00|19|15{userName:<17.17}{affils:<21.21}{location:<19.19}{lastLoginTs}"
@ -246,6 +246,96 @@
}
}
mainMenuWaitingForCaller: {
config: {
// formats
quickLogTimestampFormat: "|01|03MM|08/|03DD hh:mm:ssa"
nowDateTimeFormat: "|00|10ddd|08, |10MMMM Do YYYY|08, |10h|08:|10mm|02a"
lastLoginDateTimeFormat: "|00|10ddd hh|08:|10mm|02a"
// header
mainInfoFormat10: "|00|10{now} |10{currentUserName} |08- |02Prv|08:|10{newPrivateMail} |02Addr|08:|10{newMessagesAddrTo} |08- |02Avail|08:|10{availIndicator} |02Vis|07:|10{visIndicator}"
// today
mainInfoFormat11: "|00|15{callsToday:>5}"
mainInfoFormat12: "|00|15{postsToday:>5}"
mainInfoFormat13: "|00|15{newUsersToday:>5}"
mainInfoFormat14: "|00|15{uploadsToday:<4}"
mainInfoFormat15: "|00|15{downloadsToday:<4}"
mainInfoFormat16: "|00|15{uploadBytesToday!sizeWithoutAbbr:<5} |07{uploadBytesToday!sizeAbbr}"
mainInfoFormat17: "|00|15{downloadBytesToday!sizeWithoutAbbr:<5} |07{downloadBytesToday!sizeAbbr}"
// last login
mainInfoFormat18: "|00|15{lastLoginUserName:<26} |07{lastLogin}"
// system stats
mainInfoFormat20: "|00|15{freeMemoryBytes!sizeWithoutAbbr} |07{freeMemoryBytes!sizeAbbr} free |08/ |15{totalMemoryBytes!sizeWithoutAbbr} |07{totalMemoryBytes!sizeAbbr}"
mainInfoFormat22: "|00|15{systemCurrentLoad} |07% |08/ |15{systemAvgLoad} |07load avg|08."
mainInfoFormat24: "|00|15{processUptimeSeconds!durationSeconds} |08/ |15{processBytesIngress!sizeWithoutAbbr:>4} |07{processBytesIngress!sizeAbbr}|08/|15{processBytesEgress!sizeWithoutAbbr:>4} |07{processBytesEgress!sizeAbbr}"
// totals
mainInfoFormat19: "|00|15{totalCalls:>5}"
mainInfoFormat21: "|00|15{totalPosts:>7}"
mainInfoFormat23: "|00|15{totalUsers:>5}"
mainInfoFormat25: "|00|15{totalFiles:>4} |08/ |15{totalFileBytes!sizeWithoutAbbr:>4} |07{totalFileBytes!sizeAbbr}"
quickLogLevel: info
quickLogLevelIndicators: {
trace : |00|02T
debug: |00|03D
info: |00|15I
warn: |00|14W
error: |00|12E
fatal: |00|28F
}
quickLogLevelMessagePrefixes: {
trace : |00|02
debug: |00|03
info: |00|07
warn: |00|14
error: |00|12
fatal: |00|28
}
statusAvailableIndicators: [ "N", "Y" ]
statusVisibleIndicators: [ "N", "Y" ]
nodeStatusSelectionFormat: "|00|07{realName:<12}\n|08- |07{serverName:<10}\n|08- |07{remoteAddress:<10}"
}
0: {
mci: {
TL16: {
fillChar: .
}
TL20: { width: 30 }
TL22: { width: 30 }
TL24: { width: 30 }
// node status
VM1: {
height: 5
width: 37
itemFormat: "|00 |15{node:<3.2} |11{userName:<12} |07{action:<14.13} |15{serverName}"
focusItemFormat: "|00|10> |15{node:<3.2} |11{userName:<12} |07{action:<14.13} |15{serverName}"
focusItemAtTop: false
}
// quick log
VM2: {
height: 5
width: 73
itemFormat: "|00|07{nodeId} {levelIndicator} |02{timestamp} {message:<51.50}"
}
MT3: {
mode: preview
autoScroll: false
height: 5
width: 12
}
}
}
}
messageBaseMessageList: {
config: {
dateTimeFormat: ddd MMM Do
@ -253,7 +343,7 @@
}
mci: {
VM1: {
height: 14
height: 13
width: 70
itemFormat: "|00|15{msgNum:>4} |03{subject:<28.27} |11{fromUserName:<20.20} |03{ts:<15.16} |15{newIndicator}"
focusItemFormat: "|00|19|15{msgNum:>4} {subject:<28.27} {fromUserName:<20.20} {ts:<15.16} {newIndicator}"
@ -326,7 +416,7 @@
}
mci: {
VM1: {
height: 14
height: 12
width: 70
itemFormat: "|00|15{msgNum:>4} |03{subject:<28.27} |11{fromUserName:<20.20} |03{ts} |15{newIndicator}"
focusItemFormat: "|00|19|15{msgNum:>4} {subject:<28.27} {fromUserName:<20.20} {ts} {newIndicator}"
@ -505,7 +595,7 @@
}
}
messageBaseSearchMessageList: {
messageBaseSearchResultsMessageList: {
config: {
allViewsInfoFormat10: "|00|15{msgNumSelected:>4.4} |08/ |15{msgNumTotal:<4.4}"
// Fri Sep 25th
@ -528,7 +618,7 @@
}
mci: {
VM1: {
height: 16
height: 12
width: 71
itemFormat: "|00|15 {msgNum:<4.4} |03{subject:<34.33} {fromUserName:<19.18} |03{ts:<12.12}"
focusItemFormat: "|00|19> |15{msgNum:<4.4} {subject:<34.33} {fromUserName:<19.18} {ts:<12.12}"
@ -693,7 +783,7 @@
}
mci: {
VM1: {
height: 14
height: 12
width: 70
itemFormat: "|00|15 {msgNum:<5.5}|03{subject:<28.27} |15{fromUserName:<20.20} {ts}"
focusItemFormat: "|00|19> |15{msgNum:<5.5}{subject:<28.27} {fromUserName:<20.20} {ts}"
@ -1124,7 +1214,7 @@
2: {
mci: {
MT1: {
height: 14
height: 13
width: 45
}
@ -1274,4 +1364,4 @@
}
}
}
}
}

Binary file not shown.

Binary file not shown.

Binary file not shown.

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');
@ -108,7 +109,7 @@ exports.getModule = class AbracadabraModule extends MenuModule {
name: self.config.name,
activeCount: activeDoorNodeInstances[self.config.name],
},
'Too many active instances'
`Too many active instances of door "${self.config.name}"`
);
if (_.isString(self.config.tooManyArt)) {
@ -179,7 +180,10 @@ exports.getModule = class AbracadabraModule extends MenuModule {
this.client.term.write(ansi.resetScreen());
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',
@ -188,51 +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, () => {
trackDoorRunEnd(doorTracking);
this.decrementActiveDoorNodeInstances();
// 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._makeDropDirs([exeInfo.dropFileDir, exeInfo.userAreaDir], err => {
if (err) {
Log.warn(
`Failed creating directory ${exeInfo.dropFilePath}: ${err.message}`
);
}
// client may have disconnected while process was active -
// we're done here if so.
if (!this.client.term.output) {
return;
}
const doorTracking = trackDoorRunBegin(this.client, this.config.name);
//
// 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.doorInstance.run(exeInfo, err => {
if (err) {
Log.error(`Error running "${this.config.name}": ${err.message}`);
}
this.autoNextMenu();
trackDoorRunEnd(doorTracking);
this.decrementActiveDoorNodeInstances();
// 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.'
);
}
});
}
// 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();

View File

@ -505,9 +505,9 @@ class Achievements {
getFormatObject(info) {
return {
userName: info.user.username,
userRealName: info.user.properties[UserProps.RealName],
userLocation: info.user.properties[UserProps.Location],
userAffils: info.user.properties[UserProps.Affiliations],
userRealName: info.user.realName(false) || 'N/A',
userLocation: info.user.properties[UserProps.Location] || 'N/A',
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,

View File

@ -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]*?)([ABCDEFGfHJKLmMsSTuUYZt@PXhlnpt]))|([78DEHM]))/g, // eslint-disable-line no-control-regex
};
options = miscUtil.valueWithDefault(options, {
@ -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);
@ -71,10 +77,25 @@ function ANSIEscapeParser(options) {
self.clearScreen = function () {
self.column = 1;
self.row = 1;
self.positionUpdated();
self.emit('clear screen');
};
self.positionUpdated = function () {
if(self.row > self.termHeight) {
if(this.savedPosition) {
this.savedPosition.row -= self.row - self.termHeight;
}
self.emit('scroll', self.row - self.termHeight);
self.row = self.termHeight;
}
else if(self.row < 1) {
if(this.savedPosition) {
this.savedPosition.row -= self.row - 1;
}
self.emit('scroll', -(self.row - 1));
self.row = 1;
}
self.emit('position update', self.row, self.column);
};
@ -90,8 +111,8 @@ function ANSIEscapeParser(options) {
switch (charCode) {
case CR:
self.emit('literal', text.slice(start, pos));
start = pos;
self.emit('literal', text.slice(start, pos + 1));
start = pos + 1;
self.column = 1;
@ -105,8 +126,8 @@ function ANSIEscapeParser(options) {
self.column = 1;
}
self.emit('literal', text.slice(start, pos));
start = pos;
self.emit('literal', text.slice(start, pos + 1));
start = pos + 1;
self.row += 1;
@ -114,13 +135,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 +159,7 @@ function ANSIEscapeParser(options) {
//
// Finalize this chunk
//
if (self.column > self.termWidth) {
if (self.column > self.breakWidth) {
self.column = 1;
self.row += 1;
@ -222,7 +246,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]*?)([ABCDEFGfHJKLmMsSTuUYZt@PXhlnpt]))|([78DEHM]))/g, // eslint-disable-line no-control-regex
stop: false,
};
};
@ -262,9 +286,47 @@ function ANSIEscapeParser(options) {
opCode = match[2];
args = match[1].split(';').map(v => parseInt(v, 10)); // convert to array of ints
escape(opCode, args);
// Handle the case where there is no bracket
if(!(_.isNil(match[3]))) {
opCode = match[3];
args = [];
// no bracket
switch(opCode) {
// save cursor position
case '7':
escape('s', args);
break;
// restore cursor position
case '8':
escape('u', args);
break;
// scroll up
case 'D':
escape('S', args);
break;
// move to next line
case 'E':
// functonality is the same as ESC [ E
escape(opCode, args);
break;
// create a tab at current cursor position
case 'H':
literal('\t');
break;
// scroll down
case 'M':
escape('T', args);
break;
}
}
else {
escape(opCode, args);
}
//self.emit('chunk', match[0]);
self.emit('control', match[0], opCode, args);
}
} while (0 !== re.lastIndex);
@ -272,8 +334,8 @@ function ANSIEscapeParser(options) {
if (pos < buffer.length) {
var lastBit = buffer.slice(pos);
// :TODO: check for various ending LF's, not just DOS \r\n
if ('\r\n' === lastBit.slice(-2).toString()) {
// handles either \r\n or \n
if ('\n' === lastBit.slice(-1).toString()) {
switch (self.trailingLF) {
case 'default':
//
@ -281,14 +343,14 @@ function ANSIEscapeParser(options) {
// if we're going to end on termHeight
//
if (this.termHeight === self.row) {
lastBit = lastBit.slice(0, -2);
lastBit = lastBit.slice(0, -1);
}
break;
case 'omit':
case 'no':
case false:
lastBit = lastBit.slice(0, -2);
lastBit = lastBit.slice(0, -1);
break;
}
}
@ -299,48 +361,6 @@ function ANSIEscapeParser(options) {
self.emit('complete');
};
/*
self.parse = function(buffer, savedRe) {
// :TODO: ensure this conforms to ANSI-BBS / CTerm / bansi.txt for movement/etc.
// :TODO: move this to "constants" section @ top
var re = /(?:\x1b\x5b)([\?=;0-9]*?)([ABCDHJKfhlmnpsu])/g;
var pos = 0;
var match;
var opCode;
var args;
// ignore anything past EOF marker, if any
buffer = buffer.split(String.fromCharCode(0x1a), 1)[0];
do {
pos = re.lastIndex;
match = re.exec(buffer);
if(null !== match) {
if(match.index > pos) {
parseMCI(buffer.slice(pos, match.index));
}
opCode = match[2];
args = getArgArray(match[1].split(';'));
escape(opCode, args);
self.emit('chunk', match[0]);
}
} while(0 !== re.lastIndex);
if(pos < buffer.length) {
parseMCI(buffer.slice(pos));
}
self.emit('complete');
};
*/
function escape(opCode, args) {
let arg;
@ -373,6 +393,37 @@ function ANSIEscapeParser(options) {
self.moveCursor(-arg, 0);
break;
// line feed
case 'E':
arg = isNaN(args[0]) ? 1 : args[0];
if(this.row + arg > this.termHeight) {
this.emit('scroll', arg - (this.termHeight - this.row));
self.moveCursor(0, this.termHeight);
}
else {
self.moveCursor(0, arg);
}
break;
// reverse line feed
case 'F':
arg = isNaN(args[0]) ? 1 : args[0];
if(this.row - arg < 1) {
this.emit('scroll', -(arg - this.row));
self.moveCursor(0, 1 - this.row);
}
else {
self.moveCursor(0, -arg);
}
break;
// absolute horizontal cursor position
case 'G':
arg = isNaN(args[0]) ? 1 : args[0];
self.column = Math.max(1, arg);
self.positionUpdated();
break;
case 'f': // horiz & vertical
case 'H': // cursor position
//self.row = args[0] || 1;
@ -383,14 +434,37 @@ function ANSIEscapeParser(options) {
self.positionUpdated();
break;
// save position
case 's':
self.saveCursorPosition();
// erase display/screen
case 'J':
if(isNaN(args[0]) || 0 === args[0]) {
self.emit('erase rows', self.row, self.termHeight);
}
else if (1 === args[0]) {
self.emit('erase rows', 1, self.row);
}
else if (2 === args[0]) {
self.clearScreen();
}
break;
// restore position
case 'u':
self.restoreCursorPosition();
// erase text in line
case 'K':
if(isNaN(args[0]) || 0 === args[0]) {
self.emit('erase columns', self.row, self.column, self.termWidth);
}
else if (1 === args[0]) {
self.emit('erase columns', self.row, 1, self.column);
}
else if (2 === args[0]) {
self.emit('erase columns', self.row, 1, self.termWidth);
}
break;
// insert line
case 'L':
arg = isNaN(args[0]) ? 1 : args[0];
self.emit('insert line', self.row, arg);
break;
// set graphic rendition
@ -462,15 +536,52 @@ function ANSIEscapeParser(options) {
self.emit('sgr update', self.graphicRendition);
break; // m
// :TODO: s, u, K
// erase display/screen
case 'J':
// :TODO: Handle other 'J' types!
if (2 === args[0]) {
self.clearScreen();
}
// save position
case 's':
self.saveCursorPosition();
break;
// Scroll up
case 'S':
arg = isNaN(args[0]) ? 1 : args[0];
self.emit('scroll', arg);
break;
// Scroll down
case 'T':
arg = isNaN(args[0]) ? 1 : args[0];
self.emit('scroll', -arg);
break;
// restore position
case 'u':
self.restoreCursorPosition();
break;
// clear
case 'U':
self.clearScreen();
break;
// delete line
// TODO: how should we handle 'M'?
case 'Y':
arg = isNaN(args[0]) ? 1 : args[0];
self.emit('delete line', self.row, arg);
break;
// back tab
case 'Z':
// calculate previous tabstop
self.column = Math.max( 1, self.column - (self.column % 8 || 8) );
self.positionUpdated();
break;
case '@':
// insert column(s)
arg = isNaN(args[0]) ? 1 : args[0];
self.emit('insert columns', self.row, self.column, arg);
break;
}
}
}

View File

@ -208,17 +208,17 @@ module.exports = class ArchiveUtil {
// pty.js doesn't currently give us a error when things fail,
// so we have this horrible, horrible hack:
let err;
proc.once('data', d => {
proc.onData(d => {
if (_.isString(d) && d.startsWith('execvp(3) failed.')) {
err = Errors.ExternalProcess(`${action} failed: ${d.trim()}`);
}
});
proc.once('exit', exitCode => {
proc.onExit(exitEvent => {
return cb(
exitCode
exitEvent.exitCode
? Errors.ExternalProcess(
`${action} failed with exit code: ${exitCode}`
`${action} failed with exit code: ${exitEvent.exitCode}`
)
: err
);
@ -358,10 +358,10 @@ module.exports = class ArchiveUtil {
output += data;
});
proc.once('exit', exitCode => {
if (exitCode) {
proc.onExit(exitEvent => {
if (exitEvent.exitCode) {
return cb(
Errors.ExternalProcess(`List failed with exit code: ${exitCode}`)
Errors.ExternalProcess(`List failed with exit code: ${exitEvent.exitCode}`)
);
}

View File

@ -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,
});
@ -305,6 +316,75 @@ function display(client, art, options, cb) {
}
});
// Remove any MCI's that are in erased rows
ansiParser.on('erase row', (startRow, endRow) => {
_.forEach(mciMap, (mciInfo, mapKey) => {
if (mciInfo.position[0] >= startRow && mciInfo.position[0] <= endRow) {
delete mciMap[mapKey];
}
});
});
// Remove any MCI's that are in erased columns
ansiParser.on('erase columns', (row, startCol, endCol) => {
_.forEach(mciMap, (mciInfo, mapKey) => {
if (
mciInfo.position[0] === row &&
mciInfo.position[1] >= startCol &&
mciInfo.position[1] <= endCol
) {
delete mciMap[mapKey];
}
});
});
ansiParser.on('insert columns', (row, startCol, numCols) => {
_.forEach(mciMap, (mciInfo, mapKey) => {
if (mciInfo.position[0] === row && mciInfo.position[1] >= startCol) {
mciInfo.position[1] += numCols;
if(mciInfo.position[1] > client.term.termWidth) {
delete mciMap[mapKey];
}
}
});
});
// Clear the screen, removing any MCI's
ansiParser.on('clear screen', () => {
_.forEach(mciMap, (mciInfo, mapKey) => {
delete mciMap[mapKey];
});
});
ansiParser.on('scroll', (scrollY) => {
_.forEach(mciMap, (mciInfo) => {
mciInfo.position[0] -= scrollY;
});
});
ansiParser.on('insert line', (row, numLines) => {
_.forEach(mciMap, (mciInfo) => {
if (mciInfo.position[0] >= row) {
mciInfo.position[0] += numLines;
}
});
});
ansiParser.on('delete line', (row, numLines) => {
_.forEach(mciMap, (mciInfo, mapKey) => {
if (mciInfo.position[0] >= row) {
if(mciInfo.position[0] < row + numLines) {
// unlike scrolling, the rows are actually gone,
// so we need to delete any MCI's that are in them
delete mciMap[mapKey];
}
else {
mciInfo.position[0] -= numLines;
}
}
});
});
ansiParser.on('literal', literal => client.term.write(literal, false));
ansiParser.on('control', control => client.term.rawWrite(control));

View File

@ -2,9 +2,6 @@
/* eslint-disable no-console */
'use strict';
//var SegfaultHandler = require('segfault-handler');
//SegfaultHandler.registerHandler('enigma-bbs-segfault.log');
// ENiGMA½
const conf = require('./config.js');
const logger = require('./logger.js');
@ -13,6 +10,7 @@ const resolvePath = require('./misc_util.js').resolvePath;
const UserProps = require('./user_property.js');
const SysProps = require('./system_property.js');
const SysLogKeys = require('./system_log.js');
const UserLogNames = require('./user_log_name');
// deps
const async = require('async');
@ -151,7 +149,9 @@ function shutdownSystem() {
[
function closeConnections(callback) {
const ClientConns = require('./client_connections.js');
const activeConnections = ClientConns.getActiveConnections();
const activeConnections = ClientConns.getActiveConnections(
ClientConns.AllConnections
);
let i = activeConnections.length;
while (i--) {
const activeTerm = activeConnections[i].term;
@ -257,6 +257,8 @@ function initialize(cb) {
//
const User = require('./user.js');
// :TODO: use User.getUserInfo() for this!
const propLoadOpts = {
names: [
UserProps.RealName,
@ -270,7 +272,7 @@ function initialize(cb) {
async.waterfall(
[
function getOpUserName(next) {
return User.getUserName(1, next);
return User.getUserName(User.RootUserID, next);
},
function getOpProps(opUserName, next) {
User.loadProperties(
@ -301,8 +303,9 @@ function initialize(cb) {
}
);
},
function initCallsToday(callback) {
function initSystemLogStats(callback) {
const StatLog = require('./stat_log.js');
const filter = {
logName: SysLogKeys.UserLoginHistory,
resultType: 'count',
@ -319,6 +322,89 @@ function initialize(cb) {
return callback(null);
});
},
function initUserLogStats(callback) {
const StatLog = require('./stat_log');
const entries = [
[UserLogNames.UlFiles, [SysProps.FileUlTodayCount, 'count']],
[UserLogNames.UlFileBytes, [SysProps.FileUlTodayBytes, 'obj']],
[UserLogNames.DlFiles, [SysProps.FileDlTodayCount, 'count']],
[UserLogNames.DlFileBytes, [SysProps.FileDlTodayBytes, 'obj']],
[UserLogNames.NewUser, [SysProps.NewUsersTodayCount, 'count']],
];
async.each(
entries,
(entry, nextEntry) => {
const [logName, [sysPropName, resultType]] = entry;
const filter = {
logName,
resultType,
date: moment(),
};
StatLog.findUserLogEntries(filter, (err, stat) => {
if (!err) {
if (resultType === 'obj') {
stat = stat.reduce(
(bytes, entry) =>
bytes + parseInt(entry.log_value) || 0,
0
);
}
StatLog.setNonPersistentSystemStat(sysPropName, stat);
}
return nextEntry(null);
});
},
() => {
return callback(null);
}
);
},
function initLastLogin(callback) {
const StatLog = require('./stat_log');
StatLog.getSystemLogEntries(
SysLogKeys.UserLoginHistory,
'timestamp_desc',
1,
(err, lastLogin) => {
if (err) {
return callback(null);
}
let loginObj;
try {
loginObj = JSON.parse(lastLogin[0].log_value);
loginObj.timestamp = moment(lastLogin[0].timestamp);
} catch (e) {
return callback(null);
}
// For live stats we want to resolve user ID -> name, etc.
const User = require('./user');
User.getUserInfo(loginObj.userId, (err, props) => {
const stat = Object.assign({}, props, loginObj);
StatLog.setNonPersistentSystemStat(SysProps.LastLogin, stat);
return callback(null);
});
}
);
},
function initUserCount(callback) {
const User = require('./user.js');
User.getUserCount((err, count) => {
if (err) {
return callback(err);
}
const StatLog = require('./stat_log');
StatLog.setNonPersistentSystemStat(SysProps.TotalUserCount, count);
return callback(null);
});
},
function initMessageStats(callback) {
return require('./message_area.js').startup(callback);
},

View File

@ -129,7 +129,7 @@ exports.getModule = class BBSLinkModule extends MenuModule {
'/auth.php?key=' + randomKey,
headers,
function resp(err, body) {
var status = body.trim();
const status = body.trim();
if ('complete' === status) {
return callback(null);

View File

@ -97,7 +97,12 @@ function Client(/*input, output*/) {
Object.defineProperty(this, 'currentTheme', {
get: () => {
if (this.currentThemeConfig) {
return this.currentThemeConfig.get();
// :TODO: clean this up: We have a ugly transition state in which we have a pure raw config vs a ConfigLoader in which get() must be called
try {
return this.currentThemeConfig.get();
} catch (e) {
return this.currentThemeConfig;
}
} else {
return {
info: {
@ -508,7 +513,7 @@ Client.prototype.startIdleMonitor = function () {
idleLogoutSeconds > 0 &&
nowMs - this.lastActivityTime >= idleLogoutSeconds * 1000
) {
this.emit('idle timeout');
this.emit('idle timeout', idleLogoutSeconds);
}
}, 1000 * 60);
};
@ -592,6 +597,15 @@ Client.prototype.isLocal = function () {
return ['127.0.0.1', '::ffff:127.0.0.1'].includes(this.remoteAddress);
};
Client.prototype.friendlyRemoteAddress = function () {
if (!this.remoteAddress) {
return 'N/A';
}
// convert any :ffff: IPv4's to 32bit version
return this.remoteAddress.replace(/^::ffff:/, '').replace(/^::1$/, 'localhost');
};
///////////////////////////////////////////////////////////////////////////////
// Default error handlers
///////////////////////////////////////////////////////////////////////////////

View File

@ -21,42 +21,86 @@ exports.getConnectionByNodeId = getConnectionByNodeId;
const clientConnections = [];
exports.clientConnections = clientConnections;
function getActiveConnections(authUsersOnly = false) {
const AllConnections = { authUsersOnly: false, visibleOnly: false, availOnly: false };
exports.AllConnections = AllConnections;
const UserVisibleConnections = {
authUsersOnly: false,
visibleOnly: true,
availOnly: false,
};
exports.UserVisibleConnections = UserVisibleConnections;
const UserMessageableConnections = {
authUsersOnly: true,
visibleOnly: true,
availOnly: true,
};
exports.UserMessageableConnections = UserMessageableConnections;
function getActiveConnections(
options = { authUsersOnly: true, visibleOnly: true, availOnly: false }
) {
return clientConnections.filter(conn => {
return (authUsersOnly && conn.user.isAuthenticated()) || !authUsersOnly;
if (options.authUsersOnly && !conn.user.isAuthenticated()) {
return false;
}
if (options.visibleOnly && !conn.user.isVisible()) {
return false;
}
if (options.availOnly && !conn.user.isAvailable()) {
return false;
}
return true;
});
}
function getActiveConnectionList(authUsersOnly) {
if (!_.isBoolean(authUsersOnly)) {
authUsersOnly = true;
}
function getActiveConnectionList(
options = { authUsersOnly: true, visibleOnly: true, availOnly: false }
) {
const now = moment();
return _.map(getActiveConnections(authUsersOnly), ac => {
return _.map(getActiveConnections(options), ac => {
let action;
try {
// attempting to fetch a bad menu stack item can blow up/assert
action = _.get(ac, 'currentMenuModule.menuConfig.desc', 'Unknown');
} catch (e) {
action = 'Unknown';
}
const entry = {
node: ac.node,
authenticated: ac.user.isAuthenticated(),
userId: ac.user.userId,
action: _.get(ac, 'currentMenuModule.menuConfig.desc', 'Unknown'),
action: action,
serverName: ac.session.serverName,
isSecure: ac.session.isSecure,
isVisible: ac.user.isVisible(),
isAvailable: ac.user.isAvailable(),
remoteAddress: ac.friendlyRemoteAddress(),
};
//
// There may be a connection, but not a logged in user as of yet
//
if (ac.user.isAuthenticated()) {
entry.userName = ac.user.username;
entry.realName = ac.user.properties[UserProps.RealName];
entry.location = ac.user.properties[UserProps.Location];
entry.affils = entry.affiliation = ac.user.properties[UserProps.Affiliations];
entry.text = ac.user?.username || 'N/A';
entry.userName = ac.user?.username || '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';
if (ac.user.isAuthenticated()) {
// :TODO: track pre-auth time so we can properly track this
const diff = now.diff(
moment(ac.user.properties[UserProps.LastLoginTs]),
'minutes'
);
entry.timeOn = moment.duration(diff, 'minutes');
}
return entry;
});
}
@ -81,6 +125,15 @@ function addNewClient(client, clientSock) {
moment().valueOf(),
]);
// kludge to refresh process update stats at first client
if (clientConnections.length < 1) {
setTimeout(() => {
const StatLog = require('./stat_log');
const SysProps = require('./system_property');
StatLog.getSystemStat(SysProps.ProcessTrafficStats);
}, 3000); // slight pause to wait for updates
}
clientConnections.push(client);
clientConnections.sort((c1, c2) => c1.session.id - c2.session.id);
@ -90,6 +143,7 @@ function addNewClient(client, clientSock) {
const connInfo = {
remoteAddress: remoteAddress,
friendlyRemoteAddress: client.friendlyRemoteAddress(),
serverName: client.session.serverName,
isSecure: client.session.isSecure,
};
@ -99,7 +153,10 @@ function addNewClient(client, clientSock) {
connInfo.family = clientSock.localFamily;
}
client.log.info(connInfo, 'Client connected');
client.log.info(
connInfo,
`Client connected on node ${nodeId} (${connInfo.serverName}/${connInfo.port})`
);
Events.emit(Events.getSystemEvents().ClientConnected, {
client: client,
@ -121,7 +178,7 @@ function removeClient(client) {
connectionCount: clientConnections.length,
nodeId: client.node,
},
'Client disconnected'
`Client disconnected from node ${client.node}`
);
if (client.user && client.user.isValid()) {
@ -143,9 +200,9 @@ function removeClient(client) {
}
function getConnectionByUserId(userId) {
return getActiveConnections().find(ac => userId === ac.user.userId);
return getActiveConnections(AllConnections).find(ac => userId === ac.user.userId);
}
function getConnectionByNodeId(nodeId) {
return getActiveConnections().find(ac => nodeId == ac.node);
return getActiveConnections(AllConnections).find(ac => nodeId == ac.node);
}

View File

@ -2,19 +2,19 @@
'use strict';
// ENiGMA½
var Log = require('./logger.js').log;
var renegadeToAnsi = require('./color_codes.js').renegadeToAnsi;
const Log = require('./logger.js').log;
const renegadeToAnsi = require('./color_codes.js').renegadeToAnsi;
const Config = require('./config.js').get;
var iconv = require('iconv-lite');
var assert = require('assert');
var _ = require('lodash');
const iconv = require('iconv-lite');
const assert = require('assert');
const _ = require('lodash');
exports.ClientTerminal = ClientTerminal;
function ClientTerminal(output) {
this.output = output;
var outputEncoding = 'cp437';
let outputEncoding = 'cp437';
assert(iconv.encodingExists(outputEncoding));
// convert line feeds such as \n -> \r\n
@ -26,10 +26,10 @@ function ClientTerminal(output) {
// Some terminal we handle specially
// They can also be found in this.env{}
//
var termType = 'unknown';
var termHeight = 0;
var termWidth = 0;
var termClient = 'unknown';
let termType = 'unknown';
let termHeight = 0;
let termWidth = 0;
let termClient = 'unknown';
this.currentSyncFont = 'not_set';
@ -42,6 +42,10 @@ function ClientTerminal(output) {
},
set: function (enc) {
if (iconv.encodingExists(enc)) {
Log.info(
{ encoding: enc, currentEncoding: outputEncoding },
`Output encoding changed to ${enc}`
);
outputEncoding = enc;
} else {
Log.warn({ encoding: enc }, 'Unknown encoding');
@ -56,6 +60,11 @@ function ClientTerminal(output) {
set: function (ttype) {
termType = ttype.toLowerCase();
Log.debug(
{ encoding: this.outputEncoding },
`Terminal type changed to ${termType}; Adjusting output encoding`
);
if (this.isNixTerm()) {
this.outputEncoding = 'utf8';
} else {
@ -65,11 +74,6 @@ function ClientTerminal(output) {
// :TODO: according to this: http://mud-dev.wikidot.com/article:telnet-client-identification
// Windows telnet will send "VTNT". If so, set termClient='windows'
// there are some others on the page as well
Log.debug(
{ encoding: this.outputEncoding },
'Set output encoding due to terminal type change'
);
},
});

View File

@ -1,136 +0,0 @@
/* jslint node: true */
'use strict';
// enigma-bbs
const { MenuModule } = require('../core/menu_module.js');
const { resetScreen } = require('../core/ansi_term.js');
const { Errors } = require('./enig_error.js');
const { trackDoorRunBegin, trackDoorRunEnd } = require('./door_util.js');
// deps
const async = require('async');
const RLogin = require('rlogin');
exports.moduleInfo = {
name: 'CombatNet',
desc: 'CombatNet Access Module',
author: 'Dave Stephens',
};
exports.getModule = class CombatNetModule extends MenuModule {
constructor(options) {
super(options);
// establish defaults
this.config = options.menuConfig.config;
this.config.host = this.config.host || 'bbs.combatnet.us';
this.config.rloginPort = this.config.rloginPort || 4513;
}
initSequence() {
const self = this;
async.series(
[
function validateConfig(callback) {
return self.validateConfigFields(
{
host: 'string',
password: 'string',
bbsTag: 'string',
rloginPort: 'number',
},
callback
);
},
function establishRloginConnection(callback) {
self.client.term.write(resetScreen());
self.client.term.write('Connecting to CombatNet, please wait...\n');
let doorTracking;
const restorePipeToNormal = function () {
if (self.client.term.output) {
self.client.term.output.removeListener(
'data',
sendToRloginBuffer
);
if (doorTracking) {
trackDoorRunEnd(doorTracking);
}
}
};
const rlogin = new RLogin({
clientUsername: self.config.password,
serverUsername: `${self.config.bbsTag}${self.client.user.username}`,
host: self.config.host,
port: self.config.rloginPort,
terminalType: self.client.term.termClient,
terminalSpeed: 57600,
});
// If there was an error ...
rlogin.on('error', err => {
self.client.log.info(
`CombatNet rlogin client error: ${err.message}`
);
restorePipeToNormal();
return callback(err);
});
// If we've been disconnected ...
rlogin.on('disconnect', () => {
self.client.log.info('Disconnected from CombatNet');
restorePipeToNormal();
return callback(null);
});
function sendToRloginBuffer(buffer) {
rlogin.send(buffer);
}
rlogin.on(
'connect',
/* The 'connect' event handler will be supplied with one argument,
a boolean indicating whether or not the connection was established. */
function (state) {
if (state) {
self.client.log.info('Connected to CombatNet');
self.client.term.output.on('data', sendToRloginBuffer);
doorTracking = trackDoorRunBegin(self.client);
} else {
return callback(
Errors.General(
'Failed to establish establish CombatNet connection'
)
);
}
}
);
// If data (a Buffer) has been received from the server ...
rlogin.on('data', data => {
self.client.term.rawWrite(data);
});
// connect...
rlogin.connect();
// note: no explicit callback() until we're finished!
},
],
err => {
if (err) {
self.client.log.warn({ error: err.message }, 'CombatNet error');
}
// if the client is still here, go to previous
self.prevMenu();
}
);
}
};

View File

@ -188,22 +188,15 @@ module.exports = () => {
//
// 1 - Generate a Private Key (PK):
// Currently ENiGMA 1/2 requires a PKCS#1 PEM formatted PK.
// To generate a secure PK, issue the following command:
//
// > openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 \
// -pkeyopt rsa_keygen_pubexp:65537 | openssl rsa \
// -out ./config/security/ssh_private_key.pem -aes128
//
// (The above is a more modern equivalent of the following):
// > openssl genrsa -aes128 -out ./config/security/ssh_private_key.pem 2048
// For information on generating a key, see:
// https://nuskooler.github.io/enigma-bbs/servers/loginservers/ssh.html#generate-a-ssh-private-key
//
// 2 - Set 'privateKeyPass' to the password you used in step #1
//
// 3 - Finally, set 'enabled' to 'true'
//
// Additional reading:
// - https://blog.sleeplessbeastie.eu/2017/12/28/how-to-generate-private-key/
// - https://gist.github.com/briansmith/2ee42439923d8e65a266994d0f70180b
// - https://nuskooler.github.io/enigma-bbs/servers/loginservers/ssh.html
//
privateKeyPem: paths.join(
__dirname,
@ -222,14 +215,18 @@ module.exports = () => {
//
algorithms: {
kex: [
'curve25519-sha256',
'curve25519-sha256@libssh.org',
'ecdh-sha2-nistp256',
'ecdh-sha2-nistp384',
'ecdh-sha2-nistp521',
'diffie-hellman-group14-sha1',
'diffie-hellman-group1-sha1',
// Group exchange not currnetly supported
// 'diffie-hellman-group-exchange-sha256',
// 'diffie-hellman-group-exchange-sha1',
'curve25519-sha256',
'curve25519-sha256@libssh.org',
'ecdh-sha2-nistp256',
'ecdh-sha2-nistp384',
'ecdh-sha2-nistp521',
],
cipher: [
'aes128-ctr',
@ -242,12 +239,7 @@ module.exports = () => {
'aes256-cbc',
'aes192-cbc',
'aes128-cbc',
'blowfish-cbc',
'3des-cbc',
'arcfour256',
'arcfour128',
'cast128-cbc',
'arcfour',
],
hmac: [
'hmac-sha2-256',
@ -945,8 +937,10 @@ module.exports = () => {
],
web: {
path: '/f/',
routePath: '/f/[a-zA-Z0-9]+$',
// if you change the /_f/ prefix here, ensure something
// non-colliding with other routes is utilized
path: '/_f/',
routePath: '^/_f/[a-zA-Z0-9]+$',
expireMinutes: 1440, // 1 day
},

View File

@ -69,7 +69,7 @@ module.exports = class ConfigLoader {
defaultConfig,
config,
(defaultVal, configVal, key, target, source) => {
var path;
let path;
while (true) {
// eslint-disable-line no-constant-condition
if (!stack.length) {

View File

@ -157,9 +157,7 @@ const ansiQuerySyncTermFontSupport = (client, cb) => {
const [_, w] = pos;
if (w === 1) {
// cursor didn't move
client.log.info(
'Client supports SyncTERM fonts or properly ignores unknown ESC sequence'
);
client.log.info(`SyncTERM font support enabled on node ${client.node}`);
client.term.syncTermFontsEnabled = true;
}
},

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) {
@ -32,7 +33,7 @@ module.exports = class Door {
});
conn.once('error', err => {
this.client.log.info(
this.client.log.warn(
{ error: err.message },
'Door socket server connection'
);
@ -56,8 +57,12 @@ module.exports = class Door {
run(exeInfo, cb) {
this.encoding = (exeInfo.encoding || 'cp437').toLowerCase();
if ('socket' === this.io && !this.sockServer) {
return cb(Errors.UnexpectedState('Socket server is not running'));
if ('socket' === this.io) {
if(!this.sockServer) {
return cb(Errors.UnexpectedState('Socket server is not running'));
}
} else if ('stdio' !== this.io) {
return cb(Errors.Invalid(`"${this.io}" is not a valid io type!`));
}
const cwd = exeInfo.cwd || paths.dirname(exeInfo.cmd);
@ -65,91 +70,141 @@ 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 process'
);
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.onExit(exitEvent => {
const {exitCode, signal} = exitEvent;
this.client.log.info(
{ exitCode, signal },
'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.onExit( (/*exitEvent*/) => {
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.onExit(exitEvent => {
const {exitCode, signal} = exitEvent;
this.client.log.info({ exitCode, signal }, '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) {

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() {

View File

@ -114,7 +114,7 @@ class ScheduledEvent {
executeAction(reason, cb) {
Log.info(
{ eventName: this.name, action: this.action, reason: reason },
'Executing scheduled event action...'
`Executing scheduled event "${this.name}"...`
);
if ('method' === this.action.type) {
@ -167,17 +167,17 @@ class ScheduledEvent {
return cb(e);
}
proc.once('exit', exitCode => {
if (exitCode) {
proc.onExit(exitEvent => {
if (exitEvent.exitCode) {
Log.warn(
{ eventName: this.name, action: this.action, exitCode: exitCode },
{ eventName: this.name, action: this.action, exitCode: exitEvent.exitCode },
'Bad exit code while performing scheduled event action'
);
}
return cb(
exitCode
exitEvent.exitCode
? Errors.ExternalProcess(
`Bad exit code while performing scheduled event action: ${exitCode}`
`Bad exit code while performing scheduled event action: ${exitEvent.exitCode}`
)
: null
);

View File

@ -2,10 +2,8 @@
'use strict';
// ENiGMA½
const MenuModule = require('./menu_module.js').MenuModule;
const ViewController = require('./view_controller.js').ViewController;
const { MenuModule, MenuFlags } = require('./menu_module.js');
const ansi = require('./ansi_term.js');
const theme = require('./theme.js');
const FileEntry = require('./file_entry.js');
const stringFormat = require('./string_format.js');
const FileArea = require('./file_base_area.js');
@ -77,6 +75,8 @@ exports.getModule = class FileAreaList extends MenuModule {
this.fileList = _.get(options, 'extraArgs.fileList');
this.lastFileNextExit = _.get(options, 'extraArgs.lastFileNextExit', true);
this.setMergedFlag(MenuFlags.NoHistory);
if (this.fileList) {
// we'll need to adjust position as well!
this.fileListPosition = 0;
@ -344,74 +344,19 @@ exports.getModule = class FileAreaList extends MenuModule {
);
}
displayArtAndPrepViewController(name, options, cb) {
const self = this;
const config = this.menuConfig.config;
async.waterfall(
[
function readyAndDisplayArt(callback) {
if (options.clearScreen) {
self.client.term.rawWrite(ansi.resetScreen());
}
theme.displayThemedAsset(
config.art[name],
self.client,
{ font: self.menuConfig.font, trailingLF: false },
(err, artData) => {
return callback(err, artData);
}
);
},
function prepeareViewController(artData, callback) {
if (_.isUndefined(self.viewControllers[name])) {
const vcOpts = {
client: self.client,
formId: FormIds[name],
};
if (!_.isUndefined(options.noInput)) {
vcOpts.noInput = options.noInput;
}
const vc = self.addViewController(
name,
new ViewController(vcOpts)
);
if ('details' === name) {
try {
self.detailsInfoArea = {
top: artData.mciMap.XY2.position,
bottom: artData.mciMap.XY3.position,
};
} catch (e) {
return callback(
Errors.DoesNotExist(
'Missing XY2 and XY3 position indicators!'
)
);
}
}
const loadOpts = {
callingMenu: self,
mciMap: artData.mciMap,
formId: FormIds[name],
};
return vc.loadFromMenuConfig(loadOpts, callback);
}
self.viewControllers[name].setFocus(true);
return callback(null);
},
],
err => {
return cb(err);
displayArtDataPrepCallback(name, artData, viewController) {
if (name === 'details') {
try {
this.detailsInfoArea = {
top: artData.mciMap.XY2.position,
bottom: artData.mciMap.XY3.position,
};
} catch (e) {
throw Errors.DoesNotExist(
'File listing details %XY2 and/or %XY3 MCI position indicators!'
);
}
);
}
}
displayBrowsePage(clearScreen, cb) {
@ -436,7 +381,11 @@ exports.getModule = class FileAreaList extends MenuModule {
function prepArtAndViewController(callback) {
return self.displayArtAndPrepViewController(
'browse',
{ clearScreen: clearScreen },
FormIds.browse,
{
clearScreen: clearScreen,
artDataPrep: self.displayArtDataPrepCallback.bind(self),
},
callback
);
},
@ -528,7 +477,11 @@ exports.getModule = class FileAreaList extends MenuModule {
function prepArtAndViewController(callback) {
return self.displayArtAndPrepViewController(
'details',
{ clearScreen: true },
FormIds.details,
{
clearScreen: true,
artDataPrep: self.displayArtDataPrepCallback.bind(self),
},
callback
);
},
@ -778,7 +731,16 @@ exports.getModule = class FileAreaList extends MenuModule {
return self.displayArtAndPrepViewController(
name,
{ clearScreen: false, noInput: true },
FormIds[name],
{
clearScreen: false,
noInput: true,
artDataPrep: self.displayArtDataPrepCallback.bind(self),
viewOffsets: {
col: 0,
row: self.detailsInfoArea.top[0] - 1,
},
},
callback
);
},

View File

@ -534,6 +534,12 @@ class FileAreaWebAccess {
StatLog.incrementSystemStat(SysProps.FileDlTotalCount, 1);
StatLog.incrementSystemStat(SysProps.FileDlTotalBytes, dlBytes);
StatLog.incrementNonPersistentSystemStat(SysProps.FileDlTodayCount, 1);
StatLog.incrementNonPersistentSystemStat(
SysProps.FileDlTodayBytes,
dlBytes
);
return callback(null, user);
},
function sendEvent(user, callback) {

View File

@ -2,7 +2,7 @@
'use strict';
// enigma-bbs
const MenuModule = require('./menu_module.js').MenuModule;
const { MenuModule, MenuFlags } = require('./menu_module.js');
const { getSortedAvailableFileAreas } = require('./file_base_area.js');
const StatLog = require('./stat_log.js');
const SysProps = require('./system_property.js');
@ -24,6 +24,8 @@ exports.getModule = class FileAreaSelectModule extends MenuModule {
constructor(options) {
super(options);
this.setMergedFlag(MenuFlags.NoHistory);
this.menuMethods = {
selectArea: (formData, extraArgs, cb) => {
const filterCriteria = {
@ -34,7 +36,7 @@ exports.getModule = class FileAreaSelectModule extends MenuModule {
extraArgs: {
filterCriteria: filterCriteria,
},
menuFlags: ['popParent', 'mergeFlags'],
menuFlags: [ MenuFlags.NoHistory ],
};
return this.gotoMenu(

View File

@ -2,10 +2,8 @@
'use strict';
// ENiGMA½
const MenuModule = require('./menu_module.js').MenuModule;
const ViewController = require('./view_controller.js').ViewController;
const { MenuModule, MenuFlags } = require('./menu_module.js');
const DownloadQueue = require('./download_queue.js');
const theme = require('./theme.js');
const ansi = require('./ansi_term.js');
const Errors = require('./enig_error.js').Errors;
const FileAreaWeb = require('./file_area_web.js');
@ -38,6 +36,8 @@ exports.getModule = class FileBaseDownloadQueueManager extends MenuModule {
constructor(options) {
super(options);
this.setMergedFlag(MenuFlags.NoHistory);
this.dlQueue = new DownloadQueue(this.client);
if (_.has(options, 'lastMenuResult.sentFileIds')) {
@ -194,6 +194,7 @@ exports.getModule = class FileBaseDownloadQueueManager extends MenuModule {
function prepArtAndViewController(callback) {
return self.displayArtAndPrepViewController(
'queueManager',
FormIds.queueManager,
{ clearScreen: clearScreen },
callback
);
@ -209,59 +210,4 @@ exports.getModule = class FileBaseDownloadQueueManager extends MenuModule {
}
);
}
displayArtAndPrepViewController(name, options, cb) {
const self = this;
const config = this.menuConfig.config;
async.waterfall(
[
function readyAndDisplayArt(callback) {
if (options.clearScreen) {
self.client.term.rawWrite(ansi.resetScreen());
}
theme.displayThemedAsset(
config.art[name],
self.client,
{ font: self.menuConfig.font, trailingLF: false },
(err, artData) => {
return callback(err, artData);
}
);
},
function prepeareViewController(artData, callback) {
if (_.isUndefined(self.viewControllers[name])) {
const vcOpts = {
client: self.client,
formId: FormIds[name],
};
if (!_.isUndefined(options.noInput)) {
vcOpts.noInput = options.noInput;
}
const vc = self.addViewController(
name,
new ViewController(vcOpts)
);
const loadOpts = {
callingMenu: self,
mciMap: artData.mciMap,
formId: FormIds[name],
};
return vc.loadFromMenuConfig(loadOpts, callback);
}
self.viewControllers[name].setFocus(true);
return callback(null);
},
],
err => {
return cb(err);
}
);
}
};

View File

@ -121,7 +121,6 @@ exports.getModule = class FileBaseSearch extends MenuModule {
extraArgs: {
filterCriteria: filterCriteria,
},
menuFlags: ['popParent'],
};
return this.gotoMenu(

View File

@ -2,7 +2,7 @@
'use strict';
// ENiGMA½
const { MenuModule } = require('./menu_module.js');
const { MenuModule, MenuFlags } = require('./menu_module.js');
const FileEntry = require('./file_entry.js');
const FileArea = require('./file_base_area.js');
const { renderSubstr } = require('./string_util.js');
@ -65,6 +65,9 @@ const MciViewIds = {
exports.getModule = class FileBaseListExport extends MenuModule {
constructor(options) {
super(options);
this.setMergedFlag(MenuFlags.NoHistory);
this.config = Object.assign(
{},
_.get(options, 'menuConfig.config'),

View File

@ -2,10 +2,8 @@
'use strict';
// ENiGMA½
const MenuModule = require('./menu_module.js').MenuModule;
const ViewController = require('./view_controller.js').ViewController;
const { MenuModule, MenuFlags } = require('./menu_module.js');
const DownloadQueue = require('./download_queue.js');
const theme = require('./theme.js');
const ansi = require('./ansi_term.js');
const Errors = require('./enig_error.js').Errors;
const FileAreaWeb = require('./file_area_web.js');
@ -40,6 +38,8 @@ exports.getModule = class FileBaseWebDownloadQueueManager extends MenuModule {
constructor(options) {
super(options);
this.setMergedFlag(MenuFlags.NoHistory);
this.dlQueue = new DownloadQueue(this.client);
this.menuMethods = {
@ -187,6 +187,7 @@ exports.getModule = class FileBaseWebDownloadQueueManager extends MenuModule {
function prepArtAndViewController(callback) {
return self.displayArtAndPrepViewController(
'queueManager',
FormIds.queueManager,
{ clearScreen: clearScreen },
callback
);
@ -266,59 +267,4 @@ exports.getModule = class FileBaseWebDownloadQueueManager extends MenuModule {
}
);
}
displayArtAndPrepViewController(name, options, cb) {
const self = this;
const config = this.menuConfig.config;
async.waterfall(
[
function readyAndDisplayArt(callback) {
if (options.clearScreen) {
self.client.term.rawWrite(ansi.resetScreen());
}
theme.displayThemedAsset(
config.art[name],
self.client,
{ font: self.menuConfig.font, trailingLF: false },
(err, artData) => {
return callback(err, artData);
}
);
},
function prepeareViewController(artData, callback) {
if (_.isUndefined(self.viewControllers[name])) {
const vcOpts = {
client: self.client,
formId: FormIds[name],
};
if (!_.isUndefined(options.noInput)) {
vcOpts.noInput = options.noInput;
}
const vc = self.addViewController(
name,
new ViewController(vcOpts)
);
const loadOpts = {
callingMenu: self,
mciMap: artData.mciMap,
formId: FormIds[name],
};
return vc.loadFromMenuConfig(loadOpts, callback);
}
self.viewControllers[name].setFocus(true);
return callback(null);
},
],
err => {
return cb(err);
}
);
}
};

View File

@ -428,34 +428,47 @@ module.exports = class FileEntry {
return Object.keys(FILE_WELL_KNOWN_META);
}
static findBySha(sha, cb) {
static getFileIdsBySha(sha, options = {}, cb) {
// full or partial SHA-256
const limit = _.isNumber(options.limit) ? `LIMIT ${options.limit}` : '';
fileDb.all(
`SELECT file_id
FROM file
WHERE file_sha256 LIKE "${sha}%"
LIMIT 2;`, // limit 2 such that we can find if there are dupes
WHERE file_sha256 LIKE "${sha}%" ${limit};`,
(err, fileIdRows) => {
if (err) {
return cb(err);
}
if (!fileIdRows || 0 === fileIdRows.length) {
return cb(Errors.DoesNotExist('No matches'));
}
if (fileIdRows.length > 1) {
return cb(Errors.Invalid('SHA is ambiguous'));
}
const fileEntry = new FileEntry();
return fileEntry.load(fileIdRows[0].file_id, err => {
return cb(err, fileEntry);
});
return cb(
null,
(fileIdRows || []).map(r => r.file_id)
);
}
);
}
static findBySha(sha, cb) {
FileEntry.getFileIdsBySha(sha, { limit: 2 }, (err, fileIds) => {
if (err) {
return cb(err);
}
if (!fileIds || 0 === fileIds.length) {
return cb(Errors.DoesNotExist('No matches'));
}
if (fileIds.length > 1) {
return cb(Errors.Invalid('SHA is ambiguous'));
}
const fileEntry = new FileEntry();
return fileEntry.load(fileIds[0], err => {
return cb(err, fileEntry);
});
});
}
// Attempt to fine a file by an *existing* full path.
// Checkums may have changed and are not validated here.
static findByFullPath(fullPath, cb) {
@ -651,6 +664,14 @@ module.exports = class FileEntry {
}
}
if (_.isString(filter.fileName) && filter.fileName.length > 0) {
const caseSensitive = _.get(filter, 'filenameCaseSensitive', false);
const collate = caseSensitive ? '' : 'COLLATE NOCASE';
appendWhereClause(
`(f.file_name = "${sanitizeString(filter.fileName)}" ${collate})`
);
}
// handle e.g. 1998 -> "1998"
if (_.isNumber(filter.tags)) {
filter.tags = filter.tags.toString();

View File

@ -150,7 +150,7 @@ exports.getModule = class TransferFileModule extends MenuModule {
this.client.log.info(
{ sentFiles: sentFiles },
`Successfully sent ${sentFiles.length} file(s)`
`User "${this.client.user.username}" downloaded ${sentFiles.length} file(s)`
);
}
return cb(err);
@ -485,13 +485,10 @@ exports.getModule = class TransferFileModule extends MenuModule {
}
});
externalProc.once('close', () => {
return this.restorePipeAfterExternalProc();
});
externalProc.once('exit', exitCode => {
externalProc.onExit(exitEvent => {
const {exitCode, signal} = exitEvent;
this.client.log.debug(
{ cmd: cmd, args: args, exitCode: exitCode },
{ cmd: cmd, args: args, exitCode, signal },
'Process exited'
);

View File

@ -167,6 +167,7 @@ exports.FullScreenEditorModule =
var newFocusViewId;
if (errMsgView) {
if (err) {
errMsgView.clearText();
errMsgView.setText(err.message);
if (MciViewIds.header.subject === err.view.getId()) {
@ -183,6 +184,13 @@ exports.FullScreenEditorModule =
return cb(null);
},
editModeEscPressed: function (formData, extraArgs, cb) {
const errMsgView = self.viewControllers.header.getView(
MciViewIds.header.errorMsg
);
if (errMsgView) {
errMsgView.clearText();
}
self.footerMode =
'editor' === self.footerMode ? 'editorMenu' : 'editor';
@ -982,11 +990,7 @@ exports.FullScreenEditorModule =
const area = getMessageAreaByTag(self.messageAreaTag);
if (fromView !== undefined) {
if (area && area.realNames) {
fromView.setText(
self.client.user.properties[
UserProps.RealName
] || self.client.user.username
);
fromView.setText(self.client.user.realName());
} else {
fromView.setText(self.client.user.username);
}
@ -1054,7 +1058,7 @@ exports.FullScreenEditorModule =
posView.setText(
_.padStart(String(pos.row + 1), 2, '0') +
',' +
_.padEnd(String(pos.col + 1), 2, '0')
_.padStart(String(pos.col + 1), 2, '0')
);
this.client.term.rawWrite(ansi.restorePos());
}
@ -1299,6 +1303,10 @@ exports.FullScreenEditorModule =
callingMenu: self,
formId: formId,
mciMap: artData.mciMap,
viewOffsets: {
col: 0,
row: self.header.height,
},
};
self.addViewController(

View File

@ -135,7 +135,7 @@ module.exports = class Address {
static fromString(addrStr) {
const m = FTN_ADDRESS_REGEXP.exec(addrStr);
if (m) {
if (m && m[2] && m[3]) {
// start with a 2D
let addr = {
net: parseInt(m[2]),

141
core/goldmine.js Normal file
View File

@ -0,0 +1,141 @@
/* jslint node: true */
'use strict';
// enigma-bbs
const { MenuModule } = require('../core/menu_module');
const { resetScreen } = require('../core/ansi_term');
const { Errors } = require('../core/enig_error');
const { trackDoorRunBegin, trackDoorRunEnd } = require('./door_util');
// deps
const async = require('async');
const _ = require('lodash');
const RLogin = require('rlogin');
exports.moduleInfo = {
name: 'gOLD mINE',
desc: 'gOLD mINE Community Door Server Module',
author: 'NuSkooler',
};
exports.getModule = class GoldmineModule extends MenuModule {
constructor(options) {
super(options);
this.setConfigWithExtraArgs(options);
// http://goldminebbs.com/
this.config.host = this.config.host || '165.232.153.209';
this.config.rloginPort = this.config.rloginPort || 513;
}
initSequence() {
let clientTerminated = false;
async.series(
[
callback => {
return this.validateConfigFields(
{
host: 'string',
rloginPort: 'number',
bbsTag: 'string',
},
callback
);
},
callback => {
this.client.term.write(resetScreen());
this.client.term.write('Connecting to gOLD mINE, please wait...\n');
const username = this.client.user.getSanitizedName();
let doorTracking;
const rlogin = new RLogin({
clientUsername: username,
serverUsername: `${this.config.bbsTag}${username}`,
host: this.config.host,
port: this.config.rloginPort,
terminalType: '',
terminalSpeed: '',
});
if (
_.isString(this.config.directDoorCode) &&
this.config.directDoorCode.length > 0
) {
rlogin.terminalType = `xtrn=${this.config.directDoorCode}`;
}
const rloginSend = buffer => {
return rlogin.send(buffer);
};
let pipeRestored = false;
const restorePipeAndFinish = err => {
if (pipeRestored) {
return;
}
pipeRestored = true;
if (this.client.term.output) {
this.client.term.output.removeListener('data', rloginSend);
}
if (doorTracking) {
trackDoorRunEnd(doorTracking);
}
return callback(err);
};
rlogin.on('error', err => {
// Eat up RLogin error with terminalSpeed not being a number
if (err === 'RLogin: invalid terminalSpeed argument.') {
return;
}
this.client.log.info(
`gOLD mINE rlogin client error: ${err.message || err}`
);
return restorePipeAndFinish(err);
});
rlogin.on('disconnect', () => {
this.client.log.info('Disconnected from gOLD mINE');
return restorePipeAndFinish(null);
});
rlogin.on('connect', connected => {
if (!connected) {
return callback(
Errors.General(
'Failed to establish connection to gOLD mINE'
)
);
}
this.client.log.info('Connected to gOLD mINE');
this.client.term.output.on('data', rloginSend);
doorTracking = trackDoorRunBegin(this.client);
});
rlogin.on('data', data => {
this.client.term.rawWrite(data);
});
// connect...
rlogin.connect();
},
],
err => {
if (err) {
this.client.log.warn({ error: err.message }, 'gOLD mINE error');
}
this.prevMenu();
}
);
}
};

View File

@ -10,6 +10,7 @@ const UserProps = require('./user_property.js');
// deps
const _ = require('lodash');
const moment = require('moment');
module.exports = class LoginServerModule extends ServerModule {
constructor() {
@ -52,6 +53,7 @@ module.exports = class LoginServerModule extends ServerModule {
client.session = {};
}
client.rawSocket = clientSock;
client.session.serverName = modInfo.name;
client.session.isSecure = _.isBoolean(client.isSecure)
? client.isSecure
@ -86,8 +88,12 @@ module.exports = class LoginServerModule extends ServerModule {
clientConns.removeClient(client);
});
client.on('idle timeout', () => {
client.log.info('User idle timeout expired');
client.on('idle timeout', idleLogoutSeconds => {
client.log.info(
`Node ${client.node} idle timeout of ${moment
.duration(idleLogoutSeconds, 'seconds')
.humanize()} expired; Kicking`
);
client.menuStack.goto('idleLogoff', err => {
if (err) {

View File

@ -33,7 +33,6 @@ MCIViewFactory.UserViewCodes = [
'ET',
'ME',
'MT',
'PL',
'BT',
'VM',
'HM',
@ -129,21 +128,6 @@ MCIViewFactory.prototype.createFromMCI = function (mci) {
view = new MultiLineEditTextView(options);
break;
// Pre-defined Label (Text View)
// :TODO: Currently no real point of PL -- @method replaces this pretty much... probably remove
case 'PL':
if (mci.args.length > 0) {
options.text = getPredefinedMCIValue(this.client, mci.args[0]);
if (options.text) {
setOption(1, 'textStyle');
setOption(2, 'justify');
setWidth(3);
view = new TextView(options);
}
}
break;
// Button
case 'BT':
if (mci.args.length > 0) {

View File

@ -12,6 +12,7 @@ const MultiLineEditTextView =
require('../core/multi_line_edit_text_view.js').MultiLineEditTextView;
const Errors = require('../core/enig_error.js').Errors;
const { getPredefinedMCIValue } = require('../core/predefined_mci.js');
const EnigAssert = require('./enigma_assert');
// deps
const async = require('async');
@ -19,6 +20,23 @@ const assert = require('assert');
const _ = require('lodash');
const iconvDecode = require('iconv-lite').decode;
const MenuFlags = {
// When leaving this menu to load/chain to another, remove this
// menu from history. In other words, the fallback from
// the next menu would *not* be this one, but the previous.
NoHistory: 'noHistory',
// Generally used in code only: Request that any flags from menu.hjson
// are merged in to the total set of flags vs overriding the default.
MergeFlags: 'mergeFlags',
// Forward this menu's 'extraArgs' to the next.
ForwardArgs: 'forwardArgs',
};
exports.MenuFlags = MenuFlags;
exports.MenuModule = class MenuModule extends PluginModule {
constructor(options) {
super(options);
@ -41,6 +59,17 @@ exports.MenuModule = class MenuModule extends PluginModule {
}
}
setConfigWithExtraArgs(options) {
this.config = Object.assign({}, _.get(options, 'menuConfig.config'), {
extraArgs: options.extraArgs,
});
}
setMergedFlag(flag) {
this.menuConfig.config.menuFlags.push(flag);
this.menuConfig.config.menuFlags = [...new Set([...this.menuConfig.config.menuFlags, MenuFlags.MergeFlags])];
}
static get InterruptTypes() {
return {
Never: 'never',
@ -574,8 +603,13 @@ exports.MenuModule = class MenuModule extends PluginModule {
}
}
//let artHeight;
const originalSubmitNotify = options.submitNotify;
options.submitNotify = () => {
if (_.isFunction(originalSubmitNotify)) {
originalSubmitNotify();
}
if (prevVc) {
prevVc.setFocus(true);
}
@ -596,6 +630,9 @@ exports.MenuModule = class MenuModule extends PluginModule {
options.viewController.setFocus(true);
this.optionalMoveToPosition(position);
if (!options.position) {
options.position = position;
}
theme.displayThemedPrompt(promptName, this.client, options, (err, artInfo) => {
/*
if(artInfo) {
@ -606,6 +643,70 @@ exports.MenuModule = class MenuModule extends PluginModule {
});
}
displayArtAndPrepViewController(name, formId, options, cb) {
const config = this.menuConfig.config;
EnigAssert(_.isObject(config));
async.waterfall(
[
callback => {
if (options.clearScreen) {
this.client.term.rawWrite(ansi.resetScreen());
}
theme.displayThemedAsset(
config.art[name],
this.client,
{ font: this.menuConfig.font, trailingLF: false },
(err, artData) => {
return callback(err, artData);
}
);
},
(artData, callback) => {
if (_.isUndefined(this.viewControllers[name])) {
const vcOpts = {
client: this.client,
formId: formId,
};
if (!_.isUndefined(options.noInput)) {
vcOpts.noInput = options.noInput;
}
const vc = this.addViewController(
name,
new ViewController(vcOpts)
);
if (_.isFunction(options.artDataPrep)) {
try {
options.artDataPrep(name, artData, vc);
} catch (e) {
return callback(e);
}
}
const loadOpts = {
callingMenu: this,
mciMap: artData.mciMap,
formId: formId,
viewOffsets: options.viewOffsets,
};
return vc.loadFromMenuConfig(loadOpts, callback);
}
this.viewControllers[name].setFocus(true);
return callback(null);
},
],
err => {
return cb(err);
}
);
}
setViewText(formName, mciId, text, appendMultiLine) {
const view = this.getView(formName, mciId);
if (!view) {
@ -613,7 +714,7 @@ exports.MenuModule = class MenuModule extends PluginModule {
}
if (appendMultiLine && view instanceof MultiLineEditTextView) {
view.addText(text);
view.setAnsi(text);
} else {
view.setText(text);
}
@ -624,17 +725,19 @@ exports.MenuModule = class MenuModule extends PluginModule {
return form && form.getView(id);
}
updateCustomViewTextsWithFilter(formName, startId, fmtObj, options) {
getCustomViewsWithFilter(formName, startId, options) {
options = options || {};
let textView;
const views = [];
let view;
let customMciId = startId;
const config = this.menuConfig.config;
const endId = options.endId || 99; // we'll fail to get a view before 99
while (
customMciId <= endId &&
(textView = this.viewControllers[formName].getView(customMciId))
(view = this.viewControllers[formName].getView(customMciId))
) {
const key = `${formName}InfoFormat${customMciId}`; // e.g. "mainInfoFormat10"
const format = config[key];
@ -643,20 +746,35 @@ exports.MenuModule = class MenuModule extends PluginModule {
format &&
(!options.filter || options.filter.find(f => format.indexOf(f) > -1))
) {
const text = stringFormat(format, fmtObj);
if (
options.appendMultiLine &&
textView instanceof MultiLineEditTextView
) {
textView.addText(text);
} else {
textView.setText(text);
}
view.key = key; // cache
views.push(view);
}
++customMciId;
}
return views;
}
updateCustomViewTextsWithFilter(formName, startId, fmtObj, options) {
options = options || {};
const views = this.getCustomViewsWithFilter(formName, startId, options);
const config = this.menuConfig.config;
views.forEach(view => {
const format = config[view.key];
const text = stringFormat(format, fmtObj);
if (options.appendMultiLine && view instanceof MultiLineEditTextView) {
view.addText(text);
} else {
if (view.getData() != text) {
view.setText(text);
} else {
view.redraw();
}
}
});
}
refreshPredefinedMciViewsByCode(formName, mciCodes) {
@ -752,4 +870,26 @@ exports.MenuModule = class MenuModule extends PluginModule {
)
);
}
// Various common helpers
getDateFormat(defaultStyle = 'short') {
return (
this.config.dateFormat ||
this.client.currentTheme.helpers.getDateFormat(defaultStyle)
);
}
getTimeFormat(defaultStyle = 'short') {
return (
this.config.timeFormat ||
this.client.currentTheme.helpers.getTimeFormat(defaultStyle)
);
}
getDateTimeFormat(defaultStyle = 'short') {
return (
this.config.dateTimeFormat ||
this.client.currentTheme.helpers.getDateTimeFormat(defaultStyle)
);
}
};

View File

@ -5,12 +5,12 @@
const loadMenu = require('./menu_util.js').loadMenu;
const { Errors, ErrorReasons } = require('./enig_error.js');
const { getResolvedSpec } = require('./menu_util.js');
const { MenuFlags } = require('./menu_module.js');
// deps
const _ = require('lodash');
const assert = require('assert');
// :TODO: Stack is backwards.... top should be most recent! :)
const bunyan = require('bunyan');
module.exports = class MenuStack {
constructor(client) {
@ -27,19 +27,11 @@ module.exports = class MenuStack {
}
peekPrev() {
if (this.stackSize > 1) {
return this.stack[this.stack.length - 2];
}
return this.stack[this.stack.length - 2];
}
top() {
if (this.stackSize > 0) {
return this.stack[this.stack.length - 1];
}
}
get stackSize() {
return this.stack.length;
return this.stack[this.stack.length - 1];
}
get currentModule() {
@ -56,13 +48,13 @@ module.exports = class MenuStack {
return cb(
Array.isArray(menuConfig.next)
? Errors.MenuStack(
'No matching condition for "next"',
ErrorReasons.NoConditionMatch
)
'No matching condition for "next"',
ErrorReasons.NoConditionMatch
)
: Errors.MenuStack(
'Invalid or missing "next" member in menu config',
ErrorReasons.InvalidNextMenu
)
'Invalid or missing "next" member in menu config',
ErrorReasons.InvalidNextMenu
)
);
}
@ -81,7 +73,6 @@ module.exports = class MenuStack {
prev(cb) {
const menuResult = this.top().instance.getMenuResult();
// :TODO: leave() should really take a cb...
this.pop().instance.leave(); // leave & remove current
const previousModuleInfo = this.pop(); // get previous
@ -129,7 +120,7 @@ module.exports = class MenuStack {
client: self.client,
};
if (currentModuleInfo && currentModuleInfo.menuFlags.includes('forwardArgs')) {
if (currentModuleInfo && currentModuleInfo.menuFlags.includes(MenuFlags.ForwardArgs)) {
loadOpts.extraArgs = currentModuleInfo.extraArgs;
} else {
loadOpts.extraArgs = options.extraArgs || _.get(options, 'formData.value');
@ -138,7 +129,6 @@ module.exports = class MenuStack {
loadMenu(loadOpts, (err, modInst) => {
if (err) {
// :TODO: probably should just require a cb...
const errCb = cb || self.client.defaultHandlerMissingMod();
errCb(err);
} else {
@ -151,22 +141,6 @@ module.exports = class MenuStack {
return;
}
//
// Handle deprecated 'options' block by merging to config and warning user.
// :TODO: Remove in 0.0.10+
//
if (modInst.menuConfig.options) {
self.client.log.warn(
{ options: modInst.menuConfig.options },
'Use of "options" is deprecated. Move relevant members to "config" block! Support will be fully removed in future versions'
);
Object.assign(
modInst.menuConfig.config || {},
modInst.menuConfig.options
);
delete modInst.menuConfig.options;
}
//
// If menuFlags were supplied in menu.hjson, they should win over
// anything supplied in code.
@ -180,9 +154,9 @@ module.exports = class MenuStack {
// in code we can ask to merge in
if (
Array.isArray(options.menuFlags) &&
options.menuFlags.includes('mergeFlags')
options.menuFlags.includes(MenuFlags.MergeFlags)
) {
menuFlags = _.uniq(menuFlags.concat(options.menuFlags));
menuFlags = [...new Set(options.menuFlags)]; // make unique
}
}
@ -193,12 +167,8 @@ module.exports = class MenuStack {
currentModuleInfo.instance.leave();
if (currentModuleInfo.menuFlags.includes('noHistory')) {
this.pop();
}
if (menuFlags.includes('popParent')) {
this.pop().instance.leave(); // leave & remove current
if (currentModuleInfo.menuFlags.includes(MenuFlags.NoHistory)) {
this.pop().instance.leave(); // leave & remove current from stack
}
}
@ -214,17 +184,19 @@ module.exports = class MenuStack {
modInst.restoreSavedState(options.savedState);
}
const stackEntries = self.stack.map(stackEntry => {
let name = stackEntry.name;
if (stackEntry.instance.menuConfig.config.menuFlags.length > 0) {
name += ` (${stackEntry.instance.menuConfig.config.menuFlags.join(
', '
)})`;
}
return name;
});
if (self.client.log.level() <= bunyan.TRACE) {
const stackEntries = self.stack.map(stackEntry => {
let name = stackEntry.name;
if (stackEntry.instance.menuConfig.config.menuFlags.length > 0) {
name += ` (${stackEntry.instance.menuConfig.config.menuFlags.join(
', '
)})`;
}
return name;
});
self.client.log.trace({ stack: stackEntries }, 'Updated menu stack');
self.client.log.trace({ stack: stackEntries }, 'Updated menu stack');
}
modInst.enter();

View File

@ -198,6 +198,10 @@ MenuView.prototype.getItems = function () {
};
MenuView.prototype.getItem = function (index) {
if (index > this.items.length - 1) {
return null;
}
if (this.complexItems) {
return this.items[index];
}
@ -233,6 +237,10 @@ MenuView.prototype.setFocusItemIndex = function (index) {
this.focusedItemIndex = index;
};
MenuView.prototype.getFocusItemIndex = function () {
return this.focusedItemIndex;
};
MenuView.prototype.onKeyPress = function (ch, key) {
const itemIndex = this.getHotKeyItemIndex(ch);
if (itemIndex >= 0) {

View File

@ -55,6 +55,7 @@ const ADDRESS_FLAVOR = {
FTN: 'ftn', // FTN style
Email: 'email', // From email
QWK: 'qwk', // QWK packet
NNTP: 'nntp', // NNTP article POST; often a email address
};
const STATE_FLAGS0 = {
@ -762,6 +763,11 @@ module.exports = class Message {
}
persist(cb) {
const containsNonWhitespaceCharacterRegEx = /\S/;
if (!containsNonWhitespaceCharacterRegEx.test(this.message)) {
return cb(Errors.Invalid('Empty message'));
}
if (!this.isValid()) {
return cb(Errors.Invalid('Cannot persist invalid message!'));
}

View File

@ -40,6 +40,7 @@ exports.filterMessageListByReadACS = filterMessageListByReadACS;
exports.tempChangeMessageConfAndArea = tempChangeMessageConfAndArea;
exports.getMessageListForArea = getMessageListForArea;
exports.getNewMessageCountInAreaForUser = getNewMessageCountInAreaForUser;
exports.getNewMessageCountAddressedToUser = getNewMessageCountAddressedToUser;
exports.getNewMessagesInAreaForUser = getNewMessagesInAreaForUser;
exports.getMessageIdNewerThanTimestampByArea = getMessageIdNewerThanTimestampByArea;
exports.getMessageAreaLastReadId = getMessageAreaLastReadId;
@ -362,7 +363,7 @@ function changeMessageConference(client, confTag, cb) {
if (!err) {
client.log.info(
{ confTag: confTag, confName: conf.name, areaTag: areaInfo.areaTag },
'Current message conference changed'
`${client.node} changed message conference to ${areaInfo.areaTag}`
);
} else {
client.log.warn(
@ -411,9 +412,9 @@ function changeMessageAreaWithOptions(client, areaTag, options, cb) {
],
function complete(err, area) {
if (!err) {
client.log.info(
client.log.debug(
{ areaTag: areaTag, area: area },
'Current message area changed'
`Node ${client.node} changed message area to ${areaTag}`
);
} else {
client.log.warn(
@ -531,6 +532,36 @@ function getNewMessageCountInAreaForUser(userId, areaTag, cb) {
});
}
// New message count -- for all areas available to the user
// that are addressed to that user (ie: matching username)
// Does NOT Include private messages.
function getNewMessageCountAddressedToUser(client, cb) {
const areaTags = getAllAvailableMessageAreaTags(client).filter(
areaTag => areaTag !== Message.WellKnownAreaTags.Private
);
let newMessageCount = 0;
async.forEach(
areaTags,
(areaTag, nextAreaTag) => {
getMessageAreaLastReadId(client.user.userId, areaTag, (_, lastMessageId) => {
lastMessageId = lastMessageId || 0;
getNewMessageCountInAreaForUser(
client.user.userId,
areaTag,
(err, count) => {
newMessageCount += count;
return nextAreaTag(err);
}
);
});
},
() => {
return cb(null, newMessageCount);
}
);
}
function getNewMessagesInAreaForUser(userId, areaTag, cb) {
getMessageAreaLastReadId(userId, areaTag, (err, lastMessageId) => {
lastMessageId = lastMessageId || 0;

View File

@ -332,7 +332,10 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
publicExportAreas,
(exportArea, nextExportArea) => {
const area = getMessageAreaByTag(exportArea.areaTag);
const conf = getMessageConferenceByTag(area.confTag);
let conf;
if (area) {
conf = getMessageConferenceByTag(area.confTag);
}
if (!area || !conf) {
// :TODO: remove from user properties - this area does not exist
this.client.log.warn(

View File

@ -113,7 +113,6 @@ exports.getModule = class MessageBaseSearch extends MenuModule {
const returnNoResults = () => {
return this.gotoMenu(
this.menuConfig.config.noResultsMenu || 'messageSearchNoResults',
{ menuFlags: ['popParent'] },
cb
);
};
@ -160,7 +159,6 @@ exports.getModule = class MessageBaseSearch extends MenuModule {
messageList,
noUpdateLastReadId: true,
},
menuFlags: ['popParent'],
};
return this.gotoMenu(

View File

@ -10,7 +10,14 @@ function dailyMaintenanceScheduledEvent(args, cb) {
//
// Various stats need reset daily
//
[SysProps.LoginsToday, SysProps.MessagesToday].forEach(prop => {
// :TODO: files/etc. here
const resetProps = [
SysProps.LoginsToday,
SysProps.MessagesToday,
SysProps.NewUsersTodayCount,
];
resetProps.forEach(prop => {
StatLog.setNonPersistentSystemStat(prop, 0);
});

View File

@ -55,6 +55,8 @@ const helpText = `
|03/|11topic |03<message> |08- |07Set the room topic
|03/|11bbses |08& |03/|11info <id> |08- |07Info about BBS's connected
|03/|11meetups |08- |07Info about MRC MeetUps
|03/|11quote |08- |07Send raw command to server
|03/|11help |08- |07Server-side commands help
---
|03/|11l33t |03<your message> |08- |07l337 5p34k
|03/|11kewl |03<your message> |08- |07BBS KeWL SPeaK
@ -375,6 +377,18 @@ exports.getModule = class mrcModule extends MenuModule {
'|08' + currentTime + '|00 ' + message.body + '|00'
);
}
// Deliver PrivMsg
else if (
message.to_user.toLowerCase() == this.state.alias.toLowerCase()
) {
const currentTime = moment().format(
this.client.currentTheme.helpers.getTimeFormat()
);
this.addMessageToChatLog(
'|08' + currentTime + '|00 ' + message.body + '|00'
);
}
}
this.viewControllers.mrcChat.switchFocus(MciViewIds.mrcChat.inputArea);
@ -540,6 +554,46 @@ exports.getModule = class mrcModule extends MenuModule {
this.sendServerMessage('LIST');
break;
// Allow support for new server commands without change to client
case 'quote':
this.sendServerMessage(`${message.substr(7)}`);
break;
/**
* Process known additional server commands directly
*/
case 'afk':
this.sendServerMessage(`AFK ${message.substr(5)}`);
break;
case 'roomconfig':
this.sendServerMessage(`ROOMCONFIG ${message.substr(12)}`);
break;
case 'roompass':
this.sendServerMessage(`ROOMPASS ${message.substr(12)}`);
break;
case 'status':
this.sendServerMessage(`STATUS ${message.substr(8)}`);
break;
case 'lastseen':
this.sendServerMessage(`LASTSEEN ${message.substr(10)}`);
break;
case 'help':
this.sendServerMessage(`HELP ${message.substr(6)}`);
break;
case 'statistics':
case 'changelog':
case 'listbans':
case 'listmutes':
case 'routing':
this.sendServerMessage(cmd[0].toUpperCase());
break;
case 'quit':
return this.prevMenu();

View File

@ -2,7 +2,7 @@
'use strict';
// ENiGMA½
const { MenuModule } = require('./menu_module.js');
const { MenuModule, MenuFlags } = require('./menu_module.js');
const messageArea = require('./message_area.js');
const { Errors } = require('./enig_error.js');
const UserProps = require('./user_property.js');
@ -29,6 +29,9 @@ exports.getModule = class MessageAreaListModule extends MenuModule {
constructor(options) {
super(options);
// always include noHistory flag
this.setMergedFlag(MenuFlags.NoHistory);
this.initList();
this.menuMethods = {
@ -49,7 +52,7 @@ exports.getModule = class MessageAreaListModule extends MenuModule {
extraArgs: {
areaTag: area.areaTag,
},
menuFlags: ['popParent', 'noHistory'],
menuFlags: [ MenuFlags.NoHistory ],
};
return this.gotoMenu(

View File

@ -14,6 +14,39 @@ exports.moduleInfo = {
author: 'NuSkooler',
};
const MciViewIds = {
header: {
from: 1,
to: 2,
subject: 3,
errorMsg: 4,
modTimestamp: 5,
msgNum: 6,
msgTotal: 7,
customRangeStart: 10, // 10+ = customs
},
body: {
message: 1,
},
// :TODO: quote builder MCIs - remove all magic #'s
// :TODO: consolidate all footer MCI's - remove all magic #'s
ViewModeFooter: {
MsgNum: 6,
MsgTotal: 7,
// :TODO: Just use custom ranges
},
quoteBuilder: {
quotedMsg: 1,
// 2 NYI
quoteLines: 3,
},
};
exports.getModule = class AreaPostFSEModule extends FullScreenEditorModule {
constructor(options) {
super(options);
@ -42,19 +75,25 @@ exports.getModule = class AreaPostFSEModule extends FullScreenEditorModule {
],
function complete(err) {
if (err) {
// :TODO:... sooooo now what?
} else {
// note: not logging 'from' here as it's part of client.log.xxxx()
self.client.log.info(
{
to: msg.toUserName,
subject: msg.subject,
uuid: msg.messageUuid,
},
'Message persisted'
const errMsgView = self.viewControllers.header.getView(
MciViewIds.header.errorMsg
);
if (errMsgView) {
errMsgView.setText(err.message);
}
return cb(err);
}
// note: not logging 'from' here as it's part of client.log.xxxx()
self.client.log.info(
{
to: msg.toUserName,
subject: msg.subject,
uuid: msg.messageUuid,
},
`User "${self.client.user.username}" posted message to "${msg.toUserName}" (${msg.areaTag})`
);
return self.nextMenu(cb);
}
);

View File

@ -2,7 +2,7 @@
'use strict';
// ENiGMA½
const { MenuModule } = require('./menu_module.js');
const { MenuModule, MenuFlags } = require('./menu_module.js');
const messageArea = require('./message_area.js');
const { Errors } = require('./enig_error.js');
@ -26,6 +26,9 @@ exports.getModule = class MessageConfListModule extends MenuModule {
constructor(options) {
super(options);
// always include noHistory flag
this.setMergedFlag(MenuFlags.NoHistory);
this.initList();
this.menuMethods = {
@ -49,7 +52,7 @@ exports.getModule = class MessageConfListModule extends MenuModule {
extraArgs: {
confTag: conf.confTag,
},
menuFlags: ['popParent', 'noHistory'],
menuFlags: [ MenuFlags.NoHistory ],
};
return this.gotoMenu(

View File

@ -70,6 +70,14 @@ exports.getModule = class MessageListModule extends (
this.menuMethods = {
selectMessage: (formData, extraArgs, cb) => {
if (!Array.isArray(this.config?.messageList)) {
this.client.log.error(
{ formData },
'No message list is available to select from!'
);
return cb(null);
}
if (MciViewIds.allViews.msgList === formData.submitId) {
// 'messageIndex' or older deprecated 'message' member
this.initialFocusIndex = _.get(
@ -315,9 +323,16 @@ exports.getModule = class MessageListModule extends (
let msgNum = 1;
self.config.messageList.forEach((listItem, index) => {
listItem.msgNum = msgNum++;
listItem.ts = moment(listItem.modTimestamp).format(
dateTimeFormat
);
try {
listItem.ts = moment(listItem.modTimestamp).format(
dateTimeFormat
);
} catch (e) {
self.client.log.warn(
`Error parsing "${listItem.modTimestamp}"; expected timestamp: ${e.message}`
);
listItem.ts = moment().format(dateTimeFormat);
}
const isNew = _.isBoolean(listItem.isNew)
? listItem.isNew
: listItem.messageId > self.lastReadId;

View File

@ -2,7 +2,7 @@
'use strict';
// ENiGMA½
const MenuModule = require('./menu_module.js').MenuModule;
const { MenuModule, MenuFlags } = require('./menu_module');
const Message = require('./message.js');
const UserProps = require('./user_property.js');
const { filterMessageListByReadACS } = require('./message_area.js');
@ -16,14 +16,12 @@ exports.moduleInfo = {
exports.getModule = class MyMessagesModule extends MenuModule {
constructor(options) {
super(options);
this.setMergedFlag(MenuFlags.NoHistory);
}
initSequence() {
const filter = {
toUserName: [
this.client.user.username,
this.client.user.getProperty(UserProps.RealName),
],
toUserName: [this.client.user.username, this.client.user.realName()],
sort: 'modTimestamp',
resultType: 'messageList',
limit: 1024 * 16, // we want some sort of limit...
@ -49,7 +47,6 @@ exports.getModule = class MyMessagesModule extends MenuModule {
if (!this.messageList || 0 === this.messageList.length) {
return this.gotoMenu(
this.menuConfig.config.noResultsMenu || 'messageSearchNoResults',
{ menuFlags: ['popParent'] }
);
}
@ -58,7 +55,6 @@ exports.getModule = class MyMessagesModule extends MenuModule {
messageList: this.messageList,
noUpdateLastReadId: true,
},
menuFlags: ['popParent'],
};
return this.gotoMenu(

View File

@ -6,6 +6,7 @@ const { MenuModule } = require('./menu_module.js');
const {
getActiveConnectionList,
getConnectionByNodeId,
UserMessageableConnections,
} = require('./client_connections.js');
const UserInterruptQueue = require('./user_interrupt_queue.js');
const { getThemeArt } = require('./theme.js');
@ -236,7 +237,7 @@ exports.getModule = class NodeMessageModule extends MenuModule {
},
]
.concat(
getActiveConnectionList(true).map(node =>
getActiveConnectionList(UserMessageableConnections).map(node =>
Object.assign(node, {
text: -1 == node.node ? '-ALL-' : node.node.toString(),
})

View File

@ -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.Location]: formData.value.location,
[UserProps.Affiliations]: formData.value.affils,
[UserProps.EmailAddress]: formData.value.email,
[UserProps.WebAddress]: formData.value.web,
[UserProps.Sex]: formData.value.sex || '',
[UserProps.Location]: formData.value.location || '',
[UserProps.Affiliations]: formData.value.affils || '',
[UserProps.EmailAddress]: formData.value.email || '',
[UserProps.WebAddress]: formData.value.web || '',
[UserProps.AccountCreated]: getISOTimestampString(),
[UserProps.MessageConfTag]: confTag,
@ -130,7 +131,7 @@ exports.getModule = class NewUserAppModule extends MenuModule {
};
newUser.create(createUserInfo, err => {
if (err) {
self.client.log.info(
self.client.log.warn(
{ error: err, username: formData.value.username },
'New user creation failed'
);
@ -144,7 +145,7 @@ exports.getModule = class NewUserAppModule extends MenuModule {
} else {
self.client.log.info(
{ username: formData.value.username, userId: newUser.userId },
'New user created'
`New user "${formData.value.username}" created`
);
// Cache SysOp information now

View File

@ -69,6 +69,18 @@ Actions:
info arguments:
--security Include security information in output
list arguments:
--sort SORT_BY Specify field to sort by
Valid SORT_BY values:
id : User ID
username : Username
realname : Real name
status : Account status
created : Account creation date
lastlogin : Last login timestamp
logins : Login count
2fa-otp arguments:
--qr-type TYPE Specify QR code type
@ -170,6 +182,14 @@ General Information:
MessageBase: `usage: oputil.js mb <action> [<arguments>]
Actions:
list-confs List conferences and areas
post PATH Posts a message file specified in PATH.
PATH must point to a UTF-8 encoded JSON file
containing 'to', 'from', 'subject', 'areaTag', and
'body'. If 'timestamp' is present, the system will
attempt to use it.
areafix CMD1 CMD2 ... ADDR Sends an AreaFix NetMail
NetMail is sent to supplied address with the supplied command(s). Multi-part commands
@ -182,6 +202,9 @@ Actions:
packet in the directory specified by PATH. The QWK
BBS ID will be obtained by the final component of PATH.
list-confs arguments:
--areas Include areas within each message conference.
import-areas arguments:
--conf CONF_TAG Conference tag in which to import areas
--network NETWORK Network name/key to associate FTN areas

View File

@ -692,6 +692,162 @@ function exportQWKPacket() {
);
}
const listConferences = () => {
initConfigAndDatabases(err => {
if (err) {
return console.error(err.reason ? err.reason : err.message);
}
const { getSortedAvailMessageConferences } = require('../../core/message_area');
const conferences = getSortedAvailMessageConferences(null, { noClient: true });
for (let conf of conferences) {
console.info(`${conf.confTag} - ${conf.conf.name}`);
if (!argv.areas) {
continue;
}
for (let areaTag of Object.keys(conf.conf.areas)) {
console.info(` ${areaTag} - ${conf.conf.areas[areaTag].name}`);
}
}
});
};
const postMessage = () => {
const inputFile = argv._[argv._.length - 1];
if (argv._.length < 3 || !inputFile || 0 === inputFile.length) {
return printUsageAndSetExitCode(getHelpFor('MessageBase'), ExitCodes.ERROR);
}
async.waterfall(
[
callback => {
return initConfigAndDatabases(callback);
},
callback => {
fs.readFile(inputFile, { encoding: 'utf-8' }, (err, jsonData) => {
if (err) {
return callback(err);
}
let messageJson;
try {
messageJson = JSON.parse(jsonData);
} catch (e) {
return callback(e);
}
for (let f of ['to', 'from', 'subject', 'body', 'areaTag']) {
if (!_.isString(messageJson[f])) {
return callback(
Errors.MissingConfig(
`Missing "${f}" field in message JSON`
)
);
}
messageJson[f] = messageJson[f].trim();
if (messageJson[f].length === 0 && f !== 'subject') {
return callback(
Errors.Invalid(
`"${messageJson[f]}" is not a valid value for the "${f}" field`
)
);
}
}
const { getMessageAreaByTag } = require('../../core/message_area');
const area = getMessageAreaByTag(messageJson.areaTag);
if (!area) {
return callback(
Errors.DoesNotExist(
`Area "${messageJson.areaTag}" does not exist`
)
);
}
const { getAddressedToInfo } = require('../../core/mail_util');
const Message = require('../../core/message');
const toInfo = getAddressedToInfo(messageJson.to);
const fromInfo = getAddressedToInfo(messageJson.from);
if (fromInfo.flavor !== Message.AddressFlavor.Local) {
return callback(
Errors.Invalid(
'Only local "from" users are currently supported'
)
);
}
let modTimestamp;
if (_.isString(messageJson.timestamp)) {
modTimestamp = moment(messageJson.timestamp);
}
if (!modTimestamp || !modTimestamp.isValid()) {
modTimestamp = moment();
}
const message = new Message({
toUserName: messageJson.to,
fromUserName: messageJson.from,
subject: messageJson.subject,
message: messageJson.body,
areaTag: messageJson.areaTag,
modTimestamp,
});
if (toInfo.flavor !== Message.AddressFlavor.Local) {
message.setExternalFlavor(toInfo.flavor);
message.setRemoteToUser(toInfo.remote);
return callback(null, area, message);
}
const User = require('../../core/user');
User.getUserIdAndNameByLookup(
message.toUserName,
(err, toUserId, toUserName) => {
if (err) {
return callback(
Errors.DoesNotExist(
`User "${message.toUserName}" does not exist.`
)
);
}
message.to = toUserName; // adjust case/etc.
message.setLocalToUserId(toUserId);
return callback(null, area, message);
}
);
});
},
(area, message, callback) => {
message.persist(err => {
if (!err) {
console.info(
`Message from ${message.fromUserName} to ${message.toUserName}: "${message.subject}" in ${area.name}`
);
}
return callback(err);
});
},
],
err => {
if (err) {
return console.error(err.reason ? err.reason : err.message);
}
}
);
};
function handleMessageBaseCommand() {
function errUsage() {
return printUsageAndSetExitCode(getHelpFor('MessageBase'), ExitCodes.ERROR);
@ -709,6 +865,8 @@ function handleMessageBaseCommand() {
'import-areas': importAreas,
'qwk-dump': dumpQWKPacket,
'qwk-export': exportQWKPacket,
'list-confs': listConferences,
post: postMessage,
}[action] || errUsage
)();
}

View File

@ -17,6 +17,7 @@ const async = require('async');
const _ = require('lodash');
const moment = require('moment');
const fs = require('fs-extra');
const Table = require('easy-table');
exports.handleUserCommand = handleUserCommand;
@ -340,7 +341,7 @@ function showUserInfo(user) {
const statusDesc = () => {
const status = user.properties[UserProps.AccountStatus];
return _.invert(User.AccountStatus)[status] || 'unknown';
return _.invert(User.AccountStatus)[status] || 'N/A';
};
const created = () => {
@ -508,7 +509,6 @@ function listUsers() {
// :TODO: --created-since SPEC and --last-called SPEC
// --created-since SPEC
// SPEC can be TIMESTAMP or e.g. "-1hour" or "-90days"
// :TODO: --sort name|id
let listWhat;
if (argv._.length > 2) {
listWhat = argv._[argv._.length - 1];
@ -516,6 +516,8 @@ function listUsers() {
listWhat = 'all';
}
const sortBy = (argv.sort || 'id').toLowerCase();
const User = require('../../core/user');
if (!['all'].concat(Object.keys(User.AccountStatus)).includes(listWhat)) {
return printUsageAndSetExitCode(getHelpFor('User'), ExitCodes.ERROR);
@ -527,7 +529,13 @@ function listUsers() {
const UserProps = require('../../core/user_property');
const userListOpts = {
properties: [UserProps.AccountStatus],
properties: [
UserProps.RealName,
UserProps.AccountStatus,
UserProps.AccountCreated,
UserProps.LastLoginTs,
UserProps.LoginCount,
],
};
User.getUserList(userListOpts, (err, userList) => {
@ -550,10 +558,94 @@ function listUsers() {
});
},
(userList, callback) => {
// default sort: by ID
const sortById = (left, right) => {
return left.userId - right.userId;
};
const sortByLogin = prop => (left, right) => {
return parseInt(right[prop]) - parseInt(left[prop]);
};
const sortByString = prop => (left, right) => {
return left[prop].localeCompare(right[prop], {
sensitivity: false,
numeric: true,
});
};
const sortByTimestamp = prop => (left, right) => {
return moment(right[prop]) - moment(left[prop]);
};
let sorter;
switch (sortBy) {
case 'username':
sorter = sortByString('userName');
break;
case 'realname':
sorter = sortByString(UserProps.RealName);
break;
case 'status':
sorter = sortByString(UserProps.AccountStatus);
break;
case 'created':
sorter = sortByTimestamp(UserProps.AccountCreated);
break;
case 'lastlogin':
sorter = sortByTimestamp(UserProps.LastLoginTs);
break;
case 'logins':
sorter = sortByLogin(UserProps.LoginCount);
break;
case 'id':
default:
sorter = sortById;
break;
}
userList.sort(sorter);
const StatusNames = _.invert(User.AccountStatus);
const propOrNA = (user, prop) => {
return user[prop] || 'N/A';
};
const timestampOrNA = (user, prop, format) => {
let ts = user[prop];
return ts ? moment(ts).format(format) : 'N/A';
};
const makeAccountStatus = status => {
return StatusNames[status] || 'N/A';
};
const table = new Table();
userList.forEach(user => {
console.info(`${user.userId}: ${user.userName}`);
table.cell('ID', user.userId);
table.cell('Username', user.userName);
table.cell('Real Name', user[UserProps.RealName]);
table.cell(
'Status',
makeAccountStatus(user[UserProps.AccountStatus])
);
table.cell(
'Created',
timestampOrNA(user, UserProps.AccountCreated, 'YYYY-MM-DD')
);
table.cell(
'Last Login',
timestampOrNA(user, UserProps.LastLoginTs, 'YYYY-MM-DD HH::mm')
);
table.cell('Logins', propOrNA(user, UserProps.LoginCount));
table.newRow();
});
console.info(table.toString());
return callback(null);
},
],

View File

@ -19,14 +19,31 @@ const packageJson = require('../package.json');
const os = require('os');
const _ = require('lodash');
const moment = require('moment');
const async = require('async');
exports.getPredefinedMCIValue = getPredefinedMCIValue;
exports.getPredefinedMCIFormatObject = getPredefinedMCIFormatObject;
exports.init = init;
function init(cb) {
setNextRandomRumor(cb);
async.series(
[
callback => {
return setNextRandomRumor(callback);
},
callback => {
// by fetching a memory or load we'll force a refresh now
StatLog.getSystemStat(SysProps.SystemMemoryStats);
return callback(null);
},
],
err => {
return cb(err);
}
);
}
// :TODO: move this to stat_log.js like system memory is handled
function setNextRandomRumor(cb) {
StatLog.getSystemLogEntries(
SysLogKeys.UserAddedRumorz,
@ -65,10 +82,6 @@ function userStatAsCountString(client, statName, defaultValue) {
return toNumberWithCommas(value);
}
function sysStatAsString(statName, defaultValue) {
return (StatLog.getSystemStat(statName) || defaultValue).toLocaleString();
}
const PREDEFINED_MCI_GENERATORS = {
//
// Board
@ -104,7 +117,6 @@ const PREDEFINED_MCI_GENERATORS = {
SE: function opEmail() {
return StatLog.getSystemStat(SysProps.SysOpEmailAddress);
},
// :TODO: op age, web, ?????
//
// Current user / session
@ -162,8 +174,8 @@ const PREDEFINED_MCI_GENERATORS = {
return client.node.toString();
},
IP: function clientIpAddress(client) {
return client.remoteAddress.replace(/^::ffff:/, '');
}, // convert any :ffff: IPv4's to 32bit version
return client.friendlyRemoteAddress();
},
ST: function serverName(client) {
return client.session.serverName;
},
@ -272,6 +284,23 @@ const PREDEFINED_MCI_GENERATORS = {
const minutes = client.user.properties[UserProps.MinutesOnlineTotalCount] || 0;
return moment.duration(minutes, 'minutes').humanize();
},
NM: function userNewMessagesAddressedToCount(client) {
return StatLog.getUserStatNumByClient(
client,
UserProps.NewAddressedToMessageCount
);
},
NP: function userNewPrivateMailCount(client) {
return StatLog.getUserStatNumByClient(client, UserProps.NewPrivateMailCount);
},
IA: function userStatusAvailableIndicator(client) {
const indicators = client.currentTheme.helpers.getStatusAvailIndicators();
return client.user.isAvailable() ? indicators[0] || 'Y' : indicators[1] || 'N';
},
IV: function userStatusVisibleIndicator(client) {
const indicators = client.currentTheme.helpers.getStatusVisibleIndicators();
return client.user.isVisible() ? indicators[0] || 'Y' : indicators[1] || 'N';
},
//
// Date/Time
@ -318,15 +347,36 @@ const PREDEFINED_MCI_GENERATORS = {
.trim();
},
// :TODO: MCI for core count, e.g. os.cpus().length
// :TODO: cpu load average (over N seconds): http://stackoverflow.com/questions/9565912/convert-the-output-of-os-cpus-in-node-js-to-percentage
MB: function totalMemoryBytes() {
const stats = StatLog.getSystemStat(SysProps.SystemMemoryStats) || {
totalBytes: 0,
};
return formatByteSize(stats.totalBytes, true); // true=withAbbr
},
MF: function totalMemoryFreeBytes() {
const stats = StatLog.getSystemStat(SysProps.SystemMemoryStats) || {
freeBytes: 0,
};
return formatByteSize(stats.freeBytes, true); // true=withAbbr
},
LA: function systemLoadAverage() {
const stats = StatLog.getSystemStat(SysProps.SystemLoadStats) || { average: 0.0 };
return stats.average.toLocaleString();
},
CL: function systemCurrentLoad() {
const stats = StatLog.getSystemStat(SysProps.SystemLoadStats) || { current: 0 };
return `${stats.current}%`;
},
UU: function systemUptime() {
return moment.duration(process.uptime(), 'seconds').humanize();
},
NV: function nodeVersion() {
return process.version;
},
AN: function activeNodes() {
return clientConnections.getActiveConnections().length.toString();
return clientConnections
.getActiveConnections(clientConnections.UserVisibleConnections)
.length.toString();
},
TC: function totalCalls() {
@ -336,6 +386,19 @@ const PREDEFINED_MCI_GENERATORS = {
return StatLog.getSystemStat(SysProps.LoginsToday).toLocaleString();
},
PI: function processBytesIngress() {
const stats = StatLog.getSystemStat(SysProps.ProcessTrafficStats) || {
ingress: 0,
};
return stats.ingress.toLocaleString();
},
PE: function processBytesEgress() {
const stats = StatLog.getSystemStat(SysProps.ProcessTrafficStats) || {
egress: 0,
};
return stats.ingress.toLocaleString();
},
RR: function randomRumor() {
// start the process of picking another random one
setNextRandomRumor();
@ -346,17 +409,15 @@ const PREDEFINED_MCI_GENERATORS = {
//
// System File Base, Up/Download Info
//
// :TODO: DD - Today's # of downloads (iNiQUiTY)
//
SD: function systemNumDownloads() {
return sysStatAsString(SysProps.FileDlTotalCount, 0);
return StatLog.getFriendlySystemStat(SysProps.FileDlTotalCount, 0);
},
SO: function systemByteDownload() {
const byteSize = StatLog.getSystemStatNum(SysProps.FileDlTotalBytes);
return formatByteSize(byteSize, true); // true=withAbbr
},
SU: function systemNumUploads() {
return sysStatAsString(SysProps.FileUlTotalCount, 0);
return StatLog.getFriendlySystemStat(SysProps.FileUlTotalCount, 0);
},
SP: function systemByteUpload() {
const byteSize = StatLog.getSystemStatNum(SysProps.FileUlTotalBytes);
@ -373,18 +434,59 @@ const PREDEFINED_MCI_GENERATORS = {
},
PT: function messagesPostedToday() {
// Obv/2
return sysStatAsString(SysProps.MessagesToday, 0);
return StatLog.getFriendlySystemStat(SysProps.MessagesToday, 0);
},
TP: function totalMessagesOnSystem() {
// Obv/2
return sysStatAsString(SysProps.MessageTotalCount, 0);
return StatLog.getFriendlySystemStat(SysProps.MessageTotalCount, 0);
},
FT: function totalUploadsToday() {
// Obv/2
return StatLog.getFriendlySystemStat(SysProps.FileUlTodayCount, 0);
},
FB: function totalUploadBytesToday() {
const byteSize = StatLog.getSystemStatNum(SysProps.FileUlTodayBytes);
return formatByteSize(byteSize, true); // true=withAbbr
},
DD: function totalDownloadsToday() {
// iNiQUiTY
return StatLog.getFriendlySystemStat(SysProps.FileDlTodayCount, 0);
},
DB: function totalDownloadBytesToday() {
const byteSize = StatLog.getSystemStatNum(SysProps.FileDlTodayBytes);
return formatByteSize(byteSize, true); // true=withAbbr
},
NT: function totalNewUsersToday() {
// Obv/2
return StatLog.getSystemStatNum(SysProps.NewUsersTodayCount);
},
// :TODO: NT - New users today (Obv/2)
// :TODO: FT - Files uploaded/added *today* (Obv/2)
// :TODO: DD - Files downloaded *today* (iNiQUiTY)
// :TODO: LC - name of last caller to system (Obv/2)
// :TODO: TZ - Average *system* post/call ratio (iNiQUiTY)
// :TODO: ?? - Total users on system
TU: function totalSystemUsers() {
return StatLog.getSystemStatNum(SysProps.TotalUserCount) || 1;
},
LC: function lastCallerUserName() {
// Obv/2
const lastLogin = StatLog.getSystemStat(SysProps.LastLogin) || {};
return lastLogin.userName || 'N/A';
},
LD: function lastCallerDate(client) {
const lastLogin = StatLog.getSystemStat(SysProps.LastLogin) || {};
if (!lastLogin.timestamp) {
return 'N/A';
}
return lastLogin.timestamp.format(client.currentTheme.helpers.getDateFormat());
},
LT: function lastCallerTime(client) {
const lastLogin = StatLog.getSystemStat(SysProps.LastLogin) || {};
if (!lastLogin.timestamp) {
return 'N/A';
}
return lastLogin.timestamp.format(client.currentTheme.helpers.getTimeFormat());
},
//
// Special handling for XY
@ -424,10 +526,28 @@ function getPredefinedMCIValue(client, code, extra) {
} catch (e) {
Log.error(
{ code: code, exception: e.message },
'Exception caught generating predefined MCI value'
`Failed generating predefined MCI value (${code})`
);
}
return value;
}
}
function getPredefinedMCIFormatObject(client, text) {
const re = /\{([A-Z]{2})(?:[!:][^}]+)?\}/g;
let m;
const formatObj = {};
while ((m = re.exec(text))) {
const v = getPredefinedMCIValue(client, m[1]);
if (v) {
if (!isNaN(v)) {
formatObj[m[1]] = parseInt(v);
} else {
formatObj[m[1]] = v;
}
}
}
return _.isEmpty(formatObj) ? null : formatObj;
}

View File

@ -172,7 +172,7 @@ exports.getModule = class RumorzModule extends MenuModule {
StatLog.getSystemLogEntries(
SystemLogKeys.UserAddedRumorz,
StatLog.Order.Timestamp,
StatLog.Order.TimestampDesc,
(err, entries) => {
return callback(err, entriesView, entries);
}

View File

@ -1129,7 +1129,10 @@ function FTNMessageScanTossModule() {
],
err => {
if (err) {
Log.warn({ error: err.message }, 'Error exporting message');
Log.warn(
{ error: err.message },
`Error exporting message: ${err.message}`
);
}
return nextMessageOrUuid(null);
}
@ -1600,6 +1603,7 @@ function FTNMessageScanTossModule() {
const packetOpts = { keepTearAndOrigin: false }; // needed so we can calc message UUID without these; we'll add later
let importStats = {
packetPath,
areaSuccess: {}, // areaTag->count
areaFail: {}, // areaTag->count
otherFail: 0,
@ -1639,10 +1643,10 @@ function FTNMessageScanTossModule() {
//
// No local area configured for this import
//
// :TODO: Handle the "catch all" area bucket case if configured
// :TODO: Handle the "catch all" area bucket case if configured -> email with area info/etc.? catchAll: enabled, areaTag, prefixMsg
Log.warn(
{ areaTag: areaTag },
'No local area configured for this packet file!'
`No local message area for "${areaTag}"`
);
// bump generic failure
@ -1675,9 +1679,7 @@ function FTNMessageScanTossModule() {
self.appendTearAndOrigin(message);
const importConfig = {
localAreaTag: localAreaTag,
};
const importConfig = { localAreaTag };
self.importMailToArea(importConfig, packetHeader, message, err => {
if (err) {
@ -1699,7 +1701,7 @@ function FTNMessageScanTossModule() {
uuid: message.messageUuid,
MSGID: msgId,
},
'Not importing non-unique message'
`Not importing non-unique message "${message.subject}" to ${localAreaTag}`
);
return next(null);
@ -1718,15 +1720,34 @@ function FTNMessageScanTossModule() {
//
// try to produce something helpful in the log
//
const finalStats = Object.assign(importStats, { packetPath: packetPath });
if (err || Object.keys(finalStats.areaFail).length > 0) {
if (err) {
Object.assign(finalStats, { error: err.message });
}
const makeCount = obj => {
return obj
? _.reduce(
obj,
(sum, c) => {
return sum + c;
},
0
)
: 0;
};
Log.warn(finalStats, 'Import completed with error(s)');
const totalFail = makeCount(importStats.areaFail) + importStats.otherFail;
const packetFileName = paths.basename(packetPath);
if (err || totalFail > 0) {
if (err) {
Object.assign(importStats, { error: err.message });
}
Log.warn(
importStats,
`Packet ${packetFileName} import reported ${totalFail} error(s)`
);
} else {
Log.info(finalStats, 'Import complete');
const totalSuccess = makeCount(importStats.areaSuccess);
Log.info(
importStats,
`Packet ${packetFileName} imported with ${totalSuccess} new message(s)`
);
}
cb(err);
@ -1816,7 +1837,9 @@ function FTNMessageScanTossModule() {
path: paths.join(importDir, packetFile),
error: err.toString(),
},
'Failed to import packet file'
`Failed to import packet file "${paths.basename(
packetFile
)}"`
);
rejects.push(packetFile);
@ -2360,7 +2383,9 @@ function FTNMessageScanTossModule() {
reason: err.reason,
tic: ticFileInfo.filePath,
},
'Failed to import/update TIC'
`Failed to import/update TIC for "${paths.basename(
ticFileInfo.filePath
)}"`
);
} else {
Log.info(
@ -2369,7 +2394,9 @@ function FTNMessageScanTossModule() {
file: ticFileInfo.filePath,
area: localInfo.areaTag,
},
'TIC imported successfully'
`TIC imported "${paths.basename(ticFileInfo.filePath)}" -> ${
localInfo.areaTag
}`
);
}
return cb(err);
@ -2738,6 +2765,7 @@ FTNMessageScanTossModule.prototype.startup = function (cb) {
const importSchedule = this.parseScheduleString(
this.moduleConfig.schedule.import
);
if (importSchedule) {
Log.debug(
{
@ -2766,14 +2794,17 @@ FTNMessageScanTossModule.prototype.startup = function (cb) {
glob: `**/${paths.basename(importSchedule.watchFile)}`,
});
const makeImportMsg = (e, path) => {
return `Import/toss due to @watch[${e}] "${paths.basename(
path
)}"`;
};
['change', 'add', 'delete'].forEach(event => {
watcher.on(event, (fileName, fileRoot) => {
const eventPath = paths.join(fileRoot, fileName);
if (
paths.join(fileRoot, fileName) ===
importSchedule.watchFile
) {
tryImportNow('Performing import/toss due to @watch', {
if (eventPath === importSchedule.watchFile) {
tryImportNow(makeImportMsg(event, eventPath), {
eventPath,
event,
});
@ -2785,12 +2816,16 @@ FTNMessageScanTossModule.prototype.startup = function (cb) {
// If the watch file already exists, kick off now
// https://github.com/NuSkooler/enigma-bbs/issues/122
//
fse.exists(importSchedule.watchFile, exists => {
if (exists) {
tryImportNow('Performing import/toss due to @watch', {
eventPath: importSchedule.watchFile,
event: 'initial exists',
});
fse.access(importSchedule.watchFile, fse.constants.R_OK, err => {
if (!err) {
// exists and we can read
tryImportNow(
makeImportMsg('exists', importSchedule.watchFile),
{
eventPath: importSchedule.watchFile,
event: 'exists',
}
);
}
});
}

View File

@ -219,7 +219,8 @@ exports.getModule = class MrcModule extends ServerModule {
connectedSockets.forEach(client => {
if (
message.to_user == '' ||
message.to_user == client.username ||
// Fix PrivMSG delivery on case mismatch
message.to_user.toUpperCase() == client.username.toUpperCase() ||
message.to_user == 'CLIENT' ||
message.from_user == client.username ||
message.to_user == 'NOTME'

View File

@ -10,11 +10,13 @@ const {
splitTextAtTerms,
isAnsi,
stripAnsiControlCodes,
wildcardMatch,
} = require('../../string_util.js');
const {
getMessageConferenceByTag,
getMessageAreaByTag,
getMessageListForArea,
getAvailableMessageAreasByConfTag,
} = require('../../message_area.js');
const { sortAreasOrConfs } = require('../../conf_area_util.js');
const AnsiPrep = require('../../ansi_prep.js');
@ -122,7 +124,7 @@ exports.getModule = class GopherModule extends ServerModule {
if (isNaN(port)) {
this.log.warn(
{ port: config.contentServers.gopher.port, server: ModuleInfo.name },
'Invalid port'
'Invalid Gopher port'
);
return cb(
Errors.Invalid(`Invalid port: ${config.contentServers.gopher.port}`)
@ -243,14 +245,52 @@ exports.getModule = class GopherModule extends ServerModule {
return cb('Not found');
}
isAreaAndConfExposed(confTag, areaTag) {
const conf = _.get(Config(), [
_getConfigForConferenceTag(confTag) {
const sysConfig = Config();
let config = _.get(sysConfig, [
'contentServers',
'gopher',
'messageConferences',
'exposedConfAreas',
confTag,
]);
return Array.isArray(conf) && conf.includes(areaTag);
if (config) {
return [config, false]; // new
}
return [
_.get(sysConfig, ['contentServers', 'gopher', 'messageConferences', confTag]),
true,
];
}
isAreaAndConfExposed(confTag, areaTag) {
const [confConfig, isLegacy] = this._getConfigForConferenceTag(confTag);
if (isLegacy) {
return Array.isArray(confConfig) && confConfig.includes(areaTag);
}
if (!Array.isArray(confConfig.include)) {
return false;
}
let exposed = false;
for (let rule of confConfig.include) {
if (wildcardMatch(areaTag, rule)) {
exposed = true;
break;
}
}
// may still be excluded
for (let rule of confConfig.exclude || []) {
if (wildcardMatch(areaTag, rule)) {
exposed = false;
break;
}
}
return exposed;
}
prepareMessageBody(body, cb) {
@ -304,7 +344,7 @@ exports.getModule = class GopherModule extends ServerModule {
}
messageAreaGenerator(selectorMatch, cb) {
this.log.debug({ selector: selectorMatch[0] }, 'Serving message area content');
this.log.trace({ selector: selectorMatch[0] }, 'Message area request');
//
// Selector should be:
// /msgarea - list confs
@ -314,44 +354,267 @@ exports.getModule = class GopherModule extends ServerModule {
// /msgarea/conftag/areatag/<UUID>_raw - full message as text + headers
//
if (selectorMatch[3] || selectorMatch[4]) {
// message selector - display message
// message
//const raw = selectorMatch[4] ? true : false;
// :TODO: support 'raw'
const msgUuid = selectorMatch[3].replace(/\r\n|\//g, '');
const confTag = selectorMatch[1].substr(1).split('/')[0];
const areaTag = selectorMatch[2].replace(/\r\n|\//g, '');
const message = new Message();
return this._displayMessage(selectorMatch, msgUuid, confTag, areaTag, cb);
} else if (selectorMatch[2]) {
// conf/area selector -- list messages in area
const confTag = selectorMatch[1].substr(1).split('/')[0];
const areaTag = selectorMatch[2].replace(/\r\n|\//g, '');
const area = getMessageAreaByTag(areaTag);
return this._listMessagesInArea(selectorMatch, confTag, areaTag, area, cb);
} else if (selectorMatch[1]) {
// message conference selector -- list areas in this conference
const confTag = selectorMatch[1].replace(/\r\n|\//g, '');
return this._listExposedMessageConferenceAreas(selectorMatch, confTag, cb);
} else {
// message area base selector -- list exposed message conferences
return this._listExposedMessageConferences(cb);
}
}
return message.load({ uuid: msgUuid }, err => {
if (err) {
this.log.debug(
{ uuid: msgUuid },
'Attempted access to non-existent message UUID!'
);
return this.notFoundGenerator(selectorMatch, cb);
_makeAvailableMessageConferencesResponse(messageConferences, cb) {
sortAreasOrConfs(messageConferences);
const response = [
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, 'Available Message Conferences'),
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, ''),
...messageConferences.map(conf =>
this.makeItem(
ItemTypes.SubMenu,
`${conf.name} ${conf.desc ? '- ' + conf.desc : ''}`,
`/msgarea/${conf.confTag}`
)
),
].join('');
this.log.debug('Gopher serving message conference list');
return cb(response);
}
_exposedMessageConferenceTags(obj) {
return Object.keys(obj || {})
.map(confTag =>
Object.assign({ confTag }, getMessageConferenceByTag(confTag))
)
.filter(conf => conf); // remove any baddies
}
_noExposedMessageConferences(cb) {
return cb(
this.makeItem(ItemTypes.InfoMessage, 'No message conferences available')
);
}
// newer format
_listExposedMessageConferences(cb) {
let exposedConfs = _.get(Config(), 'contentServers.gopher.exposedConfAreas');
if (!_.isObject(exposedConfs)) {
return this._listExposedMessageConferencesLegacy(cb);
}
exposedConfs = this._exposedMessageConferenceTags(exposedConfs);
if (0 === exposedConfs.length) {
return this._noExposedMessageConferences(cb);
}
return this._makeAvailableMessageConferencesResponse(exposedConfs, cb);
}
// older deprecated format
_listExposedMessageConferencesLegacy(cb) {
const exposedConfs = this._exposedMessageConferenceTags(
_.get(Config(), 'contentServers.gopher.messageConferences')
);
if (0 === exposedConfs.length) {
return this._noExposedMessageConferences(cb);
}
return this._makeAvailableMessageConferencesResponse(exposedConfs, cb);
}
_makeAvailableMessageAreasResponse(exposedConf, exposedAreas, cb) {
// ensure nothing private is present
exposedAreas = exposedAreas.filter(
area => area && !Message.isPrivateAreaTag(area.areaTag)
);
if (0 === exposedAreas.length) {
return cb(this.makeItem(ItemTypes.InfoMessage, 'No message areas available'));
}
sortAreasOrConfs(exposedAreas);
const response = [
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, `Message areas in ${exposedConf.name}`),
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
...exposedAreas.map(area =>
this.makeItem(
ItemTypes.SubMenu,
`${area.name} ${area.desc ? '- ' + area.desc : ''}`,
`/msgarea/${exposedConf.confTag}/${area.areaTag}`
)
),
].join('');
this.log.debug(
{ confTag: exposedConf.confTag },
'Gopher serving message area list'
);
return cb(response);
}
_listExposedMessageConferenceAreas(selectorMatch, confTag, cb) {
//
// New system -- exposedConfAreas:
// We have a required array |include| of area tags that may
// contain wildcards and a _optional_ |exclude| array that
// overrides any includes
//
// Deprecated -- messageConferences:
// The key should point to an array of area tags
//
const [confConfig, isLegacy] = this._getConfigForConferenceTag(confTag);
const messageConference = getMessageConferenceByTag(confTag); // we need the actual conf!
if (!messageConference) {
return this.notFoundGenerator(selectorMatch, cb);
}
let areas;
if (isLegacy) {
areas = (confConfig || []).map(areaTag =>
Object.assign({ areaTag }, getMessageAreaByTag(areaTag))
);
} else {
// new system is more complex here, but nicer for the +op to manage
areas = getAvailableMessageAreasByConfTag(confTag);
if (!Array.isArray(confConfig.include)) {
return cb(
this.makeItem(ItemTypes.InfoMessage, 'No message areas available')
);
}
// filters |areas| down to what |includes| matches
areas = _.filter(areas, (area, areaTag) => {
for (let rule of confConfig.include) {
if (wildcardMatch(areaTag, rule)) {
area.areaTag = areaTag;
return true;
}
}
return false;
});
if (
message.areaTag !== areaTag ||
!this.isAreaAndConfExposed(confTag, areaTag)
) {
this.log.warn(
{ areaTag },
'Attempted access to non-exposed conference and/or area!'
// now filter out any excludes, if present
if (Array.isArray(confConfig.exclude)) {
areas = _.filter(areas, area => {
for (let rule of confConfig.exclude) {
if (wildcardMatch(area.areaTag, rule)) {
return false;
}
}
return true;
});
}
}
return this._makeAvailableMessageAreasResponse(messageConference, areas, cb);
}
_listMessagesInArea(selectorMatch, confTag, areaTag, area, cb) {
if (Message.isPrivateAreaTag(areaTag)) {
this.log.warn({ areaTag }, `Gopher attempted access to private "${areaTag}"`);
return cb(this.makeItem(ItemTypes.InfoMessage, 'Area is private'));
}
if (!area || !this.isAreaAndConfExposed(confTag, areaTag)) {
this.log.warn(
{ confTag, areaTag },
`Gopher attempted access to non-exposed "${confTag}"/"${areaTag}"`
);
return this.notFoundGenerator(selectorMatch, cb);
}
const filter = {
resultType: 'messageList',
sort: 'messageId',
order: 'descending', // we want newest messages first for Gopher
};
return getMessageListForArea(null, areaTag, filter, (err, msgList) => {
const response = [
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, `Messages in ${area.name}`),
this.makeItem(ItemTypes.InfoMessage, '(newest first)'),
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
...msgList.map(msg => {
let m;
try {
m = moment(msg.modTimestamp);
} catch (e) {
this.log.warn(
`Error parsing "${msg.modTimestamp}"; expected timestamp: ${e.message}`
);
m = moment();
}
return this.makeItem(
ItemTypes.TextFile,
`${m.format('YYYY-MM-DD hh:mma')}: ${this.shortenSubject(
msg.subject
)} (${msg.fromUserName} to ${msg.toUserName})`,
`/msgarea/${confTag}/${areaTag}/${msg.messageUuid}`
);
return this.notFoundGenerator(selectorMatch, cb);
}
}),
].join('');
if (Message.isPrivateAreaTag(areaTag)) {
this.log.warn(
{ areaTag },
'Attempted access to message in private area!'
);
return this.notFoundGenerator(selectorMatch, cb);
}
this.log.debug({ confTag, areaTag }, 'Gopher serving message list');
return cb(response);
});
}
this.prepareMessageBody(message.message, msgBody => {
const response = `${'-'.repeat(70)}
_displayMessage(selectorMatch, msgUuid, confTag, areaTag, cb) {
const message = new Message();
return message.load({ uuid: msgUuid }, err => {
if (err) {
this.log.debug(
{ uuid: msgUuid },
'Attempted access to non-existent message UUID!'
);
return this.notFoundGenerator(selectorMatch, cb);
}
if (
message.areaTag !== areaTag ||
!this.isAreaAndConfExposed(confTag, areaTag)
) {
this.log.warn(
{ areaTag },
`Gopher attempted access to non-exposed "${confTag}"/"${areaTag}"`
);
return this.notFoundGenerator(selectorMatch, cb);
}
if (Message.isPrivateAreaTag(areaTag)) {
this.log.warn(
{ areaTag },
`Gopher attempted access to message in private "${areaTag}"`
);
return this.notFoundGenerator(selectorMatch, cb);
}
this.prepareMessageBody(message.message, msgBody => {
const response = `${'-'.repeat(70)}
To : ${message.toUserName}
From : ${message.fromUserName}
When : ${moment(message.modTimestamp).format('dddd, MMMM Do YYYY, h:mm:ss a (UTCZ)')}
@ -359,137 +622,17 @@ Subject: ${message.subject}
ID : ${message.messageUuid} (${message.messageId})
${'-'.repeat(70)}
${msgBody}
`;
return cb(response);
});
});
} else if (selectorMatch[2]) {
// list messages in area
const confTag = selectorMatch[1].substr(1).split('/')[0];
const areaTag = selectorMatch[2].replace(/\r\n|\//g, '');
const area = getMessageAreaByTag(areaTag);
if (Message.isPrivateAreaTag(areaTag)) {
this.log.warn({ areaTag }, 'Attempted access to private area!');
return cb(this.makeItem(ItemTypes.InfoMessage, 'Area is private'));
}
if (!area || !this.isAreaAndConfExposed(confTag, areaTag)) {
this.log.warn(
{ confTag, areaTag },
'Attempted access to non-exposed conference and/or area!'
`;
this.log.debug(
{
confTag,
areaTag,
uuid: message.messageUuid,
},
`Gopher serving message "${message.subject}"`
);
return this.notFoundGenerator(selectorMatch, cb);
}
const filter = {
resultType: 'messageList',
sort: 'messageId',
order: 'descending', // we want newest messages first for Gopher
};
return getMessageListForArea(null, areaTag, filter, (err, msgList) => {
const response = [
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, `Messages in ${area.name}`),
this.makeItem(ItemTypes.InfoMessage, '(newest first)'),
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
...msgList.map(msg =>
this.makeItem(
ItemTypes.TextFile,
`${moment(msg.modTimestamp).format(
'YYYY-MM-DD hh:mma'
)}: ${this.shortenSubject(msg.subject)} (${
msg.fromUserName
} to ${msg.toUserName})`,
`/msgarea/${confTag}/${areaTag}/${msg.messageUuid}`
)
),
].join('');
return cb(response);
});
} else if (selectorMatch[1]) {
// list areas in conf
const sysConfig = Config();
const confTag = selectorMatch[1].replace(/\r\n|\//g, '');
const conf =
_.get(sysConfig, [
'contentServers',
'gopher',
'messageConferences',
confTag,
]) && getMessageConferenceByTag(confTag);
if (!conf) {
return this.notFoundGenerator(selectorMatch, cb);
}
const areas = _.get(
sysConfig,
['contentServers', 'gopher', 'messageConferences', confTag],
{}
)
.map(areaTag => Object.assign({ areaTag }, getMessageAreaByTag(areaTag)))
.filter(area => area && !Message.isPrivateAreaTag(area.areaTag));
if (0 === areas.length) {
return cb(
this.makeItem(ItemTypes.InfoMessage, 'No message areas available')
);
}
sortAreasOrConfs(areas);
const response = [
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, `Message areas in ${conf.name}`),
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
...areas.map(area =>
this.makeItem(
ItemTypes.SubMenu,
`${area.name} ${area.desc ? '- ' + area.desc : ''}`,
`/msgarea/${confTag}/${area.areaTag}`
)
),
].join('');
return cb(response);
} else {
// message area base (list confs)
const confs = Object.keys(
_.get(Config(), 'contentServers.gopher.messageConferences', {})
)
.map(confTag =>
Object.assign({ confTag }, getMessageConferenceByTag(confTag))
)
.filter(conf => conf); // remove any baddies
if (0 === confs.length) {
return cb(
this.makeItem(
ItemTypes.InfoMessage,
'No message conferences available'
)
);
}
sortAreasOrConfs(confs);
const response = [
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, 'Available Message Conferences'),
this.makeItem(ItemTypes.InfoMessage, '-'.repeat(70)),
this.makeItem(ItemTypes.InfoMessage, ''),
...confs.map(conf =>
this.makeItem(
ItemTypes.SubMenu,
`${conf.name} ${conf.desc ? '- ' + conf.desc : ''}`,
`/msgarea/${conf.confTag}`
)
),
].join('');
return cb(response);
}
});
}
};

View File

@ -9,6 +9,7 @@ const { getTransactionDatabase, getModDatabasePath } = require('../../database.j
const {
getMessageAreaByTag,
getMessageConferenceByTag,
persistMessage,
} = require('../../message_area.js');
const User = require('../../user.js');
const Errors = require('../../enig_error.js').Errors;
@ -21,6 +22,7 @@ const {
} = require('../../string_util.js');
const AnsiPrep = require('../../ansi_prep.js');
const { stripMciColorCodes } = require('../../color_codes.js');
const ACS = require('../../acs');
// deps
const NNTPServerBase = require('nntp-server');
@ -111,6 +113,38 @@ class NNTPDatabase {
let nntpDatabase;
const AuthCommands = 'POST';
// these aren't exported by the NNTP module, unfortunantely
const Responses = {
ArticlePostedOk: '240 article posted ok',
SendArticle: '340 send article to be posted',
PostingNotAllowed: '440 posting not allowed',
ArticlePostFailed: '441 posting failed',
AuthRequired: '480 authentication required',
};
const PostCommand = {
head: 'POST',
validate: /^POST$/i,
run(session, cmd) {
if (!session.authenticated) {
session.receivingPostArticle = false; // ensure reset
return Responses.AuthRequired;
}
session.receivingPostArticle = true;
return Responses.SendArticle;
},
capability(session, report) {
report.push('POST');
},
};
class NNTPServer extends NNTPServerBase {
constructor(options, serverName) {
super(options);
@ -125,14 +159,26 @@ class NNTPServer extends NNTPServerBase {
}
_needAuth(session, command) {
if (AuthCommands.includes(command)) {
return !session.authenticated && !session.authUser;
}
return super._needAuth(session, command);
}
_address(session) {
const addr = session.in_stream.remoteAddress;
return addr ? addr.replace(/^::ffff:/, '').replace(/^::1$/, 'localhost') : 'N/A';
}
_authenticate(session) {
const username = session.authinfo_user;
const password = session.authinfo_pass;
this.log.trace({ username }, 'Authentication request');
this.log.debug(
{ username, ip: this._address(session) },
`NNTP authentication request for "${username}"`
);
return new Promise(resolve => {
const user = new User();
@ -140,17 +186,19 @@ class NNTPServer extends NNTPServerBase {
{ type: User.AuthFactor1Types.Password, username, password },
err => {
if (err) {
// :TODO: Log IP address
this.log.debug(
{ username, reason: err.message },
'Authentication failure'
this.log.warn(
{ username, reason: err.message, ip: this._address(session) },
`NNTP authentication failure for "${username}"`
);
return resolve(false);
}
session.authUser = user;
this.log.debug({ username }, 'User authenticated successfully');
this.log.info(
{ username, ip: this._address(session) },
`NTTP authentication success for "${username}"`
);
return resolve(true);
}
);
@ -232,6 +280,7 @@ class NNTPServer extends NNTPServerBase {
message.nntpHeaders = {
From: this.getJAMStyleFrom(message, fromName),
'X-Comment-To': toName,
To: toName, // JAM-ish
Newsgroups: session.group.name,
Subject: message.subject,
Date: this.getMessageDate(message),
@ -343,7 +392,7 @@ class NNTPServer extends NNTPServerBase {
messageUuid = msg && msg.messageUuid;
} else {
// <Message-ID> request
[, messageUuid] = this.getMessageIdentifierParts(messageId);
[, messageUuid] = NNTPServer.getMessageIdentifierParts(messageId);
}
if (!_.isString(messageUuid)) {
@ -394,7 +443,7 @@ class NNTPServer extends NNTPServerBase {
)
) {
this.log.info(
{ messageUuid, messageId },
{ messageUuid, messageId, ip: this._address(session) },
'Access denied for message'
);
return resolve(null);
@ -592,15 +641,33 @@ class NNTPServer extends NNTPServerBase {
if (!conf) {
return false;
}
// :TODO: validate ACS
const area = getMessageAreaByTag(areaTag, confTag);
if (!area) {
return false;
}
// :TODO: validate ACS
return false;
const acs = new ACS({ client: null, user: session.authUser });
return acs.hasMessageConfRead(conf) && acs.hasMessageAreaRead(area);
}
static hasConfAndAreaWriteAccess(session, confTag, areaTag) {
if (Message.isPrivateAreaTag(areaTag)) {
return false;
}
const conf = getMessageConferenceByTag(confTag);
if (!conf) {
return false;
}
const area = getMessageAreaByTag(areaTag, confTag);
if (!area) {
return false;
}
const acs = new ACS({ client: null, user: session.authUser });
return acs.hasMessageConfWrite(conf) && acs.hasMessageAreaWrite(area);
}
getGroup(session, groupName, cb) {
@ -861,7 +928,7 @@ class NNTPServer extends NNTPServerBase {
return this.makeMessageIdentifier(message.messageId, message.messageUuid);
}
getMessageIdentifierParts(messageId) {
static getMessageIdentifierParts(messageId) {
const m = messageId.match(
/<([0-9]+)\.([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})@enigma-bbs>/
);
@ -919,6 +986,240 @@ class NNTPServer extends NNTPServerBase {
areaTag
).replace(/\./g, '_')}`;
}
static _importMessage(session, articleLines, cb) {
const tidyFrom = f => {
if (f) {
// remove quotes around name, if present
let m = /^"([^"]+)" <([^>]+)>$/.exec(f);
if (m && m[1] && m[2]) {
f = `${m[1]} <${m[2]}>`;
}
}
return f;
};
asyncWaterfall(
[
callback => {
return NNTPServer._parseArticleLines(articleLines, callback);
},
(parsed, callback) => {
// gather some initially important bits
const subject = parsed.header.get('subject');
const to = parsed.header.get('to') || parsed.header.get('x-jam-to'); // non-standard, may be missing
const from = tidyFrom(
parsed.header.get('from') ||
parsed.header.get('sender') ||
parsed.header.get('x-jam-from')
);
const date = parsed.header.get('date'); // if not present we'll use 'now'
const newsgroups = parsed.header
.get('newsgroups')
.split(',')
.map(ng => {
const [confTag, areaTag] = ng.split('.');
return { confTag, areaTag };
});
// validate areaTag exists -- currently only a single area/post; no x-posts
// :TODO: look into x-posting
const area = getMessageAreaByTag(newsgroups[0].areaTag);
if (!area) {
return callback(
Errors.DoesNotExist(
`No area by tag "${newsgroups[0].areaTag}" exists!`
)
);
}
// NOTE: Not all ACS checks work with NNTP since we don't have a standard client;
// If a particular ACS requires a |client|, it will return false!
if (
!NNTPServer.hasConfAndAreaWriteAccess(
session,
area.confTag,
area.areaTag
)
) {
return callback(
Errors.AccessDenied(
`No ACS to ${area.confTag}/${area.areaTag}`
)
);
}
if (
!_.isString(subject) ||
!_.isString(from) ||
!Array.isArray(newsgroups)
) {
return callback(
Errors.Invalid('Missing one or more required article fields')
);
}
return callback(null, {
subject,
from,
date,
newsgroups,
to,
parsed,
});
},
(msgData, callback) => {
if (msgData.to) {
return callback(null, msgData);
}
//
// We don't have a 'to' field, try to derive if this is a
// response to a message. If not, just fall back 'All'
//
// 'References'
// - https://www.rfc-editor.org/rfc/rfc5536#section-3.2.10
// - https://www.rfc-editor.org/rfc/rfc5322.html
//
// 'In-Reply-To'
// - https://www.rfc-editor.org/rfc/rfc5322.html
//
// Both may contain 1:N, "optionally" separated by CFWS; by this
// point in the code, they should be space separated at most.
//
// Each entry is in msg-id format. That is:
// "<" id-left "@" id-right ">"
//
msgData.to = 'All'; // fallback
let parentMessageId = (
msgData.parsed.header.get('in-reply-to') ||
msgData.parsed.header.get('references') ||
''
).split(' ')[0];
if (parentMessageId) {
let [_, messageUuid] =
NNTPServer.getMessageIdentifierParts(parentMessageId);
if (messageUuid) {
const filter = {
resultType: 'messageList',
uuids: messageUuid,
limit: 1,
};
return Message.findMessages(filter, (err, messageList) => {
if (err) {
return callback(err);
}
// current message/article is a reply to this message:
msgData.to = messageList[0].fromUserName;
msgData.replyToMsgId = messageList[0].replyToMsgId; // may not be present
return callback(null, msgData);
});
}
}
return callback(null, msgData);
},
(msgData, callback) => {
const message = new Message({
toUserName: msgData.to,
fromUserName: msgData.from,
subject: msgData.subject,
replyToMsgId: msgData.replyToMsgId || 0,
modTimestamp: msgData.date, // moment can generally parse these
// :TODO: inspect Content-Type 'charset' if present & attempt to properly decode if not UTF-8
message: msgData.parsed.body.join('\n'),
areaTag: msgData.newsgroups[0].areaTag,
});
message.meta.System[Message.SystemMetaNames.ExternalFlavor] =
Message.AddressFlavor.NNTP;
// :TODO: investigate JAMNTTP clients/etc.
// :TODO: slurp in various X-XXXX kludges/etc. and bring them in
persistMessage(message, err => {
if (!err) {
Log.info(
`NNTP post to "${message.areaTag}" by "${session.authUser.username}": "${message.subject}"`
);
}
return callback(err);
});
},
],
err => {
return cb(err);
}
);
}
static _parseArticleLines(articleLines, cb) {
//
// Split articleLines into:
// - Header split into N:V pairs
// - Message Body lines
// -
const header = new Map();
const body = [];
let inHeader = true;
let currentHeaderName;
forEachSeries(
articleLines,
(line, nextLine) => {
if (inHeader) {
if (line === '.' || line === '') {
inHeader = false;
return nextLine(null);
}
const sep = line.indexOf(':');
if (sep < 1) {
// at least a single char name
// entries can split across lines -- they will be prefixed with a single space.
if (
currentHeaderName &&
(line.startsWith(' ') || line.startsWith('\t'))
) {
let v = header.get(currentHeaderName);
v += line
.replace(/^\t/, ' ') // if we're dealign with a legacy tab
.trimRight();
header.set(currentHeaderName, v);
return nextLine(null);
}
return nextLine(
Errors.Invalid(
`"${line}" is not a valid NNTP message header!`
)
);
}
currentHeaderName = line.slice(0, sep).trim().toLowerCase();
const value = line.slice(sep + 1).trim();
header.set(currentHeaderName, value);
return nextLine(null);
}
// body
if (line !== '.') {
// lines consisting of a single '.' are escaped to '..'
if (line.startsWith('..')) {
body.push(line.slice(1));
} else {
body.push(line);
}
}
return nextLine(null);
},
err => {
return cb(err, { header, body });
}
);
}
}
exports.getModule = class NNTPServerModule extends ServerModule {
@ -985,11 +1286,92 @@ exports.getModule = class NNTPServerModule extends ServerModule {
const config = Config();
// :TODO: nntp-server doesn't currently allow posting in a nice way, so this is kludged in. Fork+MR something cleaner at some point
class ProxySession extends NNTPServerBase.Session {
constructor(server, stream) {
super(server, stream);
this.articleLinesBuffer = [];
}
parse(data) {
if (this.receivingPostArticle) {
return this.receivePostArticleData(data);
}
super.parse(data);
}
receivePostArticleData(data) {
this.articleLinesBuffer.push(...data.split(/r?\n/));
const endOfPost = data.length === 1 && data[0] === '.';
if (endOfPost) {
this.receivingPostArticle = false;
// Command is not exported currently; maybe submit a MR to allow posting in a nicer way...
function Command(runner, articleLines, session) {
this.state = 0; // CMD_WAIT
this.cmd_line = 'POST';
this.resolved_value = null;
this.rejected_value = null;
this.run = runner;
this.articleLines = articleLines;
this.session = session;
}
this.pipeline.push(
new Command(
this._processarticleLinesBuffer,
this.articleLinesBuffer,
this
)
);
this.articleLinesBuffer = [];
this.tick();
}
}
_processarticleLinesBuffer() {
return new Promise(resolve => {
NNTPServer._importMessage(this.session, this.articleLines, err => {
if (err) {
this.rejected_value = err; // will be serialized and 403 sent back currently; not really ideal as we want ArticlePostFailed
// :TODO: tick() needs updated in session.js such that we can write back a proper code
this.state = 3; // CMD_REJECTED
Log.error(
{ error: err.message },
`NNTP post failed: ${err.message}`
);
} else {
this.resolved_value = Responses.ArticlePostedOk;
this.state = 2; // CMD_RESOLVED
}
return resolve();
});
});
}
static create(server, stream) {
return new ProxySession(server, stream);
}
}
const commonOptions = {
//requireAuth : true, // :TODO: re-enable!
// :TODO: override |session| - use our own debug to Bunyan, etc.
// :TODO: How to hook into debugging?!
};
if (true === _.get(config, 'contentServers.nntp.allowPosts')) {
// add in some additional supported commands
const commands = Object.assign({}, NNTPServerBase.commands, {
POST: PostCommand,
});
commonOptions.commands = commands;
commonOptions.session = ProxySession;
}
if (this.enableNntp) {
this.nntpServer = new NNTPServer(
// :TODO: according to docs: if connection is non-tls, but behind proxy (assuming TLS termination?!!) then set this to true

View File

@ -15,6 +15,7 @@ const fs = require('graceful-fs');
const paths = require('path');
const mimeTypes = require('mime-types');
const forEachSeries = require('async/forEachSeries');
const findSeries = require('async/findSeries');
const ModuleInfo = (exports.moduleInfo = {
name: 'Web',
@ -74,14 +75,6 @@ exports.getModule = class WebServerModule extends ServerModule {
this.enableHttps = config.contentServers.web.https.enabled || false;
this.routes = {};
if (this.isEnabled() && config.contentServers.web.staticRoot) {
this.addRoute({
method: 'GET',
path: '/static/.*$',
handler: this.routeStaticFile.bind(this),
});
}
}
buildUrl(pathAndQuery) {
@ -210,13 +203,21 @@ exports.getModule = class WebServerModule extends ServerModule {
}
routeRequest(req, resp) {
const route = _.find(this.routes, r => r.matchesRequest(req));
let route = _.find(this.routes, r => r.matchesRequest(req));
if (!route && '/' === req.url) {
return this.routeIndex(req, resp);
if (route) {
return route.handler(req, resp);
} else {
this.tryStaticRoute(req, resp, wasHandled => {
if (!wasHandled) {
this.tryRouteIndex(req, resp, wasHandled => {
if (!wasHandled) {
return this.fileNotFound(resp);
}
});
}
});
}
return route ? route.handler(req, resp) : this.accessDenied(resp);
}
respondWithError(resp, code, bodyText, title) {
@ -256,27 +257,57 @@ exports.getModule = class WebServerModule extends ServerModule {
return this.respondWithError(resp, 404, 'File not found.', 'File Not Found');
}
routeIndex(req, resp) {
const filePath = paths.join(Config().contentServers.web.staticRoot, 'index.html');
return this.returnStaticPage(filePath, resp);
tryRouteIndex(req, resp, cb) {
const tryFiles = Config().contentServers.web.tryFiles || [
'index.html',
'index.htm',
];
findSeries(
tryFiles,
(tryFile, nextTryFile) => {
const fileName = paths.join(
req.url.substr(req.url.lastIndexOf('/', 1)),
tryFile
);
const filePath = this.resolveStaticPath(fileName);
fs.stat(filePath, (err, stats) => {
if (err || !stats.isFile()) {
return nextTryFile(null, false);
}
const headers = {
'Content-Type':
mimeTypes.contentType(paths.basename(filePath)) ||
mimeTypes.contentType('.bin'),
'Content-Length': stats.size,
};
const readStream = fs.createReadStream(filePath);
resp.writeHead(200, headers);
readStream.pipe(resp);
return nextTryFile(null, true);
});
},
(_, wasHandled) => {
return cb(wasHandled);
}
);
}
routeStaticFile(req, resp) {
const fileName = req.url.substr(req.url.indexOf('/', 1));
tryStaticRoute(req, resp, cb) {
const fileName = req.url.substr(req.url.lastIndexOf('/', 1));
const filePath = this.resolveStaticPath(fileName);
return this.returnStaticPage(filePath, resp);
}
returnStaticPage(filePath, resp) {
const self = this;
if (!filePath) {
return this.fileNotFound(resp);
return cb(false);
}
fs.stat(filePath, (err, stats) => {
if (err || !stats.isFile()) {
return self.fileNotFound(resp);
return cb(false);
}
const headers = {
@ -288,7 +319,9 @@ exports.getModule = class WebServerModule extends ServerModule {
const readStream = fs.createReadStream(filePath);
resp.writeHead(200, headers);
return readStream.pipe(resp);
readStream.pipe(resp);
return cb(true);
});
}

View File

@ -4,7 +4,6 @@
// ENiGMA½
const MenuModule = require('./menu_module.js').MenuModule;
const Errors = require('../core/enig_error.js').Errors;
const ANSI = require('./ansi_term.js');
const Config = require('./config.js').get;
const { getMessageAreaByTag } = require('./message_area.js');
@ -21,6 +20,7 @@ exports.moduleInfo = {
exports.getModule = class ShowArtModule extends MenuModule {
constructor(options) {
super(options);
this.config = Object.assign({}, _.get(options, 'menuConfig.config'), {
extraArgs: options.extraArgs,
});

View File

@ -4,10 +4,15 @@
const sysDb = require('./database.js').dbs.system;
const { getISOTimestampString } = require('./database.js');
const Errors = require('./enig_error.js');
const SysProps = require('./system_property.js');
const UserProps = require('./user_property');
const Message = require('./message');
const { getActiveConnections, AllConnections } = require('./client_connections');
// deps
const _ = require('lodash');
const moment = require('moment');
const SysInfo = require('systeminformation');
/*
System Event Log & Stats
@ -24,6 +29,7 @@ const moment = require('moment');
class StatLog {
constructor() {
this.systemStats = {};
this.lastSysInfoStatsRefresh = 0;
}
init(cb) {
@ -106,7 +112,17 @@ class StatLog {
}
getSystemStat(statName) {
return this.systemStats[statName];
const stat = this.systemStats[statName];
// Some stats are refreshed periodically when they are
// being accessed (e.g. "looked at"). This is handled async.
this._refreshSystemStat(statName);
return stat;
}
getFriendlySystemStat(statName, defaultValue) {
return (this.getSystemStat(statName) || defaultValue).toLocaleString();
}
getSystemStatNum(statName) {
@ -141,13 +157,25 @@ class StatLog {
}
getUserStat(user, statName) {
return user.properties[statName];
return user.getProperty(statName);
}
getUserStatByClient(client, statName) {
const stat = this.getUserStat(client.user, statName);
this._refreshUserStat(client, statName);
return stat;
}
getUserStatNum(user, statName) {
return parseInt(this.getUserStat(user, statName)) || 0;
}
getUserStatNumByClient(client, statName, ttlSeconds = 10) {
const stat = this.getUserStatNum(client.user, statName);
this._refreshUserStat(client, statName, ttlSeconds);
return stat;
}
incrementUserStat(user, statName, incrementBy, cb) {
incrementBy = incrementBy || 1;
@ -215,7 +243,7 @@ class StatLog {
sysDb.run(
`DELETE FROM system_event_log
WHERE id IN(
SELECT id
SELECT id
FROM system_event_log
WHERE log_name = ?
ORDER BY id DESC
@ -239,75 +267,18 @@ class StatLog {
);
}
/*
Find System Log entries by |filter|:
filter.logName (required)
filter.resultType = (obj) | count
where obj contains timestamp and log_value
filter.limit
filter.date - exact date to filter against
filter.order = (timestamp) | timestamp_asc | timestamp_desc | random
*/
//
// Find System Log entry(s) by |filter|:
//
// - logName: Name of log (required)
// - resultType: 'obj' | 'count' (default='obj')
// - limit: Limit returned results
// - date: exact date to filter against
// - order: 'timestamp' | 'timestamp_asc' | 'timestamp_desc' | 'random'
// (default='timestamp')
//
findSystemLogEntries(filter, cb) {
filter = filter || {};
if (!_.isString(filter.logName)) {
return cb(Errors.MissingParam('filter.logName is required'));
}
filter.resultType = filter.resultType || 'obj';
filter.order = filter.order || 'timestamp';
let sql;
if ('count' === filter.resultType) {
sql = `SELECT COUNT() AS count
FROM system_event_log`;
} else {
sql = `SELECT timestamp, log_value
FROM system_event_log`;
}
sql += ' WHERE log_name = ?';
if (filter.date) {
filter.date = moment(filter.date);
sql += ` AND DATE(timestamp, "localtime") = DATE("${filter.date.format(
'YYYY-MM-DD'
)}")`;
}
if ('count' !== filter.resultType) {
switch (filter.order) {
case 'timestamp':
case 'timestamp_asc':
sql += ' ORDER BY timestamp ASC';
break;
case 'timestamp_desc':
sql += ' ORDER BY timestamp DESC';
break;
case 'random':
sql += ' ORDER BY RANDOM()';
break;
}
}
if (_.isNumber(filter.limit) && 0 !== filter.limit) {
sql += ` LIMIT ${filter.limit}`;
}
sql += ';';
if ('count' === filter.resultType) {
sysDb.get(sql, [filter.logName], (err, row) => {
return cb(err, row ? row.count : 0);
});
} else {
sysDb.all(sql, [filter.logName], (err, rows) => {
return cb(err, rows);
});
}
return this._findLogEntries('system_event_log', filter, cb);
}
getSystemLogEntries(logName, order, limit, cb) {
@ -368,6 +339,211 @@ class StatLog {
systemEventUserLogInit(this);
return cb(null);
}
//
// Find User Log entry(s) by |filter|:
//
// - logName: Name of log (required)
// - userId: User ID in which to restrict entries to (missing=all)
// - sessionId: Session ID in which to restrict entries to (missing=any)
// - resultType: 'obj' | 'count' (default='obj')
// - limit: Limit returned results
// - date: exact date to filter against
// - order: 'timestamp' | 'timestamp_asc' | 'timestamp_desc' | 'random'
// (default='timestamp')
//
findUserLogEntries(filter, cb) {
return this._findLogEntries('user_event_log', filter, cb);
}
_refreshSystemStat(statName) {
switch (statName) {
case SysProps.SystemLoadStats:
case SysProps.SystemMemoryStats:
return this._refreshSysInfoStats();
case SysProps.ProcessTrafficStats:
return this._refreshProcessTrafficStats();
}
}
_refreshSysInfoStats() {
const now = Math.floor(Date.now() / 1000);
if (now < this.lastSysInfoStatsRefresh + 5) {
return;
}
this.lastSysInfoStatsRefresh = now;
const basicSysInfo = {
mem: 'total, free',
currentLoad: 'avgLoad, currentLoad',
};
SysInfo.get(basicSysInfo)
.then(sysInfo => {
const memStats = {
totalBytes: sysInfo.mem.total,
freeBytes: sysInfo.mem.free,
};
this.setNonPersistentSystemStat(SysProps.SystemMemoryStats, memStats);
const loadStats = {
// Not avail on BSD, yet.
average: parseFloat(
_.get(sysInfo, 'currentLoad.avgLoad', 0).toFixed(2)
),
current: parseFloat(
_.get(sysInfo, 'currentLoad.currentLoad', 0).toFixed(2)
),
};
this.setNonPersistentSystemStat(SysProps.SystemLoadStats, loadStats);
})
.catch(err => {
// :TODO: log me
});
}
_refreshProcessTrafficStats() {
const trafficStats = getActiveConnections(AllConnections).reduce(
(stats, conn) => {
stats.ingress += conn.rawSocket.bytesRead;
stats.egress += conn.rawSocket.bytesWritten;
return stats;
},
{ ingress: 0, egress: 0 }
);
this.setNonPersistentSystemStat(SysProps.ProcessTrafficStats, trafficStats);
}
_refreshUserStat(client, statName, ttlSeconds) {
switch (statName) {
case UserProps.NewPrivateMailCount:
this._wrapUserRefreshWithCachedTTL(
client,
statName,
this._refreshUserPrivateMailCount,
ttlSeconds
);
break;
case UserProps.NewAddressedToMessageCount:
this._wrapUserRefreshWithCachedTTL(
client,
statName,
this._refreshUserNewAddressedToMessageCount,
ttlSeconds
);
break;
}
}
_wrapUserRefreshWithCachedTTL(client, statName, updateMethod, ttlSeconds) {
client.statLogRefreshCache = client.statLogRefreshCache || new Map();
const now = Math.floor(Date.now() / 1000);
const old = client.statLogRefreshCache.get(statName) || 0;
if (now < old + ttlSeconds) {
return;
}
updateMethod(client);
client.statLogRefreshCache.set(statName, now);
}
_refreshUserPrivateMailCount(client) {
const MsgArea = require('./message_area');
MsgArea.getNewMessageCountInAreaForUser(
client.user.userId,
Message.WellKnownAreaTags.Private,
(err, count) => {
if (!err) {
client.user.setProperty(UserProps.NewPrivateMailCount, count);
}
}
);
}
_refreshUserNewAddressedToMessageCount(client) {
const MsgArea = require('./message_area');
MsgArea.getNewMessageCountAddressedToUser(client, (err, count) => {
if (!err) {
client.user.setProperty(UserProps.NewAddressedToMessageCount, count);
}
});
}
_findLogEntries(logTable, filter, cb) {
filter = filter || {};
if (!_.isString(filter.logName)) {
return cb(Errors.MissingParam('filter.logName is required'));
}
filter.resultType = filter.resultType || 'obj';
filter.order = filter.order || 'timestamp';
let sql;
if ('count' === filter.resultType) {
sql = `SELECT COUNT() AS count
FROM ${logTable}`;
} else {
sql = `SELECT timestamp, log_value
FROM ${logTable}`;
}
sql += ' WHERE log_name = ?';
if (_.isNumber(filter.userId)) {
sql += ` AND user_id = ${filter.userId}`;
}
if (filter.sessionId) {
sql += ` AND session_id = ${filter.sessionId}`;
}
if (filter.date) {
filter.date = moment(filter.date);
sql += ` AND DATE(timestamp, "localtime") = DATE("${filter.date.format(
'YYYY-MM-DD'
)}")`;
}
if ('count' !== filter.resultType) {
switch (filter.order) {
case 'timestamp':
case 'timestamp_asc':
sql += ' ORDER BY timestamp ASC';
break;
case 'timestamp_desc':
sql += ' ORDER BY timestamp DESC';
break;
case 'random':
sql += ' ORDER BY RANDOM()';
break;
}
}
if (_.isNumber(filter.limit) && 0 !== filter.limit) {
sql += ` LIMIT ${filter.limit}`;
}
sql += ';';
if ('count' === filter.resultType) {
sysDb.get(sql, [filter.logName], (err, row) => {
return cb(err, row ? row.count : 0);
});
} else {
sysDb.all(sql, [filter.logName], (err, rows) => {
return cb(err, rows);
});
}
}
}
module.exports = new StatLog();

View File

@ -380,7 +380,7 @@ function formatByteSizeAbbr(byteSize) {
function formatByteSize(byteSize, withAbbr = false, decimals = 2) {
const i = 0 === byteSize ? byteSize : Math.floor(Math.log(byteSize) / Math.log(1024));
let result = parseFloat((byteSize / Math.pow(1024, i)).toFixed(decimals));
let result = parseFloat((byteSize / Math.pow(1024, i)).toFixed(decimals)).toString();
if (withAbbr) {
result += ` ${BYTE_SIZE_ABBRS[i]}`;
}

View File

@ -3,6 +3,7 @@
const Events = require('./events.js');
const LogNames = require('./user_log_name.js');
const SysProps = require('./system_property.js');
const DefaultKeepForDays = 365;
@ -30,6 +31,7 @@ module.exports = function systemEventUserLogInit(statLog) {
const detailHandler = {
[systemEvents.NewUser]: e => {
append(e, LogNames.NewUser, 1);
statLog.incrementNonPersistentSystemStat(SysProps.NewUsersTodayCount, 1);
},
[systemEvents.UserLogin]: e => {
append(e, LogNames.Login, 1);

View File

@ -6,5 +6,5 @@
//
module.exports = {
UserAddedRumorz: 'system_rumorz',
UserLoginHistory: 'user_login_history',
UserLoginHistory: 'user_login_history', // JSON object
};

View File

@ -16,6 +16,7 @@ const iconv = require('iconv-lite');
exports.login = login;
exports.login2FA_OTP = login2FA_OTP;
exports.setClientEncoding = setClientEncoding;
exports.logoff = logoff;
exports.prevMenu = prevMenu;
exports.nextMenu = nextMenu;
@ -241,6 +242,16 @@ function nextArea(callingMenu, formData, extraArgs, cb) {
);
}
function setClientEncoding(callingMenu, formData, extraArgs, cb) {
// TODO: Also add other encoding types
const client = callingMenu.client;
let encoding = formData.value.encoding;
client.term.outputEncoding = encoding;
return callingMenu.nextMenu(cb);
}
function sendForgotPasswordEmail(callingMenu, formData, extraArgs, cb) {
const username = formData.value.username || callingMenu.client.user.username;

View File

@ -10,6 +10,7 @@
module.exports = {
LoginCount: 'login_count',
LoginsToday: 'logins_today', // non-persistent
LastLogin: 'last_login', // object { userId, sessionId, userName, userRealName, timestamp }; non-persistent
FileBaseAreaStats: 'file_base_area_stats', // object - see file_base_area.js::getAreaStats
FileUlTotalCount: 'ul_total_count',
@ -17,17 +18,27 @@ module.exports = {
FileDlTotalCount: 'dl_total_count',
FileDlTotalBytes: 'dl_total_bytes',
FileUlTodayCount: 'ul_today_count', // non-persistent
FileUlTodayBytes: 'ul_today_bytes', // non-persistent
FileDlTodayCount: 'dl_today_count', // non-persistent
FileDlTodayBytes: 'dl_today_bytes', // non-persistent
MessageTotalCount: 'message_post_total_count', // total non-private messages on the system; non-persistent
MessagesToday: 'message_post_today', // non-private messages posted/imported today; non-persistent
// begin +op non-persistent...
SysOpUsername: 'sysop_username',
SysOpRealName: 'sysop_real_name',
SysOpLocation: 'sysop_location',
SysOpAffiliations: 'sysop_affiliation',
SysOpSex: 'sysop_sex',
SysOpEmailAddress: 'sysop_email_address',
// end +op non-persistent
SysOpUsername: 'sysop_username', // non-persistent
SysOpRealName: 'sysop_real_name', // non-persistent
SysOpLocation: 'sysop_location', // non-persistent
SysOpAffiliations: 'sysop_affiliation', // non-persistent
SysOpSex: 'sysop_sex', // non-persistent
SysOpEmailAddress: 'sysop_email_address', // non-persistent
NextRandomRumor: 'random_rumor',
SystemMemoryStats: 'system_memory_stats', // object { totalBytes, freeBytes }; non-persistent
SystemLoadStats: 'system_load_stats', // object { average, current }; non-persistent
ProcessTrafficStats: 'system_traffic_bytes_ingress', // object { ingress, egress }; non-persistent
TotalUserCount: 'user_total_count', // non-persistent
NewUsersTodayCount: 'user_new_today_count', // non-persistent
};

View File

@ -21,8 +21,10 @@ exports.validateEmailAvail = validateEmailAvail;
exports.validateBirthdate = validateBirthdate;
exports.validatePasswordSpec = validatePasswordSpec;
const emptyFieldError = () => new Error('Field cannot be empty');
function validateNonEmpty(data, cb) {
return cb(data && data.length > 0 ? null : new Error('Field cannot be empty'));
return cb(data && data.length > 0 ? null : emptyFieldError);
}
function validateMessageSubject(data, cb) {
@ -91,7 +93,11 @@ function validateGeneralMailAddressedTo(data, cb) {
// :TODO: remove hard-coded FTN check here. We need a decent way to register global supported flavors with modules.
const addressedToInfo = getAddressedToInfo(data);
if (Message.AddressFlavor.FTN === addressedToInfo.flavor) {
if (addressedToInfo.name.length === 0) {
return cb(emptyFieldError());
}
if (Message.AddressFlavor.Local !== addressedToInfo.flavor) {
return cb(null);
}

View File

@ -223,7 +223,7 @@ exports.getModule = class TelnetBridgeModule extends MenuModule {
);
if (err) {
self.client.log.info(
self.client.log.warn(
`Telnet bridge connection error: ${err.message}`
);
}

Some files were not shown because too many files have changed in this diff Show More