Adjust folder structure (#242)v1.9.5-rc1v1.9.5

* Adjust folder structure

* change launcher directory name

1 files changed, 489 insertions, 0 deletions

diff --git a/NorthstarDLL/logging.cpp b/NorthstarDLL/logging.cpp
new file mode 100644
index 00000000..38430c76
--- /dev/null
+++ b/NorthstarDLL/logging.cpp
@@ -0,0 +1,489 @@
+#include "pch.h"
+#include "logging.h"
+#include "sourceconsole.h"
+#include "spdlog/sinks/basic_file_sink.h"
+#include "hookutils.h"
+#include "dedicated.h"
+#include "convar.h"
+#include <iomanip>
+#include <sstream>
+#include "configurables.h"
+#include <dbghelp.h>
+
+// This needs to be called after hooks are loaded so we can access the command line args
+void CreateLogFiles()
+{
+	if (strstr(GetCommandLineA(), "-disablelogs"))
+	{
+		spdlog::default_logger()->set_level(spdlog::level::off);
+	}
+	else
+	{
+		// todo: might be good to delete logs that are too old
+		time_t time = std::time(nullptr);
+		tm currentTime = *std::localtime(&time);
+		std::stringstream stream;
+
+		stream << std::put_time(&currentTime, (GetNorthstarPrefix() + "/logs/nslog%Y-%m-%d %H-%M-%S.txt").c_str());
+		spdlog::default_logger()->sinks().push_back(std::make_shared<spdlog::sinks::basic_file_sink_mt>(stream.str(), false));
+		spdlog::flush_on(spdlog::level::info);
+	}
+}
+
+long __stdcall ExceptionFilter(EXCEPTION_POINTERS* exceptionInfo)
+{
+	static bool logged = false;
+	if (logged)
+		return EXCEPTION_CONTINUE_SEARCH;
+
+	if (!IsDebuggerPresent())
+	{
+		const DWORD exceptionCode = exceptionInfo->ExceptionRecord->ExceptionCode;
+		if (exceptionCode != EXCEPTION_ACCESS_VIOLATION && exceptionCode != EXCEPTION_ARRAY_BOUNDS_EXCEEDED &&
+			exceptionCode != EXCEPTION_DATATYPE_MISALIGNMENT && exceptionCode != EXCEPTION_FLT_DENORMAL_OPERAND &&
+			exceptionCode != EXCEPTION_FLT_DIVIDE_BY_ZERO && exceptionCode != EXCEPTION_FLT_INEXACT_RESULT &&
+			exceptionCode != EXCEPTION_FLT_INVALID_OPERATION && exceptionCode != EXCEPTION_FLT_OVERFLOW &&
+			exceptionCode != EXCEPTION_FLT_STACK_CHECK && exceptionCode != EXCEPTION_FLT_UNDERFLOW &&
+			exceptionCode != EXCEPTION_ILLEGAL_INSTRUCTION && exceptionCode != EXCEPTION_IN_PAGE_ERROR &&
+			exceptionCode != EXCEPTION_INT_DIVIDE_BY_ZERO && exceptionCode != EXCEPTION_INT_OVERFLOW &&
+			exceptionCode != EXCEPTION_INVALID_DISPOSITION && exceptionCode != EXCEPTION_NONCONTINUABLE_EXCEPTION &&
+			exceptionCode != EXCEPTION_PRIV_INSTRUCTION && exceptionCode != EXCEPTION_STACK_OVERFLOW)
+			return EXCEPTION_CONTINUE_SEARCH;
+
+		std::stringstream exceptionCause;
+		exceptionCause << "Cause: ";
+		switch (exceptionCode)
+		{
+		case EXCEPTION_ACCESS_VIOLATION:
+		case EXCEPTION_IN_PAGE_ERROR:
+		{
+			exceptionCause << "Access Violation" << std::endl;
+
+			auto exceptionInfo0 = exceptionInfo->ExceptionRecord->ExceptionInformation[0];
+			auto exceptionInfo1 = exceptionInfo->ExceptionRecord->ExceptionInformation[1];
+
+			if (!exceptionInfo0)
+				exceptionCause << "Attempted to read from: 0x" << (void*)exceptionInfo1;
+			else if (exceptionInfo0 == 1)
+				exceptionCause << "Attempted to write to: 0x" << (void*)exceptionInfo1;
+			else if (exceptionInfo0 == 8)
+				exceptionCause << "Data Execution Prevention (DEP) at: 0x" << (void*)std::hex << exceptionInfo1;
+			else
+				exceptionCause << "Unknown access violation at: 0x" << (void*)exceptionInfo1;
+
+			break;
+		}
+		case EXCEPTION_ARRAY_BOUNDS_EXCEEDED:
+			exceptionCause << "Array bounds exceeded";
+			break;
+		case EXCEPTION_DATATYPE_MISALIGNMENT:
+			exceptionCause << "Datatype misalignment";
+			break;
+		case EXCEPTION_FLT_DENORMAL_OPERAND:
+			exceptionCause << "Denormal operand";
+			break;
+		case EXCEPTION_FLT_DIVIDE_BY_ZERO:
+			exceptionCause << "Divide by zero (float)";
+			break;
+		case EXCEPTION_INT_DIVIDE_BY_ZERO:
+			exceptionCause << "Divide by zero (int)";
+			break;
+		case EXCEPTION_FLT_INEXACT_RESULT:
+			exceptionCause << "Inexact result";
+			break;
+		case EXCEPTION_FLT_INVALID_OPERATION:
+			exceptionCause << "Invalid operation";
+			break;
+		case EXCEPTION_FLT_OVERFLOW:
+		case EXCEPTION_INT_OVERFLOW:
+			exceptionCause << "Numeric overflow";
+			break;
+		case EXCEPTION_FLT_UNDERFLOW:
+			exceptionCause << "Numeric underflow";
+			break;
+		case EXCEPTION_FLT_STACK_CHECK:
+			exceptionCause << "Stack check";
+			break;
+		case EXCEPTION_ILLEGAL_INSTRUCTION:
+			exceptionCause << "Illegal instruction";
+			break;
+		case EXCEPTION_INVALID_DISPOSITION:
+			exceptionCause << "Invalid disposition";
+			break;
+		case EXCEPTION_NONCONTINUABLE_EXCEPTION:
+			exceptionCause << "Noncontinuable exception";
+			break;
+		case EXCEPTION_PRIV_INSTRUCTION:
+			exceptionCause << "Priviledged instruction";
+			break;
+		case EXCEPTION_STACK_OVERFLOW:
+			exceptionCause << "Stack overflow";
+			break;
+		default:
+			exceptionCause << "Unknown";
+			break;
+		}
+
+		void* exceptionAddress = exceptionInfo->ExceptionRecord->ExceptionAddress;
+
+		HMODULE crashedModuleHandle;
+		GetModuleHandleExA(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS, static_cast<LPCSTR>(exceptionAddress), &crashedModuleHandle);
+
+		MODULEINFO crashedModuleInfo;
+		GetModuleInformation(GetCurrentProcess(), crashedModuleHandle, &crashedModuleInfo, sizeof(crashedModuleInfo));
+
+		char crashedModuleFullName[MAX_PATH];
+		GetModuleFileNameExA(GetCurrentProcess(), crashedModuleHandle, crashedModuleFullName, MAX_PATH);
+		char* crashedModuleName = strrchr(crashedModuleFullName, '\\') + 1;
+
+		DWORD64 crashedModuleOffset = ((DWORD64)exceptionAddress) - ((DWORD64)crashedModuleInfo.lpBaseOfDll);
+		CONTEXT* exceptionContext = exceptionInfo->ContextRecord;
+
+		spdlog::error("Northstar has crashed! a minidump has been written and exception info is available below:");
+		spdlog::error(exceptionCause.str());
+		spdlog::error("At: {} + {}", crashedModuleName, (void*)crashedModuleOffset);
+
+		PVOID framesToCapture[62];
+		int frames = RtlCaptureStackBackTrace(0, 62, framesToCapture, NULL);
+		for (int i = 0; i < frames; i++)
+		{
+			HMODULE backtraceModuleHandle;
+			GetModuleHandleExA(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS, static_cast<LPCSTR>(framesToCapture[i]), &backtraceModuleHandle);
+
+			char backtraceModuleFullName[MAX_PATH];
+			GetModuleFileNameExA(GetCurrentProcess(), backtraceModuleHandle, backtraceModuleFullName, MAX_PATH);
+			char* backtraceModuleName = strrchr(backtraceModuleFullName, '\\') + 1;
+
+			void* actualAddress = (void*)framesToCapture[i];
+			void* relativeAddress = (void*)(uintptr_t(actualAddress) - uintptr_t(backtraceModuleHandle));
+
+			spdlog::error("    {} + {} ({})", backtraceModuleName, relativeAddress, actualAddress);
+		}
+
+		spdlog::error("RAX: 0x{0:x}", exceptionContext->Rax);
+		spdlog::error("RBX: 0x{0:x}", exceptionContext->Rbx);
+		spdlog::error("RCX: 0x{0:x}", exceptionContext->Rcx);
+		spdlog::error("RDX: 0x{0:x}", exceptionContext->Rdx);
+		spdlog::error("RSI: 0x{0:x}", exceptionContext->Rsi);
+		spdlog::error("RDI: 0x{0:x}", exceptionContext->Rdi);
+		spdlog::error("RBP: 0x{0:x}", exceptionContext->Rbp);
+		spdlog::error("RSP: 0x{0:x}", exceptionContext->Rsp);
+		spdlog::error("R8: 0x{0:x}", exceptionContext->R8);
+		spdlog::error("R9: 0x{0:x}", exceptionContext->R9);
+		spdlog::error("R10: 0x{0:x}", exceptionContext->R10);
+		spdlog::error("R11: 0x{0:x}", exceptionContext->R11);
+		spdlog::error("R12: 0x{0:x}", exceptionContext->R12);
+		spdlog::error("R13: 0x{0:x}", exceptionContext->R13);
+		spdlog::error("R14: 0x{0:x}", exceptionContext->R14);
+		spdlog::error("R15: 0x{0:x}", exceptionContext->R15);
+
+		time_t time = std::time(nullptr);
+		tm currentTime = *std::localtime(&time);
+		std::stringstream stream;
+		stream << std::put_time(&currentTime, (GetNorthstarPrefix() + "/logs/nsdump%Y-%m-%d %H-%M-%S.dmp").c_str());
+
+		auto hMinidumpFile = CreateFileA(stream.str().c_str(), GENERIC_WRITE, FILE_SHARE_READ, 0, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
+		if (hMinidumpFile)
+		{
+			MINIDUMP_EXCEPTION_INFORMATION dumpExceptionInfo;
+			dumpExceptionInfo.ThreadId = GetCurrentThreadId();
+			dumpExceptionInfo.ExceptionPointers = exceptionInfo;
+			dumpExceptionInfo.ClientPointers = false;
+
+			MiniDumpWriteDump(
+				GetCurrentProcess(),
+				GetCurrentProcessId(),
+				hMinidumpFile,
+				MINIDUMP_TYPE(MiniDumpWithIndirectlyReferencedMemory | MiniDumpScanMemory),
+				&dumpExceptionInfo,
+				nullptr,
+				nullptr);
+			CloseHandle(hMinidumpFile);
+		}
+		else
+			spdlog::error("Failed to write minidump file {}!", stream.str());
+
+		if (!IsDedicated())
+			MessageBoxA(
+				0, "Northstar has crashed! Crash info can be found in R2Northstar/logs", "Northstar has crashed!", MB_ICONERROR | MB_OK);
+	}
+
+	logged = true;
+	return EXCEPTION_EXECUTE_HANDLER;
+}
+
+HANDLE hExceptionFilter;
+
+BOOL WINAPI ConsoleHandlerRoutine(DWORD eventCode)
+{
+	switch (eventCode)
+	{
+	case CTRL_CLOSE_EVENT:
+		// User closed console, shut everything down
+		spdlog::info("Exiting due to console close...");
+		RemoveVectoredExceptionHandler(hExceptionFilter);
+		exit(EXIT_SUCCESS);
+		return FALSE;
+	}
+
+	return TRUE;
+}
+
+void InitialiseLogging()
+{
+	hExceptionFilter = AddVectoredExceptionHandler(TRUE, ExceptionFilter);
+
+	AllocConsole();
+	// these two lines are responsible for stuff to not show up in the console sometimes, from talking about it on discord
+	// apparently they were meant to make logging work when using -northstar, however from testing it seems that it doesnt
+	// work regardless of these two lines
+	// freopen("CONOUT$", "w", stdout);
+	// freopen("CONOUT$", "w", stderr);
+	spdlog::default_logger()->set_pattern("[%H:%M:%S] [%^%l%$] %v");
+
+	SetConsoleCtrlHandler(ConsoleHandlerRoutine, true);
+}
+
+ConVar* Cvar_spewlog_enable;
+
+enum SpewType_t
+{
+	SPEW_MESSAGE = 0,
+
+	SPEW_WARNING,
+	SPEW_ASSERT,
+	SPEW_ERROR,
+	SPEW_LOG,
+
+	SPEW_TYPE_COUNT
+};
+
+typedef void (*EngineSpewFuncType)();
+EngineSpewFuncType EngineSpewFunc;
+
+void EngineSpewFuncHook(void* engineServer, SpewType_t type, const char* format, va_list args)
+{
+	if (!Cvar_spewlog_enable->GetBool())
+		return;
+
+	const char* typeStr;
+	switch (type)
+	{
+	case SPEW_MESSAGE:
+	{
+		typeStr = "SPEW_MESSAGE";
+		break;
+	}
+
+	case SPEW_WARNING:
+	{
+		typeStr = "SPEW_WARNING";
+		break;
+	}
+
+	case SPEW_ASSERT:
+	{
+		typeStr = "SPEW_ASSERT";
+		break;
+	}
+
+	case SPEW_ERROR:
+	{
+		typeStr = "SPEW_ERROR";
+		break;
+	}
+
+	case SPEW_LOG:
+	{
+		typeStr = "SPEW_LOG";
+		break;
+	}
+
+	default:
+	{
+		typeStr = "SPEW_UNKNOWN";
+		break;
+	}
+	}
+
+	char formatted[2048] = {0};
+	bool shouldFormat = true;
+
+	// because titanfall 2 is quite possibly the worst thing to yet exist, it sometimes gives invalid specifiers which will crash
+	// ttf2sdk had a way to prevent them from crashing but it doesnt work in debug builds
+	// so we use this instead
+	for (int i = 0; format[i]; i++)
+	{
+		if (format[i] == '%')
+		{
+			switch (format[i + 1])
+			{
+			// this is fucking awful lol
+			case 'd':
+			case 'i':
+			case 'u':
+			case 'x':
+			case 'X':
+			case 'f':
+			case 'F':
+			case 'g':
+			case 'G':
+			case 'a':
+			case 'A':
+			case 'c':
+			case 's':
+			case 'p':
+			case 'n':
+			case '%':
+			case '-':
+			case '+':
+			case ' ':
+			case '#':
+			case '*':
+			case '0':
+			case '1':
+			case '2':
+			case '3':
+			case '4':
+			case '5':
+			case '6':
+			case '7':
+			case '8':
+			case '9':
+				break;
+
+			default:
+			{
+				shouldFormat = false;
+				break;
+			}
+			}
+		}
+	}
+
+	if (shouldFormat)
+		vsnprintf(formatted, sizeof(formatted), format, args);
+	else
+	{
+		spdlog::warn("Failed to format {} \"{}\"", typeStr, format);
+	}
+
+	auto endpos = strlen(formatted);
+	if (formatted[endpos - 1] == '\n')
+		formatted[endpos - 1] = '\0'; // cut off repeated newline
+
+	spdlog::info("[SERVER {}] {}", typeStr, formatted);
+}
+
+typedef void (*Status_ConMsg_Type)(const char* text, ...);
+Status_ConMsg_Type Status_ConMsg_Original;
+
+void Status_ConMsg_Hook(const char* text, ...)
+{
+	char formatted[2048];
+	va_list list;
+
+	va_start(list, text);
+	vsprintf_s(formatted, text, list);
+	va_end(list);
+
+	auto endpos = strlen(formatted);
+	if (formatted[endpos - 1] == '\n')
+		formatted[endpos - 1] = '\0'; // cut off repeated newline
+
+	spdlog::info(formatted);
+}
+
+typedef bool (*CClientState_ProcessPrint_Type)(__int64 thisptr, __int64 msg);
+CClientState_ProcessPrint_Type CClientState_ProcessPrint_Original;
+
+bool CClientState_ProcessPrint_Hook(__int64 thisptr, __int64 msg)
+{
+	char* text = *(char**)(msg + 0x20);
+
+	auto endpos = strlen(text);
+	if (text[endpos - 1] == '\n')
+		text[endpos - 1] = '\0'; // cut off repeated newline
+
+	spdlog::info(text);
+	return true;
+}
+
+void InitialiseEngineSpewFuncHooks(HMODULE baseAddress)
+{
+	HookEnabler hook;
+
+	ENABLER_CREATEHOOK(hook, (char*)baseAddress + 0x11CA80, EngineSpewFuncHook, reinterpret_cast<LPVOID*>(&EngineSpewFunc));
+
+	// Hook print function that status concmd uses to actually print data
+	ENABLER_CREATEHOOK(hook, (char*)baseAddress + 0x15ABD0, Status_ConMsg_Hook, reinterpret_cast<LPVOID*>(&Status_ConMsg_Original));
+
+	// Hook CClientState::ProcessPrint
+	ENABLER_CREATEHOOK(
+		hook,
+		(char*)baseAddress + 0x1A1530,
+		CClientState_ProcessPrint_Hook,
+		reinterpret_cast<LPVOID*>(&CClientState_ProcessPrint_Original));
+
+	Cvar_spewlog_enable = new ConVar("spewlog_enable", "1", FCVAR_NONE, "Enables/disables whether the engine spewfunc should be logged");
+}
+
+#include "bitbuf.h"
+
+ConVar* Cvar_cl_showtextmsg;
+
+typedef void (*TextMsg_Type)(__int64);
+TextMsg_Type TextMsg_Original;
+
+class ICenterPrint
+{
+  public:
+	virtual void ctor() = 0;
+	virtual void Clear(void) = 0;
+	virtual void ColorPrint(int r, int g, int b, int a, wchar_t* text) = 0;
+	virtual void ColorPrint(int r, int g, int b, int a, char* text) = 0;
+	virtual void Print(wchar_t* text) = 0;
+	virtual void Print(char* text) = 0;
+	virtual void SetTextColor(int r, int g, int b, int a) = 0;
+};
+
+ICenterPrint* internalCenterPrint = NULL;
+
+void TextMsgHook(BFRead* msg)
+{
+	int msg_dest = msg->ReadByte();
+
+	char text[256];
+	msg->ReadString(text, sizeof(text));
+
+	if (!Cvar_cl_showtextmsg->GetBool())
+		return;
+
+	switch (msg_dest)
+	{
+	case 4: // HUD_PRINTCENTER
+		internalCenterPrint->Print(text);
+		break;
+	default:
+		spdlog::warn("Unimplemented TextMsg type {}! printing to console", msg_dest);
+		[[fallthrough]];
+	case 2: // HUD_PRINTCONSOLE
+		auto endpos = strlen(text);
+		if (text[endpos - 1] == '\n')
+			text[endpos - 1] = '\0'; // cut off repeated newline
+		spdlog::info(text);
+		break;
+	}
+}
+
+void InitialiseClientPrintHooks(HMODULE baseAddress)
+{
+	HookEnabler hook;
+
+	internalCenterPrint = (ICenterPrint*)((char*)baseAddress + 0x216E940);
+
+	// "TextMsg" usermessage
+	ENABLER_CREATEHOOK(hook, (char*)baseAddress + 0x198710, TextMsgHook, reinterpret_cast<LPVOID*>(&TextMsg_Original));
+
+	Cvar_cl_showtextmsg = new ConVar("cl_showtextmsg", "1", FCVAR_NONE, "Enable/disable text messages printing on the screen.");
+}