Files
Bubberstation/code/controllers/subsystem/ban_cache.dm
Watermelon914 79b00baad2 Refactors subsystems to use dependency-ordering to determine init order. Subsystems can now declare their own dependencies. (#90268)
## About The Pull Request
As the title says.
`init_order` is no more, subsystems ordering now depends on their
declared dependencies.
Subsystems can now declare which other subsystems need to init before
them using a list and the subsystem's typepath
I.e.
```dm
dependencies = list(
    /datum/controller/subsystem/atoms,
    /datum/controller/subsystem/mapping
)
```
The reverse can also be done, if a subsystem must initialize after your
own:
```dm
dependents = list(
    /datum/controller/subsystem/atoms
)
```
Cyclical dependencies are not allowed and will throw an error on
initialization if one is found.
There's also a debug tool to visualize the dependency graph, although
it's a bit basic:

![image](https://github.com/user-attachments/assets/80c854d9-c2a5-4f2f-92db-a031e9a8e257)

Subsystem load ordering can still be controlled using `init_stage`, some
subsystems use this in cases where they must initialize first or last
regardless of dependencies. An error will be thrown if a subsystem has
an `init_stage` before one of their dependencies.

## Why It's Good For The Game
Makes dealing with subsystem dependencies easier, and reduces the chance
of making a dependency error when needing to shift around subsystem
inits.

## Changelog
🆑
refactor: Refactored subsystem initialization
/🆑
2025-04-29 17:11:39 -06:00

85 lines
2.5 KiB
Plaintext

/// Subsystem that batches a ban cache list for clients on initialize
/// This way we don't need to do ban checks in series later in the code
SUBSYSTEM_DEF(ban_cache)
/datum/controller/subsystem/ban_cache
name = "Ban Cache"
init_stage = INITSTAGE_LAST
flags = SS_NO_FIRE
var/query_started = FALSE
/datum/controller/subsystem/ban_cache/Initialize()
generate_queries()
return SS_INIT_SUCCESS
/// Generates ban caches for any logged in clients. This ensures the amount of in-series ban checking we have to do that actually involves sleeps is VERY low
/datum/controller/subsystem/ban_cache/proc/generate_queries()
query_started = TRUE
if(!SSdbcore.Connect())
return
var/current_time = REALTIMEOFDAY
var/list/look_for = list()
var/list/query_args = list()
var/list/query_arg_keys = list()
var/num_keys = 0
for(var/ckey in GLOB.directory)
var/client/lad = GLOB.directory[ckey]
// If they've already got a ban cached, or a request goin, don't do it
if(lad.ban_cache || lad.ban_cache_start)
continue
look_for += ckey
lad.ban_cache_start = current_time
query_args += list("key[num_keys]" = ckey)
query_arg_keys += ":key[num_keys]"
num_keys++
// We're gonna try and make a query for clients
var/datum/db_query/query_batch_ban_cache = SSdbcore.NewQuery(
"SELECT ckey, role, applies_to_admins FROM [format_table_name("ban")] WHERE ckey IN ([query_arg_keys.Join(",")]) AND unbanned_datetime IS NULL AND (expiration_time IS NULL OR expiration_time > NOW())",
query_args
)
var/succeeded = query_batch_ban_cache.Execute()
for(var/ckey in look_for)
var/client/lad = GLOB.directory[ckey]
if(!lad || lad.ban_cache_start != current_time)
continue
lad.ban_cache_start = 0
if(!succeeded)
qdel(query_batch_ban_cache)
return
var/list/ckey_to_bans = list()
// Runs after the check for safety, don't want to override anything
for(var/ckey in look_for)
ckey_to_bans[ckey] = list()
while(query_batch_ban_cache.NextRow())
var/ckey = query_batch_ban_cache.item[1]
var/role = query_batch_ban_cache.item[2]
var/hits_admins = query_batch_ban_cache.item[3]
var/list/bans = ckey_to_bans[ckey]
if(!bans)
continue
// Yes I know this is slightly unoptimal, no I do not care
var/is_admin = GLOB.admin_datums[ckey] || GLOB.deadmins[ckey]
if(is_admin && !text2num(hits_admins))
continue
bans[role] = TRUE
for(var/ckey in ckey_to_bans)
var/client/lad = GLOB.directory[ckey]
if(!lad)
continue
lad.ban_cache = ckey_to_bans[ckey]
qdel(query_batch_ban_cache)