ImHex/plugins/builtin/source/content/providers.cpp

#include <hex/api/content_registry.hpp>

#include "content/providers/gdb_provider.hpp"
#include "content/providers/file_provider.hpp"
#include "content/providers/null_provider.hpp"
#include "content/providers/disk_provider.hpp"
#include "content/providers/intel_hex_provider.hpp"
#include "content/providers/motorola_srec_provider.hpp"
#include "content/providers/memory_file_provider.hpp"
#include "content/providers/view_provider.hpp"
#include "content/popups/popup_notification.hpp"
#include "content/helpers/notification.hpp"

#include <hex/api/project_file_manager.hpp>
#include <hex/api/task_manager.hpp>
#include <hex/helpers/fmt.hpp>

#include <nlohmann/json.hpp>

#include <wolv/utils/guards.hpp>

namespace hex::plugin::builtin {

    void registerProviders() {

        ContentRegistry::Provider::add<FileProvider>(false);
        ContentRegistry::Provider::add<NullProvider>(false);
        #if !defined(OS_WEB)
            ContentRegistry::Provider::add<DiskProvider>();
        #endif
        ContentRegistry::Provider::add<GDBProvider>();
        ContentRegistry::Provider::add<IntelHexProvider>();
        ContentRegistry::Provider::add<MotorolaSRECProvider>();
        ContentRegistry::Provider::add<MemoryFileProvider>(false);
        ContentRegistry::Provider::add<ViewProvider>(false);

        ProjectFile::registerHandler({
            .basePath = "providers",
            .required = true,
            .load = [](const std::fs::path &basePath, Tar &tar) {
                auto json = nlohmann::json::parse(tar.readString(basePath / "providers.json"));
                auto providerIds = json.at("providers").get<std::vector<int>>();

                bool success = true;
                std::map<hex::prv::Provider*, std::string> providerWarnings;
                for (const auto &id : providerIds) {
                    auto providerSettings = nlohmann::json::parse(tar.readString(basePath / hex::format("{}.json", id)));

                    auto providerType = providerSettings.at("type").get<std::string>();
                    auto provider = ImHexApi::Provider::createProvider(providerType, true, false);
                    ON_SCOPE_EXIT {
                        if (!success) {
                            for (auto &task : TaskManager::getRunningTasks())
                                task->interrupt();

                            TaskManager::runWhenTasksFinished([]{
                                for (auto provider : ImHexApi::Provider::getProviders())
                                    ImHexApi::Provider::remove(provider, true);
                            });
                        }
                    };

                    if (provider == nullptr) {
                        // If a provider is not created, it will be overwritten when saving the project,
                        // so we should prevent the project from loading at all
                        showError(hex::format("hex.builtin.popup.error.project.load"_lang,
                            hex::format("hex.builtin.popup.error.project.load.create_provider"_lang, providerType)
                        ));
                        success = false;
                        break;
                    }

                    provider->setID(id);
                    bool loaded = false;
                    try {
                        provider->loadSettings(providerSettings.at("settings"));
                        loaded = true;
                    } catch (const std::exception &e){
                            providerWarnings[provider] = e.what();
                    }
                    if (loaded) {
                        if (!provider->open() || !provider->isAvailable() || !provider->isReadable()) {
                            providerWarnings[provider] = provider->getErrorMessage();
                        } else
                            EventManager::post<EventProviderOpened>(provider);
                    }
                }

                std::string warningMsg;
                for (const auto &warning : providerWarnings){
                    ImHexApi::Provider::remove(warning.first);
                    warningMsg.append(
                        hex::format("\n - {} : {}", warning.first->getName(), warning.second));
                }

                // If no providers were opened, display an error with
                // the warnings that happened when opening them 
                if (ImHexApi::Provider::getProviders().size() == 0) {
                    showError(hex::format("hex.builtin.popup.error.project.load"_lang,
                        hex::format("hex.builtin.popup.error.project.load.no_providers"_lang)) + warningMsg);

                    return false;
                 } else {

                    // Else, if are warnings, still display them
                    if (warningMsg.empty()) return true;
                    else {
                        showWarning(
                            hex::format("hex.builtin.popup.error.project.load.some_providers_failed"_lang, warningMsg));
                    }
                    return success;
                }
            },
            .store = [](const std::fs::path &basePath, Tar &tar) {
                std::vector<int> providerIds;
                for (const auto &provider : ImHexApi::Provider::getProviders()) {
                    auto id = provider->getID();
                    providerIds.push_back(id);

                    nlohmann::json json;
                    json["type"] = provider->getTypeName();
                    json["settings"] = provider->storeSettings();

                    tar.writeString(basePath / hex::format("{}.json", id), json.dump(4));
                }

                tar.writeString(basePath / "providers.json",
                    nlohmann::json({ { "providers", providerIds } }).dump(4)
                );

                return true;
            }
        });
    }

}