2016-05-04 19:24:41 +02:00
|
|
|
/*****************************************************************************
|
2018-06-15 14:07:34 +02:00
|
|
|
* Copyright (c) 2014-2018 OpenRCT2 developers
|
2016-05-04 19:24:41 +02:00
|
|
|
*
|
2018-06-15 14:07:34 +02:00
|
|
|
* For a complete list of all authors, please refer to contributors.md
|
|
|
|
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
|
2016-05-04 19:24:41 +02:00
|
|
|
*
|
2018-06-15 14:07:34 +02:00
|
|
|
* OpenRCT2 is licensed under the GNU General Public License version 3.
|
2016-05-04 19:24:41 +02:00
|
|
|
*****************************************************************************/
|
|
|
|
|
2018-01-18 13:55:34 +01:00
|
|
|
#include "Crash.h"
|
2016-04-07 00:10:12 +02:00
|
|
|
|
|
|
|
#ifdef USE_BREAKPAD
|
2018-07-21 16:17:06 +02:00
|
|
|
# include <memory>
|
|
|
|
# include <stdio.h>
|
|
|
|
|
|
|
|
# if defined(_WIN32)
|
|
|
|
# include <ShlObj.h>
|
|
|
|
# include <breakpad/client/windows/handler/exception_handler.h>
|
|
|
|
# include <string>
|
|
|
|
# else
|
|
|
|
# error Breakpad support not implemented yet for this platform
|
|
|
|
# endif
|
|
|
|
|
|
|
|
# include "../Version.h"
|
|
|
|
# include "../core/Console.hpp"
|
|
|
|
# include "../localisation/Language.h"
|
|
|
|
# include "../rct2/S6Exporter.h"
|
|
|
|
# include "../scenario/Scenario.h"
|
|
|
|
# include "platform.h"
|
|
|
|
|
|
|
|
# define WSZ(x) L"" x
|
|
|
|
|
|
|
|
# ifdef OPENRCT2_COMMIT_SHA1_SHORT
|
2018-06-22 23:04:38 +02:00
|
|
|
const wchar_t* _wszCommitSha1Short = WSZ(OPENRCT2_COMMIT_SHA1_SHORT);
|
2018-07-21 16:17:06 +02:00
|
|
|
# else
|
2018-06-22 23:04:38 +02:00
|
|
|
const wchar_t* _wszCommitSha1Short = WSZ("");
|
2018-07-21 16:17:06 +02:00
|
|
|
# endif
|
2016-08-28 18:17:20 +02:00
|
|
|
|
2016-10-18 13:25:57 +02:00
|
|
|
// OPENRCT2_ARCHITECTURE is required to be defined in version.h
|
2018-06-22 23:04:38 +02:00
|
|
|
const wchar_t* _wszArchitecture = WSZ(OPENRCT2_ARCHITECTURE);
|
|
|
|
|
|
|
|
static bool OnCrash(
|
2018-07-21 13:51:54 +02:00
|
|
|
const wchar_t* dumpPath, const wchar_t* miniDumpId, void* context, EXCEPTION_POINTERS* exinfo,
|
|
|
|
MDRawAssertionInfo* assertion, bool succeeded)
|
2016-04-10 00:30:10 +02:00
|
|
|
{
|
|
|
|
if (!succeeded)
|
|
|
|
{
|
2018-07-21 11:50:45 +02:00
|
|
|
constexpr const char* DumpFailedMessage = "Failed to create the dump. Please file an issue with OpenRCT2 on GitHub and "
|
|
|
|
"provide latest save, and provide "
|
|
|
|
"information about what you did before the crash occurred.";
|
2016-04-10 00:30:10 +02:00
|
|
|
printf("%s\n", DumpFailedMessage);
|
2016-05-11 13:25:21 +02:00
|
|
|
if (!gOpenRCT2SilentBreakpad)
|
|
|
|
{
|
2017-08-15 10:07:44 +02:00
|
|
|
MessageBoxA(nullptr, DumpFailedMessage, OPENRCT2_NAME, MB_OK | MB_ICONERROR);
|
2016-05-11 13:25:21 +02:00
|
|
|
}
|
2016-04-10 00:30:10 +02:00
|
|
|
return succeeded;
|
|
|
|
}
|
|
|
|
|
2016-05-02 23:20:36 +02:00
|
|
|
// Get filenames
|
2016-04-10 00:30:10 +02:00
|
|
|
wchar_t dumpFilePath[MAX_PATH];
|
|
|
|
wchar_t saveFilePath[MAX_PATH];
|
2016-09-26 04:24:29 +02:00
|
|
|
swprintf_s(dumpFilePath, sizeof(dumpFilePath), L"%s%s.dmp", dumpPath, miniDumpId);
|
|
|
|
swprintf_s(saveFilePath, sizeof(saveFilePath), L"%s%s.sv6", dumpPath, miniDumpId);
|
2016-04-10 00:30:10 +02:00
|
|
|
|
2016-05-02 23:20:36 +02:00
|
|
|
// Try to rename the files
|
|
|
|
wchar_t dumpFilePathNew[MAX_PATH];
|
2018-06-22 23:04:38 +02:00
|
|
|
swprintf_s(
|
2018-07-21 13:51:54 +02:00
|
|
|
dumpFilePathNew, sizeof(dumpFilePathNew), L"%s%s(%s_%s).dmp", dumpPath, miniDumpId, _wszCommitSha1Short,
|
2018-06-22 23:04:38 +02:00
|
|
|
_wszArchitecture);
|
2016-05-02 23:20:36 +02:00
|
|
|
if (_wrename(dumpFilePath, dumpFilePathNew) == 0)
|
|
|
|
{
|
|
|
|
std::wcscpy(dumpFilePath, dumpFilePathNew);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Log information to output
|
2016-05-02 23:50:43 +02:00
|
|
|
wprintf(L"Dump Path: %s\n", dumpPath);
|
|
|
|
wprintf(L"Dump File Path: %s\n", dumpFilePath);
|
2016-04-10 00:30:10 +02:00
|
|
|
wprintf(L"Dump Id: %s\n", miniDumpId);
|
|
|
|
wprintf(L"Version: %s\n", WSZ(OPENRCT2_VERSION));
|
2016-08-28 18:17:20 +02:00
|
|
|
wprintf(L"Commit: %s\n", _wszCommitSha1Short);
|
2016-04-10 00:30:10 +02:00
|
|
|
|
|
|
|
bool savedGameDumped = false;
|
2018-06-22 23:04:38 +02:00
|
|
|
utf8* saveFilePathUTF8 = widechar_to_utf8(saveFilePath);
|
2017-02-08 23:17:01 +01:00
|
|
|
try
|
|
|
|
{
|
|
|
|
auto exporter = std::make_unique<S6Exporter>();
|
|
|
|
exporter->Export();
|
|
|
|
exporter->SaveGame(saveFilePathUTF8);
|
2016-04-10 00:30:10 +02:00
|
|
|
savedGameDumped = true;
|
|
|
|
}
|
2018-06-22 23:04:38 +02:00
|
|
|
catch (const std::exception&)
|
2017-02-08 23:17:01 +01:00
|
|
|
{
|
|
|
|
}
|
|
|
|
free(saveFilePathUTF8);
|
2016-04-10 00:30:10 +02:00
|
|
|
|
2016-05-11 13:25:21 +02:00
|
|
|
if (gOpenRCT2SilentBreakpad)
|
|
|
|
{
|
|
|
|
return succeeded;
|
|
|
|
}
|
2017-02-08 23:17:01 +01:00
|
|
|
|
2018-07-21 11:50:45 +02:00
|
|
|
constexpr const wchar_t* MessageFormat = L"A crash has occurred and a dump was created at\n%s.\n\nPlease file an issue "
|
|
|
|
L"with OpenRCT2 on GitHub, and provide "
|
|
|
|
L"the dump and saved game there.\n\nVersion: %s\nCommit: %s";
|
2016-04-10 00:30:10 +02:00
|
|
|
wchar_t message[MAX_PATH * 2];
|
2018-06-22 23:04:38 +02:00
|
|
|
swprintf_s(message, MessageFormat, dumpFilePath, WSZ(OPENRCT2_VERSION), _wszCommitSha1Short);
|
2016-04-10 00:30:10 +02:00
|
|
|
|
|
|
|
// Cannot use platform_show_messagebox here, it tries to set parent window already dead.
|
2017-08-15 10:07:44 +02:00
|
|
|
MessageBoxW(nullptr, message, WSZ(OPENRCT2_NAME), MB_OK | MB_ICONERROR);
|
|
|
|
HRESULT coInitializeResult = CoInitialize(nullptr);
|
2016-04-10 00:30:10 +02:00
|
|
|
if (SUCCEEDED(coInitializeResult))
|
|
|
|
{
|
2016-08-28 18:19:13 +02:00
|
|
|
LPITEMIDLIST pidl = ILCreateFromPathW(dumpPath);
|
|
|
|
LPITEMIDLIST files[2];
|
2018-06-20 17:28:51 +02:00
|
|
|
uint32_t numFiles = 0;
|
2016-04-10 00:30:10 +02:00
|
|
|
|
|
|
|
files[numFiles++] = ILCreateFromPathW(dumpFilePath);
|
|
|
|
if (savedGameDumped)
|
|
|
|
{
|
|
|
|
files[numFiles++] = ILCreateFromPathW(saveFilePath);
|
|
|
|
}
|
2018-06-22 23:04:38 +02:00
|
|
|
if (pidl != nullptr)
|
|
|
|
{
|
|
|
|
SHOpenFolderAndSelectItems(pidl, numFiles, (LPCITEMIDLIST*)files, 0);
|
2016-04-10 00:30:10 +02:00
|
|
|
ILFree(pidl);
|
2018-06-20 17:28:51 +02:00
|
|
|
for (uint32_t i = 0; i < numFiles; i++)
|
2016-04-10 00:30:10 +02:00
|
|
|
{
|
|
|
|
ILFree(files[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
CoUninitialize();
|
|
|
|
}
|
|
|
|
|
|
|
|
// Return whether the dump was successful
|
|
|
|
return succeeded;
|
2016-04-09 19:21:40 +02:00
|
|
|
}
|
|
|
|
|
2016-04-10 00:30:10 +02:00
|
|
|
static std::wstring GetDumpDirectory()
|
|
|
|
{
|
|
|
|
char userDirectory[MAX_PATH];
|
2017-08-15 10:07:44 +02:00
|
|
|
platform_get_user_directory(userDirectory, nullptr, sizeof(userDirectory));
|
2016-04-10 00:30:10 +02:00
|
|
|
|
2018-06-22 23:04:38 +02:00
|
|
|
wchar_t* userDirectoryW = utf8_to_widechar(userDirectory);
|
2016-04-10 00:30:10 +02:00
|
|
|
auto result = std::wstring(userDirectoryW);
|
|
|
|
free(userDirectoryW);
|
2016-04-07 00:10:12 +02:00
|
|
|
|
2016-04-10 00:30:10 +02:00
|
|
|
return result;
|
2016-04-07 00:10:12 +02:00
|
|
|
}
|
2016-04-10 00:30:10 +02:00
|
|
|
|
|
|
|
// Using non-null pipe name here lets breakpad try setting OOP crash handling
|
2018-06-22 23:04:38 +02:00
|
|
|
constexpr const wchar_t* PipeName = L"openrct2-bpad";
|
2016-04-10 00:30:10 +02:00
|
|
|
|
2016-10-06 23:32:10 +02:00
|
|
|
#endif // USE_BREAKPAD
|
|
|
|
|
2018-02-01 18:49:14 +01:00
|
|
|
CExceptionHandler crash_init()
|
2016-04-07 00:10:12 +02:00
|
|
|
{
|
|
|
|
#ifdef USE_BREAKPAD
|
2016-04-10 00:30:10 +02:00
|
|
|
// Path must exist and be RW!
|
|
|
|
auto exHandler = new google_breakpad::ExceptionHandler(
|
2018-06-22 23:04:38 +02:00
|
|
|
GetDumpDirectory(), 0, OnCrash, 0, google_breakpad::ExceptionHandler::HANDLER_ALL, MiniDumpWithDataSegs, PipeName, 0);
|
2016-04-10 00:30:10 +02:00
|
|
|
return reinterpret_cast<CExceptionHandler>(exHandler);
|
2018-06-22 23:04:38 +02:00
|
|
|
#else // USE_BREAKPAD
|
2016-04-10 00:30:10 +02:00
|
|
|
return nullptr;
|
2016-04-07 00:10:12 +02:00
|
|
|
#endif // USE_BREAKPAD
|
|
|
|
}
|