Server tools API v3.1

2017-09-28 23:19:50 -04:00
parent d25894447e
commit 116041d621
14 changed files with 948 additions and 124 deletions
@@ -421,8 +421,8 @@
 		return

 	var/list/options = list("Regular Restart", "Hard Restart (No Delay/Feeback Reason)", "Hardest Restart (No actions, just reboot)")
-	if(world.RunningService())
-		options += "Service Restart (Force restart DD)";
+	if(SERVER_TOOLS_PRESENT)
+		options += "Server Restart (Kill and restart DD)";

 	var/rebootconfirm
 	if(SSticker.admin_delay_notice)
@@ -434,16 +434,19 @@
 		var/result = input(usr, "Select reboot method", "World Reboot", options[1]) as null|anything in options
 		if(result)
 			SSblackbox.add_details("admin_verb","Reboot World") //If you are copy-pasting this, ensure the 2nd parameter is unique to the new proc!
+			var/init_by = "Initiated by [usr.client.holder.fakekey ? "Admin" : usr.key]."
 			switch(result)
 				if("Regular Restart")
-					SSticker.Reboot("Initiated by [usr.client.holder.fakekey ? "Admin" : usr.key].", "admin reboot - by [usr.key] [usr.client.holder.fakekey ? "(stealth)" : ""]", 10)
+					SSticker.Reboot(init_by, "admin reboot - by [usr.key] [usr.client.holder.fakekey ? "(stealth)" : ""]", 10)
 				if("Hard Restart (No Delay, No Feeback Reason)")
+					to_chat(world, "World reboot - [init_by]")
 					world.Reboot()
 				if("Hardest Restart (No actions, just reboot)")
+					to_chat(world, "Hard world reboot - [init_by]")
 					world.Reboot(fast_track = TRUE)
-				if("Service Restart (Force restart DD)")
-					GLOB.reboot_mode = REBOOT_MODE_HARD
-					world.ServiceReboot()
+				if("Server Restart (Kill and restart DD)")
+					to_chat(world, "Server restart - [init_by]")
+					SERVER_TOOLS_REBOOT_BYOND

 /datum/admins/proc/end_round()
 	set category = "Server"
@@ -0,0 +1,63 @@
+#define IRC_STATUS_THROTTLE 5
+
+/datum/server_tools_command/ircstatus
+	name = "status"
+	help_text = "Gets the admincount, playercount, gamemode, and true game mode of the server"
+	admin_only = TRUE
+	var/static/last_irc_status = 0
+
+/datum/server_tools_command/ircstatus/Run(sender, params)
+	var/rtod = REALTIMEOFDAY
+	if(rtod - last_irc_status < IRC_STATUS_THROTTLE)
+		return
+	last_irc_status = rtod
+	var/list/adm = get_admin_counts()
+	var/list/allmins = adm["total"]
+	var/status = "Admins: [allmins.len] (Active: [english_list(adm["present"])] AFK: [english_list(adm["afk"])] Stealth: [english_list(adm["stealth"])] Skipped: [english_list(adm["noflags"])]). "
+	status += "Players: [GLOB.clients.len] (Active: [get_active_player_count(0,1,0)]). Mode: [SSticker.mode ? SSticker.mode.name : "Not started"]."
+	return status
+
+/datum/server_tools_command/irccheck
+	name = "check"
+	help_text = "Gets the playercount, gamemode, and address of the server"
+	admin_only = TRUE
+	var/static/last_irc_check = 0
+
+/datum/server_tools_command/irccheck/Run(sender, params)
+	var/rtod = REALTIMEOFDAY
+	if(rtod - last_irc_check < IRC_STATUS_THROTTLE)
+		return
+	last_irc_check = rtod
+	var/server = CONFIG_GET(string/server)
+	return "[GLOB.round_id ? "Round #[GLOB.round_id]: " : ""][GLOB.clients.len] players on [SSmapping.config.map_name], Mode: [GLOB.master_mode]; Round [SSticker.HasRoundStarted() ? (SSticker.IsRoundInProgress() ? "Active" : "Finishing") : "Starting"] -- [server ? server : "[world.internet_address]:[world.port]"]" 
+
+/datum/server_tools_command/ahelp
+	name = "ahelp"
+	help_text = "<ckey> <message|ticket <close|resolve|icissue|reject|reopen <ticket #>|list>>"
+	required_parameters = 2
+	admin_only = TRUE
+
+/datum/server_tools_command/ahelp/Run(sender, params)
+	var/list/all_params = splittext(params, " ")
+	var/target = all_params[1]
+	all_params.Cut(1, 2)
+	return IrcPm(target, all_params.Join(" "), sender)
+
+/datum/server_tools_command/namecheck
+	name = "namecheck"
+	help_text = "Returns info on the specified target"
+	required_parameters = 1
+	admin_only = TRUE
+
+/datum/server_tools_command/namecheck/Run(sender, params)
+	log_admin("IRC Name Check: [sender] on [params]")
+	message_admins("IRC name checking on [params] from [sender]")
+	return keywords_lookup(params, 1)
+
+/datum/server_tools_command/adminwho
+	name = "adminwho"
+	help_text = "Lists administrators currently on the server"
+	admin_only = TRUE
+
+/datum/server_tools_command/adminwho/Run(sender, params)
+	return ircadminwho()
@@ -587,10 +587,15 @@ GLOBAL_DATUM_INIT(ahelp_tickets, /datum/admin_help_tickets, new)


 /proc/send2irc(msg,msg2)
+<<<<<<< HEAD
 	if(world.RunningService())
 		world.ExportService("[SERVICE_REQUEST_IRC_ADMIN_CHANNEL_MESSAGE] [msg] | [msg2]")
 	else if(config.useircbot)
 		shell("python nudge.py [msg] [msg2]")
+=======
+	if(SERVER_TOOLS_PRESENT)
+		SERVER_TOOLS_RELAY_BROADCAST("[msg] | [msg2]")
+>>>>>>> 62f788f... Server tools API v3.1 (#31000)

 /proc/send2otherserver(source,msg,type = "Ahelp")
 	if(config.cross_allowed)
@@ -0,0 +1,76 @@
+/datum/server_tools_command
+	var/name = ""	//the string to trigger this command on a chat bot. e.g. TGS3_BOT: do_this_command
+	var/help_text = ""	//help text for this command
+	var/required_parameters = 0	//number of parameters required for this command
+	var/admin_only = FALSE	//set to TRUE if this command should only be usable by registered chat admins
+
+//override to implement command
+//sender is the display name of who sent the command
+//params is the trimmed string following the command name
+/datum/server_tools_command/proc/Run(sender, params)
+	CRASH("[type] has no implementation for Run()")
+
+/world/proc/ListServiceCustomCommands(warnings_only)
+	if(!warnings_only)
+		. = list()
+	var/list/command_name_types = list()
+	var/list/warned_command_names = warnings_only ? list() : null
+	for(var/I in typesof(/datum/server_tools_command) - /datum/server_tools_command)
+		var/datum/server_tools_command/stc = I
+		var/command_name = initial(stc.name)
+		var/static/list/warned_server_tools_names = list()
+		if(!command_name || findtext(command_name, " ") || findtext(command_name, "'") || findtext(command_name, "\""))
+			if(warnings_only && !warned_command_names[command_name])
+				SERVER_TOOLS_LOG("WARNING: Custom command [command_name] can't be used as it is empty or contains illegal characters!")
+				warned_command_names[command_name] = TRUE
+			continue
+		
+		if(command_name_types[command_name])
+			if(warnings_only)
+				SERVER_TOOLS_LOG("WARNING: Custom commands [command_name_types[command_name]] and [stc] have the same name, only [command_name_types[command_name]] will be available!")
+			continue
+		command_name_types[stc] = command_name
+
+		if(!warnings_only)
+			.[command_name] = list(SERVICE_JSON_PARAM_HELPTEXT = initial(stc.help_text), SERVICE_JSON_PARAM_ADMINONLY = initial(stc.admin_only), SERVICE_JSON_PARAM_REQUIREDPARAMETERS = initial(stc.required_parameters))
+
+/world/proc/HandleServiceCustomCommand(command, sender, params)
+	var/static/list/cached_custom_server_tools_commands
+	if(!cached_custom_server_tools_commands)
+		cached_custom_server_tools_commands = list()
+		for(var/I in typesof(/datum/server_tools_command) - /datum/server_tools_command)
+			var/datum/server_tools_command/stc = I
+			cached_custom_server_tools_commands[lowertext(initial(stc.name))] = stc
+
+	var/command_type = cached_custom_server_tools_commands[command]
+	if(!command_type)
+		return FALSE
+	var/datum/server_tools_command/stc = new command_type
+	return stc.Run(sender, params) || TRUE
+
+/*
+The MIT License
+
+Copyright (c) 2011 Dominic Tarr
+
+Permission is hereby granted, free of charge, 
+to any person obtaining a copy of this software and 
+associated documentation files (the "Software"), to 
+deal in the Software without restriction, including 
+without limitation the rights to use, copy, modify, 
+merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom 
+the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice 
+shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR 
+ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
@@ -0,0 +1,125 @@
+SERVER_TOOLS_DEFINE_AND_SET_GLOBAL(reboot_mode, REBOOT_MODE_NORMAL)
+SERVER_TOOLS_DEFINE_AND_SET_GLOBAL(server_tools_api_compatible, FALSE)
+
+/proc/GetTestMerges()
+	if(RunningService() && fexists(SERVICE_PR_TEST_JSON))
+		. = json_decode(file2text(SERVICE_PR_TEST_JSON))
+		if(.)
+			return
+	return list()
+
+/world/proc/ServiceInit()
+	if(!RunningService(TRUE))
+		return
+	ListServiceCustomCommands(TRUE)
+	ExportService("[SERVICE_REQUEST_API_VERSION] [SERVER_TOOLS_API_VERSION]", TRUE)
+
+/proc/RunningService(skip_compat_check = FALSE)
+	return (skip_compat_check || SERVER_TOOLS_READ_GLOBAL(server_tools_api_compatible)) && world.params[SERVICE_WORLD_PARAM] != null
+
+/proc/ServiceVersion()
+	if(RunningService(TRUE))
+		return world.params[SERVICE_VERSION_PARAM]
+
+/proc/ServiceAPIVersion()
+	return SERVICE_API_VERSION_STRING
+
+/world/proc/ExportService(command, skip_compat_check = FALSE)
+	. = FALSE
+	if(!RunningService(skip_compat_check))
+		return
+	if(skip_compat_check && !fexists(SERVICE_INTERFACE_DLL))
+		CRASH("Service parameter present but no interface DLL detected. This is symptomatic of running a service less than version 3.1! Please upgrade.")
+	call(SERVICE_INTERFACE_DLL, SERVICE_INTERFACE_FUNCTION)(command)	//trust no retval
+	return TRUE
+
+/world/proc/ChatBroadcast(message)
+	ExportService("[SERVICE_REQUEST_IRC_BROADCAST] [message]")
+
+/world/proc/AdminBroadcast(message)
+	ExportService("[SERVICE_REQUEST_IRC_ADMIN_CHANNEL_MESSAGE] [message]")
+
+/world/proc/ServiceEndProcess()
+	SERVER_TOOLS_LOG("Sending shutdown request!");
+	sleep(world.tick_lag)	//flush the buffers
+	ExportService(SERVICE_REQUEST_KILL_PROCESS)
+
+//called at the exact moment the world is supposed to reboot
+/world/proc/ServiceReboot()
+	switch(SERVER_TOOLS_READ_GLOBAL(reboot_mode))
+		if(REBOOT_MODE_HARD)
+			SERVER_TOOLS_WORLD_ANNOUNCE("Hard reboot triggered, you will automatically reconnect...")
+			ServiceEndProcess()
+		if(REBOOT_MODE_SHUTDOWN)
+			SERVER_TOOLS_WORLD_ANNOUNCE("The server is shutting down...")
+			ServiceEndProcess()
+		else
+			ExportService(SERVICE_REQUEST_WORLD_REBOOT)	//just let em know
+
+/world/proc/ServiceCommand(list/params)
+	var/their_sCK = params[SERVICE_CMD_PARAM_KEY]
+	if(!their_sCK || !RunningService(TRUE))
+		return FALSE	//continue world/Topic
+
+	var/sCK = world.params[SERVICE_WORLD_PARAM]
+	if(their_sCK != sCK)
+		return "Invalid comms key!";
+
+	var/command = params[SERVICE_CMD_PARAM_COMMAND]
+	if(!command)
+		return "No command!"
+
+	switch(command)
+		if(SERVICE_CMD_API_COMPATIBLE)
+			SERVER_TOOLS_WRITE_GLOBAL(server_tools_api_compatible, TRUE)
+			return "SUCCESS"
+		if(SERVICE_CMD_HARD_REBOOT)
+			if(SERVER_TOOLS_READ_GLOBAL(reboot_mode) != REBOOT_MODE_HARD)
+				SERVER_TOOLS_WRITE_GLOBAL(reboot_mode, REBOOT_MODE_HARD)
+				SERVER_TOOLS_LOG("Hard reboot requested by service")
+				SERVER_TOOLS_NOTIFY_ADMINS("The world will hard reboot at the end of the game. Requested by service.")
+		if(SERVICE_CMD_GRACEFUL_SHUTDOWN)
+			if(SERVER_TOOLS_READ_GLOBAL(reboot_mode) != REBOOT_MODE_SHUTDOWN)
+				SERVER_TOOLS_WRITE_GLOBAL(reboot_mode, REBOOT_MODE_SHUTDOWN)
+				SERVER_TOOLS_LOG("Shutdown requested by service")
+				message_admins("The world will shutdown at the end of the game. Requested by service.")
+		if(SERVICE_CMD_WORLD_ANNOUNCE)
+			var/msg = params["message"]
+			if(!istext(msg) || !msg)
+				return "No message set!"
+			SERVER_TOOLS_WORLD_ANNOUNCE(msg)
+			return "SUCCESS"
+		if(SERVICE_CMD_LIST_CUSTOM)
+			return json_encode(ListServiceCustomCommands(FALSE))
+		else
+			var/custom_command_result = HandleServiceCustomCommand(lowertext(command), params[SERVICE_CMD_PARAM_SENDER], params[SERVICE_CMD_PARAM_CUSTOM])
+			if(custom_command_result)
+				return istext(custom_command_result) ? custom_command_result : "SUCCESS"
+			return "Unknown command: [command]"
+
+/*
+The MIT License
+
+Copyright (c) 2011 Dominic Tarr
+
+Permission is hereby granted, free of charge, 
+to any person obtaining a copy of this software and 
+associated documentation files (the "Software"), to 
+deal in the Software without restriction, including 
+without limitation the rights to use, copy, modify, 
+merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom 
+the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice 
+shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR 
+ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/