config&copypaste chang.

2020-08-20 16:36:24 +08:00
parent 3b7bca28b3
commit 2dd3d71b19
15 changed files with 614 additions and 332 deletions
@@ -14,13 +14,15 @@
 	var/list/modes			// allowed modes
 	var/list/gamemode_cache
 	var/list/votable_modes		// votable modes
-	// var/list/ic_filter_regex
 	var/list/storyteller_cache
 	var/list/mode_names
 	var/list/mode_reports
 	var/list/mode_false_report_weight

 	var/motd
+	// var/policy
+
+	// var/static/regex/ic_filter_regex

 /datum/controller/configuration/proc/admin_reload()
 	if(IsAdminAdvancedProcCall())
@@ -50,6 +52,11 @@
 				break
 	loadmaplist(CONFIG_MAPS_FILE)
 	LoadMOTD()
+	// LoadPolicy()
+	// LoadChatFilter()
+
+	if (Master)
+		Master.OnConfigLoad()

 /datum/controller/configuration/proc/full_wipe()
 	if(IsAdminAdvancedProcCall())
@@ -105,9 +112,7 @@
 	var/list/lines = world.file2list("[directory]/[filename]")
 	var/list/_entries = entries
 	var/list/postload_required = list()
-	var/linenumber = 0
 	for(var/L in lines)
-		linenumber++
 		L = trim(L)
 		if(!L)
 			continue
@@ -135,7 +140,7 @@

 		if(entry == "$include")
 			if(!value)
-				log_config("LINE [linenumber]: Invalid $include directive: [value]")
+				log_config("Warning: Invalid $include directive: [value]")
 			else
 				LoadEntries(value, stack)
 				++.
@@ -143,7 +148,7 @@

 		var/datum/config_entry/E = _entries[entry]
 		if(!E)
-			log_config("LINE [linenumber]: Unknown setting: '[entry]'")
+			log_config("Unknown setting in configuration: '[entry]'")
 			continue

 		if(lockthis)
@@ -153,9 +158,9 @@
 			var/datum/config_entry/new_ver = entries_by_type[E.deprecated_by]
 			var/new_value = E.DeprecationUpdate(value)
 			var/good_update = istext(new_value)
-			log_config("LINE [linenumber]: [entry] is deprecated and will be removed soon. Migrate to [new_ver.name]![good_update ? " Suggested new value is: [new_value]" : ""]")
+			log_config("Entry [entry] is deprecated and will be removed soon. Migrate to [new_ver.name]![good_update ? " Suggested new value is: [new_value]" : ""]")
 			if(!warned_deprecated_configs)
-				addtimer(CALLBACK(GLOBAL_PROC, /proc/message_admins, "This server is using deprecated configuration settings. Please check the logs and update accordingly."), 0)
+				DelayedMessageAdmins("This server is using deprecated configuration settings. Please check the logs and update accordingly.")
 				warned_deprecated_configs = TRUE
 			if(good_update)
 				value = new_value
@@ -163,12 +168,12 @@
 			else
 				warning("[new_ver.type] is deprecated but gave no proper return for DeprecationUpdate()")

-		var/validated = E.ValidateAndSet(value, TRUE)
+		var/validated = E.ValidateAndSet(value)
 		if(!validated)
-			log_config("LINE [linenumber]: Failed to validate setting \"[value]\" for [entry]")
+			log_config("Failed to validate setting \"[value]\" for [entry]")
 		else
 			if(E.modified && !E.dupes_allowed)
-				log_config("LINE [linenumber]: Duplicate setting for [entry] ([value], [E.resident_file]) detected! Using latest.")
+				log_config("Duplicate setting for [entry] ([value], [E.resident_file]) detected! Using latest.")
 		if(E.postload_required)
 			postload_required[E] = TRUE

@@ -196,13 +201,6 @@
 	stat("[name]:", statclick)

 /datum/controller/configuration/proc/Get(entry_type)
-	var/datum/config_entry/E = GetEntryDatum(entry_type)
-	if((E.protection & CONFIG_ENTRY_HIDDEN) && IsAdminAdvancedProcCall() && GLOB.LastAdminCalledProc == "Get" && GLOB.LastAdminCalledTargetRef == "[REF(src)]")
-		log_admin_private("Config access of [entry_type] attempted by [key_name(usr)]")
-		return
-	return E.config_entry_value
-
-/datum/controller/configuration/proc/GetEntryDatum(entry_type)
 	var/datum/config_entry/E = entry_type
 	var/entry_is_abstract = initial(E.abstract_type) == entry_type
 	if(entry_is_abstract)
@@ -210,7 +208,10 @@
 	E = entries_by_type[entry_type]
 	if(!E)
 		CRASH("Missing config entry for [entry_type]!")
-	return E
+	if((E.protection & CONFIG_ENTRY_HIDDEN) && IsAdminAdvancedProcCall() && GLOB.LastAdminCalledProc == "Get" && GLOB.LastAdminCalledTargetRef == "[REF(src)]")
+		log_admin_private("Config access of [entry_type] attempted by [key_name(usr)]")
+		return
+	return E.config_entry_value

 /datum/controller/configuration/proc/Set(entry_type, new_val)
 	var/datum/config_entry/E = entry_type
@@ -236,7 +237,6 @@
 	for(var/T in gamemode_cache)
 		// I wish I didn't have to instance the game modes in order to look up
 		// their information, but it is the only way (at least that I know of).
-		// for future reference: just use initial() lol
 		var/datum/game_mode/M = new T()

 		if(M.config_tag)
@@ -258,7 +258,37 @@
 	var/tm_info = GLOB.revdata.GetTestMergeInfo()
 	if(motd || tm_info)
 		motd = motd ? "[motd]<br>[tm_info]" : tm_info
+/*
+Policy file should be a json file with a single object.
+Value is raw html.

+Possible keywords :
+Job titles / Assigned roles (ghost spawners for example) : Assistant , Captain , Ash Walker
+Mob types : /mob/living/simple_animal/hostile/carp
+Antagonist types : /datum/antagonist/highlander
+Species types : /datum/species/lizard
+special keywords defined in _DEFINES/admin.dm
+
+Example config:
+{
+    "Assistant" : "Don't kill everyone",
+    "/datum/antagonist/highlander" : "<b>Kill everyone</b>",
+    "Ash Walker" : "Kill all spacemans"
+}
+
+*/
+/*
+/datum/controller/configuration/proc/LoadPolicy()
+	policy = list()
+	var/rawpolicy = file2text("[directory]/policy.json")
+	if(rawpolicy)
+		var/parsed = safe_json_decode(rawpolicy)
+		if(!parsed)
+			log_config("JSON parsing failure for policy.json")
+			DelayedMessageAdmins("JSON parsing failure for policy.json")
+		else
+			policy = parsed
+*/
 /datum/controller/configuration/proc/loadmaplist(filename)
 	log_config("Loading config file [filename]...")
 	filename = "[directory]/[filename]"
@@ -305,6 +335,8 @@
 				currentmap.voteweight = text2num(data)
 			if ("default","defaultmap")
 				defaultmap = currentmap
+			//if ("votable")
+			//	currentmap.votable = TRUE
 			if ("endmap")
 				LAZYINITLIST(maplist)
 				maplist[currentmap.map_name] = currentmap
@@ -326,6 +358,7 @@
 			return new T
 	return new /datum/game_mode/extended()

+/// For dynamic.
 /datum/controller/configuration/proc/pick_storyteller(storyteller_name)
 	for(var/T in storyteller_cache)
 		var/datum/dynamic_storyteller/S = T
@@ -334,6 +367,32 @@
 			return T
 	return /datum/dynamic_storyteller/classic

+/// Same with this
+/datum/controller/configuration/proc/get_runnable_storytellers()
+	var/list/datum/dynamic_storyteller/runnable_storytellers = new
+	var/list/probabilities = Get(/datum/config_entry/keyed_list/storyteller_weight)
+	var/list/repeated_mode_adjust = Get(/datum/config_entry/number_list/repeated_mode_adjust)
+	var/list/min_player_counts = Get(/datum/config_entry/keyed_list/storyteller_min_players)
+	for(var/T in storyteller_cache)
+		var/datum/dynamic_storyteller/S = T
+		var/config_tag = initial(S.config_tag)
+		var/probability = (config_tag in probabilities) ? probabilities[config_tag] : initial(S.weight)
+		var/min_players = (config_tag in min_player_counts) ? min_player_counts[config_tag] : initial(S.min_players)
+		if(probability <= 0)
+			continue
+		if(length(GLOB.player_list) < min_players)
+			continue
+		if(SSpersistence.saved_storytellers.len == repeated_mode_adjust.len)
+			var/name = initial(S.name)
+			var/recent_round = min(SSpersistence.saved_storytellers.Find(name),3)
+			var/adjustment = 0
+			while(recent_round)
+				adjustment += repeated_mode_adjust[recent_round]
+				recent_round = SSpersistence.saved_modes.Find(name,recent_round+1,0)
+			probability *= ((100-adjustment)/100)
+		runnable_storytellers[S] = probability
+	return runnable_storytellers
+
 /datum/controller/configuration/proc/get_runnable_modes()
 	var/list/datum/game_mode/runnable_modes = new
 	var/list/probabilities = Get(/datum/config_entry/keyed_list/probability)
@@ -367,32 +426,6 @@
 			runnable_modes[M] = final_weight
 	return runnable_modes

-/datum/controller/configuration/proc/get_runnable_storytellers()
-	var/list/datum/dynamic_storyteller/runnable_storytellers = new
-	var/list/probabilities = Get(/datum/config_entry/keyed_list/storyteller_weight)
-	var/list/repeated_mode_adjust = Get(/datum/config_entry/number_list/repeated_mode_adjust)
-	var/list/min_player_counts = Get(/datum/config_entry/keyed_list/storyteller_min_players)
-	for(var/T in storyteller_cache)
-		var/datum/dynamic_storyteller/S = T
-		var/config_tag = initial(S.config_tag)
-		var/probability = (config_tag in probabilities) ? probabilities[config_tag] : initial(S.weight)
-		var/min_players = (config_tag in min_player_counts) ? min_player_counts[config_tag] : initial(S.min_players)
-		if(probability <= 0)
-			continue
-		if(length(GLOB.player_list) < min_players)
-			continue
-		if(SSpersistence.saved_storytellers.len == repeated_mode_adjust.len)
-			var/name = initial(S.name)
-			var/recent_round = min(SSpersistence.saved_storytellers.Find(name),3)
-			var/adjustment = 0
-			while(recent_round)
-				adjustment += repeated_mode_adjust[recent_round]
-				recent_round = SSpersistence.saved_modes.Find(name,recent_round+1,0)
-			probability *= ((100-adjustment)/100)
-		runnable_storytellers[S] = probability
-	return runnable_storytellers
-
-
 /datum/controller/configuration/proc/get_runnable_midround_modes(crew)
 	var/list/datum/game_mode/runnable_modes = new
 	var/list/probabilities = Get(/datum/config_entry/keyed_list/probability)
@@ -418,7 +451,6 @@
 /*
 /datum/controller/configuration/proc/LoadChatFilter()
 	var/list/in_character_filter = list()
-
 	if(!fexists("[directory]/in_character_filter.txt"))
 		return
 	log_config("Loading config file in_character_filter.txt...")
@@ -428,8 +460,8 @@
 		if(findtextEx(line,"#",1,2))
 			continue
 		in_character_filter += REGEX_QUOTE(line)
-
 	ic_filter_regex = in_character_filter.len ? regex("\\b([jointext(in_character_filter, "|")])\\b", "i") : null
-
-	syncChatRegexes()
 */
+//Message admins when you can.
+/datum/controller/configuration/proc/DelayedMessageAdmins(text)
+	addtimer(CALLBACK(GLOBAL_PROC, /proc/message_admins, text), 0)
@@ -16,4 +16,4 @@

 /datum/controller/proc/Recover()

-/datum/controller/proc/stat_entry()
+/datum/controller/proc/stat_entry()
@@ -76,7 +76,11 @@ GLOBAL_REAL(Master, /datum/controller/master) = new
 	// Highlander-style: there can only be one! Kill off the old and replace it with the new.

 	if(!random_seed)
-		random_seed = (TEST_RUN_PARAMETER in world.params) ? 29051994 : rand(1, 1e9)
+		#ifdef UNIT_TESTS
+		random_seed = 29051994
+		#else
+		random_seed = rand(1, 1e9)
+		#endif
 		rand_seed(random_seed)

 	var/list/_subsystems = list()
@@ -184,9 +188,6 @@ GLOBAL_REAL(Master, /datum/controller/master) = new
 	if(delay)
 		sleep(delay)

-	if(tgs_prime)
-		world.TgsInitializationComplete()
-
 	if(init_sss)
 		init_subtypes(/datum/controller/subsystem, subsystems)

@@ -219,6 +220,9 @@ GLOBAL_REAL(Master, /datum/controller/master) = new
 	world.fps = CONFIG_GET(number/fps)
 	var/initialized_tod = REALTIMEOFDAY

+	if(tgs_prime)
+		world.TgsInitializationComplete()
+
 	if(sleep_offline_after_initializations)
 		world.sleep_offline = TRUE
 	sleep(1)
@@ -643,3 +647,8 @@ GLOBAL_REAL(Master, /datum/controller/master) = new
 		processing = CONFIG_GET(number/mc_tick_rate/base_mc_tick_rate)
 	else if (client_count > CONFIG_GET(number/mc_tick_rate/high_pop_mc_mode_amount))
 		processing = CONFIG_GET(number/mc_tick_rate/high_pop_mc_tick_rate)
+
+/datum/controller/master/proc/OnConfigLoad()
+	for (var/thing in subsystems)
+		var/datum/controller/subsystem/SS = thing
+		SS.OnConfigLoad()
@@ -1,39 +1,91 @@
+/**
+	* # Subsystem base class
+	*
+	* Defines a subsystem to be managed by the [Master Controller][/datum/controller/master]
+	*
+	* Simply define a child of this subsystem, using the [SUBSYSTEM_DEF] macro, and the MC will handle registration.
+	* Changing the name is required
+**/

 /datum/controller/subsystem
 	// Metadata; you should define these.
-	name = "fire coderbus" //name of the subsystem
-	var/init_order = INIT_ORDER_DEFAULT		//order of initialization. Higher numbers are initialized first, lower numbers later. Use defines in __DEFINES/subsystems.dm for easy understanding of order.
-	var/wait = 20			//time to wait (in deciseconds) between each call to fire(). Must be a positive integer.
-	var/priority = FIRE_PRIORITY_DEFAULT	//When mutiple subsystems need to run in the same tick, higher priority subsystems will run first and be given a higher share of the tick before MC_TICK_CHECK triggers a sleep

-	var/flags = 0			//see MC.dm in __DEFINES Most flags must be set on world start to take full effect. (You can also restart the mc to force them to process again)
+	/// Name of the subsystem - you must change this
+	name = "fire coderbus"

-	var/initialized = FALSE	//set to TRUE after it has been initialized, will obviously never be set if the subsystem doesn't initialize
+	/// Order of initialization. Higher numbers are initialized first, lower numbers later. Use or create defines such as [INIT_ORDER_DEFAULT] so we can see the order in one file.
+	var/init_order = INIT_ORDER_DEFAULT

-	//set to 0 to prevent fire() calls, mostly for admin use or subsystems that may be resumed later
-	//	use the SS_NO_FIRE flag instead for systems that never fire to keep it from even being added to the list
+	/// Time to wait (in deciseconds) between each call to fire(). Must be a positive integer.
+	var/wait = 20
+
+	/// Priority Weight: When mutiple subsystems need to run in the same tick, higher priority subsystems will be given a higher share of the tick before MC_TICK_CHECK triggers a sleep, higher priority subsystems also run before lower priority subsystems
+	var/priority = FIRE_PRIORITY_DEFAULT
+
+	/// [Subsystem Flags][SS_NO_INIT] to control binary behavior. Flags must be set at compile time or before preinit finishes to take full effect. (You can also restart the mc to force them to process again)
+	var/flags = 0
+
+	/// This var is set to TRUE after the subsystem has been initialized.
+	var/initialized = FALSE
+
+	/// Set to 0 to prevent fire() calls, mostly for admin use or subsystems that may be resumed later
+	///		use the [SS_NO_FIRE] flag instead for systems that never fire to keep it from even being added to list that is checked every tick
 	var/can_fire = TRUE

-	// Bookkeeping variables; probably shouldn't mess with these.
-	var/last_fire = 0		//last world.time we called fire()
-	var/next_fire = 0		//scheduled world.time for next fire()
-	var/cost = 0			//average time to execute
-	var/tick_usage = 0		//average tick usage
-	var/tick_overrun = 0	//average tick overrun
-	var/state = SS_IDLE		//tracks the current state of the ss, running, paused, etc.
-	var/paused_ticks = 0	//ticks this ss is taking to run right now.
-	var/paused_tick_usage	//total tick_usage of all of our runs while pausing this run
-	var/ticks = 1			//how many ticks does this ss take to run on avg.
-	var/times_fired = 0		//number of times we have called fire()
-	var/queued_time = 0		//time we entered the queue, (for timing and priority reasons)
-	var/queued_priority 	//we keep a running total to make the math easier, if priority changes mid-fire that would break our running total, so we store it here
-	//linked list stuff for the queue
-	var/datum/controller/subsystem/queue_next
-	var/datum/controller/subsystem/queue_prev
-
+	///Bitmap of what game states can this subsystem fire at. See [RUNLEVELS_DEFAULT] for more details.
 	var/runlevels = RUNLEVELS_DEFAULT	//points of the game at which the SS can fire

-	var/static/list/failure_strikes //How many times we suspect a subsystem type has crashed the MC, 3 strikes and you're out!
+	/*
+	 * The following variables are managed by the MC and should not be modified directly.
+	 */
+
+	/// Last world.time the subsystem completed a run (as in wasn't paused by [MC_TICK_CHECK])
+	var/last_fire = 0
+
+	/// Scheduled world.time for next fire()
+	var/next_fire = 0
+
+	/// Running average of the amount of milliseconds it takes the subsystem to complete a run (including all resumes but not the time spent paused)
+	var/cost = 0
+
+	/// Running average of the amount of tick usage in percents of a tick it takes the subsystem to complete a run
+	var/tick_usage = 0
+
+	/// Running average of the amount of tick usage (in percents of a game tick) the subsystem has spent past its allocated time without pausing
+	var/tick_overrun = 0
+
+	/// Tracks the current execution state of the subsystem. Used to handle subsystems that sleep in fire so the mc doesn't run them again while they are sleeping
+	var/state = SS_IDLE
+
+	/// Tracks how many fires the subsystem has consecutively paused on in the current run
+	var/paused_ticks = 0
+
+	/// Tracks how much of a tick the subsystem has consumed in the current run
+	var/paused_tick_usage
+
+	/// Tracks how many fires the subsystem takes to complete a run on average.
+	var/ticks = 1
+
+	/// Tracks the amount of completed runs for the subsystem
+	var/times_fired = 0
+
+	/// Time the subsystem entered the queue, (for timing and priority reasons)
+	var/queued_time = 0
+
+	/// Priority at the time the subsystem entered the queue. Needed to avoid changes in priority (by admins and the like) from breaking things.
+	var/queued_priority
+
+	/// How many times we suspect a subsystem type has crashed the MC, 3 strikes and you're out!
+	var/static/list/failure_strikes
+
+	/// Next subsystem in the queue of subsystems to run this tick
+	var/datum/controller/subsystem/queue_next
+	/// Previous subsystem in the queue of subsystems to run this tick
+	var/datum/controller/subsystem/queue_prev
+
+	//Do not blindly add vars here to the bottom, put it where it goes above
+	//If your var only has two values, put it in as a flag.
+

 //Do not override
 ///datum/controller/subsystem/New()
@@ -46,6 +98,7 @@

 //This is used so the mc knows when the subsystem sleeps. do not override.
 /datum/controller/subsystem/proc/ignite(resumed = 0)
+	SHOULD_NOT_OVERRIDE(TRUE)
 	set waitfor = 0
 	. = SS_SLEEPING
 	fire(resumed)
@@ -87,7 +140,7 @@
 		queue_node_flags = queue_node.flags

 		if (queue_node_flags & SS_TICKER)
-			if (!(SS_flags & SS_TICKER))
+			if ((SS_flags & (SS_TICKER|SS_BACKGROUND)) != SS_TICKER)
 				continue
 			if (queue_node_priority < SS_priority)
 				break
@@ -155,6 +208,9 @@
 		if(SS_SLEEPING)
 			state = SS_PAUSING

+/// Called after the config has been loaded or reloaded.
+/datum/controller/subsystem/proc/OnConfigLoad()
+
 /datum/controller/subsystem/proc/subsystem_log(msg)
 	return log_subsystem(name, msg)

@@ -164,7 +220,7 @@
 	var/time = (REALTIMEOFDAY - start_timeofday) / 10
 	var/msg = "Initialized [name] subsystem within [time] second[time == 1 ? "" : "s"]!"
 	to_chat(world, "<span class='boldannounce'>[msg]</span>")
-	log_subsystem("INIT", msg)
+	log_world(msg)
 	return time

 //hook for printing stats to the "MC" statuspanel for admins to see performance and related stats etc.