Debounce url logging for same content. Avoids spam.

- Improve output of the radio entity also.
- Entity reload keeps motion state.

Author: Grocel

data_static/streamradio/version.txt

@@ -1,2 +1,2 @@
-449
-1733522924
+450
+1750700988

lua/entities/base_streamradio.lua

@@ -20,8 +20,6 @@ ENT.Editable = false
 ENT.Spawnable = false
 ENT.AdminOnly = false
 
-ENT.WireDebugName = "Stream Radio"
-
 function ENT:AddDTNetworkVar(datatype, name, ...)
 	if not g_isLoaded then
 		return

lua/entities/sent_streamradio/init.lua

@@ -4,6 +4,7 @@ include( "shared.lua" )
 DEFINE_BASECLASS( "base_streamradio_gui" )
 
 local StreamRadioLib = StreamRadioLib
+local LIBPrint = StreamRadioLib.Print
 local LIBError = StreamRadioLib.Error
 local LIBWire = StreamRadioLib.Wire
 local LIBUtil = StreamRadioLib.Util
@@ -208,25 +209,49 @@ function ENT:OnTakeDamage( dmg )
 	self:TakePhysicsDamage( dmg )
 end
 
-function ENT:OnReloaded( )
-	if not IsValid( self ) then return end
+function ENT:OnReloaded()
+	if not IsValid(self) then return end
 	if not g_isLoaded then return end
 
-	local ply, model, pos, ang = self:GetRealRadioOwner(), self:GetModel( ), self:GetPos( ), self:GetAngles( )
-	StreamRadioLib.Print.Msg(ply, "Reloaded %s", tostring(self))
-	self:Remove( )
-
-	StreamRadioLib.Timedcall( function( ply, model, pos, ang )
-		local ent = StreamRadioLib.SpawnRadio( ply, model, pos, ang )
-		if ( not IsValid( ent ) ) then return end
-		if ( not IsValid( ply ) ) then return end
-		local TOOL_Class = "streamradio"
-		undo.Create( TOOL_Class )
-		undo.AddEntity( ent )
-		undo.SetPlayer( ply )
-		undo.Finish( )
-		ply:AddCleanup( TOOL_Class, ent )
-	end, ply, model, pos, ang )
+	local ply = self:GetRealRadioOwner()
+	local model = self:GetModel()
+	local pos = self:GetPos()
+	local ang = self:GetAngles()
+	local radioName = LIBPrint.GetRadioEntityString(self)
+
+	local motion = false
+
+	local selfPhys = self:GetPhysicsObject()
+	if IsValid(selfPhys) then
+		motion = selfPhys:IsMotionEnabled()
+	end
+
+	self:Remove()
+
+	StreamRadioLib.Timedcall(function(ply, model, pos, ang)
+		local ent = StreamRadioLib.SpawnRadio(ply, model, pos, ang)
+		if not IsValid(ent) then
+			return
+		end
+
+		local entPhys = ent:GetPhysicsObject()
+		if IsValid(entPhys) then
+			entPhys:EnableMotion(motion)
+		end
+
+		LIBPrint.Msg(ply, "%s respawned after reload.", radioName)
+
+		if IsValid(ply) then
+			local TOOL_Class = "streamradio"
+
+			undo.Create(TOOL_Class)
+			undo.AddEntity(ent)
+			undo.SetPlayer(ply)
+			undo.Finish()
+
+			ply:AddCleanup(TOOL_Class, ent)
+		end
+	end, ply, model, pos, ang)
 end
 
 function ENT:UpdateVolume()

lua/streamradio_core/print.lua

@@ -78,6 +78,24 @@ function LIB.GetPlayerString(ply)
 	return playerStr
 end
 
+function LIB.GetRadioEntityString(ent)
+	if not IsValid(ent) then
+		return tostring(ent or NULL)
+	end
+
+	if not ent.__IsRadio then
+		return tostring(ent)
+	end
+
+	local radioName = string.format(
+		"%s [%s]",
+		ent.PrintName,
+		ent:EntIndex()
+	)
+
+	return radioName
+end
+
 local g_colorSeparator = Color(255, 255, 255)
 local g_colorDateTime = Color(180, 180, 180)
 local g_colorAddonName = Color(0, 200, 0)

lua/streamradio_core/server/sv_lib.lua

@@ -3,13 +3,20 @@ local StreamRadioLib = StreamRadioLib
 local LIBNet = StreamRadioLib.Net
 local LIBUrl = StreamRadioLib.Url
 local LIBHook = StreamRadioLib.Hook
+local LIBUtil = StreamRadioLib.Util
 local LIBPrint = StreamRadioLib.Print
 
 LIBNet.Receive("Control", function( len, ply )
 	local trace = StreamRadioLib.Trace( ply )
 	StreamRadioLib.Control(ply, trace, net.ReadBool())
 end)
 
+local g_logDebounce = LIBUtil.CreateCacheArray(4096)
+
+LIBHook.Add("PostCleanupMap", "ResetDebounceUrlLogging", function()
+	g_logDebounce:Empty()
+end)
+
 LIBHook.AddCustom("OnPlayStream", "UrlLogging", function(url, name, ent, user)
 	local mode = StreamRadioLib.GetStreamLogMode()
 
@@ -32,16 +39,36 @@ LIBHook.AddCustom("OnPlayStream", "UrlLogging", function(url, name, ent, user)
 		nameHasUrl = true
 	end
 
+	local debounceKey = string.format(
+		"%s_%d_%s_%s",
+		LIBPrint.GetPlayerString(user),
+		ent:GetCreationID(),
+		url,
+		name
+	)
+
+	-- Prevent shenanigans with ultra long urls or player names.
+	debounceKey = StreamRadioLib.Util.Hash(debounceKey)
+	local now = RealTime()
+
+	if g_logDebounce:Has(debounceKey, now) then
+		return
+	end
+
 	local msgstring = nil
 	local onlinestring = offline and "file" or "online"
+	local radioName = LIBPrint.GetRadioEntityString(ent)
 
 	if nameHasUrl then
-		msgstring = LIBPrint.Format("STREAM - Radio '%s' plays %s => %s", ent, onlinestring, name)
+		msgstring = LIBPrint.Format("STREAM - Radio '%s' plays %s => %s", radioName, onlinestring, name)
 	else
-		msgstring = LIBPrint.Format("STREAM - Radio '%s' plays %s => %s: %s", ent, onlinestring, name, url)
+		msgstring = LIBPrint.Format("STREAM - Radio '%s' plays %s => %s: %s", radioName, onlinestring, name, url)
 	end
 
 	LIBPrint.Log(user, msgstring)
+
+	-- Allow a new log entry/print with the same content after one minute.
+	g_logDebounce:Set(debounceKey, true, now + 60)
 end)
 
 return true