From c944f92cb47edcd8069ca04a00ab383f8c9ebcca Mon Sep 17 00:00:00 2001
From: Intel44 <thomas.saillour@gmail.com>
Date: Mon, 10 Jun 2024 20:39:07 +0200
Subject: [PATCH] feat: add stop command using telnet

---
 lgsm/data/almalinux-8.csv    |  2 +-
 lgsm/data/almalinux-9.csv    |  2 +-
 lgsm/data/centos-7.csv       |  2 +-
 lgsm/data/centos-8.csv       |  2 +-
 lgsm/data/centos-9.csv       |  2 +-
 lgsm/data/debian-10.csv      |  2 +-
 lgsm/data/debian-11.csv      |  2 +-
 lgsm/data/debian-12.csv      |  2 +-
 lgsm/data/debian-9.csv       |  2 +-
 lgsm/data/rhel-7.csv         |  2 +-
 lgsm/data/rhel-8.csv         |  2 +-
 lgsm/data/rhel-9.csv         |  2 +-
 lgsm/data/rocky-8.csv        |  2 +-
 lgsm/data/rocky-9.csv        |  2 +-
 lgsm/data/ubuntu-16.04.csv   |  2 +-
 lgsm/data/ubuntu-18.04.csv   |  2 +-
 lgsm/data/ubuntu-20.04.csv   |  2 +-
 lgsm/data/ubuntu-22.04.csv   |  2 +-
 lgsm/data/ubuntu-23.04.csv   |  2 +-
 lgsm/data/ubuntu-23.10.csv   |  2 +-
 lgsm/data/ubuntu-24.04.csv   |  2 +-
 lgsm/modules/command_stop.sh | 87 ++++++++++++++++++++++++++++++++++++
 22 files changed, 108 insertions(+), 21 deletions(-)

diff --git a/lgsm/data/almalinux-8.csv b/lgsm/data/almalinux-8.csv
index e866edd32..9a4ed024e 100644
--- a/lgsm/data/almalinux-8.csv
+++ b/lgsm/data/almalinux-8.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/almalinux-9.csv b/lgsm/data/almalinux-9.csv
index 14ea8335a..067674971 100644
--- a/lgsm/data/almalinux-9.csv
+++ b/lgsm/data/almalinux-9.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/centos-7.csv b/lgsm/data/centos-7.csv
index 266c9fe40..dea6914ae 100644
--- a/lgsm/data/centos-7.csv
+++ b/lgsm/data/centos-7.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/centos-8.csv b/lgsm/data/centos-8.csv
index 9970b0b1e..41bd649ae 100644
--- a/lgsm/data/centos-8.csv
+++ b/lgsm/data/centos-8.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/centos-9.csv b/lgsm/data/centos-9.csv
index 531ff4b1b..8a66a4537 100644
--- a/lgsm/data/centos-9.csv
+++ b/lgsm/data/centos-9.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/debian-10.csv b/lgsm/data/debian-10.csv
index d3922c840..e52102d4d 100644
--- a/lgsm/data/debian-10.csv
+++ b/lgsm/data/debian-10.csv
@@ -105,7 +105,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/debian-11.csv b/lgsm/data/debian-11.csv
index e3e1ef473..7a080b8e4 100644
--- a/lgsm/data/debian-11.csv
+++ b/lgsm/data/debian-11.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/debian-12.csv b/lgsm/data/debian-12.csv
index dc46f4241..cf76caa62 100644
--- a/lgsm/data/debian-12.csv
+++ b/lgsm/data/debian-12.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/debian-9.csv b/lgsm/data/debian-9.csv
index df52fa815..7872864fe 100644
--- a/lgsm/data/debian-9.csv
+++ b/lgsm/data/debian-9.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/rhel-7.csv b/lgsm/data/rhel-7.csv
index 42eb30064..e87713fbf 100644
--- a/lgsm/data/rhel-7.csv
+++ b/lgsm/data/rhel-7.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/rhel-8.csv b/lgsm/data/rhel-8.csv
index be5d943f6..cec514505 100644
--- a/lgsm/data/rhel-8.csv
+++ b/lgsm/data/rhel-8.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/rhel-9.csv b/lgsm/data/rhel-9.csv
index 14ea8335a..067674971 100644
--- a/lgsm/data/rhel-9.csv
+++ b/lgsm/data/rhel-9.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/rocky-8.csv b/lgsm/data/rocky-8.csv
index be5d943f6..cec514505 100644
--- a/lgsm/data/rocky-8.csv
+++ b/lgsm/data/rocky-8.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/rocky-9.csv b/lgsm/data/rocky-9.csv
index 14ea8335a..067674971 100644
--- a/lgsm/data/rocky-9.csv
+++ b/lgsm/data/rocky-9.csv
@@ -106,7 +106,7 @@ scpslsm
 sdtd,telnet,expect,libxml2
 sf
 sfc,ncurses-libs.i686
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/ubuntu-16.04.csv b/lgsm/data/ubuntu-16.04.csv
index 5b6b59898..da38f8616 100644
--- a/lgsm/data/ubuntu-16.04.csv
+++ b/lgsm/data/ubuntu-16.04.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/ubuntu-18.04.csv b/lgsm/data/ubuntu-18.04.csv
index 0b49d5d98..e0404abd4 100644
--- a/lgsm/data/ubuntu-18.04.csv
+++ b/lgsm/data/ubuntu-18.04.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/ubuntu-20.04.csv b/lgsm/data/ubuntu-20.04.csv
index 9b333383d..e1c15061c 100644
--- a/lgsm/data/ubuntu-20.04.csv
+++ b/lgsm/data/ubuntu-20.04.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/ubuntu-22.04.csv b/lgsm/data/ubuntu-22.04.csv
index 6c6062510..0252819cb 100644
--- a/lgsm/data/ubuntu-22.04.csv
+++ b/lgsm/data/ubuntu-22.04.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/ubuntu-23.04.csv b/lgsm/data/ubuntu-23.04.csv
index e3847fa01..812eae986 100644
--- a/lgsm/data/ubuntu-23.04.csv
+++ b/lgsm/data/ubuntu-23.04.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/ubuntu-23.10.csv b/lgsm/data/ubuntu-23.10.csv
index e3847fa01..812eae986 100644
--- a/lgsm/data/ubuntu-23.10.csv
+++ b/lgsm/data/ubuntu-23.10.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/data/ubuntu-24.04.csv b/lgsm/data/ubuntu-24.04.csv
index e3847fa01..812eae986 100644
--- a/lgsm/data/ubuntu-24.04.csv
+++ b/lgsm/data/ubuntu-24.04.csv
@@ -106,7 +106,7 @@ scpslsm,mono-complete
 sdtd,telnet,expect,libxml2-utils
 sf
 sfc,libtinfo5:i386
-sm
+sm,telnet,expect
 sof2
 sol
 squad
diff --git a/lgsm/modules/command_stop.sh b/lgsm/modules/command_stop.sh
index 3d534317a..29926f53a 100644
--- a/lgsm/modules/command_stop.sh
+++ b/lgsm/modules/command_stop.sh
@@ -195,6 +195,91 @@ fn_stop_graceful_sdtd() {
 	fi
 }
 
+# Attempts graceful shutdown of Soulmask using telnet.
+fn_stop_graceful_sm() {
+	fn_print_dots "Graceful: telnet"
+	fn_script_log_info "Graceful: telnet"
+	if [ "${telnetenabled}" == "false" ]; then
+		fn_print_info_nl "Graceful: telnet: DISABLED: Enable in ${servercfg}"
+	elif [ "$(command -v expect 2> /dev/null)" ]; then
+		# Tries to shutdown with both localhost and server IP.
+		for telnetip in 127.0.0.1 ${ip}; do
+			fn_print_dots "Graceful: telnet: ${telnetip}:${telnetport}"
+			fn_script_log_info "Graceful: telnet: ${telnetip}:${telnetport}"
+			fn_stop_graceful_sm_telnet
+			completed=$(echo -en "\n ${sm_telnet_shutdown}" | grep "Completed.")
+			refused=$(echo -en "\n ${sm_telnet_shutdown}" | grep "Timeout or EOF")
+			if [ "${refused}" ]; then
+				fn_print_error "Graceful: telnet: ${telnetip}:${telnetport} : "
+				fn_print_fail_eol_nl
+				fn_script_log_error "Graceful: telnet:  ${telnetip}:${telnetport} : FAIL"
+			elif [ "${completed}" ]; then
+				break
+			fi
+		done
+
+		# If telnet shutdown was successful will use telnet again to check
+		# the connection has closed, confirming that the tmux session can now be killed.
+		if [ "${completed}" ]; then
+			for seconds in {1..30}; do
+				fn_stop_graceful_sm_telnet
+				refused=$(echo -en "\n ${sm_telnet_shutdown}" | grep "Timeout or EOF")
+				if [ "${refused}" ]; then
+					fn_print_ok "Graceful: telnet: ${telnetip}:${telnetport} : "
+					fn_print_ok_eol_nl
+					fn_script_log_pass "Graceful: telnet: ${telnetip}:${telnetport} : ${seconds} seconds"
+					if [ "${statusalert}" == "on" ] && [ "${firstcommandname}" == "STOP" ]; then
+						alert="stopped"
+						alert.sh
+					fi
+					break
+				fi
+				fn_sleep_time_1
+				fn_print_dots "Graceful: telnet: ${seconds}"
+			done
+		# If telnet shutdown fails, show it and stop
+		else
+			if [ "${refused}" ]; then
+				fn_print_error "Graceful: telnet: "
+				fn_print_fail_eol_nl
+				fn_script_log_error "Graceful: telnet: ${telnetip}:${telnetport} : FAIL"
+			else
+				fn_print_error_nl "Graceful: telnet: Unknown error"
+				fn_script_log_error "Graceful: telnet: Unknown error"
+			fi
+			echo -en "\n" | tee -a "${lgsmlog}"
+			echo -en "Telnet output:" | tee -a "${lgsmlog}"
+			echo -en "\n ${sm_telnet_shutdown}" | tee -a "${lgsmlog}"
+			echo -en "\n\n" | tee -a "${lgsmlog}"
+		fi
+	else
+		fn_print_warn "Graceful: telnet: expect not installed: "
+		fn_print_fail_eol_nl
+		fn_script_log_warn "Graceful: telnet: expect not installed: FAIL"
+	fi
+}
+
+# telnet command for soulmask graceful shutdown.
+fn_stop_graceful_sm_telnet() {
+	sm_telnet_shutdown=$(expect -c '
+		proc abort {} {
+			puts "Timeout or EOF\n"
+			exit 1
+		}
+		spawn telnet '"${telnetip}"' '"${telnetport}"'
+		expect {
+			"session."  { send "saveworld 1\r" }
+			default         abort
+		}
+		expect {
+			"session."  { send "quit 1\r" }
+			default         abort
+		}
+		expect { eof }
+		puts "Completed.\n"
+	')
+}
+
 # Attempts graceful shutdown by sending /save /stop.
 fn_stop_graceful_avorion() {
 	fn_print_dots "Graceful: /save /stop"
@@ -253,6 +338,8 @@ fn_stop_graceful_select() {
 		fn_stop_graceful_cmd "end" 30
 	elif [ "${stopmode}" == "12" ]; then
 		fn_stop_graceful_cmd "shutdown" 30
+	elif [ "${stopmode}" == "13" ]; then
+		fn_stop_graceful_sm
 	fi
 }