add Shavit_AdditionalReplayPath, edit & rename Shavit_ShouldSaveReplayCopy to Shavit_AddAdditionalReplayPathsHere, edit Shavit_OnReplaySaved, edit WriteReplayFrames, and make compatible with srcwr💾 v4.0.0

Author: rtldg

.github/workflows/ci.yml

@@ -36,8 +36,8 @@ jobs:
           wget https://github.com/srcwr/eventqueuefixfix/releases/download/v1.0.1/eventqueuefixfix-v1.0.1-def5b0e-windows-x32.zip
           unzip eventqueuefixfix-v1.0.1-def5b0e-windows-x32.zip "addons/sourcemod/extensions/*"
           rm "addons/sourcemod/extensions/eventqueuefixfix.pdb"
-          wget https://github.com/srcwr/srcwrfloppy/releases/download/v2.0.4/srcwrfloppy-v2.0.4.zip
-          unzip -qO UTF-8 srcwrfloppy-v2.0.4.zip "addons/sourcemod/extensions/*"
+          wget https://github.com/srcwr/srcwrfloppy/releases/download/v4.0.0/srcwrfloppy-v4.0.0.zip
+          unzip -qO UTF-8 srcwrfloppy-v4.0.0.zip "addons/sourcemod/extensions/*"
           rm "addons/sourcemod/extensions/srcwr💾.pdb"
 
       - name: Run compiler

addons/sourcemod/scripting/include/shavit/replay-file.inc

@@ -390,9 +390,7 @@ stock int WriteReplayHeaderToBuffer(char[] buf, int style, int track, float time
 	return pos;
 }
 
-// file_a is usually used as the wr replay file.
-// file_b is usually used as the duplicate/backup replay file.
-stock void WriteReplayFrames(ArrayList playerrecording, int iSize, File file_a, File file_b)
+stock void WriteReplayFrames(ArrayList playerrecording, int iSize, File replayfile)
 {
 	any aFrameData[sizeof(frame_t)];
 	any aWriteData[sizeof(frame_t) * REPLAY_FRAMES_PER_WRITE];
@@ -409,16 +407,7 @@ stock void WriteReplayFrames(ArrayList playerrecording, int iSize, File file_a,
 
 		if(++iFramesWritten == REPLAY_FRAMES_PER_WRITE || i == iSize - 1)
 		{
-			if (file_a)
-			{
-				file_a.Write(aWriteData, sizeof(frame_t) * iFramesWritten, 4);
-			}
-
-			if (file_b)
-			{
-				file_b.Write(aWriteData, sizeof(frame_t) * iFramesWritten, 4);
-			}
-
+			replayfile.Write(aWriteData, sizeof(frame_t) * iFramesWritten, 4);
 			iFramesWritten = 0;
 		}
 	}

addons/sourcemod/scripting/include/shavit/replay-recorder.inc

@@ -24,8 +24,16 @@
 #endif
 #define _shavit_replay_recorder_included
 
+/**
+ * If you want to save a replay to an additional path, then call this inside of `Shavit_AddAdditionalReplayPathsHere()`.
+ *
+ * @param path                      The additional path to save the replay to.
+ */
+native void Shavit_AdditionalReplayPath(const char[] path);
+
 /**
  * Called when a player finishes a time. Allows you to save a replay even if the run is not a WR.
+ * To save replay to additional paths, call `Shavit_AdditionalReplayPath()`
  *
  * @param client                    Client index.
  * @param style                     Style the record was done on.
@@ -42,9 +50,9 @@
  * @param isbestreplay              If the time is the new replay.
  * @param istoolong                 If the time is too long to save a replay if the time is a WR. Note: replays WON'T be full length if this is true.
  *
- * @return                          Return Plugin_Changed (or higher) to cause a copy of the replay to be saved. Return Plugin_Continue otherwise.
+ * @noreturn
  */
-forward Action Shavit_ShouldSaveReplayCopy(int client, int style, float time, int jumps, int strafes, float sync, int track, float oldtime, float perfs, float avgvel, float maxvel, int timestamp, bool isbestreplay, bool istoolong);
+forward void Shavit_AddAdditionalReplayPathsHere(int client, int style, float time, int jumps, int strafes, float sync, int track, float oldtime, float perfs, float avgvel, float maxvel, int timestamp, bool isbestreplay, bool istoolong);
 
 /**
  * Called when either a WR replay or a copy of a replay has been saved.
@@ -64,16 +72,15 @@ forward Action Shavit_ShouldSaveReplayCopy(int client, int style, float time, in
  * @param timestamp                 System time of when player finished.
  * @param isbestreplay              If the time is the new replay.
  * @param istoolong                 If the time is too long to save a replay if the time is a WR. Note: replays WON'T be full length if this is true.
- * @param iscopy                    If the path points to a copy of the replay.
- * @param replaypath                Path to the saved replay.
+ * @param replaypaths               ArrayList of the paths the replay was saved to.  If isbestreplay&&!istoolong then the 0th index will be the WR path.
  * @param frames                	ArrayList of the player's frames in the replay.
  * @param preframes                	The number of preframes in the replay.
  * @param postframes                The number of postframes in the replay.
  * @param name                		Player's name at the time of the replay.
  *
  * @noreturn
  */
-forward void Shavit_OnReplaySaved(int client, int style, float time, int jumps, int strafes, float sync, int track, float oldtime, float perfs, float avgvel, float maxvel, int timestamp, bool isbestreplay, bool istoolong, bool iscopy, const char[] replaypath, ArrayList frames, int preframes, int postframes, const char[] name);
+forward void Shavit_OnReplaySaved(int client, int style, float time, int jumps, int strafes, float sync, int track, float oldtime, float perfs, float avgvel, float maxvel, int timestamp, bool isbestreplay, bool istoolong, ArrayList replaypaths, ArrayList frames, int preframes, int postframes, const char[] name);
 
 /**
  * Retrieves a client's frame count.

addons/sourcemod/scripting/include/srcwr/floppy.inc

@@ -9,16 +9,15 @@
 
 
 typeset ReplaySavedCallback {
-	function void(bool saved, any value, char[] sPath);
+	function void(bool saved, any value);
 }
 
 
 // Don't modify the `playerrecording` ArrayList until the ReplaySavedCallback is called... OR ELSE!!!!
 native void SRCWRFloppy_AsyncSaveReplay(
 	  ReplaySavedCallback callback // what to call when saved
 	, any value // what to pass along to the callback
-	, char[] wrpath
-	, char[] copypath
+	, ArrayList paths
 	, char[] header
 	, int headersize
 	, ArrayList playerrecording

addons/sourcemod/scripting/shavit-replay-playback.sp

@@ -1696,7 +1696,7 @@ public void Shavit_OnStyleChanged(int client, int oldstyle, int newstyle, int tr
 	gI_TimeDifferenceStyle[client] = newstyle;
 }
 
-public void Shavit_OnReplaySaved(int client, int style, float time, int jumps, int strafes, float sync, int track, float oldtime, float perfs, float avgvel, float maxvel, int timestamp, bool isbestreplay, bool istoolong, bool iscopy, const char[] replaypath, ArrayList frames, int preframes, int postframes, const char[] name)
+public void Shavit_OnReplaySaved(int client, int style, float time, int jumps, int strafes, float sync, int track, float oldtime, float perfs, float avgvel, float maxvel, int timestamp, bool isbestreplay, bool istoolong, ArrayList paths, ArrayList frames, int preframes, int postframes, const char[] name)
 {
 	if (!isbestreplay || istoolong)
 	{
@@ -2763,7 +2763,7 @@ public void Player_Event(Event event, const char[] name, bool dontBroadcast)
 			KickReplay(gA_BotInfo[index]);
 		}
 	}
-	
+
 	if(IsPlayerAlive(client) && gB_InReplayMenu[client])
 	{
 		CancelClientMenu(client);

addons/sourcemod/scripting/shavit-replay-recorder.sp

@@ -77,7 +77,7 @@ Convar gCV_PlaybackPreRunTime = null;
 Convar gCV_PreRunAlways = null;
 Convar gCV_TimeLimit = null;
 
-Handle gH_ShouldSaveReplayCopy = null;
+Handle gH_AddAdditionalReplayPathsHere = null;
 Handle gH_OnReplaySaved = null;
 
 bool gB_RecordingEnabled[MAXPLAYERS+1]; // just a simple thing to prevent plugin reloads from recording half-replays
@@ -100,6 +100,8 @@ bool gB_HijackFramesKeepOnStart[MAXPLAYERS+1];
 bool gB_ReplayPlayback = false;
 bool gB_Floppy = false;
 
+ArrayList gA_PathsToSaveReplayTo = null;
+
 //#include <TickRateControl>
 forward void TickRate_OnTickRateChanged(float fOld, float fNew);
 
@@ -111,6 +113,7 @@ public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max
 	CreateNative("Shavit_HijackAngles", Native_HijackAngles);
 	CreateNative("Shavit_SetReplayData", Native_SetReplayData);
 	CreateNative("Shavit_SetPlayerPreFrames", Native_SetPlayerPreFrames);
+	CreateNative("Shavit_AlsoSaveReplayTo", Native_AlsoSaveReplayTo);
 
 	if (!FileExists("cfg/sourcemod/plugin.shavit-replay-recorder.cfg") && FileExists("cfg/sourcemod/plugin.shavit-replay.cfg"))
 	{
@@ -140,8 +143,8 @@ public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max
 
 public void OnPluginStart()
 {
-	gH_ShouldSaveReplayCopy = CreateGlobalForward("Shavit_ShouldSaveReplayCopy", ET_Event, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell);
-	gH_OnReplaySaved = CreateGlobalForward("Shavit_OnReplaySaved", ET_Ignore, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_String, Param_Cell, Param_Cell, Param_Cell, Param_String);
+	gH_AddAdditionalReplayPathsHere = CreateGlobalForward("Shavit_AddAdditionalReplayPathsHere", ET_Ignore, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell);
+	gH_OnReplaySaved = CreateGlobalForward("Shavit_OnReplaySaved", ET_Ignore, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_Cell, Param_String);
 
 	gCV_Enabled = new Convar("shavit_replay_recording_enabled", "1", "Enable replay bot functionality?", 0, true, 0.0, true, 1.0);
 	gCV_PlaybackPostRunTime = new Convar("shavit_replay_postruntime", "1.5", "Time (in seconds) to record after a player enters the end zone.", 0, true, 0.0, true, 2.0);
@@ -360,8 +363,22 @@ void DoReplaySaverCallbacks(int iSteamID, int client, int style, float time, int
 	float length = ExistingWrReplayLength(style, track);
 	bool isBestReplay = (length == 0.0 || time < length);
 
-	Action action = Plugin_Continue;
-	Call_StartForward(gH_ShouldSaveReplayCopy);
+	delete gA_PathsToSaveReplayTo;
+	ArrayList paths = gA_PathsToSaveReplayTo = new ArrayList(ByteCountToCells(PLATFORM_MAX_PATH));
+
+	bool makeReplay = (isBestReplay && !isTooLong);
+
+	if (makeReplay)
+	{
+		char wrpath[PLATFORM_MAX_PATH];
+		FormatEx(wrpath, sizeof(wrpath),
+			track>0?"%s/%d/%s_%d.replay" : "%s/%d/%s.replay",
+			gS_ReplayFolder, style, gS_Map, track
+		);
+		paths.PushString(wrpath);
+	}
+
+	Call_StartForward(gH_AddAdditionalReplayPathsHere);
 	Call_PushCell(client);
 	Call_PushCell(style);
 	Call_PushCell(time);
@@ -376,12 +393,11 @@ void DoReplaySaverCallbacks(int iSteamID, int client, int style, float time, int
 	Call_PushCell(timestamp);
 	Call_PushCell(isBestReplay);
 	Call_PushCell(isTooLong);
-	Call_Finish(action);
+	Call_Finish();
 
-	bool makeCopy = (action != Plugin_Continue);
-	bool makeReplay = (isBestReplay && !isTooLong);
+	gA_PathsToSaveReplayTo = null;
 
-	if (!makeCopy && !makeReplay)
+	if (paths.Length == 0)
 	{
 		return;
 	}
@@ -409,48 +425,51 @@ void DoReplaySaverCallbacks(int iSteamID, int client, int style, float time, int
 	dp.WriteCell(timestamp);
 	dp.WriteCell(isBestReplay);
 	dp.WriteCell(isTooLong);
-	dp.WriteCell(makeCopy);
+	dp.WriteCell(paths);
 	dp.WriteCell(playerrecording);
 	dp.WriteCell(gI_PlayerPrerunFrames[client]);
 	dp.WriteCell(postframes);
 	dp.WriteString(sName);
 
 	if (gB_Floppy)
 	{
-		char buf[512];
-		int headersize = WriteReplayHeaderToBuffer(buf, style, track, time, iSteamID, gI_PlayerPrerunFrames[client], postframes, fZoneOffset, gI_PlayerFrames[client], gF_Tickrate, gS_Map);
-
-		char wrpath[PLATFORM_MAX_PATH], copypath[PLATFORM_MAX_PATH];
-		if (makeReplay)
-			FormatEx(wrpath, sizeof(wrpath),
-				track>0?"%s/%d/%s_%d.replay" : "%s/%d/%s.replay",
-				gS_ReplayFolder, style, gS_Map, track
-			);
-		if (makeCopy)
-			FormatEx(copypath, sizeof(copypath), "%s/copy/%d_%d_%s.replay", gS_ReplayFolder, timestamp, iSteamID, gS_Map);
+		char headerbuf[512];
+		int headersize = WriteReplayHeaderToBuffer(headerbuf, style, track, time, iSteamID, gI_PlayerPrerunFrames[client], postframes, fZoneOffset, gI_PlayerFrames[client], gF_Tickrate, gS_Map);
 
 		SRCWRFloppy_AsyncSaveReplay(
 			  FloppyAsynchronouslySavedMyReplayWhichWasNiceOfThem
 			, dp
-			, wrpath
-			, copypath
-			, buf
+			, paths
+			, headerbuf
 			, headersize
 			, playerrecording
 			, gI_PlayerFrames[client]
 		);
 	}
 	else
 	{
-		char sPath[PLATFORM_MAX_PATH];
-		bool saved = SaveReplay(style, track, time, iSteamID, gI_PlayerPrerunFrames[client], playerrecording, gI_PlayerFrames[client], postframes, timestamp, fZoneOffset, makeCopy, makeReplay, sPath, sizeof(sPath));
-		FloppyAsynchronouslySavedMyReplayWhichWasNiceOfThem(saved, dp, sPath)
+		bool saved = false;
+
+		for (int i = 0, size = paths.Length; i < size; ++i)
+		{
+			char path[PLATFORM_MAX_PATH], tmp[PLATFORM_MAX_PATH];
+			paths.GetString(i, path, sizeof(path));
+			FormatEx(tmp, sizeof(tmp), "%s.tmp", path);
+
+			if (SaveReplay(style, track, time, iSteamID, gI_PlayerPrerunFrames[client], playerrecording, gI_PlayerFrames[client], postframes, fZoneOffset, tmp))
+			{
+				saved = true;
+				RenameFile(path, tmp);
+			}
+		}
+
+		FloppyAsynchronouslySavedMyReplayWhichWasNiceOfThem(saved, dp)
 	}
 
 	ClearFrames(client);
 }
 
-void FloppyAsynchronouslySavedMyReplayWhichWasNiceOfThem(bool saved, any value, char[] sPath)
+void FloppyAsynchronouslySavedMyReplayWhichWasNiceOfThem(bool saved, any value)
 {
 	DataPack dp = value;
 	dp.Reset();
@@ -469,7 +488,7 @@ void FloppyAsynchronouslySavedMyReplayWhichWasNiceOfThem(bool saved, any value,
 	int timestamp = dp.ReadCell();
 	bool isBestReplay = dp.ReadCell();
 	bool isTooLong = dp.ReadCell();
-	bool makeCopy = dp.ReadCell();
+	ArrayList paths = dp.ReadCell();
 	ArrayList playerrecording = dp.ReadCell();
 	int preframes = dp.ReadCell();
 	int postframes = dp.ReadCell();
@@ -498,8 +517,7 @@ void FloppyAsynchronouslySavedMyReplayWhichWasNiceOfThem(bool saved, any value,
 	Call_PushCell(timestamp);
 	Call_PushCell(isBestReplay);
 	Call_PushCell(isTooLong);
-	Call_PushCell(makeCopy);
-	Call_PushString(sPath);
+	Call_PushCell(paths);
 	Call_PushCell(playerrecording);
 	Call_PushCell(preframes);
 	Call_PushCell(postframes);
@@ -556,66 +574,19 @@ public void Shavit_OnFinish(int client, int style, float time, int jumps, int st
 	}
 }
 
-bool SaveReplay(int style, int track, float time, int steamid, int preframes, ArrayList playerrecording, int iSize, int postframes, int timestamp, float fZoneOffset[2], bool saveCopy, bool saveWR, char[] sPath, int sPathLen)
+bool SaveReplay(int style, int track, float time, int steamid, int preframes, ArrayList playerrecording, int iSize, int postframes, float fZoneOffset[2], const char[] sPath)
 {
-	char sTrack[4];
-	FormatEx(sTrack, 4, "_%d", track);
+	File fReplay = null;
 
-	File fWR = null;
-	File fCopy = null;
-
-	if (saveCopy)
-	{
-		FormatEx(sPath, sPathLen, "%s/copy/%d_%d_%s.replay", gS_ReplayFolder, timestamp, steamid, gS_Map);
-
-		if (!(fCopy = OpenFile(sPath, "wb+")))
-		{
-			LogError("Failed to open 'copy' replay file for writing. ('%s')", sPath);
-		}
+	if (!(fReplay = OpenFile(sPath, "wb+"))) {
+		LogError("Failed to open replay file for writing. ('%s')", sPath);
+		return false;
 	}
 
-	if (saveWR)
-	{
-		FormatEx(sPath, sPathLen, "%s/%d/%s%s.replay", gS_ReplayFolder, style, gS_Map, (track > 0)? sTrack:"");
+	WriteReplayHeader(fReplay, style, track, time, steamid, preframes, postframes, fZoneOffset, iSize, gF_Tickrate, gS_Map);
+	WriteReplayFrames(playerrecording, iSize, fReplay);
 
-		if (!(fWR = OpenFile(sPath, "wb+")))
-		{
-			LogError("Failed to open WR replay file for writing. ('%s')", sPath);
-		}
-	}
-
-	if (!fWR && !fCopy)
-	{
-		// I want to try and salvage the replay file so let's write it out to a random
-		//  file and hope people read the error log to figure out what happened...
-		// I'm not really sure how we could reach this though as
-		//  `Shavit_Replay_CreateDirectories` should have failed if it couldn't create
-		//  a test file.
-		FormatEx(sPath, sPathLen, "%s/%d_%s%s_%d.replay", gS_ReplayFolder, style, gS_Map, sTrack, iSize-preframes-postframes);
-
-		if (!(fWR = OpenFile(sPath, "wb+")))
-		{
-			LogError("Couldn't open a WR, 'copy', or 'salvage' replay file....");
-			return false;
-		}
-
-		LogError("Couldn't open a WR or 'copy' replay file. Writing 'salvage' replay @ (style %d) '%s'", style, sPath);
-	}
-
-	if (fWR)
-	{
-		WriteReplayHeader(fWR, style, track, time, steamid, preframes, postframes, fZoneOffset, iSize, gF_Tickrate, gS_Map);
-	}
-
-	if (fCopy)
-	{
-		WriteReplayHeader(fCopy, style, track, time, steamid, preframes, postframes, fZoneOffset, iSize, gF_Tickrate, gS_Map);
-	}
-
-	WriteReplayFrames(playerrecording, iSize, fWR, fCopy);
-
-	delete fWR;
-	delete fCopy;
+	delete fReplay;
 	return true;
 }
 
@@ -722,6 +693,17 @@ public int Native_SetPlayerPreFrames(Handle handler, int numParams)
 	return 1;
 }
 
+public int Native_AlsoSaveReplayTo(Handle plugin, int numParams)
+{
+	if (gA_PathsToSaveReplayTo)
+	{
+		char path[PLATFORM_MAX_PATH];
+		GetNativeString(1, path, sizeof(path));
+		gA_PathsToSaveReplayTo.PushString(path);
+	}
+	return 0; // native has void return so this value doesn't matter.
+}
+
 public int Native_GetReplayData(Handle plugin, int numParams)
 {
 	int client = GetNativeCell(1);