Update TGS DMAPI (#2577)

Co-authored-by: ss13-beebot <[email protected]>

code/__DEFINES/tgs.dm

@@ -1,6 +1,6 @@
 // tgstation-server DMAPI
 
-#define TGS_DMAPI_VERSION "6.5.0"
+#define TGS_DMAPI_VERSION "6.6.2"
 
 // All functions and datums outside this document are subject to change with any version and should not be relied on.
 
@@ -129,6 +129,13 @@
 /// DreamDaemon Ultrasafe security level.
 #define TGS_SECURITY_ULTRASAFE 2
 
+/// DreamDaemon public visibility level.
+#define TGS_VISIBILITY_PUBLIC 0
+/// DreamDaemon private visibility level.
+#define TGS_VISIBILITY_PRIVATE 1
+/// DreamDaemon invisible visibility level.
+#define TGS_VISIBILITY_INVISIBLE 2
+
 //REQUIRED HOOKS
 
 /**
@@ -154,7 +161,7 @@
 #define TGS_TOPIC var/tgs_topic_return = TgsTopic(args[1]); if(tgs_topic_return) return tgs_topic_return
 
 /**
- * Call this as late as possible in [world/proc/Reboot].
+ * Call this as late as possible in [world/proc/Reboot] (BEFORE ..()).
  */
 /world/proc/TgsReboot()
 	return
@@ -458,6 +465,10 @@
 /world/proc/TgsSecurityLevel()
 	return
 
+/// Returns the current BYOND visibility level as a TGS_VISIBILITY_ define if TGS is present, null otherwise. Requires TGS to be using interop API version 5 or higher otherwise the string "___unimplemented" wil be returned. This function may sleep if the call to [/world/proc/TgsNew] is sleeping!
+/world/proc/TgsVisibility()
+	return
+
 /// Returns a list of active [/datum/tgs_revision_information/test_merge]s if TGS is present, null otherwise. This function may sleep if the call to [/world/proc/TgsNew] is sleeping!
 /world/proc/TgsTestMerges()
 	return

code/modules/tgs/core/_definitions.dm

@@ -1,2 +1,10 @@
+#if DM_VERSION < 510
+#error The TGS DMAPI does not support BYOND versions < 510!
+#endif
+
 #define TGS_UNIMPLEMENTED "___unimplemented"
 #define TGS_VERSION_PARAMETER "server_service_version"
+
+#ifndef TGS_DEBUG_LOG
+#define TGS_DEBUG_LOG(message)
+#endif

code/modules/tgs/core/core.dm

@@ -153,4 +153,9 @@
 /world/TgsSecurityLevel()
 	var/datum/tgs_api/api = TGS_READ_GLOBAL(tgs)
 	if(api)
-		api.SecurityLevel()
+		return api.SecurityLevel()
+
+/world/TgsVisibility()
+	var/datum/tgs_api/api = TGS_READ_GLOBAL(tgs)
+	if(api)
+		return api.Visibility()

code/modules/tgs/core/datum.dm

@@ -11,6 +11,15 @@ TGS_DEFINE_AND_SET_GLOBAL(tgs, null)
 	src.event_handler = event_handler
 	src.version = version
 
+/datum/tgs_api/proc/TerminateWorld()
+	while(TRUE)
+		TGS_DEBUG_LOG("About to terminate world. Tick: [world.time], sleep_offline: [world.sleep_offline]")
+		world.sleep_offline = FALSE // https://www.byond.com/forum/post/2894866
+		del(world)
+		world.sleep_offline = FALSE // just in case, this is BYOND after all...
+		sleep(1)
+		TGS_DEBUG_LOG("BYOND DIDN'T TERMINATE THE WORLD!!! TICK IS: [world.time], sleep_offline: [world.sleep_offline]")
+
 /datum/tgs_api/latest
 	parent_type = /datum/tgs_api/v5
 
@@ -57,3 +66,6 @@ TGS_PROTECT_DATUM(/datum/tgs_api)
 
 /datum/tgs_api/proc/SecurityLevel()
 	return TGS_UNIMPLEMENTED
+
+/datum/tgs_api/proc/Visibility()
+	return TGS_UNIMPLEMENTED

code/modules/tgs/v3210/commands.dm

@@ -47,12 +47,12 @@
 	user.friendly_name = sender
 
 	// Discord hack, fix the mention if it's only numbers (fuck you IRC trolls)
-	var/regex/discord_id_regex = regex(@"^[0-9]+$")
+	var/regex/discord_id_regex = regex("^\[0-9\]+$")
 	if(findtext(sender, discord_id_regex))
 		sender = "<@[sender]>"
 
 	user.mention = sender
 	var/datum/tgs_message_content/result = stc.Run(user, params)
 	result = UpgradeDeprecatedCommandResponse(result, command)
 
-	return result?.text || TRUE
+	return result ? result.text : TRUE

code/modules/tgs/v4/api.dm

@@ -73,7 +73,7 @@
 	if(cached_json["apiValidateOnly"])
 		TGS_INFO_LOG("Validating API and exiting...")
 		Export(TGS4_COMM_VALIDATE, list(TGS4_PARAMETER_DATA = "[minimum_required_security_level]"))
-		del(world)
+		TerminateWorld()
 
 	security_level = cached_json["securityLevel"]
 	chat_channels_json_path = cached_json["chatChannelsJson"]
@@ -188,24 +188,24 @@
 		requesting_new_port = TRUE
 		if(!world.OpenPort(0)) //open any port
 			TGS_ERROR_LOG("Unable to open random port to retrieve new port![TGS4_PORT_CRITFAIL_MESSAGE]")
-			del(world)
+			TerminateWorld()
 
 		//request a new port
 		export_lock = FALSE
 		var/list/new_port_json = Export(TGS4_COMM_NEW_PORT, list(TGS4_PARAMETER_DATA = "[world.port]"), TRUE) //stringify this on purpose
 
 		if(!new_port_json)
 			TGS_ERROR_LOG("No new port response from server![TGS4_PORT_CRITFAIL_MESSAGE]")
-			del(world)
+			TerminateWorld()
 
 		var/new_port = new_port_json[TGS4_PARAMETER_DATA]
 		if(!isnum(new_port) || new_port <= 0)
 			TGS_ERROR_LOG("Malformed new port json ([json_encode(new_port_json)])![TGS4_PORT_CRITFAIL_MESSAGE]")
-			del(world)
+			TerminateWorld()
 
 		if(new_port != world.port && !world.OpenPort(new_port))
 			TGS_ERROR_LOG("Unable to open port [new_port]![TGS4_PORT_CRITFAIL_MESSAGE]")
-			del(world)
+			TerminateWorld()
 		requesting_new_port = FALSE
 
 	while(export_lock)

code/modules/tgs/v4/commands.dm

@@ -40,5 +40,5 @@
 		var/datum/tgs_message_content/result = sc.Run(u, params)
 		result = UpgradeDeprecatedCommandResponse(result, command)
 
-		return result?.text
+		return result ? result.text : TRUE
 	return "Unknown command: [command]!"

code/modules/tgs/v5/__interop_version.dm

@@ -1 +1 @@
-"5.6.1"
+"5.6.2"

code/modules/tgs/v5/_defines.dm

@@ -5,8 +5,8 @@
 #define DMAPI5_TOPIC_DATA "tgs_data"
 
 #define DMAPI5_BRIDGE_REQUEST_LIMIT 8198
-#define DMAPI5_TOPIC_REQUEST_LIMIT 65529
-#define DMAPI5_TOPIC_RESPONSE_LIMIT 65528
+#define DMAPI5_TOPIC_REQUEST_LIMIT 65528
+#define DMAPI5_TOPIC_RESPONSE_LIMIT 65529
 
 #define DMAPI5_BRIDGE_COMMAND_PORT_UPDATE 0
 #define DMAPI5_BRIDGE_COMMAND_STARTUP 1
@@ -48,6 +48,7 @@
 #define DMAPI5_RUNTIME_INFORMATION_REVISION "revision"
 #define DMAPI5_RUNTIME_INFORMATION_TEST_MERGES "testMerges"
 #define DMAPI5_RUNTIME_INFORMATION_SECURITY_LEVEL "securityLevel"
+#define DMAPI5_RUNTIME_INFORMATION_VISIBILITY "visibility"
 
 #define DMAPI5_CHAT_UPDATE_CHANNELS "channels"
 

code/modules/tgs/v5/api.dm

@@ -4,6 +4,7 @@
 
 	var/instance_name
 	var/security_level
+	var/visibility
 
 	var/reboot_mode = TGS_REBOOT_MODE_NORMAL
 
@@ -22,12 +23,17 @@
 
 	var/detached = FALSE
 
+/datum/tgs_api/v5/New()
+	. = ..()
+	TGS_DEBUG_LOG("V5 API created")
+
 /datum/tgs_api/v5/ApiVersion()
 	return new /datum/tgs_version(
 		#include "__interop_version.dm"
 	)
 
 /datum/tgs_api/v5/OnWorldNew(minimum_required_security_level)
+	TGS_DEBUG_LOG("OnWorldNew()")
 	server_port = world.params[DMAPI5_PARAM_SERVER_PORT]
 	access_identifier = world.params[DMAPI5_PARAM_ACCESS_IDENTIFIER]
 
@@ -45,10 +51,11 @@
 
 	if(runtime_information[DMAPI5_RUNTIME_INFORMATION_API_VALIDATE_ONLY])
 		TGS_INFO_LOG("DMAPI validation, exiting...")
-		del(world)
+		TerminateWorld()
 
 	version = new /datum/tgs_version(runtime_information[DMAPI5_RUNTIME_INFORMATION_SERVER_VERSION])
 	security_level = runtime_information[DMAPI5_RUNTIME_INFORMATION_SECURITY_LEVEL]
+	visibility = runtime_information[DMAPI5_RUNTIME_INFORMATION_VISIBILITY]
 	instance_name = runtime_information[DMAPI5_RUNTIME_INFORMATION_INSTANCE_NAME]
 
 	var/list/revisionData = runtime_information[DMAPI5_RUNTIME_INFORMATION_REVISION]
@@ -96,17 +103,28 @@
 	return TRUE
 
 /datum/tgs_api/v5/proc/RequireInitialBridgeResponse()
+	TGS_DEBUG_LOG("RequireInitialBridgeResponse()")
+	var/logged = FALSE
 	while(!version)
+		if(!logged)
+			TGS_DEBUG_LOG("RequireInitialBridgeResponse: Starting sleep")
+			logged = TRUE
+
 		sleep(1)
 
+	TGS_DEBUG_LOG("RequireInitialBridgeResponse: Passed")
+
 /datum/tgs_api/v5/OnInitializationComplete()
 	Bridge(DMAPI5_BRIDGE_COMMAND_PRIME)
 
 /datum/tgs_api/v5/OnTopic(T)
+	TGS_DEBUG_LOG("OnTopic()")
 	RequireInitialBridgeResponse()
+	TGS_DEBUG_LOG("OnTopic passed bridge request gate")
 	var/list/params = params2list(T)
 	var/json = params[DMAPI5_TOPIC_DATA]
 	if(!json)
+		TGS_DEBUG_LOG("No \"[DMAPI5_TOPIC_DATA]\" entry found, ignoring...")
 		return FALSE // continue to /world/Topic
 
 	if(!initialized)
@@ -156,7 +174,7 @@
 	TGS_WARNING_LOG("Received legacy string when a [/datum/tgs_message_content] was expected. Please audit all calls to TgsChatBroadcast, TgsChatTargetedBroadcast, and TgsChatPrivateMessage to ensure they use the new /datum.")
 	return new /datum/tgs_message_content(message)
 
-/datum/tgs_api/v5/ChatBroadcast(datum/tgs_message_content/message, list/channels)
+/datum/tgs_api/v5/ChatBroadcast(datum/tgs_message_content/message2, list/channels)
 	if(!length(channels))
 		channels = ChatChannelInfo()
 
@@ -165,52 +183,53 @@
 		var/datum/tgs_chat_channel/channel = I
 		ids += channel.id
 
-	message = UpgradeDeprecatedChatMessage(message)
+	message2 = UpgradeDeprecatedChatMessage(message2)
 
 	if (!length(channels))
 		return
 
-	message = message._interop_serialize()
-	message[DMAPI5_CHAT_MESSAGE_CHANNEL_IDS] = ids
+	var/list/data = message2._interop_serialize()
+	data[DMAPI5_CHAT_MESSAGE_CHANNEL_IDS] = ids
 	if(intercepted_message_queue)
-		intercepted_message_queue += list(message)
+		intercepted_message_queue += list(data)
 	else
-		Bridge(DMAPI5_BRIDGE_COMMAND_CHAT_SEND, list(DMAPI5_BRIDGE_PARAMETER_CHAT_MESSAGE = message))
+		Bridge(DMAPI5_BRIDGE_COMMAND_CHAT_SEND, list(DMAPI5_BRIDGE_PARAMETER_CHAT_MESSAGE = data))
 
-/datum/tgs_api/v5/ChatTargetedBroadcast(datum/tgs_message_content/message, admin_only)
+/datum/tgs_api/v5/ChatTargetedBroadcast(datum/tgs_message_content/message2, admin_only)
 	var/list/channels = list()
 	for(var/I in ChatChannelInfo())
 		var/datum/tgs_chat_channel/channel = I
 		if (!channel.is_private_channel && ((channel.is_admin_channel && admin_only) || (!channel.is_admin_channel && !admin_only)))
 			channels += channel.id
 
-	message = UpgradeDeprecatedChatMessage(message)
+	message2 = UpgradeDeprecatedChatMessage(message2)
 
 	if (!length(channels))
 		return
 
-	message = message._interop_serialize()
-	message[DMAPI5_CHAT_MESSAGE_CHANNEL_IDS] = channels
+	var/list/data = message2._interop_serialize()
+	data[DMAPI5_CHAT_MESSAGE_CHANNEL_IDS] = channels
 	if(intercepted_message_queue)
-		intercepted_message_queue += list(message)
+		intercepted_message_queue += list(data)
 	else
-		Bridge(DMAPI5_BRIDGE_COMMAND_CHAT_SEND, list(DMAPI5_BRIDGE_PARAMETER_CHAT_MESSAGE = message))
+		Bridge(DMAPI5_BRIDGE_COMMAND_CHAT_SEND, list(DMAPI5_BRIDGE_PARAMETER_CHAT_MESSAGE = data))
 
-/datum/tgs_api/v5/ChatPrivateMessage(datum/tgs_message_content/message, datum/tgs_chat_user/user)
-	message = UpgradeDeprecatedChatMessage(message)
-	message = message._interop_serialize()
-	message[DMAPI5_CHAT_MESSAGE_CHANNEL_IDS] = list(user.channel.id)
+/datum/tgs_api/v5/ChatPrivateMessage(datum/tgs_message_content/message2, datum/tgs_chat_user/user)
+	message2 = UpgradeDeprecatedChatMessage(message2)
+	var/list/data = message2._interop_serialize()
+	data[DMAPI5_CHAT_MESSAGE_CHANNEL_IDS] = list(user.channel.id)
 	if(intercepted_message_queue)
-		intercepted_message_queue += list(message)
+		intercepted_message_queue += list(data)
 	else
-		Bridge(DMAPI5_BRIDGE_COMMAND_CHAT_SEND, list(DMAPI5_BRIDGE_PARAMETER_CHAT_MESSAGE = message))
+		Bridge(DMAPI5_BRIDGE_COMMAND_CHAT_SEND, list(DMAPI5_BRIDGE_PARAMETER_CHAT_MESSAGE = data))
 
 /datum/tgs_api/v5/ChatChannelInfo()
 	RequireInitialBridgeResponse()
 	WaitForReattach(TRUE)
 	return chat_channels.Copy()
 
 /datum/tgs_api/v5/proc/DecodeChannels(chat_update_json)
+	TGS_DEBUG_LOG("DecodeChannels()")
 	var/list/chat_channels_json = chat_update_json[DMAPI5_CHAT_UPDATE_CHANNELS]
 	if(istype(chat_channels_json))
 		chat_channels.Cut()
@@ -235,3 +254,7 @@
 /datum/tgs_api/v5/SecurityLevel()
 	RequireInitialBridgeResponse()
 	return security_level
+
+/datum/tgs_api/v5/Visibility()
+	RequireInitialBridgeResponse()
+	return visibility

code/modules/tgs/v5/commands.dm

@@ -35,10 +35,10 @@
 	if(sc)
 		var/datum/tgs_message_content/response = sc.Run(u, params)
 		response = UpgradeDeprecatedCommandResponse(response, command)
-		
+
 		var/list/topic_response = TopicResponse()
-		topic_response[DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE_MESSAGE] = response?.text
-		topic_response[DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE] = response?._interop_serialize()
+		topic_response[DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE_MESSAGE] = response ? response.text : null
+		topic_response[DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE] = response ? response._interop_serialize() : null
 		return topic_response
 	return TopicResponse("Unknown custom chat command: [command]!")
 

code/modules/tgs/v5/serializers.dm

@@ -1,12 +1,12 @@
 /datum/tgs_message_content/proc/_interop_serialize()
-	return list("text" = text, "embed" = embed?._interop_serialize())
+	return list("text" = text, "embed" = embed ? embed._interop_serialize() : null)
 
 /datum/tgs_chat_embed/proc/_interop_serialize()
 	CRASH("Base /proc/interop_serialize called on [type]!")
 
 /datum/tgs_chat_embed/structure/_interop_serialize()
 	var/list/serialized_fields
-	if(islist(fields))
+	if(istype(fields, /list))
 		serialized_fields = list()
 		for(var/datum/tgs_chat_embed/field/field as anything in fields)
 			serialized_fields += list(field._interop_serialize())
@@ -16,12 +16,12 @@
 		"url" = url,
 		"timestamp" = timestamp,
 		"colour" = colour,
-		"image" = image?._interop_serialize(),
-		"thumbnail" = thumbnail?._interop_serialize(),
-		"video" = video?._interop_serialize(),
-		"footer" = footer?._interop_serialize(),
-		"provider" = provider?._interop_serialize(),
-		"author" = author?._interop_serialize(),
+		"image" = src.image ? src.image._interop_serialize() : null,
+		"thumbnail" = thumbnail ? thumbnail._interop_serialize() : null,
+		"video" = video ? video._interop_serialize() : null,
+		"footer" = footer ? footer._interop_serialize() : null,
+		"provider" = provider ? provider._interop_serialize() : null,
+		"author" = author ? author._interop_serialize() : null,
 		"fields" = serialized_fields
 	)
 
@@ -43,7 +43,7 @@
 	. = ..()
 	.["iconUrl"] = icon_url
 	.["proxyIconUrl"] = proxy_icon_url
-	
+
 /datum/tgs_chat_embed/footer/_interop_serialize()
 	return list(
 		"text" = text,