MRC: Session stats, mentions, themes, indenting, buffer display, and more

mrc-client:

• A separate set of stats is now shown for displaying local session info, including chatters (count of users in the current room), latency (as calculated by mrc-connector; see below), and mentions. This set of stats is shown by default, with global MRC stats (BBSES, Users, Rooms, and Activity Level) available by using /toggle_stats.

• Basic mention handling. Messages from others containing the user's alias are highlighted during chat, and the number of times mentioned shows on the status bar.

• Long chat messages are indented to the width of the time stamp. This is achieved by pre-wrapping the text and inserting spaces after the carriage- returns before passing the msg object to the frame to be displayed.

• Configurable theme options. User selects a theme by typing /theme . A set of pre-configured theme ini files are included, and the sysop may add or edit them as desired. mrc-client will automatically detect any available theme files matching the pattern "mrc-theme-<theme_name>.ini". The user's selected theme is saved to settings for future sessions.

• Buffer/MaxBuffer is now shown in the status bar.

• inputline.max_buffer is now a flat 140, rather than calculated to 140 minus the alias length. This is because the message portion of the message packet is allowed to be 140 characters.

• PgUp, PgDn, Home, and End all now work in scroll mode.

• nicklist.transparent property now gets set based on the show_nicks value, in order to get an extra column's worth of width.

• The user's nicklist preference (toggle_nicks) is saved in settings for future sessions.

• Added a save_setting function for convenience. Used by both the set_alias and set_theme functions.

mrc-session:

• mention_count and latency added to state properties.

• The room_topic session state property now holds the room topic string (previously it wasn't used).

• Added afk, register, identify, update, and trust commands, so now they can be called directly instead without using /quote.

mrc-connector:

• Latency is now calculated and passed to mrc-client for display on the status bar. It's the number of milliseconds elapsed between the time the last message was sent and acknowledged by the server.

• The FROM_SITE constant is now the more descriptive system.name (spaces replaced with underscores) instead of the less descriptive system.qwk_id. This is what gets shown in the /whoon list, as well as whenever a user enters or exits MRC.

• Stats weren't truly being requested "every 20 seconds" like they're supposed to be. This is fixed.

  (this 20-second frequency is hard-coded in Mystic's multiplexer, but maybe this could/should be configurable in the mrc-connector.ini file.)

Things to consider for future revisions (?):

• Let user review history of mentions with option to reset mention counter.
• Banners display; server periodically sends points of interest, and sysop may opt to display local banners.
• Make the top bar 2 rows high; the added row could be used by themes and/or the aforementioned banner display.
• Twit filter.
• Let user change text color using left/right arrows.

xtrn/mrc/mrc-client.js

@@ -11,13 +11,24 @@ load('sbbsdefs.js');
 load('frame.js');
 load('scrollbar.js');
 load('inputline.js');
+load("funclib.js"); // for getColor() function
 load(js.startup_dir + 'mrc-session.js');
 
 js.on_exit("js.counter = 0");
 js.time_limit=0;
 
 var input_state = 'chat';
+var show_nicks = false;
+var stat_mode = 0; // 0 = Local Session stats (Chatters, Latency, & Mentions); 1 = Global MRC Stats
 
+const MENTION_MARKER = ascii(15);
+const INDENT_MARKER = ascii(28);
+
+// default theme
+var theme_bg_color = BG_BLUE;
+var theme_fg_color = "\x01w\x01h";
+var theme_2nd_color = "\x01b\x01h";
+var theme_mrc_title = "\x01w\x01hMRC";
 
 var f = new File(js.startup_dir + 'mrc-client.ini');
 f.open('r');
@@ -25,13 +36,14 @@ const settings = {
     root: f.iniGetObject(),
     startup: f.iniGetObject('startup'),
     aliases: f.iniGetObject('aliases') || {},
-    client: f.iniGetObject('client') || {}
+    client: f.iniGetObject('client') || {},
+    show_nicks: f.iniGetObject('show_nicks') || {},
+    theme: f.iniGetObject('theme') || {}
 };
 
 f.close();
 f = undefined;
 
-var show_nicks = (settings.client.show_nicks === true) ? true : false;
 
 const NICK_COLOURS = [
     '\x01h\x01r',
@@ -52,7 +64,14 @@ const NICK_COLOURS = [
 
 const PIPE_COLOURS = [2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 15];
 
-function pipe_to_ctrl_a(str) {
+const ACT_LVL = [
+    /* 0: NUL */ "\x01H\x01KNUL",
+    /* 1: LOW */ "\x01H\x01YLOW",
+    /* 2: MED */ "\x01H\x01GMED",
+    /* 3: HI  */ "\x01H\x01RHI"
+];
+
+function pipe_to_ctrl_a(str) { // could use the pipeToCtrlA function in funclib.js instead
 	str = str.replace(/\|00/g, "\x01N\x01K");
 	str = str.replace(/\|01/g, "\x01N\x01B");
 	str = str.replace(/\|02/g, "\x01N\x01G");
@@ -84,11 +103,12 @@ function resize_nicklist(frames, nicks) {
     const maxlen = show_nicks ? Math.max(1, nicks.reduce(function (a, c) {
         return c.length > a ? c.length : a;
     }, 0)) : 0;
+    frames.nicklist.transparent = !show_nicks;
     frames.nicklist.moveTo(frames.top.x + frames.top.width - 1 - maxlen - 1, 2);
     frames.nicks.moveTo(frames.nicklist.x + 1, 2);
-    frames.nicklist.width = maxlen + (show_nicks ? 2 : 1);
+    frames.nicklist.width = maxlen + 1;
     frames.nicks.width = maxlen + 1;
-    frames.output.width = (frames.top.width - frames.nicklist.width) + 1;
+    frames.output.width = (frames.top.width - (show_nicks ? frames.nicklist.width : 0));
 }
 
 function redraw_nicklist(frames, nicks, colours) {
@@ -105,9 +125,9 @@ function init_display() {
     const w = console.screen_columns;
     const h = console.screen_rows;
     const f = { top: new Frame(1, 1, w, h, BG_BLACK|LIGHTGRAY) };
-    f.title = new Frame(1, 1, w, 1, BG_BLUE|WHITE, f.top);
+    f.title = new Frame(1, 1, w, 1, theme_bg_color|LIGHTGRAY, f.top);
     f.output = new Frame(1, 2, 1, h - 3, BG_BLACK|LIGHTGRAY, f.top);
-    f.divider = new Frame(1, h - 1, w, 1, BG_BLUE|WHITE, f.top);
+    f.divider = new Frame(1, h - 1, w, 1, theme_bg_color|LIGHTGRAY, f.top);
     f.nicklist = new Frame(w - 2, 2, 2, h - 3, BG_BLACK|LIGHTGRAY, f.top);
     f.nicks = new Frame(w - 1, 2, 1, h - 3, BG_BLACK|LIGHTGRAY, f.nicklist);
     f.input = new Frame(1, h, w, 1, BG_BLACK|WHITE, f.top);
@@ -115,25 +135,41 @@ function init_display() {
     f.nick_scroll = new ScrollBar(f.nicks, { autohide: true });
     f.output.word_wrap = true;
     f.divider.gotoxy(f.divider.width - 5, 1);
-    f.divider.putmsg('/help');
+    f.divider.putmsg(theme_fg_color + '/help');
     f.top.open();
     return f;
 }
 
-function refresh_stats(frames, stats) {
-    const activity = new Array(
-        /* 0: NUL */ "\x01H\x01KNUL", 
-        /* 1: LOW */ "\x01H\x01YLOW", 
-        /* 2: MED */ "\x01H\x01GMED", 
-        /* 3: HI  */ "\x01H\x01RHI"
-    );
-    frames.divider.clear();
-    frames.divider.putmsg(format("\x01w\x01hSTATS\x01b\x01h> \x01w\x01hBBSes \x01b\x01h[\x01w\x01h%d\x01b\x01h] \x01nRooms \x01b\x01h[\x01w\x01h%d\x01b\x01h] \x01nUsers \x01b\x01h[\x01w\x01h%d\x01b\x01h] \x01nLevel \x01b\x01h[%s\x01b\x01h]\x01n", stats[0], stats[1], stats[2], activity[Number(stats[3])]));
-    frames.divider.gotoxy(frames.divider.width - 5, 1);
-    frames.divider.putmsg('\x01w\x01h/help');    
+function refresh_stats(frames, session) {
+    if (input_state == 'chat' ) {            
+        frames.divider.clear();
+        if (stat_mode == 0) {
+            frames.divider.putmsg(format(theme_fg_color + "CLIENT STATS" + theme_2nd_color + "> " + 
+                theme_fg_color + "Latency" +  theme_2nd_color + " [" + theme_fg_color + "%d" + theme_2nd_color + "] " +
+                theme_fg_color + "Chatters" + theme_2nd_color + " [" + theme_fg_color + "%d" + theme_2nd_color + "] " +
+                theme_fg_color + "Mentions" + theme_2nd_color + " [" + theme_fg_color + "%d" + theme_2nd_color + "]",
+                session.latency,
+                session.nicks.length,
+                session.mention_count
+            ));        
+        } else {
+            frames.divider.putmsg(format(theme_fg_color + "GLOBAL STATS" + theme_2nd_color + "> " + 
+                theme_fg_color + "BBSes" +    theme_2nd_color + " [" + theme_fg_color + "%d" + theme_2nd_color + "] " +
+                theme_fg_color + "Rooms" +    theme_2nd_color + " [" + theme_fg_color + "%d" + theme_2nd_color + "] " +
+                theme_fg_color + "Users" +    theme_2nd_color + " [" + theme_fg_color + "%d" + theme_2nd_color + "] " +
+                theme_fg_color + "Activity" + theme_2nd_color + " [%s"                       + theme_2nd_color + "]",
+                session.stats[0],
+                session.stats[1],
+                session.stats[2],
+                ACT_LVL[Number(session.stats[3])]
+            ));
+        }
+        frames.divider.gotoxy(frames.divider.width - 5, 1);
+        frames.divider.putmsg(theme_fg_color + '/help');
+    }
 }
 
-function append_message(frames, msg) {
+function append_message(frames, msg, mention) {
     const top = frames.output.offset.y;
     if (frames.output.data_height > frames.output.height) {
         while (frames.output.down()) {
@@ -141,7 +177,18 @@ function append_message(frames, msg) {
         }
         frames.output.gotoxy(1, frames.output.height);
     }
-    frames.output.putmsg("\x01k\x01h" + getShortTime(new Date()) + "\x01n " + msg + '\r\n');
+
+    // programmatically insert indent(s), if the message length exceeds the frame width.
+    if (strlen(msg) >= frames.output.width - 8) {
+        var indent = "\r\n" + (new Array(7).join( " " )) + INDENT_MARKER + " ";
+        msg = lfexpand(word_wrap(msg, frames.output.width - 9)).replace(/\r\n$/g, "").replace(/\r\n/g, indent).trim();
+    }
+
+    frames.output.putmsg(
+        (mention ? "\x01k\x017" : "\x01k\x01h") + getShortTime(new Date()) + // timestamp formatting
+        (mention ? ( "\x01n\x01r\x01h\x01i" + MENTION_MARKER ) : " ") +      // mention formatting
+        "\x01n" + msg + '\r\n'                                               // message itself
+    );
     frames.output.scroll(0, -1);
     if (input_state == 'scroll') frames.output.scrollTo(0, top);
 }
@@ -150,9 +197,9 @@ function getShortTime(d) {
     return format( "%02d:%02d", d.getHours(), d.getMinutes() );
 }
 
-function display_message(frames, msg, colour) {
+function display_message(frames, msg, mention) { //, colour param was listed but not used..     
     const body = pipe_to_ctrl_a(truncsp(msg.body) || '').split(' ');
-    append_message(frames, body[0] + '\x01n\x01w ' + body.slice(1).join(' ') + '\x01n\x01w');
+    append_message(frames, body[0] + '\x01n\x01w ' + body.slice(1).join(' ') + '\x01n\x01w', mention);
 }
 
 function display_server_message(frames, msg) {
@@ -161,14 +208,11 @@ function display_server_message(frames, msg) {
 
 function display_title(frames, room, title) {
     frames.title.clear();
-    frames.title.putmsg('MRC\x01b\x01h>\x01w\x01h #' + room + ' - ' + title);
+    frames.title.putmsg(theme_mrc_title + theme_fg_color + " " + theme_2nd_color + "#" + theme_fg_color + room + theme_2nd_color + ':' + theme_fg_color + title);
 }
 
 function set_alias(alias) {
-    const f = new File(js.startup_dir + 'mrc-client.ini');
-    f.open('r+');
-    f.iniSetValue('aliases', user.alias, alias);
-    f.close();
+    save_setting(user.alias, 'aliases', alias);
 }
 
 function new_alias() {
@@ -183,6 +227,36 @@ function new_alias() {
     settings.aliases[user.alias] = alias;
 }
 
+function list_themes () {
+    var theme_list = [];
+    var theme_files = directory(backslash(js.startup_dir) + "mrc-theme-*.ini");
+    for (var t = 0; t < theme_files.length; t++) {
+        theme_list.push(file_getname(theme_files[t].replace("mrc-theme-", "").replace(".ini", "")));
+    }
+    return theme_list.join(", ");
+}
+
+function set_theme (theme_name) {
+    var f = new File(js.startup_dir + format("mrc-theme-%s.ini", theme_name));
+    if ( f.open('r') ) {
+        const theme = f.iniGetObject();
+        f.close();
+        f = undefined;
+        theme_bg_color = getColor(theme.theme_bg_color);
+        theme_fg_color = "\x01n" + getColor(getColor(theme.theme_fg_color));    // call 2x to get the CTRL_A color
+        theme_2nd_color = "\x01n" + getColor(getColor(theme.theme_2nd_color));  // for the fb and 2nd colors.
+        theme_mrc_title = theme.theme_mrc_title;
+        save_setting(user.alias, "theme", theme_name);
+    }
+}
+
+function save_setting (alias, setting_name, setting_value) {
+    const f = new File(js.startup_dir + 'mrc-client.ini');
+    f.open('r+');
+    f.iniSetValue(setting_name, alias, setting_value);
+    f.close();
+}
+
 function main() {
 
     var msg;
@@ -197,10 +271,18 @@ function main() {
         settings.aliases[user.alias] || new_alias(user.alias)
     );
 
+    if (settings.show_nicks[user.alias]) {
+        show_nicks = settings.show_nicks[user.alias];
+    }
+
+    if (settings.theme[user.alias]) {
+        set_theme(settings.theme[user.alias]);
+    }
+
     const frames = init_display();
     const inputline = new InputLine(frames.input);
     inputline.show_cursor = true;
-    inputline.max_buffer = 140 - settings.aliases[user.alias].length - 1;
+    inputline.max_buffer = 140;
 
     resize_nicklist(frames, []);
     redraw_nicklist(frames, []);
@@ -235,13 +317,22 @@ function main() {
         );
         display_server_message(frames, '\x01h\x01w/\x01h\x01cnick_suffix \x01h\x01w- \x01n\x01wSet an eight-character suffix for your handle, eg. /nick_suffix <poop>');
         display_server_message(frames, '\x01h\x01w/\x01h\x01ctoggle_nicks \x01h\x01w- \x01n\x01wShow/hide the nicklist');
+        display_server_message(frames, '\x01h\x01w/\x01h\x01ctoggle_stats \x01h\x01w- \x01n\x01wSwitch between global MRC stats and client/session stats.');
+        display_server_message(frames, "\x01h\x01w/\x01h\x01ctheme \x01n\x01w- \x01nSelect a theme: " + list_themes() );
         display_server_message(frames, '\x01h\x01w/\x01h\x01cquit \x01n\x01w- \x01h\x01wExit the program');
     });
     session.on('message', function (msg) {
         if (msg.from_user == 'SERVER') {
             display_server_message(frames, msg.body);
         } else {
-            display_message(frames, msg, nick_colours[msg.from_user] || '');
+            var mention = false;
+            if (msg.body.toUpperCase().indexOf(user.alias.toUpperCase()) >= 0 && msg.from_user !== user.alias) {
+                console.beep();
+                mention = true;
+                session.mention_count = session.mention_count + 1;
+                refresh_stats (frames, session);
+            }            
+            display_message(frames, msg, mention); //, nick_colours[msg.from_user] || '');
         }
     });
     session.on('nicks', function (nicks) {
@@ -250,6 +341,7 @@ function main() {
         });
         resize_nicklist(frames, nicks);
         redraw_nicklist(frames, nicks, nick_colours);
+        refresh_stats (frames, session);
     });
     session.on('sent_privmsg', function (user, msg) {
         display_message(frames, { body: '--> ' + (nick_colours[user] || '') + user + ' ' + msg });
@@ -258,9 +350,10 @@ function main() {
         display_title(frames, room, topic);
     });
     session.on('stats', function (stats) {
-        if (input_state == 'chat') {
-            refresh_stats(frames, stats);
-        }
+        refresh_stats(frames, session);
+    });
+    session.on('latency', function () {
+        refresh_stats(frames, session);
     });
 
     if (settings.startup.motd) session.motd();
@@ -270,6 +363,8 @@ function main() {
     var cmd, line, user_input;
     while (!js.terminated && !break_loop) {
         session.cycle();
+        frames.divider.gotoxy(frames.divider.width - 16, 1);
+        frames.divider.putmsg(theme_2nd_color + "[" + theme_fg_color + ("000" + inputline.buffer.length).slice(-3) + theme_2nd_color + '/' + theme_fg_color + inputline.max_buffer + theme_2nd_color + "]");
         user_input = inputline.getkey();
         if (typeof user_input == 'string') {
             if (input_state == 'chat') {
@@ -288,15 +383,14 @@ function main() {
                         case 'scroll':
                             input_state = 'scroll';
                             frames.divider.clear();
-                            frames.divider.putmsg('UP/DOWN to scroll, ENTER to return');
+                            frames.divider.putmsg(theme_fg_color + 'UP/DOWN, PGUP/PGDN, HOME/END to scroll, ENTER to return');
                             break;
                         case 'scroll_nicks':
                             input_state = 'scroll_nicks';
                             frames.divider.clear();
-                            frames.divider.putmsg('UP/DOWN to scroll nicklist, ENTER to return');
+                            frames.divider.putmsg(theme_fg_color + 'UP/DOWN to scroll nicklist, ENTER to return');
                             break;
                         case 'nick_prefix':
-                            log(LOG_DEBUG, 'nick prefix ' + JSON.stringify(cmd));
                             if (cmd.length == 2) {
                                 if (cmd[1].length == 1) {
                                     settings.aliases[user.alias] = settings.aliases[user.alias].replace(/^(\|\d\d)*\S/, cmd[1]);
@@ -313,7 +407,7 @@ function main() {
                         case 'nick_colour':
                             if (cmd.length == 2) {
                                 if (PIPE_COLOURS.indexOf(parseInt(cmd[1])) >= 0) {
-                                    var re = new RegExp('(\|\d\d)*' + user.alias, 'i');
+                                    var re = new RegExp('(\\|\\d\\d)*' + user.alias, 'i');
                                     settings.aliases[user.alias] = settings.aliases[user.alias].replace(re, format('|%02d%s', cmd[1], user.alias));
                                     set_alias(settings.aliases[user.alias]);
                                     session.alias = settings.aliases[user.alias];
@@ -339,6 +433,18 @@ function main() {
                             show_nicks = !show_nicks;
                             resize_nicklist(frames, session.nicks);
                             redraw_nicklist(frames, session.nicks, nick_colours);
+                            save_setting(user.alias, "show_nicks", show_nicks);
+                            break;
+                        case "toggle_stats":                            
+                            stat_mode = stat_mode === 0 ? 1 : 0;
+                            refresh_stats(frames, session);
+                            break;
+                        case "theme":
+                            set_theme( cmd[1] );
+                            frames.title.attr = theme_bg_color|theme_fg_color;
+                            frames.divider.attr = theme_bg_color|theme_fg_color;
+                            display_title(frames, session.room, session.room_topic);
+                            refresh_stats(frames, session);
                             break;
                         default:
                             if (typeof session[cmd[0]] == 'function') {
@@ -375,16 +481,27 @@ function main() {
                 }
             } else if (input_state == 'scroll' || input_state == 'scroll_nicks') {
                 var sframe = input_state == 'scroll' ? frames.output : frames.nicks;
-                // to do: page up, page down
                 if (user_input == KEY_UP && sframe.offset.y > 0) {
                     sframe.scroll(0, -1);
                 } else if (user_input == KEY_DOWN && sframe.offset.y + sframe.height < sframe.data_height) {
                     sframe.scroll(0, 1);
+                } else if (user_input == KEY_PAGEUP && sframe.offset.y > 0 ) {
+                    sframe.scroll(0, -1 * sframe.height);
+                    frames.output_scroll.cycle();
+                } else if (user_input == KEY_PAGEDN && sframe.offset.y + sframe.height < sframe.data_height ) {
+                    sframe.scroll(0, sframe.height);
+                    frames.output_scroll.cycle();
+                } else if (user_input == KEY_HOME) {
+                    sframe.scrollTo(0, 0);
+                    frames.output_scroll.cycle();
+                } else if (user_input == KEY_END) {
+                    sframe.scrollTo(0, sframe.data_height-sframe.height-1);
+                    frames.output_scroll.cycle();
                 } else if (user_input == '' || user_input == 'q') {
-                    frames.output.scrollTo(1, frames.output.data_height - frames.output.height);
+                    frames.output.scrollTo(1, frames.output.data_height - frames.output.height-1);
                     frames.output_scroll.cycle();
-                    refresh_stats(frames, session.stats);
                     input_state = 'chat';
+                    refresh_stats(frames, session);
                 }
             }
         }
@@ -395,7 +512,6 @@ function main() {
         }
         yield();
     }
-
 }
 
 main();