refactors whitelist to toml config (#7182)

Co-authored-by: Zandario <zandarioh@gmail.com>

Author: silicons

citadel.dme

@@ -543,7 +543,6 @@
 #include "code\controllers\verbs.dm"
 #include "code\controllers\configuration\config_entry.dm"
 #include "code\controllers\configuration\configuration.dm"
-#include "code\controllers\configuration\whitelists.dm"
 #include "code\controllers\configuration\entries\admin.dm"
 #include "code\controllers\configuration\entries\chat_bridge.dm"
 #include "code\controllers\configuration\entries\cross_server.dm"

code/__DEFINES/controllers/_repository.dm

@@ -31,7 +31,7 @@ GLOBAL_REAL(RS##what, /datum/controller/repository/##what); \
 	RS##what.Initialize(); \
 } \
 /datum/controller/subsystem/repository/__get_all_repositories() { \
-	. = ..(); \
+	. = ..() || list(); \
 	. += RS##what; \
 } \
 /datum/controller/repository/##what

code/__DEFINES/species/species.dm

@@ -40,7 +40,7 @@
 #define SPECIES_ID_SCORI "scori"
 #define SPECIES_ID_SERGLING "sergling"
 #define SPECIES_ID_SHADEKIN "shadekin"
-#define SPECIES_ID_SHADEKIN_BLACK "blackeyedshadekin"
+#define SPECIES_ID_SHADEKIN_BLACK "shadekin_blackeyed"
 #define SPECIES_ID_SHADOW "shadow"
 #define SPECIES_ID_SKELETON "skeleton"
 #define SPECIES_ID_SKRELL "skrell"

code/__DEFINES/species/species_flags.dm

@@ -75,12 +75,14 @@ DEFINE_BITFIELD(species_fluff_flags, list(
 /// Species is selectable and visible in chargen. This must be on a species to be roundstart/latejoin.
 #define SPECIES_SPAWN_CHARACTER (1<<1)
 /// Must be whitelisted to play roundstart/latejoin.
+/// TODO: get rid of this, rework whitelist system to config
 #define SPECIES_SPAWN_WHITELISTED (1<<2)
 /// Must be whitelisted to see this species at all.
 #define SPECIES_SPAWN_SECRET (1<<3)
 /// Cannot normally spawn; something must pass in PREFS_COPY_TO_NO_CHECK_SPECIES to spawn checks to use!
 #define SPECIES_SPAWN_RESTRICTED (1<<4)
 /// if set, check species.id in WL, otherwise use uid
+/// TODO: get rid of this, rework whitelist system to config
 #define SPECIES_SPAWN_WHITELIST_FLEXIBLE (1<<5)
 //? FLAGS ABOVE ARE RELEVANT TO UI.
 //? If you change them, change necessary TGUI too.

code/__HELPERS/lists/merge.dm

@@ -12,6 +12,8 @@
  * if a key isn't a list, it'll be turned into a list when two keys exist
  *
  * originally made for dynamic tool functions
+ *
+ * TODO: better name
  */
 /proc/merge_double_lazy_assoc_list(list/A, list/B)
 	. = A.Copy()
@@ -25,3 +27,23 @@
 				.[key] = list(.[key], B[key])
 		else
 			.[key] = B[key]
+
+/**
+ * merges two 2-deep lists, ergo list(key = list(values))
+ * dedupes values
+ *
+ * ## Input
+ *
+ * list("A" = list("a", "b", "c"))
+ * list("A" = list("d"))
+ *
+ * ## Output
+ *
+ * list("A" = list("a", "b", "c", "d"))
+ */
+/proc/merge_2_nested_list(list/A, list/B)
+	. = list()
+	for(var/k1 in A)
+		.[k1] = A[k1].Copy()
+	for(var/k2 in B)
+		.[k2] += B[k2]

code/controllers/configuration/configuration.dm

@@ -39,8 +39,6 @@
 				for(var/J in legacy_configs)
 					LoadEntries(J)
 				break
-	// loadmaplist(CONFIG_MAPS_FILE)
-	LoadWhitelists()
 	LoadMOTD()
 
 	loaded = TRUE

code/controllers/configuration/whitelists.dm

@@ -5,12 +5,23 @@
 GLOBAL_REAL(Configuration, /datum/controller/toml_configuration)
 
 // todo: /datum/controller/configuration
+// todo: needs stronger vv guarding; it still exposes list refs.
 /datum/controller/toml_configuration
 	/// Entries by type.
 	VAR_PRIVATE/list/datum/toml_config_entry/typed_entries
 	/// Entries as same structure as the underlying toml/json
 	VAR_PRIVATE/list/datum/toml_config_entry/keyed_entries
 
+	/// TODO: database whitelist when this is stupid
+	/// species id = list(ckeys)
+	VAR_PRIVATE/list/species_whitelist
+	/// TODO: database whitelist when this is stupid
+	/// language id = list(ckeys)
+	VAR_PRIVATE/list/language_whitelist
+	/// TODO: database whitelist when this is stupid
+	/// role id = list(ckeys)
+	VAR_PRIVATE/list/role_whitelist
+
 /datum/controller/toml_configuration/CanProcCall(procname)
 	switch(procname)
 		if(NAMEOF_PROC(src, New), NAMEOF_PROC(src, Destroy), NAMEOF_PROC(src, Initialize))
@@ -19,7 +30,11 @@ GLOBAL_REAL(Configuration, /datum/controller/toml_configuration)
 			return FALSE
 		if(NAMEOF_PROC(src, get_sensitive_entry), NAMEOF_PROC(src, set_sensitive_entry))
 			return FALSE
-		if(NAMEOF_PROC(src, reload), NAMEOF_PROC(src, reset), NAMEOF_PROC(src, load), NAMEOF_PROC(src, recursively_load_from_list))
+		if(NAMEOF_PROC(src, reload))
+			return FALSE
+		if(NAMEOF_PROC(src, reset), NAMEOF_PROC(src, load), NAMEOF_PROC(src, load_impl))
+			return FALSE
+		if(NAMEOF_PROC(src, reset_whitelist), NAMEOF_PROC(src, load_whitelist), NAMEOF_PROC(src, load_whitelist_impl))
 			return FALSE
 	return ..()
 
@@ -120,6 +135,10 @@ GLOBAL_REAL(Configuration, /datum/controller/toml_configuration)
 	load("config.default/config.toml")
 	load("config/config.toml")
 
+	reset_whitelist()
+	load_whitelist("config.default/whitelist.toml")
+	load_whitelist("config/whitelist.toml")
+
 /**
  * Resets the configuration.
  */
@@ -150,9 +169,9 @@ GLOBAL_REAL(Configuration, /datum/controller/toml_configuration)
 	if(!decoded)
 		CRASH("failed to decode config [filelike]!")
 
-	recursively_load_from_list(decoded, keyed_entries)
+	load_impl(decoded, keyed_entries)
 
-/datum/controller/toml_configuration/proc/recursively_load_from_list(list/decoded_list, list/entry_list)
+/datum/controller/toml_configuration/proc/load_impl(list/decoded_list, list/entry_list)
 	if(!decoded_list || !entry_list)
 		return
 	for(var/key in decoded_list)
@@ -162,10 +181,83 @@ GLOBAL_REAL(Configuration, /datum/controller/toml_configuration)
 			if(!islist(next_entry_list))
 				// todo: warn
 			else
-				recursively_load_from_list(value, next_entry_list[key])
+				load_impl(value, next_entry_list[key])
 		else
 			var/datum/toml_config_entry/entry = entry_list[key]
 			if(!istype(entry))
 				// todo: warn
 			else
 				entry.apply(value)
+
+/datum/controller/toml_configuration/proc/reset_whitelist()
+	role_whitelist = list()
+	species_whitelist = list()
+	language_whitelist = list()
+
+/datum/controller/toml_configuration/proc/load_whitelist(filelike)
+	var/list/decoded
+	if(istext(filelike))
+		if(!fexists(filelike))
+			CRASH("failed to load [filelike]: does not exist")
+		decoded = rustg_read_toml_file(filelike)
+	else if(isfile(filelike))
+		// noa path, it might be rsc cache; rust_g can't read that directly.
+		fdel("tmp/config/loading.toml")
+		fcopy(filelike, "tmp/config/loading.toml")
+		decoded = rustg_read_toml_file("tmp/config/loading.toml")
+		fdel("tmp/config/loading.toml")
+	if(!decoded)
+		CRASH("failed to decode config [filelike]!")
+
+	load_whitelist_impl(decoded)
+
+/datum/controller/toml_configuration/proc/load_whitelist_impl(list/decoded_list)
+	if(!decoded_list)
+		return
+
+	var/list/role_whitelist = sanitize_islist(deep_copy_list(decoded_list["whitelist"]?["role"]))
+	var/list/language_whitelist = sanitize_islist(deep_copy_list(decoded_list["whitelist"]?["language"]))
+	var/list/species_whitelist = sanitize_islist(deep_copy_list(decoded_list["whitelist"]?["species"]))
+
+	// fixup: make everything ckeys
+	for(var/list/root_list as anything in list(
+		role_whitelist,
+		language_whitelist,
+		species_whitelist,
+	))
+		for(var/i in 1 to length(root_list))
+			var/id = root_list[i]
+			var/list/ckey_list = root_list[id]
+			for(var/j in 1 to length(ckey_list))
+				ckey_list[j] = ckey(ckey_list[j])
+
+	src.role_whitelist = merge_2_nested_list(src.role_whitelist, role_whitelist)
+	src.language_whitelist = merge_2_nested_list(src.language_whitelist, language_whitelist)
+	src.species_whitelist = merge_2_nested_list(src.species_whitelist, species_whitelist)
+
+/datum/controller/toml_configuration/proc/check_species_whitelist(id, ckey)
+	return ckey(ckey) in species_whitelist[id]
+
+/datum/controller/toml_configuration/proc/check_role_whitelist(id, ckey)
+	return ckey(ckey) in role_whitelist[id]
+
+/datum/controller/toml_configuration/proc/check_language_whitelist(id, ckey)
+	return ckey(ckey) in language_whitelist[id]
+
+/datum/controller/toml_configuration/proc/get_all_species_whitelists_for_ckey(ckey)
+	. = list()
+	for(var/id in species_whitelist)
+		if(ckey in species_whitelist[id])
+			. += id
+
+/datum/controller/toml_configuration/proc/get_all_role_whitelists_for_ckey(ckey)
+	. = list()
+	for(var/id in role_whitelist)
+		if(ckey in role_whitelist[id])
+			. += id
+
+/datum/controller/toml_configuration/proc/get_all_language_whitelists_for_ckey(ckey)
+	. = list()
+	for(var/id in language_whitelist)
+		if(ckey in language_whitelist[id])
+			. += id

code/controllers/toml_config/toml_configuration.dm

@@ -121,7 +121,6 @@ GLOBAL_LIST(topic_status_cache)
 	#ifdef UNIT_TESTS
 	HandleTestRun()
 	#endif
-
 	if(config_legacy.ToRban)
 		addtimer(CALLBACK(GLOBAL_PROC, GLOBAL_PROC_REF(ToRban_autoupdate)), 5 MINUTES)
 

code/game/world.dm

@@ -115,7 +115,7 @@
  */
 /datum/role/job/proc/check_client_availability(client/C, check_char, latejoin)
 	. = NONE
-	if(whitelist_only && !config.check_job_whitelist(ckey(title), C.ckey))
+	if(whitelist_only && !Configuration.check_role_whitelist(id, C.ckey))
 		. |= ROLE_UNAVAILABLE_WHITELIST
 	if(!slots_remaining())
 		. |= ROLE_UNAVAILABLE_SLOTS_FULL
@@ -146,7 +146,7 @@
  */
 /datum/role/job/proc/check_client_availability_one(client/C, check_char, latejoin)
 	. = NONE
-	if(whitelist_only && !config.check_job_whitelist(ckey(title), C.ckey))
+	if(whitelist_only && !Configuration.check_role_whitelist(id, C.ckey))
 		return ROLE_UNAVAILABLE_WHITELIST
 	else if(latejoin && !slots_remaining(TRUE))
 		return ROLE_UNAVAILABLE_SLOTS_FULL