Ticket #3255: t3255_prevent_replay_overwrites_v6.patch

source/ps/Replay.cpp

@@ -28 +28 @@
 #include "ps/Loader.h"
 #include "ps/Mod.h"
 #include "ps/Profile.h"
 #include "ps/ProfileViewer.h"
 #include "ps/Pyrogenesis.h"
+#include "ps/Util.h"
+#include "ps/VisualReplay.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptStats.h"
 #include "simulation2/Simulation2.h"
 #include "simulation2/helpers/SimulationCommand.h"
 
+#include <ctime>
 #include <sstream>
 #include <fstream>
 #include <iomanip>
 
-#if MSC_VERSION
-#include <process.h>
-#define getpid _getpid // use the non-deprecated function name
-#endif
-
 static std::string Hexify(const std::string& s)
 {
     std::stringstream str;
     str << std::hex;
     for (size_t i = 0; i < s.size(); ++i)
@@ -70 +68 @@
 
     // Add engine version and currently loaded mods for sanity checks when replaying
     m_ScriptInterface.SetProperty(attribs, "engine_version", CStr(engine_version));
     m_ScriptInterface.SetProperty(attribs, "mods", g_modsLoaded);
 
-    // Construct the directory name based on the PID, to be relatively unique.
-    // Append "-1", "-2" etc if we run multiple matches in a single session,
-    // to avoid accidentally overwriting earlier logs.
-    static int run = -1;
-    do
-    {
-        std::wstringstream name;
-        name << getpid();
-        if (++run)
-            name << "-" << run;
-
-        m_Directory = psLogDir() / L"sim_log" / name.str();
-    } while (DirectoryExists(m_Directory));
-
+    m_Directory = getDateIndexSubdirectory(VisualReplay::GetDirectoryName());
+    debug_printf("Writing replay to %s\n", m_Directory.string8().c_str());
     CreateDirectories(m_Directory, 0700);
 
     m_Stream = new std::ofstream(OsString(m_Directory / L"commands.txt").c_str(), std::ofstream::out | std::ofstream::trunc);
     *m_Stream << "start " << m_ScriptInterface.StringifyJSON(attribs, false) << "\n";
 }

source/ps/Util.cpp

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -191 +191 @@
 
     (void)da_free(&da);
     return ret;
 }
 
+/**
+ * Return an unused directory, based on date and index (for example 2016-02-09_0001)
+ */
+OsPath getDateIndexSubdirectory(const OsPath& parentDir)
+{
+    const std::time_t timestamp = std::time(nullptr);
+    const struct std::tm* now = std::localtime(&timestamp);
+
+    int i = 0;
+    OsPath path;
+    char directory[256];
+
+    do
+    {
+        sprintf(directory, "%04d-%02d-%02d_%04d", now->tm_year+1900, now->tm_mon+1, now->tm_mday, ++i);
+        path = parentDir / CStr(directory);
+    } while (DirectoryExists(path) || FileExists(path));
+
+    return path;
+}
 
 static size_t s_nextScreenshotNumber;
 
 // <extension> identifies the file format that is to be written
 // (case-insensitive). examples: "bmp", "png", "jpg".

source/ps/Util.h

@@ -1 @@
-/* Copyright (C) 2009 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -24 +24 @@
 
 extern void WriteSystemInfo();
 
 extern const wchar_t* ErrorString(int err);
 
+extern OsPath getDateIndexSubdirectory(const OsPath& parentDir);
+
 extern void WriteScreenshot(const VfsPath& extension);
 extern void WriteBigScreenshot(const VfsPath& extension, int tiles);
 
 extern Status tex_write(Tex* t, const VfsPath& filename);
 

source/ps/VisualReplay.cpp

@@ -1 @@
-/* Copyright (C) 2015 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -25 +25 @@
 #include "network/NetClient.h"
 #include "network/NetServer.h"
 #include "ps/CLogger.h"
 #include "ps/Filesystem.h"
 #include "ps/Game.h"
+#include "ps/GameSetup/Paths.h"
+#include "ps/Mod.h"
 #include "ps/Pyrogenesis.h"
 #include "ps/Replay.h"
+#include "ps/Util.h"
 #include "scriptinterface/ScriptInterface.h"
 
 /**
  * Filter too short replays (value in seconds).
  */
 const u8 minimumReplayDuration = 3;
 
 OsPath VisualReplay::GetDirectoryName()
 {
-    return OsPath(psLogDir() / L"sim_log");
+    const Paths paths(g_args);
+    return OsPath(paths.UserData() / "replays" / engine_version);
 }
 
 void VisualReplay::StartVisualReplay(const CStrW& directory)
 {
     ENSURE(!g_NetServer);

source/simulation2/Simulation2.cpp

@@ -39 +39 @@
 #include "ps/ConfigDB.h"
 #include "ps/Filesystem.h"
 #include "ps/Loader.h"
 #include "ps/Profile.h"
 #include "ps/Pyrogenesis.h"
+#include "ps/Util.h"
 #include "ps/XML/Xeromyces.h"
 
 #include <iomanip>
 
-#if MSC_VERSION
-#include <process.h>
-#define getpid _getpid // use the non-deprecated function name
-#endif
-
 static std::string Hexify(const std::string& s) // TODO: shouldn't duplicate this function in so many places
 {
     std::stringstream str;
     str << std::hex;
     for (size_t i = 0; i < s.size(); ++i)
@@ -77 +73 @@
         if (CConfigDB::IsInitialised())
         {
             CFG_GET_VAL("ooslog", m_EnableOOSLog);
             CFG_GET_VAL("serializationtest", m_EnableSerializationTest);
         }
+
+        m_OOSLogPath = getDateIndexSubdirectory(psLogDir() / "oos_logs");
+
+        if (m_EnableOOSLog)
+            debug_printf("Writing ooslogs to %s\n", m_OOSLogPath.string8().c_str());
     }
 
     ~CSimulation2Impl()
     {
         UnregisterFileReloadFunc(ReloadChangedFileCB, this);
@@ -130 +131 @@
     std::set<VfsPath> m_LoadedScripts;
 
     uint32_t m_TurnNumber;
 
     bool m_EnableOOSLog;
-
+    OsPath m_OOSLogPath;
 
     // Functions and data for the serialization test mode: (see Update() for relevant comments)
 
     bool m_EnableSerializationTest;
 
@@ -293 +294 @@
 
 void CSimulation2Impl::ReportSerializationFailure(
     SerializationTestState* primaryStateBefore, SerializationTestState* primaryStateAfter,
     SerializationTestState* secondaryStateBefore, SerializationTestState* secondaryStateAfter)
 {
-    OsPath path = psLogDir() / "oos_log";
+    const OsPath path = getDateIndexSubdirectory(psLogDir() / "serializationtest");
+    debug_printf("Writing serializationtest-data to %s\n", path.string8().c_str());
     CreateDirectories(path, 0700);
 
     // Clean up obsolete files from previous runs
     wunlink(path / "hash.before.a");
     wunlink(path / "hash.before.b");
@@ -547 +549 @@
 
 void CSimulation2Impl::DumpState()
 {
     PROFILE("DumpState");
 
-    std::stringstream pid;
-    pid << getpid();
     std::stringstream name;\
     name << std::setw(5) << std::setfill('0') << m_TurnNumber << ".txt";
-    OsPath path = psLogDir() / "sim_log" / pid.str() / name.str();
+    const OsPath path = m_OOSLogPath / name.str();
     CreateDirectories(path.Parent(), 0700);
     std::ofstream file (OsString(path).c_str(), std::ofstream::out | std::ofstream::trunc);
 
     file << "State hash: " << std::hex;
     std::string hashRaw;
@@ -587 +587 @@
 // Forward all method calls to the appropriate CSimulation2Impl/CComponentManager methods:
 
 void CSimulation2::EnableOOSLog()
 {
     m->m_EnableOOSLog = true;
+    debug_printf("Writing ooslogs to %s\n", m->m_OOSLogPath.string8().c_str());
 }
 
 void CSimulation2::EnableSerializationTest()
 {
     m->m_EnableSerializationTest = true;