Merge pull request #10 from ncmud/mxp-parity

MXP negotiation parity: C, Kotlin, and Swift client

Author: powerje

Sources/SwiftMTHClient/TelnetClientSession.swift

@@ -24,6 +24,7 @@ public final class TelnetClientSession {
     public private(set) var gmcpEnabled: Bool = false
     public private(set) var msdpEnabled: Bool = false
     public private(set) var msspEnabled: Bool = false
+    public private(set) var mxpEnabled: Bool = false
 
     // MARK: - Private State
 
@@ -188,6 +189,10 @@ public final class TelnetClientSession {
             TeloptPattern(pattern: [TC.IAC, TC.SB, TO.GMCP],
                           handler: { s, src, i, n in s.processSbGmcp(src, at: i, srclen: n) }),
 
+            // MXP — accept the server's offer so it may send MXP markup.
+            TeloptPattern(pattern: [TC.IAC, TC.WILL, TO.MXP],
+                          handler: { s, _, _, _ in s.processWillMxp(); return 3 }),
+
             // MSDP
             TeloptPattern(pattern: [TC.IAC, TC.WILL, TO.MSDP],
                           handler: { s, _, _, _ in s.processWillMsdp(); return 3 }),
@@ -314,6 +319,14 @@ public final class TelnetClientSession {
         delegate?.onGMCPNegotiated()
     }
 
+    // MARK: - Handler: MXP
+
+    private func processWillMxp() {
+        mxpEnabled = true
+        serverOptions.insert(TO.MXP)
+        write([TC.IAC, TC.DO, TO.MXP])
+    }
+
     private func processSbGmcp(_ src: [UInt8], at offset: Int, srclen: Int) -> Int {
         let sbLen = skipSB(src, at: offset, srclen: srclen)
         if sbLen > srclen { return srclen + 1 }

Sources/cmth/mth.c

@@ -180,7 +180,7 @@ struct telnet_type telnet_table[] =
 	{    "88",                    0 },
 	{    "89",                    0 },
 	{    "MSP",                   0 },
-	{    "MXP",                   0 },
+	{    "MXP",                   ANNOUNCE_WILL },
 	{    "MSP2",                  0 }, /* Unadopted */
 	{    "ZMP",                   0 }, /* Unadopted */
 	{    "94",                    0 },

Sources/cmth/mth.h

@@ -62,6 +62,7 @@ typedef struct descriptor_data    DESCRIPTOR_DATA;
 #define COMM_FLAG_256COLORS     BV06
 #define COMM_FLAG_UTF8          BV07
 #define COMM_FLAG_GMCP          BV08
+#define COMM_FLAG_MXP           BV09
 
 #define MSDP_FLAG_COMMAND       BV01
 #define MSDP_FLAG_LIST          BV02

Sources/cmth/telopt.c

@@ -21,6 +21,8 @@ int         process_do_msdp          ( DESCRIPTOR_DATA *d, unsigned char *src, i
 int         process_sb_msdp          ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
 int         process_do_gmcp          ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
 int         process_sb_gmcp          ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
+int         process_do_mxp           ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
+int         process_dont_mxp         ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
 int         process_do_mccp2         ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
 int         process_dont_mccp2       ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
 int         skip_sb                  ( DESCRIPTOR_DATA *d, unsigned char *src, int srclen );
@@ -67,6 +69,9 @@ const struct telopt_type telopt_table [] =
 	{ 3, (unsigned char []) { IAC, DO,   TELOPT_GMCP, 0 },                      &process_do_gmcp},
 	{ 3, (unsigned char []) { IAC, SB,   TELOPT_GMCP, 0 },                      &process_sb_gmcp},
 
+	{ 3, (unsigned char []) { IAC, DO,   TELOPT_MXP, 0 },                       &process_do_mxp},
+	{ 3, (unsigned char []) { IAC, DONT, TELOPT_MXP, 0 },                       &process_dont_mxp},
+
 	{ 3, (unsigned char []) { IAC, DO,   TELOPT_MCCP2, 0 },                     &process_do_mccp2},
 	{ 3, (unsigned char []) { IAC, DONT, TELOPT_MCCP2, 0 },                     &process_dont_mccp2},
 
@@ -863,6 +868,32 @@ int process_sb_msdp( DESCRIPTOR_DATA *d, unsigned char *src, int srclen )
 	return i + 1;
 }
 
+// MXP
+
+int process_do_mxp( DESCRIPTOR_DATA *d, unsigned char *src, int srclen )
+{
+	if (HAS_BIT(d->mth->comm_flags, COMM_FLAG_MXP))
+	{
+		return 3;
+	}
+
+	SET_BIT(d->mth->comm_flags, COMM_FLAG_MXP);
+
+	/* ESC[7z — Lock Locked: make "locked" the persistent default line mode, so
+	   normal output is never parsed as MXP markup. Links opt back in per-span. */
+	descriptor_printf(d, "\033[7z");
+	log_descriptor_printf(d, "INFO MXP ENABLED");
+
+	return 3;
+}
+
+int process_dont_mxp( DESCRIPTOR_DATA *d, unsigned char *src, int srclen )
+{
+	DEL_BIT(d->mth->comm_flags, COMM_FLAG_MXP);
+
+	return 3;
+}
+
 // MSDP over GMCP
 
 int process_do_gmcp( DESCRIPTOR_DATA *d, unsigned char *src, int srclen )

Tests/MTHTests/TelnetClientSessionTests.swift

@@ -57,6 +57,14 @@ struct TelnetClientSessionTests {
         #expect(out == input)
     }
 
+    @Test func mxpWillIsAcceptedWithDo() {
+        let (s, d) = makeSession()
+        #expect(!s.mxpEnabled)
+        _ = s.processInput([TC.IAC, TC.WILL, TO.MXP])
+        #expect(s.mxpEnabled)
+        #expect(d.allWrittenBytes.containsSequence([TC.IAC, TC.DO, TO.MXP]))
+    }
+
     @Test func emptyInput() {
         let (s, _) = makeSession()
         let out = s.processInput([])

kotlin/mth-core/src/main/kotlin/mth/core/AnnounceFlags.kt

@@ -32,6 +32,6 @@ val defaultTelnetTable: List<TelnetOptionEntry> = buildList {
     this[86] = TelnetOptionEntry("MCCP2", AnnounceFlags.WILL)
     this[87] = TelnetOptionEntry("MCCP3", AnnounceFlags.WILL)
     this[90] = TelnetOptionEntry("MSP", AnnounceFlags.WILL)
-    this[91] = TelnetOptionEntry("MXP")
+    this[91] = TelnetOptionEntry("MXP", AnnounceFlags.WILL)
     this[201] = TelnetOptionEntry("GMCP", AnnounceFlags.WILL)
 }

kotlin/mth-core/src/main/kotlin/mth/core/CommFlags.kt

@@ -16,5 +16,6 @@ value class CommFlags(val rawValue: Int = 0) {
         val COLORS_256 = CommFlags(1 shl 5)
         val UTF8 = CommFlags(1 shl 6)
         val GMCP = CommFlags(1 shl 7)
+        val MXP = CommFlags(1 shl 8)
     }
 }

kotlin/mth-core/src/main/kotlin/mth/core/client/TelnetClientSession.kt

@@ -39,6 +39,10 @@ class TelnetClientSession(
     var msspEnabled: Boolean = false
         private set
 
+    /** Whether MXP has been negotiated. */
+    var mxpEnabled: Boolean = false
+        private set
+
     // -- Private State --
 
     /** Buffer for incomplete telnet sequences (packet fragmentation). */
@@ -230,6 +234,10 @@ class TelnetClientSession(
             TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.GMCP))
                 { s, src, i, n -> s.processSbGmcp(src, i, n) },
 
+            // Server offers MXP — accept so it may send MXP markup.
+            TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.MXP))
+                { s, _, _, _ -> s.processWillMxp(); 3 },
+
             // Server offers MCCP2
             TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.MCCP2))
                 { s, _, _, _ -> s.processWillMccp2(); 3 },
@@ -346,6 +354,12 @@ class TelnetClientSession(
         delegate?.onGMCPNegotiated()
     }
 
+    private fun processWillMxp() {
+        mxpEnabled = true
+        serverOptions.add(TO.MXP)
+        write(byteArrayOf(TC.IAC, TC.DO, TO.MXP))
+    }
+
     private fun processSbGmcp(src: ByteArray, offset: Int, srclen: Int): Int {
         val sbLen = skipSB(src, offset, srclen)
         if (sbLen > srclen) return srclen + 1

kotlin/mth-core/src/main/kotlin/mth/core/server/TelnetSession.kt

@@ -113,6 +113,14 @@ class TelnetSession(
         write(byteArrayOf(TC.IAC, TC.WILL, TO.GMCP))
     }
 
+    /** Whether the client negotiated MXP (telnet option 91). */
+    val mxpEnabled: Boolean get() = CommFlags.MXP in commFlags
+
+    /** Re-assert the locked-default MXP line mode after a copyover restore. */
+    fun reassertMXP() {
+        if (CommFlags.MXP in commFlags) write(MXP_LOCKED_DEFAULT)
+    }
+
     /** Send echo-off (password mode). */
     fun sendEchoOff() {
         commFlags = commFlags.insert(CommFlags.PASSWORD)
@@ -342,6 +350,11 @@ class TelnetSession(
             TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.GMCP))
                 { s, src, i, n -> s.processSbGmcp(src, i, n) },
 
+            TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.MXP))
+                { s, _, _, _ -> s.processDoMxp(); 3 },
+            TeloptPattern(byteArrayOf(TC.IAC, TC.DONT, TO.MXP))
+                { s, _, _, _ -> s.processDontMxp(); 3 },
+
             // MCCP2
             TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.MCCP2))
                 { s, _, _, _ -> s.processDoMccp2(); 3 },
@@ -728,6 +741,19 @@ class TelnetSession(
         return sbLen
     }
 
+    // -- Handler: MXP --
+
+    private fun processDoMxp() {
+        if (CommFlags.MXP in commFlags) return
+        commFlags = commFlags.insert(CommFlags.MXP)
+        write(MXP_LOCKED_DEFAULT)
+        log("INFO MXP ENABLED")
+    }
+
+    private fun processDontMxp() {
+        commFlags = commFlags.remove(CommFlags.MXP)
+    }
+
     // -- Handler: GMCP --
 
     private fun processDoGmcp() {
@@ -857,4 +883,10 @@ class TelnetSession(
         log("MCCP3: COMPRESSION END")
         mccp3 = null
     }
+
+    private companion object {
+        // ESC[7z — Lock Locked: makes "locked" the persistent default line mode so normal
+        // output is never parsed as MXP markup; links opt back in per-span with ESC[1z…ESC[2z.
+        val MXP_LOCKED_DEFAULT = byteArrayOf(0x1B, 0x5B, 0x37, 0x7A)
+    }
 }

kotlin/mth-core/src/test/kotlin/mth/core/client/TelnetClientSessionTest.kt

@@ -124,6 +124,14 @@ class TelnetClientSessionTest {
         assertContentEquals(byteArrayOf(IAC, DO, GMCP), d.allWrittenBytes)
     }
 
+    @Test fun serverWillMxpRespondsDoMxp() {
+        val (s, d) = makeSession()
+        assertFalse(s.mxpEnabled)
+        s.processInput(bytes(0xFF, 0xFB, 91))
+        assertTrue(s.mxpEnabled)
+        assertContentEquals(bytes(0xFF, 0xFD, 91), d.allWrittenBytes)
+    }
+
     @Test fun serverSendsGmcpDataParsed() {
         val (s, d) = makeSession()
         s.processInput(byteArrayOf(IAC, WILL, GMCP))