Skip to content

[windows][installer] add additional logging during MSI preparation for execution #6402

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

Merged
AenBleidd merged 1 commit into from
Jun 25, 2025
Merged

[windows][installer] add additional logging during MSI preparation for execution #6402

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
70 changes: 70 additions & 0 deletions installer/installer_setup/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,60 @@
#include <iomanip>
#include <sstream>
#include <codecvt>
#include <fstream>
#include <chrono>
#include <ctime>

#include <openssl/evp.h>
#include <openssl/md5.h>

#include "installer_setup.h"
#include "version.h"

class Logger {
public:
static Logger& Instance() {
static Logger instance;
return instance;
}

void Log(const std::string& message) {
if (!ofs.is_open()) {
return;
}
const auto now = std::chrono::system_clock::now();
const auto now_c = std::chrono::system_clock::to_time_t(now);
ofs << std::ctime(&now_c) << message << std::endl;
}

private:
Logger() {
char tempPath[MAX_PATH];
std::filesystem::path logPath;
const auto len = GetTempPath(MAX_PATH, tempPath);
if (len != 0 && len <= MAX_PATH) {
logPath = tempPath;
} else {
logPath = std::filesystem::current_path();
}
logPath /= "boinc_installer.log";
Comment on lines +62 to +63
Copy link

Copilot AI Jun 25, 2025

Choose a reason for hiding this comment

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

If GetTempPath fails, logPath remains empty and the log will open in the working directory. Add handling for a failed GetTempPath (e.g., fallback or an early exit) to avoid writing logs to an unintended location.

Suggested change
}
logPath /= "boinc_installer.log";
} else {
// Fallback to a path relative to the executable
logPath = std::filesystem::current_path();
logPath /= "boinc_installer.log";
}

Copilot uses AI. Check for mistakes.
ofs.open(logPath, std::ios::app);
}
~Logger() {
if (ofs.is_open()) {
ofs.close();
}
}
Logger(const Logger&) = delete;
Logger& operator=(const Logger&) = delete;

std::ofstream ofs;
};

void Log(const std::string& message) {
Logger::Instance().Log(message);
}
Comment on lines +76 to +79
Copy link

Copilot AI Jun 25, 2025

Choose a reason for hiding this comment

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

[nitpick] The free function Log may collide with other symbols or macros. Consider placing it in a namespace (e.g., installer::Log) or renaming it to avoid global scope pollution.

Suggested change
void Log(const std::string& message) {
Logger::Instance().Log(message);
}
namespace installer {
void Log(const std::string& message) {
Logger::Instance().Log(message);
}
}

Copilot uses AI. Check for mistakes.

HBITMAP hBitmap = NULL;

void LoadSplashImage(HDC hdc, HWND hwnd) {
Expand Down Expand Up @@ -69,25 +116,31 @@ LRESULT CALLBACK WndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam) {
}

std::string computeMD5(const void* buffer, size_t size) {
Log("Computing MD5 hash...");

unsigned char md5Digest[MD5_DIGEST_LENGTH];
auto* mdContext = EVP_MD_CTX_new();

if (mdContext == nullptr) {
Log("Failed to create MD5 context.");
return {};
}

if (EVP_DigestInit_ex(mdContext, EVP_md5(), nullptr) != 1) {
EVP_MD_CTX_free(mdContext);
Log("Failed to initialize MD5 context.");
return {};
}

if (EVP_DigestUpdate(mdContext, buffer, size) != 1) {
EVP_MD_CTX_free(mdContext);
Log("Failed to update MD5 context.");
return {};
}

if (EVP_DigestFinal_ex(mdContext, md5Digest, nullptr) != 1) {
EVP_MD_CTX_free(mdContext);
Log("Failed to finalize MD5 digest.");
return {};
}

Expand All @@ -99,38 +152,45 @@ std::string computeMD5(const void* buffer, size_t size) {
static_cast<int>(md5Digest[i]);
}

Log("MD5 hash computed successfully: " + oss.str());
return oss.str();
}


bool ExtractResourceAndExecute(UINT ResourceID, std::string OutputFileName,
std::string CmdParameters)
{
Log("Extracting resource and executing installer...");
try {
auto hResource = FindResource(nullptr, MAKEINTRESOURCE(ResourceID),
"BINARY");
if (hResource == nullptr) {
Log("Failed to find resource.");
return false;
}

auto hFileResource = LoadResource(nullptr, hResource);
if (hFileResource == nullptr) {
Log("Failed to load resource.");
return false;
}

auto lpFile = LockResource(hFileResource);
if (lpFile == nullptr) {
Log("Failed to lock resource.");
return false;
}

const auto dwSize = SizeofResource(nullptr, hResource);
if (dwSize == 0) {
Log("Resource size is zero.");
return false;
}

char buffer[MAX_PATH];
const auto result = GetWindowsDirectory(buffer, MAX_PATH);
if (result == 0 || result > MAX_PATH) {
Log("Failed to get Windows directory.");
MessageBox(NULL, "Failed to get the Windows directory!", "Error",
MB_ICONERROR);
return false;
Expand All @@ -140,7 +200,10 @@ bool ExtractResourceAndExecute(UINT ResourceID, std::string OutputFileName,
const auto outputDir = windowsDir / "Downloaded Installations" /
"BOINC" / BOINC_VERSION_STRING / computeMD5(lpFile, dwSize);
if (!std::filesystem::exists(outputDir)) {
Log("Creating output directory: " + outputDir.string());
if (!std::filesystem::create_directories(outputDir)) {
Log("Failed to create output directory: " +
outputDir.string());
MessageBox(NULL, "Failed to create output directory!", "Error",
MB_ICONERROR);
return false;
Expand All @@ -153,11 +216,13 @@ bool ExtractResourceAndExecute(UINT ResourceID, std::string OutputFileName,
auto hFilemap = CreateFileMapping(hFile, nullptr, PAGE_READWRITE, 0,
dwSize, nullptr);
if (hFilemap == nullptr) {
Log("Failed to create file mapping.");
return false;
}

auto lpBaseAddress = MapViewOfFile(hFilemap, FILE_MAP_WRITE, 0, 0, 0);
if (lpBaseAddress == nullptr) {
Log("Failed to map view of file.");
return false;
}
CopyMemory(lpBaseAddress, lpFile, dwSize);
Expand All @@ -170,14 +235,19 @@ bool ExtractResourceAndExecute(UINT ResourceID, std::string OutputFileName,
CmdParameters.c_str(), nullptr,
CmdParameters == "" ? SW_SHOWNORMAL : SW_HIDE);
if (reinterpret_cast<int>(hInstance) <= 32) {
Log("Failed to execute installer");
MessageBox(NULL, "Failed to execute the installer!", "Error",
MB_ICONERROR);
return false;
}

Log("Installer executed successfully: " +
(outputDir / OutputFileName).string());
return true;
}
catch (const std::exception& ex) {
Log("Exception occurred while extracting resource: " +
std::string(ex.what()));
MessageBox(NULL, "Failed to extract resource!", ex.what(),
MB_ICONERROR);
return false;
Expand Down