Update TGS DMAPI

code/__DEFINES/tgs.dm

@@ -1,6 +1,6 @@
 // tgstation-server DMAPI
 
-#define TGS_DMAPI_VERSION "5.2.8"
+#define TGS_DMAPI_VERSION "6.0.3"
 
 // All functions and datums outside this document are subject to change with any version and should not be relied on.
 
@@ -67,7 +67,7 @@
 #define TGS_EVENT_REPO_CHECKOUT 1
 /// When the repository performs a fetch operation. No parameters
 #define TGS_EVENT_REPO_FETCH 2
-/// When the repository merges a pull request. Parameters: PR Number, PR Sha, (Nullable) Comment made by TGS user
+/// When the repository test merges. Parameters: PR Number, PR Sha, (Nullable) Comment made by TGS user
 #define TGS_EVENT_REPO_MERGE_PULL_REQUEST 3
 /// Before the repository makes a sychronize operation. Parameters: Absolute repostiory path
 #define TGS_EVENT_REPO_PRE_SYNCHRONIZE 4
@@ -95,8 +95,13 @@
 #define TGS_EVENT_WATCHDOG_SHUTDOWN 15
 /// Before the watchdog detaches for a TGS update/restart. No parameters.
 #define TGS_EVENT_WATCHDOG_DETACH 16
-// We don't actually implement this value as the DMAPI can never receive it
+// We don't actually implement these 4 events as the DMAPI can never receive them.
 // #define TGS_EVENT_WATCHDOG_LAUNCH 17
+// #define TGS_EVENT_WATCHDOG_CRASH 18
+// #define TGS_EVENT_WORLD_END_PROCESS 19
+// #define TGS_EVENT_WORLD_REBOOT 20
+/// Watchdog event when TgsInitializationComplete() is called. No parameters.
+#define TGS_EVENT_WORLD_PRIME 21
 
 // OTHER ENUMS
 
@@ -117,31 +122,30 @@
 //REQUIRED HOOKS
 
 /**
-  * Call this somewhere in [/world/proc/New] that is always run. This function may sleep!
-  *
-  * * event_handler - Optional user defined [/datum/tgs_event_handler].
-  * * minimum_required_security_level: The minimum required security level to run the game in which the DMAPI is integrated. Can be one of [TGS_SECURITY_ULTRASAFE], [TGS_SECURITY_SAFE], or [TGS_SECURITY_TRUSTED].
-  */
+ * Call this somewhere in [/world/proc/New] that is always run. This function may sleep!
+ *
+ * * event_handler - Optional user defined [/datum/tgs_event_handler].
+ * * minimum_required_security_level: The minimum required security level to run the game in which the DMAPI is integrated. Can be one of [TGS_SECURITY_ULTRASAFE], [TGS_SECURITY_SAFE], or [TGS_SECURITY_TRUSTED].
+ */
 /world/proc/TgsNew(datum/tgs_event_handler/event_handler, minimum_required_security_level = TGS_SECURITY_ULTRASAFE)
 	return
 
 /**
-  * Call this when your initializations are complete and your game is ready to play before any player interactions happen.
-  *
-  * This may use [/world/var/sleep_offline] to make this happen so ensure no changes are made to it while this call is running.
-  * Afterwards, consider explicitly setting it to what you want to avoid this BYOND bug: http://www.byond.com/forum/post/2575184
-  * Before this point, note that any static files or directories may be in use by another server. Your code should account for this.
-  * This function should not be called before ..() in [/world/proc/New].
-  */
+ * Call this when your initializations are complete and your game is ready to play before any player interactions happen.
+ *
+ * This may use [/world/var/sleep_offline] to make this happen so ensure no changes are made to it while this call is running.
+ * Afterwards, consider explicitly setting it to what you want to avoid this BYOND bug: http://www.byond.com/forum/post/2575184
+ * This function should not be called before ..() in [/world/proc/New].
+ */
 /world/proc/TgsInitializationComplete()
 	return
 
 /// Put this at the start of [/world/proc/Topic].
 #define TGS_TOPIC var/tgs_topic_return = TgsTopic(args[1]); if(tgs_topic_return) return tgs_topic_return
 
 /**
-  * Call this at the beginning of [world/proc/Reboot].
-  */
+ * Call this as late as possible in [world/proc/Reboot].
+ */
 /world/proc/TgsReboot()
 	return
 
@@ -152,6 +156,8 @@
 /datum/tgs_revision_information
 	/// Full SHA of the commit.
 	var/commit
+	/// ISO 8601 timestamp of when the commit was created
+	var/timestamp
 	/// Full sha of last known remote commit. This may be null if the TGS repository is not currently tracking a remote branch.
 	var/origin_commit
 
@@ -175,36 +181,34 @@
 	var/deprefixed_parameter
 
 /**
-  * Returns [TRUE]/[FALSE] based on if the [/datum/tgs_version] contains wildcards.
-  */
+ * Returns [TRUE]/[FALSE] based on if the [/datum/tgs_version] contains wildcards.
+ */
 /datum/tgs_version/proc/Wildcard()
 	return
 
 /**
-  * Returns [TRUE]/[FALSE] based on if the [/datum/tgs_version] equals some other version.
-  *
-  * other_version - The [/datum/tgs_version] to compare against.
-  */
+ * Returns [TRUE]/[FALSE] based on if the [/datum/tgs_version] equals some other version.
+ *
+ * other_version - The [/datum/tgs_version] to compare against.
+ */
 /datum/tgs_version/proc/Equals(datum/tgs_version/other_version)
 	return
 
 /// Represents a merge of a GitHub pull request.
 /datum/tgs_revision_information/test_merge
-	/// The pull request number.
+	/// The test merge number.
 	var/number
-	/// The pull request title when it was merged.
+	/// The test merge source's title when it was merged.
 	var/title
-	/// The pull request body when it was merged.
+	/// The test merge source's body when it was merged.
 	var/body
-	/// The GitHub username of the pull request's author.
+	/// The Username of the test merge source's author.
 	var/author
-	/// An http URL to the pull request.
+	/// An http URL to the test merge source.
 	var/url
-	/// The SHA of the pull request when that was merged.
-	var/pull_request_commit
-	/// ISO 8601 timestamp of when the pull request was merged.
-	var/time_merged
-	/// (Nullable) Comment left by the TGS user who initiated the merge..
+	/// The SHA of the test merge when that was merged.
+	var/head_commit
+	/// Optional comment left by the TGS user who initiated the merge.
 	var/comment
 
 /// Represents a connected chat channel.
@@ -234,10 +238,10 @@
 	var/datum/tgs_chat_channel/channel
 
 /**
-  * User definable callback for handling TGS events.
-  *
-  * event_code - One of the TGS_EVENT_ defines. Extra parameters will be documented in each
-  */
+ * User definable callback for handling TGS events.
+ *
+ * event_code - One of the TGS_EVENT_ defines. Extra parameters will be documented in each
+ */
 /datum/tgs_event_handler/proc/HandleEvent(event_code, ...)
 	set waitfor = FALSE
 	return
@@ -252,67 +256,67 @@
 	var/admin_only = FALSE
 
 /**
-  * Process command activation. Should return a string to respond to the issuer with.
-  *
-  * sender - The [/datum/tgs_chat_user] who issued the command.
-  * params - The trimmed string following the command `/datum/tgs_chat_command/var/name].
-  */
+ * Process command activation. Should return a string to respond to the issuer with.
+ *
+ * sender - The [/datum/tgs_chat_user] who issued the command.
+ * params - The trimmed string following the command `/datum/tgs_chat_command/var/name].
+ */
 /datum/tgs_chat_command/proc/Run(datum/tgs_chat_user/sender, params)
 	CRASH("[type] has no implementation for Run()")
 
 // API FUNCTIONS
 
 /// Returns the maximum supported [/datum/tgs_version] of the DMAPI.
-/world/proc/TgsMaximumAPIVersion()
+/world/proc/TgsMaximumApiVersion()
 	return
 
 /// Returns the minimum supported [/datum/tgs_version] of the DMAPI.
-/world/proc/TgsMinimumAPIVersion()
+/world/proc/TgsMinimumApiVersion()
 	return
 
 /**
-  * Returns [TRUE] if DreamDaemon was launched under TGS, the API matches, and was properly initialized. [FALSE] will be returned otherwise.
-  */
+ * Returns [TRUE] if DreamDaemon was launched under TGS, the API matches, and was properly initialized. [FALSE] will be returned otherwise.
+ */
 /world/proc/TgsAvailable()
 	return
 
 // No function below this succeeds if it TgsAvailable() returns FALSE or if TgsNew() has yet to be called.
 
 /**
-  * Forces a hard reboot of DreamDaemon by ending the process.
-  *
-  * Unlike del(world) clients will try to reconnect.
-  * If TGS has not requested a [TGS_REBOOT_MODE_SHUTDOWN] DreamDaemon will be launched again
-  */
+ * Forces a hard reboot of DreamDaemon by ending the process.
+ *
+ * Unlike del(world) clients will try to reconnect.
+ * If TGS has not requested a [TGS_REBOOT_MODE_SHUTDOWN] DreamDaemon will be launched again
+ */
 /world/proc/TgsEndProcess()
 	return
 
 /**
-  * Send a message to connected chats.
-  *
-  * message - The string to send.
-  * admin_only: If [TRUE], message will be sent to admin connected chats. Vice-versa applies.
-  */
+ * Send a message to connected chats.
+ *
+ * message - The string to send.
+ * admin_only: If [TRUE], message will be sent to admin connected chats. Vice-versa applies.
+ */
 /world/proc/TgsTargetedChatBroadcast(message, admin_only = FALSE)
 	return
 
 /**
-  * Send a private message to a specific user.
-  *
-  * message - The string to send.
-  * user: The [/datum/tgs_chat_user] to PM.
-  */
+ * Send a private message to a specific user.
+ *
+ * message - The string to send.
+ * user: The [/datum/tgs_chat_user] to PM.
+ */
 /world/proc/TgsChatPrivateMessage(message, datum/tgs_chat_user/user)
 	return
 
 // The following functions will sleep if a call to TgsNew() is sleeping
 
 /**
-  * Send a message to connected chats that are flagged as game-related in TGS.
-  *
-  * message - The string to send.
-  * channels - Optional list of [/datum/tgs_chat_channel]s to restrict the message to.
-  */
+ * Send a message to connected chats that are flagged as game-related in TGS.
+ *
+ * message - The string to send.
+ * channels - Optional list of [/datum/tgs_chat_channel]s to restrict the message to.
+ */
 /world/proc/TgsChatBroadcast(message, list/channels = null)
 	return
 

code/modules/tgs/core/core.dm

@@ -40,7 +40,7 @@
 		if(5)
 			api_datum = /datum/tgs_api/v5
 
-	var/datum/tgs_version/max_api_version = TgsMaximumAPIVersion();
+	var/datum/tgs_version/max_api_version = TgsMaximumApiVersion();
 	if(version.suite != null && version.minor != null && version.patch != null && version.deprecated_patch != null && version.deprefixed_parameter > max_api_version.deprefixed_parameter)
 		TGS_ERROR_LOG("Detected unknown API version! Defaulting to latest. Update the DMAPI to fix this problem.")
 		api_datum = /datum/tgs_api/latest
@@ -64,10 +64,10 @@
 		TGS_WRITE_GLOBAL(tgs, null)
 		TGS_ERROR_LOG("Failed to activate API!")
 
-/world/TgsMaximumAPIVersion()
+/world/TgsMaximumApiVersion()
 	return new /datum/tgs_version("5.x.x")
 
-/world/TgsMinimumAPIVersion()
+/world/TgsMinimumApiVersion()
 	return new /datum/tgs_version("3.2.x")
 
 /world/TgsInitializationComplete()

code/modules/tgs/v3210/api.dm

@@ -62,7 +62,7 @@
 	comms_key = world.params[SERVICE_WORLD_PARAM]
 	instance_name = world.params[SERVICE_INSTANCE_PARAM]
 	if(!instance_name)
-		instance_name = "TG Station Server"	//maybe just upgraded
+		instance_name = "TG Station Server" //maybe just upgraded
 
 	var/list/logs = file2list(".git/logs/HEAD")
 	if(logs.len)
@@ -92,14 +92,14 @@
 	if(skip_compat_check && !fexists(SERVICE_INTERFACE_DLL))
 		TGS_ERROR_LOG("Service parameter present but no interface DLL detected. This is symptomatic of running a service less than version 3.1! Please upgrade.")
 		return
-	call(SERVICE_INTERFACE_DLL, SERVICE_INTERFACE_FUNCTION)(instance_name, command)	//trust no retval
+	call(SERVICE_INTERFACE_DLL, SERVICE_INTERFACE_FUNCTION)(instance_name, command) //trust no retval
 	return TRUE
 
 /datum/tgs_api/v3210/OnTopic(T)
 	var/list/params = params2list(T)
 	var/their_sCK = params[SERVICE_CMD_PARAM_KEY]
 	if(!their_sCK)
-		return FALSE	//continue world/Topic
+		return FALSE //continue world/Topic
 
 	if(their_sCK != comms_key)
 		return "Invalid comms key!";
@@ -160,7 +160,7 @@
 		var/datum/tgs_revision_information/test_merge/tm = new
 		tm.number = text2num(I)
 		var/list/entry = json[I]
-		tm.pull_request_commit = entry["commit"]
+		tm.head_commit = entry["commit"]
 		tm.author = entry["author"]
 		tm.title = entry["title"]
 		. += tm
@@ -176,7 +176,7 @@
 	return ri
 
 /datum/tgs_api/v3210/EndProcess()
-	sleep(world.tick_lag)	//flush the buffers
+	sleep(world.tick_lag) //flush the buffers
 	ExportService(SERVICE_REQUEST_KILL_PROCESS)
 
 /datum/tgs_api/v3210/ChatChannelInfo()

code/modules/tgs/v4/api.dm

@@ -92,7 +92,7 @@
 	var/list/json = cached_json["testMerges"]
 	for(var/entry in json)
 		var/datum/tgs_revision_information/test_merge/tm = new
-		tm.time_merged = text2num(entry["timeMerged"])
+		tm.timestamp = text2num(entry["timeMerged"])
 
 		var/list/revInfo = entry["revision"]
 		if(revInfo)
@@ -104,7 +104,7 @@
 		tm.url = entry["url"]
 		tm.author = entry["author"]
 		tm.number = entry["number"]
-		tm.pull_request_commit = entry["pullRequestRevision"]
+		tm.head_commit = entry["pullRequestRevision"]
 		tm.comment = entry["comment"]
 
 		cached_test_merges += tm
@@ -118,7 +118,7 @@
 	var/list/params = params2list(T)
 	var/their_sCK = params[TGS4_INTEROP_ACCESS_IDENTIFIER]
 	if(!their_sCK)
-		return FALSE	//continue world/Topic
+		return FALSE //continue world/Topic
 
 	if(their_sCK != access_identifier)
 		return "Invalid comms key!";
@@ -192,7 +192,7 @@
 
 		//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
+		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]")
@@ -235,7 +235,7 @@
 
 	var/port = result[TGS4_PARAMETER_DATA]
 	if(!isnum(port))
-		return	//this is valid, server may just want use to reboot
+		return //this is valid, server may just want use to reboot
 
 	if(port == 0)
 		//to byond 0 means any port and "none" means close vOv

code/modules/tgs/v5/README.md

@@ -1,4 +1,4 @@
-# DMAPI V4
+# DMAPI V5
 
 This DMAPI implements bridge requests using HTTP GET requests to TGS. It has no security restrictions.
 

code/modules/tgs/v5/_defines.dm

@@ -79,6 +79,7 @@
 #define DMAPI5_TOPIC_RESPONSE_CHAT_RESPONSES "chatResponses"
 
 #define DMAPI5_REVISION_INFORMATION_COMMIT_SHA "commitSha"
+#define DMAPI5_REVISION_INFORMATION_TIMESTAMP "timestamp"
 #define DMAPI5_REVISION_INFORMATION_ORIGIN_COMMIT_SHA "originCommitSha"
 
 #define DMAPI5_CHAT_USER_ID "id"