Merge branch 'master' into 'master'

CTCP, user actions, and fixes

See merge request !525

xtrn/mrc/mrc-client.js

@@ -48,6 +48,7 @@ js.on_exit("js.counter = 0");
 js.time_limit=0;
 
 var input_state = 'chat';
+var paused_msg_buffer = []; 
 var show_nicks = false;
 var stat_mode = 0; // 0 = Local Session stats (Chatters, Latency, & Mentions); 1 = Global MRC Stats
 
@@ -68,6 +69,7 @@ if (!f.open('r')) {
 	alert("Error " + f.error + " (" + strerror(f.error) + ") opening " + f.name);
 	exit(1);
 }
+
 const settings = {
     root: f.iniGetObject(),
     startup: f.iniGetObject('startup'),
@@ -140,7 +142,7 @@ function init_display(msg_color) {
     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_color = new Frame(1, h, 1, 1, BG_BLACK|LIGHTGRAY, f.top);
-    f.input = new Frame(2, h, w-2, 1, BG_BLACK|WHITE, f.top); // TODO: Test
+    f.input = new Frame(2, h, w-2, 1, BG_BLACK|WHITE, f.top);
     f.output_scroll = new ScrollBar(f.output, { autohide: true });
     f.nick_scroll = new ScrollBar(f.nicks, { autohide: true });
     f.output.word_wrap = true;
@@ -180,7 +182,15 @@ function refresh_stats(frames, session) {
     }
 }
 
-function append_message(frames, msg, mention) {
+function append_message(frames, msg, mention, when) {
+    
+    if (input_state !== "chat") {                     // pause incoming messages while scrolling.
+        paused_msg_buffer.push({"msg": msg,           // we'll capture any incoming messages in the meantime
+                                "mention": mention,   // and display them when done scrolling.
+                                "when": new Date()});
+        return;                                       
+    }
+    
     const top = frames.output.offset.y;
     if (frames.output.data_height > frames.output.height) {
         while (frames.output.down()) {
@@ -196,7 +206,7 @@ function append_message(frames, msg, mention) {
     }
 
     frames.output.putmsg(
-        (mention ? "\x01k\x017" : "\x01k\x01h") + getShortTime(new Date()) + // timestamp formatting
+        (mention ? "\x01k\x017" : "\x01k\x01h") + getShortTime(when || new Date()) + // timestamp formatting
         (mention ? ( "\x01n\x01r\x01h\x01i" + MENTION_MARKER ) : " ") +      // mention formatting
         "\x01n" + msg + '\r\n'                                               // message itself
     );
@@ -456,6 +466,9 @@ function main() {
     session.on('latency', function () {
         refresh_stats(frames, session);
     });
+    session.on('ctcp-msg', function (msg) {
+        display_server_message(frames, pipeToCtrlA( msg ) );
+    });
 
     if (settings.startup.splash) display_external_text(frames, "splash");
     if (settings.startup.motd) session.motd();
@@ -611,6 +624,9 @@ function main() {
                                 manage_twits( cmd[1].toLowerCase(), cmd.slice(2).join(' ').toLowerCase(), session.twit_list, frames );
                             }
                             break;
+                        case "?": // shortcut for "help", because why not?
+                            session.send_command("help");
+                            break;
                         default:
                             if (typeof session[cmd[0]] == 'function') {
                                 session[cmd[0]](cmd.slice(1).join(' '));
@@ -673,6 +689,12 @@ function main() {
                     input_state = 'chat';
                     session.mention_count = 0;
                     refresh_stats(frames, session);
+                    if (paused_msg_buffer.length > 0) {
+                        for (var pmb in paused_msg_buffer) {
+                            append_message(frames, paused_msg_buffer[pmb].msg, paused_msg_buffer[pmb].mention, paused_msg_buffer[pmb].when);
+                        }
+                        paused_msg_buffer = [];
+                    }
                 }
             } else if (input_state == 'scroll' || input_state == 'scroll_nicks') {
                 var sframe = input_state == 'scroll' ? frames.output : frames.nicks;
@@ -697,6 +719,12 @@ function main() {
                     frames.output_scroll.cycle();
                     input_state = 'chat';
                     refresh_stats(frames, session);
+                    if (paused_msg_buffer.length > 0) {
+                        for (var pmb in paused_msg_buffer) {
+                            append_message(frames, paused_msg_buffer[pmb].msg, paused_msg_buffer[pmb].mention, paused_msg_buffer[pmb].when);
+                        }
+                        paused_msg_buffer = [];
+                    }
                 }
             }
         }

xtrn/mrc/mrc-connector.js

@@ -28,7 +28,7 @@ f = undefined;
 if (!settings.ssl)
 	settings.ssl=false;
 
-const PROTOCOL_VERSION = '1.3.2';
+const PROTOCOL_VERSION = '1.3.3';
 const MAX_LINE = 512;
 const FROM_SITE = system.name.replace(/ /g, "_");
 const SYSTEM_NAME = system_info.system_name || system.name;

xtrn/mrc/mrc-help-ctcp.msg

+
N
B
H__[ 
H
WHow to use CTCP commands
N: 
B
H]_______________________________
+
+
N CTCP (Client-to-Client Protocol) commands are special messages
+
N that can be sent to a channel or other clients.
+
+
N Usage:
+   
W
H/
Cctcp 
N
Htarget 
H
Bcommand 
K
+
+
N A 
Htarget 
Nis a user or room name. 
H
B* 
Ntargets all.
+
+
N Supported commands: 
+
H
B   VERSION  TIME  PING  CLIENTINFO
+
+
N Type 
W
H/
Ctoggle_ctcp 
Nto hide/show incoming requests.
\ No newline at end of file

xtrn/mrc/mrc-help-main.msg

-
N
B__[ 
H
WList of available commands
N: 
B]_____________________________
+
N
B
H__[ 
H
WList of available commands
N: 
B
H]_____________________________
 
W
H/
Cinfo
N

H
K:
N View information about a BBS
H
K:
N 
H/
Cinfo
N 
H#
-
W
H/
Ct 
Kor 
W/
Cmsg

K:
N Send a direct message
H
K:
N

H/
Ct
N 
Hnick
N 
H
Bmessage
+
W
H/
Cmsg 
Kor 
W/
Ct

K:
N Send a direct message
H
K:
N

H/
Ct
N 
Hnick
N 
H
Bmessage
 
W
H/
Cr
N

H
K:
N Reply to last direct message
H
K:
N 
H/
Cr
B message
-
W
H/
Cjoin
N

H
K:
N Move to a new room
H
K:
W
/
Cjoin
N 
Hroom_name
-
W
H/
Ctopic
N

H
K:
N Change room topic:

H/
Ctopic
W topic
+
W
H/
Cjoin 
Kor 
W/
Cj
N
 
H
K    :
N Join a new room
H
K:
W
   /
Cj
N 
Hroom_name
+
W
H/
Ctopic
N

H
K:
N Change room topic
H
K:

H
W/
Ctopic
W topic
+
W
H/
Cme
N            
H
K:
N Perform an action
H
K:            
H
W/
Cme 
N
Hwaves
 
W
H/
Crooms
N

H
K:
N List available rooms
 
W
H/
Cusers
N

H
K:
N List users
 
W
H/
Cwhoon
N

H
K:
N List users and BBSes
 
W
H/
Cmotd
N

H
K:
N Display the Message of the Day
 
W
H/
Cscroll 
Kor 
CPGUP
K:
N Scroll the chat window
 
W
H/
Cmentions 
Kor 
CUP
K:
N Reset mention counter and review mentions
-
W
H/
Cscroll_nicks
N  
H
K:
N Scroll the nicklist
-
W
H/
Ctoggle_nicks
N  
H
K:
N Show/hide the nicklist
-
W
H/
Ctoggle_stats
N  
H
K:
N Toggle MRC stats view
 
W
H/
Ctheme
N

H
K:
N Select a theme 
H
K..........
N see
H
K:
N 
H/
Chelp
N 
Htheme
 
W
H/
Ctwit
N

H
K:
N Twit List management 
H
K....
N see
H
K:
N 
H/
Chelp
N 
Htwit
-
W
H/
Cquit
N

H
K:
N Exit the program
+
W
H/
Cctcp
N

H
K:
N Send a CTCP command 
H
K.....
N see
H
K:
N 
H/
Chelp
N 
Hctcp
+
W
H/
Cquit 
Kor 
W/
Cq
N
 
H
K    :
N Exit the program
 
W
H
CLEFT
K/
CRIGHT
W

K:
N Change your text color 
H
K..
N see
H
K:
N 
H/
Chelp
N 
Hnick
 
W
H
CCTRL
K+
CD
N

H
K:
N Clear the input line
-
NFor a list of additional 
HSERVER
N commands, see 
H/
Cquote
N 
Hhelp
+
W
H/
Chelp
N

H
K:
N Shows this help list 
H
K....
N see
H
K:
N 
H/
Chelp
N 
Hmore
\ No newline at end of file
+
NFor a list of additional 
HSERVER
N commands, see 
H/
Cquote
N 
Hhelp 
Nor 
H/
C?
\ No newline at end of file

xtrn/mrc/mrc-help-more.msg

+
N
B
H__[ 
H
WList of additional commands
N: 
B
H]____________________________
+
W
H/
Cscroll_nicks
N  
H
K:
N Scroll the nicklist
+
W
H/
Ctoggle_nicks
N  
H
K:
N Show/hide the nicklist
+
W
H/
Ctoggle_stats
N  
H
K:
N Toggle MRC stats view

xtrn/mrc/mrc-help-twit.msg

-
N
B__[ 
H
WHow to use the twit list
N: 
B]_______________________________
+
N
B
H__[ 
H
WHow to use the twit list
N: 
B]
H_______________________________
 
-
N Basic twit list implemented! Hides messages from problematic 
-
N chatters.
+
N The 
Htwit list 
Nhides messages from problematic chatters.
 
 
N Usage:
    
W
H/
Ctwit 
N
Hadd 
H
Bnameoftwit 
K:
W 
NFilters out nameoftwit's messages
    
W
H/
Ctwit 
N
Hdel 
H
Bnameoftwit 
K:
W 
Nnameoftwit's messages are re-allowed
-   
W
H/
Ctwit 
N
Hlist           
K:
W 
NLists twits the user has added
-   
W
H/
Ctwit 
N
Hclear          
K:
W 
NEmpty's the user's twit list
+   
W
H/
Ctwit 
N
Hlist           
K:
W 
NLists twits you have added
+   
W
H/
Ctwit 
N
Hclear          
K:
W 
NEmpties your twit list

xtrn/mrc/mrc-session.js

@@ -4,6 +4,9 @@
 // See mrc-client.js for a bad example.
 function MRC_Session(host, port, user, pass, alias) {
     
+    const MRC_VER = "Multi Relay Chat JS v1.3.3 2025-04-11 [cf]";
+    const CTCP_ROOM = "ctcp_echo_channel";
+    
     const handle = new Socket();
 
     const state = {
@@ -19,7 +22,8 @@ function MRC_Session(host, port, user, pass, alias) {
         latency: '-',
         msg_color: 7,
         twit_list: [],
-        last_private_msg_from: ""
+        last_private_msg_from: "",
+        show_ctcp_req: true
     };
 
     const callbacks = {
@@ -51,6 +55,63 @@ function MRC_Session(host, port, user, pass, alias) {
         }
     }
     
+    function send_ctcp(to, p, s) {       
+        state.output_buffer.push({
+            from_room: CTCP_ROOM,
+            to_user: to,
+            to_site: "",
+            to_room: CTCP_ROOM,
+            body: p + " " + user + " " + s
+        });        
+        mswait(20);
+    }
+    
+    function ctcp_time(d) {
+        return format("%02d/%02d/%02d %02d:%02d", d.getMonth()+1, d.getDate(), d.getFullYear().toString().substr(-2), d.getHours(), d.getMinutes());        
+    }
+    
+    function ctcp_reply(cmd) {
+        // Future ctcp commands can be added easily by adding another
+        // string to this array, and then adding the response logic 
+        // to the switch/case structure below.
+        const CTCP_CMDS = [
+            /* 0 */ "VERSION",    
+            /* 1 */ "TIME", 
+            /* 2 */ "PING", 
+            /* 3 */ "CLIENTINFO"
+        ];
+        var reply = "";
+        switch (CTCP_CMDS.indexOf(cmd)) {
+            case 0:
+                reply = MRC_VER;
+                break;
+            case 1:
+                reply = ctcp_time(new Date());
+                break;
+            case 2:
+                // It's not clear what's supposed to be happening here.
+                // In the mystic client, PING returns the message string minus
+                // the sum of the length of the substrings within the string...
+                // which is an empty string... i.e.: no response
+                //
+                // According to https://en.wikipedia.org/wiki/Client-to-client_protocol#PING,
+                // it's /supposed/ to be the latency between two clients, 
+                // not taking the server into account. Such communication 
+                // within MRC does not presently exist.
+                //
+                // So for now, we're just going to return a "PONG" in response.
+                reply = "PONG";
+                break;
+            case 3:
+                reply = CTCP_CMDS.join(" ");
+                break;    
+            default:
+                reply = "Unsupported ctcp command";
+                break;                    
+        }
+        return reply.trim();
+    }
+
     function emit() {
         if (!Array.isArray(callbacks[arguments[0]])) return;
         const rest = Array.prototype.slice.call(arguments, 1);
@@ -129,6 +190,24 @@ function MRC_Session(host, port, user, pass, alias) {
             }*/
             emit('message', msg);
         }
+        if (msg.to_room === CTCP_ROOM) {
+                        
+            const ctcp_data = msg.body.split(' ');
+            if (ctcp_data[0] === "[CTCP]" && ctcp_data.length >= 4) {
+                
+                if (state.show_ctcp_req) {
+                    emit('ctcp-msg', '* |14[CTCP-REQUEST] |15' + ctcp_data[3] + ' |07on |15' + ctcp_data[2] + ' |07from |10' + msg.from_user);
+                }
+                if (ctcp_data[2] === "*" || ctcp_data[2].toUpperCase()===user.toUpperCase() || ctcp_data[2].toUpperCase()==="#"+state.room.toUpperCase() ) {
+                    send_ctcp(ctcp_data[1], "[CTCP-REPLY]", ctcp_data[3].toUpperCase() + " " + ctcp_reply(ctcp_data[3].toUpperCase()) );
+                }
+                
+            } else if (ctcp_data[0] === "[CTCP-REPLY]" && ctcp_data.length >= 3) {
+                if (msg.to_user.toUpperCase()===user.toUpperCase()) {
+                    emit('ctcp-msg', '* |14[CTCP-REPLY] |10' + ctcp_data[1] + ' |15' + ctcp_data.slice(2).join(' ').trim());
+                }
+            }
+        }        
     }
 
     this.send_room_message = function (msg) {
@@ -139,6 +218,10 @@ function MRC_Session(host, port, user, pass, alias) {
         send("NOTME", "", "", msg);
     }
     
+    this.send_action = function (msg) {
+        send("", "", state.room, msg);
+    }
+
     this.send_private_messsage = function (user, msg) {
         msg = '|11(|03Private|11)|07 ' + msg;
         send_message(user, state.room, msg);
@@ -243,6 +326,17 @@ function MRC_Session(host, port, user, pass, alias) {
                 this.send_command('USERLIST', 'ALL');
             }
         },
+        j: { // shorthand for join 
+            // TODO: is there an easier way to duplicate command functionality?
+            //help: 'Move to a new room: /join room_name',
+            callback: function (str) { // validate valid room name?
+                str = str.replace(/^#/, '');                
+                this.send_command(format('NEWROOM:%s:%s', state.room, str));
+                state.room = str;
+                state.nicks = [];
+                this.send_command('USERLIST', 'ALL');
+            }
+        },
         motd: {
             //help: 'Display the Message of the Day'
         },
@@ -255,7 +349,8 @@ function MRC_Session(host, port, user, pass, alias) {
                 }
             }
         },
-        t: {
+        t: { // shorthand for msg
+            // TODO: is there an easier way to duplicate command functionality?
             //help: 'Send a private message: /t nick message goes here',
             callback: function (str) {
                 const cmd = str.split(' ');
@@ -263,6 +358,7 @@ function MRC_Session(host, port, user, pass, alias) {
                     this.send_private_messsage(cmd[0], cmd.slice(1).join(' '));
                 }
             }
+            
         },
         r: {
             //help: 'Reply to last private message: /r message goes here',
@@ -285,6 +381,14 @@ function MRC_Session(host, port, user, pass, alias) {
                 handle.close();
             }
         },
+        q: { // shorthand for quit
+            // TODO: is there an easier way to duplicate command functionality?
+            //help: 'Quit the program',
+            callback: function () {
+                emit('disconnect');
+                handle.close();
+            }
+        },
         rooms: {
             //help: 'List available rooms',
             command: 'LIST'
@@ -298,6 +402,31 @@ function MRC_Session(host, port, user, pass, alias) {
             callback: function (str) {
                 this.send_command(format('NEWTOPIC:%s:%s', state.room, str));
             }
+        },
+        me: {
+            //me: 'Send an action to the server',
+            callback: function (str) {
+                this.send_action('|15* |13' + user + ' ' + str);
+            }
+        },
+        ctcp: {
+            // outgoing ctcp request            
+            callback: function (str) {                
+                const cmd = str.split(' ');
+                var u = cmd[0];
+                if (u) {
+                    if (u === "*" || u.indexOf("#") === 0) {
+                        u = "";
+                    }
+                    send_ctcp(u, '[CTCP]', str.trim().toUpperCase());
+                } 
+            }     
+        },
+        toggle_ctcp: {
+            callback: function() {
+                state.show_ctcp_req = !state.show_ctcp_req;
+                emit('ctcp-msg', '* |14Incoming CTCP requests are now ' + (state.show_ctcp_req ? "|15shown" : "|12hidden") + '.');
+            }
         }
     };