Merge pull request #606 from evoskuil/master

Generalize explore routing, factor out new [peer] config section.

Author: evoskuil

include/bitcoin/server/parsers/explore_query.hpp

@@ -24,6 +24,28 @@
 namespace libbitcoin {
 namespace server {
 
+// Query string tokens.
+namespace token
+{
+    // Names.
+    constexpr auto turbo = "turbo";
+    constexpr auto format = "format";
+    constexpr auto witness = "witness";
+
+    // Boolean values.
+    constexpr auto true_ = "true";
+    constexpr auto false_ = "false";
+
+    // Format values.
+    namespace formats
+    {
+        constexpr auto html = "html";
+        constexpr auto text = "text";
+        constexpr auto json = "json";
+        constexpr auto data = "data";
+    }
+}
+
 BCS_API bool explore_query(network::rpc::request_t& out,
     const network::http::request& request) NOEXCEPT;
 

src/parser.cpp

@@ -509,143 +509,140 @@ options_metadata parser::load_settings() THROWS
         "The minimum number of threads in the network threadpool, defaults to '16'."
     )
     (
-        "network.address_upper",
+        "network.retry_timeout_seconds",
+        value<uint32_t>(&configured.network.retry_timeout_seconds),
+        "The time delay for failed connection retry, defaults to '1'."
+    )
+    (
+        "network.connect_timeout_seconds",
+        value<uint32_t>(&configured.network.connect_timeout_seconds),
+        "The time limit for connection establishment, defaults to '5'."
+    )
+    (
+        "network.rate_limit",
+        value<uint32_t>(&configured.network.rate_limit),
+        "The peer download rate limit (not implemented)."
+    )
+    (
+        "network.blacklist",
+        value<network::config::authorities>(&configured.network.blacklists),
+        "IP address to disallow, allows all others, multiple allowed."
+    )
+    (
+        "network.whitelist",
+        value<network::config::authorities>(&configured.network.whitelists),
+        "IP address to allow, prohibits all others, multiple allowed."
+    )
+
+    /* [peer] */
+    (
+        "peer.address_upper",
         value<uint16_t>(&configured.network.address_upper),
         "The upper bound for address selection divisor, defaults to '10'."
     )
     (
-        "network.address_lower",
+        "peer.address_lower",
         value<uint16_t>(&configured.network.address_lower),
         "The lower bound for address selection divisor, defaults to '5'."
     )
     (
-        "network.protocol_maximum",
+        "peer.protocol_maximum",
         value<uint32_t>(&configured.network.protocol_maximum),
         "The maximum network protocol version, defaults to '70012'."
     )
     (
-        "network.protocol_minimum",
+        "peer.protocol_minimum",
         value<uint32_t>(&configured.network.protocol_minimum),
         "The minimum network protocol version, defaults to '31800'."
     )
     (
-        "network.services_maximum",
+        "peer.services_maximum",
         value<uint64_t>(&configured.network.services_maximum),
         "The maximum services exposed by network connections, defaults to '9' (full node, witness)."
     )
     (
-        "network.services_minimum",
+        "peer.services_minimum",
         value<uint64_t>(&configured.network.services_minimum),
         "The minimum services exposed by network connections, defaults to '9' (full node, witness)."
     )
     (
-        "network.invalid_services",
+        "peer.invalid_services",
         value<uint64_t>(&configured.network.invalid_services),
         "The advertised services that cause a peer to be dropped, defaults to '176'."
     )
     (
-        "network.enable_address",
+        "peer.enable_address",
         value<bool>(&configured.network.enable_address),
         "Enable address messages, defaults to 'true'."
     )
     (
-        "network.enable_address_v2",
+        "peer.enable_address_v2",
         value<bool>(&configured.network.enable_address_v2),
         "Enable address v2 messages, defaults to 'false'."
     )
     (
-        "network.enable_witness_tx",
+        "peer.enable_witness_tx",
         value<bool>(&configured.network.enable_witness_tx),
         "Enable witness transaction identifier relay, defaults to 'false'."
     )
     (
-        "network.enable_compact",
+        "peer.enable_compact",
         value<bool>(&configured.network.enable_compact),
         "Enable enable compact block messages, defaults to 'false'."
     )
     (
-        "network.enable_alert",
+        "peer.enable_alert",
         value<bool>(&configured.network.enable_alert),
         "Enable alert messages, defaults to 'false'."
     )
     (
-        "network.enable_reject",
+        "peer.enable_reject",
         value<bool>(&configured.network.enable_reject),
         "Enable reject messages, defaults to 'false'."
     )
     (
-        "network.enable_relay",
+        "peer.enable_relay",
         value<bool>(&configured.network.enable_relay),
         "Enable transaction relay, defaults to 'true'."
     )
     (
-        "network.validate_checksum",
+        "peer.validate_checksum",
         value<bool>(&configured.network.validate_checksum),
         "Validate the checksum of network messages, defaults to 'false'."
     )
     (
-        "network.identifier",
+        "peer.identifier",
         value<uint32_t>(&configured.network.identifier),
         "The magic number for message headers, defaults to '3652501241'."
     )
     (
-        "network.retry_timeout_seconds",
-        value<uint32_t>(&configured.network.retry_timeout_seconds),
-        "The time delay for failed connection retry, defaults to '1'."
-    )
-    (
-        "network.connect_timeout_seconds",
-        value<uint32_t>(&configured.network.connect_timeout_seconds),
-        "The time limit for connection establishment, defaults to '5'."
-    )
-    (
-        "network.handshake_timeout_seconds",
+        "peer.handshake_timeout_seconds",
         value<uint32_t>(&configured.network.handshake_timeout_seconds),
         "The time limit to complete the connection handshake, defaults to '15'."
     )
     (
-        "network.channel_heartbeat_minutes",
+        "peer.channel_heartbeat_minutes",
         value<uint32_t>(&configured.network.channel_heartbeat_minutes),
         "The time between ping messages, defaults to '5'."
     )
     (
-        "network.maximum_skew_minutes",
+        "peer.maximum_skew_minutes",
         value<uint32_t>(&configured.network.maximum_skew_minutes),
         "The maximum allowable channel clock skew, defaults to '120'."
     )
     (
-        "network.rate_limit",
-        value<uint32_t>(&configured.network.rate_limit),
-        "The peer download rate limit in bytes per second, defaults to 1024 (not implemented)."
-    )
-    (
-        "network.user_agent",
+        "peer.user_agent",
         value<std::string>(&configured.network.user_agent),
         "The node user agent string, defaults to '" BC_USER_AGENT "'."
     )
     (
-        "network.path",
+        "peer.path",
         value<std::filesystem::path>(&configured.network.path),
         "The peer address cache file directory, defaults to empty."
     )
-    (
-        "network.blacklist",
-        value<network::config::authorities>(&configured.network.blacklists),
-        "IP address to disallow as a peer, multiple allowed."
-    )
-    (
-        "network.whitelist",
-        value<network::config::authorities>(&configured.network.whitelists),
-        "IP address to allow as a peer, multiple allowed."
-    )
 
     /* [outbound] */
     ////(
-    ////    "outbound.secure",
-    ////    value<bool>(&configured.network.outbound.secure),
-    ////    "Require transport layer security, defaults to 'false' (not implemented)."
-    ////)
-    ////(
     ////    "outbound.bind",
     ////    value<network::config::authorities>(&configured.network.outbound.binds),
     ////    "IP address to bind for load balancing, multiple allowed (not implemented)."
@@ -1675,7 +1672,9 @@ options_metadata parser::load_settings() THROWS
     return description;
 }
 
+BC_PUSH_WARNING(NO_ARRAY_TO_POINTER_DECAY)
 bool parser::parse(int argc, const char* argv[], std::ostream& error) THROWS
+BC_POP_WARNING()
 {
     try
     {

src/parsers/explore_query.cpp

@@ -30,6 +30,21 @@ using namespace network::http;
 BC_PUSH_WARNING(NO_ARRAY_INDEXING)
 BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
 
+inline bool is_true(const std::string& value) NOEXCEPT
+{
+    return value == token::true_;
+}
+
+inline bool is_false(const std::string& value) NOEXCEPT
+{
+    return value == token::false_;
+}
+
+inline void set_media(rpc::object_t& params, media_type media) NOEXCEPT
+{
+    params["media"] = to_value(media);
+}
+
 bool explore_query(rpc::request_t& out, const request& request) NOEXCEPT
 {
     wallet::uri uri{};
@@ -41,70 +56,59 @@ bool explore_query(rpc::request_t& out, const request& request) NOEXCEPT
     constexpr auto json = media_type::application_json;
     constexpr auto data = media_type::application_octet_stream;
 
-    // TODO: reject invalid format.
-    auto query = uri.decode_query();
-    const auto format = query["format"];
-
+    // Caller must have provided a request.params object.
     if (!out.params.has_value() ||
         !std::holds_alternative<rpc::object_t>(out.params.value()))
         return false;
 
+    auto query = uri.decode_query();
     auto& params = std::get<rpc::object_t>(out.params.value());
 
-    // Validate proper witness bool value if set.
-    const auto witness = query.find("witness");
-    if (witness != query.end())
+    // Witness is optional<true> (where applicable), so only set if false.
+    if (const auto witness = query.find(token::witness); witness != query.end())
     {
-        if (witness->second != "true" && witness->second != "false")
+        if (is_false(witness->second))
+            params[token::witness] = false;
+        else if (!is_true(witness->second))
             return false;
-
-        // Witness is optional<true> (where applicable), so only set if false.
-        if (witness->second == "false")
-            params["witness"] = false;
     }
 
-    // Validate proper turbo bool value if set.
-    const auto turbo = query.find("turbo");
-    if (turbo != query.end())
+    // Turbo is optional<true> (where applicable), so only set if false.
+    if (const auto turbo = query.find(token::turbo); turbo != query.end())
     {
-        if (turbo->second != "true" && turbo->second != "false")
+        if (is_false(turbo->second))
+            params[token::turbo] = false;
+        else if (!is_true(turbo->second))
             return false;
-
-        // Turbo is optional<true> (where applicable), so only set if false.
-        if (turbo->second == "false")
-            params["turbo"] = false;
     }
 
+    const auto format = query[token::format];
     const auto accepts = to_media_types((request)[field::accept]);
 
-    if (contains(accepts, text) || format == "text")
-    {
-        params["media"] = to_value(text);
-        return true;
-    }
-
-    if (contains(accepts, data) || format == "data")
-    {
-        params["media"] = to_value(data);
-        return true;
-    }
-
-    ////// Default format to json.
-    ////params["media"] = to_value(json);
-    ////return true;
-
-    if (contains(accepts, json) || format == "json")
-    {
-        params["media"] = to_value(json);
-        return true;
-    }
-
-    if (contains(accepts, html) || format == "html")
-        params["media"] = to_value(html);
+    // Prioritize query string format over http headers.
+    if (format == token::formats::json)
+        set_media(params, json);
+    else if (format == token::formats::text)
+        set_media(params, text);
+    else if (format == token::formats::data)
+        set_media(params, data);
+    else if (format == token::formats::html)
+        set_media(params, html);
+
+    // Priotize: json, html, text, data (ignores accept priorities).
+    else if (contains(accepts, json))
+        set_media(params, json);
+    else if (contains(accepts, html))
+        set_media(params, html);
+    else if (contains(accepts, text))
+        set_media(params, text);
+    else if (contains(accepts, data))
+        set_media(params, data);
+    else
+        return false;
 
-    // Not dispatchable (media is html or undefined).
-    // TODO: differentiate return of false (error) vs. false (continue).
-    return false;
+    // Media type has been set.
+    return true;
 }
 
 media_type get_media(const rpc::request_t& model) NOEXCEPT

src/protocols/protocol_explore.cpp

@@ -139,19 +139,18 @@ bool protocol_explore::try_dispatch_object(const http::request& request) NOEXCEP
         return !ec;
     }
 
-    // TODO: differentiate return of false (error) vs. false (continue).
-    if (explore_query(model, request))
+    if (!explore_query(model, request))
     {
-        if (const auto ec = dispatcher_.notify(model))
-            send_internal_server_error(ec, request);
-
+        send_not_acceptable(request);
         return true;
     }
 
     if (get_media(model) == http::media_type::text_html)
         return false;
 
-    send_not_acceptable(request);
+    if (const auto ec = dispatcher_.notify(model))
+        send_internal_server_error(ec, request);
+
     return true;
 }