Merge pull request #3984 from Citadel-Station-13/upstream-merge-32188

[MIRROR] JSON feedback

code/controllers/subsystem/blackbox.dm

@@ -5,21 +5,12 @@ SUBSYSTEM_DEF(blackbox)
 	runlevels = RUNLEVEL_GAME | RUNLEVEL_POSTGAME
 	init_order = INIT_ORDER_BLACKBOX
 
-	var/list/msg_common = list()
-	var/list/msg_science = list()
-	var/list/msg_command = list()
-	var/list/msg_medical = list()
-	var/list/msg_engineering = list()
-	var/list/msg_security = list()
-	var/list/msg_deathsquad = list()
-	var/list/msg_syndicate = list()
-	var/list/msg_service = list()
-	var/list/msg_cargo = list()
-	var/list/msg_other = list()
-
 	var/list/feedback = list()	//list of datum/feedback_variable
 	var/triggertime = 0
 	var/sealed = FALSE	//time to stop tracking stats?
+	var/list/research_levels = list() //list of highest tech levels attained that isn't lost lost by destruction of RD computers
+	var/list/versions = list("time_dilation_current" = 2,
+							"science_techweb_unlock" = 2) //associative list of any feedback variables that have had their format changed since creation and their current version, remember to update this
 
 
 /datum/controller/subsystem/blackbox/Initialize()
@@ -44,20 +35,7 @@ SUBSYSTEM_DEF(blackbox)
 
 
 /datum/controller/subsystem/blackbox/Recover()
-	msg_common = SSblackbox.msg_common
-	msg_science = SSblackbox.msg_science
-	msg_command = SSblackbox.msg_command
-	msg_medical = SSblackbox.msg_medical
-	msg_engineering = SSblackbox.msg_engineering
-	msg_security = SSblackbox.msg_security
-	msg_deathsquad = SSblackbox.msg_deathsquad
-	msg_syndicate = SSblackbox.msg_syndicate
-	msg_service = SSblackbox.msg_service
-	msg_cargo = SSblackbox.msg_cargo
-	msg_other = SSblackbox.msg_other
-
 	feedback = SSblackbox.feedback
-
 	sealed = SSblackbox.sealed
 
 //no touchie
@@ -71,32 +49,14 @@ SUBSYSTEM_DEF(blackbox)
 
 /datum/controller/subsystem/blackbox/Shutdown()
 	sealed = FALSE
-	set_val("ahelp_unresolved", GLOB.ahelp_tickets.active_tickets.len)
-
-	var/pda_msg_amt = 0
-	var/rc_msg_amt = 0
-
+	record_feedback("tally", "ahelp_stats", GLOB.ahelp_tickets.active_tickets.len, "unresolved")
 	for (var/obj/machinery/message_server/MS in GLOB.message_servers)
-		if (MS.pda_msgs.len > pda_msg_amt)
-			pda_msg_amt = MS.pda_msgs.len
-		if (MS.rc_msgs.len > rc_msg_amt)
-			rc_msg_amt = MS.rc_msgs.len
-
-	set_details("radio_usage","")
-
-	add_details("radio_usage","COM-[msg_common.len]")
-	add_details("radio_usage","SCI-[msg_science.len]")
-	add_details("radio_usage","HEA-[msg_command.len]")
-	add_details("radio_usage","MED-[msg_medical.len]")
-	add_details("radio_usage","ENG-[msg_engineering.len]")
-	add_details("radio_usage","SEC-[msg_security.len]")
-	add_details("radio_usage","DTH-[msg_deathsquad.len]")
-	add_details("radio_usage","SYN-[msg_syndicate.len]")
-	add_details("radio_usage","SRV-[msg_service.len]")
-	add_details("radio_usage","CAR-[msg_cargo.len]")
-	add_details("radio_usage","OTH-[msg_other.len]")
-	add_details("radio_usage","PDA-[pda_msg_amt]")
-	add_details("radio_usage","RC-[rc_msg_amt]")
+		if (MS.pda_msgs.len)
+			record_feedback("tally", "radio_usage", MS.pda_msgs.len, "PDA")
+		if (MS.rc_msgs.len)
+			record_feedback("tally", "radio_usage", MS.rc_msgs.len, "request console")
+	if(research_levels.len)
+		SSblackbox.record_feedback("associative", "high_research_level", 1, research_levels)
 
 	if (!SSdbcore.Connect())
 		return
@@ -104,79 +64,183 @@ SUBSYSTEM_DEF(blackbox)
 	var/list/sqlrowlist = list()
 
 	for (var/datum/feedback_variable/FV in feedback)
-		sqlrowlist += list(list("time" = "Now()", "round_id" = GLOB.round_id, "var_name" =  "'[sanitizeSQL(FV.get_variable())]'", "var_value" = FV.get_value(), "details" = "'[sanitizeSQL(FV.get_details())]'"))
+		var/sqlversion = 1
+		if(FV.key in versions)
+			sqlversion = versions[FV.key]
+		sqlrowlist += list(list("datetime" = "Now()", "round_id" = GLOB.round_id, "key_name" =  "'[sanitizeSQL(FV.key)]'", "key_type" = "'[FV.key_type]'", "version" = "[sqlversion]", "json" = "'[sanitizeSQL(json_encode(FV.json))]'"))
 
 	if (!length(sqlrowlist))
 		return
 
 	SSdbcore.MassInsert(format_table_name("feedback"), sqlrowlist, ignore_errors = TRUE, delayed = TRUE)
 
+/datum/controller/subsystem/blackbox/proc/Seal()
+	if(sealed)
+		return
+	if(IsAdminAdvancedProcCall())
+		message_admins("[key_name_admin(usr)] sealed the blackbox!")
+	log_game("Blackbox sealed[IsAdminAdvancedProcCall() ? " by [key_name(usr)]" : ""].")
+	sealed = TRUE
 
-/datum/controller/subsystem/blackbox/proc/LogBroadcast(blackbox_msg, freq)
+/datum/controller/subsystem/blackbox/proc/log_research(tech, level)
+	if(!(tech in research_levels) || research_levels[tech] < level)
+		research_levels[tech] = level
+
+/datum/controller/subsystem/blackbox/proc/LogBroadcast(freq)
 	if(sealed)
 		return
 	switch(freq)
 		if(1459)
-			msg_common += blackbox_msg
-		if(1351)
-			msg_science += blackbox_msg
-		if(1353)
-			msg_command += blackbox_msg
-		if(1355)
-			msg_medical += blackbox_msg
-		if(1357)
-			msg_engineering += blackbox_msg
-		if(1359)
-			msg_security += blackbox_msg
-		if(1441)
-			msg_deathsquad += blackbox_msg
-		if(1213)
-			msg_syndicate += blackbox_msg
-		if(1349)
-			msg_service += blackbox_msg
-		if(1347)
-			msg_cargo += blackbox_msg
+			record_feedback("tally", "radio_usage", 1, "common")
+		if(GLOB.SCI_FREQ)
+			record_feedback("tally", "radio_usage", 1, "science")
+		if(GLOB.COMM_FREQ)
+			record_feedback("tally", "radio_usage", 1, "command")
+		if(GLOB.MED_FREQ)
+			record_feedback("tally", "radio_usage", 1, "medical")
+		if(GLOB.ENG_FREQ)
+			record_feedback("tally", "radio_usage", 1, "engineering")
+		if(GLOB.SEC_FREQ)
+			record_feedback("tally", "radio_usage", 1, "security")
+		if(GLOB.SYND_FREQ)
+			record_feedback("tally", "radio_usage", 1, "syndicate")
+		if(GLOB.SERV_FREQ)
+			record_feedback("tally", "radio_usage", 1, "service")
+		if(GLOB.SUPP_FREQ)
+			record_feedback("tally", "radio_usage", 1, "supply")
+		if(GLOB.CENTCOM_FREQ)
+			record_feedback("tally", "radio_usage", 1, "centcom")
+		if(GLOB.AIPRIV_FREQ)
+			record_feedback("tally", "radio_usage", 1, "ai private")
+		if(GLOB.REDTEAM_FREQ)
+			record_feedback("tally", "radio_usage", 1, "CTF red team")
+		if(GLOB.BLUETEAM_FREQ)
+			record_feedback("tally", "radio_usage", 1, "CTF blue team")
 		else
-			msg_other += blackbox_msg
+			record_feedback("tally", "radio_usage", 1, "other")
 
-/datum/controller/subsystem/blackbox/proc/find_feedback_datum(variable)
+/datum/controller/subsystem/blackbox/proc/find_feedback_datum(key, key_type)
 	for(var/datum/feedback_variable/FV in feedback)
-		if(FV.get_variable() == variable)
+		if(FV.key == key)
 			return FV
 
-	var/datum/feedback_variable/FV = new(variable)
+	var/datum/feedback_variable/FV = new(key, key_type)
 	feedback += FV
 	return FV
+/*
+feedback data can be recorded in 5 formats:
+"text"
+	used for simple single-string records i.e. the current map
+	further calls to the same key will append saved data unless the overwrite argument is true or it already exists
+	when encoded calls made with overwrite will lack square brackets
+	calls: 	SSblackbox.record_feedback("text", "example", 1, "sample text")
+			SSblackbox.record_feedback("text", "example", 1, "other text")
+	json: {"data":["sample text","other text"]}
+"amount"
+	used to record simple counts of data i.e. the number of ahelps recieved
+	further calls to the same key will add or subtract (if increment argument is a negative) from the saved amount
+	calls:	SSblackbox.record_feedback("amount", "example", 8)
+			SSblackbox.record_feedback("amount", "example", 2)
+	json: {"data":10}
+"tally"
+	used to track the number of occurances of multiple related values i.e. how many times each type of gun is fired
+	further calls to the same key will:
+	 	add or subtract from the saved value of the data key if it already exists
+		append the key and it's value if it doesn't exist
+	calls:	SSblackbox.record_feedback("tally", "example", 1, "sample data")
+			SSblackbox.record_feedback("tally", "example", 4, "sample data")
+			SSblackbox.record_feedback("tally", "example", 2, "other data")
+	json: {"data":{"sample data":5,"other data":2}}
+"nested tally"
+	used to track the number of occurances of structured semi-relational values i.e. the results of arcade machines
+	similar to running total, but related values are nested in a multi-dimensional array built
+	the final element in the data list is used as the tracking key, all prior elements are used for nesting
+	all data list elements must be strings
+	further calls to the same key will:
+	 	add or subtract from the saved value of the data key if it already exists in the same multi-dimensional position
+		append the key and it's value if it doesn't exist
+	calls: 	SSblackbox.record_feedback("nested tally", "example", 1, list("fruit", "orange", "apricot"))
+			SSblackbox.record_feedback("nested tally", "example", 2, list("fruit", "orange", "orange"))
+			SSblackbox.record_feedback("nested tally", "example", 3, list("fruit", "orange", "apricot"))
+			SSblackbox.record_feedback("nested tally", "example", 10, list("fruit", "red", "apple"))
+			SSblackbox.record_feedback("nested tally", "example", 1, list("vegetable", "orange", "carrot"))
+	json: {"data":{"fruit":{"orange":{"apricot":4,"orange":2},"red":{"apple":10}},"vegetable":{"orange":{"carrot":1}}}}
+	tracking values associated with a number can't merge with a nesting value, trying to do so will append the list
+	call:	SSblackbox.record_feedback("nested tally", "example", 3, list("fruit", "orange"))
+	json: {"data":{"fruit":{"orange":{"apricot":4,"orange":2},"red":{"apple":10},"orange":3},"vegetable":{"orange":{"carrot":1}}}}
+"associative"
+	used to record text that's associated with a value i.e. coordinates
+	further calls to the same key will append a new list to existing data
+	calls:	SSblackbox.record_feedback("associative", "example", 1, list("text" = "example", "path" = /obj/item, "number" = 4))
+			SSblackbox.record_feedback("associative", "example", 1, list("number" = 7, "text" = "example", "other text" = "sample"))
+	json: {"data":{"1":{"text":"example","path":"/obj/item","number":"4"},"2":{"number":"7","text":"example","other text":"sample"}}}
 
-/datum/controller/subsystem/blackbox/proc/set_val(variable, value)
-	if(sealed)
+Versioning
+	If the format of a feedback variable is ever changed, i.e. how many levels of nesting are used or a new type of data is added to it, add it to the versions list
+	When feedback is being saved if a key is in the versions list the value specified there will be used, otherwise all keys are assumed to be version = 1
+	versions is an associative list, remember to use the same string in it as defined on a feedback variable, example:
+	list/versions = list("round_end_stats" = 4,
+						"admin_toggle" = 2,
+						"gun_fired" = 2)
+*/
+/datum/controller/subsystem/blackbox/proc/record_feedback(key_type, key, increment, data, overwrite)
+	if(sealed || !key_type || !istext(key) || !isnum(increment || !data))
 		return
-	var/datum/feedback_variable/FV = find_feedback_datum(variable)
-	FV.set_value(value)
+	var/datum/feedback_variable/FV = find_feedback_datum(key, key_type)
+	switch(key_type)
+		if("text")
+			if(!istext(data))
+				return
+			if(!islist(FV.json["data"]))
+				FV.json["data"] = list()
+			if(overwrite)
+				FV.json["data"] = data
+			else
+				FV.json["data"] |= data
+		if("amount")
+			FV.json["data"] += increment
+		if("tally")
+			if(!islist(FV.json["data"]))
+				FV.json["data"] = list()
+			FV.json["data"]["[data]"] += increment
+		if("nested tally")
+			if(!islist(data))
+				return
+			if(!islist(FV.json["data"]))
+				FV.json["data"] = list()
+			FV.json["data"] = record_feedback_recurse_list(FV.json["data"], data, increment)
+		if("associative")
+			if(!islist(data))
+				return
+			if(!islist(FV.json["data"]))
+				FV.json["data"] = list()
+			var/pos = length(FV.json["data"]) + 1
+			FV.json["data"]["[pos]"] = list() //in 512 "pos" can be replaced with "[FV.json["data"].len+1]"
+			for(var/i in data)
+				FV.json["data"]["[pos]"]["[i]"] = "[data[i]]" //and here with "[FV.json["data"].len]"
 
-/datum/controller/subsystem/blackbox/proc/inc(variable, value)
-	if(sealed)
-		return
-	var/datum/feedback_variable/FV = find_feedback_datum(variable)
-	FV.inc(value)
+/datum/controller/subsystem/blackbox/proc/record_feedback_recurse_list(list/L, list/key_list, increment, depth = 1)
+	if(depth == key_list.len)
+		if(L.Find(key_list[depth]))
+			L["[key_list[depth]]"] += increment
+		else
+			var/list/LFI = list(key_list[depth] = increment)
+			L += LFI
+	else
+		if(!L.Find(key_list[depth]))
+			var/list/LGD = list(key_list[depth] = list())
+			L += LGD
+		L["[key_list[depth-1]]"] = .(L["[key_list[depth]]"], key_list, increment, ++depth)
+	return L
 
-/datum/controller/subsystem/blackbox/proc/dec(variable,value)
-	if(sealed)
-		return
-	var/datum/feedback_variable/FV = find_feedback_datum(variable)
-	FV.dec(value)
+/datum/feedback_variable
+	var/key
+	var/key_type
+	var/list/json = list()
 
-/datum/controller/subsystem/blackbox/proc/set_details(variable,details)
-	if(sealed)
-		return
-	var/datum/feedback_variable/FV = find_feedback_datum(variable)
-	FV.set_details(details)
-
-/datum/controller/subsystem/blackbox/proc/add_details(variable,details)
-	if(sealed)
-		return
-	var/datum/feedback_variable/FV = find_feedback_datum(variable)
-	FV.add_details(details)
+/datum/feedback_variable/New(new_key, new_key_type)
+	key = new_key
+	key_type = new_key_type
 
 /datum/controller/subsystem/blackbox/proc/ReportDeath(mob/living/L)
 	if(sealed)
@@ -208,69 +272,3 @@ SUBSYSTEM_DEF(blackbox)
 	var/map = sanitizeSQL(SSmapping.config.map_name)
 	var/datum/DBQuery/query_report_death = SSdbcore.NewQuery("INSERT INTO [format_table_name("death")] (pod, x_coord, y_coord, z_coord, mapname, server_ip, server_port, round_id, tod, job, special, name, byondkey, laname, lakey, bruteloss, fireloss, brainloss, oxyloss, toxloss, cloneloss, staminaloss, last_words, suicide) VALUES ('[sqlpod]', '[x_coord]', '[y_coord]', '[z_coord]', '[map]', INET_ATON(IF('[world.internet_address]' LIKE '', '0', '[world.internet_address]')), '[world.port]', [GLOB.round_id], '[SQLtime()]', '[sqljob]', '[sqlspecial]', '[sqlname]', '[sqlkey]', '[laname]', '[lakey]', [sqlbrute], [sqlfire], [sqlbrain], [sqloxy], [sqltox], [sqlclone], [sqlstamina], '[last_words]', [suicide])")
 	query_report_death.Execute()
-
-/datum/controller/subsystem/blackbox/proc/Seal()
-	if(sealed)
-		return
-	if(IsAdminAdvancedProcCall())
-		var/msg = "[key_name_admin(usr)] sealed the blackbox!"
-		message_admins(msg)
-	log_game("Blackbox sealed[IsAdminAdvancedProcCall() ? " by [key_name(usr)]" : ""].")
-	sealed = TRUE
-
-//feedback variable datum, for storing all kinds of data
-/datum/feedback_variable
-	var/variable
-	var/value
-	var/list/details
-
-/datum/feedback_variable/New(param_variable, param_value = 0)
-	variable = param_variable
-	value = param_value
-
-/datum/feedback_variable/proc/inc(num = 1)
-	if (isnum(value))
-		value += num
-	else
-		value = text2num(value)
-		if (isnum(value))
-			value += num
-		else
-			value = num
-
-/datum/feedback_variable/proc/dec(num = 1)
-	if (isnum(value))
-		value -= num
-	else
-		value = text2num(value)
-		if (isnum(value))
-			value -= num
-		else
-			value = -num
-
-/datum/feedback_variable/proc/set_value(num)
-	if (isnum(num))
-		value = num
-
-/datum/feedback_variable/proc/get_value()
-	if (!isnum(value))
-		return 0
-	return value
-
-/datum/feedback_variable/proc/get_variable()
-	return variable
-
-/datum/feedback_variable/proc/set_details(deets)
-	details = list("\"[deets]\"")
-
-/datum/feedback_variable/proc/add_details(deets)
-	if (!details)
-		set_details(deets)
-	else
-		details += "\"[deets]\""
-
-/datum/feedback_variable/proc/get_details()
-	return details ? details.Join(" | ") : null
-
-/datum/feedback_variable/proc/get_parsed()
-	return list(variable,value,details.Join(" | "))

code/controllers/subsystem/job.dm

@@ -462,36 +462,37 @@ SUBSYSTEM_DEF(job)
 
 /datum/controller/subsystem/job/proc/HandleFeedbackGathering()
 	for(var/datum/job/job in occupations)
-		var/tmp_str = "|[job.title]|"
-
-		var/level1 = 0 //high
-		var/level2 = 0 //medium
-		var/level3 = 0 //low
-		var/level4 = 0 //never
-		var/level5 = 0 //banned
-		var/level6 = 0 //account too young
+		var/high = 0 //high
+		var/medium = 0 //medium
+		var/low = 0 //low
+		var/never = 0 //never
+		var/banned = 0 //banned
+		var/young = 0 //account too young
 		for(var/mob/dead/new_player/player in GLOB.player_list)
 			if(!(player.ready == PLAYER_READY_TO_PLAY && player.mind && !player.mind.assigned_role))
 				continue //This player is not ready
 			if(jobban_isbanned(player, job.title))
-				level5++
+				banned++
 				continue
 			if(!job.player_old_enough(player.client))
-				level6++
+				young++
 				continue
 			if(job.required_playtime_remaining(player.client))
-				level6++
+				young++
 				continue
 			if(player.client.prefs.GetJobDepartment(job, 1) & job.flag)
-				level1++
+				high++
 			else if(player.client.prefs.GetJobDepartment(job, 2) & job.flag)
-				level2++
+				medium++
 			else if(player.client.prefs.GetJobDepartment(job, 3) & job.flag)
-				level3++
-			else level4++ //not selected
-
-		tmp_str += "HIGH=[level1]|MEDIUM=[level2]|LOW=[level3]|NEVER=[level4]|BANNED=[level5]|YOUNG=[level6]|-"
-		SSblackbox.add_details("job_preferences",tmp_str)
+				low++
+			else never++ //not selected
+		SSblackbox.record_feedback("nested tally", "job_preferences", high, list("[job.title]", "high"))
+		SSblackbox.record_feedback("nested tally", "job_preferences", medium, list("[job.title]", "medium"))
+		SSblackbox.record_feedback("nested tally", "job_preferences", low, list("[job.title]", "low"))
+		SSblackbox.record_feedback("nested tally", "job_preferences", never, list("[job.title]", "never"))
+		SSblackbox.record_feedback("nested tally", "job_preferences", banned, list("[job.title]", "banned"))
+		SSblackbox.record_feedback("nested tally", "job_preferences", young, list("[job.title]", "young"))
 
 /datum/controller/subsystem/job/proc/PopcapReached()
 	var/hpc = CONFIG_GET(number/hard_popcap)

code/controllers/subsystem/radiation.dm

@@ -13,6 +13,6 @@ PROCESSING_SUBSYSTEM_DEF(radiation)
 		return
 	warned_atoms[ref] = TRUE
 	var/atom/master = contamination.parent
-	SSblackbox.add_details("contaminated", "[master.type]")
+	SSblackbox.record_feedback("tally", "contaminated", 1, master.type)
 	var/msg = "has become contamintaed with enough radiation to contaminate other objects. || Source: [contamination.source] || Strength: [contamination.strength]"
 	master.investigate_log(msg, INVESTIGATE_RADIATION)

code/controllers/subsystem/shuttle.dm

@@ -167,7 +167,7 @@ SUBSYSTEM_DEF(shuttle)
 		var/mob/M = I
 		if(M.stat != DEAD)
 			++alive
-	
+
 	var/total = GLOB.joined_player_list.len
 
 	if(alive / total <= threshold)
@@ -247,7 +247,7 @@ SUBSYSTEM_DEF(shuttle)
 
 	log_game("[key_name(user)] has called the shuttle.")
 	if(call_reason)
-		SSblackbox.add_details("shuttle_reason", call_reason)
+		SSblackbox.record_feedback("text", "shuttle_reason", 1, "[call_reason]")
 		log_game("Shuttle call reason: [call_reason]")
 	message_admins("[key_name_admin(user)] has called the shuttle. (<A HREF='?_src_=holder;[HrefToken()];trigger_centcom_recall=1'>TRIGGER CENTCOM RECALL</A>)")
 

code/controllers/subsystem/time_track.dm

@@ -35,4 +35,4 @@ SUBSYSTEM_DEF(time_track)
 	last_tick_realtime = current_realtime
 	last_tick_byond_time = current_byondtime
 	last_tick_tickcount = current_tickcount
-	SSblackbox.add_details("time_dilation_current", time_dilation_current)
+	SSblackbox.record_feedback("associative", "time_dilation_current", 1, list("[time_dilation_current]" = "[SQLtime()]"))