Feature/dropfile improvements #521

cognitivegears · 2023-11-05T00:25:20Z

Updated to 8 dropfile formats and changed to use a template file.

Note: additional testing and changes are most likely needed for the formats for both the current door support as well as the new door system, I wanted to get this in now though to get the conversation started about changes needed, etc.

NuSkooler · 2023-11-05T20:55:09Z

core/dropfile.js

+        let formatObj = getPredefinedMCIFormatObject(this.client, text);
+
+        const additionalFormatObj = {
+            'getSysopFirstName': this.getSysopFirstName(),


small nit here, remove the get prefix to match the rest of how the system treats these types of variables

NuSkooler · 2023-11-05T20:59:00Z

core/dropfile.js

+            'getSysopLastName': this.getSysopLastName(),
+            'getUserFirstName': this.getUserFirstName(),
+            'getUserLastName': this.getUserLastName(),
+            'getUserTotalDownloadK': this.getUserTotalDownloadK(),


I think {userTotalDownloadBytes!toKilobytes} (by resolving some TODO's in string_format.js would work here and be more flexible?

So this one and the date format I had thought about, but there is a bit of a problem with when these methods are called... it looks like the methods run first and return a string, then the formatting runs on them. So for these it would actually have to parse as a string to format, which is a bit ugly. Maybe a better way would be to have these return an object with a toString instead, then we can format them as we like, with the default behaving as it does now? Just a thought.

I'll take a look at this maybe tomorrow night. I think in string_format.js it can be expanded to allow some Date/Time raw formats of some sort and via transformers:

try { value = getValue(obj, objPath); if (transformer) { // 'value' can be a obj here IIRC value = transformValue(transformer, value); } tokens = tokenizeFormatSpec(formatSpec || ''); // could allow non-transformers to handle D/T here too... maybe if (_.isNumber(value)) { out += formatNumber(value, tokens); } else { out += formatString(value, tokens); } } catch (e) { if (e instanceof KeyError) { out += match[0]; // preserve full thing } else if (e instanceof ValueError) { out += value.toString(); } }

NuSkooler · 2023-11-05T21:00:25Z

core/dropfile.js

+            'getUserLastName': this.getUserLastName(),
+            'getUserTotalDownloadK': this.getUserTotalDownloadK(),
+            'getUserTotalUploadK': this.getUserTotalUploadK(),
+            'getCurrentDateMMDDYY': this.getCurrentDateMMDDYY(),


We might be able to do it here as well, something like {currentDate!dateMmDdYy} or something, with some other common formats.

NuSkooler · 2023-11-05T21:00:47Z

core/dropfile.js

+        // Read the directory containing the dropfile formats, and return undefined if we don't have the format
+        const fileName = this.fileName;
+        if (!fileName) {
+            Log.info({fileType: this.fileType}, 'Dropfile format not supported.');


Should that be a warn?

Agreed I'll change these to warns

NuSkooler · 2023-11-05T21:03:17Z

core/string_format.js

@@ -210,7 +212,7 @@ function formatNumberHelper(n, precision, type) {
 function formatNumber(value, tokens) {
    const fill = tokens.fill || (tokens['0'] ? '0' : ' ');
    const align = tokens.align || (tokens['0'] ? '=' : '>');
-    const width = Number(tokens.width);
+    const width = Number(tokens.width);value.replace(/\x1b\[[0-9;]*m/g, '');


formatting nit

Sorry I'll clean that up

NuSkooler · 2023-11-05T21:04:08Z

dropfile_formats/CALLINFO.BBS

@@ -0,0 +1,36 @@
+{UR}


Very minor, but can we call these "dropfile_templates" to match the 'template' naming elsewhere?

NuSkooler · 2023-11-05T21:06:44Z

Any thoughts on how the binary formats would work here? Not exactly pressing of course...

I'll pull this down and start poking. At glance it looks 100% backwards compatible, which is 👍

NuSkooler · 2023-11-05T21:07:05Z

core/string_format.js

@@ -299,6 +301,7 @@ const transformers = {
    styleSmallI: s => stylizeString(s, 'small i'),
    styleMixed: s => stylizeString(s, 'mixed'),
    styleL33t: s => stylizeString(s, 'l33t'),
+    sanitized: s => stylizeString(s, 'sanitized'),


We'll want to get this guy documented

Should have done that already 🙂 will do

NuSkooler · 2023-11-05T21:08:21Z

core/predefined_mci.js

@@ -124,6 +124,12 @@ const PREDEFINED_MCI_GENERATORS = {
    UN: function userName(client) {
        return client.user.username;
    },
+    UZ: function sanitizedUserName(client) {


Nice! We'll need to get these in the MCI docs

Yeah I actually probably need to do a few more of these too and think about the split - I.e I could also add first name / last name ones etc among others. Probably needs some more thinking on what is appropriate here

NuSkooler · 2023-11-05T21:09:45Z

dropfile_formats/CHAIN.TXT

+1
+0
+99999
+C:\DATA


I wonder if we'll need to allow these to be configured. I imagine a WWIV door running under e.g. DOSEMU, where D:\SOMETHING\DATA is where it wants to perform I/O. I'm not sure though...

They absolutely will need to be - I didn't have anything to set them to yet, so left them for now. Before this gets merged though hopefully will be able to set them to what we need for either existing door system or the new one. I just didn't want to wait for that for you to get a chance to check out the overall direction etc

cognitivegears · 2023-11-05T21:32:23Z

Any thoughts on how the binary formats would work here? Not exactly pressing of course...

I'll pull this down and start poking. At glance it looks 100% backwards compatible, which is 👍

I left room for specific implementations that don't use the templates - they would return a method the same as they did before for the implementation. I haven't put any in yet though - I know I have the format for at least one binary dropfile format though I can go ahead and add that to work as an example too

NuSkooler · 2023-11-06T00:27:22Z

core/dropfile.js


-        //  :TODO: fix time remaining
-        //  :TODO: fix default protocol -- user prop: transfer_protocol
-        return iconv.encode(


One thing I think we're losing here is the self-commenting dropfile formats.

NuSkooler · 2023-11-06T00:28:43Z

dropfile_formats/DOOR.SYS

@@ -0,0 +1,52 @@
+COM1:


What do you think about supporting comments in the templates so we can self-doc? I think // anything after would work for all of them

cognitivegears added 7 commits October 1, 2023 19:04

Added dropfile formats

19d92b3

Started on initial implementation

d3a0fb4

Removed unused functions

8a27bb6

Merge remote-tracking branch 'origin' into feature/dropfile_improvements

e6cc890

First set of updates for formatting

e2a9d35

Various bug fixes

9bb8277

Fixed handling of unknown door types

04392e3

cognitivegears requested a review from NuSkooler November 5, 2023 00:25

NuSkooler reviewed Nov 5, 2023

View reviewed changes

NuSkooler reviewed Nov 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/dropfile improvements #521

Feature/dropfile improvements #521

cognitivegears commented Nov 5, 2023

NuSkooler Nov 5, 2023

NuSkooler Nov 5, 2023

cognitivegears Nov 5, 2023

NuSkooler Nov 6, 2023 •

edited

Loading

NuSkooler Nov 5, 2023

NuSkooler Nov 5, 2023

cognitivegears Nov 5, 2023

NuSkooler Nov 5, 2023

cognitivegears Nov 5, 2023

NuSkooler Nov 5, 2023 •

edited

Loading

cognitivegears Nov 5, 2023

NuSkooler commented Nov 5, 2023

NuSkooler Nov 5, 2023

cognitivegears Nov 5, 2023

NuSkooler Nov 5, 2023

cognitivegears Nov 5, 2023

NuSkooler Nov 5, 2023

cognitivegears Nov 5, 2023

cognitivegears commented Nov 5, 2023

NuSkooler Nov 6, 2023

NuSkooler Nov 6, 2023

+
+
+
+              C:\DATA

Feature/dropfile improvements #521

Are you sure you want to change the base?

Feature/dropfile improvements #521

Conversation

cognitivegears commented Nov 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NuSkooler Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NuSkooler Nov 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NuSkooler commented Nov 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cognitivegears commented Nov 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NuSkooler Nov 6, 2023 •

edited

Loading

NuSkooler Nov 5, 2023 •

edited

Loading