http_util.h

Go to the documentation of this file.

/*
* HTTP utilities
* (C) 2013 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
 
#ifndef BOTAN_UTILS_URLGET_H_
#define BOTAN_UTILS_URLGET_H_
 
#include <botan/exceptn.h>
#include <botan/types.h>
#include <chrono>
#include <functional>
#include <map>
#include <string>
#include <vector>
 
namespace Botan::HTTP {
 
/**
* HTTP_Error Exception
*/
class HTTP_Error final : public Exception {
   public:
      explicit HTTP_Error(const std::string& msg) : Exception("HTTP error " + msg) {}
 
      ErrorType error_type() const noexcept override { return ErrorType::HttpError; }
};
 
class Response final {
   public:
      Response() : m_status_code(0), m_status_message("Uninitialized") {}
 
      Response(unsigned int status_code,
               std::string_view status_message,
               const std::vector<uint8_t>& body,
               const std::map<std::string, std::string>& headers) :
            m_status_code(status_code), m_status_message(status_message), m_body(body), m_headers(headers) {}
 
      unsigned int status_code() const { return m_status_code; }
 
      const std::vector<uint8_t>& body() const { return m_body; }
 
      const std::map<std::string, std::string>& headers() const { return m_headers; }
 
      std::string status_message() const { return m_status_message; }
 
      void throw_unless_ok() const {
         if(status_code() != 200) {
            throw HTTP_Error(status_message());
         }
      }
 
   private:
      unsigned int m_status_code;
      std::string m_status_message;
      std::vector<uint8_t> m_body;
      std::map<std::string, std::string> m_headers;
};
 
BOTAN_TEST_API std::ostream& operator<<(std::ostream& o, const Response& resp);
 
typedef std::function<std::string(std::string_view, std::string_view, std::string_view)> http_exch_fn;
 
Response http_sync(const http_exch_fn& fn,
                   std::string_view verb,
                   std::string_view url,
                   std::string_view content_type,
                   const std::vector<uint8_t>& body,
                   size_t allowable_redirects);
 
Response http_sync(std::string_view verb,
                   std::string_view url,
                   std::string_view content_type,
                   const std::vector<uint8_t>& body,
                   size_t allowable_redirects,
                   std::chrono::milliseconds timeout = std::chrono::milliseconds(3000));
 
Response BOTAN_TEST_API GET_sync(std::string_view url,
                                 size_t allowable_redirects = 1,
                                 std::chrono::milliseconds timeout = std::chrono::milliseconds(3000));
 
Response POST_sync(std::string_view url,
                   std::string_view content_type,
                   const std::vector<uint8_t>& body,
                   size_t allowable_redirects = 1,
                   std::chrono::milliseconds timeout = std::chrono::milliseconds(3000));
 
std::string url_encode(std::string_view url);
 
}  // namespace Botan::HTTP
 
#endif