Merge pull request ddnet#9479 from Robyt3/Storage-Error-Handling

Improve storage initialization and error handling, refactoring

src/base/log.cpp

@@ -549,3 +549,38 @@ void CFutureLogger::OnFilterChange()
 		pLogger->SetFilter(m_Filter);
 	}
 }
+
+void CMemoryLogger::Log(const CLogMessage *pMessage)
+{
+	if(m_pParentLogger)
+	{
+		m_pParentLogger->Log(pMessage);
+	}
+	if(m_Filter.Filters(pMessage))
+	{
+		return;
+	}
+	const CLockScope LockScope(m_MessagesMutex);
+	m_vMessages.push_back(*pMessage);
+}
+
+std::vector<CLogMessage> CMemoryLogger::Lines()
+{
+	const CLockScope LockScope(m_MessagesMutex);
+	return m_vMessages;
+}
+
+std::string CMemoryLogger::ConcatenatedLines()
+{
+	const CLockScope LockScope(m_MessagesMutex);
+	std::string Result;
+	for(const CLogMessage &Message : m_vMessages)
+	{
+		if(!Result.empty())
+		{
+			Result += '\n';
+		}
+		Result += Message.m_aLine;
+	}
+	return Result;
+}

src/base/logger.h

@@ -6,6 +6,7 @@
 
 #include <atomic>
 #include <memory>
+#include <string>
 #include <vector>
 
 typedef void *IOHANDLE;
@@ -247,6 +248,30 @@ class CFutureLogger : public ILogger
 	void OnFilterChange() override;
 };
 
+/**
+ * @ingroup Log
+ *
+ * Logger that collects messages in memory. This is useful to collect the log
+ * messages for a particular operation and show them in a user interface when
+ * the operation failed. Use only temporarily with @link CLogScope @endlink
+ * or it will result in excessive memory usage.
+ *
+ * Messages are also forwarded to the parent logger if it's set, regardless
+ * of this logger's filter.
+ */
+class CMemoryLogger : public ILogger
+{
+	ILogger *m_pParentLogger = nullptr;
+	std::vector<CLogMessage> m_vMessages GUARDED_BY(m_MessagesMutex);
+	CLock m_MessagesMutex;
+
+public:
+	void SetParent(ILogger *pParentLogger) { m_pParentLogger = pParentLogger; }
+	void Log(const CLogMessage *pMessage) override REQUIRES(!m_MessagesMutex);
+	std::vector<CLogMessage> Lines() REQUIRES(!m_MessagesMutex);
+	std::string ConcatenatedLines() REQUIRES(!m_MessagesMutex);
+};
+
 /**
  * @ingroup Log
  *

src/engine/client/client.cpp

@@ -4067,8 +4067,7 @@ void CClient::Con_BenchmarkQuit(IConsole::IResult *pResult, void *pUserData)
 
 void CClient::BenchmarkQuit(int Seconds, const char *pFilename)
 {
-	char aBuf[IO_MAX_PATH_LENGTH];
-	m_BenchmarkFile = Storage()->OpenFile(pFilename, IOFLAG_WRITE, IStorage::TYPE_ABSOLUTE, aBuf, sizeof(aBuf));
+	m_BenchmarkFile = Storage()->OpenFile(pFilename, IOFLAG_WRITE, IStorage::TYPE_ABSOLUTE);
 	m_BenchmarkStopTime = time_get() + time_freq() * Seconds;
 }
 
@@ -4708,7 +4707,23 @@ int main(int argc, const char **argv)
 		delete pEngine;
 	});
 
-	IStorage *pStorage = CreateStorage(IStorage::STORAGETYPE_CLIENT, argc, argv);
+	IStorage *pStorage;
+	{
+		CMemoryLogger MemoryLogger;
+		MemoryLogger.SetParent(log_get_scope_logger());
+		{
+			CLogScope LogScope(&MemoryLogger);
+			pStorage = CreateStorage(IStorage::EInitializationType::CLIENT, argc, argv);
+		}
+		if(!pStorage)
+		{
+			log_error("client", "Failed to initialize the storage location (see details above)");
+			std::string Message = "Failed to initialize the storage location. See details below.\n\n" + MemoryLogger.ConcatenatedLines();
+			pClient->ShowMessageBox("Storage Error", Message.c_str());
+			PerformAllCleanup();
+			return -1;
+		}
+	}
 	pKernel->RegisterInterface(pStorage);
 
 	pFutureAssertionLogger->Set(CreateAssertionLogger(pStorage, GAME_NAME));

src/engine/server/main.cpp

@@ -120,7 +120,12 @@ int main(int argc, const char **argv)
 	IEngine *pEngine = CreateEngine(GAME_NAME, pFutureConsoleLogger, 2 * std::thread::hardware_concurrency() + 2);
 	pKernel->RegisterInterface(pEngine);
 
-	IStorage *pStorage = CreateStorage(IStorage::STORAGETYPE_SERVER, argc, argv);
+	IStorage *pStorage = CreateStorage(IStorage::EInitializationType::SERVER, argc, argv);
+	if(!pStorage)
+	{
+		log_error("server", "failed to initialize storage");
+		return -1;
+	}
 	pKernel->RegisterInterface(pStorage);
 
 	pFutureAssertionLogger->Set(CreateAssertionLogger(pStorage, GAME_NAME));