Cleanup old log files

lib/framework/physfs_ext.cpp

@@ -124,7 +124,7 @@ bool WZ_PHYSFS_createPlatformPrefDir(const WzString& basePath, const WzString& a
 	return true;
 }
 
-static bool filenameEndWithExtension(const char *filename, const char *extension)
+bool filenameEndWithExtension(const char *filename, const char *extension)
 {
 	if (nullptr == filename)
 	{
@@ -146,18 +146,26 @@ struct compareTimes {
 
 int WZ_PHYSFS_cleanupOldFilesInFolder(const char *path, const char *extension, int fileLimit, const std::function<bool (const char *fileName)>& deleteFileFunction)
 {
-	ASSERT_OR_RETURN(-1, path != nullptr, "Null path");
 	ASSERT_OR_RETURN(-1, extension != nullptr, "Null extension");
+	CleanupFileEnumFilterFunctions filterFuncs;
+	filterFuncs.fileNameFilterFunction = [extension](const char *fileName) -> bool {
+		return filenameEndWithExtension(fileName, extension);
+	};
+	return WZ_PHYSFS_cleanupOldFilesInFolder(path, filterFuncs, fileLimit, deleteFileFunction);
+}
+
+int WZ_PHYSFS_cleanupOldFilesInFolder(const char *path, const CleanupFileEnumFilterFunctions& fileFilterFunctions, int fileLimit, const std::function<bool (const char *fileName)>& deleteFileFunction)
+{
+	ASSERT_OR_RETURN(-1, path != nullptr, "Null path");
 	ASSERT_OR_RETURN(-1, deleteFileFunction != nullptr, "No deleteFileFunction");
 	char **i, **files;
 	files = PHYSFS_enumerateFiles(path);
 	ASSERT_OR_RETURN(-1, files, "PHYSFS_enumerateFiles(\"%s\") failed: %s", path, WZ_PHYSFS_getLastError());
 	int nfiles = 0;
 	for (i = files; *i != nullptr; ++i)
 	{
-		if (!filenameEndWithExtension(*i, extension))
+		if (fileFilterFunctions.fileNameFilterFunction != nullptr && !fileFilterFunctions.fileNameFilterFunction(*i))
 		{
-			// If it doesn't, move on to the next filename
 			continue;
 		}
 		nfiles++;
@@ -169,21 +177,24 @@ int WZ_PHYSFS_cleanupOldFilesInFolder(const char *path, const char *extension, i
 	}
 
 	// too many files
-	debug(LOG_SAVE, "found %i files with ext %s, limit is %i", nfiles, extension, fileLimit);
+	debug(LOG_SAVE, "found %i matching files in %s, limit is %i", nfiles, path, fileLimit);
 
 	// build a sorted list of file + save time
 	std::multiset<SaveTimePair, compareTimes> fileTimes;
 	char savefile[PATH_MAX];
 	for (i = files; *i != nullptr; ++i)
 	{
-		if (!filenameEndWithExtension(*i, extension))
+		if (fileFilterFunctions.fileNameFilterFunction != nullptr && !fileFilterFunctions.fileNameFilterFunction(*i))
 		{
-			// If it doesn't, move on to the next filename
 			continue;
 		}
 		/* Gather save-time */
 		snprintf(savefile, sizeof(savefile), "%s/%s", path, *i);
 		time_t savetime = WZ_PHYSFS_getLastModTime(savefile);
+		if (fileFilterFunctions.fileLastModifiedFilterFunction != nullptr && !fileFilterFunctions.fileLastModifiedFilterFunction(savetime))
+		{
+			continue;
+		}
 		fileTimes.insert(SaveTimePair{*i, savetime});
 	}
 

lib/framework/physfs_ext.h

@@ -287,4 +287,15 @@ bool WZ_PHYSFS_createPlatformPrefDir(const WzString& basePath, const WzString& a
 // fileLimit: < 0, pass the single oldest matching file to deleteFileFunction
 int WZ_PHYSFS_cleanupOldFilesInFolder(const char *path, const char *extension, int fileLimit, const std::function<bool (const char *fileName)>& deleteFileFunction);
 
+struct CleanupFileEnumFilterFunctions
+{
+	// Return `true` to include a file, `false` to exclude it
+	std::function<bool (const char *fileName)> fileNameFilterFunction;
+	std::function<bool (time_t fileLastModified)> fileLastModifiedFilterFunction;
+};
+
+int WZ_PHYSFS_cleanupOldFilesInFolder(const char *path, const CleanupFileEnumFilterFunctions& fileFilterFunctions, int fileLimit, const std::function<bool (const char *fileName)>& deleteFileFunction);
+
+bool filenameEndWithExtension(const char *filename, const char *extension);
+
 #endif // _physfs_ext_h

src/main.cpp

@@ -1581,6 +1581,43 @@ static void wzCmdInterfaceShutdown()
 	stdInThreadShutdown();
 }
 
+static void cleanupOldLogFiles()
+{
+	constexpr int MAX_OLD_LOGS = 50;
+	ASSERT_OR_RETURN(, PHYSFS_isInit() != 0, "PhysFS isn't initialized");
+	// safety check to ensure we *never* delete the current log file
+	WzString fullCurrentLogFileName = WzString::fromUtf8(getDefaultLogFilePath("/"));
+	if (fullCurrentLogFileName.startsWith("logs/"))
+	{
+		fullCurrentLogFileName.remove(0, 5);
+	}
+
+	CleanupFileEnumFilterFunctions filterFuncs;
+	constexpr std::chrono::hours MinDeletableAge(24 * 7); // never delete logs that are less than a week old
+	auto currentTime = std::chrono::system_clock::now();
+	filterFuncs.fileNameFilterFunction = [](const char *fileName) -> bool {
+		return filenameEndWithExtension(fileName, ".txt") || filenameEndWithExtension(fileName, ".log");
+	};
+	filterFuncs.fileLastModifiedFilterFunction = [currentTime, MinDeletableAge](time_t fileLastModified) -> bool {
+		return std::chrono::duration_cast<std::chrono::hours>(currentTime - std::chrono::system_clock::from_time_t(fileLastModified)) >= MinDeletableAge;
+	};
+
+	// clean up old log .txt / .log files
+	WZ_PHYSFS_cleanupOldFilesInFolder("logs", filterFuncs, MAX_OLD_LOGS, [fullCurrentLogFileName](const char *fileName){
+		if (fullCurrentLogFileName.compare(fileName) == 0)
+		{
+			// skip
+			return true;
+		}
+		if (PHYSFS_delete(fileName) == 0)
+		{
+			debug(LOG_ERROR, "Failed to delete old log file: %s", fileName);
+			return false;
+		}
+		return true;
+	});
+}
+
 // for backend detection
 extern const char *BACKEND;
 
@@ -1985,6 +2022,7 @@ int realmain(int argc, char *argv[])
 #endif
 	wzCmdInterfaceShutdown();
 	urlRequestShutdown();
+	cleanupOldLogFiles();
 	systemShutdown();
 #ifdef WZ_OS_WIN	// clean up the memory allocated for the command line conversion
 	for (int i = 0; i < argc; i++)