Files
Bubberstation/code/modules/interview/interview.dm
san7890 ccef887efe Lints Against Unmanaged Local Defines (#74333)
# MAINTAINER - USE THE BUTTON THAT SAYS "MERGE MASTER" THEN SET THE PR
TO AUTO-MERGE! IT'S MUCH EASIER FOR ME TO FIX THINGS BEFORE THEY SKEW
RATHER THAN AFTER THE FACT.

## About The Pull Request

Hey there,

This took a while to do, but here's the gist:

Python file now regexes every file in `/code` except for those that have
some valid reason to be tacking on more global defines. Some of those
reasons are simply just that I don't have the time right now (doing what
you see in this PR took a few hours) to refactor and parse what should
belong and what should be thrown out. For the time being though, this PR
will at least _halt_ people making the mistake of not `#undef`ing any
files they `#define` "locally", or within the scope of a file.

Most people forget to do this and this leads to a lot of mess later on
due to how many variables can be unmanaged on the global level. I've
made this mistake, you've made this mistake, it's a common thing. Let's
automatically check for it so it can be fixed no-stress.

Scenarios this PR corrects:

* Forgetting to undef a define but undeffing others.
* Not undeffing any defines in your file.
* Earmarking a define as a "file local" define, but not defining it.
* Having a define be a "file local" define, but having it be used
elsewhere.
* Having a "local" define not even be in the file that it only shows up
in.
* Having a completely unused define*

(* I kept some of these because they seemed important... Others were
junked.)
## Why It's Good For The Game

If you wanna use it across multiple files, no reason to not make it a
global define (maybe there's a few reasons but let's assume that this is
the 95% case).

Let me know if you don't like how I re-arranged some of the defines and
how you'd rather see it be implemented, and I'd be happy to do that.
This was mostly just "eh does it need it or not" sorta stuff.

I used a pretty cool way to detect if we should use the standardized
GitHub "error" output, you can see the results of that here
https://github.com/san7890/bruhstation/actions/runs/4549766579/jobs/8022186846#step:7:792
## Changelog
Nothing that really concerns players.

(I fixed up all this stuff using vscode, no regexes beyond what you see
in the python script. sorry downstreams)
2023-03-29 10:17:03 -07:00

164 lines
5.9 KiB
Plaintext

/**
* Represents a new-player interview form
*
* Represents a new-player interview form, enabled by configuration to require
* players with low playtime to request access to the server. To do so, they will
* out a brief questionnaire, and are otherwise unable to do anything while they
* wait for a response.
*/
/datum/interview
/// Unique ID of the interview
var/id
/// Atomic ID for incrementing unique IDs
var/static/atomic_id = 0
/// The /client who owns this interview, the intiator
var/client/owner
/// The Ckey of the owner, used for when a client could disconnect
var/owner_ckey
/// The welcome message shown at the top of the interview panel
var/welcome_message
/// The questions to display on the questionnaire of the interview
var/list/questions
/// The stored responses, will be filled as the questionnaire is answered
var/list/responses = list()
/// Boolean operator controlling if the questionnaire's contents can be edited
var/read_only = FALSE
/// Integer that contains the current position in the interview queue, used for rendering
var/pos_in_queue
/// Contains the state of the form, used for rendering and sanity checking
var/status = INTERVIEW_PENDING
/datum/interview/New(client/interviewee)
if(!interviewee)
qdel(src)
return
id = ++atomic_id
owner = interviewee
owner_ckey = owner.ckey
questions = CONFIG_GET(str_list/interview_questions)
responses.len = questions.len
welcome_message = CONFIG_GET(string/interview_welcome_msg)
/**
* Approves the interview, forces reconnect of owner if relevant.
*
* Approves the interview, and if relevant will force the owner to reconnect so that they have the proper
* verbs returned to them.
* Arguments:
* * approved_by - The user who approved the interview, used for logging
*/
/datum/interview/proc/approve(client/approved_by)
status = INTERVIEW_APPROVED
read_only = TRUE
GLOB.interviews.approved_ckeys |= owner_ckey
GLOB.interviews.close_interview(src)
log_admin_private("[key_name(approved_by)] has approved interview #[id] for [owner_ckey][!owner ? "(DC)": ""].")
message_admins(span_adminnotice("[key_name(approved_by)] has approved [link_self()] for [owner_ckey][!owner ? "(DC)": ""]."))
if (owner)
SEND_SOUND(owner, sound('sound/effects/adminhelp.ogg'))
to_chat(owner, "<font color='red' size='4'><b>-- Interview Update --</b></font>" \
+ "\n[span_adminsay("Your interview was approved, you will now be reconnected in 5 seconds.")]", confidential = TRUE)
addtimer(CALLBACK(src, PROC_REF(reconnect_owner)), 50)
/**
* Denies the interview and adds the owner to the cooldown for new interviews.
*
* Arguments:
* * denied_by - The user who denied the interview, used for logging
*/
/datum/interview/proc/deny(client/denied_by)
status = INTERVIEW_DENIED
read_only = TRUE
GLOB.interviews.close_interview(src)
GLOB.interviews.cooldown_ckeys |= owner_ckey
log_admin_private("[key_name(denied_by)] has denied interview #[id] for [owner_ckey][!owner ? "(DC)": ""].")
message_admins(span_adminnotice("[key_name(denied_by)] has denied [link_self()] for [owner_ckey][!owner ? "(DC)": ""]."))
addtimer(CALLBACK(GLOB.interviews, TYPE_PROC_REF(/datum/interview_manager, release_from_cooldown), owner_ckey), 180)
if (owner)
SEND_SOUND(owner, sound('sound/effects/adminhelp.ogg'))
to_chat(owner, "<font color='red' size='4'><b>-- Interview Update --</b></font>" \
+ "\n<span class='adminsay'>Unfortunately your interview was denied. Please try submitting another questionnaire." \
+ " You may do this in three minutes.</span>", confidential = TRUE)
/**
* Forces client to reconnect, used in the callback from approval
*/
/datum/interview/proc/reconnect_owner()
if (!owner)
return
winset(owner, null, "command=.reconnect")
/**
* Verb for opening the existing interview, or if relevant creating a new interview if possible.
*/
/mob/dead/new_player/proc/open_interview()
set name = "Open Interview"
set category = "Interview"
var/mob/dead/new_player/M = usr
if (M?.client?.interviewee)
var/datum/interview/I = GLOB.interviews.interview_for_client(M.client)
if (I) // we can be returned nothing if the user is on cooldown
I.ui_interact(M)
else
to_chat(usr, "<span class='adminsay'>You are on cooldown for interviews. Please" \
+ " wait at least 3 minutes before starting a new questionnaire.</span>", confidential = TRUE)
/datum/interview/ui_interact(mob/user, datum/tgui/ui = null)
ui = SStgui.try_update_ui(user, src, ui)
if (!ui)
ui = new(user, src, "Interview")
ui.open()
/datum/interview/ui_state(mob/user)
if(check_rights_for(user.client, R_ADMIN))
return GLOB.always_state
return GLOB.new_player_state
/datum/interview/ui_act(action, list/params, datum/tgui/ui, datum/ui_state/state)
if (..())
return
switch(action)
if ("update_answer")
if (!read_only)
responses[text2num(params["qidx"])] = copytext_char(params["answer"], 1, 501) // byond indexing moment
. = TRUE
if ("submit")
if (!read_only)
read_only = TRUE
GLOB.interviews.enqueue(src)
. = TRUE
if ("approve")
if (usr.client?.holder && status == INTERVIEW_PENDING)
src.approve(usr)
. = TRUE
if ("deny")
if (usr.client?.holder && status == INTERVIEW_PENDING)
src.deny(usr)
. = TRUE
if ("adminpm")
if (usr.client?.holder && owner)
usr.client.cmd_admin_pm(owner, null)
/datum/interview/ui_data(mob/user)
. = list(
"welcome_message" = welcome_message,
"questions" = list(),
"read_only" = read_only,
"queue_pos" = pos_in_queue,
"is_admin" = !!(user?.client && user.client.holder),
"status" = status,
"connected" = !!owner)
for (var/i in 1 to questions.len)
var/list/data = list(
"qidx" = i,
"question" = questions[i],
"response" = responses.len < i ? null : responses[i]
)
.["questions"] += list(data)
/**
* Generates a clickable link to open this interview
*/
/datum/interview/proc/link_self()
return "<a href='?_src_=holder;[HrefToken(forceGlobal = TRUE)];interview=[REF(src)]'>Interview #[id]</a>"