curl.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache 2.0 License.
#pragma once
 
#include "ccf/ds/nonstd.h"
#include "ccf/rest_verb.h"
#include "ds/internal_logger.h"
#include "host/proxy.h"
 
#include <cstddef>
#include <cstdint>
#include <curl/curl.h>
#include <curl/multi.h>
#include <memory>
#include <mutex>
#include <optional>
#include <regex>
#include <span>
#include <stdexcept>
#include <uv.h>
 
#define CHECK_CURL_EASY(fn, ...) \
  do \
  { \
    const auto res = fn(__VA_ARGS__); \
    if (res != CURLE_OK) \
    { \
      throw std::runtime_error(fmt::format( \
        "Error calling " #fn ": {} ({})", res, curl_easy_strerror(res))); \
    } \
  } while (0)
 
#define CHECK_CURL_EASY_SETOPT(handle, info, arg) \
  CHECK_CURL_EASY(curl_easy_setopt, handle, info, arg)
#define CHECK_CURL_EASY_GETINFO(handle, info, arg) \
  CHECK_CURL_EASY(curl_easy_getinfo, handle, info, arg)
 
#define CHECK_CURL_MULTI(fn, ...) \
  do \
  { \
    const auto res = fn(__VA_ARGS__); \
    if (res != CURLM_OK) \
    { \
      throw std::runtime_error(fmt::format( \
        "Error calling " #fn ": {} ({})", res, curl_multi_strerror(res))); \
    } \
  } while (0)
 
namespace ccf::curl
{
 
  class UniqueCURL
  {
  private:
    std::unique_ptr<CURL, void (*)(CURL*)> p;
 
  public:
    UniqueCURL() : p(curl_easy_init(), [](auto x) { curl_easy_cleanup(x); })
    {
      if (p == nullptr)
      {
        throw std::runtime_error("Error initialising curl easy request");
      }
    }
 
    // No implicit copying: unique ownership of the CURL handle
    UniqueCURL(const UniqueCURL&) = delete;
    UniqueCURL& operator=(const UniqueCURL&) = delete;
 
    // Move semantics
    UniqueCURL(UniqueCURL&& other) noexcept : p(std::move(other.p)) {}
    UniqueCURL& operator=(UniqueCURL&& other) noexcept
    {
      p = std::move(other.p);
      return *this;
    }
 
    ~UniqueCURL() = default;
 
    operator CURL*() const
    {
      return p.get();
    }
 
    void set_blob_opt(auto option, const uint8_t* data, size_t length)
    {
      if (data == nullptr || length == 0)
      {
        throw std::invalid_argument(
          "Data pointer cannot be null or length zero");
      }
 
      if (p == nullptr)
      {
        throw std::logic_error("Cannot set option on a null CURL handle");
      }
 
      struct curl_blob blob
      {
        .data = const_cast<uint8_t*>(data), .len = length,
        .flags = CURL_BLOB_COPY,
      };
 
      CHECK_CURL_EASY_SETOPT(p.get(), option, &blob);
    }
 
    void set_opt(auto option, auto value)
    {
      CHECK_CURL_EASY_SETOPT(p.get(), option, value);
    }
  };
 
  class UniqueCURLM
  {
  protected:
    std::unique_ptr<CURLM, void (*)(CURLM*)> p;
 
  public:
    UniqueCURLM() : p(curl_multi_init(), [](auto x) { curl_multi_cleanup(x); })
    {
      if (p == nullptr)
      {
        throw std::runtime_error("Error initialising curl multi request");
      }
    }
 
    ~UniqueCURLM() = default;
    UniqueCURLM(const UniqueCURLM&) = delete;
    UniqueCURLM& operator=(const UniqueCURLM&) = delete;
    UniqueCURLM(UniqueCURLM&& other) noexcept : p(std::move(other.p)) {}
    UniqueCURLM& operator=(UniqueCURLM&& other) noexcept
    {
      p = std::move(other.p);
      return *this;
    }
 
    [[nodiscard]] CURLM* release()
    {
      return p.release();
    }
 
    operator CURLM*() const
    {
      return p.get();
    }
  };
 
  class UniqueSlist
  {
  private:
    std::unique_ptr<curl_slist, void (*)(curl_slist*)> p;
 
  public:
    UniqueSlist() : p(nullptr, [](auto x) { curl_slist_free_all(x); }) {}
    ~UniqueSlist() = default;
    UniqueSlist(const UniqueSlist&) = delete;
    UniqueSlist& operator=(const UniqueSlist&) = delete;
    UniqueSlist(UniqueSlist&& other) noexcept : p(std::move(other.p)) {}
    UniqueSlist& operator=(UniqueSlist&& other) noexcept
    {
      p = std::move(other.p);
      return *this;
    }
 
    void append(const char* str)
    {
      p.reset(curl_slist_append(p.release(), str));
    }
 
    void append(const std::string& key, const std::string& value)
    {
      append(fmt::format("{}: {}", key, value).c_str());
    }
 
    [[nodiscard]] curl_slist* get() const
    {
      return p.get();
    }
  };
 
  class RequestBody
  {
    std::vector<uint8_t> buffer;
    std::span<const uint8_t> unsent;
 
  public:
    RequestBody(std::vector<uint8_t>& buffer) : buffer(buffer)
    {
      unsent = std::span<const uint8_t>(buffer.data(), buffer.size());
    }
 
    RequestBody(std::vector<uint8_t>&& buffer_) : buffer(std::move(buffer_))
    {
      unsent = std::span<const uint8_t>(buffer.data(), buffer.size());
    }
 
    RequestBody(nlohmann::json json)
    {
      auto json_str = json.dump();
      buffer = std::vector<uint8_t>(
        json_str.begin(), json_str.end()); // Convert to vector of bytes
      unsent = std::span<const uint8_t>(buffer.data(), buffer.size());
    }
 
    static size_t send_data(
      char* ptr, size_t size, size_t nitems, RequestBody* data)
    {
      if (data == nullptr)
      {
        LOG_FAIL_FMT("send_data called with null userdata");
        return 0;
      }
      auto bytes_to_copy = std::min(data->unsent.size(), size * nitems);
      memcpy(ptr, data->unsent.data(), bytes_to_copy);
      data->unsent = data->unsent.subspan(bytes_to_copy);
      return bytes_to_copy;
    }
 
    void attach_to_curl(CURL* curl)
    {
      if (curl == nullptr)
      {
        throw std::logic_error(
          "Cannot attach request body to a null CURL handle");
      }
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_READDATA, this);
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_READFUNCTION, send_data);
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_INFILESIZE, unsent.size());
    }
  };
 
  class ResponseBody
  {
  public:
    std::vector<uint8_t> buffer;
    size_t maximum_size;
 
    // Ensure there is always a maximum size set
    ResponseBody() = delete;
 
    // _max_size is the maximum size of the response body
    ResponseBody(size_t max_size_) : maximum_size(max_size_) {}
 
    static size_t write_response_chunk(
      const uint8_t* ptr, size_t size, size_t nmemb, ResponseBody* response)
    {
      if (response == nullptr)
      {
        LOG_FAIL_FMT(
          "write_response_chunk called with a null response pointer");
        return CURL_WRITEFUNC_ERROR;
      }
      auto bytes_to_copy = size * nmemb;
      if (response->buffer.size() + bytes_to_copy > response->maximum_size)
      {
        LOG_FAIL_FMT(
          "Response size limit exceeded: {} bytes, maximum is {} bytes",
          response->buffer.size() + bytes_to_copy,
          response->maximum_size);
        return CURL_WRITEFUNC_ERROR;
      }
 
      response->buffer.insert(response->buffer.end(), ptr, ptr + bytes_to_copy);
      return bytes_to_copy;
    }
 
    void attach_to_curl(CURL* curl)
    {
      if (curl == nullptr)
      {
        throw std::logic_error("Cannot attach response to a null CURL handle");
      }
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_WRITEDATA, this);
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_WRITEFUNCTION, write_response_chunk);
    }
 
    static size_t noop_write_function(
      const uint8_t* ptr, size_t size, size_t nmemb, ResponseBody* response)
    {
      (void)ptr;
      (void)response;
      return size * nmemb;
    }
 
    static void attach_noop_response(CURL* curl)
    {
      if (curl == nullptr)
      {
        throw std::logic_error(
          "Cannot attach noop response to a null CURL handle");
      }
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_WRITEDATA, nullptr);
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_WRITEFUNCTION, noop_write_function);
    }
  };
 
  class ResponseHeaders
  {
  public:
    using HeaderMap = std::unordered_map<std::string, std::string>;
    bool is_first_header = true;
    HeaderMap data;
 
    static size_t recv_header_line(
      char* buffer, size_t size, size_t nitems, ResponseHeaders* response)
    {
      if (response == nullptr)
      {
        LOG_FAIL_FMT("recv_header_line called with a null response pointer");
        return 0;
      }
      auto bytes_to_read = size * nitems;
      std::string_view header(buffer, bytes_to_read);
 
      // strip \r\n etc
      header = ccf::nonstd::trim(header);
 
      // Ignore the http status line (e.g. "HTTP/1.1 200") which should be the
      // first header
      static const std::regex http_status_line_regex(R"(^HTTP\/[1-9]+.*)");
      if (response->is_first_header)
      {
        response->is_first_header = false;
        if (!std::regex_match(std::string(header), http_status_line_regex))
        {
          LOG_FAIL_FMT(
            "Expected HTTP status line as first header, got '{}'", header);
          return bytes_to_read;
        }
      }
      else
      {
        // ignore empty headers
        if (!header.empty())
        {
          const auto [field, value] = ccf::nonstd::split_1(header, ": ");
          if (!value.empty())
          {
            std::string field_str(field);
            nonstd::to_lower(field_str);
            if (response->data.contains(field_str))
            {
              auto current = response->data[field_str];
              LOG_FAIL_FMT(
                "Duplicate header for '{}', current = '{}', new = '{}'",
                field_str,
                current,
                value);
            }
            response->data[field_str] = ccf::nonstd::trim(value);
          }
          else
          {
            LOG_DEBUG_FMT("Ignoring invalid-looking HTTP Header '{}'", header);
          }
        }
      }
 
      return bytes_to_read;
    }
 
    void attach_to_curl(CURL* curl)
    {
      if (curl == nullptr)
      {
        throw std::logic_error("Cannot attach response to a null CURL handle");
      }
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_HEADERDATA, this);
      CHECK_CURL_EASY_SETOPT(curl, CURLOPT_HEADERFUNCTION, recv_header_line);
    }
  };
 
  class CurlRequest
  {
  public:
    using ResponseCallback = std::function<void(
      std::unique_ptr<CurlRequest>&& request,
      CURLcode curl_response_code,
      long status_code)>;
 
  private:
    UniqueCURL curl_handle;
    RESTVerb method;
    std::string url;
    ccf::curl::UniqueSlist headers;
    std::unique_ptr<ccf::curl::RequestBody> request_body;
    std::unique_ptr<ccf::curl::ResponseBody> response;
    ResponseHeaders response_headers;
    std::optional<ResponseCallback> response_callback;
 
  public:
    CurlRequest(
      UniqueCURL&& curl_handle_,
      RESTVerb method_,
      std::string url_,
      UniqueSlist&& headers_,
      std::unique_ptr<RequestBody>&& request_body_,
      std::unique_ptr<ccf::curl::ResponseBody>&& response_,
      std::optional<ResponseCallback>&& response_callback_) :
      curl_handle(std::move(curl_handle_)),
      method(method_),
      url(std::move(url_)),
      headers(std::move(headers_)),
      request_body(std::move(request_body_)),
      response(std::move(response_)),
      response_callback(std::move(response_callback_))
    {
      if (url.empty())
      {
        throw std::invalid_argument("URL cannot be empty");
      }
      CHECK_CURL_EASY_SETOPT(curl_handle, CURLOPT_URL, url.c_str());
 
      auto http_method = method.get_http_method();
      if (!http_method.has_value())
      {
        throw std::logic_error(
          fmt::format("Unsupported HTTP method: {}", method.c_str()));
      }
 
      switch (http_method.value())
      {
        case HTTP_GET:
          CHECK_CURL_EASY_SETOPT(curl_handle, CURLOPT_HTTPGET, 1L);
          break;
        case HTTP_HEAD:
          CHECK_CURL_EASY_SETOPT(curl_handle, CURLOPT_NOBODY, 1L);
          break;
        case HTTP_PUT:
        {
          CHECK_CURL_EASY_SETOPT(curl_handle, CURLOPT_UPLOAD, 1L);
          if (request_body == nullptr)
          {
            // If no request body is provided, curl will try reading from
            // stdin, which causes a blockage
            request_body =
              std::make_unique<RequestBody>(std::vector<uint8_t>());
          }
        }
        break;
        case HTTP_POST:
          // libcurl sets the post verb when CURLOPT_POSTFIELDS is set, so we
          // skip doing so here, and we assume that the user has already set
          // these fields
          break;
        default:
          throw std::logic_error(
            fmt::format("Unsupported HTTP method: {}", method.c_str()));
      }
 
      if (request_body != nullptr)
      {
        request_body->attach_to_curl(curl_handle);
      }
 
      if (response != nullptr)
      {
        response->attach_to_curl(curl_handle);
      }
      else
      {
        ResponseBody::attach_noop_response(curl_handle);
      }
 
      response_headers.attach_to_curl(curl_handle);
 
      if (headers.get() != nullptr)
      {
        CHECK_CURL_EASY_SETOPT(curl_handle, CURLOPT_HTTPHEADER, headers.get());
      }
    }
 
    static void handle_response(
      std::unique_ptr<CurlRequest>&& request, CURLcode curl_response_code)
    {
      LOG_TRACE_FMT("Handling response for {}", request->url);
      auto& callback = request->response_callback;
      if (callback.has_value())
      {
        if (callback.value() != nullptr)
        {
          long status_code = 0;
          CHECK_CURL_EASY_GETINFO(
            request->curl_handle, CURLINFO_RESPONSE_CODE, &status_code);
          callback.value()(std::move(request), curl_response_code, status_code);
        }
      }
    }
 
    static void synchronous_perform(std::unique_ptr<CurlRequest>&& request)
    {
      if (request == nullptr)
      {
        throw std::logic_error("Cannot perform a null CurlRequest");
      }
      if (request->curl_handle == nullptr)
      {
        throw std::logic_error(
          "Cannot curl_easy_perform on a null CURL handle");
      }
 
      auto curl_code = curl_easy_perform(request->curl_handle);
 
      handle_response(
        std::move(request),
        curl_code); // handle the response callback if set
    }
 
    [[nodiscard]] CURL* get_easy_handle() const
    {
      return curl_handle;
    }
 
    [[nodiscard]] UniqueCURL& get_easy_handle_ptr()
    {
      return curl_handle;
    }
 
    [[nodiscard]] RESTVerb get_method() const
    {
      return method;
    }
 
    [[nodiscard]] std::string get_url() const
    {
      return url;
    }
 
    [[nodiscard]] ResponseBody* get_response_body()
    {
      return response.get();
    }
 
    [[nodiscard]] std::unique_ptr<ResponseBody>& get_response_ptr()
    {
      return response;
    }
 
    [[nodiscard]] const ResponseHeaders::HeaderMap& get_response_headers() const
    {
      return response_headers.data;
    }
  };
 
  class CurlRequestCURLM : public UniqueCURLM
  {
  public:
    void attach_curl_request(std::unique_ptr<CurlRequest>&& request)
    {
      if (p == nullptr)
      {
        throw std::logic_error(
          "Cannot attach CurlRequest to a null CURLM handle");
      }
      if (request == nullptr)
      {
        throw std::logic_error("Cannot attach a null CurlRequest");
      }
      LOG_DEBUG_FMT("Attaching CurlRequest to {} to Curlm", request->get_url());
      CURL* curl_handle = request->get_easy_handle();
      CHECK_CURL_EASY_SETOPT(curl_handle, CURLOPT_PRIVATE, request.release());
      CHECK_CURL_MULTI(curl_multi_add_handle, p.get(), curl_handle);
    }
 
    int perform()
    {
      if (p == nullptr)
      {
        throw std::logic_error("Cannot perform on a null CURLM handle");
      }
 
      int running_handles = 0;
      CHECK_CURL_MULTI(curl_multi_perform, p.get(), &running_handles);
 
      // handle all completed curl requests
      int msgq = 0;
      CURLMsg* msg = nullptr;
      do
      {
        msg = curl_multi_info_read(p.get(), &msgq);
 
        if ((msg != nullptr) && msg->msg == CURLMSG_DONE)
        {
          auto* easy = msg->easy_handle;
          auto result = msg->data.result;
 
          // retrieve the request data and attach a lifetime to it
          ccf::curl::CurlRequest* request = nullptr;
          curl_easy_getinfo(easy, CURLINFO_PRIVATE, &request);
          if (request == nullptr)
          {
            curl_multi_remove_handle(p.get(), easy);
            throw std::runtime_error(
              "CURLMSG_DONE received with no associated request data");
          }
          std::unique_ptr<ccf::curl::CurlRequest> request_data_ptr(request);
 
          // detach the easy handle such that it can be cleaned up with the
          // destructor of CurlRequest
          curl_multi_remove_handle(p.get(), easy);
 
          // handle response inline. Note that if this is expensive, it should
          // defer its work to a task
          CurlRequest::handle_response(std::move(request_data_ptr), result);
        }
      } while (msgq > 0);
      return running_handles;
    }
  };
 
  // Must be created on the same thread as the uv loop is running
  class CurlmLibuvContextImpl
  {
    /* Very high level:
     * CURLM triggers timeout callback with some delay for libuv
     * libuv calls the timeout callback which then triggers the curl socket
     *   action
     * curl calls the socket callback to register the libuv polling
     * libuv waits on the socket events and calls the socket poll callback
     * socket poll callback triggers relevant libuv action
     * etc.
     *
     * Example flow:
     *
     * Initially a CURL* is attached to the curl_multi CURLM* handle
     * This calls the curl_multi's timeout function curl_timeout_callback with
     * 0 delay which then registers the libuv timeout callback with 0 delay
     * libuv_timeout_callback then registers a timeout socket_action with curl
     * which then registers the socket polling at the libuv level
     *
     * At this point, either the relevant timeout will fire and call the
     * relevant timeout callbacks, or the socket polling will trigger allowing
     * data to be sent/received
     */
  private:
    uv_loop_t* loop;
    uv_timer_t uv_handle{};
    CurlRequestCURLM curl_request_curlm;
    std::atomic<bool> is_stopping = false;
 
    class SocketContextImpl : public asynchost::with_uv_handle<uv_poll_t>
    {
      friend class CurlmLibuvContextImpl;
 
    public:
      curl_socket_t socket{};
      CurlmLibuvContextImpl* context = nullptr;
    };
 
    using SocketContext = asynchost::proxy_ptr<SocketContextImpl>;
 
    uv_async_t async_requests_handle{};
    std::mutex requests_mutex;
    std::deque<std::unique_ptr<CurlRequest>> pending_requests;
 
    static void async_requests_callback(uv_async_t* handle)
    {
      auto* self = static_cast<CurlmLibuvContextImpl*>(handle->data);
      if (self == nullptr)
      {
        throw std::logic_error(
          "async_requests_callback called with null self pointer");
      }
 
      if (self->is_stopping)
      {
        LOG_FAIL_FMT("async_requests_callback called while stopping");
        return;
      }
 
      LOG_DEBUG_FMT("Libuv: processing pending curl requests");
 
      std::deque<std::unique_ptr<CurlRequest>> requests_to_add;
      {
        std::lock_guard<std::mutex> requests_lock(self->requests_mutex);
        requests_to_add.swap(self->pending_requests);
      }
 
      for (auto& req : requests_to_add)
      {
        self->curl_request_curlm.attach_curl_request(std::move(req));
      }
    }
 
  public:
    static void libuv_timeout_callback(uv_timer_t* handle)
    {
      auto* self = static_cast<CurlmLibuvContextImpl*>(handle->data);
      if (self == nullptr)
      {
        throw std::logic_error(
          "libuv_timeout_callback called with null self pointer");
      }
 
      if (self->is_stopping)
      {
        LOG_FAIL_FMT("libuv_timeout_callback called while stopping");
        return;
      }
 
      LOG_DEBUG_FMT("Libuv timeout");
 
      int running_handles = 0;
      CHECK_CURL_MULTI(
        curl_multi_socket_action,
        self->curl_request_curlm,
        CURL_SOCKET_TIMEOUT,
        0,
        &running_handles);
      self->curl_request_curlm.perform();
    }
 
    static int curl_timeout_callback(
      CURLM* multi, long timeout_ms, CurlmLibuvContextImpl* self)
    {
      (void)multi;
      if (self == nullptr)
      {
        throw std::logic_error(
          "libuv_timeout_callback called with null self pointer");
      }
 
      if (self->is_stopping)
      {
        LOG_FAIL_FMT("curl_timeout_callback called while stopping");
        return 0;
      }
 
      LOG_DEBUG_FMT("Curl timeout {}ms", timeout_ms);
 
      if (timeout_ms < 0)
      {
        // No timeout set, stop the timer
        uv_timer_stop(&self->uv_handle);
      }
      else
      {
        // If timeout is zero, this will trigger immediately, possibly within a
        // callback so clamp it to at least 1ms
        timeout_ms = std::max(timeout_ms, 1L);
        uv_timer_start(&self->uv_handle, libuv_timeout_callback, timeout_ms, 0);
      }
      return 0;
    }
 
    // Called when libuv detects a socket event
    static void libuv_socket_poll_callback(
      uv_poll_t* req, int status, int events)
    {
      auto* socket_context = static_cast<SocketContextImpl*>(req->data);
      if (socket_context == nullptr)
      {
        throw std::logic_error(
          "libuv_socket_poll_callback called with null request context");
      }
 
      auto* self = socket_context->context;
      if (self == nullptr)
      {
        throw std::logic_error(
          "libuv_socket_poll_callback called with null self pointer");
      }
 
      if (self->is_stopping)
      {
        LOG_FAIL_FMT(
          "libuv_socket_poll_callback called on {} while stopped",
          socket_context->socket);
        return;
      }
 
      if (status < 0)
      {
        if (status == UV_EBADF)
        {
          // Thrown when POLLERR is thrown by the epoll socket, such as when a
          // TCP socket received a reset at a bad time
          // https://docs.libuv.org/en/v1.x/poll.html#c.uv_poll_start
          // https://github.com/libuv/libuv/issues/3796
          LOG_INFO_FMT(
            "Socket poll error on {}: {}",
            socket_context->socket,
            uv_strerror(status));
        }
        else
        {
          LOG_FAIL_FMT(
            "Socket poll error on {}: {}",
            socket_context->socket,
            uv_strerror(status));
        }
 
        // Notify curl of the error
        int running_handles = 0;
        CHECK_CURL_MULTI(
          curl_multi_socket_action,
          self->curl_request_curlm,
          socket_context->socket,
          CURL_CSELECT_ERR,
          &running_handles);
        self->curl_request_curlm.perform();
        return;
      }
 
      LOG_DEBUG_FMT(
        "Libuv socket poll callback on {}: {}",
        static_cast<int>(socket_context->socket),
        static_cast<int>(events));
 
      int action = 0;
      action |= ((events & UV_READABLE) != 0) ? CURL_CSELECT_IN : 0;
      action |= ((events & UV_WRITABLE) != 0) ? CURL_CSELECT_OUT : 0;
      int running_handles = 0;
      CHECK_CURL_MULTI(
        curl_multi_socket_action,
        self->curl_request_curlm,
        socket_context->socket,
        action,
        &running_handles);
      self->curl_request_curlm.perform();
    }
 
    // Called when the status of a socket changes (creation/deletion)
    static int curl_socket_callback(
      CURL* easy,
      curl_socket_t s,
      int action,
      CurlmLibuvContextImpl* self,
      SocketContextImpl* socket_context)
    {
      if (self == nullptr)
      {
        throw std::logic_error(
          "curl_socket_callback called with null self pointer");
      }
      (void)easy;
 
      switch (action)
      {
        case CURL_POLL_IN:
        case CURL_POLL_OUT:
        case CURL_POLL_INOUT:
        {
          LOG_DEBUG_FMT(
            "Curl socket callback: listen on socket {}, {}",
            static_cast<int>(s),
            static_cast<int>(action));
 
          // During shutdown ignore requests to add new sockets
          if (self->is_stopping)
          {
            return 0;
          }
 
          if (socket_context == nullptr)
          {
            auto socket_context_ptr = std::make_unique<SocketContextImpl>();
            socket_context_ptr->context = self;
            socket_context_ptr->socket = s;
            uv_poll_init_socket(self->loop, &socket_context_ptr->uv_handle, s);
            socket_context_ptr->uv_handle.data =
              socket_context_ptr.get(); // Attach the context
            // attach the lifetime to the socket handle
            socket_context = socket_context_ptr.release();
            CHECK_CURL_MULTI(
              curl_multi_assign, self->curl_request_curlm, s, socket_context);
          }
 
          int events = 0;
          events |= (action != CURL_POLL_IN) ? UV_WRITABLE : 0;
          events |= (action != CURL_POLL_OUT) ? UV_READABLE : 0;
 
          uv_poll_start(
            &socket_context->uv_handle, events, libuv_socket_poll_callback);
          break;
        }
        case CURL_POLL_REMOVE:
          if (socket_context != nullptr)
          {
            LOG_DEBUG_FMT(
              "CurlmLibuv: curl socket callback: remove socket {}",
              static_cast<int>(s));
            SocketContext socket_context_ptr(socket_context);
            uv_poll_stop(&socket_context->uv_handle);
            CHECK_CURL_MULTI(
              curl_multi_assign, self->curl_request_curlm, s, nullptr);
          }
          break;
        default:
          throw std::runtime_error("Unknown action in curl_socket_callback");
      }
      return 0;
    }
 
    CurlmLibuvContextImpl(uv_loop_t* loop) : loop(loop)
    {
      uv_timer_init(loop, &uv_handle);
      uv_handle.data = this; // Attach this instance to the timer
 
      uv_async_init(loop, &async_requests_handle, async_requests_callback);
      async_requests_handle.data = this;
      uv_unref(reinterpret_cast<uv_handle_t*>(
        &async_requests_handle)); // allow the loop to exit if this is the only
                                  // active handle
 
      // attach timeouts
      CHECK_CURL_MULTI(
        curl_multi_setopt, curl_request_curlm, CURLMOPT_TIMERDATA, this);
      CHECK_CURL_MULTI(
        curl_multi_setopt,
        curl_request_curlm,
        CURLMOPT_TIMERFUNCTION,
        curl_timeout_callback);
 
      // attach socket events
      CHECK_CURL_MULTI(
        curl_multi_setopt, curl_request_curlm, CURLMOPT_SOCKETDATA, this);
      CHECK_CURL_MULTI(
        curl_multi_setopt,
        curl_request_curlm,
        CURLMOPT_SOCKETFUNCTION,
        curl_socket_callback);
    }
 
    void attach_request(std::unique_ptr<CurlRequest>&& request)
    {
      if (is_stopping)
      {
        LOG_FAIL_FMT("CurlmLibuvContext already closed, cannot attach request");
        return;
      }
      LOG_DEBUG_FMT("Adding request to {} to queue", request->get_url());
      std::lock_guard<std::mutex> requests_lock(requests_mutex);
      pending_requests.push_back(std::move(request));
      uv_async_send(&async_requests_handle);
    }
 
  private:
    // Interface to allow the proxy pointer to close and delete this safely
    // Make the templated asynchost::close_ptr a friend so it can call close()
    template <typename T>
    friend class ::asynchost::close_ptr;
    size_t closed_uv_handle_count = 0;
 
    // called by the close_ptr within the destructor of the proxy_ptr
    void close()
    {
      LOG_TRACE_FMT("Closing CurlmLibuvContext");
 
      // Prevent multiple close calls
      if (is_stopping)
      {
        LOG_INFO_FMT(
          "CurlmLibuvContext already closed, nothing to stop or remove");
        return;
      }
      is_stopping = true;
 
      // remove, stop and cleanup all curl easy handles
      std::unique_ptr<CURL*, void (*)(CURL**)> easy_handles(
        curl_multi_get_handles(curl_request_curlm),
        // NOLINTNEXTLINE(bugprone-multi-level-implicit-pointer-conversion)
        [](CURL** handles) { curl_free(static_cast<void*>(handles)); });
      // curl_multi_get_handles returns the handles as a null-terminated array
      for (size_t i = 0; easy_handles.get()[i] != nullptr; ++i)
      {
        auto* easy = easy_handles.get()[i];
        curl_multi_remove_handle(curl_request_curlm, easy);
        if (easy != nullptr)
        {
          // attach a lifetime to the request
          ccf::curl::CurlRequest* request = nullptr;
          curl_easy_getinfo(easy, CURLINFO_PRIVATE, &request);
          if (request == nullptr)
          {
            LOG_FAIL_FMT(
              "CURLMSG_DONE received with no associated request data");
          }
          std::unique_ptr<ccf::curl::CurlRequest> request_data_ptr(request);
          curl_easy_cleanup(easy);
        }
      }
      // Drain the deque rather than letting it destruct
      std::deque<std::unique_ptr<CurlRequest>> requests_to_cleanup;
      {
        std::lock_guard<std::mutex> requests_lock(requests_mutex);
        requests_to_cleanup.swap(pending_requests);
      }
      // Dispatch uv_close to asynchronously close the timer handle
      uv_close(
        reinterpret_cast<uv_handle_t*>(&async_requests_handle), on_close);
      uv_close(reinterpret_cast<uv_handle_t*>(&uv_handle), on_close);
    }
    static void on_close(uv_handle_t* handle)
    {
      auto& close_count = static_cast<CurlmLibuvContextImpl*>(handle->data)
                            ->closed_uv_handle_count;
      close_count++;
      if (close_count >= 2)
      {
        static_cast<CurlmLibuvContextImpl*>(handle->data)->on_close();
      }
    }
    void on_close()
    {
      // We are being notified asynchronously that libuv has finished closing
      delete this;
    }
  };
 
  // Required destructor sequence triggered by proxy_ptr calling close
  // 1. Detach CURLM handle from this object and clean up all easy handles.
  //    Detaching prevents new easy handles being added.
  //    curl_multi_cleanup detaches all sockets from libuv
  // 2. Close the libuv timer handle.
  //    Prevents any further callbacks from the libuv timer
  // 3. Delete CurlmLibuvContextImpl via the on_close callback
  using CurlmLibuvContext = asynchost::proxy_ptr<CurlmLibuvContextImpl>;
 
  class CurlmLibuvContextSingleton
  {
  private:
    static std::unique_ptr<CurlmLibuvContext>& instance()
    {
      static std::unique_ptr<CurlmLibuvContext> curlm_libuv_context_instance =
        nullptr;
      return curlm_libuv_context_instance;
    }
 
  public:
    static CurlmLibuvContext& get_instance()
    {
      if (instance() == nullptr)
      {
        throw std::logic_error(
          "CurlmLibuvContextSingleton instance not initialized");
      }
      return *instance();
    }
    CurlmLibuvContextSingleton(uv_loop_t* loop)
    {
      if (instance() != nullptr)
      {
        throw std::logic_error(
          "CurlmLibuvContextSingleton instance already initialized");
      }
      instance() = std::make_unique<CurlmLibuvContext>(loop);
    }
    ~CurlmLibuvContextSingleton()
    {
      instance().reset(); // Clean up the instance
    }
 
    CurlmLibuvContextSingleton(const CurlmLibuvContextSingleton&) = delete;
    CurlmLibuvContextSingleton& operator=(const CurlmLibuvContextSingleton&) =
      delete;
    CurlmLibuvContextSingleton(CurlmLibuvContextSingleton&&) = default;
    CurlmLibuvContextSingleton& operator=(CurlmLibuvContextSingleton&&) =
      default;
  };
} // namespace ccf::curl