#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace hex::plugin::builtin { static ImGui::Texture s_bannerTexture, s_backdropTexture; static std::string s_tipOfTheDay; class PopupRestoreBackup : public Popup { private: std::fs::path m_logFilePath; std::function m_restoreCallback; std::function m_deleteCallback; bool m_reportError = true; public: PopupRestoreBackup(std::fs::path logFilePath, const std::function &restoreCallback, const std::function &deleteCallback) : Popup("hex.builtin.popup.safety_backup.title"), m_logFilePath(std::move(logFilePath)), m_restoreCallback(restoreCallback), m_deleteCallback(deleteCallback) { this->m_reportError = ContentRegistry::Settings::read("hex.builtin.setting.general", "hex.builtin.setting.general.upload_crash_logs", true); } void drawContent() override { ImGui::TextUnformatted("hex.builtin.popup.safety_backup.desc"_lang); if (!this->m_logFilePath.empty()) { ImGui::NewLine(); ImGui::TextUnformatted("hex.builtin.popup.safety_backup.log_file"_lang); ImGui::SameLine(0, 2_scaled); if (ImGui::Hyperlink(this->m_logFilePath.filename().string().c_str())) { fs::openFolderWithSelectionExternal(this->m_logFilePath); } ImGui::Checkbox("hex.builtin.popup.safety_backup.report_error"_lang, &this->m_reportError); ImGui::NewLine(); } auto width = ImGui::GetWindowWidth(); ImGui::SetCursorPosX(width / 9); if (ImGui::Button("hex.builtin.popup.safety_backup.restore"_lang, ImVec2(width / 3, 0))) { this->m_restoreCallback(); this->m_deleteCallback(); if (this->m_reportError) { wolv::io::File logFile(this->m_logFilePath, wolv::io::File::Mode::Read); if (logFile.isValid()) { // Read current log file data auto data = logFile.readString(); // Anonymize the log file { for (u32 pathType = 0; pathType < u32(fs::ImHexPath::END); pathType++) { for (auto &folder : fs::getDefaultPaths(static_cast(pathType))) { auto parent = wolv::util::toUTF8String(folder.parent_path()); data = wolv::util::replaceStrings(data, parent, "<*****>"); } } } TaskManager::createBackgroundTask("Upload Crash report", [path = this->m_logFilePath, data](auto&){ HttpRequest request("POST", ImHexApiURL + std::string("/crash_upload")); request.uploadFile(std::vector(data.begin(), data.end()), "file", path.filename()).wait(); }); } } ContentRegistry::Settings::write("hex.builtin.setting.general", "hex.builtin.setting.general.upload_crash_logs", this->m_reportError); this->close(); } ImGui::SameLine(); ImGui::SetCursorPosX(width / 9 * 5); if (ImGui::Button("hex.builtin.popup.safety_backup.delete"_lang, ImVec2(width / 3, 0))) { this->m_deleteCallback(); this->close(); } } }; class PopupTipOfTheDay : public Popup { public: PopupTipOfTheDay() : Popup("hex.builtin.popup.tip_of_the_day.title", true, false) { } void drawContent() override { ImGui::Header("hex.builtin.welcome.tip_of_the_day"_lang, true); ImGui::TextFormattedWrapped("{}", s_tipOfTheDay.c_str()); ImGui::NewLine(); static bool dontShowAgain = false; if (ImGui::Checkbox("hex.builtin.common.dont_show_again"_lang, &dontShowAgain)) { ContentRegistry::Settings::write("hex.builtin.setting.general", "hex.builtin.setting.general.show_tips", !dontShowAgain); } ImGui::SameLine((ImGui::GetMainViewport()->Size / 3 - ImGui::CalcTextSize("hex.builtin.common.close"_lang) - ImGui::GetStyle().FramePadding).x); if (ImGui::Button("hex.builtin.common.close"_lang)) Popup::close(); } }; static void loadDefaultLayout() { LayoutManager::loadString(std::string(romfs::get("layouts/default.hexlyt").string())); } static bool isAnyViewOpen() { const auto &views = ContentRegistry::Views::impl::getEntries(); return std::any_of(views.begin(), views.end(), [](const auto &entry) { return entry.second->getWindowOpenState(); }); } static void drawWelcomeScreenContent() { const auto availableSpace = ImGui::GetContentRegionAvail(); ImGui::Image(s_bannerTexture, s_bannerTexture.getSize() / (2 * (1.0F / ImHexApi::System::getGlobalScale()))); ImGui::Indent(); if (ImGui::BeginTable("Welcome Left", 1, ImGuiTableFlags_NoBordersInBody, ImVec2(availableSpace.x / 2, 0))) { ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 3); ImGui::TableNextColumn(); ImGui::PushTextWrapPos(ImGui::GetCursorPosX() + std::min(450_scaled, availableSpace.x / 2 - 50_scaled)); ImGui::TextFormattedWrapped("A Hex Editor for Reverse Engineers, Programmers and people who value their retinas when working at 3 AM."); ImGui::PopTextWrapPos(); ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 6); ImGui::TableNextColumn(); ImGui::UnderlinedText("hex.builtin.welcome.header.start"_lang); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + 5_scaled); { if (ImGui::IconHyperlink(ICON_VS_NEW_FILE, "hex.builtin.welcome.start.create_file"_lang)) { auto newProvider = hex::ImHexApi::Provider::createProvider("hex.builtin.provider.mem_file", true); if (newProvider != nullptr && !newProvider->open()) hex::ImHexApi::Provider::remove(newProvider); else EventManager::post(newProvider); } if (ImGui::IconHyperlink(ICON_VS_GO_TO_FILE, "hex.builtin.welcome.start.open_file"_lang)) EventManager::post("Open File"); if (ImGui::IconHyperlink(ICON_VS_NOTEBOOK, "hex.builtin.welcome.start.open_project"_lang)) EventManager::post("Open Project"); if (ImGui::IconHyperlink(ICON_VS_TELESCOPE, "hex.builtin.welcome.start.open_other"_lang)) ImGui::OpenPopup("hex.builtin.welcome.start.popup.open_other"_lang); } ImGui::SetNextWindowPos(ImGui::GetWindowPos() + ImGui::GetCursorPos()); if (ImGui::BeginPopup("hex.builtin.welcome.start.popup.open_other"_lang)) { for (const auto &unlocalizedProviderName : ContentRegistry::Provider::impl::getEntries()) { if (ImGui::Hyperlink(LangEntry(unlocalizedProviderName))) { ImHexApi::Provider::createProvider(unlocalizedProviderName); ImGui::CloseCurrentPopup(); } } ImGui::EndPopup(); } // Draw recent entries ImGui::Dummy({}); recent::draw(); if (ImHexApi::System::getInitArguments().contains("update-available")) { ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 5); ImGui::TableNextColumn(); ImGui::UnderlinedText("hex.builtin.welcome.header.update"_lang); { if (ImGui::DescriptionButton("hex.builtin.welcome.update.title"_lang, hex::format("hex.builtin.welcome.update.desc"_lang, ImHexApi::System::getInitArguments()["update-available"]).c_str(), ImVec2(ImGui::GetContentRegionAvail().x * 0.8F, 0))) ImHexApi::System::updateImHex(ImHexApi::System::UpdateType::Stable); } } ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 6); ImGui::TableNextColumn(); ImGui::UnderlinedText("hex.builtin.welcome.header.help"_lang); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + 5_scaled); ImGui::Dummy({0, 0}); { if (ImGui::IconHyperlink(ICON_VS_GITHUB, "hex.builtin.welcome.help.repo"_lang)) hex::openWebpage("hex.builtin.welcome.help.repo.link"_lang); if (ImGui::IconHyperlink(ICON_VS_ORGANIZATION, "hex.builtin.welcome.help.gethelp"_lang)) hex::openWebpage("hex.builtin.welcome.help.gethelp.link"_lang); if (ImGui::IconHyperlink(ICON_VS_COMMENT_DISCUSSION, "hex.builtin.welcome.help.discord"_lang)) hex::openWebpage("hex.builtin.welcome.help.discord.link"_lang); } ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 5); ImGui::TableNextColumn(); ImGui::UnderlinedText("hex.builtin.welcome.header.plugins"_lang); { const auto &plugins = PluginManager::getPlugins(); if (!plugins.empty()) { if (ImGui::BeginTable("plugins", 4, ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg | ImGuiTableFlags_ScrollY | ImGuiTableFlags_SizingFixedFit, ImVec2((ImGui::GetContentRegionAvail().x * 5) / 6, ImGui::GetTextLineHeightWithSpacing() * 5))) { ImGui::TableSetupScrollFreeze(0, 1); ImGui::TableSetupColumn("hex.builtin.welcome.plugins.plugin"_lang, ImGuiTableColumnFlags_WidthStretch, 0.2); ImGui::TableSetupColumn("hex.builtin.welcome.plugins.author"_lang, ImGuiTableColumnFlags_WidthStretch, 0.2); ImGui::TableSetupColumn("hex.builtin.welcome.plugins.desc"_lang, ImGuiTableColumnFlags_WidthStretch, 0.6); ImGui::TableSetupColumn("##loaded", ImGuiTableColumnFlags_WidthFixed, ImGui::GetTextLineHeight()); ImGui::TableHeadersRow(); ImGuiListClipper clipper; clipper.Begin(plugins.size()); while (clipper.Step()) { for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) { const auto &plugin = plugins[i]; ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::TextUnformatted(plugin.getPluginName().c_str()); ImGui::TableNextColumn(); ImGui::TextUnformatted(plugin.getPluginAuthor().c_str()); ImGui::TableNextColumn(); ImGui::TextUnformatted(plugin.getPluginDescription().c_str()); ImGui::TableNextColumn(); ImGui::TextUnformatted(plugin.isLoaded() ? ICON_VS_CHECK : ICON_VS_CLOSE); } } clipper.End(); ImGui::EndTable(); } } } ImGui::EndTable(); } ImGui::SameLine(); if (ImGui::BeginTable("Welcome Right", 1, ImGuiTableFlags_NoBordersInBody, ImVec2(availableSpace.x / 2, 0))) { ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 5); ImGui::TableNextColumn(); ImGui::UnderlinedText("hex.builtin.welcome.header.customize"_lang); { if (ImGui::DescriptionButton("hex.builtin.welcome.customize.settings.title"_lang, "hex.builtin.welcome.customize.settings.desc"_lang, ImVec2(ImGui::GetContentRegionAvail().x * 0.8F, 0))) EventManager::post("Settings"); } ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 5); ImGui::TableNextColumn(); ImGui::UnderlinedText("hex.builtin.welcome.header.learn"_lang); { if (ImGui::DescriptionButton("hex.builtin.welcome.learn.latest.title"_lang, "hex.builtin.welcome.learn.latest.desc"_lang, ImVec2(ImGui::GetContentRegionAvail().x * 0.8F, 0))) hex::openWebpage("hex.builtin.welcome.learn.latest.link"_lang); if (ImGui::DescriptionButton("hex.builtin.welcome.learn.imhex.title"_lang, "hex.builtin.welcome.learn.imhex.desc"_lang, ImVec2(ImGui::GetContentRegionAvail().x * 0.8F, 0))) { AchievementManager::unlockAchievement("hex.builtin.achievement.starting_out", "hex.builtin.achievement.starting_out.docs.name"); hex::openWebpage("hex.builtin.welcome.learn.imhex.link"_lang); } if (ImGui::DescriptionButton("hex.builtin.welcome.learn.pattern.title"_lang, "hex.builtin.welcome.learn.pattern.desc"_lang, ImVec2(ImGui::GetContentRegionAvail().x * 0.8F, 0))) hex::openWebpage("hex.builtin.welcome.learn.pattern.link"_lang); if (ImGui::DescriptionButton("hex.builtin.welcome.learn.plugins.title"_lang, "hex.builtin.welcome.learn.plugins.desc"_lang, ImVec2(ImGui::GetContentRegionAvail().x * 0.8F, 0))) hex::openWebpage("hex.builtin.welcome.learn.plugins.link"_lang); } auto extraWelcomeScreenEntries = ContentRegistry::Interface::impl::getWelcomeScreenEntries(); if (!extraWelcomeScreenEntries.empty()) { ImGui::TableNextRow(ImGuiTableRowFlags_None, ImGui::GetTextLineHeightWithSpacing() * 5); ImGui::TableNextColumn(); ImGui::UnderlinedText("hex.builtin.welcome.header.various"_lang); { for (const auto &callback : extraWelcomeScreenEntries) callback(); } } ImGui::EndTable(); } ImGui::SetCursorPos(ImVec2(ImGui::GetContentRegionAvail().x + ImGui::GetStyle().FramePadding.x, ImGui::GetStyle().FramePadding.y * 2 - 1)); if (ImGui::DimmedIconButton(ICON_VS_CLOSE, ImGui::GetCustomColorVec4(ImGuiCustomCol_ToolbarRed))) { auto provider = ImHexApi::Provider::createProvider("hex.builtin.provider.null"); if (provider != nullptr) if (provider->open()) EventManager::post(provider); } } static void drawWelcomeScreen() { if (ImGui::Begin("ImHexDockSpace")) { if (!ImHexApi::Provider::isValid()) { static std::array title; ImFormatString(title.data(), title.size(), "%s/DockSpace_%08X", ImGui::GetCurrentWindow()->Name, ImGui::GetID("ImHexMainDock")); if (ImGui::Begin(title.data(), nullptr, ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoBringToFrontOnFocus)) { ImGui::Dummy({}); ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(10_scaled, 10_scaled)); ImGui::SetNextWindowScroll(ImVec2(0.0F, -1.0F)); ImGui::SetNextWindowSize(ImGui::GetContentRegionAvail() + scaled({ 0, 10 })); ImGui::SetNextWindowPos(ImGui::GetCursorScreenPos() - scaled({ 0, ImGui::GetStyle().FramePadding.y })); if (ImGui::Begin("Welcome Screen", nullptr, ImGuiWindowFlags_AlwaysUseWindowPadding | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoDocking | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove)) { drawWelcomeScreenContent(); } ImGui::End(); ImGui::PopStyleVar(); } ImGui::End(); } } ImGui::End(); } /** * @brief Draw some default background if there are no views available in the current layout */ static void drawNoViewsBackground() { if (ImGui::Begin("ImHexDockSpace")) { static std::array title; ImFormatString(title.data(), title.size(), "%s/DockSpace_%08X", ImGui::GetCurrentWindow()->Name, ImGui::GetID("ImHexMainDock")); if (ImGui::Begin(title.data())) { ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(10_scaled, 10_scaled)); if (ImGui::Begin("NoViewsBackground", nullptr, ImGuiWindowFlags_AlwaysUseWindowPadding | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoScrollWithMouse)) { ImGui::Dummy({}); auto imageSize = scaled(ImVec2(350, 350)); auto imagePos = (ImGui::GetContentRegionAvail() - imageSize) / 2; ImGui::SetCursorPos(imagePos); ImGui::Image(s_backdropTexture, imageSize); auto loadDefaultText = "hex.builtin.layouts.none.restore_default"_lang; auto textSize = ImGui::CalcTextSize(loadDefaultText); auto textPos = ImVec2( (ImGui::GetContentRegionAvail().x - textSize.x) / 2, imagePos.y + imageSize.y ); ImGui::SetCursorPos(textPos); if (ImGui::DimmedButton(loadDefaultText)){ loadDefaultLayout(); } } ImGui::End(); ImGui::PopStyleVar(); } ImGui::End(); } ImGui::End(); } /** * @brief Registers the event handlers related to the welcome screen * should only be called once, at startup */ void createWelcomeScreen() { recent::registerEventHandlers(); recent::updateRecentEntries(); (void)EventManager::subscribe(drawWelcomeScreen); // Sets a background when they are no views (void)EventManager::subscribe([]{ if (ImHexApi::Provider::isValid() && !isAnyViewOpen()) drawNoViewsBackground(); }); (void)EventManager::subscribe([]() { { auto theme = ContentRegistry::Settings::read("hex.builtin.setting.interface", "hex.builtin.setting.interface.color", ThemeManager::NativeTheme).get(); if (theme != ThemeManager::NativeTheme) { static std::string lastTheme; if (theme != lastTheme) { EventManager::post(theme); lastTheme = theme; } } } { auto language = ContentRegistry::Settings::read("hex.builtin.setting.interface", "hex.builtin.setting.interface.language", "en-US").get(); if (language != LangEntry::getSelectedLanguage()) LangEntry::loadLanguage(language); } { auto targetFps = ContentRegistry::Settings::read("hex.builtin.setting.interface", "hex.builtin.setting.interface.fps", 14).get(); ImHexApi::System::setTargetFPS(static_cast(targetFps)); } }); (void)EventManager::subscribe([](const std::string &theme) { auto changeTexture = [&](const std::string &path) { return ImGui::Texture(romfs::get(path).span()); }; ThemeManager::changeTheme(theme); s_bannerTexture = changeTexture(hex::format("assets/{}/banner.png", ThemeManager::getImageTheme())); s_backdropTexture = changeTexture(hex::format("assets/{}/backdrop.png", ThemeManager::getImageTheme())); if (!s_bannerTexture.isValid()) { log::error("Failed to load banner texture!"); } }); EventManager::subscribe([](auto) { if (!isAnyViewOpen()) loadDefaultLayout(); }); EventManager::subscribe([] { // Documentation of the value above the setting definition auto allowServerContact = ContentRegistry::Settings::read("hex.builtin.setting.general", "hex.builtin.setting.general.server_contact", 2); if (allowServerContact == 2) { ContentRegistry::Settings::write("hex.builtin.setting.general", "hex.builtin.setting.general.server_contact", 0); // Open the telemetry popup but only on desktop versions #if !defined(OS_WEB) PopupTelemetryRequest::open(); #endif } }); // Clear project context if we go back to the welcome screen EventManager::subscribe([](hex::prv::Provider *oldProvider, hex::prv::Provider *newProvider) { hex::unused(oldProvider); if (newProvider == nullptr) { ProjectFile::clearPath(); EventManager::post(); } }); recent::drawFileMenuItem(); // Check for crash backup constexpr static auto CrashFileName = "crash.json"; constexpr static auto BackupFileName = "crash_backup.hexproj"; bool hasCrashed = false; for (const auto &path : fs::getDefaultPaths(fs::ImHexPath::Config)) { if (auto crashFilePath = std::fs::path(path) / CrashFileName; wolv::io::fs::exists(crashFilePath)) { hasCrashed = true; log::info("Found crash.json file at {}", wolv::util::toUTF8String(crashFilePath)); wolv::io::File crashFile(crashFilePath, wolv::io::File::Mode::Read); nlohmann::json crashFileData; try { crashFileData = nlohmann::json::parse(crashFile.readString()); } catch (nlohmann::json::exception &e) { log::error("Failed to parse crash.json file: {}", e.what()); crashFile.remove(); continue; } bool hasProject = !crashFileData.value("project", "").empty(); auto backupFilePath = path / BackupFileName; bool hasBackupFile = wolv::io::fs::exists(backupFilePath); PopupRestoreBackup::open( // Path of log file crashFileData.value("logFile", ""), // Restore callback [=] { if (hasBackupFile) { ProjectFile::load(backupFilePath); if (hasProject) { ProjectFile::setPath(crashFileData["project"].get()); } else { ProjectFile::setPath(""); } EventManager::post(); }else{ if (hasProject) { ProjectFile::setPath(crashFileData["project"].get()); } } }, // Delete callback (also executed after restore) [crashFilePath, backupFilePath] { wolv::io::fs::remove(crashFilePath); wolv::io::fs::remove(backupFilePath); } ); } } // Tip of the day auto tipsData = romfs::get("tips.json"); if (!hasCrashed && tipsData.valid()) { auto tipsCategories = nlohmann::json::parse(tipsData.string()); auto now = std::chrono::system_clock::now(); auto days_since_epoch = std::chrono::duration_cast(now.time_since_epoch()); std::mt19937 random(days_since_epoch.count()); auto chosenCategory = tipsCategories[random()%tipsCategories.size()].at("tips"); auto chosenTip = chosenCategory[random()%chosenCategory.size()]; s_tipOfTheDay = chosenTip.get(); bool showTipOfTheDay = ContentRegistry::Settings::read("hex.builtin.setting.general", "hex.builtin.setting.general.show_tips", true); if (showTipOfTheDay) PopupTipOfTheDay::open(); } if (hasCrashed) { AchievementManager::unlockAchievement("hex.builtin.achievement.starting_out", "hex.builtin.achievement.starting_out.crash.name"); } } }