feat: Add replay archive feature

Author: Stubbjax

Generals/Code/GameEngine/Include/Common/GlobalData.h

@@ -392,6 +392,7 @@ class GlobalData : public SubsystemInterface
 																			 smaller area within the rectangle to order the gather. */
 
 	Int m_antiAliasBoxValue;          ///< value of selected antialias from combo box in options menu
+	Bool m_archiveReplays;						///< if true, each replay is archived to the replay archive folder after recording
 	Bool m_languageFilterPref;        ///< Bool if user wants to filter language
 	Bool m_loadScreenDemo;						///< Bool if true, run the loadscreen demo movie
 	Bool m_disableRender;							///< if true, no rendering!

Generals/Code/GameEngine/Include/Common/Recorder.h

@@ -119,6 +119,7 @@ class RecorderClass : public SubsystemInterface {
 	void initControls();															///< Show or Hide the Replay controls
 
 	AsciiString getReplayDir();												///< Returns the directory that holds the replay files.
+	AsciiString getReplayArchiveDir();								///< Returns the directory that holds the archived replay files.
 	static AsciiString getReplayExtention();									///< Returns the file extention for replay files.
 	AsciiString getLastReplayFileName();							///< Returns the filename used for the default replay.
 
@@ -137,6 +138,7 @@ class RecorderClass : public SubsystemInterface {
 protected:
 	void startRecording(GameDifficulty diff, Int originalGameMode, Int rankPoints, Int maxFPS);					///< Start recording to m_file.
 	void writeToFile(GameMessage *msg);								///< Write this GameMessage to m_file.
+	void archiveReplay(AsciiString fileName);					///< Move the specified replay file to the archive directory.
 
 	void logGameStart(AsciiString options);
 	void logGameEnd( void );

Generals/Code/GameEngine/Include/Common/UserPreferences.h

@@ -91,6 +91,7 @@ class OptionPreferences : public UserPreferences
 	void setOnlineIPAddress(AsciiString IP);	// convenience function
 	void setLANIPAddress(UnsignedInt IP);			// convenience function
 	void setOnlineIPAddress(UnsignedInt IP);	// convenience function
+	Bool getArchiveReplaysEnabled();					// convenience function
 	Bool getAlternateMouseModeEnabled(void);	// convenience function
 	Real getScrollFactor(void);								// convenience function
 	Bool getDrawScrollAnchor(void);

Generals/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -920,6 +920,7 @@ GlobalData::GlobalData()
 	m_standardPublicBones.clear();
 
 	m_antiAliasBoxValue = 0;
+	m_archiveReplays = false;
 
 //	m_languageFilterPref = false;
 	m_languageFilterPref = true;
@@ -1173,6 +1174,7 @@ void GlobalData::parseGameDataDefinition( INI* ini )
 
 	// override INI values with user preferences
 	OptionPreferences optionPref;
+	TheWritableGlobalData->m_archiveReplays = optionPref.getArchiveReplaysEnabled();
  	TheWritableGlobalData->m_useAlternateMouse = optionPref.getAlternateMouseModeEnabled();
 	TheWritableGlobalData->m_keyboardScrollFactor = optionPref.getScrollFactor();
 	TheWritableGlobalData->m_drawScrollAnchor = optionPref.getDrawScrollAnchor();

Generals/Code/GameEngine/Source/Common/Recorder.cpp

@@ -726,10 +726,40 @@ void RecorderClass::stopRecording() {
 	if (m_file != NULL) {
 		m_file->close();
 		m_file = NULL;
+
+		if (TheGlobalData->m_archiveReplays)
+			archiveReplay(m_fileName);
 	}
 	m_fileName.clear();
 }
 
+/**
+ * Copy the replay file to the archive directory and rename it using the current timestamp.
+ */
+void RecorderClass::archiveReplay(AsciiString fileName)
+{
+	SYSTEMTIME st;
+	GetLocalTime(&st);
+
+	AsciiString archiveFileName;
+	// Use a standard YYYYMMDD_HHMMSS format for simplicity and to avoid conflicts.
+	archiveFileName.format("%04d%02d%02d_%02d%02d%02d", st.wYear, st.wMonth, st.wDay, st.wHour, st.wMinute, st.wSecond);
+
+	AsciiString sourcePath = getReplayDir();
+	sourcePath.concat(fileName);
+
+	if (!sourcePath.endsWith(getReplayExtention()))
+		sourcePath.concat(getReplayExtention());
+
+	AsciiString destPath = getReplayArchiveDir();
+	destPath.concat(archiveFileName);
+	destPath.concat(getReplayExtention());
+
+	TheFileSystem->createDirectory(getReplayArchiveDir().str());
+	if (!CopyFile(sourcePath.str(), destPath.str(), FALSE))
+		DEBUG_LOG(("RecorderClass::archiveReplay: Failed to copy %s to %s", sourcePath.str(), destPath.str()));
+}
+
 /**
  * Write this game message to the record file. This also writes the game message's execution frame.
  */
@@ -1602,6 +1632,18 @@ AsciiString RecorderClass::getReplayDir()
 	return tmp;
 }
 
+/**
+ * returns the directory that holds the archived replay files.
+ */
+AsciiString RecorderClass::getReplayArchiveDir()
+{
+	const char* replayDir = "ArchivedReplays\\";
+
+	AsciiString tmp = TheGlobalData->getPath_UserData();
+	tmp.concat(replayDir);
+	return tmp;
+}
+
 /**
  * returns the file extention for the replay files.
  */

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp

@@ -310,6 +310,18 @@ void OptionPreferences::setOnlineIPAddress( UnsignedInt IP )
 	(*this)["GameSpyIPAddress"] = tmp;
 }
 
+Bool OptionPreferences::getArchiveReplaysEnabled()
+{
+	OptionPreferences::const_iterator it = find("ArchiveReplays");
+	if (it == end())
+		return TheGlobalData->m_archiveReplays;
+
+	if (stricmp(it->second.str(), "yes") == 0) {
+		return TRUE;
+	}
+	return FALSE;
+}
+
 Bool OptionPreferences::getAlternateMouseModeEnabled(void)
 {
 	OptionPreferences::const_iterator it = find("UseAlternateMouse");

GeneralsMD/Code/GameEngine/Include/Common/GlobalData.h

@@ -400,6 +400,7 @@ class GlobalData : public SubsystemInterface
 																			 smaller area within the rectangle to order the gather. */
 
 	Int m_antiAliasBoxValue;          ///< value of selected antialias from combo box in options menu
+	Bool m_archiveReplays;						///< if true, each replay is archived to the replay archive folder after recording
 	Bool m_languageFilterPref;        ///< Bool if user wants to filter language
 	Bool m_loadScreenDemo;						///< Bool if true, run the loadscreen demo movie
 	Bool m_disableRender;							///< if true, no rendering!

GeneralsMD/Code/GameEngine/Include/Common/Recorder.h

@@ -119,6 +119,7 @@ class RecorderClass : public SubsystemInterface {
 	void initControls();															///< Show or Hide the Replay controls
 
 	AsciiString getReplayDir();												///< Returns the directory that holds the replay files.
+	AsciiString getReplayArchiveDir();								///< Returns the directory that holds the archived replay files.
 	static AsciiString getReplayExtention();									///< Returns the file extention for replay files.
 	AsciiString getLastReplayFileName();							///< Returns the filename used for the default replay.
 
@@ -137,6 +138,7 @@ class RecorderClass : public SubsystemInterface {
 protected:
 	void startRecording(GameDifficulty diff, Int originalGameMode, Int rankPoints, Int maxFPS);					///< Start recording to m_file.
 	void writeToFile(GameMessage *msg);								///< Write this GameMessage to m_file.
+	void archiveReplay(AsciiString fileName);					///< Move the specified replay file to the archive directory.
 
 	void logGameStart(AsciiString options);
 	void logGameEnd( void );

GeneralsMD/Code/GameEngine/Include/Common/UserPreferences.h

@@ -92,6 +92,7 @@ class OptionPreferences : public UserPreferences
 	void setOnlineIPAddress(AsciiString IP);	// convenience function
 	void setLANIPAddress(UnsignedInt IP);			// convenience function
 	void setOnlineIPAddress(UnsignedInt IP);	// convenience function
+	Bool getArchiveReplaysEnabled();					// convenience function
 	Bool getAlternateMouseModeEnabled(void);	// convenience function
 	Bool getRetaliationModeEnabled();					// convenience function
 	Bool getDoubleClickAttackMoveEnabled(void);	// convenience function

GeneralsMD/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -929,6 +929,7 @@ GlobalData::GlobalData()
 	m_standardPublicBones.clear();
 
 	m_antiAliasBoxValue = 0;
+	m_archiveReplays = false;
 
 //	m_languageFilterPref = false;
 	m_languageFilterPref = true;
@@ -1199,6 +1200,7 @@ void GlobalData::parseGameDataDefinition( INI* ini )
 
 	// override INI values with user preferences
 	OptionPreferences optionPref;
+	TheWritableGlobalData->m_archiveReplays = optionPref.getArchiveReplaysEnabled();
 	TheWritableGlobalData->m_useAlternateMouse = optionPref.getAlternateMouseModeEnabled();
 	TheWritableGlobalData->m_clientRetaliationModeEnabled = optionPref.getRetaliationModeEnabled();
 	TheWritableGlobalData->m_doubleClickAttackMove = optionPref.getDoubleClickAttackMoveEnabled();