Merge pull request #65 from rayshader/timestamp_log_rotation

Enable log rotation with timestamp context.

Author: wopss

src/dll/App.cpp

@@ -149,6 +149,9 @@ void App::Startup()
         system->Startup();
     }
 
+    auto pluginNames = GetPluginSystem()->GetActivePlugins();
+    GetLoggerSystem()->RotateLogs(pluginNames);
+
     spdlog::info("RED4ext has been started");
 }
 

src/dll/Systems/LoggerSystem.cpp

@@ -1,5 +1,7 @@
-#include "stdafx.hpp"
 #include "LoggerSystem.hpp"
+#include "Config.hpp"
+#include "Paths.hpp"
+#include "stdafx.hpp"
 
 LoggerSystem::LoggerSystem(const Paths& aPaths, const Config& aConfig, const DevConsole& aDevConsole)
     : m_paths(aPaths)
@@ -32,6 +34,65 @@ void LoggerSystem::Shutdown()
     spdlog::trace("{} logger(s) flushed", count);
 }
 
+void LoggerSystem::RotateLogs(std::vector<std::wstring> pluginNames) const
+{
+    std::error_code error;
+    auto files = std::filesystem::directory_iterator(m_paths.GetLogsDir(), error);
+
+    if (error)
+    {
+        // Ignore and try the next time.
+        return;
+    }
+    spdlog::trace("Rotate logs...");
+    pluginNames.emplace_back(L"RED4ext");
+
+    // List all log files.
+    std::vector<std::filesystem::path> logs;
+
+    for (const std::filesystem::directory_entry& file : files)
+    {
+        const auto fileName = file.path().filename().wstring();
+
+        if (file.is_regular_file() && fileName.ends_with(L".log"))
+        {
+            logs.emplace_back(file.path());
+        }
+    }
+    const Config::LoggingConfig config = m_config.GetLogging();
+
+    // Rotate oldest logs per plugin.
+    for (auto pluginName : pluginNames)
+    {
+        pluginName = Utils::ToLower(pluginName);
+        std::vector<std::filesystem::path> pluginLogs;
+
+        logs.erase(std::remove_if(logs.begin(), logs.end(),
+                                  [&pluginName, &pluginLogs](const auto& log)
+                                  {
+                                      if (log.filename().wstring().starts_with(pluginName))
+                                      {
+                                          pluginLogs.push_back(log);
+                                          return true;
+                                      }
+                                      return false;
+                                  }),
+                   logs.end());
+        std::sort(pluginLogs.begin(), pluginLogs.end(), [](const auto& a, const auto& b) { return a > b; });
+
+        // maxFiles is guaranteed to be >= 1.
+        for (size_t i = config.maxFiles; i < pluginLogs.size(); i++)
+        {
+            std::filesystem::remove(pluginLogs[i], error);
+        }
+    }
+    // Remove log files of removed plugins.
+    for (const auto& log : logs)
+    {
+        std::filesystem::remove(log, error);
+    }
+}
+
 void LoggerSystem::Trace(std::shared_ptr<PluginBase> aPlugin, std::string_view aText)
 {
     Log(aPlugin, spdlog::level::trace, aText);

src/dll/Systems/LoggerSystem.hpp

@@ -16,6 +16,8 @@ class LoggerSystem : public ISystem
     void Startup() final;
     void Shutdown() final;
 
+    void RotateLogs(std::vector<std::wstring> plugins) const;
+
     void Trace(std::shared_ptr<PluginBase> aPlugin, std::string_view aText);
     void Trace(std::shared_ptr<PluginBase> aPlugin, std::wstring_view aText);
 
@@ -60,14 +62,12 @@ class LoggerSystem : public ISystem
                 const auto stem = path.stem();
                 auto fileName = stem.wstring();
 
-                std::transform(fileName.begin(), fileName.end(), fileName.begin(),
-                               [](wchar_t aC) { return std::towlower(aC); });
+                fileName = Utils::ToLower(fileName);
 
                 const auto logName = aPlugin->GetName();
 
                 fileName = fmt::format(L"{}-{}.log", fileName, Utils::FormatCurrentTimestamp());
-                logger =
-                    Utils::CreateLogger(logName, fileName, m_paths, m_config, m_devConsole);
+                logger = Utils::CreateLogger(logName, fileName, m_paths, m_config, m_devConsole);
                 m_loggers.emplace(aPlugin, logger);
             }
         }

src/dll/Systems/PluginSystem.cpp

@@ -185,6 +185,18 @@ const std::vector<PluginSystem::PluginName>& PluginSystem::GetIncompatiblePlugin
     return m_incompatiblePlugins;
 }
 
+std::vector<PluginSystem::PluginName> PluginSystem::GetActivePlugins() const
+{
+    std::vector<PluginSystem::PluginName> plugins;
+
+    plugins.reserve(m_plugins.size());
+    for (const auto& [handle, plugin] : m_plugins)
+    {
+        plugins.emplace_back(plugin->GetName());
+    }
+    return plugins;
+}
+
 void PluginSystem::Load(const std::filesystem::path& aPath, bool aUseAlteredSearchPath)
 {
     spdlog::info(L"Loading plugin from '{}'...", aPath);

src/dll/Systems/PluginSystem.hpp

@@ -20,6 +20,7 @@ class PluginSystem : public ISystem
 
     std::shared_ptr<PluginBase> GetPlugin(HMODULE aModule) const;
     const std::vector<PluginName>& GetIncompatiblePlugins() const;
+    std::vector<PluginName> GetActivePlugins() const;
 
 private:
     using Map_t = std::unordered_map<HMODULE, std::shared_ptr<PluginBase>>;

src/dll/Utils.cpp

@@ -5,6 +5,7 @@
 #include "stdafx.hpp"
 
 #include <ctime>
+#include <cwctype>
 
 #include <spdlog/sinks/rotating_file_sink.h>
 #include <spdlog/sinks/stdout_color_sinks.h>
@@ -230,3 +231,11 @@ std::wstring Utils::Widen(const std::string_view aText)
 
     return result;
 }
+
+std::wstring Utils::ToLower(const std::wstring& acText)
+{
+    std::wstring text = acText;
+
+    std::transform(text.begin(), text.end(), text.begin(), std::towlower);
+    return text;
+}

src/dll/Utils.hpp

@@ -21,6 +21,8 @@ int32_t ShowMessageBox(const std::wstring_view aText, uint32_t aType = MB_OK);
 std::string Narrow(const std::wstring_view aText);
 std::wstring Widen(const std::string_view aText);
 
+std::wstring ToLower(const std::wstring& acText);
+
 template<typename... Args>
 int32_t ShowMessageBox(uint32_t aType, const std::wstring_view aText, Args&&... aArgs)
 {