2023-05-15 11:30:24 +02:00
|
|
|
#include <hex/api/content_registry.hpp>
|
2023-11-21 14:38:01 +01:00
|
|
|
#include <hex/api/localization_manager.hpp>
|
impr: Refactor and restructure Event Manager (#2082)
### Problem description
This PR addresses issue #2013 that described a cluttered Event Manager.
This is a DX issue and should not impact the users whatsoever.
### Implementation description
The changes revolve around three main points:
1. the Event Manager (`event_manager.hpp`) was split into four
categories: GUI, Interaction, Lifecycle, and Provider, and two types:
Events, and Requests. This results in the following files:
- `events_gui.hpp`
- `events_interaction.hpp`
- `events_lifecycle.hpp`
- `events_provider.hpp`
- `requests_gui.hpp`
- `requests_interaction.hpp`
- `requests_lifecycle.hpp`
- `requests_provider.hpp`
2. Every event and request now has its own piece of documentation, with
a `@brief`, accompanied by a longer comment if needed, and gets its
`@param`s described.
3. The old `event_manager.hpp` import was removed and replaced by the
correct imports wherever needed, as to reduce spread of those files only
to where they are truly useful.
### Additional things
The commits have been split into (chrono-)logical steps:
- `feat`: split the Event Manager, and replace the imports
- `refactor`, `chore`: make various small changes to match the required
structure
- `docs`: add documentation for events and requests
Hopefully, this will help to review the PR.
*Note: Beware of very long rebuild times in between the commits, use
them sparingly! The Actions will ensure this PR builds anyways*
Closes #2013
---------
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Co-authored-by: Nik <werwolv98@gmail.com>
2025-01-25 16:32:07 +01:00
|
|
|
#include <hex/api/events/events_provider.hpp>
|
|
|
|
#include <hex/api/events/events_lifecycle.hpp>
|
2023-12-11 11:42:33 +01:00
|
|
|
#include <hex/api/project_file_manager.hpp>
|
2023-05-15 11:30:24 +02:00
|
|
|
|
2023-12-11 11:42:33 +01:00
|
|
|
#include <hex/helpers/fmt.hpp>
|
2024-06-22 10:44:55 +02:00
|
|
|
#include <hex/helpers/default_paths.hpp>
|
2023-05-15 11:30:24 +02:00
|
|
|
#include <hex/helpers/logger.hpp>
|
2024-06-19 13:51:36 +02:00
|
|
|
#include <hex/providers/provider.hpp>
|
2023-05-15 11:30:24 +02:00
|
|
|
|
2024-06-22 10:44:55 +02:00
|
|
|
#include <wolv/utils/guards.hpp>
|
2024-06-19 13:51:36 +02:00
|
|
|
#include <wolv/utils/string.hpp>
|
2024-06-22 10:44:55 +02:00
|
|
|
#include <wolv/net/socket_server.hpp>
|
|
|
|
|
|
|
|
#include <fmt/chrono.h>
|
|
|
|
#include <nlohmann/json.hpp>
|
2023-05-15 11:30:24 +02:00
|
|
|
|
|
|
|
namespace hex::plugin::builtin {
|
|
|
|
|
2024-06-19 13:51:36 +02:00
|
|
|
static bool s_networkInterfaceServiceEnabled = false;
|
|
|
|
static int s_autoBackupTime = 0;
|
2023-05-15 11:30:24 +02:00
|
|
|
|
|
|
|
namespace {
|
|
|
|
|
|
|
|
void handleNetworkInterfaceService() {
|
2024-06-19 13:51:36 +02:00
|
|
|
if (!s_networkInterfaceServiceEnabled) {
|
2023-06-18 10:18:58 +02:00
|
|
|
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
2023-05-15 11:30:24 +02:00
|
|
|
return;
|
|
|
|
}
|
2023-06-18 10:18:58 +02:00
|
|
|
|
2023-05-16 11:01:59 +02:00
|
|
|
static wolv::net::SocketServer networkInterfaceServer(31337);
|
2023-11-04 22:20:22 +01:00
|
|
|
|
2023-11-04 23:41:52 +01:00
|
|
|
AT_FIRST_TIME {
|
2023-12-08 10:29:44 +01:00
|
|
|
EventImHexClosing::subscribe([]{
|
2023-11-04 23:41:52 +01:00
|
|
|
networkInterfaceServer.shutdown();
|
|
|
|
});
|
|
|
|
};
|
2023-11-04 22:20:22 +01:00
|
|
|
|
2023-05-15 11:30:24 +02:00
|
|
|
networkInterfaceServer.accept([](auto, const std::vector<u8> &data) -> std::vector<u8> {
|
|
|
|
nlohmann::json result;
|
|
|
|
|
|
|
|
try {
|
|
|
|
auto json = nlohmann::json::parse(data.begin(), data.end());
|
|
|
|
|
|
|
|
const auto &endpoints = ContentRegistry::CommunicationInterface::impl::getNetworkEndpoints();
|
2023-05-16 11:33:00 +02:00
|
|
|
if (auto callback = endpoints.find(json.at("endpoint").get<std::string>()); callback != endpoints.end()) {
|
|
|
|
log::info("Network endpoint {} called with arguments '{}'", json.at("endpoint").get<std::string>(), json.contains("data") ? json.at("data").dump() : "");
|
2023-05-16 11:20:46 +02:00
|
|
|
|
2023-05-16 11:33:00 +02:00
|
|
|
auto responseData = callback->second(json.contains("data") ? json.at("data") : nlohmann::json::object());
|
2023-05-15 11:30:24 +02:00
|
|
|
|
|
|
|
result["status"] = "success";
|
|
|
|
result["data"] = responseData;
|
2023-05-16 11:20:46 +02:00
|
|
|
} else {
|
|
|
|
throw std::runtime_error("Endpoint not found");
|
2023-05-15 11:30:24 +02:00
|
|
|
}
|
|
|
|
} catch (const std::exception &e) {
|
2023-05-16 11:20:46 +02:00
|
|
|
log::warn("Network interface service error: {}", e.what());
|
2023-05-15 11:30:24 +02:00
|
|
|
|
|
|
|
result["status"] = "error";
|
|
|
|
result["data"]["error"] = e.what();
|
|
|
|
}
|
|
|
|
|
|
|
|
auto resultString = result.dump();
|
|
|
|
return { resultString.begin(), resultString.end() };
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2024-06-19 13:51:36 +02:00
|
|
|
bool s_dataDirty = false;
|
2023-12-11 11:42:33 +01:00
|
|
|
void handleAutoBackup() {
|
|
|
|
auto now = std::chrono::steady_clock::now();
|
|
|
|
static std::chrono::time_point<std::chrono::steady_clock> lastBackupTime = now;
|
|
|
|
|
2024-06-19 13:51:36 +02:00
|
|
|
if (s_autoBackupTime > 0 && (now - lastBackupTime) > std::chrono::seconds(s_autoBackupTime)) {
|
2023-12-11 11:42:33 +01:00
|
|
|
lastBackupTime = now;
|
|
|
|
|
2024-06-19 13:51:36 +02:00
|
|
|
if (ImHexApi::Provider::isValid() && s_dataDirty) {
|
|
|
|
s_dataDirty = false;
|
|
|
|
|
|
|
|
std::vector<prv::Provider *> dirtyProviders;
|
|
|
|
for (const auto &provider : ImHexApi::Provider::getProviders()) {
|
|
|
|
if (provider->isDirty()) {
|
|
|
|
dirtyProviders.push_back(provider);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-06-22 10:44:55 +02:00
|
|
|
for (const auto &path : paths::Backups.write()) {
|
2024-06-19 13:51:36 +02:00
|
|
|
const auto backupPath = path / hex::format("auto_backup.{:%y%m%d_%H%M%S}.hexproj", fmt::gmtime(std::chrono::system_clock::now()));
|
|
|
|
if (ProjectFile::store(backupPath, false)) {
|
|
|
|
log::info("Created auto-backup file '{}'", wolv::util::toUTF8String(backupPath));
|
2023-12-11 11:42:33 +01:00
|
|
|
break;
|
2024-06-19 13:51:36 +02:00
|
|
|
}
|
2023-12-11 11:42:33 +01:00
|
|
|
}
|
|
|
|
|
2024-06-19 13:51:36 +02:00
|
|
|
for (const auto &provider : dirtyProviders) {
|
|
|
|
provider->markDirty();
|
|
|
|
}
|
2023-12-11 11:42:33 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
|
|
|
}
|
|
|
|
|
2023-05-15 11:30:24 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void registerBackgroundServices() {
|
2024-02-18 11:29:18 +01:00
|
|
|
ContentRegistry::Settings::onChange("hex.builtin.setting.general", "hex.builtin.setting.general.network_interface", [](const ContentRegistry::Settings::SettingsValue &value) {
|
2024-06-19 13:51:36 +02:00
|
|
|
s_networkInterfaceServiceEnabled = value.get<bool>(false);
|
2024-02-18 11:29:18 +01:00
|
|
|
});
|
|
|
|
|
|
|
|
ContentRegistry::Settings::onChange("hex.builtin.setting.general", "hex.builtin.setting.general.auto_backup_time", [](const ContentRegistry::Settings::SettingsValue &value) {
|
2024-06-19 13:51:36 +02:00
|
|
|
s_autoBackupTime = value.get<int>(0) * 30;
|
2023-05-15 11:30:24 +02:00
|
|
|
});
|
|
|
|
|
2024-08-03 11:32:17 +02:00
|
|
|
ContentRegistry::BackgroundServices::registerService("hex.builtin.background_service.network_interface", handleNetworkInterfaceService);
|
|
|
|
ContentRegistry::BackgroundServices::registerService("hex.builtin.background_service.auto_backup", handleAutoBackup);
|
2024-06-19 13:51:36 +02:00
|
|
|
|
|
|
|
EventProviderDirtied::subscribe([](prv::Provider *) {
|
|
|
|
s_dataDirty = true;
|
|
|
|
});
|
2023-05-15 11:30:24 +02:00
|
|
|
}
|
|
|
|
|
2024-06-19 13:51:36 +02:00
|
|
|
}
|