Skip to content

Update ErrorReport.cpp #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dracy21 wants to merge 1 commit into
base: main
Choose a base branch
from
+72 −35
Open

Update ErrorReport.cpp #189

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 72 additions & 35 deletions Source Main 5.2/source/Utilities/Log/ErrorReport.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// ErrorReport.cpp: implementation of the CErrorReport class.
//
// By Dr@Cy ...
//////////////////////////////////////////////////////////////////////

#include "stdafx.h"
Expand All @@ -12,9 +12,23 @@

void DeleteSocket();

void CErrorReport::WriteLabelValue(const wchar_t* label, const wchar_t* value) {
const int labelWidth = 25;
wchar_t buffer[256];
swprintf(buffer, L"%-*s: %s\r\n", labelWidth, label, value);
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider using swprintf_s for improved memory safety. This prevents potential buffer overflows by ensuring null-termination, even if truncation occurs.

Suggested change
swprintf(buffer, L"%-*s: %s\r\n", labelWidth, label, value);
swprintf_s(buffer, _countof(buffer), L"%-*s: %s\r\n", labelWidth, label, value);

WriteDebugInfoStr(buffer);
}

CErrorReport::CErrorReport()
{
Clear();

// Check and delete the existing file.
const wchar_t* logFile = L"MuError.log";
if (GetFileAttributes(logFile) != INVALID_FILE_ATTRIBUTES) {
DeleteFile(logFile);
}

Create(L"MuError.log");
}

Expand All @@ -33,18 +47,30 @@ void CErrorReport::Clear(void)
void CErrorReport::Create(wchar_t* lpszFileName)
{
wcscpy(m_lpszFileName, lpszFileName);
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Use wcscpy_s instead of wcscpy to avoid potential buffer overflows. wcscpy_s ensures the destination buffer is large enough to hold the source string.

Suggested change
wcscpy(m_lpszFileName, lpszFileName);
wcscpy_s(m_lpszFileName, _countof(m_lpszFileName), lpszFileName);


//DeleteFile( m_lpszFileName);
m_iKey = 0;
m_hFile = CreateFile(m_lpszFileName, GENERIC_READ | GENERIC_WRITE, FILE_SHARE_READ, NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);

CutHead();
SetFilePointer(m_hFile, 0, NULL, FILE_END);
m_hFile = ::CreateFile(m_lpszFileName, // Using :: to explicitly call Windows API
GENERIC_READ | GENERIC_WRITE, // Read/write access
FILE_SHARE_READ, // Allow others to read
NULL,
CREATE_ALWAYS, // Overwrite if exists
FILE_ATTRIBUTE_NORMAL, // Normal file attributes
NULL);

if (m_hFile != INVALID_HANDLE_VALUE) {
// Adaugă BOM UTF-16
const wchar_t BOM = 0xFEFF;
DWORD written;
::WriteFile(m_hFile, &BOM, sizeof(BOM), &written, NULL); // :: for Windows API
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Check the return value of ::WriteFile to ensure the BOM was written successfully. Handle potential write failures to maintain log file integrity.

Suggested change
::WriteFile(m_hFile, &BOM, sizeof(BOM), &written, NULL); // :: for Windows API
if (!::WriteFile(m_hFile, &BOM, sizeof(BOM), &written, NULL) || written != sizeof(BOM)) {
// Handle error, e.g., log a warning or close the file
} else {
::SetFilePointer(m_hFile, 0, NULL, FILE_END);
}

::SetFilePointer(m_hFile, 0, NULL, FILE_END);
}
}

void CErrorReport::Destroy(void)
{
CloseHandle(m_hFile);
if (m_hFile != INVALID_HANDLE_VALUE) {
CloseHandle(m_hFile);
}
Clear();
}

Expand All @@ -53,7 +79,6 @@ void CErrorReport::CutHead(void)
DWORD dwNumber;
wchar_t lpszBuffer[128 * 1024];
ReadFile(m_hFile, lpszBuffer, 128 * 1024 - 1, &dwNumber, NULL);
//m_iKey = Xor_ConvertBuffer( lpszBuffer, dwNumber);
lpszBuffer[dwNumber] = '\0';
wchar_t* lpCut = CheckHeadToCut(lpszBuffer, dwNumber);
if (dwNumber >= 32 * 1024 - 1)
Expand Down Expand Up @@ -105,7 +130,6 @@ wchar_t* CErrorReport::CheckHeadToCut(wchar_t* lpszBuffer, DWORD dwNumber)

BOOL CErrorReport::WriteFile(HANDLE hFile, void* lpBuffer, DWORD nNumberOfBytesToWrite, LPDWORD lpNumberOfBytesWritten, LPOVERLAPPED lpOverlapped)
{
//m_iKey = Xor_ConvertBuffer( lpBuffer, nNumberOfBytesToWrite, m_iKey);
return (::WriteFile(hFile, lpBuffer, nNumberOfBytesToWrite, lpNumberOfBytesWritten, lpOverlapped));
}

Expand All @@ -114,7 +138,7 @@ void CErrorReport::WriteDebugInfoStr(wchar_t* lpszToWrite)
if (m_hFile != INVALID_HANDLE_VALUE)
{
DWORD dwNumber;
WriteFile(m_hFile, lpszToWrite, wcslen(lpszToWrite), &dwNumber, NULL);
WriteFile(m_hFile, lpszToWrite, wcslen(lpszToWrite) * sizeof(wchar_t), &dwNumber, NULL);

if (dwNumber == 0)
{
Expand All @@ -126,10 +150,10 @@ void CErrorReport::WriteDebugInfoStr(wchar_t* lpszToWrite)

void CErrorReport::Write(const wchar_t* lpszFormat, ...)
{
wchar_t lpszBuffer[1024] = { 0, };
wchar_t lpszBuffer[2048] = { 0 };
va_list va;
va_start(va, lpszFormat);
vswprintf(lpszBuffer, 1024, lpszFormat, va);
vswprintf(lpszBuffer, _countof(lpszBuffer), lpszFormat, va);
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider using vswprintf_s for enhanced buffer overflow protection. It provides stronger guarantees against buffer overflows and ensures null-termination.

Suggested change
vswprintf(lpszBuffer, _countof(lpszBuffer), lpszFormat, va);
vswprintf_s(lpszBuffer, _countof(lpszBuffer), lpszFormat, va);

va_end(va);

WriteDebugInfoStr(lpszBuffer);
Expand All @@ -138,71 +162,84 @@ void CErrorReport::Write(const wchar_t* lpszFormat, ...)
void CErrorReport::HexWrite(void* pBuffer, int iSize)
{
DWORD dwWritten = 0;
wchar_t szLine[256] = { 0, };
wchar_t szLine[256] = { 0 };
int offset = 0;
offset += swprintf(szLine, L"0x%00000008X : ", (DWORD*)pBuffer);
offset += swprintf(szLine, L"0x%08X : ", (DWORD*)pBuffer);
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Use swprintf_s instead of swprintf for improved buffer safety. Check the return value to correctly update offset.

Suggested change
offset += swprintf(szLine, L"0x%08X : ", (DWORD*)pBuffer);
int chars_written = swprintf_s(szLine, _countof(szLine), L"0x%08X : ", (DWORD*)pBuffer);
if (chars_written > 0) offset = chars_written; else { /* Handle error */ return; }

for (int i = 0; i < iSize; i++) {
offset += swprintf(szLine + offset, L"%02X", *((BYTE*)pBuffer + i));
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Replace swprintf with swprintf_s for buffer safety. Pass the remaining buffer size to swprintf_s.

Suggested change
offset += swprintf(szLine + offset, L"%02X", *((BYTE*)pBuffer + i));
int chars_written_loop = swprintf_s(szLine + offset, _countof(szLine) - offset, L"%02X", *((BYTE*)pBuffer + i));
if (chars_written_loop > 0) offset += chars_written_loop; else { /* Handle error */ break; }

if (i > 0 && i < iSize - 1) {
if (i % 16 == 15) { //. new line
if (i % 16 == 15) {
offset += swprintf(szLine + offset, L"\r\n");
WriteFile(m_hFile, szLine, wcslen(szLine), &dwWritten, NULL);
WriteFile(m_hFile, szLine, wcslen(szLine) * sizeof(wchar_t), &dwWritten, NULL);
offset = 0;
offset += swprintf(szLine + offset, L" : ");
}
else if (i % 4 == 3) { //. space
else if (i % 4 == 3) {
offset += swprintf(szLine + offset, L" ");
}
}
}
offset += swprintf(szLine + offset, L"\r\n");
WriteFile(m_hFile, szLine, wcslen(szLine), &dwWritten, NULL);
WriteFile(m_hFile, szLine, wcslen(szLine) * sizeof(wchar_t), &dwWritten, NULL);
}

void CErrorReport::AddSeparator(void)
{
Write(L"-------------------------------------------------------------------------------------\r\n");
Write(L"------------------------------------------------------------\r\n");
}

void CErrorReport::WriteLogBegin(void)
{
Write(L"###### Log Begin ######\r\n");
SYSTEMTIME st;
GetLocalTime(&st);
Write(L"\n###### Log Begin ######\r\n");
Write(L"Date: %04d/%02d/%02d\r\n", st.wYear, st.wMonth, st.wDay);
Write(L"Time: %02d:%02d:%02d\r\n", st.wHour, st.wMinute, st.wSecond);
AddSeparator();
}

void CErrorReport::WriteCurrentTime(BOOL bLineShift)
{
SYSTEMTIME st;
GetLocalTime(&st);
g_ErrorReport.Write(L"%4d/%02d/%02d %02d:%02d", st.wYear, st.wMonth, st.wDay, st.wHour, st.wMinute);
Write(L"%04d/%02d/%02d %02d:%02d", st.wYear, st.wMonth, st.wDay, st.wHour, st.wMinute);
if (bLineShift)
{
g_ErrorReport.Write(L"\r\n");
Write(L"\r\n");
}
}

void CErrorReport::WriteSystemInfo(ER_SystemInfo* si)
{
Write(L"<System information>\r\n");
Write(L"OS \t\t\t: %s\r\n", si->m_lpszOS);
Write(L"CPU \t\t\t: %s\r\n", si->m_lpszCPU);
Write(L"RAM \t\t\t: %dMB\r\n", 1 + (si->m_iMemorySize / 1024 / 1024));
Write(L"\n===== SYSTEM INFORMATION =====\r\n");
WriteLabelValue(L"OS", si->m_lpszOS);
WriteLabelValue(L"CPU", si->m_lpszCPU);

wchar_t ram[32];
swprintf(ram, L"%dMB", 1 + (si->m_iMemorySize / 1024 / 1024));
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Use swprintf_s instead of swprintf for improved memory safety with the ram buffer.

Suggested change
swprintf(ram, L"%dMB", 1 + (si->m_iMemorySize / 1024 / 1024));
swprintf_s(ram, _countof(ram), L"%dMB", 1 + (si->m_iMemorySize / 1024 / 1024));

WriteLabelValue(L"RAM", ram);

AddSeparator();
Write(L"Direct-X \t\t: %s\r\n", si->m_lpszDxVersion);
WriteLabelValue(L"Direct-X", si->m_lpszDxVersion);
}

void CErrorReport::WriteOpenGLInfo(void)
{
Write(L"<OpenGL information>\r\n");
Write(L"Vendor\t\t: %s\r\n", (wchar_t*)glGetString(GL_VENDOR));
Write(L"Render\t\t: %s\r\n", (wchar_t*)glGetString(GL_RENDERER));
Write(L"OpenGL version\t: %s\r\n", (wchar_t*)glGetString(GL_VERSION));
Write(L"\n===== OPENGL INFORMATION =====\r\n");
WriteLabelValue(L"Vendor", (wchar_t*)glGetString(GL_VENDOR));
WriteLabelValue(L"Render", (wchar_t*)glGetString(GL_RENDERER));
WriteLabelValue(L"OpenGL version", (wchar_t*)glGetString(GL_VERSION));
Comment on lines +229 to +231
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

glGetString returns const GLubyte*. Casting directly to wchar_t* is incorrect. Convert from the original encoding (likely ASCII or UTF-8) to wchar_t using MultiByteToWideChar.


GLint iResult[2];
glGetIntegerv(GL_MAX_TEXTURE_SIZE, iResult);
Write(L"Max Texture size\t: %d x %d\r\n", iResult[0], iResult[0]);
wchar_t texSize[32];
swprintf(texSize, L"%d x %d", iResult[0], iResult[0]);
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Use swprintf_s instead of swprintf for improved memory safety with the texSize buffer. Apply the same change on line 240.

Suggested change
swprintf(texSize, L"%d x %d", iResult[0], iResult[0]);
swprintf_s(texSize, _countof(texSize), L"%d x %d", iResult[0], iResult[0]);

WriteLabelValue(L"Max Texture size", texSize);

glGetIntegerv(GL_MAX_VIEWPORT_DIMS, iResult);
Write(L"Max Viewport size\t: %d x %d\r\n", iResult[0], iResult[1]);
swprintf(texSize, L"%d x %d", iResult[0], iResult[1]);
WriteLabelValue(L"Max Viewport size", texSize);
}

void CErrorReport::WriteImeInfo(HWND hWnd)
{
wchar_t lpszTemp[256];
Expand Down Expand Up @@ -921,4 +958,4 @@ void GetSystemInfo(ER_SystemInfo* si)
// DX
DWORD dwDX = GetDXVersion();
swprintf(si->m_lpszDxVersion, L"Direct-X %d.%d", dwDX >> 8, dwDX & 0xFF);
}
}