diff --git a/.github/workflows/kotlin.yml b/.github/workflows/kotlin.yml new file mode 100644 index 0000000..d9de9f8 --- /dev/null +++ b/.github/workflows/kotlin.yml @@ -0,0 +1,25 @@ +name: Kotlin + +on: + push: + branches: [ "trunk" ] + pull_request: + branches: [ "trunk" ] + +jobs: + build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: kotlin + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: 17 + - uses: gradle/actions/setup-gradle@v4 + - name: Build + run: ./gradlew build + - name: Test + run: ./gradlew test diff --git a/.gitignore b/.gitignore index 5d911a5..aab9b8d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ *.o .swiftpm +kotlin/.gradle/ +kotlin/**/build/ diff --git a/README.md b/README.md index 939eca5..483541d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -[![C CI](https://github.com/ncmud/mth/actions/workflows/c.yml/badge.svg)](https://github.com/ncmud/mth/actions/workflows/c.yml) [![Swift](https://github.com/ncmud/mth/actions/workflows/swift.yml/badge.svg)](https://github.com/ncmud/mth/actions/workflows/swift.yml) +[![C CI](https://github.com/ncmud/mth/actions/workflows/c.yml/badge.svg)](https://github.com/ncmud/mth/actions/workflows/c.yml) [![Swift](https://github.com/ncmud/mth/actions/workflows/swift.yml/badge.svg)](https://github.com/ncmud/mth/actions/workflows/swift.yml) [![Kotlin](https://github.com/ncmud/mth/actions/workflows/kotlin.yml/badge.svg)](https://github.com/ncmud/mth/actions/workflows/kotlin.yml) # MTH (Mud Telopt Handler) -A Swift library for handling telnet option negotiation in MUD servers. Supports the following telnet options: +A library for handling telnet option negotiation in MUD servers and clients. Available in C, Swift, and Kotlin. Supports the following telnet options: ``` CHARSET - Reports the character sets supported by the client. @@ -19,9 +19,9 @@ NEW_ENVIRON - Reports various system variables. TTYPE - Reports the client's terminal type. ``` -Also includes `MTHColor`, a color code substitution library supporting ANSI-16, xterm-256, and true color output. +Also includes color code substitution supporting ANSI-16, xterm-256, and true color output. -## Usage +## Swift Usage Add the dependency to your `Package.swift`: @@ -41,7 +41,7 @@ Then add the libraries you need: ), ``` -### TelnetSession +### Server-Side TelnetSession ```swift import MTH @@ -84,9 +84,101 @@ import MTHColor let output = substituteColor("^RBold Red ^ggreen^x", depth: .trueColor) ``` +## Kotlin Usage + +The Kotlin package provides both server-side and client-side telnet handling. Add the dependency via a Gradle composite build or git submodule: + +```kotlin +// settings.gradle.kts +includeBuild("path/to/mth/kotlin") { + dependencySubstitution { + substitute(module("mth:mth-core")).using(project(":mth-core")) + substitute(module("mth:mth-color")).using(project(":mth-color")) + } +} +``` + +```kotlin +// build.gradle.kts +dependencies { + implementation("mth:mth-core") // telnet protocol handling + implementation("mth:mth-color") // color substitution +} +``` + +### Client-Side (for MUD clients like Android apps) + +The client session handles the inverse of server-side negotiation: it receives WILL/DO from the server and responds appropriately. + +```kotlin +import mth.core.client.TelnetClientDelegate +import mth.core.client.TelnetClientSession + +class MyConnection : TelnetClientDelegate { + val session = TelnetClientSession( + delegate = this, + terminalType = "MyMudClient", + windowWidth = 80, + windowHeight = 24 + ) + + override fun write(data: ByteArray) { + socket.write(data) // send to server + } + + override fun onLocalEchoChanged(enabled: Boolean) { + // toggle local echo (e.g. hide password input) + } + + override fun onGMCPReceived(module: String, json: String) { + // handle GMCP data from server (e.g. "Char.Vitals" with HP/mana JSON) + } + + override fun onMSDPVariable(name: String, value: String) { + // handle MSDP variable updates from server + } + + override fun onPromptReceived() { + // server sent EOR/GA — mark prompt boundary + } + + fun onDataReceived(raw: ByteArray) { + val displayText = session.processInput(raw) + // displayText is clean text with all telnet sequences stripped + terminal.append(displayText) + } + + fun onWindowResized(cols: Int, rows: Int) { + session.sendWindowSize(cols, rows) + } +} +``` + +### Server-Side (for MUD servers) + +```kotlin +import mth.core.server.TelnetSession +import mth.core.server.TelnetSessionDelegate + +class MyServerConnection : TelnetSessionDelegate { + val session = TelnetSession(delegate = this) + + init { session.announceSupport() } + + override fun telnetSessionWrite(session: TelnetSession, data: ByteArray) { + socket.write(data) + } + + fun onDataReceived(raw: ByteArray) { + val clean = session.processInput(raw) + } +} +``` + ## Platforms -macOS, Linux, and Windows. MCCP2/MCCP3 compression requires system zlib (present in macOS SDK and as a Swift toolchain dependency on Linux). On Windows, the library builds and runs without compression support — MCCP is compiled out and all other telnet options work normally. +- **Swift:** macOS, Linux, Windows. MCCP2/3 requires system zlib (present in macOS SDK and as a Swift toolchain dependency on Linux). On Windows, compression is compiled out; all other options work normally. +- **Kotlin/JVM:** Any platform with JDK 17+. MCCP2 uses `java.util.zip`. ## License diff --git a/kotlin/build.gradle.kts b/kotlin/build.gradle.kts new file mode 100644 index 0000000..f3136aa --- /dev/null +++ b/kotlin/build.gradle.kts @@ -0,0 +1,3 @@ +plugins { + alias(libs.plugins.kotlin.jvm) apply false +} diff --git a/kotlin/gradle.properties b/kotlin/gradle.properties new file mode 100644 index 0000000..7fc6f1f --- /dev/null +++ b/kotlin/gradle.properties @@ -0,0 +1 @@ +kotlin.code.style=official diff --git a/kotlin/gradle/libs.versions.toml b/kotlin/gradle/libs.versions.toml new file mode 100644 index 0000000..5196782 --- /dev/null +++ b/kotlin/gradle/libs.versions.toml @@ -0,0 +1,5 @@ +[versions] +kotlin = "2.3.10" + +[plugins] +kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" } diff --git a/kotlin/gradle/wrapper/gradle-wrapper.jar b/kotlin/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..a4b76b9 Binary files /dev/null and b/kotlin/gradle/wrapper/gradle-wrapper.jar differ diff --git a/kotlin/gradle/wrapper/gradle-wrapper.properties b/kotlin/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..dbc3ce4 --- /dev/null +++ b/kotlin/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/kotlin/gradlew b/kotlin/gradlew new file mode 100755 index 0000000..f5feea6 --- /dev/null +++ b/kotlin/gradlew @@ -0,0 +1,252 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/kotlin/gradlew.bat b/kotlin/gradlew.bat new file mode 100644 index 0000000..9b42019 --- /dev/null +++ b/kotlin/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/kotlin/mth-color/build.gradle.kts b/kotlin/mth-color/build.gradle.kts new file mode 100644 index 0000000..16be88f --- /dev/null +++ b/kotlin/mth-color/build.gradle.kts @@ -0,0 +1,11 @@ +plugins { + alias(libs.plugins.kotlin.jvm) +} + +dependencies { + testImplementation(kotlin("test")) +} + +tasks.test { + useJUnitPlatform() +} diff --git a/kotlin/mth-color/src/main/kotlin/mth/color/ColorDepth.kt b/kotlin/mth-color/src/main/kotlin/mth/color/ColorDepth.kt new file mode 100644 index 0000000..7311a95 --- /dev/null +++ b/kotlin/mth-color/src/main/kotlin/mth/color/ColorDepth.kt @@ -0,0 +1,8 @@ +package mth.color + +enum class ColorDepth(val colors: Int) { + NONE(0), + ANSI16(16), + XTERM256(256), + TRUE_COLOR(4096) +} diff --git a/kotlin/mth-color/src/main/kotlin/mth/color/ColorSubstitution.kt b/kotlin/mth-color/src/main/kotlin/mth/color/ColorSubstitution.kt new file mode 100644 index 0000000..4e69bc7 --- /dev/null +++ b/kotlin/mth-color/src/main/kotlin/mth/color/ColorSubstitution.kt @@ -0,0 +1,203 @@ +package mth.color + +import kotlin.random.Random + +fun substituteColor(input: String, depth: ColorDepth): String { + val bytes = input.toByteArray(Charsets.UTF_8) + 0.toByte() // null terminator + val output = mutableListOf() + substituteColorBytes(bytes, output, depth.colors) + return String(output.toByteArray(), Charsets.UTF_8) +} + +private fun substituteColorBytes(input: ByteArray, output: MutableList, colors: Int): Int { + val startCount = output.size + val oldF = ByteArray(7) // tracks last foreground code + val oldB = ByteArray(7) // tracks last background code + var i = 0 + + while (i < input.size && input[i] != 0.toByte()) { + val c = input[i].toInt() and 0xFF + + when (c) { + '^'.code -> { + val next = if (i + 1 < input.size) input[i + 1] else 0.toByte() + if (ColorTables.is32c(next) != 0) { + // Skip pattern: ^r^^g skips ^r, processes ^g + if (i + 3 < input.size && + input[i + 2] == '^'.code.toByte() && + ColorTables.is32c(input[i + 3]) != 0 + ) { + i += 2 + continue + } + + if (colors != 0) { + val nextUnsigned = next.toInt() and 0xFF + if (nextUnsigned == '?'.code) { + // Random color + val rndCode = randomTrueColorCode() + val rndBytes = rndCode.toByteArray(Charsets.UTF_8) + 0.toByte() + substituteColorBytes(rndBytes, output, colors) + } else if (oldF[0] != input[i] || oldF[1] != next) { + // Different from last foreground -- emit ANSI + if (nextUnsigned in 'a'.code..'z'.code) { + val idx = nextUnsigned - 'a'.code + val expanded = ColorTables.alphabetFgcDark[idx] + val expandedBytes = expanded.toByteArray(Charsets.UTF_8) + 0.toByte() + val cappedColors = if (colors < 256) colors else 256 + substituteColorBytes(expandedBytes, output, cappedColors) + } else { + val idx = nextUnsigned - 'A'.code + val expanded = ColorTables.alphabetFgcBold[idx] + val expandedBytes = expanded.toByteArray(Charsets.UTF_8) + 0.toByte() + val cappedColors = if (colors < 256) colors else 256 + substituteColorBytes(expandedBytes, output, cappedColors) + } + } + } + // Update oldF + oldF[0] = input[i] + oldF[1] = next + i += 2 + } else { + if ((next.toInt() and 0xFF) == '^'.code) { + // ^^ escape -- skip first ^, output second + i += 1 + } + output.add(input[i]) + i += 1 + } + } + + '<'.code -> { + if (matchesForegroundCode(input, i)) { + val c2 = input[i + 2] + val c3 = input[i + 3] + val c4 = input[i + 4] + val normalized = normalizedFCode(c2, c3, c4) + + if (!caseInsensitiveMatch6(oldF, input, i) && colors != 0) { + if (colors == 4096) { + val r = ColorTables.tcVal(c2) + val g = ColorTables.tcVal(c3) + val b = ColorTables.tcVal(c4) + appendString(output, "\u001B[38;2;${r};${g};${b}m") + } else if (colors == 256) { + val idx = 16 + ColorTables.x256cVal(c2) * 36 + ColorTables.x256cVal(c3) * 6 + ColorTables.x256cVal(c4) + appendString(output, "\u001B[38;5;${idx}m") + } else { + // 16 colors -- recurse through ANSI table + val idx = 16 + ColorTables.x256cVal(c2) * 36 + ColorTables.x256cVal(c3) * 6 + ColorTables.x256cVal(c4) + val ansi = ColorTables.ansiForeground[idx] + val ansiBytes = ansi.toByteArray(Charsets.UTF_8) + 0.toByte() + substituteColorBytes(ansiBytes, output, colors) + } + } + for (j in 0 until 6) oldF[j] = normalized[j] + i += 6 + } else if (matchesBackgroundCode(input, i)) { + val c2 = input[i + 2] + val c3 = input[i + 3] + val c4 = input[i + 4] + val normalized = normalizedFCode(c2, c3, c4) // C uses F for both + + if (!caseInsensitiveMatch6(oldB, input, i) && colors != 0) { + if (colors == 4096) { + val r = ColorTables.tcVal(c2) + val g = ColorTables.tcVal(c3) + val b = ColorTables.tcVal(c4) + appendString(output, "\u001B[48;2;${r};${g};${b}m") + } else if (colors == 256) { + val idx = 16 + ColorTables.x256cVal(c2) * 36 + ColorTables.x256cVal(c3) * 6 + ColorTables.x256cVal(c4) + appendString(output, "\u001B[48;5;${idx}m") + } else { + val idx = 16 + ColorTables.x256cVal(c2) * 36 + ColorTables.x256cVal(c3) * 6 + ColorTables.x256cVal(c4) + val ansi = ColorTables.ansiBackground[idx] + val ansiBytes = ansi.toByteArray(Charsets.UTF_8) + 0.toByte() + substituteColorBytes(ansiBytes, output, colors) + } + } + for (j in 0 until 6) oldB[j] = normalized[j] + i += 6 + } else { + output.add(input[i]) + i += 1 + } + } + + else -> { + output.add(input[i]) + i += 1 + } + } + } + + return output.size - startCount +} + +private fun isHexDigit(c: Byte): Boolean { + val v = c.toInt() and 0xFF + return v in '0'.code..'9'.code || v in 'A'.code..'F'.code || v in 'a'.code..'f'.code +} + +private fun toUpper(c: Byte): Byte { + val v = c.toInt() and 0xFF + return if (v in 'a'.code..'z'.code) (v - 32).toByte() else c +} + +private fun matchesForegroundCode(input: ByteArray, at: Int): Boolean { + if (at + 5 >= input.size) return false + if ((input[at].toInt() and 0xFF) != '<'.code) return false + val tag = input[at + 1].toInt() and 0xFF + if (tag != 'F'.code && tag != 'f'.code) return false + if (!isHexDigit(input[at + 2])) return false + if (!isHexDigit(input[at + 3])) return false + if (!isHexDigit(input[at + 4])) return false + if ((input[at + 5].toInt() and 0xFF) != '>'.code) return false + return true +} + +private fun matchesBackgroundCode(input: ByteArray, at: Int): Boolean { + if (at + 5 >= input.size) return false + if ((input[at].toInt() and 0xFF) != '<'.code) return false + val tag = input[at + 1].toInt() and 0xFF + if (tag != 'B'.code && tag != 'b'.code) return false + if (!isHexDigit(input[at + 2])) return false + if (!isHexDigit(input[at + 3])) return false + if (!isHexDigit(input[at + 4])) return false + if ((input[at + 5].toInt() and 0xFF) != '>'.code) return false + return true +} + +private fun normalizedFCode(c2: Byte, c3: Byte, c4: Byte): ByteArray { + return byteArrayOf( + '<'.code.toByte(), + 'F'.code.toByte(), + toUpper(c2), + toUpper(c3), + toUpper(c4), + '>'.code.toByte(), + 0.toByte() + ) +} + +private fun caseInsensitiveMatch6(old: ByteArray, input: ByteArray, at: Int): Boolean { + for (j in 0 until 6) { + if (at + j >= input.size) return false + if (toUpper(old[j]) != toUpper(input[at + j])) return false + } + return true +} + +private fun appendString(output: MutableList, s: String) { + for (b in s.toByteArray(Charsets.UTF_8)) { + output.add(b) + } +} + +private fun randomTrueColorCode(): String { + val r = ColorTables.decToHex[Random.nextInt(16)] + val g = ColorTables.decToHex[Random.nextInt(16)] + val b = ColorTables.decToHex[Random.nextInt(16)] + return "" +} diff --git a/kotlin/mth-color/src/main/kotlin/mth/color/ColorTables.kt b/kotlin/mth-color/src/main/kotlin/mth/color/ColorTables.kt new file mode 100644 index 0000000..c2b821f --- /dev/null +++ b/kotlin/mth-color/src/main/kotlin/mth/color/ColorTables.kt @@ -0,0 +1,167 @@ +package mth.color + +object ColorTables { + + val ansiForeground: Array = arrayOf( + // 0-15: standard + bright colors + "\u001B[22;30m", "\u001B[22;31m", "\u001B[22;32m", "\u001B[22;33m", "\u001B[22;34m", "\u001B[22;35m", "\u001B[22;36m", "\u001B[22;37m", + "\u001B[1;30m", "\u001B[1;31m", "\u001B[1;32m", "\u001B[1;33m", "\u001B[1;34m", "\u001B[1;35m", "\u001B[1;36m", "\u001B[1;37m", + + // 16-51: color cube row 0 + "\u001B[22;30m", "\u001B[22;34m", "\u001B[22;34m", "\u001B[22;34m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;32m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[22;34m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;32m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;32m", "\u001B[22;32m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[1;36m", + "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[22;36m", "\u001B[1;36m", "\u001B[1;36m", + "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;36m", "\u001B[1;36m", "\u001B[1;36m", + + // 52-87: color cube row 1 + "\u001B[22;31m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[22;34m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;33m", "\u001B[1;30m", "\u001B[22;34m", "\u001B[22;34m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;33m", "\u001B[22;32m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;32m", "\u001B[22;32m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[1;36m", + "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[22;36m", "\u001B[1;36m", "\u001B[1;36m", + "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;36m", "\u001B[1;36m", "\u001B[1;36m", + + // 88-123: color cube row 2 + "\u001B[22;31m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;33m", "\u001B[22;31m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;33m", "\u001B[22;33m", "\u001B[22;37m", "\u001B[22;34m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;33m", "\u001B[22;33m", "\u001B[22;32m", "\u001B[22;36m", "\u001B[22;36m", "\u001B[1;34m", + "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[22;36m", "\u001B[1;36m", "\u001B[1;36m", + "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;36m", "\u001B[1;36m", + + // 124-159: color cube row 3 + "\u001B[22;31m", "\u001B[22;31m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[1;35m", + "\u001B[22;31m", "\u001B[22;31m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[1;35m", + "\u001B[22;33m", "\u001B[22;33m", "\u001B[22;31m", "\u001B[22;35m", "\u001B[22;35m", "\u001B[1;34m", + "\u001B[22;33m", "\u001B[22;33m", "\u001B[22;33m", "\u001B[22;37m", "\u001B[1;34m", "\u001B[1;34m", + "\u001B[22;33m", "\u001B[22;33m", "\u001B[22;33m", "\u001B[1;32m", "\u001B[1;36m", "\u001B[1;36m", + "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;32m", "\u001B[1;32m", "\u001B[1;36m", "\u001B[1;36m", + + // 160-195: color cube row 4 + "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[22;35m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[22;35m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[22;35m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[22;33m", "\u001B[22;33m", "\u001B[22;33m", "\u001B[1;31m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;37m", "\u001B[1;37m", + "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;37m", "\u001B[1;37m", + + // 196-231: color cube row 5 + "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;35m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;35m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;31m", "\u001B[1;31m", "\u001B[1;35m", "\u001B[1;35m", + "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;37m", "\u001B[1;37m", + "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;33m", "\u001B[1;37m", "\u001B[1;37m", + + // 232-255: grayscale + "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", + "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", "\u001B[1;30m", + "\u001B[22;37m", "\u001B[22;37m", "\u001B[22;37m", "\u001B[22;37m", "\u001B[22;37m", "\u001B[22;37m", + "\u001B[1;37m", "\u001B[1;37m", "\u001B[1;37m", "\u001B[1;37m", "\u001B[1;37m", "\u001B[1;37m", + ) + + val ansiBackground: Array = arrayOf( + // 0-15 + "\u001B[40m", "\u001B[41m", "\u001B[42m", "\u001B[43m", "\u001B[44m", "\u001B[45m", "\u001B[46m", "\u001B[47m", + "\u001B[40m", "\u001B[41m", "\u001B[42m", "\u001B[43m", "\u001B[44m", "\u001B[45m", "\u001B[46m", "\u001B[47m", + + // 16-51 + "\u001B[40m", "\u001B[44m", "\u001B[44m", "\u001B[44m", "\u001B[44m", "\u001B[44m", + "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[44m", "\u001B[44m", "\u001B[44m", + "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", "\u001B[44m", "\u001B[44m", + "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", "\u001B[46m", + "\u001B[42m", "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", + "\u001B[42m", "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", + + // 52-87 + "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[44m", "\u001B[44m", "\u001B[44m", + "\u001B[43m", "\u001B[40m", "\u001B[44m", "\u001B[44m", "\u001B[44m", "\u001B[44m", + "\u001B[43m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[44m", "\u001B[44m", + "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", "\u001B[46m", + "\u001B[42m", "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", + "\u001B[42m", "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", + + // 88-123 + "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", "\u001B[44m", "\u001B[44m", + "\u001B[43m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[44m", "\u001B[44m", + "\u001B[43m", "\u001B[43m", "\u001B[47m", "\u001B[44m", "\u001B[44m", "\u001B[44m", + "\u001B[43m", "\u001B[43m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[44m", + "\u001B[42m", "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", "\u001B[46m", + "\u001B[42m", "\u001B[42m", "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", + + // 124-159 + "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", "\u001B[45m", + "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", "\u001B[45m", + "\u001B[43m", "\u001B[43m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[44m", + "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[47m", "\u001B[44m", "\u001B[44m", + "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[42m", "\u001B[46m", "\u001B[46m", + "\u001B[43m", "\u001B[43m", "\u001B[42m", "\u001B[42m", "\u001B[46m", "\u001B[46m", + + // 160-195 + "\u001B[41m", "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", + "\u001B[41m", "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", + "\u001B[41m", "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", + "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[41m", "\u001B[45m", "\u001B[45m", + "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[47m", "\u001B[47m", + "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[47m", "\u001B[47m", + + // 196-231 + "\u001B[41m", "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", + "\u001B[41m", "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", "\u001B[45m", + "\u001B[41m", "\u001B[41m", "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", + "\u001B[43m", "\u001B[43m", "\u001B[41m", "\u001B[41m", "\u001B[45m", "\u001B[45m", + "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[47m", "\u001B[47m", + "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[43m", "\u001B[47m", "\u001B[47m", + + // 232-255 + "\u001B[40m", "\u001B[40m", "\u001B[40m", "\u001B[40m", "\u001B[40m", "\u001B[40m", + "\u001B[40m", "\u001B[40m", "\u001B[40m", "\u001B[40m", "\u001B[40m", "\u001B[40m", + "\u001B[47m", "\u001B[47m", "\u001B[47m", "\u001B[47m", "\u001B[47m", "\u001B[47m", + "\u001B[47m", "\u001B[47m", "\u001B[47m", "\u001B[47m", "\u001B[47m", "\u001B[47m", + ) + + // 4096 to 256 color conversion - indexed by byte value (0-255) + val x256colorValues: IntArray = IntArray(256).also { arr -> + arr[0x30] = 0; arr[0x31] = 1; arr[0x32] = 1; arr[0x33] = 1; arr[0x34] = 1; arr[0x35] = 1 + arr[0x36] = 1; arr[0x37] = 2; arr[0x38] = 2; arr[0x39] = 3 + arr[0x41] = 3; arr[0x42] = 3; arr[0x43] = 4; arr[0x44] = 4; arr[0x45] = 4; arr[0x46] = 5 + arr[0x61] = 3; arr[0x62] = 3; arr[0x63] = 4; arr[0x64] = 4; arr[0x65] = 4; arr[0x66] = 5 + } + + // 16M to 4096 RGB component conversion - indexed by byte value + val truecolorValues: IntArray = IntArray(256).also { arr -> + arr[0x30] = 0; arr[0x31] = 17; arr[0x32] = 34; arr[0x33] = 51; arr[0x34] = 68; arr[0x35] = 85 + arr[0x36] = 102; arr[0x37] = 119; arr[0x38] = 136; arr[0x39] = 153 + arr[0x41] = 170; arr[0x42] = 187; arr[0x43] = 204; arr[0x44] = 221; arr[0x45] = 238; arr[0x46] = 255 + arr[0x61] = 170; arr[0x62] = 187; arr[0x63] = 204; arr[0x64] = 221; arr[0x65] = 238; arr[0x66] = 255 + } + + // 32 color lookup - validates if a byte is a valid 32-color code after '^' + val m32colorValues: IntArray = IntArray(256).also { arr -> + arr['?'.code] = 63 + arr['A'.code] = 65 + for (c in 'B'..'Z') arr[c.code] = 1 + arr['a'.code] = 97 + for (c in 'b'..'z') arr[c.code] = 1 + } + + // 32 to 4096 dark foreground color strings (a=0, b=1, ..., z=25) + val alphabetFgcDark: Array = arrayOf( + "", "", "", "", "", "", "", "", "", "", "", "", "", + "", "", "", "", "", "", "", "", "", "", "", "", "", + ) + + // 32 to 4096 bright foreground color strings (A=0, B=1, ..., Z=25) + val alphabetFgcBold: Array = arrayOf( + "", "", "", "", "", "", "", "", "", "", "", "", "", + "", "", "", "", "", "", "", "", "", "", "", "", "", + ) + + val decToHex: CharArray = charArrayOf('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F') + + fun x256cVal(c: Byte): Int = x256colorValues[c.toInt() and 0xFF] + fun tcVal(c: Byte): Int = truecolorValues[c.toInt() and 0xFF] + fun is32c(c: Byte): Int = m32colorValues[c.toInt() and 0xFF] +} diff --git a/kotlin/mth-color/src/test/kotlin/mth/color/ColorSubstitutionTest.kt b/kotlin/mth-color/src/test/kotlin/mth/color/ColorSubstitutionTest.kt new file mode 100644 index 0000000..5b42679 --- /dev/null +++ b/kotlin/mth-color/src/test/kotlin/mth/color/ColorSubstitutionTest.kt @@ -0,0 +1,216 @@ +package mth.color + +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertTrue + +class ColorSubstitutionTest { + + // 1. Plain text passthrough + @Test + fun plainTextPassthroughAtAllDepths() { + for (depth in ColorDepth.entries) { + assertEquals("Hello, world!", substituteColor("Hello, world!", depth)) + } + } + + // 2. Empty string + @Test + fun emptyStringReturnsEmpty() { + for (depth in ColorDepth.entries) { + assertEquals("", substituteColor("", depth)) + } + } + + // 3. Caret escape + @Test + fun caretEscapeProducesLiteralCaret() { + for (depth in ColorDepth.entries) { + assertEquals("^", substituteColor("^^", depth)) + assertEquals("foo^bar", substituteColor("foo^^bar", depth)) + assertEquals("^^", substituteColor("^^^^", depth)) + } + } + + // 4. Dark colors produce ANSI escape at non-NONE depths, stripped at NONE + // ^r -> alphabetFgcDark[17] = "" + // ANSI16: ansiForeground[124] = "\u001B[22;31m" + // XTERM256: "\u001B[38;5;124m" + // TRUE_COLOR: tcVal('b')=187, tcVal('0')=0 -> "\u001B[38;2;187;0;0m" + @Test + fun darkColorAtNone() { + assertEquals("text", substituteColor("^rtext", ColorDepth.NONE)) + } + + @Test + fun darkColorAtAnsi16() { + assertEquals("\u001B[22;31mtext", substituteColor("^rtext", ColorDepth.ANSI16)) + } + + @Test + fun darkColorAtXterm256() { + assertEquals("\u001B[38;5;124mtext", substituteColor("^rtext", ColorDepth.XTERM256)) + } + + @Test + fun darkColorAtTrueColor() { + // ^r expands to , but recursive call caps colors at 256 + assertEquals("\u001B[38;5;124mtext", substituteColor("^rtext", ColorDepth.TRUE_COLOR)) + } + + // 5. Bright colors + // ^R -> alphabetFgcBold[17] = "" + // ANSI16: ansiForeground[196] = "\u001B[1;31m" + // XTERM256: "\u001B[38;5;196m" + // TRUE_COLOR: tcVal('f')=255 -> "\u001B[38;2;255;0;0m" + @Test + fun brightColorAtNone() { + assertEquals("text", substituteColor("^Rtext", ColorDepth.NONE)) + } + + @Test + fun brightColorAtAnsi16() { + assertEquals("\u001B[1;31mtext", substituteColor("^Rtext", ColorDepth.ANSI16)) + } + + @Test + fun brightColorAtXterm256() { + assertEquals("\u001B[38;5;196mtext", substituteColor("^Rtext", ColorDepth.XTERM256)) + } + + @Test + fun brightColorAtTrueColor() { + // ^R expands to , but recursive call caps colors at 256 + assertEquals("\u001B[38;5;196mtext", substituteColor("^Rtext", ColorDepth.TRUE_COLOR)) + } + + // 6. Colors stripped at NONE + @Test + fun colorsStrippedAtNone() { + assertEquals("hello world", substituteColor("^rhello world", ColorDepth.NONE)) + } + + // 7. Repeated color suppressed -- only one ANSI code emitted + @Test + fun repeatedColorSuppressed() { + val result = substituteColor("^r^r^rred", ColorDepth.XTERM256) + assertEquals("\u001B[38;5;124mred", result) + } + + @Test + fun repeatedColorSuppressedAnsi16() { + val result = substituteColor("^r^r^rred", ColorDepth.ANSI16) + assertEquals("\u001B[22;31mred", result) + } + + @Test + fun repeatedColorSuppressedTrueColor() { + // ^r expands to , recursive call caps at 256 + val result = substituteColor("^r^r^rred", ColorDepth.TRUE_COLOR) + assertEquals("\u001B[38;5;124mred", result) + } + + // 8. Skip pattern -- ^r^g skips ^r, processes ^g + // ^g -> alphabetFgcDark[6] = "" + // XTERM256: 16 + 0*36 + 3*6 + 0 = 34 -> "\u001B[38;5;34m" + @Test + fun skipPatternSkipsFirstColor() { + val result = substituteColor("^r^gtext", ColorDepth.XTERM256) + assertEquals("\u001B[38;5;34mtext", result) + } + + @Test + fun skipPatternSkipsFirstColorAnsi16() { + // ansiForeground[34] = "\u001B[22;32m" + val result = substituteColor("^r^gtext", ColorDepth.ANSI16) + assertEquals("\u001B[22;32mtext", result) + } + + @Test + fun skipPatternSkipsFirstColorTrueColor() { + // ^g expands to , recursive call caps at 256 + val result = substituteColor("^r^gtext", ColorDepth.TRUE_COLOR) + assertEquals("\u001B[38;5;34mtext", result) + } + + // 9. True color foreground + // tcVal('8')=136, tcVal('0')=0 + @Test + fun trueColorForeground() { + assertEquals("\u001B[38;2;136;0;0mred", substituteColor("red", ColorDepth.TRUE_COLOR)) + } + + // 10. True color foreground at 256 + // 16 + x256cVal('8')*36 + 0 + 0 = 16 + 2*36 = 88 + @Test + fun trueColorForegroundAt256() { + assertEquals("\u001B[38;5;88mred", substituteColor("red", ColorDepth.XTERM256)) + } + + // 11. True color background + // at TRUE_COLOR: tcVal('0')=0, tcVal('8')=136, tcVal('0')=0 + @Test + fun trueColorBackground() { + assertEquals( + "\u001B[48;2;0;136;0mgreen bg", + substituteColor("green bg", ColorDepth.TRUE_COLOR), + ) + } + + // 12. Invalid codes passthrough + @Test + fun invalidCodesPassthrough() { + assertEquals("notcolor", substituteColor("notcolor", ColorDepth.TRUE_COLOR)) + } + + // 13. Short code passthrough + @Test + fun shortCodePassthrough() { + assertEquals("short", substituteColor("short", ColorDepth.TRUE_COLOR)) + } + + // 14. Non-FB code passthrough + @Test + fun nonFBCodePassthrough() { + assertEquals("notfb", substituteColor("notfb", ColorDepth.TRUE_COLOR)) + } + + // 15. Complex mixed + // ^W -> alphabetFgcBold[22] = "" (bright white) + // ^^ -> literal ^ + @Test + fun complexMixed() { + val result = substituteColor("^WHello, ^^world^^!", ColorDepth.ANSI16) + assertTrue(result.contains("\u001B[")) + assertTrue(result.contains("Hello, ")) + assertTrue(result.contains("^world^!")) + } + + // 16. Foreground deduplication + @Test + fun foregroundDeduplication() { + val result = substituteColor("red", ColorDepth.TRUE_COLOR) + assertEquals("\u001B[38;2;136;0;0mred", result) + } + + @Test + fun foregroundDeduplicationXterm256() { + val result = substituteColor("red", ColorDepth.XTERM256) + assertEquals("\u001B[38;5;88mred", result) + } + + // 17. Background deduplication -- normalizedFCode uses for both fg/bg, + // so oldB stores which won't match in input; both codes emitted. + // Use (lowercase) after to test case-insensitive dedup. + @Test + fun backgroundDeduplication() { + val result = substituteColor("black bg", ColorDepth.TRUE_COLOR) + assertEquals("\u001B[48;2;0;0;0m\u001B[48;2;0;0;0mblack bg", result) + } + + @Test + fun backgroundDeduplicationXterm256() { + val result = substituteColor("black bg", ColorDepth.XTERM256) + assertEquals("\u001B[48;5;16m\u001B[48;5;16mblack bg", result) + } +} diff --git a/kotlin/mth-core/build.gradle.kts b/kotlin/mth-core/build.gradle.kts new file mode 100644 index 0000000..16be88f --- /dev/null +++ b/kotlin/mth-core/build.gradle.kts @@ -0,0 +1,11 @@ +plugins { + alias(libs.plugins.kotlin.jvm) +} + +dependencies { + testImplementation(kotlin("test")) +} + +tasks.test { + useJUnitPlatform() +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/AnnounceFlags.kt b/kotlin/mth-core/src/main/kotlin/mth/core/AnnounceFlags.kt new file mode 100644 index 0000000..1f6a83a --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/AnnounceFlags.kt @@ -0,0 +1,37 @@ +package mth.core + +@JvmInline +value class AnnounceFlags(val rawValue: Int) { + operator fun contains(other: AnnounceFlags): Boolean = rawValue and other.rawValue == other.rawValue + fun isEmpty(): Boolean = rawValue == 0 + infix fun or(other: AnnounceFlags) = AnnounceFlags(rawValue or other.rawValue) + + companion object { + val NONE = AnnounceFlags(0) + val WILL = AnnounceFlags(1 shl 0) + val DO = AnnounceFlags(1 shl 1) + } +} + +data class TelnetOptionEntry( + val name: String, + val announce: AnnounceFlags = AnnounceFlags.NONE +) + +val defaultTelnetTable: List = buildList { + repeat(256) { add(TelnetOptionEntry("")) } + this[1] = TelnetOptionEntry("ECHO") + this[3] = TelnetOptionEntry("SUPPRESS GA") + this[24] = TelnetOptionEntry("TERMINAL TYPE", AnnounceFlags.DO) + this[25] = TelnetOptionEntry("EOR") + this[31] = TelnetOptionEntry("NAWS", AnnounceFlags.DO) + this[39] = TelnetOptionEntry("NEW_ENVIRON", AnnounceFlags.DO) + this[42] = TelnetOptionEntry("CHARSET", AnnounceFlags.WILL) + this[69] = TelnetOptionEntry("MSDP", AnnounceFlags.WILL) + this[70] = TelnetOptionEntry("MSSP", AnnounceFlags.WILL) + this[86] = TelnetOptionEntry("MCCP2", AnnounceFlags.WILL) + this[87] = TelnetOptionEntry("MCCP3", AnnounceFlags.WILL) + this[90] = TelnetOptionEntry("MSP", AnnounceFlags.WILL) + this[91] = TelnetOptionEntry("MXP") + this[201] = TelnetOptionEntry("GMCP", AnnounceFlags.WILL) +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/CommFlags.kt b/kotlin/mth-core/src/main/kotlin/mth/core/CommFlags.kt new file mode 100644 index 0000000..a9ac3f0 --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/CommFlags.kt @@ -0,0 +1,20 @@ +package mth.core + +@JvmInline +value class CommFlags(val rawValue: Int = 0) { + operator fun contains(flag: CommFlags): Boolean = rawValue and flag.rawValue == flag.rawValue + fun insert(flag: CommFlags) = CommFlags(rawValue or flag.rawValue) + fun remove(flag: CommFlags) = CommFlags(rawValue and flag.rawValue.inv()) + fun isEmpty(): Boolean = rawValue == 0 + + companion object { + val DISCONNECT = CommFlags(1 shl 0) + val PASSWORD = CommFlags(1 shl 1) + val REMOTE_ECHO = CommFlags(1 shl 2) + val EOR = CommFlags(1 shl 3) + val MSDP_UPDATE = CommFlags(1 shl 4) + val COLORS_256 = CommFlags(1 shl 5) + val UTF8 = CommFlags(1 shl 6) + val GMCP = CommFlags(1 shl 7) + } +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/Compression.kt b/kotlin/mth-core/src/main/kotlin/mth/core/Compression.kt new file mode 100644 index 0000000..cacd887 --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/Compression.kt @@ -0,0 +1,122 @@ +package mth.core + +import java.util.zip.Deflater +import java.util.zip.Inflater +import java.util.zip.DataFormatException + +class DeflateStream private constructor(private val deflater: Deflater) { + companion object { + fun create(): DeflateStream? { + return try { + val deflater = Deflater(Deflater.BEST_COMPRESSION) + DeflateStream(deflater) + } catch (e: Exception) { + null + } + } + } + + fun compress(input: ByteArray): ByteArray? { + return try { + deflater.setInput(input) + val output = ByteArray(input.size + 256) + val count = deflater.deflate(output, 0, output.size, Deflater.SYNC_FLUSH) + output.copyOf(count) + } catch (e: Exception) { + null + } + } + + fun finish(): ByteArray? { + return try { + deflater.finish() + val output = ByteArray(256) + val count = deflater.deflate(output) + deflater.end() + output.copyOf(count) + } catch (e: Exception) { + null + } + } +} + +data class InflateResult( + val decompressed: ByteArray, + val finished: Boolean, + val unconsumedInput: ByteArray +) { + override fun equals(other: Any?): Boolean { + if (this === other) return true + if (other !is InflateResult) return false + return decompressed.contentEquals(other.decompressed) + && finished == other.finished + && unconsumedInput.contentEquals(other.unconsumedInput) + } + + override fun hashCode(): Int { + var result = decompressed.contentHashCode() + result = 31 * result + finished.hashCode() + result = 31 * result + unconsumedInput.contentHashCode() + return result + } +} + +class InflateStream private constructor(private val inflater: Inflater) { + companion object { + fun create(): InflateStream? { + return try { + InflateStream(Inflater()) + } catch (e: Exception) { + null + } + } + } + + fun decompress(input: ByteArray): InflateResult? { + return try { + inflater.setInput(input) + var bufSize = input.size * 4 + 256 + var output = ByteArray(bufSize) + var totalProduced = 0 + + while (true) { + val count = inflater.inflate(output, totalProduced, output.size - totalProduced) + totalProduced += count + + if (inflater.finished()) { + val remaining = inflater.remaining + val unconsumed = if (remaining > 0) { + input.copyOfRange(input.size - remaining, input.size) + } else { + ByteArray(0) + } + return InflateResult(output.copyOf(totalProduced), true, unconsumed) + } + + if (count == 0) { + // No more output and not finished + if (inflater.needsInput()) { + val remaining = inflater.remaining + val unconsumed = if (remaining > 0) { + input.copyOfRange(input.size - remaining, input.size) + } else { + ByteArray(0) + } + return InflateResult(output.copyOf(totalProduced), false, unconsumed) + } + return null // error + } + + if (totalProduced >= output.size) { + bufSize *= 2 + output = output.copyOf(bufSize) + } + } + + @Suppress("UNREACHABLE_CODE") + null + } catch (e: DataFormatException) { + null + } + } +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/MSDPConverter.kt b/kotlin/mth-core/src/main/kotlin/mth/core/MSDPConverter.kt new file mode 100644 index 0000000..717b9e6 --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/MSDPConverter.kt @@ -0,0 +1,262 @@ +package mth.core + +// MSDP protocol control bytes +private const val MSDP_VAR: Byte = 1 +private const val MSDP_VAL: Byte = 2 +private const val MSDP_TABLE_OPEN: Byte = 3 +private const val MSDP_TABLE_CLOSE: Byte = 4 +private const val MSDP_ARRAY_OPEN: Byte = 5 +private const val MSDP_ARRAY_CLOSE: Byte = 6 + +// Telnet framing bytes +private const val IAC: Byte = 0xFF.toByte() // -1 signed +private const val SB: Byte = 0xFA.toByte() // -6 signed +private const val SE: Byte = 0xF0.toByte() // -16 signed +private const val TELOPT_MSDP: Byte = 69 +private const val TELOPT_GMCP: Byte = 0xC9.toByte() // 201 / -55 signed + +/** Extension to get unsigned int value of a Byte. */ +private val Byte.u: Int get() = toInt() and 0xFF + +/** + * Convert MSDP binary subnegotiation to GMCP JSON subnegotiation. + * + * Input: `IAC SB TELOPT_MSDP IAC SE` + * Output: `IAC SB TELOPT_GMCP MSDP {} IAC SE` + */ +fun msdp2json(src: ByteArray): ByteArray { + val out = mutableListOf() + val srclen = src.size + + // If MSDP framing, replace with GMCP framing + "MSDP {" + if (srclen >= 3 && src[2] == TELOPT_MSDP) { + out.add(IAC) + out.add(SB) + out.add(TELOPT_GMCP) + for (b in "MSDP {".toByteArray(Charsets.UTF_8)) { + out.add(b) + } + } + + var i = 3 + var nest = 0 + var last: Byte = 0 + + while (i < srclen) { + if (src[i] == IAC && i + 1 < srclen && src[i + 1] == SE) { + break + } + + when (src[i]) { + MSDP_TABLE_OPEN -> { + out.add('{'.code.toByte()) + nest++ + last = MSDP_TABLE_OPEN + } + MSDP_TABLE_CLOSE -> { + if (last == MSDP_VAL || last == MSDP_VAR) { + out.add('"'.code.toByte()) + } + if (nest > 0) nest-- + out.add('}'.code.toByte()) + last = MSDP_TABLE_CLOSE + } + MSDP_ARRAY_OPEN -> { + out.add('['.code.toByte()) + nest++ + last = MSDP_ARRAY_OPEN + } + MSDP_ARRAY_CLOSE -> { + if (last == MSDP_VAL || last == MSDP_VAR) { + out.add('"'.code.toByte()) + } + if (nest > 0) nest-- + out.add(']'.code.toByte()) + last = MSDP_ARRAY_CLOSE + } + MSDP_VAR -> { + if (last == MSDP_VAL || last == MSDP_VAR) { + out.add('"'.code.toByte()) + } + if (last == MSDP_VAL || last == MSDP_VAR || last == MSDP_TABLE_CLOSE || last == MSDP_ARRAY_CLOSE) { + out.add(','.code.toByte()) + } + out.add('"'.code.toByte()) + last = MSDP_VAR + } + MSDP_VAL -> { + if (last == MSDP_VAR) { + out.add('"'.code.toByte()) + out.add(':'.code.toByte()) + } + if (last == MSDP_VAL) { + out.add('"'.code.toByte()) + out.add(','.code.toByte()) + } + if (i + 1 < srclen && src[i + 1] != MSDP_TABLE_OPEN && src[i + 1] != MSDP_ARRAY_OPEN) { + out.add('"'.code.toByte()) + } + last = MSDP_VAL + } + '\\'.code.toByte() -> { + out.add('\\'.code.toByte()) + out.add('\\'.code.toByte()) + } + '"'.code.toByte() -> { + out.add('\\'.code.toByte()) + out.add('"'.code.toByte()) + } + else -> { + out.add(src[i]) + } + } + i++ + } + + // Append closing "}" and IAC SE + out.add('}'.code.toByte()) + out.add(IAC) + out.add(SE) + + return out.toByteArray() +} + +/** + * Convert GMCP JSON subnegotiation to MSDP binary subnegotiation. + * + * Input: `IAC SB TELOPT_GMCP MSDP {} IAC SE` + * Output: `IAC SB TELOPT_MSDP IAC SE` + */ +fun json2msdp(src: ByteArray): ByteArray { + val out = mutableListOf() + val srclen = src.size + + // If GMCP framing, replace with MSDP framing + if (srclen >= 3 && src[2] == TELOPT_GMCP) { + out.add(IAC) + out.add(SB) + out.add(TELOPT_MSDP) + } + + var i = 3 + + // Skip "MSDP {" prefix if present + if (i + 6 <= srclen) { + val prefix = "MSDP {".toByteArray(Charsets.UTF_8) + var matches = true + for (k in prefix.indices) { + if (src[i + k] != prefix[k]) { + matches = false + break + } + } + if (matches) { + i += 6 + } + } + + val state = IntArray(100) + var nest = 0 + var last: Byte = 0 + state[0] = 0 + + while (i < srclen && src[i] != IAC && nest < 99) { + when (src[i]) { + ' '.code.toByte() -> { + i++ + } + '{'.code.toByte() -> { + out.add(MSDP_TABLE_OPEN) + i++ + nest++ + state[nest] = 0 + } + '}'.code.toByte() -> { + nest-- + i++ + if (nest < 0) { + out.add(IAC) + out.add(SE) + return out.toByteArray() + } + out.add(MSDP_TABLE_CLOSE) + } + '['.code.toByte() -> { + i++ + nest++ + state[nest] = 1 + out.add(MSDP_ARRAY_OPEN) + } + ']'.code.toByte() -> { + nest-- + i++ + out.add(MSDP_ARRAY_CLOSE) + } + ':'.code.toByte() -> { + out.add(MSDP_VAL) + i++ + } + ','.code.toByte() -> { + i++ + if (state[nest] != 0) { + out.add(MSDP_VAL) + } else { + out.add(MSDP_VAR) + } + } + '"'.code.toByte() -> { + i++ + if (last == 0.toByte()) { + last = MSDP_VAR + out.add(MSDP_VAR) + } + + // Read quoted string + var reading = true + while (i < srclen && src[i] != IAC && reading) { + when (src[i]) { + '\\'.code.toByte() -> { + i++ + if (i < srclen && src[i] == '"'.code.toByte()) { + out.add(src[i]) + i++ + } else { + out.add('\\'.code.toByte()) + } + } + '"'.code.toByte() -> { + i++ + reading = false + } + else -> { + out.add(src[i]) + i++ + } + } + } + } + else -> { + // Unquoted value + var reading = true + while (i < srclen && src[i] != IAC && reading) { + when (src[i]) { + '}'.code.toByte(), ']'.code.toByte(), ','.code.toByte(), ':'.code.toByte() -> { + reading = false + } + ' '.code.toByte() -> { + i++ + } + else -> { + out.add(src[i]) + i++ + } + } + } + } + } + } + + out.add(IAC) + out.add(SE) + return out.toByteArray() +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/MSDPManager.kt b/kotlin/mth-core/src/main/kotlin/mth/core/MSDPManager.kt new file mode 100644 index 0000000..903c2fe --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/MSDPManager.kt @@ -0,0 +1,352 @@ +package mth.core + +/** + * Manages MSDP variable state for a single connection. + * + * Replaces the C per-connection `msdp_data` array and the global `msdp_table` + * functions. Each MSDPManager instance corresponds to one telnet session. + */ +class MSDPManager( + table: List = defaultMSDPTable, + val writeHandler: (ByteArray) -> Unit, + val logHandler: (String) -> Unit = {} +) { + // MSDP protocol control bytes + companion object { + private const val MSDP_VAR: Byte = 1 + private const val MSDP_VAL: Byte = 2 + private const val MSDP_TABLE_OPEN: Byte = 3 + private const val MSDP_TABLE_CLOSE: Byte = 4 + private const val MSDP_ARRAY_OPEN: Byte = 5 + private const val MSDP_ARRAY_CLOSE: Byte = 6 + private val IAC: Byte = 0xFF.toByte() + private val SB: Byte = 0xFA.toByte() + private val SE: Byte = 0xF0.toByte() + private const val TELOPT_MSDP: Byte = 69 + } + + /** Variable definitions (shared, immutable). */ + private val definitions: List = table + + /** Fast lookup from variable name to index in definitions. */ + private val nameIndex: Map = buildMap { + for ((i, def) in table.withIndex()) { + put(def.name, i) + } + } + + /** Per-connection variable state, indexed by position in definitions. */ + private val state: MutableList = table.map { def -> + MSDPVariableState(value = "", flags = def.flags) + }.toMutableList() + + /** Whether any variable needs to be flushed via flushUpdates(). */ + var needsUpdate: Boolean = false + private set + + /** Whether this connection uses GMCP (JSON) instead of raw MSDP. */ + var usesGMCP: Boolean = false + + // -- Variable Lookup -- + + private fun findIndex(name: String): Int? = nameIndex[name] + + // -- Copyover Support -- + + /** Names of variables currently marked as reported (for copyover snapshot). */ + val reportedVariableNames: List + get() { + val names = mutableListOf() + for (idx in definitions.indices) { + if (MSDPFlags.REPORTED in state[idx].flags) { + names.add(definitions[idx].name) + } + } + return names + } + + /** Restore reported variable flags from a list of variable names (after copyover). */ + fun restoreReportedVariables(names: List) { + for (name in names) { + val idx = findIndex(name) ?: continue + state[idx].flags = state[idx].flags.insert(MSDPFlags.REPORTED) + } + } + + // -- Reading -- + + /** Get the current value of a variable, or null if unknown. */ + fun getVariable(name: String): String? { + val idx = findIndex(name) + if (idx == null) { + logHandler("msdp_get_var: Unknown variable: $name.") + return null + } + return state[idx].value + } + + // -- Updating -- + + /** + * Update a variable's value. If the variable is being reported and the + * value changed, queues it for the next flushUpdates() call. + */ + fun updateVariable(name: String, value: String) { + val idx = findIndex(name) + if (idx == null) { + logHandler("msdp_update_var: Unknown variable: $name.") + return + } + + if (state[idx].value != value) { + if (MSDPFlags.REPORTED in state[idx].flags) { + state[idx].flags = state[idx].flags.insert(MSDPFlags.UPDATED) + needsUpdate = true + } + state[idx].value = value + } + } + + /** + * Update a variable's value and immediately send it if reported. + */ + fun updateVariableImmediate(name: String, value: String) { + val idx = findIndex(name) + if (idx == null) { + logHandler("msdp_update_var_instant: Unknown variable: $name.") + return + } + + if (state[idx].value != value) { + state[idx].value = value + } + + if (MSDPFlags.REPORTED in state[idx].flags) { + val packet = mutableListOf() + packet.add(IAC) + packet.add(SB) + packet.add(TELOPT_MSDP) + packet.add(MSDP_VAR) + packet.addAll(definitions[idx].name.toByteArray(Charsets.UTF_8).toList()) + packet.add(MSDP_VAL) + packet.addAll(value.toByteArray(Charsets.UTF_8).toList()) + packet.add(IAC) + packet.add(SE) + writeMSDP(packet.toByteArray()) + } + } + + /** + * Send all reported variables that have been updated since the last flush. + */ + fun flushUpdates() { + val packet = mutableListOf() + packet.add(IAC) + packet.add(SB) + packet.add(TELOPT_MSDP) + var hasContent = false + + for (idx in definitions.indices) { + if (MSDPFlags.UPDATED in state[idx].flags) { + packet.add(MSDP_VAR) + packet.addAll(definitions[idx].name.toByteArray(Charsets.UTF_8).toList()) + packet.add(MSDP_VAL) + packet.addAll(state[idx].value.toByteArray(Charsets.UTF_8).toList()) + state[idx].flags = state[idx].flags.remove(MSDPFlags.UPDATED) + hasContent = true + } + } + + packet.add(IAC) + packet.add(SE) + + if (hasContent) { + writeMSDP(packet.toByteArray()) + } + + needsUpdate = false + } + + // -- Client Commands -- + + /** + * Process an incoming MSDP variable/value pair from the client. + */ + fun processVarVal(variable: String, value: String) { + val varIdx = findIndex(variable) ?: return + val def = definitions[varIdx] + + if (MSDPFlags.CONFIGURABLE in def.flags) { + state[varIdx].value = value + handleCommand(varIdx) + return + } + + if (MSDPFlags.COMMAND in def.flags) { + if (value.isNotEmpty() && value.toByteArray(Charsets.UTF_8)[0] == MSDP_ARRAY_OPEN) { + processArray(varIdx, value) + } else { + val valIdx = findIndex(value) ?: return + handleCommandWithArgument(varIdx, valIdx) + } + } + } + + /** Process a 1D array argument for a command variable. */ + private fun processArray(varIdx: Int, value: String) { + val bytes = value.toByteArray(Charsets.UTF_8) + var i = 0 + val buf = mutableListOf() + + while (i < bytes.size) { + when (bytes[i]) { + MSDP_ARRAY_OPEN -> { + i++ + } + MSDP_VAL -> { + if (buf.isNotEmpty()) { + val name = String(buf.toByteArray(), Charsets.UTF_8) + val argIdx = findIndex(name) + if (argIdx != null) { + handleCommandWithArgument(varIdx, argIdx) + } + } + buf.clear() + i++ + } + MSDP_ARRAY_CLOSE -> { + if (buf.isNotEmpty()) { + val name = String(buf.toByteArray(), Charsets.UTF_8) + val argIdx = findIndex(name) + if (argIdx != null) { + handleCommandWithArgument(varIdx, argIdx) + } + } + return + } + else -> { + buf.add(bytes[i]) + i++ + } + } + } + + if (buf.isNotEmpty()) { + val name = String(buf.toByteArray(), Charsets.UTF_8) + val argIdx = findIndex(name) + if (argIdx != null) { + handleCommandWithArgument(varIdx, argIdx) + } + } + } + + /** Dispatch a command with no argument (configurable variable handler). */ + private fun handleCommand(varIdx: Int) { + @Suppress("UNUSED_VARIABLE") + val name = definitions[varIdx].name + // Arachnos handlers are MUD-specific; delegate up + } + + /** Dispatch a command with a variable-index argument. */ + private fun handleCommandWithArgument(cmdIdx: Int, argumentIndex: Int) { + when (definitions[cmdIdx].name) { + "LIST" -> commandList(argumentIndex) + "REPORT" -> commandReport(argumentIndex) + "UNREPORT" -> commandUnreport(argumentIndex) + "SEND" -> commandSend(argumentIndex) + "RESET" -> commandReset(argumentIndex) + } + } + + // -- Command Implementations -- + + /** LIST command: send a list of variables matching the requested category. */ + private fun commandList(index: Int) { + val def = definitions[index] + if (MSDPFlags.LIST !in def.flags) return + + val packet = mutableListOf() + packet.add(IAC) + packet.add(SB) + packet.add(TELOPT_MSDP) + packet.add(MSDP_VAR) + packet.addAll(def.name.toByteArray(Charsets.UTF_8).toList()) + packet.add(MSDP_VAL) + packet.add(MSDP_ARRAY_OPEN) + + val flag = def.flags.subtract(MSDPFlags.LIST) + + for (idx in definitions.indices) { + if (!flag.isEmpty()) { + // List variables matching the flag (excluding other list vars) + if (flag in state[idx].flags && MSDPFlags.LIST !in state[idx].flags) { + packet.add(MSDP_VAL) + packet.addAll(definitions[idx].name.toByteArray(Charsets.UTF_8).toList()) + } + } else { + // flag is empty after removing .list -> this is "LISTS", list all list variables + if (MSDPFlags.LIST in state[idx].flags) { + packet.add(MSDP_VAL) + packet.addAll(definitions[idx].name.toByteArray(Charsets.UTF_8).toList()) + } + } + } + + packet.add(MSDP_ARRAY_CLOSE) + packet.add(IAC) + packet.add(SE) + + writeMSDP(packet.toByteArray()) + } + + /** REPORT command: enable auto-reporting for a variable. */ + private fun commandReport(index: Int) { + if (MSDPFlags.REPORTABLE !in definitions[index].flags) return + + state[index].flags = state[index].flags.insert(MSDPFlags.REPORTED) + + if (MSDPFlags.SENDABLE !in definitions[index].flags) return + + state[index].flags = state[index].flags.insert(MSDPFlags.UPDATED) + needsUpdate = true + } + + /** UNREPORT command: disable auto-reporting for a variable. */ + private fun commandUnreport(index: Int) { + if (MSDPFlags.REPORTABLE !in definitions[index].flags) return + state[index].flags = state[index].flags.remove(MSDPFlags.REPORTED) + } + + /** SEND command: queue a sendable variable for immediate update. */ + private fun commandSend(index: Int) { + if (MSDPFlags.SENDABLE in state[index].flags) { + state[index].flags = state[index].flags.insert(MSDPFlags.UPDATED) + needsUpdate = true + } + } + + /** RESET command: reset all variables matching the list's flag. */ + private fun commandReset(index: Int) { + if (MSDPFlags.LIST !in definitions[index].flags) return + + val flag = definitions[index].flags.subtract(MSDPFlags.LIST) + + for (idx in definitions.indices) { + if (flag in state[idx].flags) { + state[idx].flags = definitions[idx].flags + } + } + } + + // -- Output -- + + /** Write an MSDP packet, converting to GMCP JSON if needed. */ + private fun writeMSDP(packet: ByteArray) { + if (usesGMCP) { + val json = msdp2json(packet) + writeHandler(json) + } else { + writeHandler(packet) + } + } +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/MSDPTypes.kt b/kotlin/mth-core/src/main/kotlin/mth/core/MSDPTypes.kt new file mode 100644 index 0000000..54a7194 --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/MSDPTypes.kt @@ -0,0 +1,63 @@ +package mth.core + +@JvmInline +value class MSDPFlags(val rawValue: Int = 0) { + operator fun contains(flag: MSDPFlags): Boolean = rawValue and flag.rawValue == flag.rawValue + fun insert(flag: MSDPFlags) = MSDPFlags(rawValue or flag.rawValue) + fun remove(flag: MSDPFlags) = MSDPFlags(rawValue and flag.rawValue.inv()) + fun subtract(flag: MSDPFlags) = MSDPFlags(rawValue and flag.rawValue.inv()) + fun isEmpty(): Boolean = rawValue == 0 + + companion object { + val COMMAND = MSDPFlags(1 shl 0) + val LIST = MSDPFlags(1 shl 1) + val SENDABLE = MSDPFlags(1 shl 2) + val REPORTABLE = MSDPFlags(1 shl 3) + val CONFIGURABLE = MSDPFlags(1 shl 4) + val REPORTED = MSDPFlags(1 shl 5) + val UPDATED = MSDPFlags(1 shl 6) + + infix fun Int.or(flag: MSDPFlags) = this or flag.rawValue + fun of(a: MSDPFlags, b: MSDPFlags) = MSDPFlags(a.rawValue or b.rawValue) + } +} + +data class MSDPVariableDefinition( + val name: String, + val flags: MSDPFlags +) + +class MSDPVariableState( + var value: String = "", + var flags: MSDPFlags = MSDPFlags() +) + +val defaultMSDPTable: List = listOf( + MSDPVariableDefinition("ALIGNMENT", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("ARACHNOS_DEVEL", MSDPFlags.of(MSDPFlags.CONFIGURABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("ARACHNOS_MUDLIST", MSDPFlags(MSDPFlags.CONFIGURABLE.rawValue)), + MSDPVariableDefinition("COMMANDS", MSDPFlags.of(MSDPFlags.COMMAND, MSDPFlags.LIST)), + MSDPVariableDefinition("CONFIGURABLE_VARIABLES", MSDPFlags.of(MSDPFlags.CONFIGURABLE, MSDPFlags.LIST)), + MSDPVariableDefinition("EXPERIENCE", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("EXPERIENCE_MAX", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("HEALTH", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("HEALTH_MAX", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("LEVEL", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("LIST", MSDPFlags(MSDPFlags.COMMAND.rawValue)), + MSDPVariableDefinition("LISTS", MSDPFlags(MSDPFlags.LIST.rawValue)), + MSDPVariableDefinition("MANA", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("MANA_MAX", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("MONEY", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("MOVEMENT", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("MOVEMENT_MAX", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("REPORT", MSDPFlags(MSDPFlags.COMMAND.rawValue)), + MSDPVariableDefinition("REPORTABLE_VARIABLES", MSDPFlags.of(MSDPFlags.REPORTABLE, MSDPFlags.LIST)), + MSDPVariableDefinition("REPORTED_VARIABLES", MSDPFlags.of(MSDPFlags.REPORTED, MSDPFlags.LIST)), + MSDPVariableDefinition("RESET", MSDPFlags(MSDPFlags.COMMAND.rawValue)), + MSDPVariableDefinition("ROOM", MSDPFlags(MSDPFlags.REPORTABLE.rawValue)), + MSDPVariableDefinition("ROOM_EXITS", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.REPORTABLE)), + MSDPVariableDefinition("SEND", MSDPFlags(MSDPFlags.COMMAND.rawValue)), + MSDPVariableDefinition("SENDABLE_VARIABLES", MSDPFlags.of(MSDPFlags.SENDABLE, MSDPFlags.LIST)), + MSDPVariableDefinition("SPECIFICATION", MSDPFlags(MSDPFlags.SENDABLE.rawValue)), + MSDPVariableDefinition("UNREPORT", MSDPFlags(MSDPFlags.COMMAND.rawValue)), +) diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/MTTSFlags.kt b/kotlin/mth-core/src/main/kotlin/mth/core/MTTSFlags.kt new file mode 100644 index 0000000..8469a2a --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/MTTSFlags.kt @@ -0,0 +1,18 @@ +package mth.core + +@JvmInline +value class MTTSFlags(val rawValue: Int = 0) { + operator fun contains(flag: MTTSFlags): Boolean = rawValue and flag.rawValue == flag.rawValue + + companion object { + val ANSI = MTTSFlags(1 shl 0) + val VT100 = MTTSFlags(1 shl 1) + val UTF8 = MTTSFlags(1 shl 2) + val COLORS_256 = MTTSFlags(1 shl 3) + val MOUSE_TRACKING = MTTSFlags(1 shl 4) + val COLOR_PALETTE = MTTSFlags(1 shl 5) + val SCREEN_READER = MTTSFlags(1 shl 6) + val PROXY = MTTSFlags(1 shl 7) + val TRUE_COLOR = MTTSFlags(1 shl 8) + } +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/TelnetConstants.kt b/kotlin/mth-core/src/main/kotlin/mth/core/TelnetConstants.kt new file mode 100644 index 0000000..2291d19 --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/TelnetConstants.kt @@ -0,0 +1,60 @@ +package mth.core + +object TelnetCommand { + const val IAC: Byte = 0xFF.toByte() // 255 + const val DONT: Byte = 0xFE.toByte() // 254 + const val DO: Byte = 0xFD.toByte() // 253 + const val WONT: Byte = 0xFC.toByte() // 252 + const val WILL: Byte = 0xFB.toByte() // 251 + const val SB: Byte = 0xFA.toByte() // 250 + const val GA: Byte = 0xF9.toByte() // 249 + const val EL: Byte = 0xF8.toByte() // 248 + const val EC: Byte = 0xF7.toByte() // 247 + const val AYT: Byte = 0xF6.toByte() // 246 + const val AO: Byte = 0xF5.toByte() // 245 + const val IP: Byte = 0xF4.toByte() // 244 + const val BREAK: Byte = 0xF3.toByte() // 243 + const val DM: Byte = 0xF2.toByte() // 242 + const val NOP: Byte = 0xF1.toByte() // 241 + const val SE: Byte = 0xF0.toByte() // 240 + const val EOR: Byte = 0xEF.toByte() // 239 + const val ABORT: Byte = 0xEE.toByte() // 238 + const val SUSP: Byte = 0xED.toByte() // 237 + const val xEOF: Byte = 0xEC.toByte() // 236 + + fun isCommand(c: Byte): Boolean = (c.toInt() and 0xFF) >= (xEOF.toInt() and 0xFF) +} + +object TelnetOption { + const val ECHO: Byte = 1 + const val SGA: Byte = 3 + const val TTYPE: Byte = 24 + const val EOR: Byte = 25 + const val NAWS: Byte = 31 + const val NEW_ENVIRON: Byte = 39 + const val CHARSET: Byte = 42 + const val MSDP: Byte = 69 + const val MSSP: Byte = 70 + const val MCCP2: Byte = 86.toByte() + const val MCCP3: Byte = 87.toByte() + const val MSP: Byte = 90.toByte() + const val MXP: Byte = 91.toByte() + const val GMCP: Byte = 0xC9.toByte() // 201 +} + +object TelnetSub { + const val ENV_IS: Byte = 0 + const val ENV_SEND: Byte = 1 + const val ENV_INFO: Byte = 2 + const val ENV_VAR: Byte = 0 + const val ENV_VAL: Byte = 1 + const val ENV_ESC: Byte = 2 + const val ENV_USR: Byte = 3 + + const val CHARSET_REQUEST: Byte = 1 + const val CHARSET_ACCEPTED: Byte = 2 + const val CHARSET_REJECTED: Byte = 3 + + const val MSSP_VAR: Byte = 1 + const val MSSP_VAL: Byte = 2 +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/client/TelnetClientDelegate.kt b/kotlin/mth-core/src/main/kotlin/mth/core/client/TelnetClientDelegate.kt new file mode 100644 index 0000000..9d6b7a5 --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/client/TelnetClientDelegate.kt @@ -0,0 +1,27 @@ +package mth.core.client + +interface TelnetClientDelegate { + /** Send raw bytes to the server socket. */ + fun write(data: ByteArray) + + /** Local echo state changed due to server ECHO negotiation. */ + fun onLocalEchoChanged(enabled: Boolean) + + /** GMCP has been negotiated. Called once when server's WILL GMCP is accepted. */ + fun onGMCPNegotiated() {} + + /** GMCP data received from server. */ + fun onGMCPReceived(module: String, json: String) + + /** MSDP variable update received from server. */ + fun onMSDPVariable(name: String, value: String) + + /** Server sent EOR or GA prompt marker. */ + fun onPromptReceived() + + /** Server sent BEL (0x07) character. */ + fun onBellReceived() {} + + /** Log a diagnostic message. */ + fun log(message: String) {} +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/client/TelnetClientSession.kt b/kotlin/mth-core/src/main/kotlin/mth/core/client/TelnetClientSession.kt new file mode 100644 index 0000000..734883d --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/client/TelnetClientSession.kt @@ -0,0 +1,531 @@ +package mth.core.client + +import mth.core.* + +private typealias TC = TelnetCommand +private typealias TO = TelnetOption +private typealias TS = TelnetSub + +/** + * A client-side telnet session for MUD clients. + * + * Handles the inverse of the server-side negotiation: receives WILL/DO from the + * server and responds with DO/WILL (or DONT/WONT for unsupported options). + */ +class TelnetClientSession( + var delegate: TelnetClientDelegate? = null, + var terminalType: String = "MTH", + var windowWidth: Int = 80, + var windowHeight: Int = 24 +) { + // -- Public State -- + + /** Whether MCCP2 decompression is active for inbound data. */ + val isMCCP2Active: Boolean get() = mccp2 != null + + /** Whether the server is echoing (client should disable local echo). */ + var serverEcho: Boolean = false + private set + + /** Whether GMCP has been negotiated. */ + var gmcpEnabled: Boolean = false + private set + + /** Whether MSDP has been negotiated. */ + var msdpEnabled: Boolean = false + private set + + // -- Private State -- + + /** Buffer for incomplete telnet sequences (packet fragmentation). */ + private var telbuf: MutableList = mutableListOf() + + /** MCCP2 inflate stream (decompress server→client data). */ + private var mccp2: InflateStream? = null + + /** Whether we're in the middle of MCCP2 startup (just saw IAC SB MCCP2 IAC SE). */ + private var mccp2Starting: Boolean = false + + /** Set of options the server has offered via WILL that we accepted. */ + private val serverOptions: MutableSet = mutableSetOf() + + /** Set of options the server asked us to DO that we accepted. */ + private val clientOptions: MutableSet = mutableSetOf() + + /** TTYPE negotiation round counter. */ + private var ttypeRound: Int = 0 + + // -- Connection Lifecycle -- + + /** Send window size to server. Call after NAWS is negotiated or when window resizes. */ + fun sendWindowSize(width: Int = windowWidth, height: Int = windowHeight) { + windowWidth = width + windowHeight = height + if (TO.NAWS in clientOptions) { + sendNawsPacket() + } + } + + /** Send a GMCP message to the server. */ + fun sendGMCP(module: String, json: String) { + if (!gmcpEnabled) return + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.GMCP) + packet.addAll(module.toByteArray(Charsets.UTF_8).toList()) + packet.add(' '.code.toByte()) + packet.addAll(json.toByteArray(Charsets.UTF_8).toList()) + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + // -- Input Processing -- + + /** + * Process raw input from the server. Strips telnet negotiations, + * decompresses MCCP2 data, and returns clean display text. + */ + fun processInput(src: ByteArray): ByteArray { + var input = src + + // MCCP2: decompress incoming data if active + val inflater = mccp2 + if (inflater != null) { + val result = inflater.decompress(input) + if (result == null) { + log("MCCP2: Decompression error, disabling MCCP2.") + mccp2 = null + return ByteArray(0) + } + if (result.finished) { + log("MCCP2: Compression stream ended.") + mccp2 = null + input = result.decompressed + result.unconsumedInput + } else { + input = result.decompressed + } + } + + val out = mutableListOf() + + // Reassemble fragmented packets + if (telbuf.isNotEmpty()) { + val combined = ByteArray(telbuf.size + input.size) + telbuf.toByteArray().copyInto(combined) + input.copyInto(combined, telbuf.size) + input = combined + telbuf.clear() + } + + var i = 0 + + while (i < input.size) { + when (input[i]) { + TC.IAC -> { + val remaining = input.size - i + + val (skip, matched) = dispatchTelopt(input, i, remaining) + + if (!matched && remaining > 1) { + val genericSkip = handleGenericTelnet(input, i, remaining, out) + if (genericSkip <= remaining) { + i += genericSkip + } else { + telbuf = input.copyOfRange(i, input.size).toMutableList() + return out.toByteArray() + } + } else if (skip <= remaining) { + i += skip + // After processing IAC SB MCCP2 IAC SE, remaining data is compressed + if (mccp2Starting) { + mccp2Starting = false + if (i < input.size) { + // Decompress the rest of this packet + val compressed = input.copyOfRange(i, input.size) + val decompressed = processInput(compressed) + out.addAll(decompressed.toList()) + return out.toByteArray() + } + } + } else { + telbuf = input.copyOfRange(i, input.size).toMutableList() + return out.toByteArray() + } + } + 0x0D.toByte() -> { // CR — strip carriage returns (servers send \r\n) + i++ + } + 0x07.toByte() -> { // BEL + delegate?.onBellReceived() + i++ + } + else -> { + out.add(input[i]) + i++ + } + } + } + + return out.toByteArray() + } + + // -- Telopt Dispatch -- + + private data class TeloptPattern( + val pattern: ByteArray, + val handler: (TelnetClientSession, ByteArray, Int, Int) -> Int + ) { + override fun equals(other: Any?): Boolean { + if (this === other) return true + if (other !is TeloptPattern) return false + return pattern.contentEquals(other.pattern) + } + override fun hashCode(): Int = pattern.contentHashCode() + } + + private fun dispatchTelopt(src: ByteArray, i: Int, remaining: Int): Pair { + for (entry in teloptPatterns) { + if (remaining < entry.pattern.size) { + if (isPartialMatch(src, i, remaining, entry.pattern)) { + return Pair(entry.pattern.size, true) // signal incomplete + } + } else { + if (matchesPattern(src, i, entry.pattern)) { + val skip = entry.handler(this, src, i, remaining) + return Pair(skip, true) + } + } + } + return Pair(2, false) + } + + private fun matchesPattern(src: ByteArray, offset: Int, pattern: ByteArray): Boolean { + if (offset + pattern.size > src.size) return false + for (k in pattern.indices) { + if (src[offset + k] != pattern[k]) return false + } + return true + } + + private fun isPartialMatch(src: ByteArray, offset: Int, remaining: Int, pattern: ByteArray): Boolean { + for (k in 0 until remaining) { + if (src[offset + k] != pattern[k]) return false + } + return true + } + + private val teloptPatterns: List by lazy { buildTeloptPatterns() } + + private fun buildTeloptPatterns(): List { + return listOf( + // Server offers GMCP + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.GMCP)) + { s, _, _, _ -> s.processWillGmcp(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.GMCP)) + { s, src, i, n -> s.processSbGmcp(src, i, n) }, + + // Server offers MCCP2 + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.MCCP2)) + { s, _, _, _ -> s.processWillMccp2(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.MCCP2, TC.IAC, TC.SE)) + { s, _, _, _ -> s.processSbMccp2(); 5 }, + + // Server offers MSDP + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.MSDP)) + { s, _, _, _ -> s.processWillMsdp(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.MSDP)) + { s, src, i, n -> s.processSbMsdp(src, i, n) }, + + // Server offers ECHO + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.ECHO)) + { s, _, _, _ -> s.processWillEcho(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.WONT, TO.ECHO)) + { s, _, _, _ -> s.processWontEcho(); 3 }, + + // Server offers EOR + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.EOR)) + { s, _, _, _ -> s.processWillEor(); 3 }, + + // Server offers SGA + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.SGA)) + { s, _, _, _ -> s.processWillSga(); 3 }, + + // Server requests TTYPE + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.TTYPE)) + { s, _, _, _ -> s.processDoTtype(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.TTYPE, TS.ENV_SEND, TC.IAC, TC.SE)) + { s, _, _, _ -> s.processSbTtypeSend(); 6 }, + + // Server requests NAWS + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.NAWS)) + { s, _, _, _ -> s.processDoNaws(); 3 }, + + // EOR command (prompt marker) + TeloptPattern(byteArrayOf(TC.IAC, TC.EOR)) + { s, _, _, _ -> s.processEorCommand(); 2 }, + + // GA command (prompt marker) + TeloptPattern(byteArrayOf(TC.IAC, TC.GA)) + { s, _, _, _ -> s.processGaCommand(); 2 }, + ) + } + + private fun handleGenericTelnet(src: ByteArray, i: Int, remaining: Int, out: MutableList): Int { + if (remaining <= 1) return remaining + 1 + + return when (src[i + 1]) { + TC.WILL -> { + // Unsupported option: reject + if (remaining < 3) return remaining + 1 + write(byteArrayOf(TC.IAC, TC.DONT, src[i + 2])) + 3 + } + TC.DO -> { + // Unsupported option: reject + if (remaining < 3) return remaining + 1 + write(byteArrayOf(TC.IAC, TC.WONT, src[i + 2])) + 3 + } + TC.WONT, TC.DONT -> 3 + TC.SB -> skipSB(src, i, remaining) + TC.IAC -> { + out.add(TC.IAC) + 2 + } + else -> { + if (TelnetCommand.isCommand(src[i + 1])) 2 else 1 + } + } + } + + private fun skipSB(src: ByteArray, offset: Int, srclen: Int): Int { + val end = offset + srclen + var j = offset + 1 + while (j < end) { + if (src[j] == TC.SE && j > offset && src[j - 1] == TC.IAC) { + return j - offset + 1 + } + j++ + } + return srclen + 1 + } + + // -- Output -- + + private fun write(data: ByteArray) { + delegate?.write(data) + } + + private fun log(message: String) { + delegate?.log(message) + } + + // -- Handler: GMCP -- + + private fun processWillGmcp() { + gmcpEnabled = true + serverOptions.add(TO.GMCP) + write(byteArrayOf(TC.IAC, TC.DO, TO.GMCP)) + delegate?.onGMCPNegotiated() + } + + private fun processSbGmcp(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + // Extract payload between IAC SB GMCP and IAC SE + val payloadStart = offset + 3 + val payloadEnd = offset + sbLen - 2 // before IAC SE + if (payloadEnd <= payloadStart) return sbLen + + val payload = String(src.copyOfRange(payloadStart, payloadEnd), Charsets.UTF_8) + + // Split into module name and JSON at first space + val spaceIdx = payload.indexOf(' ') + if (spaceIdx > 0) { + val module = payload.substring(0, spaceIdx) + val json = payload.substring(spaceIdx + 1) + delegate?.onGMCPReceived(module, json) + } else { + // Module with no payload + delegate?.onGMCPReceived(payload, "") + } + + return sbLen + } + + // -- Handler: MCCP2 -- + + private fun processWillMccp2() { + serverOptions.add(TO.MCCP2) + write(byteArrayOf(TC.IAC, TC.DO, TO.MCCP2)) + } + + private fun processSbMccp2(): Int { + val stream = InflateStream.create() + if (stream == null) { + log("MCCP2: Failed to initialize inflate stream.") + return 5 + } + mccp2 = stream + mccp2Starting = true + log("MCCP2: Decompression started.") + return 5 + } + + // -- Handler: MSDP -- + + private fun processWillMsdp() { + msdpEnabled = true + serverOptions.add(TO.MSDP) + write(byteArrayOf(TC.IAC, TC.DO, TO.MSDP)) + } + + private fun processSbMsdp(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + var varName = "" + var j = offset + 3 + val end = offset + srclen + + while (j < end && src[j] != TC.SE) { + when (src[j]) { + 1.toByte() -> { // MSDP_VAR + j++ + val buf = mutableListOf() + while (j < end && src[j] != 2.toByte() && src[j] != TC.IAC) { + buf.add(src[j]) + j++ + } + varName = String(buf.toByteArray(), Charsets.UTF_8) + } + 2.toByte() -> { // MSDP_VAL + j++ + val buf = mutableListOf() + var nest = 0 + while (j < end && src[j] != TC.IAC) { + if (src[j] == 3.toByte() || src[j] == 5.toByte()) nest++ + else if (src[j] == 4.toByte() || src[j] == 6.toByte()) nest-- + else if (nest == 0 && (src[j] == 1.toByte() || src[j] == 2.toByte())) break + buf.add(src[j]) + j++ + } + val valStr = String(buf.toByteArray(), Charsets.UTF_8) + if (nest == 0 && varName.isNotEmpty()) { + delegate?.onMSDPVariable(varName, valStr) + } + } + else -> j++ + } + } + + return sbLen + } + + // -- Handler: ECHO -- + + private fun processWillEcho() { + serverOptions.add(TO.ECHO) + serverEcho = true + write(byteArrayOf(TC.IAC, TC.DO, TO.ECHO)) + delegate?.onLocalEchoChanged(false) + } + + private fun processWontEcho() { + serverOptions.remove(TO.ECHO) + serverEcho = false + write(byteArrayOf(TC.IAC, TC.DONT, TO.ECHO)) + delegate?.onLocalEchoChanged(true) + } + + // -- Handler: EOR -- + + private fun processWillEor() { + serverOptions.add(TO.EOR) + write(byteArrayOf(TC.IAC, TC.DO, TO.EOR)) + } + + // -- Handler: SGA -- + + private fun processWillSga() { + serverOptions.add(TO.SGA) + write(byteArrayOf(TC.IAC, TC.DO, TO.SGA)) + } + + // -- Handler: TTYPE -- + + private fun processDoTtype() { + clientOptions.add(TO.TTYPE) + ttypeRound = 0 + write(byteArrayOf(TC.IAC, TC.WILL, TO.TTYPE)) + } + + private fun processSbTtypeSend() { + val name = when (ttypeRound) { + 0 -> terminalType + 1 -> "$terminalType-256color" + else -> "MTTS 137" // ANSI | VT100 | UTF8 | COLORS_256 + } + ttypeRound++ + + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.TTYPE) + packet.add(TS.ENV_IS) + packet.addAll(name.toByteArray(Charsets.UTF_8).toList()) + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + // -- Handler: NAWS -- + + private fun processDoNaws() { + clientOptions.add(TO.NAWS) + write(byteArrayOf(TC.IAC, TC.WILL, TO.NAWS)) + sendNawsPacket() + } + + private fun sendNawsPacket() { + val colsHi = ((windowWidth shr 8) and 0xFF).toByte() + val colsLo = (windowWidth and 0xFF).toByte() + val rowsHi = ((windowHeight shr 8) and 0xFF).toByte() + val rowsLo = (windowHeight and 0xFF).toByte() + + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.NAWS) + addNawsByte(packet, colsHi) + addNawsByte(packet, colsLo) + addNawsByte(packet, rowsHi) + addNawsByte(packet, rowsLo) + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + /** Add a NAWS value byte, doubling IAC (0xFF) per RFC 855. */ + private fun addNawsByte(packet: MutableList, b: Byte) { + packet.add(b) + if (b == TC.IAC) { + packet.add(b) + } + } + + // -- Handler: EOR/GA Commands -- + + private fun processEorCommand(): Int { + delegate?.onPromptReceived() + return 2 + } + + private fun processGaCommand(): Int { + delegate?.onPromptReceived() + return 2 + } +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/server/TelnetSession.kt b/kotlin/mth-core/src/main/kotlin/mth/core/server/TelnetSession.kt new file mode 100644 index 0000000..13aa948 --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/server/TelnetSession.kt @@ -0,0 +1,860 @@ +package mth.core.server + +import mth.core.* + +private typealias TC = TelnetCommand +private typealias TO = TelnetOption +private typealias TS = TelnetSub + +/** + * A single server-side telnet session, managing protocol negotiation state. + * + * Replaces the C `mth_data` struct and the `translate_telopts` function. + * Each instance corresponds to one client connection. + */ +class TelnetSession( + var delegate: TelnetSessionDelegate? = null, + val telnetTable: List = defaultTelnetTable, + val msdpTable: List = defaultMSDPTable +) { + // -- Public State -- + + var terminalType: String = "" + private set + var mttsFlags: MTTSFlags = MTTSFlags() + private set + var windowSize: Pair = Pair(0, 0) + private set + var commFlags: CommFlags = CommFlags() + private set + var proxy: String = "" + private set + + /** The MSDP manager for this session. Created lazily when MSDP/GMCP is negotiated. */ + var msdpManager: MSDPManager? = null + private set + + /** Whether MCCP2 compression is active for outbound data. */ + val isMCCP2Active: Boolean get() = mccp2 != null + + /** Whether MCCP3 decompression is active for inbound data. */ + val isMCCP3Active: Boolean get() = mccp3 != null + + // -- Private State -- + + /** Buffer for incomplete telnet sequences (packet fragmentation). */ + private var telbuf: MutableList = mutableListOf() + + /** MCCP2 deflate stream (server->client output compression). */ + private var mccp2: DeflateStream? = null + + /** MCCP3 inflate stream (client->server input decompression). */ + private var mccp3: InflateStream? = null + + // -- Restore Constructor -- + + /** + * Restore a TelnetSession from saved copyover state. + * Sets negotiated flags directly without sending announcements to the client. + */ + constructor( + restoringCommFlags: CommFlags, + mttsFlags: MTTSFlags, + terminalType: String, + windowSize: Pair, + proxy: String, + delegate: TelnetSessionDelegate? = null, + telnetTable: List = defaultTelnetTable, + msdpTable: List = defaultMSDPTable + ) : this(delegate, telnetTable, msdpTable) { + this.commFlags = restoringCommFlags + this.mttsFlags = mttsFlags + this.terminalType = terminalType + this.windowSize = windowSize + this.proxy = proxy + } + + // -- Connection Lifecycle -- + + /** Announce support for negotiated telnet options. Call once after connection is established. */ + fun announceSupport() { + for (i in 0 until minOf(telnetTable.size, 255)) { + val entry = telnetTable[i] + if (!entry.announce.isEmpty()) { + if (AnnounceFlags.WILL in entry.announce) { + write(byteArrayOf(TC.IAC, TC.WILL, i.toByte())) + } + if (AnnounceFlags.DO in entry.announce) { + write(byteArrayOf(TC.IAC, TC.DO, i.toByte())) + } + } + } + } + + /** Unannounce support (e.g. before copyover). */ + fun unannounceSupport() { + endMCCP2() + endMCCP3() + for (i in 0 until minOf(telnetTable.size, 255)) { + val entry = telnetTable[i] + if (!entry.announce.isEmpty()) { + if (AnnounceFlags.WILL in entry.announce) { + write(byteArrayOf(TC.IAC, TC.WONT, i.toByte())) + } + if (AnnounceFlags.DO in entry.announce) { + write(byteArrayOf(TC.IAC, TC.DONT, i.toByte())) + } + } + } + } + + /** Re-send IAC WILL GMCP to the client. */ + fun reannounceGMCP() { + write(byteArrayOf(TC.IAC, TC.WILL, TO.GMCP)) + } + + /** Send echo-off (password mode). */ + fun sendEchoOff() { + commFlags = commFlags.insert(CommFlags.PASSWORD) + write(byteArrayOf(TC.IAC, TC.WILL, TO.ECHO)) + } + + /** Send echo-on (normal mode). */ + fun sendEchoOn() { + commFlags = commFlags.remove(CommFlags.PASSWORD) + write(byteArrayOf(TC.IAC, TC.WONT, TO.ECHO)) + } + + /** Send End-of-Record marker (prompt marker). */ + fun sendEOR() { + if (CommFlags.EOR in commFlags) { + write(byteArrayOf(TC.IAC, TC.EOR)) + } + } + + /** Send MSDP update if needed. Call periodically (e.g. each tick). */ + fun flushMSDPUpdates() { + msdpManager?.flushUpdates() + } + + /** Send a GMCP packet with the given module name and JSON payload. */ + fun sendGMCP(module: String, json: String) { + if (CommFlags.GMCP !in commFlags) return + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.GMCP) + packet.addAll(module.toByteArray(Charsets.UTF_8).toList()) + packet.add(' '.code.toByte()) + packet.addAll(json.toByteArray(Charsets.UTF_8).toList()) + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + /** Send an MSP trigger as a telnet subnegotiation (IAC SB MSP ... IAC SE). */ + fun sendMSP(payload: String) { + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.MSP) + packet.addAll(payload.toByteArray(Charsets.UTF_8).toList()) + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + // -- Input Processing -- + + /** + * Process raw input from the client. Strips telnet negotiations, + * handles \r\0 -> \n conversion, and returns clean text. + */ + fun processInput(src: ByteArray): ByteArray { + var input = src + + // MCCP3: decompress incoming data if active + val inflater = mccp3 + if (inflater != null) { + val result = inflater.decompress(input) + if (result == null) { + log("MCCP3: Compression error, disabling MCCP3.") + write(byteArrayOf(TC.IAC, TC.DONT, TO.MCCP3)) + endMCCP3() + return ByteArray(0) + } + if (result.finished) { + log("MCCP3: Compression end, disabling MCCP3.") + endMCCP3() + // Decompressed data + any trailing uncompressed data + input = result.decompressed + result.unconsumedInput + } else { + input = result.decompressed + } + } + + val out = mutableListOf() + + // Reassemble fragmented packets + if (telbuf.isNotEmpty()) { + val combined = ByteArray(telbuf.size + input.size) + telbuf.toByteArray().copyInto(combined) + input.copyInto(combined, telbuf.size) + input = combined + telbuf.clear() + } + + var i = 0 + + while (i < input.size) { + when (input[i]) { + TC.IAC -> { + val remaining = input.size - i + + // Try to match against the telopt dispatch table + val (skip, matched) = dispatchTelopt(input, i, remaining) + + if (!matched && remaining > 1) { + // No handler matched -- handle generic telnet commands + val genericSkip = handleGenericTelnet(input, i, remaining, out) + if (genericSkip <= remaining) { + i += genericSkip + } else { + // Incomplete -- buffer for next call + telbuf = input.copyOfRange(i, input.size).toMutableList() + return out.toByteArray() + } + } else if (skip <= remaining) { + i += skip + } else { + // Incomplete telnet sequence -- buffer for next call + telbuf = input.copyOfRange(i, input.size).toMutableList() + return out.toByteArray() + } + } + 0x0D.toByte() -> { // \r + if (i + 1 < input.size && input[i + 1] == 0x00.toByte()) { + out.add(0x0A.toByte()) // \r\0 -> \n + } + // \r alone or \r\n -- skip \r, let \n be handled next iteration + i++ + } + 0x00.toByte() -> { // \0 + i++ + } + else -> { + out.add(input[i]) + i++ + } + } + } + + return out.toByteArray() + } + + // -- Telopt Dispatch -- + + private data class TeloptPattern( + val pattern: ByteArray, + val handler: (TelnetSession, ByteArray, Int, Int) -> Int + ) { + override fun equals(other: Any?): Boolean { + if (this === other) return true + if (other !is TeloptPattern) return false + return pattern.contentEquals(other.pattern) + } + + override fun hashCode(): Int = pattern.contentHashCode() + } + + /** + * Try to match input at position against known telopt patterns. + * Returns (skip count, matched). + */ + private fun dispatchTelopt(src: ByteArray, i: Int, remaining: Int): Pair { + for (entry in teloptPatterns) { + if (remaining < entry.pattern.size) { + // Check if it's a partial match (incomplete packet) + if (isPartialMatch(src, i, remaining, entry.pattern)) { + return Pair(entry.pattern.size, true) // signal incomplete + } + } else { + if (matchesPattern(src, i, entry.pattern)) { + val skip = entry.handler(this, src, i, remaining) + return Pair(skip, true) + } + } + } + return Pair(2, false) // no match + } + + private fun matchesPattern(src: ByteArray, offset: Int, pattern: ByteArray): Boolean { + if (offset + pattern.size > src.size) return false + for (k in pattern.indices) { + if (src[offset + k] != pattern[k]) return false + } + return true + } + + private fun isPartialMatch(src: ByteArray, offset: Int, remaining: Int, pattern: ByteArray): Boolean { + for (k in 0 until remaining) { + if (src[offset + k] != pattern[k]) return false + } + return true + } + + /** Lazily built telopt pattern table. */ + private val teloptPatterns: List by lazy { buildTeloptPatterns() } + + private fun buildTeloptPatterns(): List { + return listOf( + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.EOR)) + { s, _, _, _ -> s.processDoEOR(); 3 }, + + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.TTYPE)) + { s, _, _, _ -> s.processWillTtype(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.TTYPE, TS.ENV_IS)) + { s, src, i, n -> s.processSbTtypeIs(src, i, n) }, + + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.NAWS)) + { s, src, i, n -> s.processSbNaws(src, i, n) }, + + TeloptPattern(byteArrayOf(TC.IAC, TC.WILL, TO.NEW_ENVIRON)) + { s, _, _, _ -> s.processWillNewEnviron(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.NEW_ENVIRON)) + { s, src, i, n -> s.processSbNewEnviron(src, i, n) }, + + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.CHARSET)) + { s, _, _, _ -> s.processDoCharset(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.CHARSET)) + { s, src, i, n -> s.processSbCharset(src, i, n) }, + + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.MSSP)) + { s, _, _, _ -> s.processDoMssp(); 3 }, + + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.MSDP)) + { s, _, _, _ -> s.processDoMsdp(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.MSDP)) + { s, src, i, n -> s.processSbMsdp(src, i, n) }, + + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.GMCP)) + { s, _, _, _ -> s.processDoGmcp(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.GMCP)) + { s, src, i, n -> s.processSbGmcp(src, i, n) }, + + // MCCP2 + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.MCCP2)) + { s, _, _, _ -> s.processDoMccp2(); 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.DONT, TO.MCCP2)) + { s, _, _, _ -> s.processDontMccp2(); 3 }, + + // MCCP3 + TeloptPattern(byteArrayOf(TC.IAC, TC.DO, TO.MCCP3)) + { _, _, _, _ -> 3 }, + TeloptPattern(byteArrayOf(TC.IAC, TC.SB, TO.MCCP3, TC.IAC, TC.SE)) + { s, _, _, _ -> s.processSbMccp3(); 5 }, + ) + } + + /** + * Handle generic telnet commands that don't match any specific pattern. + */ + private fun handleGenericTelnet(src: ByteArray, i: Int, remaining: Int, out: MutableList): Int { + if (remaining <= 1) return remaining + 1 // incomplete + + return when (src[i + 1]) { + TC.WILL, TC.DO, TC.WONT, TC.DONT -> 3 + TC.SB -> skipSB(src, i, remaining) + TC.IAC -> { + // IAC IAC -> literal 0xFF + out.add(TC.IAC) + 2 + } + else -> { + if (TelnetCommand.isCommand(src[i + 1])) 2 else 1 + } + } + } + + // -- Subnegotiation Helpers -- + + /** Find the end of a subnegotiation (IAC SE). Returns skip count, or remaining+1 if incomplete. */ + private fun skipSB(src: ByteArray, offset: Int, srclen: Int): Int { + val end = offset + srclen + var j = offset + 1 + while (j < end) { + if (src[j] == TC.SE && j > offset && src[j - 1] == TC.IAC) { + return j - offset + 1 + } + j++ + } + return srclen + 1 // incomplete + } + + // -- Output -- + + /** + * Send output data to the client, compressing via MCCP2 if active. + */ + fun sendOutput(data: ByteArray) { + write(data) + } + + private fun write(data: ByteArray) { + val compressor = mccp2 + if (compressor != null) { + val compressed = compressor.compress(data) + if (compressed != null) { + delegate?.telnetSessionWrite(this, compressed) + } + } else { + delegate?.telnetSessionWrite(this, data) + } + } + + /** Write data bypassing MCCP2 compression (used for the MCCP2 start marker). */ + private fun writeRaw(data: ByteArray) { + delegate?.telnetSessionWrite(this, data) + } + + private fun log(message: String) { + delegate?.telnetSessionLog(this, message) + } + + // -- Handler: EOR -- + + private fun processDoEOR() { + commFlags = commFlags.insert(CommFlags.EOR) + } + + // -- Handler: Terminal Type -- + + private fun processWillTtype() { + if (terminalType.isEmpty()) { + // Request terminal type 3 times for MTTS detection, then reset + val request = byteArrayOf(TC.IAC, TC.SB, TO.TTYPE, TS.ENV_SEND, TC.IAC, TC.SE) + write(request) + write(request) + write(request) + write(byteArrayOf(TC.IAC, TC.DONT, TO.TTYPE)) + } + } + + private fun processSbTtypeIs(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + // Extract terminal type value from: IAC SB TTYPE IS IAC SE + val buf = mutableListOf() + var j = offset + 4 + val end = offset + srclen + while (j < end) { + if (src[j] == TC.IAC) break + buf.add(src[j]) + j++ + } + val value = String(buf.toByteArray(), Charsets.UTF_8) + + if (terminalType.isEmpty()) { + terminalType = value + } else { + // Check for MTTS flags + if (value.uppercase().startsWith("MTTS ")) { + val flagStr = value.substring(5).trim() + val flags = flagStr.toIntOrNull() + if (flags != null) { + mttsFlags = MTTSFlags(flags) + + if (MTTSFlags.COLORS_256 in mttsFlags) { + commFlags = commFlags.insert(CommFlags.COLORS_256) + } + if (MTTSFlags.UTF8 in mttsFlags) { + commFlags = commFlags.insert(CommFlags.UTF8) + } + } + } + + // Detect 256-color terminals by name + val upper = value.uppercase() + if (upper.contains("-256COLOR") || upper == "XTERM") { + commFlags = commFlags.insert(CommFlags.COLORS_256) + } + } + + return sbLen + } + + // -- Handler: NAWS -- + + private fun processSbNaws(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + // NAWS data starts at offset+3: 2 bytes cols (big-endian), 2 bytes rows + // IAC bytes are doubled (stuffed) in NAWS values + var cols = 0 + var rows = 0 + var j = offset + 3 + val end = offset + srclen + + // Parse 4 value bytes with IAC stuffing + for (field in 0 until 4) { + if (j >= end) break + val byte = src[j].toInt() and 0xFF + if (src[j] == TC.IAC && j + 1 < end) { + j++ // skip stuffed IAC + } + j++ + + when (field) { + 0 -> cols += byte * 256 + 1 -> cols += byte + 2 -> rows += byte * 256 + 3 -> rows += byte + } + } + + windowSize = Pair(cols, rows) + return sbLen + } + + // -- Handler: NEW-ENVIRON -- + + private fun processWillNewEnviron() { + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.NEW_ENVIRON) + packet.add(TS.ENV_SEND) + packet.add(TS.ENV_VAR) + packet.addAll("SYSTEMTYPE".toByteArray(Charsets.UTF_8).toList()) + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + private fun processSbNewEnviron(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + var varName = "" + var j = offset + 4 + val end = offset + srclen + val subCommand = src[offset + 3] + + while (j < end && src[j] != TC.SE) { + when (src[j]) { + TS.ENV_VAR, TS.ENV_USR -> { + j++ + val buf = mutableListOf() + while (j < end && (src[j].toInt() and 0xFF) >= 32 && src[j] != TC.IAC) { + buf.add(src[j]) + j++ + } + varName = String(buf.toByteArray(), Charsets.UTF_8) + } + TS.ENV_VAL -> { + j++ + val buf = mutableListOf() + while (j < end && (src[j].toInt() and 0xFF) >= 32 && src[j] != TC.IAC) { + buf.add(src[j]) + j++ + } + val valName = String(buf.toByteArray(), Charsets.UTF_8) + + if (subCommand == TS.ENV_IS) { + if (varName.equals("SYSTEMTYPE", ignoreCase = true) + && valName.equals("WIN32", ignoreCase = true) + ) { + if (terminalType.equals("ANSI", ignoreCase = true)) { + commFlags = commFlags.insert(CommFlags.REMOTE_ECHO) + terminalType = "WINDOWS TELNET" + } + } + if (varName.equals("IPADDRESS", ignoreCase = true)) { + proxy = valName + } + } + } + else -> { + j++ + } + } + } + + return sbLen + } + + // -- Handler: CHARSET -- + + private fun processDoCharset() { + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.CHARSET) + packet.add(TS.CHARSET_REQUEST) + packet.add(' '.code.toByte()) + packet.addAll("UTF-8".toByteArray(Charsets.UTF_8).toList()) + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + private fun processSbCharset(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + val subCommand = src[offset + 3] + val separator = src[offset + 4] + var j = offset + 5 + val end = offset + srclen + + while (j < end && src[j] != TC.SE && src[j] != separator) { + val buf = mutableListOf() + while (j < end && src[j] != separator && src[j] != TC.IAC) { + buf.add(src[j]) + j++ + } + val charset = String(buf.toByteArray(), Charsets.UTF_8) + + if (subCommand == TS.CHARSET_ACCEPTED) { + if (charset.equals("UTF-8", ignoreCase = true)) { + commFlags = commFlags.insert(CommFlags.UTF8) + } + } else if (subCommand == TS.CHARSET_REJECTED) { + if (charset.equals("UTF-8", ignoreCase = true)) { + commFlags = commFlags.remove(CommFlags.UTF8) + } + } + j++ + } + + return sbLen + } + + // -- Handler: MSSP -- + + private fun processDoMssp() { + val d = delegate ?: return + val pairs = d.telnetSessionMSSPData(this) + + val packet = mutableListOf() + packet.add(TC.IAC) + packet.add(TC.SB) + packet.add(TO.MSSP) + for (pair in pairs) { + packet.add(TS.MSSP_VAR) + packet.addAll(pair.first.toByteArray(Charsets.UTF_8).toList()) + packet.add(TS.MSSP_VAL) + packet.addAll(pair.second.toByteArray(Charsets.UTF_8).toList()) + } + packet.add(TC.IAC) + packet.add(TC.SE) + write(packet.toByteArray()) + } + + // -- Handler: MSDP -- + + private fun processDoMsdp() { + if (msdpManager != null) return + initializeMSDP() + log("INFO MSDP INITIALIZED") + } + + /** Initialize MSDP manager for copyover restore (no negotiation announcements). */ + fun initializeMSDPForRestore(usesGMCP: Boolean) { + if (msdpManager != null) return + initializeMSDP() + msdpManager?.usesGMCP = usesGMCP + } + + private fun initializeMSDP() { + msdpManager = MSDPManager( + table = msdpTable, + writeHandler = { data -> write(data) }, + logHandler = { message -> log(message) } + ) + msdpManager?.usesGMCP = CommFlags.GMCP in commFlags + msdpManager?.updateVariable("SPECIFICATION", "http://tintin.sourceforge.net/msdp") + } + + private fun processSbMsdp(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + val mgr = msdpManager ?: return sbLen + + var varName = "" + var j = offset + 3 + val end = offset + srclen + + while (j < end && src[j] != TC.SE) { + when (src[j]) { + 1.toByte() -> { // MSDP_VAR + j++ + val buf = mutableListOf() + while (j < end && src[j] != 2.toByte() && src[j] != TC.IAC) { + buf.add(src[j]) + j++ + } + varName = String(buf.toByteArray(), Charsets.UTF_8) + } + 2.toByte() -> { // MSDP_VAL + j++ + val buf = mutableListOf() + var nest = 0 + while (j < end && src[j] != TC.IAC) { + if (src[j] == 3.toByte() || src[j] == 5.toByte()) { // TABLE_OPEN or ARRAY_OPEN + nest++ + } else if (src[j] == 4.toByte() || src[j] == 6.toByte()) { // TABLE_CLOSE or ARRAY_CLOSE + nest-- + } else if (nest == 0 && (src[j] == 1.toByte() || src[j] == 2.toByte())) { // VAR or VAL + break + } + buf.add(src[j]) + j++ + } + val valStr = String(buf.toByteArray(), Charsets.UTF_8) + if (nest == 0) { + mgr.processVarVal(varName, valStr) + } + } + else -> { + j++ + } + } + } + + return sbLen + } + + // -- Handler: GMCP -- + + private fun processDoGmcp() { + commFlags = commFlags.insert(CommFlags.GMCP) + if (msdpManager != null) { + msdpManager?.usesGMCP = true + log("INFO GMCP ENABLED (MSDP already active)") + return + } + log("INFO MSDP OVER GMCP INITIALIZED") + initializeMSDP() + } + + private fun processSbGmcp(src: ByteArray, offset: Int, srclen: Int): Int { + val sbLen = skipSB(src, offset, srclen) + if (sbLen > srclen) return srclen + 1 + + // Convert JSON to MSDP and process + val gmcpPacket = src.copyOfRange(offset, offset + srclen) + val msdpPacket = json2msdp(gmcpPacket) + + // Process the converted MSDP packet + val mgr = msdpManager + if (mgr != null) { + var varName = "" + var j = 3 // skip IAC SB MSDP + while (j < msdpPacket.size) { + if (msdpPacket[j] == TC.IAC) break + when (msdpPacket[j]) { + 1.toByte() -> { // MSDP_VAR + j++ + val buf = mutableListOf() + while (j < msdpPacket.size && msdpPacket[j] != 2.toByte() && msdpPacket[j] != TC.IAC) { + buf.add(msdpPacket[j]) + j++ + } + varName = String(buf.toByteArray(), Charsets.UTF_8) + } + 2.toByte() -> { // MSDP_VAL + j++ + val buf = mutableListOf() + var nest = 0 + while (j < msdpPacket.size && msdpPacket[j] != TC.IAC) { + if (msdpPacket[j] == 3.toByte() || msdpPacket[j] == 5.toByte()) { nest++ } + else if (msdpPacket[j] == 4.toByte() || msdpPacket[j] == 6.toByte()) { nest-- } + else if (nest == 0 && (msdpPacket[j] == 1.toByte() || msdpPacket[j] == 2.toByte())) { break } + buf.add(msdpPacket[j]) + j++ + } + if (nest == 0) { + mgr.processVarVal(varName, String(buf.toByteArray(), Charsets.UTF_8)) + } + } + else -> { + j++ + } + } + } + } + + return sbLen + } + + // -- Handler: MCCP2 -- + + private fun processDoMccp2() { + startMCCP2() + } + + private fun processDontMccp2() { + endMCCP2() + } + + /** + * Start MCCP2 compression. Sends the start marker uncompressed, + * then all subsequent write() calls are compressed. + */ + private fun startMCCP2() { + if (mccp2 != null) return + val stream = DeflateStream.create() + if (stream == null) { + log("MCCP2: failed to initialize deflate stream") + return + } + + // Send the MCCP2 start marker BEFORE enabling compression + writeRaw(byteArrayOf(TC.IAC, TC.SB, TO.MCCP2, TC.IAC, TC.SE)) + + mccp2 = stream + } + + /** End MCCP2 compression. */ + fun endMCCP2() { + val stream = mccp2 ?: return + + // Flush remaining compressed data + if (CommFlags.DISCONNECT !in commFlags) { + val final = stream.finish() + if (final != null) { + delegate?.telnetSessionWrite(this, final) + } + } + + mccp2 = null + log("MCCP2: COMPRESSION END") + } + + // -- Handler: MCCP3 -- + + private fun processSbMccp3() { + endMCCP3() + + val stream = InflateStream.create() + if (stream == null) { + log("INFO IAC SB MCCP3 FAILED TO INITIALIZE") + write(byteArrayOf(TC.IAC, TC.WONT, TO.MCCP3)) + return + } + + mccp3 = stream + log("INFO IAC SB MCCP3 INITIALIZED") + } + + /** End MCCP3 decompression. */ + fun endMCCP3() { + if (mccp3 == null) return + log("MCCP3: COMPRESSION END") + mccp3 = null + } +} diff --git a/kotlin/mth-core/src/main/kotlin/mth/core/server/TelnetSessionDelegate.kt b/kotlin/mth-core/src/main/kotlin/mth/core/server/TelnetSessionDelegate.kt new file mode 100644 index 0000000..03ff4cc --- /dev/null +++ b/kotlin/mth-core/src/main/kotlin/mth/core/server/TelnetSessionDelegate.kt @@ -0,0 +1,7 @@ +package mth.core.server + +interface TelnetSessionDelegate { + fun telnetSessionWrite(session: TelnetSession, data: ByteArray) + fun telnetSessionLog(session: TelnetSession, message: String) {} + fun telnetSessionMSSPData(session: TelnetSession): List> = emptyList() +} diff --git a/kotlin/mth-core/src/test/kotlin/mth/core/MSDPManagerTest.kt b/kotlin/mth-core/src/test/kotlin/mth/core/MSDPManagerTest.kt new file mode 100644 index 0000000..ddbd67d --- /dev/null +++ b/kotlin/mth-core/src/test/kotlin/mth/core/MSDPManagerTest.kt @@ -0,0 +1,353 @@ +package mth.core + +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertTrue +import kotlin.test.assertFalse +import kotlin.test.assertNull +import kotlin.test.assertNotNull +import kotlin.test.assertContentEquals + +private const val IAC: Byte = 0xFF.toByte() +private const val SB: Byte = 0xFA.toByte() +private const val SE: Byte = 0xF0.toByte() +private const val TELOPT_MSDP: Byte = 69 +private const val TELOPT_GMCP: Byte = 0xC9.toByte() +private const val MV: Byte = 1 // MSDP_VAR +private const val ML: Byte = 2 // MSDP_VAL +private const val AO: Byte = 5 // MSDP_ARRAY_OPEN +private const val AC: Byte = 6 // MSDP_ARRAY_CLOSE + +private fun textBytes(s: String): ByteArray = s.toByteArray(Charsets.UTF_8) + +/** Parse an MSDP array (sequence of MSDP_VAL + string) into string values. */ +private fun parseMSDPArray(bytes: ByteArray): List { + val result = mutableListOf() + var i = 0 + while (i < bytes.size) { + if (bytes[i] == ML) { + i++ + val name = mutableListOf() + while (i < bytes.size && bytes[i] != ML && bytes[i] != AC) { + name.add(bytes[i]) + i++ + } + if (name.isNotEmpty()) { + result.add(String(name.toByteArray(), Charsets.UTF_8)) + } + } else { + i++ + } + } + return result +} + +/** Extract the array bytes from a LIST command response packet. */ +private fun extractArrayFromListPacket(packet: ByteArray, varName: String): ByteArray { + val headerLen = 4 + varName.toByteArray(Charsets.UTF_8).size + 2 // IAC SB MSDP MV + name + ML AO + val trailerLen = 3 // AC IAC SE + if (packet.size <= headerLen + trailerLen) return byteArrayOf() + return packet.copyOfRange(headerLen, packet.size - trailerLen) +} + +class MSDPManagerTest { + + // -- Table Verification -- + + @Test fun tableIsSorted() { + val names = defaultMSDPTable.map { it.name } + for (i in 1 until names.size) { + assertTrue(names[i - 1] < names[i], + "${names[i - 1]} should sort before ${names[i]}") + } + } + + @Test fun tableContentsMatchCSource() { + val table = defaultMSDPTable + val byName = table.associate { it.name to it.flags } + + assertEquals(27, table.size) + + // MSDP_FLAG_SENDABLE|MSDP_FLAG_REPORTABLE = 4|8 = 12 + assertEquals(12, byName["HEALTH"]?.rawValue) + assertEquals(12, byName["MANA"]?.rawValue) + assertEquals(12, byName["LEVEL"]?.rawValue) + + // MSDP_FLAG_COMMAND = 1 + assertEquals(1, byName["LIST"]?.rawValue) + assertEquals(1, byName["REPORT"]?.rawValue) + assertEquals(1, byName["SEND"]?.rawValue) + assertEquals(1, byName["UNREPORT"]?.rawValue) + assertEquals(1, byName["RESET"]?.rawValue) + + // MSDP_FLAG_COMMAND|MSDP_FLAG_LIST = 1|2 = 3 + assertEquals(3, byName["COMMANDS"]?.rawValue) + + // MSDP_FLAG_LIST = 2 + assertEquals(2, byName["LISTS"]?.rawValue) + + // MSDP_FLAG_CONFIGURABLE|MSDP_FLAG_REPORTABLE = 16|8 = 24 + assertEquals(24, byName["ARACHNOS_DEVEL"]?.rawValue) + + // MSDP_FLAG_CONFIGURABLE = 16 + assertEquals(16, byName["ARACHNOS_MUDLIST"]?.rawValue) + + // MSDP_FLAG_REPORTABLE = 8 + assertEquals(8, byName["ROOM"]?.rawValue) + + // MSDP_FLAG_SENDABLE = 4 + assertEquals(4, byName["SPECIFICATION"]?.rawValue) + + // MSDP_FLAG_REPORTABLE|MSDP_FLAG_LIST = 8|2 = 10 + assertEquals(10, byName["REPORTABLE_VARIABLES"]?.rawValue) + + // MSDP_FLAG_REPORTED|MSDP_FLAG_LIST = 32|2 = 34 + assertEquals(34, byName["REPORTED_VARIABLES"]?.rawValue) + } + + // -- Packet Format -- + + @Test fun updateVariableImmediatePacketFormat() { + var captured = byteArrayOf() + val mgr = MSDPManager(writeHandler = { captured = it }) + + mgr.processVarVal("REPORT", "HEALTH") + captured = byteArrayOf() + + mgr.updateVariableImmediate("HEALTH", "95") + + val expected = byteArrayOf(IAC, SB, TELOPT_MSDP, MV) + + textBytes("HEALTH") + byteArrayOf(ML) + textBytes("95") + byteArrayOf(IAC, SE) + + assertContentEquals(expected, captured, "Instant update packet mismatch") + } + + @Test fun flushUpdatesPacketFormat() { + val captured = mutableListOf() + val mgr = MSDPManager(writeHandler = { captured.add(it.copyOf()) }) + + mgr.processVarVal("REPORT", "HEALTH") + mgr.processVarVal("REPORT", "MANA") + captured.clear() + + mgr.updateVariable("HEALTH", "100") + mgr.updateVariable("MANA", "50") + + assertTrue(mgr.needsUpdate) + + mgr.flushUpdates() + + assertFalse(mgr.needsUpdate) + assertEquals(1, captured.size) + + val packet = captured[0] + + val expected = byteArrayOf(IAC, SB, TELOPT_MSDP) + + byteArrayOf(MV) + textBytes("HEALTH") + byteArrayOf(ML) + textBytes("100") + + byteArrayOf(MV) + textBytes("MANA") + byteArrayOf(ML) + textBytes("50") + + byteArrayOf(IAC, SE) + + assertContentEquals(expected, packet, "Flush packet mismatch") + } + + @Test fun flushUpdatesNoopWhenNoChanges() { + val captured = mutableListOf() + val mgr = MSDPManager(writeHandler = { captured.add(it.copyOf()) }) + + mgr.processVarVal("REPORT", "HEALTH") + mgr.flushUpdates() + captured.clear() + + mgr.flushUpdates() + + assertTrue(captured.isEmpty(), "Should not send packet when nothing updated") + } + + // -- GMCP Conversion -- + + @Test fun gmcpModeConvertsPackets() { + var captured = byteArrayOf() + val mgr = MSDPManager(writeHandler = { captured = it }) + mgr.usesGMCP = true + + mgr.processVarVal("REPORT", "HEALTH") + captured = byteArrayOf() + + mgr.updateVariableImmediate("HEALTH", "42") + + assertEquals(IAC, captured[0]) + assertEquals(SB, captured[1]) + assertEquals(TELOPT_GMCP, captured[2]) + + assertEquals(IAC, captured[captured.size - 2]) + assertEquals(SE, captured[captured.size - 1]) + + val jsonPortion = String(captured.copyOfRange(3, captured.size - 2), Charsets.UTF_8) + assertTrue(jsonPortion.contains("HEALTH"), "GMCP should contain variable name") + assertTrue(jsonPortion.contains("42"), "GMCP should contain value") + } + + // -- State Transitions -- + + @Test fun reportEnablesReporting() { + val mgr = MSDPManager(writeHandler = { }) + + mgr.processVarVal("REPORT", "HEALTH") + + assertTrue(mgr.needsUpdate) + } + + @Test fun unreportDisablesReporting() { + val mgr = MSDPManager(writeHandler = { }) + + mgr.processVarVal("REPORT", "HEALTH") + mgr.flushUpdates() + + mgr.processVarVal("UNREPORT", "HEALTH") + + mgr.updateVariable("HEALTH", "99") + assertFalse(mgr.needsUpdate) + } + + @Test fun sendQueuesUpdate() { + val captured = mutableListOf() + val mgr = MSDPManager(writeHandler = { captured.add(it.copyOf()) }) + + mgr.updateVariable("HEALTH", "100") + captured.clear() + + mgr.processVarVal("SEND", "HEALTH") + assertTrue(mgr.needsUpdate) + + mgr.flushUpdates() + assertEquals(1, captured.size) + } + + @Test fun updateVariableOnlyQueuesOnChange() { + val mgr = MSDPManager(writeHandler = { }) + + mgr.processVarVal("REPORT", "HEALTH") + mgr.flushUpdates() + + mgr.updateVariable("HEALTH", "100") + assertTrue(mgr.needsUpdate) + mgr.flushUpdates() + + mgr.updateVariable("HEALTH", "100") + assertFalse(mgr.needsUpdate) + } + + @Test fun getVariableReturnsValue() { + val mgr = MSDPManager(writeHandler = { }) + + assertEquals("", mgr.getVariable("HEALTH")) + + mgr.updateVariable("HEALTH", "100") + assertEquals("100", mgr.getVariable("HEALTH")) + } + + @Test fun getVariableReturnsNilForUnknown() { + val logMessages = mutableListOf() + val mgr = MSDPManager( + writeHandler = { }, + logHandler = { logMessages.add(it) } + ) + + val result = mgr.getVariable("NONEXISTENT") + assertNull(result) + assertEquals(1, logMessages.size) + } + + // -- LIST Commands -- + + @Test fun listCommandSendableVariables() { + var captured = byteArrayOf() + val mgr = MSDPManager(writeHandler = { captured = it }) + + mgr.processVarVal("LIST", "SENDABLE_VARIABLES") + + assertEquals(IAC, captured[0]) + assertEquals(SB, captured[1]) + assertEquals(TELOPT_MSDP, captured[2]) + assertEquals(MV, captured[3]) + + val headerEnd = 4 + textBytes("SENDABLE_VARIABLES").size + assertEquals(ML, captured[headerEnd]) + assertEquals(AO, captured[headerEnd + 1]) + + assertEquals(AC, captured[captured.size - 3]) + assertEquals(IAC, captured[captured.size - 2]) + assertEquals(SE, captured[captured.size - 1]) + + val arrayBytes = captured.copyOfRange(headerEnd + 2, captured.size - 3) + val content = parseMSDPArray(arrayBytes) + val sendableNames = defaultMSDPTable + .filter { MSDPFlags.SENDABLE in it.flags && MSDPFlags.LIST !in it.flags } + .map { it.name } + + assertEquals(sendableNames.toSet(), content.toSet(), + "LIST SENDABLE_VARIABLES should return all sendable non-list vars") + } + + @Test fun listCommandLists() { + var captured = byteArrayOf() + val mgr = MSDPManager(writeHandler = { captured = it }) + + mgr.processVarVal("LIST", "LISTS") + + val arrayBytes = extractArrayFromListPacket(captured, "LISTS") + val content = parseMSDPArray(arrayBytes) + val listNames = defaultMSDPTable + .filter { MSDPFlags.LIST in it.flags } + .map { it.name } + + assertEquals(listNames.toSet(), content.toSet(), + "LIST LISTS should return all list vars") + } + + @Test fun listCommandWithArray() { + val captured = mutableListOf() + val mgr = MSDPManager(writeHandler = { captured.add(it.copyOf()) }) + + val arrayBytes = byteArrayOf(AO, ML) + + textBytes("SENDABLE_VARIABLES") + + byteArrayOf(ML) + + textBytes("REPORTABLE_VARIABLES") + + byteArrayOf(AC) + val arrayArg = String(arrayBytes, Charsets.UTF_8) + + mgr.processVarVal("LIST", arrayArg) + + assertEquals(2, captured.size, "Should produce two LIST responses") + } + + // -- Round-trip with msdp2json -- + + @Test fun managerOutputConvertsToValidGMCP() { + var captured = byteArrayOf() + val mgr = MSDPManager(writeHandler = { captured = it }) + + mgr.processVarVal("REPORT", "HEALTH") + mgr.processVarVal("REPORT", "LEVEL") + mgr.flushUpdates() + captured = byteArrayOf() + + mgr.updateVariable("HEALTH", "100") + mgr.updateVariable("LEVEL", "5") + mgr.flushUpdates() + + val json = msdp2json(captured) + + assertEquals(IAC, json[0]) + assertEquals(SB, json[1]) + assertEquals(TELOPT_GMCP, json[2]) + assertEquals(IAC, json[json.size - 2]) + assertEquals(SE, json[json.size - 1]) + + val content = String(json.copyOfRange(3, json.size - 2), Charsets.UTF_8) + assertTrue(content.contains("HEALTH"), "Should contain HEALTH") + assertTrue(content.contains("100"), "Should contain value 100") + assertTrue(content.contains("LEVEL"), "Should contain LEVEL") + assertTrue(content.contains("5"), "Should contain value 5") + } +} diff --git a/kotlin/mth-core/src/test/kotlin/mth/core/client/TelnetClientSessionTest.kt b/kotlin/mth-core/src/test/kotlin/mth/core/client/TelnetClientSessionTest.kt new file mode 100644 index 0000000..33494e3 --- /dev/null +++ b/kotlin/mth-core/src/test/kotlin/mth/core/client/TelnetClientSessionTest.kt @@ -0,0 +1,477 @@ +package mth.core.client + +import mth.core.* +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertTrue +import kotlin.test.assertFalse +import kotlin.test.assertContentEquals + +private const val IAC: Byte = 0xFF.toByte() +private const val DONT: Byte = 0xFE.toByte() +private const val DO: Byte = 0xFD.toByte() +private const val WONT: Byte = 0xFC.toByte() +private const val WILL: Byte = 0xFB.toByte() +private const val SB: Byte = 0xFA.toByte() +private const val GA: Byte = 0xF9.toByte() +private const val SE: Byte = 0xF0.toByte() +private const val EOR_CMD: Byte = 0xEF.toByte() +private const val NOP: Byte = 0xF1.toByte() + +private const val ECHO: Byte = 1 +private const val SGA: Byte = 3 +private const val TTYPE: Byte = 24 +private const val EOR_OPT: Byte = 25 +private const val NAWS: Byte = 31 +private const val MSDP: Byte = 69 +private const val MCCP2: Byte = 86 +private const val GMCP: Byte = 0xC9.toByte() + +private const val ENV_IS: Byte = 0 +private const val ENV_SEND: Byte = 1 + +private fun bytes(vararg values: Int): ByteArray = ByteArray(values.size) { values[it].toByte() } +private fun textBytes(s: String): ByteArray = s.toByteArray(Charsets.UTF_8) + +private fun ByteArray.containsSequence(seq: ByteArray): Boolean { + if (seq.isEmpty()) return true + if (size < seq.size) return false + for (i in 0..(size - seq.size)) { + if (this.sliceArray(i until i + seq.size).contentEquals(seq)) return true + } + return false +} + +private class FakeClientDelegate : TelnetClientDelegate { + val writtenChunks = mutableListOf() + val logMessages = mutableListOf() + val gmcpMessages = mutableListOf>() + val msdpVariables = mutableListOf>() + var localEchoEnabled: Boolean? = null + var promptCount = 0 + var bellCount = 0 + var gmcpNegotiatedCount = 0 + + val allWrittenBytes: ByteArray get() = writtenChunks.fold(byteArrayOf()) { acc, chunk -> acc + chunk } + + override fun write(data: ByteArray) { + writtenChunks.add(data.copyOf()) + } + override fun onLocalEchoChanged(enabled: Boolean) { + localEchoEnabled = enabled + } + override fun onGMCPNegotiated() { + gmcpNegotiatedCount++ + } + override fun onGMCPReceived(module: String, json: String) { + gmcpMessages.add(Pair(module, json)) + } + override fun onMSDPVariable(name: String, value: String) { + msdpVariables.add(Pair(name, value)) + } + override fun onPromptReceived() { + promptCount++ + } + override fun onBellReceived() { + bellCount++ + } + override fun log(message: String) { + logMessages.add(message) + } +} + +private fun makeSession(): Pair { + val d = FakeClientDelegate() + val s = TelnetClientSession(delegate = d) + return Pair(s, d) +} + +class TelnetClientSessionTest { + + // -- Plain Text -- + + @Test fun plainTextPassthrough() { + val (s, _) = makeSession() + val input = textBytes("Hello, World!") + val out = s.processInput(input) + assertContentEquals(input, out) + } + + @Test fun emptyInput() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf()) + assertTrue(out.isEmpty()) + } + + // -- IAC IAC Escape -- + + @Test fun iacIacProducesLiteralFF() { + val (s, _) = makeSession() + val out = s.processInput(bytes(0x41, 0xFF, 0xFF, 0x42)) + assertContentEquals(bytes(0x41, 0xFF, 0x42), out) + } + + // -- GMCP -- + + @Test fun serverWillGmcpRespondsDoGmcp() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + assertTrue(s.gmcpEnabled) + assertContentEquals(byteArrayOf(IAC, DO, GMCP), d.allWrittenBytes) + } + + @Test fun serverSendsGmcpDataParsed() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + d.writtenChunks.clear() + + val payload = textBytes("Char.Vitals {\"hp\":100,\"mana\":50}") + val packet = byteArrayOf(IAC, SB, GMCP) + payload + byteArrayOf(IAC, SE) + s.processInput(packet) + + assertEquals(1, d.gmcpMessages.size) + assertEquals("Char.Vitals", d.gmcpMessages[0].first) + assertEquals("{\"hp\":100,\"mana\":50}", d.gmcpMessages[0].second) + } + + @Test fun gmcpModuleWithNoPayload() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + + val packet = byteArrayOf(IAC, SB, GMCP) + textBytes("Core.Ping") + byteArrayOf(IAC, SE) + s.processInput(packet) + + assertEquals(1, d.gmcpMessages.size) + assertEquals("Core.Ping", d.gmcpMessages[0].first) + assertEquals("", d.gmcpMessages[0].second) + } + + @Test fun sendGmcpToServer() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + d.writtenChunks.clear() + + s.sendGMCP("core.hello", "{\"client\":\"MTH\"}") + + val expected = byteArrayOf(IAC, SB, GMCP) + + textBytes("core.hello {\"client\":\"MTH\"}") + + byteArrayOf(IAC, SE) + assertContentEquals(expected, d.allWrittenBytes) + } + + @Test fun sendGmcpWithoutNegotiationDoesNothing() { + val (s, d) = makeSession() + s.sendGMCP("core.hello", "{}") + assertTrue(d.writtenChunks.isEmpty()) + } + + // -- MCCP2 -- + + @Test fun serverWillMccp2RespondsDoMccp2() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, MCCP2)) + assertContentEquals(byteArrayOf(IAC, DO, MCCP2), d.allWrittenBytes) + } + + @Test fun serverSbMccp2StartsDecompression() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, MCCP2)) + d.writtenChunks.clear() + + // Server sends MCCP2 start marker + compressed data + val plaintext = textBytes("Hello from server!") + val deflater = DeflateStream.create()!! + val compressed = deflater.compress(plaintext)!! + + val packet = byteArrayOf(IAC, SB, MCCP2, IAC, SE) + compressed + val out = s.processInput(packet) + + assertTrue(s.isMCCP2Active) + assertContentEquals(plaintext, out) + } + + @Test fun mccp2DecompressionAcrossMultiplePackets() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, MCCP2)) + d.writtenChunks.clear() + + // Start MCCP2 + s.processInput(byteArrayOf(IAC, SB, MCCP2, IAC, SE)) + assertTrue(s.isMCCP2Active) + + // Now send compressed data + val plaintext = textBytes("Second packet") + val deflater = DeflateStream.create()!! + val compressed = deflater.compress(plaintext)!! + + val out = s.processInput(compressed) + assertContentEquals(plaintext, out) + } + + // -- ECHO -- + + @Test fun serverWillEchoDisablesLocalEcho() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, ECHO)) + assertTrue(s.serverEcho) + assertEquals(false, d.localEchoEnabled) + assertTrue(d.allWrittenBytes.containsSequence(byteArrayOf(IAC, DO, ECHO))) + } + + @Test fun serverWontEchoEnablesLocalEcho() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, ECHO)) + d.writtenChunks.clear() + + s.processInput(byteArrayOf(IAC, WONT, ECHO)) + assertFalse(s.serverEcho) + assertEquals(true, d.localEchoEnabled) + assertTrue(d.allWrittenBytes.containsSequence(byteArrayOf(IAC, DONT, ECHO))) + } + + // -- TTYPE -- + + @Test fun serverDoTtypeRespondsWillTtype() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, TTYPE)) + assertTrue(d.allWrittenBytes.containsSequence(byteArrayOf(IAC, WILL, TTYPE))) + } + + @Test fun serverSbTtypeSendRespondsWithTerminalType() { + val (s, d) = makeSession() + s.terminalType = "Wamdroid" + s.processInput(byteArrayOf(IAC, DO, TTYPE)) + d.writtenChunks.clear() + + s.processInput(byteArrayOf(IAC, SB, TTYPE, ENV_SEND, IAC, SE)) + + val expected = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("Wamdroid") + byteArrayOf(IAC, SE) + assertContentEquals(expected, d.allWrittenBytes) + } + + @Test fun ttypeSecondRoundSends256Color() { + val (s, d) = makeSession() + s.terminalType = "Wamdroid" + s.processInput(byteArrayOf(IAC, DO, TTYPE)) + d.writtenChunks.clear() + + // First request + s.processInput(byteArrayOf(IAC, SB, TTYPE, ENV_SEND, IAC, SE)) + d.writtenChunks.clear() + + // Second request + s.processInput(byteArrayOf(IAC, SB, TTYPE, ENV_SEND, IAC, SE)) + + val expected = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("Wamdroid-256color") + byteArrayOf(IAC, SE) + assertContentEquals(expected, d.allWrittenBytes) + } + + @Test fun ttypeThirdRoundSendsMTTS() { + val (s, d) = makeSession() + s.terminalType = "Wamdroid" + s.processInput(byteArrayOf(IAC, DO, TTYPE)) + d.writtenChunks.clear() + + // Three requests + s.processInput(byteArrayOf(IAC, SB, TTYPE, ENV_SEND, IAC, SE)) + s.processInput(byteArrayOf(IAC, SB, TTYPE, ENV_SEND, IAC, SE)) + d.writtenChunks.clear() + s.processInput(byteArrayOf(IAC, SB, TTYPE, ENV_SEND, IAC, SE)) + + val expected = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("MTTS 137") + byteArrayOf(IAC, SE) + assertContentEquals(expected, d.allWrittenBytes) + } + + // -- NAWS -- + + @Test fun serverDoNawsRespondsWillAndSendsSize() { + val (s, d) = makeSession() + s.windowWidth = 120 + s.windowHeight = 40 + s.processInput(byteArrayOf(IAC, DO, NAWS)) + + val written = d.allWrittenBytes + assertTrue(written.containsSequence(byteArrayOf(IAC, WILL, NAWS))) + // Also should contain NAWS subnegotiation: IAC SB NAWS 0 120 0 40 IAC SE + assertTrue(written.containsSequence(byteArrayOf(IAC, SB, NAWS, 0, 120, 0, 40, IAC, SE))) + } + + @Test fun sendWindowSizeUpdatesNaws() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, NAWS)) + d.writtenChunks.clear() + + s.sendWindowSize(200, 50) + val expected = byteArrayOf(IAC, SB, NAWS, 0, 200.toByte(), 0, 50, IAC, SE) + assertContentEquals(expected, d.allWrittenBytes) + } + + @Test fun sendWindowSizeBeforeNegotiationDoesNothing() { + val (s, d) = makeSession() + s.sendWindowSize(120, 40) + assertTrue(d.writtenChunks.isEmpty()) + } + + // -- MSDP -- + + @Test fun serverWillMsdpRespondsDo() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, MSDP)) + assertTrue(s.msdpEnabled) + assertContentEquals(byteArrayOf(IAC, DO, MSDP), d.allWrittenBytes) + } + + @Test fun serverSendsMsdpVariableUpdate() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, MSDP)) + d.writtenChunks.clear() + + val MV: Byte = 1 + val ML: Byte = 2 + val packet = byteArrayOf(IAC, SB, MSDP, MV) + textBytes("HEALTH") + + byteArrayOf(ML) + textBytes("100") + byteArrayOf(IAC, SE) + s.processInput(packet) + + assertEquals(1, d.msdpVariables.size) + assertEquals("HEALTH", d.msdpVariables[0].first) + assertEquals("100", d.msdpVariables[0].second) + } + + // -- EOR / GA (Prompt) -- + + @Test fun serverEorTriggersPrompt() { + val (s, d) = makeSession() + val out = s.processInput(textBytes("HP: 100> ") + byteArrayOf(IAC, EOR_CMD)) + assertContentEquals(textBytes("HP: 100> "), out) + assertEquals(1, d.promptCount) + } + + @Test fun serverGaTriggersPrompt() { + val (s, d) = makeSession() + val out = s.processInput(textBytes("HP: 100> ") + byteArrayOf(IAC, GA)) + assertContentEquals(textBytes("HP: 100> "), out) + assertEquals(1, d.promptCount) + } + + // -- Packet Fragmentation -- + + @Test fun fragmentedIacSequenceReassembles() { + val (s, d) = makeSession() + // Split IAC WILL GMCP across two packets + val out1 = s.processInput(byteArrayOf(0x41, IAC, WILL)) + assertContentEquals(bytes(0x41), out1) + + val out2 = s.processInput(byteArrayOf(GMCP, 0x42)) + assertContentEquals(bytes(0x42), out2) + assertTrue(s.gmcpEnabled) + assertTrue(d.allWrittenBytes.containsSequence(byteArrayOf(IAC, DO, GMCP))) + } + + @Test fun fragmentedSubnegotiationReassembles() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + d.writtenChunks.clear() + d.gmcpMessages.clear() + + // Split GMCP subnegotiation across packets + val out1 = s.processInput(byteArrayOf(IAC, SB, GMCP) + textBytes("Char.Name")) + assertTrue(out1.isEmpty()) + + val out2 = s.processInput(textBytes(" \"Hero\"") + byteArrayOf(IAC, SE)) + assertTrue(out2.isEmpty()) + assertEquals(1, d.gmcpMessages.size) + assertEquals("Char.Name", d.gmcpMessages[0].first) + assertEquals("\"Hero\"", d.gmcpMessages[0].second) + } + + // -- Unsupported Options -- + + @Test fun unsupportedWillGetsDont() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, 99)) + assertContentEquals(byteArrayOf(IAC, DONT, 99), d.allWrittenBytes) + } + + @Test fun unsupportedDoGetsWont() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, 99)) + assertContentEquals(byteArrayOf(IAC, WONT, 99), d.allWrittenBytes) + } + + // -- Mixed Input -- + + @Test fun mixedTextAndTelnet() { + val (s, d) = makeSession() + val input = textBytes("Welcome!") + byteArrayOf(IAC, WILL, ECHO) + textBytes(" Login:") + val out = s.processInput(input) + assertContentEquals(textBytes("Welcome! Login:"), out) + assertTrue(s.serverEcho) + } + + @Test fun multipleNegotiationsInOnePacket() { + val (s, d) = makeSession() + val input = byteArrayOf(IAC, WILL, GMCP, IAC, WILL, ECHO, IAC, WILL, EOR_OPT) + s.processInput(input) + assertTrue(s.gmcpEnabled) + assertTrue(s.serverEcho) + + val written = d.allWrittenBytes + assertTrue(written.containsSequence(byteArrayOf(IAC, DO, GMCP))) + assertTrue(written.containsSequence(byteArrayOf(IAC, DO, ECHO))) + assertTrue(written.containsSequence(byteArrayOf(IAC, DO, EOR_OPT))) + } + + // -- SGA -- + + @Test fun serverWillSgaRespondsDo() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, SGA)) + assertTrue(d.allWrittenBytes.containsSequence(byteArrayOf(IAC, DO, SGA))) + } + + // -- CR Stripping -- + + @Test fun carriageReturnStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x48, 0x69, 0x0D, 0x0A)) // "Hi\r\n" + assertContentEquals(byteArrayOf(0x48, 0x69, 0x0A), out) // "Hi\n" + } + + @Test fun loneCrStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, 0x0D, 0x42)) // "A\rB" + assertContentEquals(byteArrayOf(0x41, 0x42), out) // "AB" + } + + // -- BEL -- + + @Test fun bellStrippedAndDelegateNotified() { + val (s, d) = makeSession() + val out = s.processInput(byteArrayOf(0x41, 0x07, 0x42)) // "AB" + assertContentEquals(byteArrayOf(0x41, 0x42), out) // "AB" + assertEquals(1, d.bellCount) + } + + @Test fun multipleBells() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(0x07, 0x07, 0x07)) + assertEquals(3, d.bellCount) + } + + // -- GMCP Negotiated Callback -- + + @Test fun gmcpNegotiatedCallbackFires() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + assertEquals(1, d.gmcpNegotiatedCount) + } + + @Test fun gmcpNegotiatedCallbackFiresOnlyOnce() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + s.processInput(byteArrayOf(IAC, WILL, GMCP)) + // Second WILL GMCP still fires — the library doesn't deduplicate, + // but in practice servers only send it once + assertEquals(2, d.gmcpNegotiatedCount) + } +} diff --git a/kotlin/mth-core/src/test/kotlin/mth/core/server/TelnetSessionTest.kt b/kotlin/mth-core/src/test/kotlin/mth/core/server/TelnetSessionTest.kt new file mode 100644 index 0000000..2f6641d --- /dev/null +++ b/kotlin/mth-core/src/test/kotlin/mth/core/server/TelnetSessionTest.kt @@ -0,0 +1,675 @@ +package mth.core.server + +import mth.core.* +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertTrue +import kotlin.test.assertFalse +import kotlin.test.assertNull +import kotlin.test.assertNotNull +import kotlin.test.assertContentEquals + +// Telnet protocol constants +private const val IAC: Byte = 0xFF.toByte() +private const val DONT: Byte = 0xFE.toByte() +private const val DO: Byte = 0xFD.toByte() +private const val WONT: Byte = 0xFC.toByte() +private const val WILL: Byte = 0xFB.toByte() +private const val SB: Byte = 0xFA.toByte() +private const val GA: Byte = 0xF9.toByte() +private const val SE: Byte = 0xF0.toByte() +private const val EOR_CMD: Byte = 0xEF.toByte() +private const val NOP: Byte = 0xF1.toByte() + +// Telnet options +private const val ECHO: Byte = 1 +private const val SGA: Byte = 3 +private const val TTYPE: Byte = 24 +private const val EOR_OPT: Byte = 25 +private const val NAWS: Byte = 31 +private const val NEW_ENVIRON: Byte = 39 +private const val CHARSET: Byte = 42 +private const val MSDP: Byte = 69 +private const val MSSP: Byte = 70 +private const val MCCP2: Byte = 86 +private const val MCCP3: Byte = 87 +private const val GMCP: Byte = 0xC9.toByte() + +// Sub-negotiation constants +private const val ENV_IS: Byte = 0 +private const val ENV_SEND: Byte = 1 +private const val ENV_VAR: Byte = 0 +private const val ENV_VAL: Byte = 1 +private const val ENV_USR: Byte = 3 +private const val CHARSET_REQUEST: Byte = 1 +private const val CHARSET_ACCEPTED: Byte = 2 +private const val CHARSET_REJECTED: Byte = 3 +private const val MSSP_VAR: Byte = 1 +private const val MSSP_VAL: Byte = 2 + +private class FakeDelegate : TelnetSessionDelegate { + val writtenChunks = mutableListOf() + val logMessages = mutableListOf() + var msspPairs: List> = emptyList() + + val allWrittenBytes: ByteArray get() = writtenChunks.fold(byteArrayOf()) { acc, chunk -> acc + chunk } + + override fun telnetSessionWrite(session: TelnetSession, data: ByteArray) { + writtenChunks.add(data.copyOf()) + } + override fun telnetSessionLog(session: TelnetSession, message: String) { + logMessages.add(message) + } + override fun telnetSessionMSSPData(session: TelnetSession): List> = msspPairs +} + +private fun bytes(vararg values: Int): ByteArray = ByteArray(values.size) { values[it].toByte() } + +private fun textBytes(s: String): ByteArray = s.toByteArray(Charsets.UTF_8) + +private fun ByteArray.containsSequence(seq: ByteArray): Boolean { + if (seq.isEmpty()) return true + if (size < seq.size) return false + for (i in 0..(size - seq.size)) { + if (this.sliceArray(i until i + seq.size).contentEquals(seq)) return true + } + return false +} + +private fun makeSession(): Pair { + val d = FakeDelegate() + val s = TelnetSession(delegate = d) + return Pair(s, d) +} + +class TelnetSessionTest { + + // -- Plain Text Passthrough -- + + @Test fun plainTextPassthrough() { + val (s, _) = makeSession() + val input = textBytes("Hello, World!") + val out = s.processInput(input) + assertContentEquals(input, out) + } + + @Test fun emptyInput() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf()) + assertTrue(out.isEmpty()) + } + + // -- CR/NUL Handling -- + + @Test fun crNulConvertsToNewline() { + val (s, _) = makeSession() + val out = s.processInput(bytes(0x48, 0x0D, 0x00, 0x49)) + assertContentEquals(bytes(0x48, 0x0A, 0x49), out) + } + + @Test fun crLfSkipsCrKeepsLf() { + val (s, _) = makeSession() + val out = s.processInput(bytes(0x48, 0x0D, 0x0A, 0x49)) + assertContentEquals(bytes(0x48, 0x0A, 0x49), out) + } + + @Test fun standaloneNulStripped() { + val (s, _) = makeSession() + val out = s.processInput(bytes(0x48, 0x00, 0x49)) + assertContentEquals(bytes(0x48, 0x49), out) + } + + @Test fun standaloneCrStripped() { + val (s, _) = makeSession() + val out = s.processInput(bytes(0x48, 0x0D)) + assertContentEquals(bytes(0x48), out) + } + + // -- IAC IAC Escape -- + + @Test fun iacIacProducesLiteralFF() { + val (s, _) = makeSession() + val out = s.processInput(bytes(0x41, 0xFF, 0xFF, 0x42)) + assertContentEquals(bytes(0x41, 0xFF, 0x42), out) + } + + // -- WILL/WONT/DO/DONT Stripping -- + + @Test fun willIsStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, IAC, WILL, SGA, 0x42)) + assertContentEquals(bytes(0x41, 0x42), out) + } + + @Test fun wontIsStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, IAC, WONT, SGA, 0x42)) + assertContentEquals(bytes(0x41, 0x42), out) + } + + @Test fun doIsStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, IAC, DO, SGA, 0x42)) + assertContentEquals(bytes(0x41, 0x42), out) + } + + @Test fun dontIsStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, IAC, DONT, SGA, 0x42)) + assertContentEquals(bytes(0x41, 0x42), out) + } + + // -- Subnegotiation Stripping -- + + @Test fun unknownSubnegotiationStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, IAC, SB, 99, 1, 2, 3, IAC, SE, 0x42)) + assertContentEquals(bytes(0x41, 0x42), out) + } + + // -- Packet Fragmentation -- + + @Test fun fragmentedIACReassembles() { + val (s, _) = makeSession() + val out1 = s.processInput(byteArrayOf(0x41, IAC)) + assertContentEquals(bytes(0x41), out1) + + val out2 = s.processInput(byteArrayOf(IAC, 0x42)) + assertContentEquals(bytes(0xFF, 0x42), out2) + } + + @Test fun fragmentedWillReassembles() { + val (s, _) = makeSession() + val out1 = s.processInput(byteArrayOf(0x41, IAC, WILL)) + assertContentEquals(bytes(0x41), out1) + + val out2 = s.processInput(byteArrayOf(SGA, 0x42)) + assertContentEquals(bytes(0x42), out2) + } + + @Test fun fragmentedSubnegotiationReassembles() { + val (s, _) = makeSession() + val out1 = s.processInput(byteArrayOf(0x41, IAC, SB, NAWS, 0, 80)) + assertContentEquals(bytes(0x41), out1) + + val out2 = s.processInput(byteArrayOf(0, 24, IAC, SE, 0x42)) + assertContentEquals(bytes(0x42), out2) + assertEquals(80, s.windowSize.first) + assertEquals(24, s.windowSize.second) + } + + // -- Two-byte Commands -- + + @Test fun gaCmdStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, IAC, GA, 0x42)) + assertContentEquals(bytes(0x41, 0x42), out) + } + + @Test fun nopCmdStripped() { + val (s, _) = makeSession() + val out = s.processInput(byteArrayOf(0x41, IAC, NOP, 0x42)) + assertContentEquals(bytes(0x41, 0x42), out) + } + + // -- announceSupport / unannounceSupport -- + + @Test fun announceSupportSendsExpectedOptions() { + val (s, d) = makeSession() + s.announceSupport() + + val written = d.allWrittenBytes + assertTrue(written.containsSequence(byteArrayOf(IAC, WILL, CHARSET))) + assertTrue(written.containsSequence(byteArrayOf(IAC, DO, TTYPE))) + assertTrue(written.containsSequence(byteArrayOf(IAC, DO, NAWS))) + assertTrue(written.containsSequence(byteArrayOf(IAC, DO, NEW_ENVIRON))) + assertTrue(written.containsSequence(byteArrayOf(IAC, WILL, MSDP))) + assertTrue(written.containsSequence(byteArrayOf(IAC, WILL, MSSP))) + assertTrue(written.containsSequence(byteArrayOf(IAC, WILL, GMCP))) + assertTrue(written.containsSequence(byteArrayOf(IAC, WILL, MCCP2))) + assertTrue(written.containsSequence(byteArrayOf(IAC, WILL, MCCP3))) + } + + @Test fun unannounceSupportSendsWontDont() { + val (s, d) = makeSession() + s.unannounceSupport() + + val written = d.allWrittenBytes + assertTrue(written.containsSequence(byteArrayOf(IAC, WONT, CHARSET))) + assertTrue(written.containsSequence(byteArrayOf(IAC, DONT, TTYPE))) + assertTrue(written.containsSequence(byteArrayOf(IAC, DONT, NAWS))) + assertTrue(written.containsSequence(byteArrayOf(IAC, WONT, MSDP))) + assertTrue(written.containsSequence(byteArrayOf(IAC, WONT, GMCP))) + } + + // -- Echo On/Off -- + + @Test fun sendEchoOffSetsPasswordAndSendsWillEcho() { + val (s, d) = makeSession() + s.sendEchoOff() + assertTrue(CommFlags.PASSWORD in s.commFlags) + assertContentEquals(byteArrayOf(IAC, WILL, ECHO), d.allWrittenBytes) + } + + @Test fun sendEchoOnClearsPasswordAndSendsWontEcho() { + val (s, d) = makeSession() + s.sendEchoOff() + d.writtenChunks.clear() + s.sendEchoOn() + assertFalse(CommFlags.PASSWORD in s.commFlags) + assertContentEquals(byteArrayOf(IAC, WONT, ECHO), d.allWrittenBytes) + } + + // -- Send EOR -- + + @Test fun sendEOROnlyWhenEORNegotiated() { + val (s, d) = makeSession() + s.sendEOR() + assertTrue(d.allWrittenBytes.isEmpty()) + + s.processInput(byteArrayOf(IAC, DO, EOR_OPT)) + d.writtenChunks.clear() + s.sendEOR() + assertContentEquals(byteArrayOf(IAC, EOR_CMD), d.allWrittenBytes) + } + + // -- DO EOR -- + + @Test fun doEorSetsFlag() { + val (s, _) = makeSession() + s.processInput(byteArrayOf(IAC, DO, EOR_OPT)) + assertTrue(CommFlags.EOR in s.commFlags) + } + + // -- Terminal Type -- + + @Test fun willTtypeSendsThreeRequestsThenDont() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, TTYPE)) + + val request = byteArrayOf(IAC, SB, TTYPE, ENV_SEND, IAC, SE) + + assertEquals(4, d.writtenChunks.size) + assertContentEquals(request, d.writtenChunks[0]) + assertContentEquals(request, d.writtenChunks[1]) + assertContentEquals(request, d.writtenChunks[2]) + assertContentEquals(byteArrayOf(IAC, DONT, TTYPE), d.writtenChunks[3]) + } + + @Test fun willTtypeIgnoredIfTerminalAlreadySet() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, TTYPE)) + val firstTtype = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("xterm") + byteArrayOf(IAC, SE) + s.processInput(firstTtype) + d.writtenChunks.clear() + + s.processInput(byteArrayOf(IAC, WILL, TTYPE)) + assertTrue(d.writtenChunks.isEmpty()) + } + + @Test fun sbTtypeIsSetsTerminalType() { + val (s, _) = makeSession() + val packet = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("xterm-256color") + byteArrayOf(IAC, SE) + s.processInput(packet) + assertEquals("xterm-256color", s.terminalType) + } + + @Test fun sbTtypeIsSecondResponseDetects256Color() { + val (s, _) = makeSession() + val first = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("MUDLET") + byteArrayOf(IAC, SE) + s.processInput(first) + assertEquals("MUDLET", s.terminalType) + + val second = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("MUDLET-256COLOR") + byteArrayOf(IAC, SE) + s.processInput(second) + assertTrue(CommFlags.COLORS_256 in s.commFlags) + } + + @Test fun sbTtypeIsMTTSDetection() { + val (s, _) = makeSession() + val first = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("MUDLET") + byteArrayOf(IAC, SE) + s.processInput(first) + + val mtts = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("MTTS 15") + byteArrayOf(IAC, SE) + s.processInput(mtts) + + assertTrue(MTTSFlags.ANSI in s.mttsFlags) + assertTrue(MTTSFlags.VT100 in s.mttsFlags) + assertTrue(MTTSFlags.UTF8 in s.mttsFlags) + assertTrue(MTTSFlags.COLORS_256 in s.mttsFlags) + assertTrue(CommFlags.COLORS_256 in s.commFlags) + assertTrue(CommFlags.UTF8 in s.commFlags) + } + + @Test fun sbTtypeIsXtermSets256Color() { + val (s, _) = makeSession() + val first = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("PUTTY") + byteArrayOf(IAC, SE) + s.processInput(first) + + val second = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("XTERM") + byteArrayOf(IAC, SE) + s.processInput(second) + assertTrue(CommFlags.COLORS_256 in s.commFlags) + } + + // -- NAWS -- + + @Test fun nawsSetsWindowSize() { + val (s, _) = makeSession() + val packet = byteArrayOf(IAC, SB, NAWS, 0, 80, 0, 24, IAC, SE) + s.processInput(packet) + assertEquals(80, s.windowSize.first) + assertEquals(24, s.windowSize.second) + } + + @Test fun nawsLargeWindowSize() { + val (s, _) = makeSession() + val packet = byteArrayOf(IAC, SB, NAWS, 1, 0x2C, 0, 0x64, IAC, SE) + s.processInput(packet) + assertEquals(300, s.windowSize.first) + assertEquals(100, s.windowSize.second) + } + + @Test fun nawsWithIACStuffing() { + val (s, _) = makeSession() + val packet = byteArrayOf(IAC, SB, NAWS, IAC, IAC, 0, 0, 24, IAC, SE) + s.processInput(packet) + assertEquals(65280, s.windowSize.first) + assertEquals(24, s.windowSize.second) + } + + // -- NEW-ENVIRON -- + + @Test fun willNewEnvironSendsRequest() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, WILL, NEW_ENVIRON)) + + val expected = byteArrayOf(IAC, SB, NEW_ENVIRON, ENV_SEND, ENV_VAR) + + textBytes("SYSTEMTYPE") + byteArrayOf(IAC, SE) + assertContentEquals(expected, d.allWrittenBytes) + } + + @Test fun sbNewEnvironWin32Detection() { + val (s, _) = makeSession() + val ttype = byteArrayOf(IAC, SB, TTYPE, ENV_IS) + textBytes("ANSI") + byteArrayOf(IAC, SE) + s.processInput(ttype) + assertEquals("ANSI", s.terminalType) + + val packet = byteArrayOf(IAC, SB, NEW_ENVIRON, ENV_IS, ENV_VAR) + + textBytes("SYSTEMTYPE") + byteArrayOf(ENV_VAL) + textBytes("WIN32") + byteArrayOf(IAC, SE) + s.processInput(packet) + + assertEquals("WINDOWS TELNET", s.terminalType) + assertTrue(CommFlags.REMOTE_ECHO in s.commFlags) + } + + @Test fun sbNewEnvironIPAddress() { + val (s, _) = makeSession() + val packet = byteArrayOf(IAC, SB, NEW_ENVIRON, ENV_IS, ENV_VAR) + + textBytes("IPADDRESS") + byteArrayOf(ENV_VAL) + textBytes("192.168.1.100") + byteArrayOf(IAC, SE) + s.processInput(packet) + assertEquals("192.168.1.100", s.proxy) + } + + // -- CHARSET -- + + @Test fun doCharsetSendsRequest() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, CHARSET)) + + val expected = byteArrayOf(IAC, SB, CHARSET, CHARSET_REQUEST, 0x20) + + textBytes("UTF-8") + byteArrayOf(IAC, SE) + assertContentEquals(expected, d.allWrittenBytes) + } + + @Test fun sbCharsetAcceptedSetsUtf8() { + val (s, _) = makeSession() + val packet = byteArrayOf(IAC, SB, CHARSET, CHARSET_ACCEPTED, ';'.code.toByte()) + + textBytes("UTF-8") + byteArrayOf(IAC, SE) + s.processInput(packet) + assertTrue(CommFlags.UTF8 in s.commFlags) + } + + @Test fun sbCharsetRejectedClearsUtf8() { + val (s, _) = makeSession() + val accept = byteArrayOf(IAC, SB, CHARSET, CHARSET_ACCEPTED, ';'.code.toByte()) + + textBytes("UTF-8") + byteArrayOf(IAC, SE) + s.processInput(accept) + assertTrue(CommFlags.UTF8 in s.commFlags) + + val reject = byteArrayOf(IAC, SB, CHARSET, CHARSET_REJECTED, ';'.code.toByte()) + + textBytes("UTF-8") + byteArrayOf(IAC, SE) + s.processInput(reject) + assertFalse(CommFlags.UTF8 in s.commFlags) + } + + // -- MSSP -- + + @Test fun doMsspSendsData() { + val (s, d) = makeSession() + d.msspPairs = listOf( + Pair("NAME", "TestMUD"), + Pair("PLAYERS", "42"), + ) + s.processInput(byteArrayOf(IAC, DO, MSSP)) + + val written = d.allWrittenBytes + assertTrue(written.sliceArray(0 until 3).contentEquals(byteArrayOf(IAC, SB, MSSP))) + assertTrue(written.sliceArray(written.size - 2 until written.size).contentEquals(byteArrayOf(IAC, SE))) + assertTrue(written.containsSequence( + byteArrayOf(MSSP_VAR) + textBytes("NAME") + byteArrayOf(MSSP_VAL) + textBytes("TestMUD") + )) + assertTrue(written.containsSequence( + byteArrayOf(MSSP_VAR) + textBytes("PLAYERS") + byteArrayOf(MSSP_VAL) + textBytes("42") + )) + } + + // -- MSDP -- + + @Test fun doMsdpInitializesManager() { + val (s, d) = makeSession() + assertNull(s.msdpManager) + s.processInput(byteArrayOf(IAC, DO, MSDP)) + assertNotNull(s.msdpManager) + assertTrue(d.logMessages.contains("INFO MSDP INITIALIZED")) + } + + @Test fun doMsdpIdempotent() { + val (s, _) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MSDP)) + val mgr1 = s.msdpManager + s.processInput(byteArrayOf(IAC, DO, MSDP)) + assertTrue(s.msdpManager === mgr1) + } + + @Test fun sbMsdpProcessesCommand() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MSDP)) + d.writtenChunks.clear() + + val MV: Byte = 1 + val ML: Byte = 2 + val packet = byteArrayOf(IAC, SB, MSDP, MV) + + textBytes("LIST") + byteArrayOf(ML) + textBytes("COMMANDS") + byteArrayOf(IAC, SE) + s.processInput(packet) + + assertTrue(d.writtenChunks.isNotEmpty()) + } + + // -- GMCP -- + + @Test fun doGmcpInitializesMSDPOverGmcp() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, GMCP)) + assertNotNull(s.msdpManager) + assertTrue(CommFlags.GMCP in s.commFlags) + assertTrue(d.logMessages.contains("INFO MSDP OVER GMCP INITIALIZED")) + } + + @Test fun doGmcpIdempotent() { + val (s, _) = makeSession() + s.processInput(byteArrayOf(IAC, DO, GMCP)) + val mgr1 = s.msdpManager + s.processInput(byteArrayOf(IAC, DO, GMCP)) + assertTrue(s.msdpManager === mgr1) + } + + @Test fun sbGmcpProcessesJsonCommand() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, GMCP)) + d.writtenChunks.clear() + + val json = textBytes("MSDP {\"LIST\":\"COMMANDS\"}") + val packet = byteArrayOf(IAC, SB, GMCP) + json + byteArrayOf(IAC, SE) + s.processInput(packet) + + assertTrue(d.writtenChunks.isNotEmpty()) + } + + // -- MCCP2 (Output Compression) -- + + @Test fun doMccp2StartsCompression() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + assertTrue(s.isMCCP2Active) + + assertContentEquals(byteArrayOf(IAC, SB, MCCP2, IAC, SE), d.writtenChunks[0]) + } + + @Test fun mccp2CompressesOutput() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + d.writtenChunks.clear() + + s.sendEchoOff() + + assertTrue(d.writtenChunks.isNotEmpty()) + val compressed = d.allWrittenBytes + assertFalse(compressed.contentEquals(byteArrayOf(IAC, WILL, ECHO))) + assertTrue(compressed.isNotEmpty()) + } + + @Test fun mccp2RoundTrip() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + d.writtenChunks.clear() + + s.sendEchoOff() + val compressedEcho = d.allWrittenBytes + d.writtenChunks.clear() + + s.endMCCP2() + assertFalse(s.isMCCP2Active) + val finalBytes = d.allWrittenBytes + + val allCompressed = compressedEcho + finalBytes + assertTrue(allCompressed.isNotEmpty()) + assertTrue(d.logMessages.contains("MCCP2: COMPRESSION END")) + } + + @Test fun dontMccp2EndsCompression() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + assertTrue(s.isMCCP2Active) + s.processInput(byteArrayOf(IAC, DONT, MCCP2)) + assertFalse(s.isMCCP2Active) + assertTrue(d.logMessages.contains("MCCP2: COMPRESSION END")) + } + + @Test fun mccp2IdempotentStart() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + val chunks1 = d.writtenChunks.size + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + assertEquals(chunks1, d.writtenChunks.size) + } + + // -- sendOutput -- + + @Test fun sendOutputPassthroughWithoutMCCP2() { + val (s, d) = makeSession() + val data = textBytes("Hello, World!\r\n") + s.sendOutput(data) + assertContentEquals(data, d.allWrittenBytes) + } + + @Test fun sendOutputCompressesWithMCCP2() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + d.writtenChunks.clear() + + val data = textBytes("Hello, World!\r\n") + s.sendOutput(data) + + assertTrue(d.writtenChunks.isNotEmpty()) + val compressed = d.allWrittenBytes + assertFalse(compressed.contentEquals(data)) + assertTrue(compressed.isNotEmpty()) + } + + // -- MCCP3 (Input Decompression) -- + + @Test fun sbMccp3InitializesInflate() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, SB, MCCP3, IAC, SE)) + assertTrue(s.isMCCP3Active) + assertTrue(d.logMessages.contains("INFO IAC SB MCCP3 INITIALIZED")) + } + + @Test fun mccp3DecompressesInput() { + val (s, _) = makeSession() + s.processInput(byteArrayOf(IAC, SB, MCCP3, IAC, SE)) + assertTrue(s.isMCCP3Active) + + val plaintext = textBytes("Hello") + byteArrayOf(0x0D, 0x00) + + val deflater = DeflateStream.create() + assertNotNull(deflater) + val compressed = deflater.compress(plaintext) + assertNotNull(compressed) + + val out = s.processInput(compressed) + assertContentEquals(textBytes("Hello\n"), out) + } + + @Test fun endMccp3DisablesDecompression() { + val (s, d) = makeSession() + s.processInput(byteArrayOf(IAC, SB, MCCP3, IAC, SE)) + assertTrue(s.isMCCP3Active) + s.endMCCP3() + assertFalse(s.isMCCP3Active) + assertTrue(d.logMessages.contains("MCCP3: COMPRESSION END")) + } + + @Test fun unannounceSupportEndsMCCP() { + val (s, _) = makeSession() + s.processInput(byteArrayOf(IAC, DO, MCCP2)) + assertTrue(s.isMCCP2Active) + s.processInput(byteArrayOf(IAC, SB, MCCP3, IAC, SE)) + assertTrue(s.isMCCP3Active) + + s.unannounceSupport() + assertFalse(s.isMCCP2Active) + assertFalse(s.isMCCP3Active) + } + + // -- Mixed Input -- + + @Test fun mixedTextAndTelnet() { + val (s, _) = makeSession() + val input = textBytes("Hi") + byteArrayOf(IAC, DO, EOR_OPT) + textBytes("Bye") + byteArrayOf(0x0D, 0x00) + val out = s.processInput(input) + assertContentEquals(textBytes("HiBye\n"), out) + assertTrue(CommFlags.EOR in s.commFlags) + } + + @Test fun multipleNegotiationsInOnePacket() { + val (s, _) = makeSession() + val input = byteArrayOf(IAC, DO, EOR_OPT, + IAC, SB, NAWS, 0, 80, 0, 24, IAC, SE) + val out = s.processInput(input) + assertTrue(out.isEmpty()) + assertTrue(CommFlags.EOR in s.commFlags) + assertEquals(80, s.windowSize.first) + assertEquals(24, s.windowSize.second) + } +} diff --git a/kotlin/settings.gradle.kts b/kotlin/settings.gradle.kts new file mode 100644 index 0000000..d3a5c95 --- /dev/null +++ b/kotlin/settings.gradle.kts @@ -0,0 +1,11 @@ +rootProject.name = "mth" + +dependencyResolutionManagement { + repositories { + mavenCentral() + google() + } +} + +include(":mth-core") +include(":mth-color")