dhtrunner.h

// Copyright (c) 2014-2026 Savoir-faire Linux Inc.
// SPDX-License-Identifier: MIT
#pragma once
 
#include "def.h"
#include "infohash.h"
#include "value.h"
#include "callbacks.h"
#include "sockaddr.h"
#include "logger.h"
#include "network_utils.h"
#include "node_export.h"
 
#include <thread>
#include <mutex>
#include <atomic>
#include <condition_variable>
#include <future>
#include <exception>
#include <queue>
#include <chrono>
 
namespace dht {
 
struct Node;
class SecureDht;
class PeerDiscovery;
struct SecureDhtConfig;

class OPENDHT_PUBLIC DhtRunner
{
public:
    using StatusCallback = std::function<void(NodeStatus, NodeStatus)>;
 
    struct Config
    {
        SecureDhtConfig dht_config {};
        bool threaded {true};
        std::string proxy_server {};
        std::string push_node_id {};
        std::string push_token {};
        std::string push_topic {};
        std::string push_platform {};
        std::string proxy_user_agent {};
        bool peer_discovery {false};
        bool peer_publish {false};
        std::shared_ptr<dht::crypto::Certificate> server_ca;
        dht::crypto::Identity client_identity;
        SockAddr bind4 {}, bind6 {};
    };
 
    struct Context
    {
        std::shared_ptr<Logger> logger {};
        std::unique_ptr<net::DatagramSocket> sock;
        std::shared_ptr<PeerDiscovery> peerDiscovery {};
        StatusCallback statusChangedCallback {};
        CertificateStoreQuery certificateStore {};
        IdentityAnnouncedCb identityAnnouncedCb {};
        PublicAddressChangedCb publicAddressChangedCb {};
        std::unique_ptr<std::mt19937_64> rng {};
        Context() {}
    };
 
    DhtRunner();
    virtual ~DhtRunner();
 
    void get(InfoHash id, GetCallbackSimple cb, DoneCallback donecb = {}, Value::Filter f = {}, Where w = {})
    {
        get(id, bindGetCb(cb), donecb, f, w);
    }
 
    void get(InfoHash id, GetCallbackSimple cb, DoneCallbackSimple donecb = {}, Value::Filter f = {}, Where w = {})
    {
        get(id, bindGetCb(cb), donecb, f, w);
    }
 
    void get(InfoHash hash, GetCallback vcb, DoneCallback dcb, Value::Filter f = {}, Where w = {});
 
    void get(InfoHash id, GetCallback cb, DoneCallbackSimple donecb = {}, Value::Filter f = {}, Where w = {})
    {
        get(id, cb, bindDoneCb(donecb), f, w);
    }
    void get(const std::string& key, GetCallback vcb, DoneCallbackSimple dcb = {}, Value::Filter f = {}, Where w = {});
 
    template<class T>
    void get(InfoHash hash, std::function<bool(std::vector<T>&&)> cb, DoneCallbackSimple dcb = {})
    {
        get(
            hash,
            [cb = std::move(cb)](const std::vector<std::shared_ptr<Value>>& vals) { return cb(unpackVector<T>(vals)); },
            dcb,
            getFilterSet<T>());
    }
    template<class T>
    void get(InfoHash hash, std::function<bool(T&&)> cb, DoneCallbackSimple dcb = {})
    {
        get(
            hash,
            [cb = std::move(cb)](const std::vector<std::shared_ptr<Value>>& vals) {
                for (const auto& v : vals) {
                    try {
                        if (not cb(Value::unpack<T>(*v)))
                            return false;
                    } catch (const std::exception&) {
                        continue;
                    }
                }
                return true;
            },
            dcb,
            getFilterSet<T>());
    }
 
    std::future<std::vector<std::shared_ptr<dht::Value>>> get(InfoHash key, Value::Filter f = {}, Where w = {})
    {
        auto p = std::make_shared<std::promise<std::vector<std::shared_ptr<dht::Value>>>>();
        auto values = std::make_shared<std::vector<std::shared_ptr<dht::Value>>>();
        get(
            key,
            [=](const std::vector<std::shared_ptr<dht::Value>>& vlist) {
                values->insert(values->end(), vlist.begin(), vlist.end());
                return true;
            },
            [=](bool) { p->set_value(std::move(*values)); },
            f,
            w);
        return p->get_future();
    }
 
    template<class T>
    std::future<std::vector<T>> get(InfoHash key)
    {
        auto p = std::make_shared<std::promise<std::vector<T>>>();
        auto values = std::make_shared<std::vector<T>>();
        get<T>(
            key,
            [=](T&& v) {
                values->emplace_back(std::move(v));
                return true;
            },
            [=](bool) { p->set_value(std::move(*values)); });
        return p->get_future();
    }
 
    void query(const InfoHash& hash, QueryCallback cb, DoneCallback done_cb = {}, Query q = {});
    void query(const InfoHash& hash, QueryCallback cb, DoneCallbackSimple done_cb = {}, Query q = {})
    {
        query(hash, cb, bindDoneCb(done_cb), q);
    }
 
    std::future<size_t> listen(InfoHash key, ValueCallback vcb, Value::Filter f = {}, Where w = {});
 
    std::future<size_t> listen(InfoHash key, GetCallback cb, Value::Filter f = {}, Where w = {})
    {
        return listen(
            key,
            [cb = std::move(cb)](const std::vector<Sp<Value>>& vals, bool expired) {
                if (not expired)
                    return cb(vals);
                return true;
            },
            std::forward<Value::Filter>(f),
            std::forward<Where>(w));
    }
    std::future<size_t> listen(const std::string& key, GetCallback vcb, Value::Filter f = {}, Where w = {});
    std::future<size_t> listen(InfoHash key, GetCallbackSimple cb, Value::Filter f = {}, Where w = {})
    {
        return listen(key, bindGetCb(cb), f, w);
    }
 
    template<class T>
    std::future<size_t> listen(InfoHash hash, std::function<bool(std::vector<T>&&)> cb)
    {
        return listen(
            hash,
            [cb = std::move(cb)](const std::vector<std::shared_ptr<Value>>& vals) { return cb(unpackVector<T>(vals)); },
            getFilterSet<T>());
    }
    template<class T>
    std::future<size_t> listen(InfoHash hash, std::function<bool(std::vector<T>&&, bool)> cb)
    {
        return listen(
            hash,
            [cb = std::move(cb)](const std::vector<std::shared_ptr<Value>>& vals, bool expired) {
                return cb(unpackVector<T>(vals), expired);
            },
            getFilterSet<T>());
    }
 
    template<typename T>
    std::future<size_t> listen(InfoHash hash, std::function<bool(T&&)> cb, Value::Filter f = {}, Where w = {})
    {
        return listen(
            hash,
            [cb = std::move(cb)](const std::vector<std::shared_ptr<Value>>& vals) {
                for (const auto& v : vals) {
                    try {
                        if (not cb(Value::unpack<T>(*v)))
                            return false;
                    } catch (const std::exception&) {
                        continue;
                    }
                }
                return true;
            },
            getFilterSet<T>(f),
            w);
    }
    template<typename T>
    std::future<size_t> listen(InfoHash hash, std::function<bool(T&&, bool)> cb, Value::Filter f = {}, Where w = {})
    {
        return listen(
            hash,
            [cb = std::move(cb)](const std::vector<std::shared_ptr<Value>>& vals, bool expired) {
                for (const auto& v : vals) {
                    try {
                        if (not cb(Value::unpack<T>(*v), expired))
                            return false;
                    } catch (const std::exception&) {
                        continue;
                    }
                }
                return true;
            },
            getFilterSet<T>(f),
            w);
    }
 
    void cancelListen(InfoHash h, size_t token);
    void cancelListen(InfoHash h, std::shared_future<size_t> token);
 
    void put(InfoHash hash,
             std::shared_ptr<Value> value,
             DoneCallback cb = {},
             time_point created = time_point::max(),
             bool permanent = false);
    void put(InfoHash hash,
             std::shared_ptr<Value> value,
             DoneCallbackSimple cb,
             time_point created = time_point::max(),
             bool permanent = false)
    {
        put(hash, value, bindDoneCb(cb), created, permanent);
    }
 
    void put(InfoHash hash,
             Value&& value,
             DoneCallback cb = {},
             time_point created = time_point::max(),
             bool permanent = false);
    void put(InfoHash hash,
             Value&& value,
             DoneCallbackSimple cb,
             time_point created = time_point::max(),
             bool permanent = false)
    {
        put(hash, std::forward<Value>(value), bindDoneCb(cb), created, permanent);
    }
    void put(const std::string& key,
             Value&& value,
             DoneCallbackSimple cb = {},
             time_point created = time_point::max(),
             bool permanent = false);
 
    void cancelPut(const InfoHash& h, Value::Id id);
    void cancelPut(const InfoHash& h, const std::shared_ptr<Value>& value);
 
    void putSigned(InfoHash hash, std::shared_ptr<Value> value, DoneCallback cb = {}, bool permanent = false);
    void putSigned(InfoHash hash, std::shared_ptr<Value> value, DoneCallbackSimple cb, bool permanent = false)
    {
        putSigned(hash, value, bindDoneCb(cb), permanent);
    }
 
    void putSigned(InfoHash hash, Value&& value, DoneCallback cb = {}, bool permanent = false);
    void putSigned(InfoHash hash, Value&& value, DoneCallbackSimple cb, bool permanent = false)
    {
        putSigned(hash, std::forward<Value>(value), bindDoneCb(cb), permanent);
    }
    void putSigned(const std::string& key, Value&& value, DoneCallbackSimple cb = {}, bool permanent = false);
 
    void putEncrypted(InfoHash hash,
                      const std::shared_ptr<crypto::PublicKey>& to,
                      std::shared_ptr<Value> value,
                      DoneCallback cb = {},
                      bool permanent = false);
    void putEncrypted(InfoHash hash,
                      const std::shared_ptr<crypto::PublicKey>& to,
                      std::shared_ptr<Value> value,
                      DoneCallbackSimple cb,
                      bool permanent = false)
    {
        putEncrypted(hash, to, value, bindDoneCb(cb), permanent);
    }
 
    void putEncrypted(InfoHash hash,
                      const std::shared_ptr<crypto::PublicKey>& to,
                      Value&& value,
                      DoneCallback cb = {},
                      bool permanent = false);
    void putEncrypted(InfoHash hash,
                      const std::shared_ptr<crypto::PublicKey>& to,
                      Value&& value,
                      DoneCallbackSimple cb,
                      bool permanent = false)
    {
        putEncrypted(hash, to, std::forward<Value>(value), bindDoneCb(cb), permanent);
    }
 
    void putEncrypted(
        InfoHash hash, const PkId& to, std::shared_ptr<Value> value, DoneCallback cb = {}, bool permanent = false);
    void putEncrypted(
        InfoHash hash, const PkId& to, std::shared_ptr<Value> value, DoneCallbackSimple cb, bool permanent = false)
    {
        putEncrypted(hash, to, value, bindDoneCb(cb), permanent);
    }
    void putEncrypted(InfoHash hash, const PkId& to, Value&& value, DoneCallback cb = {}, bool permanent = false)
    {
        putEncrypted(hash, to, std::make_shared<Value>(std::move(value)), std::move(cb), permanent);
    }
    void putEncrypted(InfoHash hash, const PkId& to, Value&& value, DoneCallbackSimple cb, bool permanent = false)
    {
        putEncrypted(hash, to, std::make_shared<Value>(std::move(value)), bindDoneCb(cb), permanent);
    }

    void bootstrap(std::vector<SockAddr> nodes, DoneCallbackSimple cb = {});
    void bootstrap(SockAddr addr, DoneCallbackSimple cb = {});

    void bootstrap(std::vector<NodeExport> nodes);

    void bootstrap(const std::string& host, const std::string& service);
    void bootstrap(const std::string& hostService);

    void bootstrap(const InfoHash& id, const SockAddr& address);

    void clearBootstrap();

    void connectivityChanged();
 
    void dumpTables() const;

    [[deprecated("Use getPublicKey()->getLongId() instead")]] InfoHash getId() const;
    std::shared_ptr<crypto::PublicKey> getPublicKey() const;

    InfoHash getNodeId() const;

    SockAddr getBound(sa_family_t f = AF_INET) const;

    in_port_t getBoundPort(sa_family_t f = AF_INET) const;
 
    std::pair<size_t, size_t> getStoreSize() const;
 
    size_t getStorageLimit() const;
    void setStorageLimit(size_t limit = 0);
 
    size_t getLocalStorageLimit() const;
    void setLocalStorageLimit(size_t limit = 0);
 
    std::vector<NodeExport> exportNodes() const;
 
    std::vector<ValuesExport> exportValues() const;
 
    void setLogger(const Sp<Logger>& logger = {});

    void setLogFilter(const InfoHash& f = {});
 
    void registerType(const ValueType& type);
    void registerInsecureType(const ValueType& type);
 
    void importValues(const std::vector<ValuesExport>& values);
 
    bool isRunning() const { return running != State::Idle; }
 
    NodeStats getNodesStats(sa_family_t af) const;
    unsigned getNodesStats(sa_family_t af,
                           unsigned* good_return,
                           unsigned* dubious_return,
                           unsigned* cached_return,
                           unsigned* incoming_return) const;
    NodeInfo getNodeInfo() const;
    void getNodeInfo(std::function<void(std::shared_ptr<NodeInfo>)>);
 
    std::vector<unsigned> getNodeMessageStats(bool in = false) const;
    std::string getStorageLog() const;
    std::string getStorageLog(const InfoHash&) const;
    std::string getRoutingTablesLog(sa_family_t af) const;
    std::string getSearchesLog(sa_family_t af = AF_UNSPEC) const;
    std::string getSearchLog(const InfoHash&, sa_family_t af = AF_UNSPEC) const;
    std::vector<SockAddr> getPublicAddress(sa_family_t af = AF_UNSPEC) const;
    std::vector<std::string> getPublicAddressStr(sa_family_t af = AF_UNSPEC) const;
    void getPublicAddress(std::function<void(std::vector<SockAddr>&&)>, sa_family_t af = AF_UNSPEC);
 
    // securedht methods
    void findCertificate(PkId hash, std::function<void(const std::shared_ptr<crypto::Certificate>&)>);
 
    void registerCertificate(const std::shared_ptr<crypto::Certificate>& cert);
    void setLocalCertificateStore(CertificateStoreQuery&& query_method);

    void run(in_port_t port = dht::net::DHT_DEFAULT_PORT,
             const crypto::Identity& identity = {},
             bool threaded = true,
             NetId network = 0)
    {
        Config config;
        config.dht_config.node_config.network = network;
        config.dht_config.id = identity;
        config.threaded = threaded;
        run(port, config);
    }
    void run(in_port_t port, Config& config, Context&& context = {});

    void run(const char* ip4, const char* ip6, const char* service, Config& config, Context&& context = {});
 
    void run(const Config& config, Context&& context);
 
    void setOnStatusChanged(StatusCallback&& cb)
    {
        if (cb)
            statusCbs.emplace_back(std::move(cb));
    }

    time_point loop()
    {
        std::lock_guard lck(dht_mtx);
        return loop_();
    }

    void shutdown(ShutdownCallback cb = {}, bool stop = false);

    void join();
 
    std::shared_ptr<PeerDiscovery> getPeerDiscovery() const { return peerDiscovery_; };
 
    void setProxyServer(const std::string& proxy, const std::string& pushNodeId = "");

    void enableProxy(bool proxify);
 
    /* Push notification methods */

    void setPushNotificationToken(const std::string& token);

    void setPushNotificationTopic(const std::string& topic);

    void setPushNotificationPlatform(const std::string& platform);

    std::future<PushNotificationResult> pushNotificationReceived(const std::map<std::string, std::string>& data);
 
    /* Proxy server mothods */
    void forwardAllMessages(bool forward);
 
private:
    enum class State { Idle, Running, Stopping };
 
    time_point loop_();
 
    NodeStatus getStatus() const { return std::max(status4, status6); }
 
    bool checkShutdown();
    void opEnded();
    DoneCallback bindOpDoneCallback(DoneCallback&& cb);
    DoneCallbackSimple bindOpDoneCallback(DoneCallbackSimple&& cb);

    std::unique_ptr<SecureDht> dht_;

    std::atomic_bool use_proxy {false};

    Config config_;
    IdentityAnnouncedCb identityAnnouncedCb_;

    void resetDht();
 
    mutable std::mutex dht_mtx;
    std::thread dht_thread {};
    std::condition_variable cv {};
    std::mutex sock_mtx;
    net::PacketList rcv {};
    decltype(rcv) rcv_free {};
 
    std::queue<std::function<void(SecureDht&)>> pending_ops_prio {};
    std::queue<std::function<void(SecureDht&)>> pending_ops {};
    std::mutex storage_mtx;
 
    std::atomic<State> running {State::Idle};
    std::atomic_size_t ongoing_ops {0};
    std::vector<ShutdownCallback> shutdownCallbacks_;
 
    NodeStatus status4 {NodeStatus::Disconnected}, status6 {NodeStatus::Disconnected};
 
    std::vector<StatusCallback> statusCbs {};

    std::shared_ptr<PeerDiscovery> peerDiscovery_;

    std::shared_ptr<dht::Logger> logger_;
};
 
} // namespace dht