From 3c62153322a51669e17bbfb2015565bd53b56878 Mon Sep 17 00:00:00 2001 From: plenarius Date: Fri, 15 Jan 2021 15:43:16 -0500 Subject: [PATCH 01/19] New Plugin: HTTP Client and Server --- CHANGELOG.md | 1 + Plugins/HTTP/CMakeLists.txt | 8 + Plugins/HTTP/External/httplib.h | 7066 ++++++++++++++++++++++ Plugins/HTTP/HTTP.cpp | 42 + Plugins/HTTP/HTTP.hpp | 61 + Plugins/HTTP/HTTP/Client.cpp | 242 + Plugins/HTTP/HTTP/Client.hpp | 59 + Plugins/HTTP/HTTP/RPC.cpp | 128 + Plugins/HTTP/HTTP/RPC.hpp | 25 + Plugins/HTTP/HTTP/Server.cpp | 188 + Plugins/HTTP/HTTP/Server.hpp | 52 + Plugins/HTTP/NWScript/nwnx_http.nss | 134 + Plugins/HTTP/NWScript/nwnx_http_json.nss | 322 + Plugins/HTTP/README.md | 231 + 14 files changed, 8559 insertions(+) create mode 100644 Plugins/HTTP/CMakeLists.txt create mode 100644 Plugins/HTTP/External/httplib.h create mode 100644 Plugins/HTTP/HTTP.cpp create mode 100644 Plugins/HTTP/HTTP.hpp create mode 100644 Plugins/HTTP/HTTP/Client.cpp create mode 100644 Plugins/HTTP/HTTP/Client.hpp create mode 100644 Plugins/HTTP/HTTP/RPC.cpp create mode 100644 Plugins/HTTP/HTTP/RPC.hpp create mode 100644 Plugins/HTTP/HTTP/Server.cpp create mode 100644 Plugins/HTTP/HTTP/Server.hpp create mode 100644 Plugins/HTTP/NWScript/nwnx_http.nss create mode 100644 Plugins/HTTP/NWScript/nwnx_http_json.nss create mode 100644 Plugins/HTTP/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a93fda1455..abc013538a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ https://github.com/nwnxee/unified/compare/build8193.20...HEAD - Tweaks: added `NWNX_TWEAKS_DISPLAY_NUM_ATTACKS_OVERRIDE_IN_CHARACTER_SHEET` to display the correct amount of attacks per round on the character sheet when overridden with SetBaseAttackBonus() ##### New Plugins +- HTTP: Server and client functionality. - SWIG: Native Interop support added for DotNET. ##### New NWScript Functions diff --git a/Plugins/HTTP/CMakeLists.txt b/Plugins/HTTP/CMakeLists.txt new file mode 100644 index 00000000000..0a56611ea10 --- /dev/null +++ b/Plugins/HTTP/CMakeLists.txt @@ -0,0 +1,8 @@ +find_package(OpenSSL) + +if (${OPENSSL_FOUND}) + add_plugin(HTTP HTTP.cpp HTTP/Client.cpp HTTP/Server.cpp HTTP/RPC.cpp) + add_definitions(-DCPPHTTPLIB_OPENSSL_SUPPORT) + target_link_libraries(HTTP ${OPENSSL_LIBRARIES}) + target_include_directories(HTTP PUBLIC ${OPENSSL_INCLUDE_DIR}) +endif() diff --git a/Plugins/HTTP/External/httplib.h b/Plugins/HTTP/External/httplib.h new file mode 100644 index 00000000000..39af3b8070f --- /dev/null +++ b/Plugins/HTTP/External/httplib.h @@ -0,0 +1,7066 @@ +// +// httplib.h +// +// Copyright (c) 2020 Yuji Hirose. All rights reserved. +// MIT License +// + +#ifndef CPPHTTPLIB_HTTPLIB_H +#define CPPHTTPLIB_HTTPLIB_H + +/* + * Configuration + */ + +#ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND +#define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5 +#endif + +#ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT +#define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 5 +#endif + +#ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND +#define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300 +#endif + +#ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND +#define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0 +#endif + +#ifndef CPPHTTPLIB_READ_TIMEOUT_SECOND +#define CPPHTTPLIB_READ_TIMEOUT_SECOND 5 +#endif + +#ifndef CPPHTTPLIB_READ_TIMEOUT_USECOND +#define CPPHTTPLIB_READ_TIMEOUT_USECOND 0 +#endif + +#ifndef CPPHTTPLIB_WRITE_TIMEOUT_SECOND +#define CPPHTTPLIB_WRITE_TIMEOUT_SECOND 5 +#endif + +#ifndef CPPHTTPLIB_WRITE_TIMEOUT_USECOND +#define CPPHTTPLIB_WRITE_TIMEOUT_USECOND 0 +#endif + +#ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND +#define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0 +#endif + +#ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND +#ifdef _WIN32 +#define CPPHTTPLIB_IDLE_INTERVAL_USECOND 10000 +#else +#define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0 +#endif +#endif + +#ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH +#define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192 +#endif + +#ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT +#define CPPHTTPLIB_REDIRECT_MAX_COUNT 20 +#endif + +#ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH +#define CPPHTTPLIB_PAYLOAD_MAX_LENGTH ((std::numeric_limits::max)()) +#endif + +#ifndef CPPHTTPLIB_TCP_NODELAY +#define CPPHTTPLIB_TCP_NODELAY false +#endif + +#ifndef CPPHTTPLIB_RECV_BUFSIZ +#define CPPHTTPLIB_RECV_BUFSIZ size_t(4096u) +#endif + +#ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ +#define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u) +#endif + +#ifndef CPPHTTPLIB_THREAD_POOL_COUNT +#define CPPHTTPLIB_THREAD_POOL_COUNT \ + ((std::max)(8u, std::thread::hardware_concurrency() > 0 \ + ? std::thread::hardware_concurrency() - 1 \ + : 0)) +#endif + +#ifndef CPPHTTPLIB_RECV_FLAGS +#define CPPHTTPLIB_RECV_FLAGS 0 +#endif + +#ifndef CPPHTTPLIB_SEND_FLAGS +#define CPPHTTPLIB_SEND_FLAGS 0 +#endif + +/* + * Headers + */ + +#ifdef _WIN32 +#ifndef _CRT_SECURE_NO_WARNINGS +#define _CRT_SECURE_NO_WARNINGS +#endif //_CRT_SECURE_NO_WARNINGS + +#ifndef _CRT_NONSTDC_NO_DEPRECATE +#define _CRT_NONSTDC_NO_DEPRECATE +#endif //_CRT_NONSTDC_NO_DEPRECATE + +#if defined(_MSC_VER) +#ifdef _WIN64 +using ssize_t = __int64; +#else +using ssize_t = int; +#endif + +#if _MSC_VER < 1900 +#define snprintf _snprintf_s +#endif +#endif // _MSC_VER + +#ifndef S_ISREG +#define S_ISREG(m) (((m)&S_IFREG) == S_IFREG) +#endif // S_ISREG + +#ifndef S_ISDIR +#define S_ISDIR(m) (((m)&S_IFDIR) == S_IFDIR) +#endif // S_ISDIR + +#ifndef NOMINMAX +#define NOMINMAX +#endif // NOMINMAX + +#include +#include + +#include +#include + +#ifndef WSA_FLAG_NO_HANDLE_INHERIT +#define WSA_FLAG_NO_HANDLE_INHERIT 0x80 +#endif + +#ifdef _MSC_VER +#pragma comment(lib, "ws2_32.lib") +#pragma comment(lib, "crypt32.lib") +#pragma comment(lib, "cryptui.lib") +#endif + +#ifndef strcasecmp +#define strcasecmp _stricmp +#endif // strcasecmp + +using socket_t = SOCKET; +#ifdef CPPHTTPLIB_USE_POLL +#define poll(fds, nfds, timeout) WSAPoll(fds, nfds, timeout) +#endif + +#else // not _WIN32 + +#include +#include +#include +#include +#include +#ifdef __linux__ +#include +#endif +#include +#ifdef CPPHTTPLIB_USE_POLL +#include +#endif +#include +#include +#include +#include +#include + +using socket_t = int; +#define INVALID_SOCKET (-1) +#endif //_WIN32 + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +#include +#include +#include +#include + +#if defined(_WIN32) && defined(OPENSSL_USE_APPLINK) +#include +#endif + +#include +#include + +#if OPENSSL_VERSION_NUMBER < 0x1010100fL +#error Sorry, OpenSSL versions prior to 1.1.1 are not supported +#endif + +#if OPENSSL_VERSION_NUMBER < 0x10100000L +#include +inline const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *asn1) { + return M_ASN1_STRING_data(asn1); +} +#endif +#endif + +#ifdef CPPHTTPLIB_ZLIB_SUPPORT +#include +#endif + +#ifdef CPPHTTPLIB_BROTLI_SUPPORT +#include +#include +#endif + +/* + * Declaration + */ +namespace httplib { + +namespace detail { + +/* + * Backport std::make_unique from C++14. + * + * NOTE: This code came up with the following stackoverflow post: + * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique + * + */ + +template +typename std::enable_if::value, std::unique_ptr>::type +make_unique(Args &&... args) { + return std::unique_ptr(new T(std::forward(args)...)); +} + +template +typename std::enable_if::value, std::unique_ptr>::type +make_unique(std::size_t n) { + typedef typename std::remove_extent::type RT; + return std::unique_ptr(new RT[n]); +} + +struct ci { + bool operator()(const std::string &s1, const std::string &s2) const { + return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), + s2.end(), + [](unsigned char c1, unsigned char c2) { + return ::tolower(c1) < ::tolower(c2); + }); + } +}; + +} // namespace detail + +using Headers = std::multimap; + +using Params = std::multimap; +using Match = std::smatch; + +using Progress = std::function; + +struct Response; +using ResponseHandler = std::function; + +struct MultipartFormData { + std::string name; + std::string content; + std::string filename; + std::string content_type; +}; +using MultipartFormDataItems = std::vector; +using MultipartFormDataMap = std::multimap; + +class DataSink { +public: + DataSink() : os(&sb_), sb_(*this) {} + + DataSink(const DataSink &) = delete; + DataSink &operator=(const DataSink &) = delete; + DataSink(DataSink &&) = delete; + DataSink &operator=(DataSink &&) = delete; + + std::function write; + std::function done; + std::function is_writable; + std::ostream os; + +private: + class data_sink_streambuf : public std::streambuf { + public: + explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {} + + protected: + std::streamsize xsputn(const char *s, std::streamsize n) { + sink_.write(s, static_cast(n)); + return n; + } + + private: + DataSink &sink_; + }; + + data_sink_streambuf sb_; +}; + +using ContentProvider = + std::function; + +using ContentProviderWithoutLength = + std::function; + +using ContentReceiverWithProgress = + std::function; + +using ContentReceiver = + std::function; + +using MultipartContentHeader = + std::function; + +class ContentReader { +public: + using Reader = std::function; + using MultipartReader = std::function; + + ContentReader(Reader reader, MultipartReader multipart_reader) + : reader_(std::move(reader)), + multipart_reader_(std::move(multipart_reader)) {} + + bool operator()(MultipartContentHeader header, + ContentReceiver receiver) const { + return multipart_reader_(std::move(header), std::move(receiver)); + } + + bool operator()(ContentReceiver receiver) const { + return reader_(std::move(receiver)); + } + + Reader reader_; + MultipartReader multipart_reader_; +}; + +using Range = std::pair; +using Ranges = std::vector; + +struct Request { + std::string method; + std::string path; + Headers headers; + std::string body; + + std::string remote_addr; + int remote_port = -1; + + // for server + std::string version; + std::string target; + Params params; + MultipartFormDataMap files; + Ranges ranges; + Match matches; + + // for client +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + const SSL *ssl; +#endif + + bool has_header(const char *key) const; + std::string get_header_value(const char *key, size_t id = 0) const; + template + T get_header_value(const char *key, size_t id = 0) const; + size_t get_header_value_count(const char *key) const; + void set_header(const char *key, const char *val); + void set_header(const char *key, const std::string &val); + + bool has_param(const char *key) const; + std::string get_param_value(const char *key, size_t id = 0) const; + size_t get_param_value_count(const char *key) const; + + bool is_multipart_form_data() const; + + bool has_file(const char *key) const; + MultipartFormData get_file_value(const char *key) const; + + // private members... + size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT; + ResponseHandler response_handler_; + ContentReceiverWithProgress content_receiver_; + size_t content_length_ = 0; + ContentProvider content_provider_; + bool is_chunked_content_provider_ = false; + Progress progress_; + size_t authorization_count_ = 0; +}; + +struct Response { + std::string version; + int status = -1; + std::string reason; + Headers headers; + std::string body; + std::string location; // Redirect location + + bool has_header(const char *key) const; + std::string get_header_value(const char *key, size_t id = 0) const; + template + T get_header_value(const char *key, size_t id = 0) const; + size_t get_header_value_count(const char *key) const; + void set_header(const char *key, const char *val); + void set_header(const char *key, const std::string &val); + + void set_redirect(const char *url, int status = 302); + void set_redirect(const std::string &url, int status = 302); + void set_content(const char *s, size_t n, const char *content_type); + void set_content(const std::string &s, const char *content_type); + + void set_content_provider( + size_t length, const char *content_type, ContentProvider provider, + const std::function &resource_releaser = nullptr); + + void set_content_provider( + const char *content_type, ContentProviderWithoutLength provider, + const std::function &resource_releaser = nullptr); + + void set_chunked_content_provider( + const char *content_type, ContentProviderWithoutLength provider, + const std::function &resource_releaser = nullptr); + + Response() = default; + Response(const Response &) = default; + Response &operator=(const Response &) = default; + Response(Response &&) = default; + Response &operator=(Response &&) = default; + ~Response() { + if (content_provider_resource_releaser_) { + content_provider_resource_releaser_(); + } + } + + // private members... + size_t content_length_ = 0; + ContentProvider content_provider_; + std::function content_provider_resource_releaser_; + bool is_chunked_content_provider_ = false; +}; + +class Stream { +public: + virtual ~Stream() = default; + + virtual bool is_readable() const = 0; + virtual bool is_writable() const = 0; + + virtual ssize_t read(char *ptr, size_t size) = 0; + virtual ssize_t write(const char *ptr, size_t size) = 0; + virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0; + virtual socket_t socket() const = 0; + + template + ssize_t write_format(const char *fmt, const Args &... args); + ssize_t write(const char *ptr); + ssize_t write(const std::string &s); +}; + +class TaskQueue { +public: + TaskQueue() = default; + virtual ~TaskQueue() = default; + + virtual void enqueue(std::function fn) = 0; + virtual void shutdown() = 0; + + virtual void on_idle(){}; +}; + +class ThreadPool : public TaskQueue { +public: + explicit ThreadPool(size_t n) : shutdown_(false) { + while (n) { + threads_.emplace_back(worker(*this)); + n--; + } + } + + ThreadPool(const ThreadPool &) = delete; + ~ThreadPool() override = default; + + void enqueue(std::function fn) override { + std::unique_lock lock(mutex_); + jobs_.push_back(std::move(fn)); + cond_.notify_one(); + } + + void shutdown() override { + // Stop all worker threads... + { + std::unique_lock lock(mutex_); + shutdown_ = true; + } + + cond_.notify_all(); + + // Join... + for (auto &t : threads_) { + t.join(); + } + } + +private: + struct worker { + explicit worker(ThreadPool &pool) : pool_(pool) {} + + void operator()() { + for (;;) { + std::function fn; + { + std::unique_lock lock(pool_.mutex_); + + pool_.cond_.wait( + lock, [&] { return !pool_.jobs_.empty() || pool_.shutdown_; }); + + if (pool_.shutdown_ && pool_.jobs_.empty()) { break; } + + fn = pool_.jobs_.front(); + pool_.jobs_.pop_front(); + } + + assert(true == static_cast(fn)); + fn(); + } + } + + ThreadPool &pool_; + }; + friend struct worker; + + std::vector threads_; + std::list> jobs_; + + bool shutdown_; + + std::condition_variable cond_; + std::mutex mutex_; +}; + +using Logger = std::function; + +using SocketOptions = std::function; + +inline void default_socket_options(socket_t sock) { + int yes = 1; +#ifdef _WIN32 + setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast(&yes), + sizeof(yes)); + setsockopt(sock, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, + reinterpret_cast(&yes), sizeof(yes)); +#else +#ifdef SO_REUSEPORT + setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, reinterpret_cast(&yes), + sizeof(yes)); +#else + setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast(&yes), + sizeof(yes)); +#endif +#endif +} + +class Server { +public: + using Handler = std::function; + using HandlerWithContentReader = std::function; + using Expect100ContinueHandler = + std::function; + + Server(); + + virtual ~Server(); + + virtual bool is_valid() const; + + Server &Get(const char *pattern, Handler handler); + Server &Post(const char *pattern, Handler handler); + Server &Post(const char *pattern, HandlerWithContentReader handler); + Server &Put(const char *pattern, Handler handler); + Server &Put(const char *pattern, HandlerWithContentReader handler); + Server &Patch(const char *pattern, Handler handler); + Server &Patch(const char *pattern, HandlerWithContentReader handler); + Server &Delete(const char *pattern, Handler handler); + Server &Delete(const char *pattern, HandlerWithContentReader handler); + Server &Options(const char *pattern, Handler handler); + + bool set_base_dir(const char *dir, const char *mount_point = nullptr); + bool set_mount_point(const char *mount_point, const char *dir, + Headers headers = Headers()); + bool remove_mount_point(const char *mount_point); + void set_file_extension_and_mimetype_mapping(const char *ext, + const char *mime); + void set_file_request_handler(Handler handler); + + void set_error_handler(Handler handler); + void set_expect_100_continue_handler(Expect100ContinueHandler handler); + void set_logger(Logger logger); + + void set_tcp_nodelay(bool on); + void set_socket_options(SocketOptions socket_options); + + void set_keep_alive_max_count(size_t count); + void set_keep_alive_timeout(time_t sec); + void set_read_timeout(time_t sec, time_t usec = 0); + void set_write_timeout(time_t sec, time_t usec = 0); + void set_idle_interval(time_t sec, time_t usec = 0); + + void set_payload_max_length(size_t length); + + bool bind_to_port(const char *host, int port, int socket_flags = 0); + int bind_to_any_port(const char *host, int socket_flags = 0); + bool listen_after_bind(); + + bool listen(const char *host, int port, int socket_flags = 0); + + bool is_running() const; + void stop(); + + std::function new_task_queue; + +protected: + bool process_request(Stream &strm, bool close_connection, + bool &connection_closed, + const std::function &setup_request); + + std::atomic svr_sock_; + size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT; + time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND; + time_t read_timeout_sec_ = CPPHTTPLIB_READ_TIMEOUT_SECOND; + time_t read_timeout_usec_ = CPPHTTPLIB_READ_TIMEOUT_USECOND; + time_t write_timeout_sec_ = CPPHTTPLIB_WRITE_TIMEOUT_SECOND; + time_t write_timeout_usec_ = CPPHTTPLIB_WRITE_TIMEOUT_USECOND; + time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND; + time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND; + size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH; + +private: + using Handlers = std::vector>; + using HandlersForContentReader = + std::vector>; + + socket_t create_server_socket(const char *host, int port, int socket_flags, + SocketOptions socket_options) const; + int bind_internal(const char *host, int port, int socket_flags); + bool listen_internal(); + + bool routing(Request &req, Response &res, Stream &strm); + bool handle_file_request(Request &req, Response &res, bool head = false); + bool dispatch_request(Request &req, Response &res, const Handlers &handlers); + bool + dispatch_request_for_content_reader(Request &req, Response &res, + ContentReader content_reader, + const HandlersForContentReader &handlers); + + bool parse_request_line(const char *s, Request &req); + void apply_ranges(const Request &req, Response &res, + std::string &content_type, std::string &boundary); + bool write_response(Stream &strm, bool close_connection, const Request &req, + Response &res); + bool write_response_with_content(Stream &strm, bool close_connection, + const Request &req, Response &res); + bool write_response_core(Stream &strm, bool close_connection, + const Request &req, Response &res, + bool need_apply_ranges); + bool write_content_with_provider(Stream &strm, const Request &req, + Response &res, const std::string &boundary, + const std::string &content_type); + bool read_content(Stream &strm, Request &req, Response &res); + bool + read_content_with_content_receiver(Stream &strm, Request &req, Response &res, + ContentReceiver receiver, + MultipartContentHeader multipart_header, + ContentReceiver multipart_receiver); + bool read_content_core(Stream &strm, Request &req, Response &res, + ContentReceiver receiver, + MultipartContentHeader mulitpart_header, + ContentReceiver multipart_receiver); + + virtual bool process_and_close_socket(socket_t sock); + + struct MountPointEntry { + std::string mount_point; + std::string base_dir; + Headers headers; + }; + std::vector base_dirs_; + + std::atomic is_running_; + std::map file_extension_and_mimetype_map_; + Handler file_request_handler_; + Handlers get_handlers_; + Handlers post_handlers_; + HandlersForContentReader post_handlers_for_content_reader_; + Handlers put_handlers_; + HandlersForContentReader put_handlers_for_content_reader_; + Handlers patch_handlers_; + HandlersForContentReader patch_handlers_for_content_reader_; + Handlers delete_handlers_; + HandlersForContentReader delete_handlers_for_content_reader_; + Handlers options_handlers_; + Handler error_handler_; + Logger logger_; + Expect100ContinueHandler expect_100_continue_handler_; + + bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY; + SocketOptions socket_options_ = default_socket_options; +}; + +enum Error { + Success = 0, + Unknown, + Connection, + BindIPAddress, + Read, + Write, + ExceedRedirectCount, + Canceled, + SSLConnection, + SSLLoadingCerts, + SSLServerVerification, + UnsupportedMultipartBoundaryChars, + Compression, +}; + +class Result { +public: + Result(std::unique_ptr res, Error err) + : res_(std::move(res)), err_(err) {} + operator bool() const { return res_ != nullptr; } + bool operator==(std::nullptr_t) const { return res_ == nullptr; } + bool operator!=(std::nullptr_t) const { return res_ != nullptr; } + const Response &value() const { return *res_; } + Response &value() { return *res_; } + const Response &operator*() const { return *res_; } + Response &operator*() { return *res_; } + const Response *operator->() const { return res_.get(); } + Response *operator->() { return res_.get(); } + Error error() const { return err_; } + +private: + std::unique_ptr res_; + Error err_; +}; + +class ClientImpl { +public: + explicit ClientImpl(const std::string &host); + + explicit ClientImpl(const std::string &host, int port); + + explicit ClientImpl(const std::string &host, int port, + const std::string &client_cert_path, + const std::string &client_key_path); + + virtual ~ClientImpl(); + + virtual bool is_valid() const; + + Result Get(const char *path); + Result Get(const char *path, const Headers &headers); + Result Get(const char *path, Progress progress); + Result Get(const char *path, const Headers &headers, Progress progress); + Result Get(const char *path, ContentReceiver content_receiver); + Result Get(const char *path, const Headers &headers, + ContentReceiver content_receiver); + Result Get(const char *path, ContentReceiver content_receiver, + Progress progress); + Result Get(const char *path, const Headers &headers, + ContentReceiver content_receiver, Progress progress); + Result Get(const char *path, ResponseHandler response_handler, + ContentReceiver content_receiver); + Result Get(const char *path, const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver); + Result Get(const char *path, ResponseHandler response_handler, + ContentReceiver content_receiver, Progress progress); + Result Get(const char *path, const Headers &headers, + ResponseHandler response_handler, ContentReceiver content_receiver, + Progress progress); + + Result Head(const char *path); + Result Head(const char *path, const Headers &headers); + + Result Post(const char *path); + Result Post(const char *path, const std::string &body, + const char *content_type); + Result Post(const char *path, const Headers &headers, const std::string &body, + const char *content_type); + Result Post(const char *path, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Post(const char *path, ContentProviderWithoutLength content_provider, + const char *content_type); + Result Post(const char *path, const Headers &headers, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Post(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type); + Result Post(const char *path, const Params ¶ms); + Result Post(const char *path, const Headers &headers, const Params ¶ms); + Result Post(const char *path, const MultipartFormDataItems &items); + Result Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items); + Result Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items, const std::string &boundary); + + Result Put(const char *path); + Result Put(const char *path, const std::string &body, + const char *content_type); + Result Put(const char *path, const Headers &headers, const std::string &body, + const char *content_type); + Result Put(const char *path, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Put(const char *path, ContentProviderWithoutLength content_provider, + const char *content_type); + Result Put(const char *path, const Headers &headers, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Put(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type); + Result Put(const char *path, const Params ¶ms); + Result Put(const char *path, const Headers &headers, const Params ¶ms); + + Result Patch(const char *path, const std::string &body, + const char *content_type); + Result Patch(const char *path, const Headers &headers, + const std::string &body, const char *content_type); + Result Patch(const char *path, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Patch(const char *path, ContentProviderWithoutLength content_provider, + const char *content_type); + Result Patch(const char *path, const Headers &headers, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Patch(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type); + + Result Delete(const char *path); + Result Delete(const char *path, const std::string &body, + const char *content_type); + Result Delete(const char *path, const Headers &headers); + Result Delete(const char *path, const Headers &headers, + const std::string &body, const char *content_type); + + Result Options(const char *path); + Result Options(const char *path, const Headers &headers); + + bool send(const Request &req, Response &res, Error &error); + Result send(const Request &req); + + size_t is_socket_open() const; + + void stop(); + + void set_default_headers(Headers headers); + + void set_tcp_nodelay(bool on); + void set_socket_options(SocketOptions socket_options); + + void set_connection_timeout(time_t sec, time_t usec = 0); + void set_read_timeout(time_t sec, time_t usec = 0); + void set_write_timeout(time_t sec, time_t usec = 0); + + void set_basic_auth(const char *username, const char *password); + void set_bearer_token_auth(const char *token); +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void set_digest_auth(const char *username, const char *password); +#endif + + void set_keep_alive(bool on); + void set_follow_location(bool on); + + void set_compress(bool on); + + void set_decompress(bool on); + + void set_interface(const char *intf); + + void set_proxy(const char *host, int port); + void set_proxy_basic_auth(const char *username, const char *password); + void set_proxy_bearer_token_auth(const char *token); +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void set_proxy_digest_auth(const char *username, const char *password); +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void enable_server_certificate_verification(bool enabled); +#endif + + void set_logger(Logger logger); + +protected: + struct Socket { + socket_t sock = INVALID_SOCKET; +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + SSL *ssl = nullptr; +#endif + + bool is_open() const { return sock != INVALID_SOCKET; } + }; + + virtual bool create_and_connect_socket(Socket &socket, Error &error); + + // All of: + // shutdown_ssl + // shutdown_socket + // close_socket + // should ONLY be called when socket_mutex_ is locked. + // Also, shutdown_ssl and close_socket should also NOT be called concurrently + // with a DIFFERENT thread sending requests using that socket. + virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully); + void shutdown_socket(Socket &socket); + void close_socket(Socket &socket); + + // Similar to shutdown_ssl and close_socket, this should NOT be called + // concurrently with a DIFFERENT thread sending requests from the socket + void lock_socket_and_shutdown_and_close(); + + bool process_request(Stream &strm, const Request &req, Response &res, + bool close_connection, Error &error); + + bool write_content_with_provider(Stream &strm, const Request &req, + Error &error); + + void copy_settings(const ClientImpl &rhs); + + // Socket endoint information + const std::string host_; + const int port_; + const std::string host_and_port_; + + // Current open socket + Socket socket_; + mutable std::mutex socket_mutex_; + std::recursive_mutex request_mutex_; + + // These are all protected under socket_mutex + size_t socket_requests_in_flight_ = 0; + std::thread::id socket_requests_are_from_thread_ = std::thread::id(); + bool socket_should_be_closed_when_request_is_done_ = false; + + // Default headers + Headers default_headers_; + + // Settings + std::string client_cert_path_; + std::string client_key_path_; + + time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND; + time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND; + time_t read_timeout_sec_ = CPPHTTPLIB_READ_TIMEOUT_SECOND; + time_t read_timeout_usec_ = CPPHTTPLIB_READ_TIMEOUT_USECOND; + time_t write_timeout_sec_ = CPPHTTPLIB_WRITE_TIMEOUT_SECOND; + time_t write_timeout_usec_ = CPPHTTPLIB_WRITE_TIMEOUT_USECOND; + + std::string basic_auth_username_; + std::string basic_auth_password_; + std::string bearer_token_auth_token_; +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + std::string digest_auth_username_; + std::string digest_auth_password_; +#endif + + bool keep_alive_ = false; + bool follow_location_ = false; + + bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY; + SocketOptions socket_options_ = nullptr; + + bool compress_ = false; + bool decompress_ = true; + + std::string interface_; + + std::string proxy_host_; + int proxy_port_ = -1; + + std::string proxy_basic_auth_username_; + std::string proxy_basic_auth_password_; + std::string proxy_bearer_token_auth_token_; +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + std::string proxy_digest_auth_username_; + std::string proxy_digest_auth_password_; +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + bool server_certificate_verification_ = false; +#endif + + Logger logger_; + +private: + socket_t create_client_socket(Error &error) const; + bool read_response_line(Stream &strm, const Request &req, Response &res); + bool write_request(Stream &strm, const Request &req, bool close_connection, + Error &error); + bool redirect(const Request &req, Response &res, Error &error); + bool handle_request(Stream &strm, const Request &req, Response &res, + bool close_connection, Error &error); + std::unique_ptr send_with_content_provider( + const char *method, const char *path, const Headers &headers, + const std::string &body, size_t content_length, + ContentProvider content_provider, + ContentProviderWithoutLength content_provider_without_length, + const char *content_type, Error &error); + Result send_with_content_provider( + const char *method, const char *path, const Headers &headers, + const std::string &body, size_t content_length, + ContentProvider content_provider, + ContentProviderWithoutLength content_provider_without_length, + const char *content_type); + + virtual bool process_socket(const Socket &socket, + std::function callback); + virtual bool is_ssl() const; +}; + +class Client { +public: + // Universal interface + explicit Client(const char *scheme_host_port); + + explicit Client(const char *scheme_host_port, + const std::string &client_cert_path, + const std::string &client_key_path); + + // HTTP only interface + explicit Client(const std::string &host, int port); + + explicit Client(const std::string &host, int port, + const std::string &client_cert_path, + const std::string &client_key_path); + + ~Client(); + + bool is_valid() const; + + Result Get(const char *path); + Result Get(const char *path, const Headers &headers); + Result Get(const char *path, Progress progress); + Result Get(const char *path, const Headers &headers, Progress progress); + Result Get(const char *path, ContentReceiver content_receiver); + Result Get(const char *path, const Headers &headers, + ContentReceiver content_receiver); + Result Get(const char *path, ContentReceiver content_receiver, + Progress progress); + Result Get(const char *path, const Headers &headers, + ContentReceiver content_receiver, Progress progress); + Result Get(const char *path, ResponseHandler response_handler, + ContentReceiver content_receiver); + Result Get(const char *path, const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver); + Result Get(const char *path, const Headers &headers, + ResponseHandler response_handler, ContentReceiver content_receiver, + Progress progress); + Result Get(const char *path, ResponseHandler response_handler, + ContentReceiver content_receiver, Progress progress); + + Result Head(const char *path); + Result Head(const char *path, const Headers &headers); + + Result Post(const char *path); + Result Post(const char *path, const std::string &body, + const char *content_type); + Result Post(const char *path, const Headers &headers, const std::string &body, + const char *content_type); + Result Post(const char *path, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Post(const char *path, ContentProviderWithoutLength content_provider, + const char *content_type); + Result Post(const char *path, const Headers &headers, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Post(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type); + Result Post(const char *path, const Params ¶ms); + Result Post(const char *path, const Headers &headers, const Params ¶ms); + Result Post(const char *path, const MultipartFormDataItems &items); + Result Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items); + Result Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items, const std::string &boundary); + Result Put(const char *path); + Result Put(const char *path, const std::string &body, + const char *content_type); + Result Put(const char *path, const Headers &headers, const std::string &body, + const char *content_type); + Result Put(const char *path, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Put(const char *path, ContentProviderWithoutLength content_provider, + const char *content_type); + Result Put(const char *path, const Headers &headers, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Put(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type); + Result Put(const char *path, const Params ¶ms); + Result Put(const char *path, const Headers &headers, const Params ¶ms); + Result Patch(const char *path, const std::string &body, + const char *content_type); + Result Patch(const char *path, const Headers &headers, + const std::string &body, const char *content_type); + Result Patch(const char *path, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Patch(const char *path, ContentProviderWithoutLength content_provider, + const char *content_type); + Result Patch(const char *path, const Headers &headers, size_t content_length, + ContentProvider content_provider, const char *content_type); + Result Patch(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type); + + Result Delete(const char *path); + Result Delete(const char *path, const std::string &body, + const char *content_type); + Result Delete(const char *path, const Headers &headers); + Result Delete(const char *path, const Headers &headers, + const std::string &body, const char *content_type); + + Result Options(const char *path); + Result Options(const char *path, const Headers &headers); + + bool send(const Request &req, Response &res, Error &error); + Result send(const Request &req); + + size_t is_socket_open() const; + + void stop(); + + void set_default_headers(Headers headers); + + void set_tcp_nodelay(bool on); + void set_socket_options(SocketOptions socket_options); + + void set_connection_timeout(time_t sec, time_t usec = 0); + void set_read_timeout(time_t sec, time_t usec = 0); + void set_write_timeout(time_t sec, time_t usec = 0); + + void set_basic_auth(const char *username, const char *password); + void set_bearer_token_auth(const char *token); +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void set_digest_auth(const char *username, const char *password); +#endif + + void set_keep_alive(bool on); + void set_follow_location(bool on); + + void set_compress(bool on); + + void set_decompress(bool on); + + void set_interface(const char *intf); + + void set_proxy(const char *host, int port); + void set_proxy_basic_auth(const char *username, const char *password); + void set_proxy_bearer_token_auth(const char *token); +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void set_proxy_digest_auth(const char *username, const char *password); +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void enable_server_certificate_verification(bool enabled); +#endif + + void set_logger(Logger logger); + + // SSL +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void set_ca_cert_path(const char *ca_cert_file_path, + const char *ca_cert_dir_path = nullptr); + + void set_ca_cert_store(X509_STORE *ca_cert_store); + + long get_openssl_verify_result() const; + + SSL_CTX *ssl_context() const; +#endif + +private: + std::unique_ptr cli_; + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + bool is_ssl_ = false; +#endif +}; + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +class SSLServer : public Server { +public: + SSLServer(const char *cert_path, const char *private_key_path, + const char *client_ca_cert_file_path = nullptr, + const char *client_ca_cert_dir_path = nullptr); + + SSLServer(X509 *cert, EVP_PKEY *private_key, + X509_STORE *client_ca_cert_store = nullptr); + + ~SSLServer() override; + + bool is_valid() const override; + +private: + bool process_and_close_socket(socket_t sock) override; + + SSL_CTX *ctx_; + std::mutex ctx_mutex_; +}; + +class SSLClient : public ClientImpl { +public: + explicit SSLClient(const std::string &host); + + explicit SSLClient(const std::string &host, int port); + + explicit SSLClient(const std::string &host, int port, + const std::string &client_cert_path, + const std::string &client_key_path); + + explicit SSLClient(const std::string &host, int port, X509 *client_cert, + EVP_PKEY *client_key); + + ~SSLClient() override; + + bool is_valid() const override; + + void set_ca_cert_path(const char *ca_cert_file_path, + const char *ca_cert_dir_path = nullptr); + + void set_ca_cert_store(X509_STORE *ca_cert_store); + + long get_openssl_verify_result() const; + + SSL_CTX *ssl_context() const; + +private: + bool create_and_connect_socket(Socket &socket, Error &error) override; + void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override; + + bool process_socket(const Socket &socket, + std::function callback) override; + bool is_ssl() const override; + + bool connect_with_proxy(Socket &sock, Response &res, bool &success, + Error &error); + bool initialize_ssl(Socket &socket, Error &error); + + bool load_certs(); + + bool verify_host(X509 *server_cert) const; + bool verify_host_with_subject_alt_name(X509 *server_cert) const; + bool verify_host_with_common_name(X509 *server_cert) const; + bool check_host_name(const char *pattern, size_t pattern_len) const; + + SSL_CTX *ctx_; + std::mutex ctx_mutex_; + std::once_flag initialize_cert_; + + std::vector host_components_; + + std::string ca_cert_file_path_; + std::string ca_cert_dir_path_; + long verify_result_ = 0; + + friend class ClientImpl; +}; +#endif + +// ---------------------------------------------------------------------------- + +/* + * Implementation + */ + +namespace detail { + +inline bool is_hex(char c, int &v) { + if (0x20 <= c && isdigit(c)) { + v = c - '0'; + return true; + } else if ('A' <= c && c <= 'F') { + v = c - 'A' + 10; + return true; + } else if ('a' <= c && c <= 'f') { + v = c - 'a' + 10; + return true; + } + return false; +} + +inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt, + int &val) { + if (i >= s.size()) { return false; } + + val = 0; + for (; cnt; i++, cnt--) { + if (!s[i]) { return false; } + int v = 0; + if (is_hex(s[i], v)) { + val = val * 16 + v; + } else { + return false; + } + } + return true; +} + +inline std::string from_i_to_hex(size_t n) { + const char *charset = "0123456789abcdef"; + std::string ret; + do { + ret = charset[n & 15] + ret; + n >>= 4; + } while (n > 0); + return ret; +} + +inline size_t to_utf8(int code, char *buff) { + if (code < 0x0080) { + buff[0] = (code & 0x7F); + return 1; + } else if (code < 0x0800) { + buff[0] = static_cast(0xC0 | ((code >> 6) & 0x1F)); + buff[1] = static_cast(0x80 | (code & 0x3F)); + return 2; + } else if (code < 0xD800) { + buff[0] = static_cast(0xE0 | ((code >> 12) & 0xF)); + buff[1] = static_cast(0x80 | ((code >> 6) & 0x3F)); + buff[2] = static_cast(0x80 | (code & 0x3F)); + return 3; + } else if (code < 0xE000) { // D800 - DFFF is invalid... + return 0; + } else if (code < 0x10000) { + buff[0] = static_cast(0xE0 | ((code >> 12) & 0xF)); + buff[1] = static_cast(0x80 | ((code >> 6) & 0x3F)); + buff[2] = static_cast(0x80 | (code & 0x3F)); + return 3; + } else if (code < 0x110000) { + buff[0] = static_cast(0xF0 | ((code >> 18) & 0x7)); + buff[1] = static_cast(0x80 | ((code >> 12) & 0x3F)); + buff[2] = static_cast(0x80 | ((code >> 6) & 0x3F)); + buff[3] = static_cast(0x80 | (code & 0x3F)); + return 4; + } + + // NOTREACHED + return 0; +} + +// NOTE: This code came up with the following stackoverflow post: +// https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c +inline std::string base64_encode(const std::string &in) { + static const auto lookup = + "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; + + std::string out; + out.reserve(in.size()); + + int val = 0; + int valb = -6; + + for (auto c : in) { + val = (val << 8) + static_cast(c); + valb += 8; + while (valb >= 0) { + out.push_back(lookup[(val >> valb) & 0x3F]); + valb -= 6; + } + } + + if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); } + + while (out.size() % 4) { + out.push_back('='); + } + + return out; +} + +inline bool is_file(const std::string &path) { + struct stat st; + return stat(path.c_str(), &st) >= 0 && S_ISREG(st.st_mode); +} + +inline bool is_dir(const std::string &path) { + struct stat st; + return stat(path.c_str(), &st) >= 0 && S_ISDIR(st.st_mode); +} + +inline bool is_valid_path(const std::string &path) { + size_t level = 0; + size_t i = 0; + + // Skip slash + while (i < path.size() && path[i] == '/') { + i++; + } + + while (i < path.size()) { + // Read component + auto beg = i; + while (i < path.size() && path[i] != '/') { + i++; + } + + auto len = i - beg; + assert(len > 0); + + if (!path.compare(beg, len, ".")) { + ; + } else if (!path.compare(beg, len, "..")) { + if (level == 0) { return false; } + level--; + } else { + level++; + } + + // Skip slash + while (i < path.size() && path[i] == '/') { + i++; + } + } + + return true; +} + +inline std::string encode_query_param(const std::string &value) { + std::ostringstream escaped; + escaped.fill('0'); + escaped << std::hex; + + for (char const &c : value) { + if (std::isalnum(c) || c == '-' || c == '_' || c == '.' || c == '!' || + c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') { + escaped << c; + } else { + escaped << std::uppercase; + escaped << '%' << std::setw(2) + << static_cast(static_cast(c)); + escaped << std::nouppercase; + } + } + + return escaped.str(); +} + +inline std::string encode_url(const std::string &s) { + std::string result; + + for (size_t i = 0; s[i]; i++) { + switch (s[i]) { + case ' ': result += "%20"; break; + case '+': result += "%2B"; break; + case '\r': result += "%0D"; break; + case '\n': result += "%0A"; break; + case '\'': result += "%27"; break; + case ',': result += "%2C"; break; + // case ':': result += "%3A"; break; // ok? probably... + case ';': result += "%3B"; break; + default: + auto c = static_cast(s[i]); + if (c >= 0x80) { + result += '%'; + char hex[4]; + auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c); + assert(len == 2); + result.append(hex, static_cast(len)); + } else { + result += s[i]; + } + break; + } + } + + return result; +} + +inline std::string decode_url(const std::string &s, + bool convert_plus_to_space) { + std::string result; + + for (size_t i = 0; i < s.size(); i++) { + if (s[i] == '%' && i + 1 < s.size()) { + if (s[i + 1] == 'u') { + int val = 0; + if (from_hex_to_i(s, i + 2, 4, val)) { + // 4 digits Unicode codes + char buff[4]; + size_t len = to_utf8(val, buff); + if (len > 0) { result.append(buff, len); } + i += 5; // 'u0000' + } else { + result += s[i]; + } + } else { + int val = 0; + if (from_hex_to_i(s, i + 1, 2, val)) { + // 2 digits hex codes + result += static_cast(val); + i += 2; // '00' + } else { + result += s[i]; + } + } + } else if (convert_plus_to_space && s[i] == '+') { + result += ' '; + } else { + result += s[i]; + } + } + + return result; +} + +inline void read_file(const std::string &path, std::string &out) { + std::ifstream fs(path, std::ios_base::binary); + fs.seekg(0, std::ios_base::end); + auto size = fs.tellg(); + fs.seekg(0); + out.resize(static_cast(size)); + fs.read(&out[0], static_cast(size)); +} + +inline std::string file_extension(const std::string &path) { + std::smatch m; + static auto re = std::regex("\\.([a-zA-Z0-9]+)$"); + if (std::regex_search(path, m, re)) { return m[1].str(); } + return std::string(); +} + +inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; } + +inline std::pair trim(const char *b, const char *e, size_t left, + size_t right) { + while (b + left < e && is_space_or_tab(b[left])) { + left++; + } + while (right > 0 && is_space_or_tab(b[right - 1])) { + right--; + } + return std::make_pair(left, right); +} + +inline std::string trim_copy(const std::string &s) { + auto r = trim(s.data(), s.data() + s.size(), 0, s.size()); + return s.substr(r.first, r.second - r.first); +} + +template void split(const char *b, const char *e, char d, Fn fn) { + size_t i = 0; + size_t beg = 0; + + while (e ? (b + i < e) : (b[i] != '\0')) { + if (b[i] == d) { + auto r = trim(b, e, beg, i); + if (r.first < r.second) { fn(&b[r.first], &b[r.second]); } + beg = i + 1; + } + i++; + } + + if (i) { + auto r = trim(b, e, beg, i); + if (r.first < r.second) { fn(&b[r.first], &b[r.second]); } + } +} + +// NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer` +// to store data. The call can set memory on stack for performance. +class stream_line_reader { +public: + stream_line_reader(Stream &strm, char *fixed_buffer, size_t fixed_buffer_size) + : strm_(strm), fixed_buffer_(fixed_buffer), + fixed_buffer_size_(fixed_buffer_size) {} + + const char *ptr() const { + if (glowable_buffer_.empty()) { + return fixed_buffer_; + } else { + return glowable_buffer_.data(); + } + } + + size_t size() const { + if (glowable_buffer_.empty()) { + return fixed_buffer_used_size_; + } else { + return glowable_buffer_.size(); + } + } + + bool end_with_crlf() const { + auto end = ptr() + size(); + return size() >= 2 && end[-2] == '\r' && end[-1] == '\n'; + } + + bool getline() { + fixed_buffer_used_size_ = 0; + glowable_buffer_.clear(); + + for (size_t i = 0;; i++) { + char byte; + auto n = strm_.read(&byte, 1); + + if (n < 0) { + return false; + } else if (n == 0) { + if (i == 0) { + return false; + } else { + break; + } + } + + append(byte); + + if (byte == '\n') { break; } + } + + return true; + } + +private: + void append(char c) { + if (fixed_buffer_used_size_ < fixed_buffer_size_ - 1) { + fixed_buffer_[fixed_buffer_used_size_++] = c; + fixed_buffer_[fixed_buffer_used_size_] = '\0'; + } else { + if (glowable_buffer_.empty()) { + assert(fixed_buffer_[fixed_buffer_used_size_] == '\0'); + glowable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_); + } + glowable_buffer_ += c; + } + } + + Stream &strm_; + char *fixed_buffer_; + const size_t fixed_buffer_size_; + size_t fixed_buffer_used_size_ = 0; + std::string glowable_buffer_; +}; + +inline int close_socket(socket_t sock) { +#ifdef _WIN32 + return closesocket(sock); +#else + return close(sock); +#endif +} + +template inline ssize_t handle_EINTR(T fn) { + ssize_t res = false; + while (true) { + res = fn(); + if (res < 0 && errno == EINTR) { continue; } + break; + } + return res; +} + +inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) { +#ifdef CPPHTTPLIB_USE_POLL + struct pollfd pfd_read; + pfd_read.fd = sock; + pfd_read.events = POLLIN; + + auto timeout = static_cast(sec * 1000 + usec / 1000); + + return handle_EINTR([&]() { return poll(&pfd_read, 1, timeout); }); +#else +#ifndef _WIN32 + if (sock >= FD_SETSIZE) { return 1; } +#endif + + fd_set fds; + FD_ZERO(&fds); + FD_SET(sock, &fds); + + timeval tv; + tv.tv_sec = static_cast(sec); + tv.tv_usec = static_cast(usec); + + return handle_EINTR([&]() { + return select(static_cast(sock + 1), &fds, nullptr, nullptr, &tv); + }); +#endif +} + +inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) { +#ifdef CPPHTTPLIB_USE_POLL + struct pollfd pfd_read; + pfd_read.fd = sock; + pfd_read.events = POLLOUT; + + auto timeout = static_cast(sec * 1000 + usec / 1000); + + return handle_EINTR([&]() { return poll(&pfd_read, 1, timeout); }); +#else +#ifndef _WIN32 + if (sock >= FD_SETSIZE) { return 1; } +#endif + + fd_set fds; + FD_ZERO(&fds); + FD_SET(sock, &fds); + + timeval tv; + tv.tv_sec = static_cast(sec); + tv.tv_usec = static_cast(usec); + + return handle_EINTR([&]() { + return select(static_cast(sock + 1), nullptr, &fds, nullptr, &tv); + }); +#endif +} + +inline bool wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec) { +#ifdef CPPHTTPLIB_USE_POLL + struct pollfd pfd_read; + pfd_read.fd = sock; + pfd_read.events = POLLIN | POLLOUT; + + auto timeout = static_cast(sec * 1000 + usec / 1000); + + auto poll_res = handle_EINTR([&]() { return poll(&pfd_read, 1, timeout); }); + + if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) { + int error = 0; + socklen_t len = sizeof(error); + auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR, + reinterpret_cast(&error), &len); + return res >= 0 && !error; + } + return false; +#else +#ifndef _WIN32 + if (sock >= FD_SETSIZE) { return false; } +#endif + + fd_set fdsr; + FD_ZERO(&fdsr); + FD_SET(sock, &fdsr); + + auto fdsw = fdsr; + auto fdse = fdsr; + + timeval tv; + tv.tv_sec = static_cast(sec); + tv.tv_usec = static_cast(usec); + + auto ret = handle_EINTR([&]() { + return select(static_cast(sock + 1), &fdsr, &fdsw, &fdse, &tv); + }); + + if (ret > 0 && (FD_ISSET(sock, &fdsr) || FD_ISSET(sock, &fdsw))) { + int error = 0; + socklen_t len = sizeof(error); + return getsockopt(sock, SOL_SOCKET, SO_ERROR, + reinterpret_cast(&error), &len) >= 0 && + !error; + } + return false; +#endif +} + +class SocketStream : public Stream { +public: + SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec, + time_t write_timeout_sec, time_t write_timeout_usec); + ~SocketStream() override; + + bool is_readable() const override; + bool is_writable() const override; + ssize_t read(char *ptr, size_t size) override; + ssize_t write(const char *ptr, size_t size) override; + void get_remote_ip_and_port(std::string &ip, int &port) const override; + socket_t socket() const override; + +private: + socket_t sock_; + time_t read_timeout_sec_; + time_t read_timeout_usec_; + time_t write_timeout_sec_; + time_t write_timeout_usec_; +}; + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +class SSLSocketStream : public Stream { +public: + SSLSocketStream(socket_t sock, SSL *ssl, time_t read_timeout_sec, + time_t read_timeout_usec, time_t write_timeout_sec, + time_t write_timeout_usec); + ~SSLSocketStream() override; + + bool is_readable() const override; + bool is_writable() const override; + ssize_t read(char *ptr, size_t size) override; + ssize_t write(const char *ptr, size_t size) override; + void get_remote_ip_and_port(std::string &ip, int &port) const override; + socket_t socket() const override; + +private: + socket_t sock_; + SSL *ssl_; + time_t read_timeout_sec_; + time_t read_timeout_usec_; + time_t write_timeout_sec_; + time_t write_timeout_usec_; +}; +#endif + +class BufferStream : public Stream { +public: + BufferStream() = default; + ~BufferStream() override = default; + + bool is_readable() const override; + bool is_writable() const override; + ssize_t read(char *ptr, size_t size) override; + ssize_t write(const char *ptr, size_t size) override; + void get_remote_ip_and_port(std::string &ip, int &port) const override; + socket_t socket() const override; + + const std::string &get_buffer() const; + +private: + std::string buffer; + size_t position = 0; +}; + +inline bool keep_alive(socket_t sock, time_t keep_alive_timeout_sec) { + using namespace std::chrono; + auto start = steady_clock::now(); + while (true) { + auto val = select_read(sock, 0, 10000); + if (val < 0) { + return false; + } else if (val == 0) { + auto current = steady_clock::now(); + auto duration = duration_cast(current - start); + auto timeout = keep_alive_timeout_sec * 1000; + if (duration.count() > timeout) { return false; } + std::this_thread::sleep_for(std::chrono::milliseconds(1)); + } else { + return true; + } + } +} + +template +inline bool +process_server_socket_core(socket_t sock, size_t keep_alive_max_count, + time_t keep_alive_timeout_sec, T callback) { + assert(keep_alive_max_count > 0); + auto ret = false; + auto count = keep_alive_max_count; + while (count > 0 && keep_alive(sock, keep_alive_timeout_sec)) { + auto close_connection = count == 1; + auto connection_closed = false; + ret = callback(close_connection, connection_closed); + if (!ret || connection_closed) { break; } + count--; + } + return ret; +} + +template +inline bool +process_server_socket(socket_t sock, size_t keep_alive_max_count, + time_t keep_alive_timeout_sec, time_t read_timeout_sec, + time_t read_timeout_usec, time_t write_timeout_sec, + time_t write_timeout_usec, T callback) { + return process_server_socket_core( + sock, keep_alive_max_count, keep_alive_timeout_sec, + [&](bool close_connection, bool &connection_closed) { + SocketStream strm(sock, read_timeout_sec, read_timeout_usec, + write_timeout_sec, write_timeout_usec); + return callback(strm, close_connection, connection_closed); + }); +} + +template +inline bool process_client_socket(socket_t sock, time_t read_timeout_sec, + time_t read_timeout_usec, + time_t write_timeout_sec, + time_t write_timeout_usec, T callback) { + SocketStream strm(sock, read_timeout_sec, read_timeout_usec, + write_timeout_sec, write_timeout_usec); + return callback(strm); +} + +inline int shutdown_socket(socket_t sock) { +#ifdef _WIN32 + return shutdown(sock, SD_BOTH); +#else + return shutdown(sock, SHUT_RDWR); +#endif +} + +template +socket_t create_socket(const char *host, int port, int socket_flags, + bool tcp_nodelay, SocketOptions socket_options, + BindOrConnect bind_or_connect) { + // Get address info + struct addrinfo hints; + struct addrinfo *result; + + memset(&hints, 0, sizeof(struct addrinfo)); + hints.ai_family = AF_UNSPEC; + hints.ai_socktype = SOCK_STREAM; + hints.ai_flags = socket_flags; + hints.ai_protocol = 0; + + auto service = std::to_string(port); + + if (getaddrinfo(host, service.c_str(), &hints, &result)) { +#ifdef __linux__ + res_init(); +#endif + return INVALID_SOCKET; + } + + for (auto rp = result; rp; rp = rp->ai_next) { + // Create a socket +#ifdef _WIN32 + auto sock = WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, + nullptr, 0, WSA_FLAG_NO_HANDLE_INHERIT); + /** + * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1 + * and above the socket creation fails on older Windows Systems. + * + * Let's try to create a socket the old way in this case. + * + * Reference: + * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa + * + * WSA_FLAG_NO_HANDLE_INHERIT: + * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with + * SP1, and later + * + */ + if (sock == INVALID_SOCKET) { + sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol); + } +#else + auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol); +#endif + if (sock == INVALID_SOCKET) { continue; } + +#ifndef _WIN32 + if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) { continue; } +#endif + + if (tcp_nodelay) { + int yes = 1; + setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, reinterpret_cast(&yes), + sizeof(yes)); + } + + if (socket_options) { socket_options(sock); } + + if (rp->ai_family == AF_INET6) { + int no = 0; + setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, reinterpret_cast(&no), + sizeof(no)); + } + + // bind or connect + if (bind_or_connect(sock, *rp)) { + freeaddrinfo(result); + return sock; + } + + close_socket(sock); + } + + freeaddrinfo(result); + return INVALID_SOCKET; +} + +inline void set_nonblocking(socket_t sock, bool nonblocking) { +#ifdef _WIN32 + auto flags = nonblocking ? 1UL : 0UL; + ioctlsocket(sock, FIONBIO, &flags); +#else + auto flags = fcntl(sock, F_GETFL, 0); + fcntl(sock, F_SETFL, + nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK))); +#endif +} + +inline bool is_connection_error() { +#ifdef _WIN32 + return WSAGetLastError() != WSAEWOULDBLOCK; +#else + return errno != EINPROGRESS; +#endif +} + +inline bool bind_ip_address(socket_t sock, const char *host) { + struct addrinfo hints; + struct addrinfo *result; + + memset(&hints, 0, sizeof(struct addrinfo)); + hints.ai_family = AF_UNSPEC; + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = 0; + + if (getaddrinfo(host, "0", &hints, &result)) { return false; } + + auto ret = false; + for (auto rp = result; rp; rp = rp->ai_next) { + const auto &ai = *rp; + if (!::bind(sock, ai.ai_addr, static_cast(ai.ai_addrlen))) { + ret = true; + break; + } + } + + freeaddrinfo(result); + return ret; +} + +#if !defined _WIN32 && !defined ANDROID +#define USE_IF2IP +#endif + +#ifdef USE_IF2IP +inline std::string if2ip(const std::string &ifn) { + struct ifaddrs *ifap; + getifaddrs(&ifap); + for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) { + if (ifa->ifa_addr && ifn == ifa->ifa_name) { + if (ifa->ifa_addr->sa_family == AF_INET) { + auto sa = reinterpret_cast(ifa->ifa_addr); + char buf[INET_ADDRSTRLEN]; + if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) { + freeifaddrs(ifap); + return std::string(buf, INET_ADDRSTRLEN); + } + } + } + } + freeifaddrs(ifap); + return std::string(); +} +#endif + +inline socket_t create_client_socket(const char *host, int port, + bool tcp_nodelay, + SocketOptions socket_options, + time_t timeout_sec, time_t timeout_usec, + const std::string &intf, Error &error) { + auto sock = create_socket( + host, port, 0, tcp_nodelay, std::move(socket_options), + [&](socket_t sock, struct addrinfo &ai) -> bool { + if (!intf.empty()) { +#ifdef USE_IF2IP + auto ip = if2ip(intf); + if (ip.empty()) { ip = intf; } + if (!bind_ip_address(sock, ip.c_str())) { + error = Error::BindIPAddress; + return false; + } +#endif + } + + set_nonblocking(sock, true); + + auto ret = + ::connect(sock, ai.ai_addr, static_cast(ai.ai_addrlen)); + + if (ret < 0) { + if (is_connection_error() || + !wait_until_socket_is_ready(sock, timeout_sec, timeout_usec)) { + close_socket(sock); + error = Error::Connection; + return false; + } + } + + set_nonblocking(sock, false); + error = Error::Success; + return true; + }); + + if (sock != INVALID_SOCKET) { + error = Error::Success; + } else { + if (error == Error::Success) { error = Error::Connection; } + } + + return sock; +} + +inline void get_remote_ip_and_port(const struct sockaddr_storage &addr, + socklen_t addr_len, std::string &ip, + int &port) { + if (addr.ss_family == AF_INET) { + port = ntohs(reinterpret_cast(&addr)->sin_port); + } else if (addr.ss_family == AF_INET6) { + port = + ntohs(reinterpret_cast(&addr)->sin6_port); + } + + std::array ipstr{}; + if (!getnameinfo(reinterpret_cast(&addr), addr_len, + ipstr.data(), static_cast(ipstr.size()), nullptr, + 0, NI_NUMERICHOST)) { + ip = ipstr.data(); + } +} + +inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) { + struct sockaddr_storage addr; + socklen_t addr_len = sizeof(addr); + + if (!getpeername(sock, reinterpret_cast(&addr), + &addr_len)) { + get_remote_ip_and_port(addr, addr_len, ip, port); + } +} + +inline constexpr unsigned int str2tag_core(const char *s, size_t l, + unsigned int h) { + return (l == 0) ? h + : str2tag_core(s + 1, l - 1, + (h * 33) ^ static_cast(*s)); +} + +inline unsigned int str2tag(const std::string &s) { + return str2tag_core(s.data(), s.size(), 0); +} + +namespace udl { + +inline constexpr unsigned int operator"" _(const char *s, size_t l) { + return str2tag_core(s, l, 0); +} + +} // namespace udl + +inline const char * +find_content_type(const std::string &path, + const std::map &user_data) { + auto ext = file_extension(path); + + auto it = user_data.find(ext); + if (it != user_data.end()) { return it->second.c_str(); } + + using udl::operator""_; + + switch (str2tag(ext)) { + default: return nullptr; + case "css"_: return "text/css"; + case "csv"_: return "text/csv"; + case "txt"_: return "text/plain"; + case "vtt"_: return "text/vtt"; + case "htm"_: + case "html"_: return "text/html"; + + case "apng"_: return "image/apng"; + case "avif"_: return "image/avif"; + case "bmp"_: return "image/bmp"; + case "gif"_: return "image/gif"; + case "png"_: return "image/png"; + case "svg"_: return "image/svg+xml"; + case "webp"_: return "image/webp"; + case "ico"_: return "image/x-icon"; + case "tif"_: return "image/tiff"; + case "tiff"_: return "image/tiff"; + case "jpg"_: + case "jpeg"_: return "image/jpeg"; + + case "mp4"_: return "video/mp4"; + case "mpeg"_: return "video/mpeg"; + case "webm"_: return "video/webm"; + + case "mp3"_: return "audio/mp3"; + case "mpga"_: return "audio/mpeg"; + case "weba"_: return "audio/webm"; + case "wav"_: return "audio/wave"; + + case "otf"_: return "font/otf"; + case "ttf"_: return "font/ttf"; + case "woff"_: return "font/woff"; + case "woff2"_: return "font/woff2"; + + case "7z"_: return "application/x-7z-compressed"; + case "atom"_: return "application/atom+xml"; + case "pdf"_: return "application/pdf"; + case "js"_: + case "mjs"_: return "application/javascript"; + case "json"_: return "application/json"; + case "rss"_: return "application/rss+xml"; + case "tar"_: return "application/x-tar"; + case "xht"_: + case "xhtml"_: return "application/xhtml+xml"; + case "xslt"_: return "application/xslt+xml"; + case "xml"_: return "application/xml"; + case "gz"_: return "application/gzip"; + case "zip"_: return "application/zip"; + case "wasm"_: return "application/wasm"; + } +} + +inline const char *status_message(int status) { + switch (status) { + case 100: return "Continue"; + case 101: return "Switching Protocol"; + case 102: return "Processing"; + case 103: return "Early Hints"; + case 200: return "OK"; + case 201: return "Created"; + case 202: return "Accepted"; + case 203: return "Non-Authoritative Information"; + case 204: return "No Content"; + case 205: return "Reset Content"; + case 206: return "Partial Content"; + case 207: return "Multi-Status"; + case 208: return "Already Reported"; + case 226: return "IM Used"; + case 300: return "Multiple Choice"; + case 301: return "Moved Permanently"; + case 302: return "Found"; + case 303: return "See Other"; + case 304: return "Not Modified"; + case 305: return "Use Proxy"; + case 306: return "unused"; + case 307: return "Temporary Redirect"; + case 308: return "Permanent Redirect"; + case 400: return "Bad Request"; + case 401: return "Unauthorized"; + case 402: return "Payment Required"; + case 403: return "Forbidden"; + case 404: return "Not Found"; + case 405: return "Method Not Allowed"; + case 406: return "Not Acceptable"; + case 407: return "Proxy Authentication Required"; + case 408: return "Request Timeout"; + case 409: return "Conflict"; + case 410: return "Gone"; + case 411: return "Length Required"; + case 412: return "Precondition Failed"; + case 413: return "Payload Too Large"; + case 414: return "URI Too Long"; + case 415: return "Unsupported Media Type"; + case 416: return "Range Not Satisfiable"; + case 417: return "Expectation Failed"; + case 418: return "I'm a teapot"; + case 421: return "Misdirected Request"; + case 422: return "Unprocessable Entity"; + case 423: return "Locked"; + case 424: return "Failed Dependency"; + case 425: return "Too Early"; + case 426: return "Upgrade Required"; + case 428: return "Precondition Required"; + case 429: return "Too Many Requests"; + case 431: return "Request Header Fields Too Large"; + case 451: return "Unavailable For Legal Reasons"; + case 501: return "Not Implemented"; + case 502: return "Bad Gateway"; + case 503: return "Service Unavailable"; + case 504: return "Gateway Timeout"; + case 505: return "HTTP Version Not Supported"; + case 506: return "Variant Also Negotiates"; + case 507: return "Insufficient Storage"; + case 508: return "Loop Detected"; + case 510: return "Not Extended"; + case 511: return "Network Authentication Required"; + + default: + case 500: return "Internal Server Error"; + } +} + +inline bool can_compress_content_type(const std::string &content_type) { + return (!content_type.find("text/") && content_type != "text/event-stream") || + content_type == "image/svg+xml" || + content_type == "application/javascript" || + content_type == "application/json" || + content_type == "application/xml" || + content_type == "application/xhtml+xml"; +} + +enum class EncodingType { None = 0, Gzip, Brotli }; + +inline EncodingType encoding_type(const Request &req, const Response &res) { + auto ret = + detail::can_compress_content_type(res.get_header_value("Content-Type")); + if (!ret) { return EncodingType::None; } + + const auto &s = req.get_header_value("Accept-Encoding"); + (void)(s); + +#ifdef CPPHTTPLIB_BROTLI_SUPPORT + // TODO: 'Accept-Encoding' has br, not br;q=0 + ret = s.find("br") != std::string::npos; + if (ret) { return EncodingType::Brotli; } +#endif + +#ifdef CPPHTTPLIB_ZLIB_SUPPORT + // TODO: 'Accept-Encoding' has gzip, not gzip;q=0 + ret = s.find("gzip") != std::string::npos; + if (ret) { return EncodingType::Gzip; } +#endif + + return EncodingType::None; +} + +class compressor { +public: + virtual ~compressor(){}; + + typedef std::function Callback; + virtual bool compress(const char *data, size_t data_length, bool last, + Callback callback) = 0; +}; + +class decompressor { +public: + virtual ~decompressor() {} + + virtual bool is_valid() const = 0; + + typedef std::function Callback; + virtual bool decompress(const char *data, size_t data_length, + Callback callback) = 0; +}; + +class nocompressor : public compressor { +public: + ~nocompressor(){}; + + bool compress(const char *data, size_t data_length, bool /*last*/, + Callback callback) override { + if (!data_length) { return true; } + return callback(data, data_length); + } +}; + +#ifdef CPPHTTPLIB_ZLIB_SUPPORT +class gzip_compressor : public compressor { +public: + gzip_compressor() { + std::memset(&strm_, 0, sizeof(strm_)); + strm_.zalloc = Z_NULL; + strm_.zfree = Z_NULL; + strm_.opaque = Z_NULL; + + is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8, + Z_DEFAULT_STRATEGY) == Z_OK; + } + + ~gzip_compressor() { deflateEnd(&strm_); } + + bool compress(const char *data, size_t data_length, bool last, + Callback callback) override { + assert(is_valid_); + + auto flush = last ? Z_FINISH : Z_NO_FLUSH; + + strm_.avail_in = static_cast(data_length); + strm_.next_in = const_cast(reinterpret_cast(data)); + + int ret = Z_OK; + + std::array buff{}; + do { + strm_.avail_out = buff.size(); + strm_.next_out = reinterpret_cast(buff.data()); + + ret = deflate(&strm_, flush); + assert(ret != Z_STREAM_ERROR); + + if (!callback(buff.data(), buff.size() - strm_.avail_out)) { + return false; + } + } while (strm_.avail_out == 0); + + assert((last && ret == Z_STREAM_END) || (!last && ret == Z_OK)); + assert(strm_.avail_in == 0); + return true; + } + +private: + bool is_valid_ = false; + z_stream strm_; +}; + +class gzip_decompressor : public decompressor { +public: + gzip_decompressor() { + std::memset(&strm_, 0, sizeof(strm_)); + strm_.zalloc = Z_NULL; + strm_.zfree = Z_NULL; + strm_.opaque = Z_NULL; + + // 15 is the value of wbits, which should be at the maximum possible value + // to ensure that any gzip stream can be decoded. The offset of 32 specifies + // that the stream type should be automatically detected either gzip or + // deflate. + is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK; + } + + ~gzip_decompressor() { inflateEnd(&strm_); } + + bool is_valid() const override { return is_valid_; } + + bool decompress(const char *data, size_t data_length, + Callback callback) override { + assert(is_valid_); + + int ret = Z_OK; + + strm_.avail_in = static_cast(data_length); + strm_.next_in = const_cast(reinterpret_cast(data)); + + std::array buff{}; + while (strm_.avail_in > 0) { + strm_.avail_out = buff.size(); + strm_.next_out = reinterpret_cast(buff.data()); + + ret = inflate(&strm_, Z_NO_FLUSH); + assert(ret != Z_STREAM_ERROR); + switch (ret) { + case Z_NEED_DICT: + case Z_DATA_ERROR: + case Z_MEM_ERROR: inflateEnd(&strm_); return false; + } + + if (!callback(buff.data(), buff.size() - strm_.avail_out)) { + return false; + } + } + + return ret == Z_OK || ret == Z_STREAM_END; + } + +private: + bool is_valid_ = false; + z_stream strm_; +}; +#endif + +#ifdef CPPHTTPLIB_BROTLI_SUPPORT +class brotli_compressor : public compressor { +public: + brotli_compressor() { + state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr); + } + + ~brotli_compressor() { BrotliEncoderDestroyInstance(state_); } + + bool compress(const char *data, size_t data_length, bool last, + Callback callback) override { + std::array buff{}; + + auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS; + auto available_in = data_length; + auto next_in = reinterpret_cast(data); + + for (;;) { + if (last) { + if (BrotliEncoderIsFinished(state_)) { break; } + } else { + if (!available_in) { break; } + } + + auto available_out = buff.size(); + auto next_out = buff.data(); + + if (!BrotliEncoderCompressStream(state_, operation, &available_in, + &next_in, &available_out, &next_out, + nullptr)) { + return false; + } + + auto output_bytes = buff.size() - available_out; + if (output_bytes) { + callback(reinterpret_cast(buff.data()), output_bytes); + } + } + + return true; + } + +private: + BrotliEncoderState *state_ = nullptr; +}; + +class brotli_decompressor : public decompressor { +public: + brotli_decompressor() { + decoder_s = BrotliDecoderCreateInstance(0, 0, 0); + decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT + : BROTLI_DECODER_RESULT_ERROR; + } + + ~brotli_decompressor() { + if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); } + } + + bool is_valid() const override { return decoder_s; } + + bool decompress(const char *data, size_t data_length, + Callback callback) override { + if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS || + decoder_r == BROTLI_DECODER_RESULT_ERROR) { + return 0; + } + + const uint8_t *next_in = (const uint8_t *)data; + size_t avail_in = data_length; + size_t total_out; + + decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT; + + std::array buff{}; + while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) { + char *next_out = buff.data(); + size_t avail_out = buff.size(); + + decoder_r = BrotliDecoderDecompressStream( + decoder_s, &avail_in, &next_in, &avail_out, + reinterpret_cast(&next_out), &total_out); + + if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; } + + if (!callback(buff.data(), buff.size() - avail_out)) { return false; } + } + + return decoder_r == BROTLI_DECODER_RESULT_SUCCESS || + decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT; + } + +private: + BrotliDecoderResult decoder_r; + BrotliDecoderState *decoder_s = nullptr; +}; +#endif + +inline bool has_header(const Headers &headers, const char *key) { + return headers.find(key) != headers.end(); +} + +inline const char *get_header_value(const Headers &headers, const char *key, + size_t id = 0, const char *def = nullptr) { + auto rng = headers.equal_range(key); + auto it = rng.first; + std::advance(it, static_cast(id)); + if (it != rng.second) { return it->second.c_str(); } + return def; +} + +template +inline T get_header_value(const Headers & /*headers*/, const char * /*key*/, + size_t /*id*/ = 0, uint64_t /*def*/ = 0) {} + +template <> +inline uint64_t get_header_value(const Headers &headers, + const char *key, size_t id, + uint64_t def) { + auto rng = headers.equal_range(key); + auto it = rng.first; + std::advance(it, static_cast(id)); + if (it != rng.second) { + return std::strtoull(it->second.data(), nullptr, 10); + } + return def; +} + +template +inline bool parse_header(const char *beg, const char *end, T fn) { + // Skip trailing spaces and tabs. + while (beg < end && is_space_or_tab(end[-1])) { + end--; + } + + auto p = beg; + while (p < end && *p != ':') { + p++; + } + + if (p == end) { return false; } + + auto key_end = p; + + if (*p++ != ':') { return false; } + + while (p < end && is_space_or_tab(*p)) { + p++; + } + + if (p < end) { + fn(std::string(beg, key_end), decode_url(std::string(p, end), false)); + return true; + } + + return false; +} + +inline bool read_headers(Stream &strm, Headers &headers) { + const auto bufsiz = 2048; + char buf[bufsiz]; + stream_line_reader line_reader(strm, buf, bufsiz); + + for (;;) { + if (!line_reader.getline()) { return false; } + + // Check if the line ends with CRLF. + if (line_reader.end_with_crlf()) { + // Blank line indicates end of headers. + if (line_reader.size() == 2) { break; } + } else { + continue; // Skip invalid line. + } + + // Exclude CRLF + auto end = line_reader.ptr() + line_reader.size() - 2; + + parse_header(line_reader.ptr(), end, + [&](std::string &&key, std::string &&val) { + headers.emplace(std::move(key), std::move(val)); + }); + } + + return true; +} + +inline bool read_content_with_length(Stream &strm, uint64_t len, + Progress progress, + ContentReceiverWithProgress out) { + char buf[CPPHTTPLIB_RECV_BUFSIZ]; + + uint64_t r = 0; + while (r < len) { + auto read_len = static_cast(len - r); + auto n = strm.read(buf, (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ)); + if (n <= 0) { return false; } + + if (!out(buf, static_cast(n), r, len)) { return false; } + r += static_cast(n); + + if (progress) { + if (!progress(r, len)) { return false; } + } + } + + return true; +} + +inline void skip_content_with_length(Stream &strm, uint64_t len) { + char buf[CPPHTTPLIB_RECV_BUFSIZ]; + uint64_t r = 0; + while (r < len) { + auto read_len = static_cast(len - r); + auto n = strm.read(buf, (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ)); + if (n <= 0) { return; } + r += static_cast(n); + } +} + +inline bool read_content_without_length(Stream &strm, + ContentReceiverWithProgress out) { + char buf[CPPHTTPLIB_RECV_BUFSIZ]; + uint64_t r = 0; + for (;;) { + auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ); + if (n < 0) { + return false; + } else if (n == 0) { + return true; + } + + if (!out(buf, static_cast(n), r, 0)) { return false; } + r += static_cast(n); + } + + return true; +} + +inline bool read_content_chunked(Stream &strm, + ContentReceiverWithProgress out) { + const auto bufsiz = 16; + char buf[bufsiz]; + + stream_line_reader line_reader(strm, buf, bufsiz); + + if (!line_reader.getline()) { return false; } + + unsigned long chunk_len; + while (true) { + char *end_ptr; + + chunk_len = std::strtoul(line_reader.ptr(), &end_ptr, 16); + + if (end_ptr == line_reader.ptr()) { return false; } + if (chunk_len == ULONG_MAX) { return false; } + + if (chunk_len == 0) { break; } + + if (!read_content_with_length(strm, chunk_len, nullptr, out)) { + return false; + } + + if (!line_reader.getline()) { return false; } + + if (strcmp(line_reader.ptr(), "\r\n")) { break; } + + if (!line_reader.getline()) { return false; } + } + + if (chunk_len == 0) { + // Reader terminator after chunks + if (!line_reader.getline() || strcmp(line_reader.ptr(), "\r\n")) + return false; + } + + return true; +} + +inline bool is_chunked_transfer_encoding(const Headers &headers) { + return !strcasecmp(get_header_value(headers, "Transfer-Encoding", 0, ""), + "chunked"); +} + +template +bool prepare_content_receiver(T &x, int &status, + ContentReceiverWithProgress receiver, + bool decompress, U callback) { + if (decompress) { + std::string encoding = x.get_header_value("Content-Encoding"); + std::unique_ptr decompressor; + + if (encoding.find("gzip") != std::string::npos || + encoding.find("deflate") != std::string::npos) { +#ifdef CPPHTTPLIB_ZLIB_SUPPORT + decompressor = detail::make_unique(); +#else + status = 415; + return false; +#endif + } else if (encoding.find("br") != std::string::npos) { +#ifdef CPPHTTPLIB_BROTLI_SUPPORT + decompressor = detail::make_unique(); +#else + status = 415; + return false; +#endif + } + + if (decompressor) { + if (decompressor->is_valid()) { + ContentReceiverWithProgress out = [&](const char *buf, size_t n, + uint64_t off, uint64_t len) { + return decompressor->decompress(buf, n, + [&](const char *buf, size_t n) { + return receiver(buf, n, off, len); + }); + }; + return callback(std::move(out)); + } else { + status = 500; + return false; + } + } + } + + ContentReceiverWithProgress out = [&](const char *buf, size_t n, uint64_t off, + uint64_t len) { + return receiver(buf, n, off, len); + }; + return callback(std::move(out)); +} + +template +bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status, + Progress progress, ContentReceiverWithProgress receiver, + bool decompress) { + return prepare_content_receiver( + x, status, std::move(receiver), decompress, + [&](const ContentReceiverWithProgress &out) { + auto ret = true; + auto exceed_payload_max_length = false; + + if (is_chunked_transfer_encoding(x.headers)) { + ret = read_content_chunked(strm, out); + } else if (!has_header(x.headers, "Content-Length")) { + ret = read_content_without_length(strm, out); + } else { + auto len = get_header_value(x.headers, "Content-Length"); + if (len > payload_max_length) { + exceed_payload_max_length = true; + skip_content_with_length(strm, len); + ret = false; + } else if (len > 0) { + ret = read_content_with_length(strm, len, std::move(progress), out); + } + } + + if (!ret) { status = exceed_payload_max_length ? 413 : 400; } + return ret; + }); +} + +template +inline ssize_t write_headers(Stream &strm, const T &info, + const Headers &headers) { + ssize_t write_len = 0; + for (const auto &x : info.headers) { + if (x.first == "EXCEPTION_WHAT") { continue; } + auto len = + strm.write_format("%s: %s\r\n", x.first.c_str(), x.second.c_str()); + if (len < 0) { return len; } + write_len += len; + } + for (const auto &x : headers) { + auto len = + strm.write_format("%s: %s\r\n", x.first.c_str(), x.second.c_str()); + if (len < 0) { return len; } + write_len += len; + } + auto len = strm.write("\r\n"); + if (len < 0) { return len; } + write_len += len; + return write_len; +} + +inline bool write_data(Stream &strm, const char *d, size_t l) { + size_t offset = 0; + while (offset < l) { + auto length = strm.write(d + offset, l - offset); + if (length < 0) { return false; } + offset += static_cast(length); + } + return true; +} + +template +inline bool write_content(Stream &strm, const ContentProvider &content_provider, + size_t offset, size_t length, T is_shutting_down, + Error &error) { + size_t end_offset = offset + length; + auto ok = true; + DataSink data_sink; + + data_sink.write = [&](const char *d, size_t l) { + if (ok) { + if (write_data(strm, d, l)) { + offset += l; + } else { + ok = false; + } + } + }; + + data_sink.is_writable = [&](void) { return ok && strm.is_writable(); }; + + while (offset < end_offset && !is_shutting_down()) { + if (!content_provider(offset, end_offset - offset, data_sink)) { + error = Error::Canceled; + return false; + } + if (!ok) { + error = Error::Write; + return false; + } + } + + error = Error::Success; + return true; +} + +template +inline bool write_content(Stream &strm, const ContentProvider &content_provider, + size_t offset, size_t length, + const T &is_shutting_down) { + auto error = Error::Success; + return write_content(strm, content_provider, offset, length, is_shutting_down, + error); +} + +template +inline bool +write_content_without_length(Stream &strm, + const ContentProvider &content_provider, + const T &is_shutting_down) { + size_t offset = 0; + auto data_available = true; + auto ok = true; + DataSink data_sink; + + data_sink.write = [&](const char *d, size_t l) { + if (ok) { + offset += l; + if (!write_data(strm, d, l)) { ok = false; } + } + }; + + data_sink.done = [&](void) { data_available = false; }; + + data_sink.is_writable = [&](void) { return ok && strm.is_writable(); }; + + while (data_available && !is_shutting_down()) { + if (!content_provider(offset, 0, data_sink)) { return false; } + if (!ok) { return false; } + } + return true; +} + +template +inline bool +write_content_chunked(Stream &strm, const ContentProvider &content_provider, + const T &is_shutting_down, U &compressor, Error &error) { + size_t offset = 0; + auto data_available = true; + auto ok = true; + DataSink data_sink; + + data_sink.write = [&](const char *d, size_t l) { + if (!ok) { return; } + + data_available = l > 0; + offset += l; + + std::string payload; + if (!compressor.compress(d, l, false, + [&](const char *data, size_t data_len) { + payload.append(data, data_len); + return true; + })) { + ok = false; + return; + } + + if (!payload.empty()) { + // Emit chunked response header and footer for each chunk + auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n"; + if (!write_data(strm, chunk.data(), chunk.size())) { + ok = false; + return; + } + } + }; + + data_sink.done = [&](void) { + if (!ok) { return; } + + data_available = false; + + std::string payload; + if (!compressor.compress(nullptr, 0, true, + [&](const char *data, size_t data_len) { + payload.append(data, data_len); + return true; + })) { + ok = false; + return; + } + + if (!payload.empty()) { + // Emit chunked response header and footer for each chunk + auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n"; + if (!write_data(strm, chunk.data(), chunk.size())) { + ok = false; + return; + } + } + + static const std::string done_marker("0\r\n\r\n"); + if (!write_data(strm, done_marker.data(), done_marker.size())) { + ok = false; + } + }; + + data_sink.is_writable = [&](void) { return ok && strm.is_writable(); }; + + while (data_available && !is_shutting_down()) { + if (!content_provider(offset, 0, data_sink)) { + error = Error::Canceled; + return false; + } + if (!ok) { + error = Error::Write; + return false; + } + } + + error = Error::Success; + return true; +} + +template +inline bool write_content_chunked(Stream &strm, + const ContentProvider &content_provider, + const T &is_shutting_down, U &compressor) { + auto error = Error::Success; + return write_content_chunked(strm, content_provider, is_shutting_down, + compressor, error); +} + +template +inline bool redirect(T &cli, const Request &req, Response &res, + const std::string &path, const std::string &location, + Error &error) { + Request new_req = req; + new_req.path = path; + new_req.redirect_count_ -= 1; + + if (res.status == 303 && (req.method != "GET" && req.method != "HEAD")) { + new_req.method = "GET"; + new_req.body.clear(); + new_req.headers.clear(); + } + + Response new_res; + + auto ret = cli.send(new_req, new_res, error); + if (ret) { + new_res.location = location; + res = new_res; + } + return ret; +} + +inline std::string params_to_query_str(const Params ¶ms) { + std::string query; + + for (auto it = params.begin(); it != params.end(); ++it) { + if (it != params.begin()) { query += "&"; } + query += it->first; + query += "="; + query += encode_query_param(it->second); + } + return query; +} + +inline void parse_query_text(const std::string &s, Params ¶ms) { + split(s.data(), s.data() + s.size(), '&', [&](const char *b, const char *e) { + std::string key; + std::string val; + split(b, e, '=', [&](const char *b2, const char *e2) { + if (key.empty()) { + key.assign(b2, e2); + } else { + val.assign(b2, e2); + } + }); + + if (!key.empty()) { + params.emplace(decode_url(key, true), decode_url(val, true)); + } + }); +} + +inline bool parse_multipart_boundary(const std::string &content_type, + std::string &boundary) { + auto pos = content_type.find("boundary="); + if (pos == std::string::npos) { return false; } + boundary = content_type.substr(pos + 9); + if (boundary.length() >= 2 && boundary.front() == '"' && + boundary.back() == '"') { + boundary = boundary.substr(1, boundary.size() - 2); + } + return !boundary.empty(); +} + +inline bool parse_range_header(const std::string &s, Ranges &ranges) try { + static auto re_first_range = std::regex(R"(bytes=(\d*-\d*(?:,\s*\d*-\d*)*))"); + std::smatch m; + if (std::regex_match(s, m, re_first_range)) { + auto pos = static_cast(m.position(1)); + auto len = static_cast(m.length(1)); + bool all_valid_ranges = true; + split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) { + if (!all_valid_ranges) return; + static auto re_another_range = std::regex(R"(\s*(\d*)-(\d*))"); + std::cmatch cm; + if (std::regex_match(b, e, cm, re_another_range)) { + ssize_t first = -1; + if (!cm.str(1).empty()) { + first = static_cast(std::stoll(cm.str(1))); + } + + ssize_t last = -1; + if (!cm.str(2).empty()) { + last = static_cast(std::stoll(cm.str(2))); + } + + if (first != -1 && last != -1 && first > last) { + all_valid_ranges = false; + return; + } + ranges.emplace_back(std::make_pair(first, last)); + } + }); + return all_valid_ranges; + } + return false; +} catch (...) { return false; } + +class MultipartFormDataParser { +public: + MultipartFormDataParser() = default; + + void set_boundary(std::string &&boundary) { boundary_ = boundary; } + + bool is_valid() const { return is_valid_; } + + bool parse(const char *buf, size_t n, const ContentReceiver &content_callback, + const MultipartContentHeader &header_callback) { + + static const std::regex re_content_disposition( + "^Content-Disposition:\\s*form-data;\\s*name=\"(.*?)\"(?:;\\s*filename=" + "\"(.*?)\")?\\s*$", + std::regex_constants::icase); + static const std::string dash_ = "--"; + static const std::string crlf_ = "\r\n"; + + buf_.append(buf, n); // TODO: performance improvement + + while (!buf_.empty()) { + switch (state_) { + case 0: { // Initial boundary + auto pattern = dash_ + boundary_ + crlf_; + if (pattern.size() > buf_.size()) { return true; } + auto pos = buf_.find(pattern); + if (pos != 0) { return false; } + buf_.erase(0, pattern.size()); + off_ += pattern.size(); + state_ = 1; + break; + } + case 1: { // New entry + clear_file_info(); + state_ = 2; + break; + } + case 2: { // Headers + auto pos = buf_.find(crlf_); + while (pos != std::string::npos) { + // Empty line + if (pos == 0) { + if (!header_callback(file_)) { + is_valid_ = false; + return false; + } + buf_.erase(0, crlf_.size()); + off_ += crlf_.size(); + state_ = 3; + break; + } + + static const std::string header_name = "content-type:"; + const auto header = buf_.substr(0, pos); + if (start_with_case_ignore(header, header_name)) { + file_.content_type = trim_copy(header.substr(header_name.size())); + } else { + std::smatch m; + if (std::regex_match(header, m, re_content_disposition)) { + file_.name = m[1]; + file_.filename = m[2]; + } + } + + buf_.erase(0, pos + crlf_.size()); + off_ += pos + crlf_.size(); + pos = buf_.find(crlf_); + } + if (state_ != 3) { return true; } + break; + } + case 3: { // Body + { + auto pattern = crlf_ + dash_; + if (pattern.size() > buf_.size()) { return true; } + + auto pos = find_string(buf_, pattern); + + if (!content_callback(buf_.data(), pos)) { + is_valid_ = false; + return false; + } + + off_ += pos; + buf_.erase(0, pos); + } + { + auto pattern = crlf_ + dash_ + boundary_; + if (pattern.size() > buf_.size()) { return true; } + + auto pos = buf_.find(pattern); + if (pos != std::string::npos) { + if (!content_callback(buf_.data(), pos)) { + is_valid_ = false; + return false; + } + + off_ += pos + pattern.size(); + buf_.erase(0, pos + pattern.size()); + state_ = 4; + } else { + if (!content_callback(buf_.data(), pattern.size())) { + is_valid_ = false; + return false; + } + + off_ += pattern.size(); + buf_.erase(0, pattern.size()); + } + } + break; + } + case 4: { // Boundary + if (crlf_.size() > buf_.size()) { return true; } + if (buf_.compare(0, crlf_.size(), crlf_) == 0) { + buf_.erase(0, crlf_.size()); + off_ += crlf_.size(); + state_ = 1; + } else { + auto pattern = dash_ + crlf_; + if (pattern.size() > buf_.size()) { return true; } + if (buf_.compare(0, pattern.size(), pattern) == 0) { + buf_.erase(0, pattern.size()); + off_ += pattern.size(); + is_valid_ = true; + state_ = 5; + } else { + return true; + } + } + break; + } + case 5: { // Done + is_valid_ = false; + return false; + } + } + } + + return true; + } + +private: + void clear_file_info() { + file_.name.clear(); + file_.filename.clear(); + file_.content_type.clear(); + } + + bool start_with_case_ignore(const std::string &a, + const std::string &b) const { + if (a.size() < b.size()) { return false; } + for (size_t i = 0; i < b.size(); i++) { + if (::tolower(a[i]) != ::tolower(b[i])) { return false; } + } + return true; + } + + bool start_with(const std::string &a, size_t off, + const std::string &b) const { + if (a.size() - off < b.size()) { return false; } + for (size_t i = 0; i < b.size(); i++) { + if (a[i + off] != b[i]) { return false; } + } + return true; + } + + size_t find_string(const std::string &s, const std::string &pattern) const { + auto c = pattern.front(); + + size_t off = 0; + while (off < s.size()) { + auto pos = s.find(c, off); + if (pos == std::string::npos) { return s.size(); } + + auto rem = s.size() - pos; + if (pattern.size() > rem) { return pos; } + + if (start_with(s, pos, pattern)) { return pos; } + + off = pos + 1; + } + + return s.size(); + } + + std::string boundary_; + + std::string buf_; + size_t state_ = 0; + bool is_valid_ = false; + size_t off_ = 0; + MultipartFormData file_; +}; + +inline std::string to_lower(const char *beg, const char *end) { + std::string out; + auto it = beg; + while (it != end) { + out += static_cast(::tolower(*it)); + it++; + } + return out; +} + +inline std::string make_multipart_data_boundary() { + static const char data[] = + "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"; + + // std::random_device might actually be deterministic on some + // platforms, but due to lack of support in the c++ standard library, + // doing better requires either some ugly hacks or breaking portability. + std::random_device seed_gen; + // Request 128 bits of entropy for initialization + std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()}; + std::mt19937 engine(seed_sequence); + + std::string result = "--cpp-httplib-multipart-data-"; + + for (auto i = 0; i < 16; i++) { + result += data[engine() % (sizeof(data) - 1)]; + } + + return result; +} + +inline std::pair +get_range_offset_and_length(const Request &req, size_t content_length, + size_t index) { + auto r = req.ranges[index]; + + if (r.first == -1 && r.second == -1) { + return std::make_pair(0, content_length); + } + + auto slen = static_cast(content_length); + + if (r.first == -1) { + r.first = (std::max)(static_cast(0), slen - r.second); + r.second = slen - 1; + } + + if (r.second == -1) { r.second = slen - 1; } + return std::make_pair(r.first, static_cast(r.second - r.first) + 1); +} + +inline std::string make_content_range_header_field(size_t offset, size_t length, + size_t content_length) { + std::string field = "bytes "; + field += std::to_string(offset); + field += "-"; + field += std::to_string(offset + length - 1); + field += "/"; + field += std::to_string(content_length); + return field; +} + +template +bool process_multipart_ranges_data(const Request &req, Response &res, + const std::string &boundary, + const std::string &content_type, + SToken stoken, CToken ctoken, + Content content) { + for (size_t i = 0; i < req.ranges.size(); i++) { + ctoken("--"); + stoken(boundary); + ctoken("\r\n"); + if (!content_type.empty()) { + ctoken("Content-Type: "); + stoken(content_type); + ctoken("\r\n"); + } + + auto offsets = get_range_offset_and_length(req, res.body.size(), i); + auto offset = offsets.first; + auto length = offsets.second; + + ctoken("Content-Range: "); + stoken(make_content_range_header_field(offset, length, res.body.size())); + ctoken("\r\n"); + ctoken("\r\n"); + if (!content(offset, length)) { return false; } + ctoken("\r\n"); + } + + ctoken("--"); + stoken(boundary); + ctoken("--\r\n"); + + return true; +} + +inline bool make_multipart_ranges_data(const Request &req, Response &res, + const std::string &boundary, + const std::string &content_type, + std::string &data) { + return process_multipart_ranges_data( + req, res, boundary, content_type, + [&](const std::string &token) { data += token; }, + [&](const char *token) { data += token; }, + [&](size_t offset, size_t length) { + if (offset < res.body.size()) { + data += res.body.substr(offset, length); + return true; + } + return false; + }); +} + +inline size_t +get_multipart_ranges_data_length(const Request &req, Response &res, + const std::string &boundary, + const std::string &content_type) { + size_t data_length = 0; + + process_multipart_ranges_data( + req, res, boundary, content_type, + [&](const std::string &token) { data_length += token.size(); }, + [&](const char *token) { data_length += strlen(token); }, + [&](size_t /*offset*/, size_t length) { + data_length += length; + return true; + }); + + return data_length; +} + +template +inline bool write_multipart_ranges_data(Stream &strm, const Request &req, + Response &res, + const std::string &boundary, + const std::string &content_type, + const T &is_shutting_down) { + return process_multipart_ranges_data( + req, res, boundary, content_type, + [&](const std::string &token) { strm.write(token); }, + [&](const char *token) { strm.write(token); }, + [&](size_t offset, size_t length) { + return write_content(strm, res.content_provider_, offset, length, + is_shutting_down); + }); +} + +inline std::pair +get_range_offset_and_length(const Request &req, const Response &res, + size_t index) { + auto r = req.ranges[index]; + + if (r.second == -1) { + r.second = static_cast(res.content_length_) - 1; + } + + return std::make_pair(r.first, r.second - r.first + 1); +} + +inline bool expect_content(const Request &req) { + if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" || + req.method == "PRI" || req.method == "DELETE") { + return true; + } + // TODO: check if Content-Length is set + return false; +} + +inline bool has_crlf(const char *s) { + auto p = s; + while (*p) { + if (*p == '\r' || *p == '\n') { return true; } + p++; + } + return false; +} + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +template +inline std::string message_digest(const std::string &s, Init init, + Update update, Final final, + size_t digest_length) { + using namespace std; + + std::vector md(digest_length, 0); + CTX ctx; + init(&ctx); + update(&ctx, s.data(), s.size()); + final(md.data(), &ctx); + + stringstream ss; + for (auto c : md) { + ss << setfill('0') << setw(2) << hex << (unsigned int)c; + } + return ss.str(); +} + +inline std::string MD5(const std::string &s) { + return message_digest(s, MD5_Init, MD5_Update, MD5_Final, + MD5_DIGEST_LENGTH); +} + +inline std::string SHA_256(const std::string &s) { + return message_digest(s, SHA256_Init, SHA256_Update, SHA256_Final, + SHA256_DIGEST_LENGTH); +} + +inline std::string SHA_512(const std::string &s) { + return message_digest(s, SHA512_Init, SHA512_Update, SHA512_Final, + SHA512_DIGEST_LENGTH); +} +#endif + +#ifdef _WIN32 +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +// NOTE: This code came up with the following stackoverflow post: +// https://stackoverflow.com/questions/9507184/can-openssl-on-windows-use-the-system-certificate-store +inline bool load_system_certs_on_windows(X509_STORE *store) { + auto hStore = CertOpenSystemStoreW((HCRYPTPROV_LEGACY)NULL, L"ROOT"); + + if (!hStore) { return false; } + + PCCERT_CONTEXT pContext = NULL; + while (pContext = CertEnumCertificatesInStore(hStore, pContext)) { + auto encoded_cert = + static_cast(pContext->pbCertEncoded); + + auto x509 = d2i_X509(NULL, &encoded_cert, pContext->cbCertEncoded); + if (x509) { + X509_STORE_add_cert(store, x509); + X509_free(x509); + } + } + + CertFreeCertificateContext(pContext); + CertCloseStore(hStore, 0); + + return true; +} +#endif + +class WSInit { +public: + WSInit() { + WSADATA wsaData; + WSAStartup(0x0002, &wsaData); + } + + ~WSInit() { WSACleanup(); } +}; + +static WSInit wsinit_; +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline std::pair make_digest_authentication_header( + const Request &req, const std::map &auth, + size_t cnonce_count, const std::string &cnonce, const std::string &username, + const std::string &password, bool is_proxy = false) { + using namespace std; + + string nc; + { + stringstream ss; + ss << setfill('0') << setw(8) << hex << cnonce_count; + nc = ss.str(); + } + + auto qop = auth.at("qop"); + if (qop.find("auth-int") != std::string::npos) { + qop = "auth-int"; + } else { + qop = "auth"; + } + + std::string algo = "MD5"; + if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); } + + string response; + { + auto H = algo == "SHA-256" + ? detail::SHA_256 + : algo == "SHA-512" ? detail::SHA_512 : detail::MD5; + + auto A1 = username + ":" + auth.at("realm") + ":" + password; + + auto A2 = req.method + ":" + req.path; + if (qop == "auth-int") { A2 += ":" + H(req.body); } + + response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce + + ":" + qop + ":" + H(A2)); + } + + auto field = "Digest username=\"" + username + "\", realm=\"" + + auth.at("realm") + "\", nonce=\"" + auth.at("nonce") + + "\", uri=\"" + req.path + "\", algorithm=" + algo + + ", qop=" + qop + ", nc=\"" + nc + "\", cnonce=\"" + cnonce + + "\", response=\"" + response + "\""; + + auto key = is_proxy ? "Proxy-Authorization" : "Authorization"; + return std::make_pair(key, field); +} +#endif + +inline bool parse_www_authenticate(const Response &res, + std::map &auth, + bool is_proxy) { + auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate"; + if (res.has_header(auth_key)) { + static auto re = std::regex(R"~((?:(?:,\s*)?(.+?)=(?:"(.*?)"|([^,]*))))~"); + auto s = res.get_header_value(auth_key); + auto pos = s.find(' '); + if (pos != std::string::npos) { + auto type = s.substr(0, pos); + if (type == "Basic") { + return false; + } else if (type == "Digest") { + s = s.substr(pos + 1); + auto beg = std::sregex_iterator(s.begin(), s.end(), re); + for (auto i = beg; i != std::sregex_iterator(); ++i) { + auto m = *i; + auto key = s.substr(static_cast(m.position(1)), + static_cast(m.length(1))); + auto val = m.length(2) > 0 + ? s.substr(static_cast(m.position(2)), + static_cast(m.length(2))) + : s.substr(static_cast(m.position(3)), + static_cast(m.length(3))); + auth[key] = val; + } + return true; + } + } + } + return false; +} + +// https://stackoverflow.com/questions/440133/how-do-i-create-a-random-alpha-numeric-string-in-c/440240#answer-440240 +inline std::string random_string(size_t length) { + auto randchar = []() -> char { + const char charset[] = "0123456789" + "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + "abcdefghijklmnopqrstuvwxyz"; + const size_t max_index = (sizeof(charset) - 1); + return charset[static_cast(rand()) % max_index]; + }; + std::string str(length, 0); + std::generate_n(str.begin(), length, randchar); + return str; +} + +class ContentProviderAdapter { +public: + explicit ContentProviderAdapter( + ContentProviderWithoutLength &&content_provider) + : content_provider_(content_provider) {} + + bool operator()(size_t offset, size_t, DataSink &sink) { + return content_provider_(offset, sink); + } + +private: + ContentProviderWithoutLength content_provider_; +}; + +} // namespace detail + +// Header utilities +inline std::pair make_range_header(Ranges ranges) { + std::string field = "bytes="; + auto i = 0; + for (auto r : ranges) { + if (i != 0) { field += ", "; } + if (r.first != -1) { field += std::to_string(r.first); } + field += '-'; + if (r.second != -1) { field += std::to_string(r.second); } + i++; + } + return std::make_pair("Range", std::move(field)); +} + +inline std::pair +make_basic_authentication_header(const std::string &username, + const std::string &password, + bool is_proxy = false) { + auto field = "Basic " + detail::base64_encode(username + ":" + password); + auto key = is_proxy ? "Proxy-Authorization" : "Authorization"; + return std::make_pair(key, std::move(field)); +} + +inline std::pair +make_bearer_token_authentication_header(const std::string &token, + bool is_proxy = false) { + auto field = "Bearer " + token; + auto key = is_proxy ? "Proxy-Authorization" : "Authorization"; + return std::make_pair(key, std::move(field)); +} + +// Request implementation +inline bool Request::has_header(const char *key) const { + return detail::has_header(headers, key); +} + +inline std::string Request::get_header_value(const char *key, size_t id) const { + return detail::get_header_value(headers, key, id, ""); +} + +template +inline T Request::get_header_value(const char *key, size_t id) const { + return detail::get_header_value(headers, key, id, 0); +} + +inline size_t Request::get_header_value_count(const char *key) const { + auto r = headers.equal_range(key); + return static_cast(std::distance(r.first, r.second)); +} + +inline void Request::set_header(const char *key, const char *val) { + if (!detail::has_crlf(key) && !detail::has_crlf(val)) { + headers.emplace(key, val); + } +} + +inline void Request::set_header(const char *key, const std::string &val) { + if (!detail::has_crlf(key) && !detail::has_crlf(val.c_str())) { + headers.emplace(key, val); + } +} + +inline bool Request::has_param(const char *key) const { + return params.find(key) != params.end(); +} + +inline std::string Request::get_param_value(const char *key, size_t id) const { + auto rng = params.equal_range(key); + auto it = rng.first; + std::advance(it, static_cast(id)); + if (it != rng.second) { return it->second; } + return std::string(); +} + +inline size_t Request::get_param_value_count(const char *key) const { + auto r = params.equal_range(key); + return static_cast(std::distance(r.first, r.second)); +} + +inline bool Request::is_multipart_form_data() const { + const auto &content_type = get_header_value("Content-Type"); + return !content_type.find("multipart/form-data"); +} + +inline bool Request::has_file(const char *key) const { + return files.find(key) != files.end(); +} + +inline MultipartFormData Request::get_file_value(const char *key) const { + auto it = files.find(key); + if (it != files.end()) { return it->second; } + return MultipartFormData(); +} + +// Response implementation +inline bool Response::has_header(const char *key) const { + return headers.find(key) != headers.end(); +} + +inline std::string Response::get_header_value(const char *key, + size_t id) const { + return detail::get_header_value(headers, key, id, ""); +} + +template +inline T Response::get_header_value(const char *key, size_t id) const { + return detail::get_header_value(headers, key, id, 0); +} + +inline size_t Response::get_header_value_count(const char *key) const { + auto r = headers.equal_range(key); + return static_cast(std::distance(r.first, r.second)); +} + +inline void Response::set_header(const char *key, const char *val) { + if (!detail::has_crlf(key) && !detail::has_crlf(val)) { + headers.emplace(key, val); + } +} + +inline void Response::set_header(const char *key, const std::string &val) { + if (!detail::has_crlf(key) && !detail::has_crlf(val.c_str())) { + headers.emplace(key, val); + } +} + +inline void Response::set_redirect(const char *url, int stat) { + if (!detail::has_crlf(url)) { + set_header("Location", url); + if (300 <= stat && stat < 400) { + this->status = stat; + } else { + this->status = 302; + } + } +} + +inline void Response::set_redirect(const std::string &url, int stat) { + set_redirect(url.c_str(), stat); +} + +inline void Response::set_content(const char *s, size_t n, + const char *content_type) { + body.assign(s, n); + + auto rng = headers.equal_range("Content-Type"); + headers.erase(rng.first, rng.second); + set_header("Content-Type", content_type); +} + +inline void Response::set_content(const std::string &s, + const char *content_type) { + set_content(s.data(), s.size(), content_type); +} + +inline void +Response::set_content_provider(size_t in_length, const char *content_type, + ContentProvider provider, + const std::function &resource_releaser) { + assert(in_length > 0); + set_header("Content-Type", content_type); + content_length_ = in_length; + content_provider_ = std::move(provider); + content_provider_resource_releaser_ = resource_releaser; + is_chunked_content_provider_ = false; +} + +inline void +Response::set_content_provider(const char *content_type, + ContentProviderWithoutLength provider, + const std::function &resource_releaser) { + set_header("Content-Type", content_type); + content_length_ = 0; + content_provider_ = detail::ContentProviderAdapter(std::move(provider)); + content_provider_resource_releaser_ = resource_releaser; + is_chunked_content_provider_ = false; +} + +inline void Response::set_chunked_content_provider( + const char *content_type, ContentProviderWithoutLength provider, + const std::function &resource_releaser) { + set_header("Content-Type", content_type); + content_length_ = 0; + content_provider_ = detail::ContentProviderAdapter(std::move(provider)); + content_provider_resource_releaser_ = resource_releaser; + is_chunked_content_provider_ = true; +} + +// Rstream implementation +inline ssize_t Stream::write(const char *ptr) { + return write(ptr, strlen(ptr)); +} + +inline ssize_t Stream::write(const std::string &s) { + return write(s.data(), s.size()); +} + +template +inline ssize_t Stream::write_format(const char *fmt, const Args &... args) { + const auto bufsiz = 2048; + std::array buf; + +#if defined(_MSC_VER) && _MSC_VER < 1900 + auto sn = _snprintf_s(buf.data(), bufsiz - 1, buf.size() - 1, fmt, args...); +#else + auto sn = snprintf(buf.data(), buf.size() - 1, fmt, args...); +#endif + if (sn <= 0) { return sn; } + + auto n = static_cast(sn); + + if (n >= buf.size() - 1) { + std::vector glowable_buf(buf.size()); + + while (n >= glowable_buf.size() - 1) { + glowable_buf.resize(glowable_buf.size() * 2); +#if defined(_MSC_VER) && _MSC_VER < 1900 + n = static_cast(_snprintf_s(&glowable_buf[0], glowable_buf.size(), + glowable_buf.size() - 1, fmt, + args...)); +#else + n = static_cast( + snprintf(&glowable_buf[0], glowable_buf.size() - 1, fmt, args...)); +#endif + } + return write(&glowable_buf[0], n); + } else { + return write(buf.data(), n); + } +} + +namespace detail { + +// Socket stream implementation +inline SocketStream::SocketStream(socket_t sock, time_t read_timeout_sec, + time_t read_timeout_usec, + time_t write_timeout_sec, + time_t write_timeout_usec) + : sock_(sock), read_timeout_sec_(read_timeout_sec), + read_timeout_usec_(read_timeout_usec), + write_timeout_sec_(write_timeout_sec), + write_timeout_usec_(write_timeout_usec) {} + +inline SocketStream::~SocketStream() {} + +inline bool SocketStream::is_readable() const { + return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0; +} + +inline bool SocketStream::is_writable() const { + return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0; +} + +inline ssize_t SocketStream::read(char *ptr, size_t size) { + if (!is_readable()) { return -1; } + +#ifdef _WIN32 + if (size > static_cast((std::numeric_limits::max)())) { + return -1; + } + return recv(sock_, ptr, static_cast(size), CPPHTTPLIB_RECV_FLAGS); +#else + return handle_EINTR( + [&]() { return recv(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS); }); +#endif +} + +inline ssize_t SocketStream::write(const char *ptr, size_t size) { + if (!is_writable()) { return -1; } + +#ifdef _WIN32 + if (size > static_cast((std::numeric_limits::max)())) { + return -1; + } + return send(sock_, ptr, static_cast(size), CPPHTTPLIB_SEND_FLAGS); +#else + return handle_EINTR( + [&]() { return send(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS); }); +#endif +} + +inline void SocketStream::get_remote_ip_and_port(std::string &ip, + int &port) const { + return detail::get_remote_ip_and_port(sock_, ip, port); +} + +inline socket_t SocketStream::socket() const { return sock_; } + +// Buffer stream implementation +inline bool BufferStream::is_readable() const { return true; } + +inline bool BufferStream::is_writable() const { return true; } + +inline ssize_t BufferStream::read(char *ptr, size_t size) { +#if defined(_MSC_VER) && _MSC_VER <= 1900 + auto len_read = buffer._Copy_s(ptr, size, size, position); +#else + auto len_read = buffer.copy(ptr, size, position); +#endif + position += static_cast(len_read); + return static_cast(len_read); +} + +inline ssize_t BufferStream::write(const char *ptr, size_t size) { + buffer.append(ptr, size); + return static_cast(size); +} + +inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/, + int & /*port*/) const {} + +inline socket_t BufferStream::socket() const { return 0; } + +inline const std::string &BufferStream::get_buffer() const { return buffer; } + +} // namespace detail + +// HTTP server implementation +inline Server::Server() + : new_task_queue( + [] { return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT); }), + svr_sock_(INVALID_SOCKET), is_running_(false) { +#ifndef _WIN32 + signal(SIGPIPE, SIG_IGN); +#endif +} + +inline Server::~Server() {} + +inline Server &Server::Get(const char *pattern, Handler handler) { + get_handlers_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Post(const char *pattern, Handler handler) { + post_handlers_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Post(const char *pattern, + HandlerWithContentReader handler) { + post_handlers_for_content_reader_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Put(const char *pattern, Handler handler) { + put_handlers_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Put(const char *pattern, + HandlerWithContentReader handler) { + put_handlers_for_content_reader_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Patch(const char *pattern, Handler handler) { + patch_handlers_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Patch(const char *pattern, + HandlerWithContentReader handler) { + patch_handlers_for_content_reader_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Delete(const char *pattern, Handler handler) { + delete_handlers_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Delete(const char *pattern, + HandlerWithContentReader handler) { + delete_handlers_for_content_reader_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline Server &Server::Options(const char *pattern, Handler handler) { + options_handlers_.push_back( + std::make_pair(std::regex(pattern), std::move(handler))); + return *this; +} + +inline bool Server::set_base_dir(const char *dir, const char *mount_point) { + return set_mount_point(mount_point, dir); +} + +inline bool Server::set_mount_point(const char *mount_point, const char *dir, + Headers headers) { + if (detail::is_dir(dir)) { + std::string mnt = mount_point ? mount_point : "/"; + if (!mnt.empty() && mnt[0] == '/') { + base_dirs_.push_back({mnt, dir, std::move(headers)}); + return true; + } + } + return false; +} + +inline bool Server::remove_mount_point(const char *mount_point) { + for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) { + if (it->mount_point == mount_point) { + base_dirs_.erase(it); + return true; + } + } + return false; +} + +inline void Server::set_file_extension_and_mimetype_mapping(const char *ext, + const char *mime) { + file_extension_and_mimetype_map_[ext] = mime; +} + +inline void Server::set_file_request_handler(Handler handler) { + file_request_handler_ = std::move(handler); +} + +inline void Server::set_error_handler(Handler handler) { + error_handler_ = std::move(handler); +} + +inline void Server::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; } + +inline void Server::set_socket_options(SocketOptions socket_options) { + socket_options_ = std::move(socket_options); +} + +inline void Server::set_logger(Logger logger) { logger_ = std::move(logger); } + +inline void +Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) { + expect_100_continue_handler_ = std::move(handler); +} + +inline void Server::set_keep_alive_max_count(size_t count) { + keep_alive_max_count_ = count; +} + +inline void Server::set_keep_alive_timeout(time_t sec) { + keep_alive_timeout_sec_ = sec; +} + +inline void Server::set_read_timeout(time_t sec, time_t usec) { + read_timeout_sec_ = sec; + read_timeout_usec_ = usec; +} + +inline void Server::set_write_timeout(time_t sec, time_t usec) { + write_timeout_sec_ = sec; + write_timeout_usec_ = usec; +} + +inline void Server::set_idle_interval(time_t sec, time_t usec) { + idle_interval_sec_ = sec; + idle_interval_usec_ = usec; +} + +inline void Server::set_payload_max_length(size_t length) { + payload_max_length_ = length; +} + +inline bool Server::bind_to_port(const char *host, int port, int socket_flags) { + if (bind_internal(host, port, socket_flags) < 0) return false; + return true; +} +inline int Server::bind_to_any_port(const char *host, int socket_flags) { + return bind_internal(host, 0, socket_flags); +} + +inline bool Server::listen_after_bind() { return listen_internal(); } + +inline bool Server::listen(const char *host, int port, int socket_flags) { + return bind_to_port(host, port, socket_flags) && listen_internal(); +} + +inline bool Server::is_running() const { return is_running_; } + +inline void Server::stop() { + if (is_running_) { + assert(svr_sock_ != INVALID_SOCKET); + std::atomic sock(svr_sock_.exchange(INVALID_SOCKET)); + detail::shutdown_socket(sock); + detail::close_socket(sock); + } +} + +inline bool Server::parse_request_line(const char *s, Request &req) { + const static std::regex re( + "(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|PRI) " + "(([^? ]+)(?:\\?([^ ]*?))?) +(HTTP/1\\.[01])\r\n"); + + std::cmatch m; + if (std::regex_match(s, m, re)) { + req.version = std::string(m[5]); + req.method = std::string(m[1]); + req.target = std::string(m[2]); + req.path = detail::decode_url(m[3], false); + + // Parse query text + auto len = std::distance(m[4].first, m[4].second); + if (len > 0) { detail::parse_query_text(m[4], req.params); } + + return true; + } + + return false; +} + +inline bool Server::write_response(Stream &strm, bool close_connection, + const Request &req, Response &res) { + return write_response_core(strm, close_connection, req, res, false); +} + +inline bool Server::write_response_with_content(Stream &strm, + bool close_connection, + const Request &req, + Response &res) { + return write_response_core(strm, close_connection, req, res, true); +} + +inline bool Server::write_response_core(Stream &strm, bool close_connection, + const Request &req, Response &res, + bool need_apply_ranges) { + assert(res.status != -1); + + if (400 <= res.status && error_handler_) { error_handler_(req, res); } + + std::string content_type; + std::string boundary; + if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); } + + // Headers + if (close_connection || req.get_header_value("Connection") == "close") { + res.set_header("Connection", "close"); + } else { + std::stringstream ss; + ss << "timeout=" << keep_alive_timeout_sec_ + << ", max=" << keep_alive_max_count_; + res.set_header("Keep-Alive", ss.str()); + } + + if (!res.has_header("Content-Type") && + (!res.body.empty() || res.content_length_ > 0 || res.content_provider_)) { + res.set_header("Content-Type", "text/plain"); + } + + if (!res.has_header("Content-Length") && res.body.empty() && + !res.content_length_ && !res.content_provider_) { + res.set_header("Content-Length", "0"); + } + + if (!res.has_header("Accept-Ranges") && req.method == "HEAD") { + res.set_header("Accept-Ranges", "bytes"); + } + + detail::BufferStream bstrm; + + // Response line + if (!bstrm.write_format("HTTP/1.1 %d %s\r\n", res.status, + detail::status_message(res.status))) { + return false; + } + + if (!detail::write_headers(bstrm, res, Headers())) { return false; } + + // Flush buffer + auto &data = bstrm.get_buffer(); + strm.write(data.data(), data.size()); + + // Body + auto ret = true; + if (req.method != "HEAD") { + if (!res.body.empty()) { + if (!strm.write(res.body)) { ret = false; } + } else if (res.content_provider_) { + if (!write_content_with_provider(strm, req, res, boundary, + content_type)) { + ret = false; + } + } + } + + // Log + if (logger_) { logger_(req, res); } + + return ret; +} + +inline bool +Server::write_content_with_provider(Stream &strm, const Request &req, + Response &res, const std::string &boundary, + const std::string &content_type) { + auto is_shutting_down = [this]() { + return this->svr_sock_ == INVALID_SOCKET; + }; + + if (res.content_length_ > 0) { + if (req.ranges.empty()) { + return detail::write_content(strm, res.content_provider_, 0, + res.content_length_, is_shutting_down); + } else if (req.ranges.size() == 1) { + auto offsets = + detail::get_range_offset_and_length(req, res.content_length_, 0); + auto offset = offsets.first; + auto length = offsets.second; + return detail::write_content(strm, res.content_provider_, offset, length, + is_shutting_down); + } else { + return detail::write_multipart_ranges_data( + strm, req, res, boundary, content_type, is_shutting_down); + } + } else { + if (res.is_chunked_content_provider_) { + auto type = detail::encoding_type(req, res); + + std::unique_ptr compressor; + if (type == detail::EncodingType::Gzip) { +#ifdef CPPHTTPLIB_ZLIB_SUPPORT + compressor = detail::make_unique(); +#endif + } else if (type == detail::EncodingType::Brotli) { +#ifdef CPPHTTPLIB_BROTLI_SUPPORT + compressor = detail::make_unique(); +#endif + } else { + compressor = detail::make_unique(); + } + assert(compressor != nullptr); + + return detail::write_content_chunked(strm, res.content_provider_, + is_shutting_down, *compressor); + } else { + return detail::write_content_without_length(strm, res.content_provider_, + is_shutting_down); + } + } + return true; +} + +inline bool Server::read_content(Stream &strm, Request &req, Response &res) { + MultipartFormDataMap::iterator cur; + if (read_content_core( + strm, req, res, + // Regular + [&](const char *buf, size_t n) { + if (req.body.size() + n > req.body.max_size()) { return false; } + req.body.append(buf, n); + return true; + }, + // Multipart + [&](const MultipartFormData &file) { + cur = req.files.emplace(file.name, file); + return true; + }, + [&](const char *buf, size_t n) { + auto &content = cur->second.content; + if (content.size() + n > content.max_size()) { return false; } + content.append(buf, n); + return true; + })) { + const auto &content_type = req.get_header_value("Content-Type"); + if (!content_type.find("application/x-www-form-urlencoded")) { + detail::parse_query_text(req.body, req.params); + } + return true; + } + return false; +} + +inline bool Server::read_content_with_content_receiver( + Stream &strm, Request &req, Response &res, ContentReceiver receiver, + MultipartContentHeader multipart_header, + ContentReceiver multipart_receiver) { + return read_content_core(strm, req, res, std::move(receiver), + std::move(multipart_header), + std::move(multipart_receiver)); +} + +inline bool Server::read_content_core(Stream &strm, Request &req, Response &res, + ContentReceiver receiver, + MultipartContentHeader mulitpart_header, + ContentReceiver multipart_receiver) { + detail::MultipartFormDataParser multipart_form_data_parser; + ContentReceiverWithProgress out; + + if (req.is_multipart_form_data()) { + const auto &content_type = req.get_header_value("Content-Type"); + std::string boundary; + if (!detail::parse_multipart_boundary(content_type, boundary)) { + res.status = 400; + return false; + } + + multipart_form_data_parser.set_boundary(std::move(boundary)); + out = [&](const char *buf, size_t n, uint64_t /*off*/, uint64_t /*len*/) { + /* For debug + size_t pos = 0; + while (pos < n) { + auto read_size = std::min(1, n - pos); + auto ret = multipart_form_data_parser.parse( + buf + pos, read_size, multipart_receiver, mulitpart_header); + if (!ret) { return false; } + pos += read_size; + } + return true; + */ + return multipart_form_data_parser.parse(buf, n, multipart_receiver, + mulitpart_header); + }; + } else { + out = [receiver](const char *buf, size_t n, uint64_t /*off*/, + uint64_t /*len*/) { return receiver(buf, n); }; + } + + if (req.method == "DELETE" && !req.has_header("Content-Length")) { + return true; + } + + if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr, + out, true)) { + return false; + } + + if (req.is_multipart_form_data()) { + if (!multipart_form_data_parser.is_valid()) { + res.status = 400; + return false; + } + } + + return true; +} + +inline bool Server::handle_file_request(Request &req, Response &res, + bool head) { + for (const auto &entry : base_dirs_) { + // Prefix match + if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point)) { + std::string sub_path = "/" + req.path.substr(entry.mount_point.size()); + if (detail::is_valid_path(sub_path)) { + auto path = entry.base_dir + sub_path; + if (path.back() == '/') { path += "index.html"; } + + if (detail::is_file(path)) { + detail::read_file(path, res.body); + auto type = + detail::find_content_type(path, file_extension_and_mimetype_map_); + if (type) { res.set_header("Content-Type", type); } + for (const auto &kv : entry.headers) { + res.set_header(kv.first.c_str(), kv.second); + } + res.status = req.has_header("Range") ? 206 : 200; + if (!head && file_request_handler_) { + file_request_handler_(req, res); + } + return true; + } + } + } + } + return false; +} + +inline socket_t +Server::create_server_socket(const char *host, int port, int socket_flags, + SocketOptions socket_options) const { + return detail::create_socket( + host, port, socket_flags, tcp_nodelay_, std::move(socket_options), + [](socket_t sock, struct addrinfo &ai) -> bool { + if (::bind(sock, ai.ai_addr, static_cast(ai.ai_addrlen))) { + return false; + } + if (::listen(sock, 5)) { // Listen through 5 channels + return false; + } + return true; + }); +} + +inline int Server::bind_internal(const char *host, int port, int socket_flags) { + if (!is_valid()) { return -1; } + + svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_); + if (svr_sock_ == INVALID_SOCKET) { return -1; } + + if (port == 0) { + struct sockaddr_storage addr; + socklen_t addr_len = sizeof(addr); + if (getsockname(svr_sock_, reinterpret_cast(&addr), + &addr_len) == -1) { + return -1; + } + if (addr.ss_family == AF_INET) { + return ntohs(reinterpret_cast(&addr)->sin_port); + } else if (addr.ss_family == AF_INET6) { + return ntohs(reinterpret_cast(&addr)->sin6_port); + } else { + return -1; + } + } else { + return port; + } +} + +inline bool Server::listen_internal() { + auto ret = true; + is_running_ = true; + + { + std::unique_ptr task_queue(new_task_queue()); + + while (svr_sock_ != INVALID_SOCKET) { +#ifndef _WIN32 + if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) { +#endif + auto val = detail::select_read(svr_sock_, idle_interval_sec_, + idle_interval_usec_); + if (val == 0) { // Timeout + task_queue->on_idle(); + continue; + } +#ifndef _WIN32 + } +#endif + socket_t sock = accept(svr_sock_, nullptr, nullptr); + + if (sock == INVALID_SOCKET) { + if (errno == EMFILE) { + // The per-process limit of open file descriptors has been reached. + // Try to accept new connections after a short sleep. + std::this_thread::sleep_for(std::chrono::milliseconds(1)); + continue; + } + if (svr_sock_ != INVALID_SOCKET) { + detail::close_socket(svr_sock_); + ret = false; + } else { + ; // The server socket was closed by user. + } + break; + } + +#if __cplusplus > 201703L + task_queue->enqueue([=, this]() { process_and_close_socket(sock); }); +#else + task_queue->enqueue([=]() { process_and_close_socket(sock); }); +#endif + } + + task_queue->shutdown(); + } + + is_running_ = false; + return ret; +} + +inline bool Server::routing(Request &req, Response &res, Stream &strm) { + // File handler + bool is_head_request = req.method == "HEAD"; + if ((req.method == "GET" || is_head_request) && + handle_file_request(req, res, is_head_request)) { + return true; + } + + if (detail::expect_content(req)) { + // Content reader handler + { + ContentReader reader( + [&](ContentReceiver receiver) { + return read_content_with_content_receiver( + strm, req, res, std::move(receiver), nullptr, nullptr); + }, + [&](MultipartContentHeader header, ContentReceiver receiver) { + return read_content_with_content_receiver(strm, req, res, nullptr, + std::move(header), + std::move(receiver)); + }); + + if (req.method == "POST") { + if (dispatch_request_for_content_reader( + req, res, std::move(reader), + post_handlers_for_content_reader_)) { + return true; + } + } else if (req.method == "PUT") { + if (dispatch_request_for_content_reader( + req, res, std::move(reader), + put_handlers_for_content_reader_)) { + return true; + } + } else if (req.method == "PATCH") { + if (dispatch_request_for_content_reader( + req, res, std::move(reader), + patch_handlers_for_content_reader_)) { + return true; + } + } else if (req.method == "DELETE") { + if (dispatch_request_for_content_reader( + req, res, std::move(reader), + delete_handlers_for_content_reader_)) { + return true; + } + } + } + + // Read content into `req.body` + if (!read_content(strm, req, res)) { return false; } + } + + // Regular handler + if (req.method == "GET" || req.method == "HEAD") { + return dispatch_request(req, res, get_handlers_); + } else if (req.method == "POST") { + return dispatch_request(req, res, post_handlers_); + } else if (req.method == "PUT") { + return dispatch_request(req, res, put_handlers_); + } else if (req.method == "DELETE") { + return dispatch_request(req, res, delete_handlers_); + } else if (req.method == "OPTIONS") { + return dispatch_request(req, res, options_handlers_); + } else if (req.method == "PATCH") { + return dispatch_request(req, res, patch_handlers_); + } + + res.status = 400; + return false; +} + +inline bool Server::dispatch_request(Request &req, Response &res, + const Handlers &handlers) { + try { + for (const auto &x : handlers) { + const auto &pattern = x.first; + const auto &handler = x.second; + + if (std::regex_match(req.path, req.matches, pattern)) { + handler(req, res); + return true; + } + } + } catch (const std::exception &ex) { + res.status = 500; + res.set_header("EXCEPTION_WHAT", ex.what()); + } catch (...) { + res.status = 500; + res.set_header("EXCEPTION_WHAT", "UNKNOWN"); + } + return false; +} + +inline void Server::apply_ranges(const Request &req, Response &res, + std::string &content_type, + std::string &boundary) { + if (req.ranges.size() > 1) { + boundary = detail::make_multipart_data_boundary(); + + auto it = res.headers.find("Content-Type"); + if (it != res.headers.end()) { + content_type = it->second; + res.headers.erase(it); + } + + res.headers.emplace("Content-Type", + "multipart/byteranges; boundary=" + boundary); + } + + auto type = detail::encoding_type(req, res); + + if (res.body.empty()) { + if (res.content_length_ > 0) { + size_t length = 0; + if (req.ranges.empty()) { + length = res.content_length_; + } else if (req.ranges.size() == 1) { + auto offsets = + detail::get_range_offset_and_length(req, res.content_length_, 0); + auto offset = offsets.first; + length = offsets.second; + auto content_range = detail::make_content_range_header_field( + offset, length, res.content_length_); + res.set_header("Content-Range", content_range); + } else { + length = detail::get_multipart_ranges_data_length(req, res, boundary, + content_type); + } + res.set_header("Content-Length", std::to_string(length)); + } else { + if (res.content_provider_) { + if (res.is_chunked_content_provider_) { + res.set_header("Transfer-Encoding", "chunked"); + if (type == detail::EncodingType::Gzip) { + res.set_header("Content-Encoding", "gzip"); + } else if (type == detail::EncodingType::Brotli) { + res.set_header("Content-Encoding", "br"); + } + } + } + } + } else { + if (req.ranges.empty()) { + ; + } else if (req.ranges.size() == 1) { + auto offsets = + detail::get_range_offset_and_length(req, res.body.size(), 0); + auto offset = offsets.first; + auto length = offsets.second; + auto content_range = detail::make_content_range_header_field( + offset, length, res.body.size()); + res.set_header("Content-Range", content_range); + if (offset < res.body.size()) { + res.body = res.body.substr(offset, length); + } else { + res.body.clear(); + res.status = 416; + } + } else { + std::string data; + if (detail::make_multipart_ranges_data(req, res, boundary, content_type, + data)) { + res.body.swap(data); + } else { + res.body.clear(); + res.status = 416; + } + } + + if (type != detail::EncodingType::None) { + std::unique_ptr compressor; + std::string content_encoding; + + if (type == detail::EncodingType::Gzip) { +#ifdef CPPHTTPLIB_ZLIB_SUPPORT + compressor = detail::make_unique(); + content_encoding = "gzip"; +#endif + } else if (type == detail::EncodingType::Brotli) { +#ifdef CPPHTTPLIB_BROTLI_SUPPORT + compressor = detail::make_unique(); + content_encoding = "br"; +#endif + } + + if (compressor) { + std::string compressed; + if (compressor->compress(res.body.data(), res.body.size(), true, + [&](const char *data, size_t data_len) { + compressed.append(data, data_len); + return true; + })) { + res.body.swap(compressed); + res.set_header("Content-Encoding", content_encoding); + } + } + } + + auto length = std::to_string(res.body.size()); + res.set_header("Content-Length", length); + } +} + +inline bool Server::dispatch_request_for_content_reader( + Request &req, Response &res, ContentReader content_reader, + const HandlersForContentReader &handlers) { + for (const auto &x : handlers) { + const auto &pattern = x.first; + const auto &handler = x.second; + + if (std::regex_match(req.path, req.matches, pattern)) { + handler(req, res, content_reader); + return true; + } + } + return false; +} + +inline bool +Server::process_request(Stream &strm, bool close_connection, + bool &connection_closed, + const std::function &setup_request) { + std::array buf{}; + + detail::stream_line_reader line_reader(strm, buf.data(), buf.size()); + + // Connection has been closed on client + if (!line_reader.getline()) { return false; } + + Request req; + Response res; + + res.version = "HTTP/1.1"; + +#ifdef _WIN32 + // TODO: Increase FD_SETSIZE statically (libzmq), dynamically (MySQL). +#else +#ifndef CPPHTTPLIB_USE_POLL + // Socket file descriptor exceeded FD_SETSIZE... + if (strm.socket() >= FD_SETSIZE) { + Headers dummy; + detail::read_headers(strm, dummy); + res.status = 500; + return write_response(strm, close_connection, req, res); + } +#endif +#endif + + // Check if the request URI doesn't exceed the limit + if (line_reader.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) { + Headers dummy; + detail::read_headers(strm, dummy); + res.status = 414; + return write_response(strm, close_connection, req, res); + } + + // Request line and headers + if (!parse_request_line(line_reader.ptr(), req) || + !detail::read_headers(strm, req.headers)) { + res.status = 400; + return write_response(strm, close_connection, req, res); + } + + if (req.get_header_value("Connection") == "close") { + connection_closed = true; + } + + if (req.version == "HTTP/1.0" && + req.get_header_value("Connection") != "Keep-Alive") { + connection_closed = true; + } + + strm.get_remote_ip_and_port(req.remote_addr, req.remote_port); + req.set_header("REMOTE_ADDR", req.remote_addr); + req.set_header("REMOTE_PORT", std::to_string(req.remote_port)); + + if (req.has_header("Range")) { + const auto &range_header_value = req.get_header_value("Range"); + if (!detail::parse_range_header(range_header_value, req.ranges)) { + res.status = 416; + return write_response(strm, close_connection, req, res); + } + } + + if (setup_request) { setup_request(req); } + + if (req.get_header_value("Expect") == "100-continue") { + auto status = 100; + if (expect_100_continue_handler_) { + status = expect_100_continue_handler_(req, res); + } + switch (status) { + case 100: + case 417: + strm.write_format("HTTP/1.1 %d %s\r\n\r\n", status, + detail::status_message(status)); + break; + default: return write_response(strm, close_connection, req, res); + } + } + + // Rounting + if (routing(req, res, strm)) { + if (res.status == -1) { res.status = req.ranges.empty() ? 200 : 206; } + return write_response_with_content(strm, close_connection, req, res); + } else { + if (res.status == -1) { res.status = 404; } + return write_response(strm, close_connection, req, res); + } +} + +inline bool Server::is_valid() const { return true; } + +inline bool Server::process_and_close_socket(socket_t sock) { + auto ret = detail::process_server_socket( + sock, keep_alive_max_count_, keep_alive_timeout_sec_, read_timeout_sec_, + read_timeout_usec_, write_timeout_sec_, write_timeout_usec_, + [this](Stream &strm, bool close_connection, bool &connection_closed) { + return process_request(strm, close_connection, connection_closed, + nullptr); + }); + + detail::shutdown_socket(sock); + detail::close_socket(sock); + return ret; +} + +// HTTP client implementation +inline ClientImpl::ClientImpl(const std::string &host) + : ClientImpl(host, 80, std::string(), std::string()) {} + +inline ClientImpl::ClientImpl(const std::string &host, int port) + : ClientImpl(host, port, std::string(), std::string()) {} + +inline ClientImpl::ClientImpl(const std::string &host, int port, + const std::string &client_cert_path, + const std::string &client_key_path) + // : (Error::Success), host_(host), port_(port), + : host_(host), port_(port), + host_and_port_(host_ + ":" + std::to_string(port_)), + client_cert_path_(client_cert_path), client_key_path_(client_key_path) {} + +inline ClientImpl::~ClientImpl() { lock_socket_and_shutdown_and_close(); } + +inline bool ClientImpl::is_valid() const { return true; } + +inline void ClientImpl::copy_settings(const ClientImpl &rhs) { + client_cert_path_ = rhs.client_cert_path_; + client_key_path_ = rhs.client_key_path_; + connection_timeout_sec_ = rhs.connection_timeout_sec_; + read_timeout_sec_ = rhs.read_timeout_sec_; + read_timeout_usec_ = rhs.read_timeout_usec_; + write_timeout_sec_ = rhs.write_timeout_sec_; + write_timeout_usec_ = rhs.write_timeout_usec_; + basic_auth_username_ = rhs.basic_auth_username_; + basic_auth_password_ = rhs.basic_auth_password_; + bearer_token_auth_token_ = rhs.bearer_token_auth_token_; +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + digest_auth_username_ = rhs.digest_auth_username_; + digest_auth_password_ = rhs.digest_auth_password_; +#endif + keep_alive_ = rhs.keep_alive_; + follow_location_ = rhs.follow_location_; + tcp_nodelay_ = rhs.tcp_nodelay_; + socket_options_ = rhs.socket_options_; + compress_ = rhs.compress_; + decompress_ = rhs.decompress_; + interface_ = rhs.interface_; + proxy_host_ = rhs.proxy_host_; + proxy_port_ = rhs.proxy_port_; + proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_; + proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_; + proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_; +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_; + proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_; +#endif +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + server_certificate_verification_ = rhs.server_certificate_verification_; +#endif + logger_ = rhs.logger_; +} + +inline socket_t ClientImpl::create_client_socket(Error &error) const { + if (!proxy_host_.empty() && proxy_port_ != -1) { + return detail::create_client_socket( + proxy_host_.c_str(), proxy_port_, tcp_nodelay_, socket_options_, + connection_timeout_sec_, connection_timeout_usec_, interface_, error); + } + return detail::create_client_socket( + host_.c_str(), port_, tcp_nodelay_, socket_options_, + connection_timeout_sec_, connection_timeout_usec_, interface_, error); +} + +inline bool ClientImpl::create_and_connect_socket(Socket &socket, + Error &error) { + auto sock = create_client_socket(error); + if (sock == INVALID_SOCKET) { return false; } + socket.sock = sock; + return true; +} + +inline void ClientImpl::shutdown_ssl(Socket & /*socket*/, + bool /*shutdown_gracefully*/) { + // If there are any requests in flight from threads other than us, then it's + // a thread-unsafe race because individual ssl* objects are not thread-safe. + assert(socket_requests_in_flight_ == 0 || + socket_requests_are_from_thread_ == std::this_thread::get_id()); +} + +inline void ClientImpl::shutdown_socket(Socket &socket) { + if (socket.sock == INVALID_SOCKET) { return; } + detail::shutdown_socket(socket.sock); +} + +inline void ClientImpl::close_socket(Socket &socket) { + // If there are requests in flight in another thread, usually closing + // the socket will be fine and they will simply receive an error when + // using the closed socket, but it is still a bug since rarely the OS + // may reassign the socket id to be used for a new socket, and then + // suddenly they will be operating on a live socket that is different + // than the one they intended! + assert(socket_requests_in_flight_ == 0 || + socket_requests_are_from_thread_ == std::this_thread::get_id()); + + // It is also a bug if this happens while SSL is still active +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + assert(socket.ssl == nullptr); +#endif + if (socket.sock == INVALID_SOCKET) { return; } + detail::close_socket(socket.sock); + socket.sock = INVALID_SOCKET; +} + +inline void ClientImpl::lock_socket_and_shutdown_and_close() { + std::lock_guard guard(socket_mutex_); + shutdown_ssl(socket_, true); + shutdown_socket(socket_); + close_socket(socket_); +} + +inline bool ClientImpl::read_response_line(Stream &strm, const Request &req, + Response &res) { + std::array buf; + + detail::stream_line_reader line_reader(strm, buf.data(), buf.size()); + + if (!line_reader.getline()) { return false; } + + const static std::regex re("(HTTP/1\\.[01]) (\\d{3}) (.*?)\r\n"); + + std::cmatch m; + if (!std::regex_match(line_reader.ptr(), m, re)) { + return req.method == "CONNECT"; + } + res.version = std::string(m[1]); + res.status = std::stoi(std::string(m[2])); + res.reason = std::string(m[3]); + + // Ignore '100 Continue' + while (res.status == 100) { + if (!line_reader.getline()) { return false; } // CRLF + if (!line_reader.getline()) { return false; } // next response line + + if (!std::regex_match(line_reader.ptr(), m, re)) { return false; } + res.version = std::string(m[1]); + res.status = std::stoi(std::string(m[2])); + res.reason = std::string(m[3]); + } + + return true; +} + +inline bool ClientImpl::send(const Request &req, Response &res, Error &error) { + std::lock_guard request_mutex_guard(request_mutex_); + + { + std::lock_guard guard(socket_mutex_); + // Set this to false immediately - if it ever gets set to true by the end of + // the request, we know another thread instructed us to close the socket. + socket_should_be_closed_when_request_is_done_ = false; + + auto is_alive = false; + if (socket_.is_open()) { + is_alive = detail::select_write(socket_.sock, 0, 0) > 0; + if (!is_alive) { + // Attempt to avoid sigpipe by shutting down nongracefully if it seems + // like the other side has already closed the connection Also, there + // cannot be any requests in flight from other threads since we locked + // request_mutex_, so safe to close everything immediately + const bool shutdown_gracefully = false; + shutdown_ssl(socket_, shutdown_gracefully); + shutdown_socket(socket_); + close_socket(socket_); + } + } + + if (!is_alive) { + if (!create_and_connect_socket(socket_, error)) { return false; } + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + // TODO: refactoring + if (is_ssl()) { + auto &scli = static_cast(*this); + if (!proxy_host_.empty() && proxy_port_ != -1) { + bool success = false; + if (!scli.connect_with_proxy(socket_, res, success, error)) { + return success; + } + } + + if (!scli.initialize_ssl(socket_, error)) { return false; } + } +#endif + } + + // Mark the current socket as being in use so that it cannot be closed by + // anyone else while this request is ongoing, even though we will be + // releasing the mutex. + if (socket_requests_in_flight_ > 1) { + assert(socket_requests_are_from_thread_ == std::this_thread::get_id()); + } + socket_requests_in_flight_ += 1; + socket_requests_are_from_thread_ = std::this_thread::get_id(); + } + + auto close_connection = !keep_alive_; + auto ret = process_socket(socket_, [&](Stream &strm) { + return handle_request(strm, req, res, close_connection, error); + }); + + // Briefly lock mutex in order to mark that a request is no longer ongoing + { + std::lock_guard guard(socket_mutex_); + socket_requests_in_flight_ -= 1; + if (socket_requests_in_flight_ <= 0) { + assert(socket_requests_in_flight_ == 0); + socket_requests_are_from_thread_ = std::thread::id(); + } + + if (socket_should_be_closed_when_request_is_done_ || close_connection || + !ret) { + shutdown_ssl(socket_, true); + shutdown_socket(socket_); + close_socket(socket_); + } + } + + if (!ret) { + if (error == Error::Success) { error = Error::Unknown; } + } + + return ret; +} + +inline Result ClientImpl::send(const Request &req) { + auto res = detail::make_unique(); + auto error = Error::Success; + auto ret = send(req, *res, error); + return Result{ret ? std::move(res) : nullptr, error}; +} + +inline bool ClientImpl::handle_request(Stream &strm, const Request &req, + Response &res, bool close_connection, + Error &error) { + if (req.path.empty()) { + error = Error::Connection; + return false; + } + + bool ret; + + if (!is_ssl() && !proxy_host_.empty() && proxy_port_ != -1) { + auto req2 = req; + req2.path = "http://" + host_and_port_ + req.path; + ret = process_request(strm, req2, res, close_connection, error); + } else { + ret = process_request(strm, req, res, close_connection, error); + } + + if (!ret) { return false; } + + if (300 < res.status && res.status < 400 && follow_location_) { + ret = redirect(req, res, error); + } + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + if ((res.status == 401 || res.status == 407) && + req.authorization_count_ < 5) { + auto is_proxy = res.status == 407; + const auto &username = + is_proxy ? proxy_digest_auth_username_ : digest_auth_username_; + const auto &password = + is_proxy ? proxy_digest_auth_password_ : digest_auth_password_; + + if (!username.empty() && !password.empty()) { + std::map auth; + if (detail::parse_www_authenticate(res, auth, is_proxy)) { + Request new_req = req; + new_req.authorization_count_ += 1; + auto key = is_proxy ? "Proxy-Authorization" : "Authorization"; + new_req.headers.erase(key); + new_req.headers.insert(detail::make_digest_authentication_header( + req, auth, new_req.authorization_count_, detail::random_string(10), + username, password, is_proxy)); + + Response new_res; + + ret = send(new_req, new_res, error); + if (ret) { res = new_res; } + } + } + } +#endif + + return ret; +} + +inline bool ClientImpl::redirect(const Request &req, Response &res, + Error &error) { + if (req.redirect_count_ == 0) { + error = Error::ExceedRedirectCount; + return false; + } + + auto location = detail::decode_url(res.get_header_value("location"), true); + if (location.empty()) { return false; } + + const static std::regex re( + R"(^(?:(https?):)?(?://([^:/?#]*)(?::(\d+))?)?([^?#]*(?:\?[^#]*)?)(?:#.*)?)"); + + std::smatch m; + if (!std::regex_match(location, m, re)) { return false; } + + auto scheme = is_ssl() ? "https" : "http"; + + auto next_scheme = m[1].str(); + auto next_host = m[2].str(); + auto port_str = m[3].str(); + auto next_path = m[4].str(); + + auto next_port = port_; + if (!port_str.empty()) { + next_port = std::stoi(port_str); + } else if (!next_scheme.empty()) { + next_port = next_scheme == "https" ? 443 : 80; + } + + if (next_scheme.empty()) { next_scheme = scheme; } + if (next_host.empty()) { next_host = host_; } + if (next_path.empty()) { next_path = "/"; } + + if (next_scheme == scheme && next_host == host_ && next_port == port_) { + return detail::redirect(*this, req, res, next_path, location, error); + } else { + if (next_scheme == "https") { +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + SSLClient cli(next_host.c_str(), next_port); + cli.copy_settings(*this); + return detail::redirect(cli, req, res, next_path, location, error); +#else + return false; +#endif + } else { + ClientImpl cli(next_host.c_str(), next_port); + cli.copy_settings(*this); + return detail::redirect(cli, req, res, next_path, location, error); + } + } +} + +inline bool ClientImpl::write_content_with_provider(Stream &strm, + const Request &req, + Error &error) { + auto is_shutting_down = []() { return false; }; + + if (req.is_chunked_content_provider_) { + // TODO: Brotli suport + std::unique_ptr compressor; +#ifdef CPPHTTPLIB_ZLIB_SUPPORT + if (compress_) { + compressor = detail::make_unique(); + } else +#endif + { + compressor = detail::make_unique(); + } + + return detail::write_content_chunked(strm, req.content_provider_, + is_shutting_down, *compressor, error); + } else { + return detail::write_content(strm, req.content_provider_, 0, + req.content_length_, is_shutting_down, error); + } +} // namespace httplib + +inline bool ClientImpl::write_request(Stream &strm, const Request &req, + bool close_connection, Error &error) { + detail::BufferStream bstrm; + + // Request line + const auto &path = detail::encode_url(req.path); + + bstrm.write_format("%s %s HTTP/1.1\r\n", req.method.c_str(), path.c_str()); + + // Additonal headers + Headers headers; + if (close_connection) { headers.emplace("Connection", "close"); } + + if (!req.has_header("Host")) { + if (is_ssl()) { + if (port_ == 443) { + headers.emplace("Host", host_); + } else { + headers.emplace("Host", host_and_port_); + } + } else { + if (port_ == 80) { + headers.emplace("Host", host_); + } else { + headers.emplace("Host", host_and_port_); + } + } + } + + if (!req.has_header("Accept")) { headers.emplace("Accept", "*/*"); } + + if (!req.has_header("User-Agent")) { + headers.emplace("User-Agent", "cpp-httplib/0.7"); + } + + if (req.body.empty()) { + if (req.content_provider_) { + if (!req.is_chunked_content_provider_) { + auto length = std::to_string(req.content_length_); + headers.emplace("Content-Length", length); + } + } else { + if (req.method == "POST" || req.method == "PUT" || + req.method == "PATCH") { + headers.emplace("Content-Length", "0"); + } + } + } else { + if (!req.has_header("Content-Type")) { + headers.emplace("Content-Type", "text/plain"); + } + + if (!req.has_header("Content-Length")) { + auto length = std::to_string(req.body.size()); + headers.emplace("Content-Length", length); + } + } + + if (!basic_auth_password_.empty()) { + headers.insert(make_basic_authentication_header( + basic_auth_username_, basic_auth_password_, false)); + } + + if (!proxy_basic_auth_username_.empty() && + !proxy_basic_auth_password_.empty()) { + headers.insert(make_basic_authentication_header( + proxy_basic_auth_username_, proxy_basic_auth_password_, true)); + } + + if (!bearer_token_auth_token_.empty()) { + headers.insert(make_bearer_token_authentication_header( + bearer_token_auth_token_, false)); + } + + if (!proxy_bearer_token_auth_token_.empty()) { + headers.insert(make_bearer_token_authentication_header( + proxy_bearer_token_auth_token_, true)); + } + + detail::write_headers(bstrm, req, headers); + + // Flush buffer + auto &data = bstrm.get_buffer(); + if (!detail::write_data(strm, data.data(), data.size())) { + error = Error::Write; + return false; + } + + // Body + if (req.body.empty()) { + return write_content_with_provider(strm, req, error); + } else { + return detail::write_data(strm, req.body.data(), req.body.size()); + } + + return true; +} + +inline std::unique_ptr ClientImpl::send_with_content_provider( + const char *method, const char *path, const Headers &headers, + const std::string &body, size_t content_length, + ContentProvider content_provider, + ContentProviderWithoutLength content_provider_without_length, + const char *content_type, Error &error) { + + Request req; + req.method = method; + req.headers = default_headers_; + req.headers.insert(headers.begin(), headers.end()); + req.path = path; + + if (content_type) { req.headers.emplace("Content-Type", content_type); } + +#ifdef CPPHTTPLIB_ZLIB_SUPPORT + if (compress_) { req.headers.emplace("Content-Encoding", "gzip"); } +#endif + +#ifdef CPPHTTPLIB_ZLIB_SUPPORT + if (compress_ && !content_provider_without_length) { + // TODO: Brotli support + detail::gzip_compressor compressor; + + if (content_provider) { + auto ok = true; + size_t offset = 0; + DataSink data_sink; + + data_sink.write = [&](const char *data, size_t data_len) { + if (ok) { + auto last = offset + data_len == content_length; + + auto ret = compressor.compress( + data, data_len, last, [&](const char *data, size_t data_len) { + req.body.append(data, data_len); + return true; + }); + + if (ret) { + offset += data_len; + } else { + ok = false; + } + } + }; + + data_sink.is_writable = [&](void) { return ok && true; }; + + while (ok && offset < content_length) { + if (!content_provider(offset, content_length - offset, data_sink)) { + error = Error::Canceled; + return nullptr; + } + } + } else { + if (!compressor.compress(body.data(), body.size(), true, + [&](const char *data, size_t data_len) { + req.body.append(data, data_len); + return true; + })) { + error = Error::Compression; + return nullptr; + } + } + } else +#endif + { + if (content_provider) { + req.content_length_ = content_length; + req.content_provider_ = std::move(content_provider); + req.is_chunked_content_provider_ = false; + } else if (content_provider_without_length) { + req.content_length_ = 0; + req.content_provider_ = detail::ContentProviderAdapter( + std::move(content_provider_without_length)); + req.is_chunked_content_provider_ = true; + req.headers.emplace("Transfer-Encoding", "chunked"); + } else { + req.body = body; + } + } + + auto res = detail::make_unique(); + return send(req, *res, error) ? std::move(res) : nullptr; +} + +inline Result ClientImpl::send_with_content_provider( + const char *method, const char *path, const Headers &headers, + const std::string &body, size_t content_length, + ContentProvider content_provider, + ContentProviderWithoutLength content_provider_without_length, + const char *content_type) { + auto error = Error::Success; + auto res = send_with_content_provider( + method, path, headers, body, content_length, std::move(content_provider), + std::move(content_provider_without_length), content_type, error); + return Result{std::move(res), error}; +} + +inline bool ClientImpl::process_request(Stream &strm, const Request &req, + Response &res, bool close_connection, + Error &error) { + // Send request + if (!write_request(strm, req, close_connection, error)) { return false; } + + // Receive response and headers + if (!read_response_line(strm, req, res) || + !detail::read_headers(strm, res.headers)) { + error = Error::Read; + return false; + } + + if (req.response_handler_) { + if (!req.response_handler_(res)) { + error = Error::Canceled; + return false; + } + } + + // Body + if (req.method != "HEAD" && req.method != "CONNECT") { + auto out = + req.content_receiver_ + ? static_cast( + [&](const char *buf, size_t n, uint64_t off, uint64_t len) { + auto ret = req.content_receiver_(buf, n, off, len); + if (!ret) { error = Error::Canceled; } + return ret; + }) + : static_cast( + [&](const char *buf, size_t n, uint64_t /*off*/, + uint64_t /*len*/) { + if (res.body.size() + n > res.body.max_size()) { + return false; + } + res.body.append(buf, n); + return true; + }); + + auto progress = [&](uint64_t current, uint64_t total) { + if (!req.progress_) { return true; } + auto ret = req.progress_(current, total); + if (!ret) { error = Error::Canceled; } + return ret; + }; + + int dummy_status; + if (!detail::read_content(strm, res, (std::numeric_limits::max)(), + dummy_status, std::move(progress), std::move(out), + decompress_)) { + if (error != Error::Canceled) { error = Error::Read; } + return false; + } + } + + if (res.get_header_value("Connection") == "close" || + (res.version == "HTTP/1.0" && res.reason != "Connection established")) { + // TODO this requires a not-entirely-obvious chain of calls to be correct + // for this to be safe. Maybe a code refactor (such as moving this out to + // the send function and getting rid of the recursiveness of the mutex) + // could make this more obvious. + + // This is safe to call because process_request is only called by + // handle_request which is only called by send, which locks the request + // mutex during the process. It would be a bug to call it from a different + // thread since it's a thread-safety issue to do these things to the socket + // if another thread is using the socket. + lock_socket_and_shutdown_and_close(); + } + + // Log + if (logger_) { logger_(req, res); } + + return true; +} + +inline bool +ClientImpl::process_socket(const Socket &socket, + std::function callback) { + return detail::process_client_socket( + socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_, + write_timeout_usec_, std::move(callback)); +} + +inline bool ClientImpl::is_ssl() const { return false; } + +inline Result ClientImpl::Get(const char *path) { + return Get(path, Headers(), Progress()); +} + +inline Result ClientImpl::Get(const char *path, Progress progress) { + return Get(path, Headers(), std::move(progress)); +} + +inline Result ClientImpl::Get(const char *path, const Headers &headers) { + return Get(path, headers, Progress()); +} + +inline Result ClientImpl::Get(const char *path, const Headers &headers, + Progress progress) { + Request req; + req.method = "GET"; + req.path = path; + req.headers = default_headers_; + req.headers.insert(headers.begin(), headers.end()); + req.progress_ = std::move(progress); + + return send(req); +} + +inline Result ClientImpl::Get(const char *path, + ContentReceiver content_receiver) { + return Get(path, Headers(), nullptr, std::move(content_receiver), nullptr); +} + +inline Result ClientImpl::Get(const char *path, + ContentReceiver content_receiver, + Progress progress) { + return Get(path, Headers(), nullptr, std::move(content_receiver), + std::move(progress)); +} + +inline Result ClientImpl::Get(const char *path, const Headers &headers, + ContentReceiver content_receiver) { + return Get(path, headers, nullptr, std::move(content_receiver), nullptr); +} + +inline Result ClientImpl::Get(const char *path, const Headers &headers, + ContentReceiver content_receiver, + Progress progress) { + return Get(path, headers, nullptr, std::move(content_receiver), + std::move(progress)); +} + +inline Result ClientImpl::Get(const char *path, + ResponseHandler response_handler, + ContentReceiver content_receiver) { + return Get(path, Headers(), std::move(response_handler), + std::move(content_receiver), nullptr); +} + +inline Result ClientImpl::Get(const char *path, const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver) { + return Get(path, headers, std::move(response_handler), + std::move(content_receiver), nullptr); +} + +inline Result ClientImpl::Get(const char *path, + ResponseHandler response_handler, + ContentReceiver content_receiver, + Progress progress) { + return Get(path, Headers(), std::move(response_handler), + std::move(content_receiver), std::move(progress)); +} + +inline Result ClientImpl::Get(const char *path, const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver, + Progress progress) { + Request req; + req.method = "GET"; + req.path = path; + req.headers = default_headers_; + req.headers.insert(headers.begin(), headers.end()); + req.response_handler_ = std::move(response_handler); + req.content_receiver_ = + [content_receiver](const char *data, size_t data_length, + uint64_t /*offset*/, uint64_t /*total_length*/) { + return content_receiver(data, data_length); + }; + req.progress_ = std::move(progress); + + return send(req); +} + +inline Result ClientImpl::Head(const char *path) { + return Head(path, Headers()); +} + +inline Result ClientImpl::Head(const char *path, const Headers &headers) { + Request req; + req.method = "HEAD"; + req.headers = default_headers_; + req.headers.insert(headers.begin(), headers.end()); + req.path = path; + + return send(req); +} + +inline Result ClientImpl::Post(const char *path) { + return Post(path, std::string(), nullptr); +} + +inline Result ClientImpl::Post(const char *path, const std::string &body, + const char *content_type) { + return Post(path, Headers(), body, content_type); +} + +inline Result ClientImpl::Post(const char *path, const Headers &headers, + const std::string &body, + const char *content_type) { + return send_with_content_provider("POST", path, headers, body, 0, nullptr, + nullptr, content_type); +} + +inline Result ClientImpl::Post(const char *path, const Params ¶ms) { + return Post(path, Headers(), params); +} + +inline Result ClientImpl::Post(const char *path, size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return Post(path, Headers(), content_length, std::move(content_provider), + content_type); +} + +inline Result ClientImpl::Post(const char *path, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return Post(path, Headers(), std::move(content_provider), content_type); +} + +inline Result ClientImpl::Post(const char *path, const Headers &headers, + size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return send_with_content_provider("POST", path, headers, std::string(), + content_length, std::move(content_provider), + nullptr, content_type); +} + +inline Result ClientImpl::Post(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return send_with_content_provider("POST", path, headers, std::string(), 0, + nullptr, std::move(content_provider), + content_type); +} + +inline Result ClientImpl::Post(const char *path, const Headers &headers, + const Params ¶ms) { + auto query = detail::params_to_query_str(params); + return Post(path, headers, query, "application/x-www-form-urlencoded"); +} + +inline Result ClientImpl::Post(const char *path, + const MultipartFormDataItems &items) { + return Post(path, Headers(), items); +} + +inline Result ClientImpl::Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items) { + return Post(path, headers, items, detail::make_multipart_data_boundary()); +} +inline Result ClientImpl::Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items, + const std::string &boundary) { + for (size_t i = 0; i < boundary.size(); i++) { + char c = boundary[i]; + if (!std::isalnum(c) && c != '-' && c != '_') { + return Result{nullptr, Error::UnsupportedMultipartBoundaryChars}; + } + } + + std::string body; + + for (const auto &item : items) { + body += "--" + boundary + "\r\n"; + body += "Content-Disposition: form-data; name=\"" + item.name + "\""; + if (!item.filename.empty()) { + body += "; filename=\"" + item.filename + "\""; + } + body += "\r\n"; + if (!item.content_type.empty()) { + body += "Content-Type: " + item.content_type + "\r\n"; + } + body += "\r\n"; + body += item.content + "\r\n"; + } + + body += "--" + boundary + "--\r\n"; + + std::string content_type = "multipart/form-data; boundary=" + boundary; + return Post(path, headers, body, content_type.c_str()); +} + +inline Result ClientImpl::Put(const char *path) { + return Put(path, std::string(), nullptr); +} + +inline Result ClientImpl::Put(const char *path, const std::string &body, + const char *content_type) { + return Put(path, Headers(), body, content_type); +} + +inline Result ClientImpl::Put(const char *path, const Headers &headers, + const std::string &body, + const char *content_type) { + return send_with_content_provider("PUT", path, headers, body, 0, nullptr, + nullptr, content_type); +} + +inline Result ClientImpl::Put(const char *path, size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return Put(path, Headers(), content_length, std::move(content_provider), + content_type); +} + +inline Result ClientImpl::Put(const char *path, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return Put(path, Headers(), std::move(content_provider), content_type); +} + +inline Result ClientImpl::Put(const char *path, const Headers &headers, + size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return send_with_content_provider("PUT", path, headers, std::string(), + content_length, std::move(content_provider), + nullptr, content_type); +} + +inline Result ClientImpl::Put(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return send_with_content_provider("PUT", path, headers, std::string(), 0, + nullptr, std::move(content_provider), + content_type); +} + +inline Result ClientImpl::Put(const char *path, const Params ¶ms) { + return Put(path, Headers(), params); +} + +inline Result ClientImpl::Put(const char *path, const Headers &headers, + const Params ¶ms) { + auto query = detail::params_to_query_str(params); + return Put(path, headers, query, "application/x-www-form-urlencoded"); +} + +inline Result ClientImpl::Patch(const char *path, const std::string &body, + const char *content_type) { + return Patch(path, Headers(), body, content_type); +} + +inline Result ClientImpl::Patch(const char *path, const Headers &headers, + const std::string &body, + const char *content_type) { + return send_with_content_provider("PATCH", path, headers, body, 0, nullptr, + nullptr, content_type); +} + +inline Result ClientImpl::Patch(const char *path, size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return Patch(path, Headers(), content_length, std::move(content_provider), + content_type); +} + +inline Result ClientImpl::Patch(const char *path, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return Patch(path, Headers(), std::move(content_provider), content_type); +} + +inline Result ClientImpl::Patch(const char *path, const Headers &headers, + size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return send_with_content_provider("PATCH", path, headers, std::string(), + content_length, std::move(content_provider), + nullptr, content_type); +} + +inline Result ClientImpl::Patch(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return send_with_content_provider("PATCH", path, headers, std::string(), 0, + nullptr, std::move(content_provider), + content_type); +} + +inline Result ClientImpl::Delete(const char *path) { + return Delete(path, Headers(), std::string(), nullptr); +} + +inline Result ClientImpl::Delete(const char *path, const std::string &body, + const char *content_type) { + return Delete(path, Headers(), body, content_type); +} + +inline Result ClientImpl::Delete(const char *path, const Headers &headers) { + return Delete(path, headers, std::string(), nullptr); +} + +inline Result ClientImpl::Delete(const char *path, const Headers &headers, + const std::string &body, + const char *content_type) { + Request req; + req.method = "DELETE"; + req.headers = default_headers_; + req.headers.insert(headers.begin(), headers.end()); + req.path = path; + + if (content_type) { req.headers.emplace("Content-Type", content_type); } + req.body = body; + + return send(req); +} + +inline Result ClientImpl::Options(const char *path) { + return Options(path, Headers()); +} + +inline Result ClientImpl::Options(const char *path, const Headers &headers) { + Request req; + req.method = "OPTIONS"; + req.headers = default_headers_; + req.headers.insert(headers.begin(), headers.end()); + req.path = path; + + return send(req); +} + +inline size_t ClientImpl::is_socket_open() const { + std::lock_guard guard(socket_mutex_); + return socket_.is_open(); +} + +inline void ClientImpl::stop() { + std::lock_guard guard(socket_mutex_); + + // If there is anything ongoing right now, the ONLY thread-safe thing we can + // do is to shutdown_socket, so that threads using this socket suddenly + // discover they can't read/write any more and error out. Everything else + // (closing the socket, shutting ssl down) is unsafe because these actions are + // not thread-safe. + if (socket_requests_in_flight_ > 0) { + shutdown_socket(socket_); + + // Aside from that, we set a flag for the socket to be closed when we're + // done. + socket_should_be_closed_when_request_is_done_ = true; + return; + } + + // Otherwise, sitll holding the mutex, we can shut everything down ourselves + shutdown_ssl(socket_, true); + shutdown_socket(socket_); + close_socket(socket_); +} + +inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) { + connection_timeout_sec_ = sec; + connection_timeout_usec_ = usec; +} + +inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) { + read_timeout_sec_ = sec; + read_timeout_usec_ = usec; +} + +inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) { + write_timeout_sec_ = sec; + write_timeout_usec_ = usec; +} + +inline void ClientImpl::set_basic_auth(const char *username, + const char *password) { + basic_auth_username_ = username; + basic_auth_password_ = password; +} + +inline void ClientImpl::set_bearer_token_auth(const char *token) { + bearer_token_auth_token_ = token; +} + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void ClientImpl::set_digest_auth(const char *username, + const char *password) { + digest_auth_username_ = username; + digest_auth_password_ = password; +} +#endif + +inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; } + +inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; } + +inline void ClientImpl::set_default_headers(Headers headers) { + default_headers_ = std::move(headers); +} + +inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; } + +inline void ClientImpl::set_socket_options(SocketOptions socket_options) { + socket_options_ = std::move(socket_options); +} + +inline void ClientImpl::set_compress(bool on) { compress_ = on; } + +inline void ClientImpl::set_decompress(bool on) { decompress_ = on; } + +inline void ClientImpl::set_interface(const char *intf) { interface_ = intf; } + +inline void ClientImpl::set_proxy(const char *host, int port) { + proxy_host_ = host; + proxy_port_ = port; +} + +inline void ClientImpl::set_proxy_basic_auth(const char *username, + const char *password) { + proxy_basic_auth_username_ = username; + proxy_basic_auth_password_ = password; +} + +inline void ClientImpl::set_proxy_bearer_token_auth(const char *token) { + proxy_bearer_token_auth_token_ = token; +} + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void ClientImpl::set_proxy_digest_auth(const char *username, + const char *password) { + proxy_digest_auth_username_ = username; + proxy_digest_auth_password_ = password; +} +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void ClientImpl::enable_server_certificate_verification(bool enabled) { + server_certificate_verification_ = enabled; +} +#endif + +inline void ClientImpl::set_logger(Logger logger) { + logger_ = std::move(logger); +} + +/* + * SSL Implementation + */ +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +namespace detail { + +template +inline SSL *ssl_new(socket_t sock, SSL_CTX *ctx, std::mutex &ctx_mutex, + U SSL_connect_or_accept, V setup) { + SSL *ssl = nullptr; + { + std::lock_guard guard(ctx_mutex); + ssl = SSL_new(ctx); + } + + if (ssl) { + set_nonblocking(sock, true); + auto bio = BIO_new_socket(static_cast(sock), BIO_NOCLOSE); + BIO_set_nbio(bio, 1); + SSL_set_bio(ssl, bio, bio); + + if (!setup(ssl) || SSL_connect_or_accept(ssl) != 1) { + SSL_shutdown(ssl); + { + std::lock_guard guard(ctx_mutex); + SSL_free(ssl); + } + set_nonblocking(sock, false); + return nullptr; + } + BIO_set_nbio(bio, 0); + set_nonblocking(sock, false); + } + + return ssl; +} + +inline void ssl_delete(std::mutex &ctx_mutex, SSL *ssl, + bool shutdown_gracefully) { + // sometimes we may want to skip this to try to avoid SIGPIPE if we know + // the remote has closed the network connection + // Note that it is not always possible to avoid SIGPIPE, this is merely a + // best-efforts. + if (shutdown_gracefully) { SSL_shutdown(ssl); } + + std::lock_guard guard(ctx_mutex); + SSL_free(ssl); +} + +template +bool ssl_connect_or_accept_nonblocking(socket_t sock, SSL *ssl, + U ssl_connect_or_accept, + time_t timeout_sec, + time_t timeout_usec) { + int res = 0; + while ((res = ssl_connect_or_accept(ssl)) != 1) { + auto err = SSL_get_error(ssl, res); + switch (err) { + case SSL_ERROR_WANT_READ: + if (select_read(sock, timeout_sec, timeout_usec) > 0) { continue; } + break; + case SSL_ERROR_WANT_WRITE: + if (select_write(sock, timeout_sec, timeout_usec) > 0) { continue; } + break; + default: break; + } + return false; + } + return true; +} + +template +inline bool +process_server_socket_ssl(SSL *ssl, socket_t sock, size_t keep_alive_max_count, + time_t keep_alive_timeout_sec, + time_t read_timeout_sec, time_t read_timeout_usec, + time_t write_timeout_sec, time_t write_timeout_usec, + T callback) { + return process_server_socket_core( + sock, keep_alive_max_count, keep_alive_timeout_sec, + [&](bool close_connection, bool &connection_closed) { + SSLSocketStream strm(sock, ssl, read_timeout_sec, read_timeout_usec, + write_timeout_sec, write_timeout_usec); + return callback(strm, close_connection, connection_closed); + }); +} + +template +inline bool +process_client_socket_ssl(SSL *ssl, socket_t sock, time_t read_timeout_sec, + time_t read_timeout_usec, time_t write_timeout_sec, + time_t write_timeout_usec, T callback) { + SSLSocketStream strm(sock, ssl, read_timeout_sec, read_timeout_usec, + write_timeout_sec, write_timeout_usec); + return callback(strm); +} + +#if OPENSSL_VERSION_NUMBER < 0x10100000L +static std::shared_ptr> openSSL_locks_; + +class SSLThreadLocks { +public: + SSLThreadLocks() { + openSSL_locks_ = + std::make_shared>(CRYPTO_num_locks()); + CRYPTO_set_locking_callback(locking_callback); + } + + ~SSLThreadLocks() { CRYPTO_set_locking_callback(nullptr); } + +private: + static void locking_callback(int mode, int type, const char * /*file*/, + int /*line*/) { + auto &lk = (*openSSL_locks_)[static_cast(type)]; + if (mode & CRYPTO_LOCK) { + lk.lock(); + } else { + lk.unlock(); + } + } +}; + +#endif + +class SSLInit { +public: + SSLInit() { +#if OPENSSL_VERSION_NUMBER < 0x1010001fL + SSL_load_error_strings(); + SSL_library_init(); +#else + OPENSSL_init_ssl( + OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL); +#endif + } + + ~SSLInit() { +#if OPENSSL_VERSION_NUMBER < 0x1010001fL + ERR_free_strings(); +#endif + } + +private: +#if OPENSSL_VERSION_NUMBER < 0x10100000L + SSLThreadLocks thread_init_; +#endif +}; + +// SSL socket stream implementation +inline SSLSocketStream::SSLSocketStream(socket_t sock, SSL *ssl, + time_t read_timeout_sec, + time_t read_timeout_usec, + time_t write_timeout_sec, + time_t write_timeout_usec) + : sock_(sock), ssl_(ssl), read_timeout_sec_(read_timeout_sec), + read_timeout_usec_(read_timeout_usec), + write_timeout_sec_(write_timeout_sec), + write_timeout_usec_(write_timeout_usec) { + SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY); +} + +inline SSLSocketStream::~SSLSocketStream() {} + +inline bool SSLSocketStream::is_readable() const { + return detail::select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0; +} + +inline bool SSLSocketStream::is_writable() const { + return detail::select_write(sock_, write_timeout_sec_, write_timeout_usec_) > + 0; +} + +inline ssize_t SSLSocketStream::read(char *ptr, size_t size) { + if (SSL_pending(ssl_) > 0) { + return SSL_read(ssl_, ptr, static_cast(size)); + } else if (is_readable()) { + auto ret = SSL_read(ssl_, ptr, static_cast(size)); + if (ret < 0) { + auto err = SSL_get_error(ssl_, ret); + while (err == SSL_ERROR_WANT_READ) { + if (SSL_pending(ssl_) > 0) { + return SSL_read(ssl_, ptr, static_cast(size)); + } else if (is_readable()) { + ret = SSL_read(ssl_, ptr, static_cast(size)); + if (ret >= 0) { return ret; } + err = SSL_get_error(ssl_, ret); + } else { + return -1; + } + } + } + return ret; + } + return -1; +} + +inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) { + if (is_writable()) { return SSL_write(ssl_, ptr, static_cast(size)); } + return -1; +} + +inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip, + int &port) const { + detail::get_remote_ip_and_port(sock_, ip, port); +} + +inline socket_t SSLSocketStream::socket() const { return sock_; } + +static SSLInit sslinit_; + +} // namespace detail + +// SSL HTTP server implementation +inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path, + const char *client_ca_cert_file_path, + const char *client_ca_cert_dir_path) { + ctx_ = SSL_CTX_new(SSLv23_server_method()); + + if (ctx_) { + SSL_CTX_set_options(ctx_, + SSL_OP_ALL | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | + SSL_OP_NO_COMPRESSION | + SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION); + + // auto ecdh = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1); + // SSL_CTX_set_tmp_ecdh(ctx_, ecdh); + // EC_KEY_free(ecdh); + + if (SSL_CTX_use_certificate_chain_file(ctx_, cert_path) != 1 || + SSL_CTX_use_PrivateKey_file(ctx_, private_key_path, SSL_FILETYPE_PEM) != + 1) { + SSL_CTX_free(ctx_); + ctx_ = nullptr; + } else if (client_ca_cert_file_path || client_ca_cert_dir_path) { + // if (client_ca_cert_file_path) { + // auto list = SSL_load_client_CA_file(client_ca_cert_file_path); + // SSL_CTX_set_client_CA_list(ctx_, list); + // } + + SSL_CTX_load_verify_locations(ctx_, client_ca_cert_file_path, + client_ca_cert_dir_path); + + SSL_CTX_set_verify( + ctx_, + SSL_VERIFY_PEER | + SSL_VERIFY_FAIL_IF_NO_PEER_CERT, // SSL_VERIFY_CLIENT_ONCE, + nullptr); + } + } +} + +inline SSLServer::SSLServer(X509 *cert, EVP_PKEY *private_key, + X509_STORE *client_ca_cert_store) { + ctx_ = SSL_CTX_new(SSLv23_server_method()); + + if (ctx_) { + SSL_CTX_set_options(ctx_, + SSL_OP_ALL | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | + SSL_OP_NO_COMPRESSION | + SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION); + + if (SSL_CTX_use_certificate(ctx_, cert) != 1 || + SSL_CTX_use_PrivateKey(ctx_, private_key) != 1) { + SSL_CTX_free(ctx_); + ctx_ = nullptr; + } else if (client_ca_cert_store) { + + SSL_CTX_set_cert_store(ctx_, client_ca_cert_store); + + SSL_CTX_set_verify( + ctx_, + SSL_VERIFY_PEER | + SSL_VERIFY_FAIL_IF_NO_PEER_CERT, // SSL_VERIFY_CLIENT_ONCE, + nullptr); + } + } +} + +inline SSLServer::~SSLServer() { + if (ctx_) { SSL_CTX_free(ctx_); } +} + +inline bool SSLServer::is_valid() const { return ctx_; } + +inline bool SSLServer::process_and_close_socket(socket_t sock) { + auto ssl = detail::ssl_new( + sock, ctx_, ctx_mutex_, + [&](SSL *ssl) { + return detail::ssl_connect_or_accept_nonblocking( + sock, ssl, SSL_accept, read_timeout_sec_, read_timeout_usec_); + }, + [](SSL * /*ssl*/) { return true; }); + + bool ret = false; + if (ssl) { + ret = detail::process_server_socket_ssl( + ssl, sock, keep_alive_max_count_, keep_alive_timeout_sec_, + read_timeout_sec_, read_timeout_usec_, write_timeout_sec_, + write_timeout_usec_, + [this, ssl](Stream &strm, bool close_connection, + bool &connection_closed) { + return process_request(strm, close_connection, connection_closed, + [&](Request &req) { req.ssl = ssl; }); + }); + + // Shutdown gracefully if the result seemed successful, non-gracefully if + // the connection appeared to be closed. + const bool shutdown_gracefully = ret; + detail::ssl_delete(ctx_mutex_, ssl, shutdown_gracefully); + } + + detail::shutdown_socket(sock); + detail::close_socket(sock); + return ret; +} + +// SSL HTTP client implementation +inline SSLClient::SSLClient(const std::string &host) + : SSLClient(host, 443, std::string(), std::string()) {} + +inline SSLClient::SSLClient(const std::string &host, int port) + : SSLClient(host, port, std::string(), std::string()) {} + +inline SSLClient::SSLClient(const std::string &host, int port, + const std::string &client_cert_path, + const std::string &client_key_path) + : ClientImpl(host, port, client_cert_path, client_key_path) { + ctx_ = SSL_CTX_new(SSLv23_client_method()); + + detail::split(&host_[0], &host_[host_.size()], '.', + [&](const char *b, const char *e) { + host_components_.emplace_back(std::string(b, e)); + }); + if (!client_cert_path.empty() && !client_key_path.empty()) { + if (SSL_CTX_use_certificate_file(ctx_, client_cert_path.c_str(), + SSL_FILETYPE_PEM) != 1 || + SSL_CTX_use_PrivateKey_file(ctx_, client_key_path.c_str(), + SSL_FILETYPE_PEM) != 1) { + SSL_CTX_free(ctx_); + ctx_ = nullptr; + } + } +} + +inline SSLClient::SSLClient(const std::string &host, int port, + X509 *client_cert, EVP_PKEY *client_key) + : ClientImpl(host, port) { + ctx_ = SSL_CTX_new(SSLv23_client_method()); + + detail::split(&host_[0], &host_[host_.size()], '.', + [&](const char *b, const char *e) { + host_components_.emplace_back(std::string(b, e)); + }); + if (client_cert != nullptr && client_key != nullptr) { + if (SSL_CTX_use_certificate(ctx_, client_cert) != 1 || + SSL_CTX_use_PrivateKey(ctx_, client_key) != 1) { + SSL_CTX_free(ctx_); + ctx_ = nullptr; + } + } +} + +inline SSLClient::~SSLClient() { + if (ctx_) { SSL_CTX_free(ctx_); } + // Make sure to shut down SSL since shutdown_ssl will resolve to the + // base function rather than the derived function once we get to the + // base class destructor, and won't free the SSL (causing a leak). + SSLClient::shutdown_ssl(socket_, true); +} + +inline bool SSLClient::is_valid() const { return ctx_; } + +inline void SSLClient::set_ca_cert_path(const char *ca_cert_file_path, + const char *ca_cert_dir_path) { + if (ca_cert_file_path) { ca_cert_file_path_ = ca_cert_file_path; } + if (ca_cert_dir_path) { ca_cert_dir_path_ = ca_cert_dir_path; } +} + +inline void SSLClient::set_ca_cert_store(X509_STORE *ca_cert_store) { + if (ca_cert_store) { + if (ctx_) { + if (SSL_CTX_get_cert_store(ctx_) != ca_cert_store) { + // Free memory allocated for old cert and use new store `ca_cert_store` + SSL_CTX_set_cert_store(ctx_, ca_cert_store); + } + } else { + X509_STORE_free(ca_cert_store); + } + } +} + +inline long SSLClient::get_openssl_verify_result() const { + return verify_result_; +} + +inline SSL_CTX *SSLClient::ssl_context() const { return ctx_; } + +inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) { + return is_valid() && ClientImpl::create_and_connect_socket(socket, error); +} + +// Assumes that socket_mutex_ is locked and that there are no requests in flight +inline bool SSLClient::connect_with_proxy(Socket &socket, Response &res, + bool &success, Error &error) { + success = true; + Response res2; + if (!detail::process_client_socket( + socket.sock, read_timeout_sec_, read_timeout_usec_, + write_timeout_sec_, write_timeout_usec_, [&](Stream &strm) { + Request req2; + req2.method = "CONNECT"; + req2.path = host_and_port_; + return process_request(strm, req2, res2, false, error); + })) { + // Thread-safe to close everything because we are assuming there are no + // requests in flight + shutdown_ssl(socket, true); + shutdown_socket(socket); + close_socket(socket); + success = false; + return false; + } + + if (res2.status == 407) { + if (!proxy_digest_auth_username_.empty() && + !proxy_digest_auth_password_.empty()) { + std::map auth; + if (detail::parse_www_authenticate(res2, auth, true)) { + Response res3; + if (!detail::process_client_socket( + socket.sock, read_timeout_sec_, read_timeout_usec_, + write_timeout_sec_, write_timeout_usec_, [&](Stream &strm) { + Request req3; + req3.method = "CONNECT"; + req3.path = host_and_port_; + req3.headers.insert(detail::make_digest_authentication_header( + req3, auth, 1, detail::random_string(10), + proxy_digest_auth_username_, proxy_digest_auth_password_, + true)); + return process_request(strm, req3, res3, false, error); + })) { + // Thread-safe to close everything because we are assuming there are + // no requests in flight + shutdown_ssl(socket, true); + shutdown_socket(socket); + close_socket(socket); + success = false; + return false; + } + } + } else { + res = res2; + return false; + } + } + + return true; +} + +inline bool SSLClient::load_certs() { + bool ret = true; + + std::call_once(initialize_cert_, [&]() { + std::lock_guard guard(ctx_mutex_); + if (!ca_cert_file_path_.empty()) { + if (!SSL_CTX_load_verify_locations(ctx_, ca_cert_file_path_.c_str(), + nullptr)) { + ret = false; + } + } else if (!ca_cert_dir_path_.empty()) { + if (!SSL_CTX_load_verify_locations(ctx_, nullptr, + ca_cert_dir_path_.c_str())) { + ret = false; + } + } else { +#ifdef _WIN32 + detail::load_system_certs_on_windows(SSL_CTX_get_cert_store(ctx_)); +#else + SSL_CTX_set_default_verify_paths(ctx_); +#endif + } + }); + + return ret; +} + +inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) { + auto ssl = detail::ssl_new( + socket.sock, ctx_, ctx_mutex_, + [&](SSL *ssl) { + if (server_certificate_verification_) { + if (!load_certs()) { + error = Error::SSLLoadingCerts; + return false; + } + SSL_set_verify(ssl, SSL_VERIFY_NONE, nullptr); + } + + if (!detail::ssl_connect_or_accept_nonblocking( + socket.sock, ssl, SSL_connect, connection_timeout_sec_, + connection_timeout_usec_)) { + error = Error::SSLConnection; + return false; + } + + if (server_certificate_verification_) { + verify_result_ = SSL_get_verify_result(ssl); + + if (verify_result_ != X509_V_OK) { + error = Error::SSLServerVerification; + return false; + } + + auto server_cert = SSL_get_peer_certificate(ssl); + + if (server_cert == nullptr) { + error = Error::SSLServerVerification; + return false; + } + + if (!verify_host(server_cert)) { + X509_free(server_cert); + error = Error::SSLServerVerification; + return false; + } + X509_free(server_cert); + } + + return true; + }, + [&](SSL *ssl) { + SSL_set_tlsext_host_name(ssl, host_.c_str()); + return true; + }); + + if (ssl) { + socket.ssl = ssl; + return true; + } + + shutdown_socket(socket); + close_socket(socket); + return false; +} + +inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) { + if (socket.sock == INVALID_SOCKET) { + assert(socket.ssl == nullptr); + return; + } + if (socket.ssl) { + detail::ssl_delete(ctx_mutex_, socket.ssl, shutdown_gracefully); + socket.ssl = nullptr; + } + assert(socket.ssl == nullptr); +} + +inline bool +SSLClient::process_socket(const Socket &socket, + std::function callback) { + assert(socket.ssl); + return detail::process_client_socket_ssl( + socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_, + write_timeout_sec_, write_timeout_usec_, std::move(callback)); +} + +inline bool SSLClient::is_ssl() const { return true; } + +inline bool SSLClient::verify_host(X509 *server_cert) const { + /* Quote from RFC2818 section 3.1 "Server Identity" + + If a subjectAltName extension of type dNSName is present, that MUST + be used as the identity. Otherwise, the (most specific) Common Name + field in the Subject field of the certificate MUST be used. Although + the use of the Common Name is existing practice, it is deprecated and + Certification Authorities are encouraged to use the dNSName instead. + + Matching is performed using the matching rules specified by + [RFC2459]. If more than one identity of a given type is present in + the certificate (e.g., more than one dNSName name, a match in any one + of the set is considered acceptable.) Names may contain the wildcard + character * which is considered to match any single domain name + component or component fragment. E.g., *.a.com matches foo.a.com but + not bar.foo.a.com. f*.com matches foo.com but not bar.com. + + In some cases, the URI is specified as an IP address rather than a + hostname. In this case, the iPAddress subjectAltName must be present + in the certificate and must exactly match the IP in the URI. + + */ + return verify_host_with_subject_alt_name(server_cert) || + verify_host_with_common_name(server_cert); +} + +inline bool +SSLClient::verify_host_with_subject_alt_name(X509 *server_cert) const { + auto ret = false; + + auto type = GEN_DNS; + + struct in6_addr addr6; + struct in_addr addr; + size_t addr_len = 0; + +#ifndef __MINGW32__ + if (inet_pton(AF_INET6, host_.c_str(), &addr6)) { + type = GEN_IPADD; + addr_len = sizeof(struct in6_addr); + } else if (inet_pton(AF_INET, host_.c_str(), &addr)) { + type = GEN_IPADD; + addr_len = sizeof(struct in_addr); + } +#endif + + auto alt_names = static_cast( + X509_get_ext_d2i(server_cert, NID_subject_alt_name, nullptr, nullptr)); + + if (alt_names) { + auto dsn_matched = false; + auto ip_mached = false; + + auto count = sk_GENERAL_NAME_num(alt_names); + + for (decltype(count) i = 0; i < count && !dsn_matched; i++) { + auto val = sk_GENERAL_NAME_value(alt_names, i); + if (val->type == type) { + auto name = (const char *)ASN1_STRING_get0_data(val->d.ia5); + auto name_len = (size_t)ASN1_STRING_length(val->d.ia5); + + switch (type) { + case GEN_DNS: dsn_matched = check_host_name(name, name_len); break; + + case GEN_IPADD: + if (!memcmp(&addr6, name, addr_len) || + !memcmp(&addr, name, addr_len)) { + ip_mached = true; + } + break; + } + } + } + + if (dsn_matched || ip_mached) { ret = true; } + } + + GENERAL_NAMES_free((STACK_OF(GENERAL_NAME) *)alt_names); + return ret; +} + +inline bool SSLClient::verify_host_with_common_name(X509 *server_cert) const { + const auto subject_name = X509_get_subject_name(server_cert); + + if (subject_name != nullptr) { + char name[BUFSIZ]; + auto name_len = X509_NAME_get_text_by_NID(subject_name, NID_commonName, + name, sizeof(name)); + + if (name_len != -1) { + return check_host_name(name, static_cast(name_len)); + } + } + + return false; +} + +inline bool SSLClient::check_host_name(const char *pattern, + size_t pattern_len) const { + if (host_.size() == pattern_len && host_ == pattern) { return true; } + + // Wildcard match + // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484 + std::vector pattern_components; + detail::split(&pattern[0], &pattern[pattern_len], '.', + [&](const char *b, const char *e) { + pattern_components.emplace_back(std::string(b, e)); + }); + + if (host_components_.size() != pattern_components.size()) { return false; } + + auto itr = pattern_components.begin(); + for (const auto &h : host_components_) { + auto &p = *itr; + if (p != h && p != "*") { + auto partial_match = (p.size() > 0 && p[p.size() - 1] == '*' && + !p.compare(0, p.size() - 1, h)); + if (!partial_match) { return false; } + } + ++itr; + } + + return true; +} +#endif + +// Universal client implementation +inline Client::Client(const char *scheme_host_port) + : Client(scheme_host_port, std::string(), std::string()) {} + +inline Client::Client(const char *scheme_host_port, + const std::string &client_cert_path, + const std::string &client_key_path) { + const static std::regex re(R"(^(?:([a-z]+)://)?([^:/?#]+)(?::(\d+))?)"); + + std::cmatch m; + if (std::regex_match(scheme_host_port, m, re)) { + auto scheme = m[1].str(); + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + if (!scheme.empty() && (scheme != "http" && scheme != "https")) { +#else + if (!scheme.empty() && scheme != "http") { +#endif + std::string msg = "'" + scheme + "' scheme is not supported."; + throw std::invalid_argument(msg); + return; + } + + auto is_ssl = scheme == "https"; + + auto host = m[2].str(); + + auto port_str = m[3].str(); + auto port = !port_str.empty() ? std::stoi(port_str) : (is_ssl ? 443 : 80); + + if (is_ssl) { +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + cli_ = detail::make_unique(host.c_str(), port, + client_cert_path, client_key_path); + is_ssl_ = is_ssl; +#endif + } else { + cli_ = detail::make_unique(host.c_str(), port, + client_cert_path, client_key_path); + } + } else { + cli_ = detail::make_unique(scheme_host_port, 80, + client_cert_path, client_key_path); + } +} + +inline Client::Client(const std::string &host, int port) + : cli_(detail::make_unique(host, port)) {} + +inline Client::Client(const std::string &host, int port, + const std::string &client_cert_path, + const std::string &client_key_path) + : cli_(detail::make_unique(host, port, client_cert_path, + client_key_path)) {} + +inline Client::~Client() {} + +inline bool Client::is_valid() const { + return cli_ != nullptr && cli_->is_valid(); +} + +inline Result Client::Get(const char *path) { return cli_->Get(path); } +inline Result Client::Get(const char *path, const Headers &headers) { + return cli_->Get(path, headers); +} +inline Result Client::Get(const char *path, Progress progress) { + return cli_->Get(path, std::move(progress)); +} +inline Result Client::Get(const char *path, const Headers &headers, + Progress progress) { + return cli_->Get(path, headers, std::move(progress)); +} +inline Result Client::Get(const char *path, ContentReceiver content_receiver) { + return cli_->Get(path, std::move(content_receiver)); +} +inline Result Client::Get(const char *path, const Headers &headers, + ContentReceiver content_receiver) { + return cli_->Get(path, headers, std::move(content_receiver)); +} +inline Result Client::Get(const char *path, ContentReceiver content_receiver, + Progress progress) { + return cli_->Get(path, std::move(content_receiver), std::move(progress)); +} +inline Result Client::Get(const char *path, const Headers &headers, + ContentReceiver content_receiver, Progress progress) { + return cli_->Get(path, headers, std::move(content_receiver), + std::move(progress)); +} +inline Result Client::Get(const char *path, ResponseHandler response_handler, + ContentReceiver content_receiver) { + return cli_->Get(path, std::move(response_handler), + std::move(content_receiver)); +} +inline Result Client::Get(const char *path, const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver) { + return cli_->Get(path, headers, std::move(response_handler), + std::move(content_receiver)); +} +inline Result Client::Get(const char *path, ResponseHandler response_handler, + ContentReceiver content_receiver, Progress progress) { + return cli_->Get(path, std::move(response_handler), + std::move(content_receiver), std::move(progress)); +} +inline Result Client::Get(const char *path, const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver, Progress progress) { + return cli_->Get(path, headers, std::move(response_handler), + std::move(content_receiver), std::move(progress)); +} + +inline Result Client::Head(const char *path) { return cli_->Head(path); } +inline Result Client::Head(const char *path, const Headers &headers) { + return cli_->Head(path, headers); +} + +inline Result Client::Post(const char *path) { return cli_->Post(path); } +inline Result Client::Post(const char *path, const std::string &body, + const char *content_type) { + return cli_->Post(path, body, content_type); +} +inline Result Client::Post(const char *path, const Headers &headers, + const std::string &body, const char *content_type) { + return cli_->Post(path, headers, body, content_type); +} +inline Result Client::Post(const char *path, size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return cli_->Post(path, content_length, std::move(content_provider), + content_type); +} +inline Result Client::Post(const char *path, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return cli_->Post(path, std::move(content_provider), content_type); +} +inline Result Client::Post(const char *path, const Headers &headers, + size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return cli_->Post(path, headers, content_length, std::move(content_provider), + content_type); +} +inline Result Client::Post(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return cli_->Post(path, headers, std::move(content_provider), content_type); +} +inline Result Client::Post(const char *path, const Params ¶ms) { + return cli_->Post(path, params); +} +inline Result Client::Post(const char *path, const Headers &headers, + const Params ¶ms) { + return cli_->Post(path, headers, params); +} +inline Result Client::Post(const char *path, + const MultipartFormDataItems &items) { + return cli_->Post(path, items); +} +inline Result Client::Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items) { + return cli_->Post(path, headers, items); +} +inline Result Client::Post(const char *path, const Headers &headers, + const MultipartFormDataItems &items, + const std::string &boundary) { + return cli_->Post(path, headers, items, boundary); +} +inline Result Client::Put(const char *path) { return cli_->Put(path); } +inline Result Client::Put(const char *path, const std::string &body, + const char *content_type) { + return cli_->Put(path, body, content_type); +} +inline Result Client::Put(const char *path, const Headers &headers, + const std::string &body, const char *content_type) { + return cli_->Put(path, headers, body, content_type); +} +inline Result Client::Put(const char *path, size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return cli_->Put(path, content_length, std::move(content_provider), + content_type); +} +inline Result Client::Put(const char *path, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return cli_->Put(path, std::move(content_provider), content_type); +} +inline Result Client::Put(const char *path, const Headers &headers, + size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return cli_->Put(path, headers, content_length, std::move(content_provider), + content_type); +} +inline Result Client::Put(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return cli_->Put(path, headers, std::move(content_provider), content_type); +} +inline Result Client::Put(const char *path, const Params ¶ms) { + return cli_->Put(path, params); +} +inline Result Client::Put(const char *path, const Headers &headers, + const Params ¶ms) { + return cli_->Put(path, headers, params); +} +inline Result Client::Patch(const char *path, const std::string &body, + const char *content_type) { + return cli_->Patch(path, body, content_type); +} +inline Result Client::Patch(const char *path, const Headers &headers, + const std::string &body, const char *content_type) { + return cli_->Patch(path, headers, body, content_type); +} +inline Result Client::Patch(const char *path, size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return cli_->Patch(path, content_length, std::move(content_provider), + content_type); +} +inline Result Client::Patch(const char *path, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return cli_->Patch(path, std::move(content_provider), content_type); +} +inline Result Client::Patch(const char *path, const Headers &headers, + size_t content_length, + ContentProvider content_provider, + const char *content_type) { + return cli_->Patch(path, headers, content_length, std::move(content_provider), + content_type); +} +inline Result Client::Patch(const char *path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const char *content_type) { + return cli_->Patch(path, headers, std::move(content_provider), content_type); +} +inline Result Client::Delete(const char *path) { return cli_->Delete(path); } +inline Result Client::Delete(const char *path, const std::string &body, + const char *content_type) { + return cli_->Delete(path, body, content_type); +} +inline Result Client::Delete(const char *path, const Headers &headers) { + return cli_->Delete(path, headers); +} +inline Result Client::Delete(const char *path, const Headers &headers, + const std::string &body, + const char *content_type) { + return cli_->Delete(path, headers, body, content_type); +} +inline Result Client::Options(const char *path) { return cli_->Options(path); } +inline Result Client::Options(const char *path, const Headers &headers) { + return cli_->Options(path, headers); +} + +inline bool Client::send(const Request &req, Response &res, Error &error) { + return cli_->send(req, res, error); +} + +inline Result Client::send(const Request &req) { return cli_->send(req); } + +inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); } + +inline void Client::stop() { cli_->stop(); } + +inline void Client::set_default_headers(Headers headers) { + cli_->set_default_headers(std::move(headers)); +} + +inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); } +inline void Client::set_socket_options(SocketOptions socket_options) { + cli_->set_socket_options(std::move(socket_options)); +} + +inline void Client::set_connection_timeout(time_t sec, time_t usec) { + cli_->set_connection_timeout(sec, usec); +} +inline void Client::set_read_timeout(time_t sec, time_t usec) { + cli_->set_read_timeout(sec, usec); +} +inline void Client::set_write_timeout(time_t sec, time_t usec) { + cli_->set_write_timeout(sec, usec); +} + +inline void Client::set_basic_auth(const char *username, const char *password) { + cli_->set_basic_auth(username, password); +} +inline void Client::set_bearer_token_auth(const char *token) { + cli_->set_bearer_token_auth(token); +} +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void Client::set_digest_auth(const char *username, + const char *password) { + cli_->set_digest_auth(username, password); +} +#endif + +inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); } +inline void Client::set_follow_location(bool on) { + cli_->set_follow_location(on); +} + +inline void Client::set_compress(bool on) { cli_->set_compress(on); } + +inline void Client::set_decompress(bool on) { cli_->set_decompress(on); } + +inline void Client::set_interface(const char *intf) { + cli_->set_interface(intf); +} + +inline void Client::set_proxy(const char *host, int port) { + cli_->set_proxy(host, port); +} +inline void Client::set_proxy_basic_auth(const char *username, + const char *password) { + cli_->set_proxy_basic_auth(username, password); +} +inline void Client::set_proxy_bearer_token_auth(const char *token) { + cli_->set_proxy_bearer_token_auth(token); +} +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void Client::set_proxy_digest_auth(const char *username, + const char *password) { + cli_->set_proxy_digest_auth(username, password); +} +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void Client::enable_server_certificate_verification(bool enabled) { + cli_->enable_server_certificate_verification(enabled); +} +#endif + +inline void Client::set_logger(Logger logger) { cli_->set_logger(logger); } + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void Client::set_ca_cert_path(const char *ca_cert_file_path, + const char *ca_cert_dir_path) { + if (is_ssl_) { + static_cast(*cli_).set_ca_cert_path(ca_cert_file_path, + ca_cert_dir_path); + } +} + +inline void Client::set_ca_cert_store(X509_STORE *ca_cert_store) { + if (is_ssl_) { + static_cast(*cli_).set_ca_cert_store(ca_cert_store); + } +} + +inline long Client::get_openssl_verify_result() const { + if (is_ssl_) { + return static_cast(*cli_).get_openssl_verify_result(); + } + return -1; // NOTE: -1 doesn't match any of X509_V_ERR_??? +} + +inline SSL_CTX *Client::ssl_context() const { + if (is_ssl_) { return static_cast(*cli_).ssl_context(); } + return nullptr; +} +#endif + +// ---------------------------------------------------------------------------- + +} // namespace httplib + +#endif // CPPHTTPLIB_HTTPLIB_H diff --git a/Plugins/HTTP/HTTP.cpp b/Plugins/HTTP/HTTP.cpp new file mode 100644 index 00000000000..794e3bdd30a --- /dev/null +++ b/Plugins/HTTP/HTTP.cpp @@ -0,0 +1,42 @@ +#include "HTTP.hpp" +#include "HTTP/Client.hpp" +#include "HTTP/RPC.hpp" +#include "HTTP/Server.hpp" +#include "Services/Config/Config.hpp" + +using namespace NWNXLib; + +static HTTP::HTTP* g_plugin; + +NWNX_PLUGIN_ENTRY Plugin* PluginLoad(Services::ProxyServiceList* services) +{ + g_plugin = new HTTP::HTTP(services); + return g_plugin; +} + +namespace HTTP { + +HTTP::HTTP(Services::ProxyServiceList* services) + : Plugin(services) +{ + auto tasks = GetServices()->m_tasks.get(); + auto messaging = GetServices()->m_messaging.get(); + auto events = GetServices()->m_events.get(); + auto config = GetServices()->m_config.get(); + + m_Client = std::make_unique(config, events, messaging, tasks); + bool bRPC = config->Get("RPC", false); + if (config->Get("SERVER", false) || bRPC) + { + m_Server = std::make_unique(config, events, messaging, tasks); + if (bRPC) + { + m_RPC = std::make_unique(config, messaging, tasks); + } + } +} + +HTTP::~HTTP() += default; + +} diff --git a/Plugins/HTTP/HTTP.hpp b/Plugins/HTTP/HTTP.hpp new file mode 100644 index 00000000000..b070e8b4f29 --- /dev/null +++ b/Plugins/HTTP/HTTP.hpp @@ -0,0 +1,61 @@ +#pragma once + +#include "Plugin.hpp" +#include "External/httplib.h" + +namespace HTTP { + class Client; + class RPC; + class Server; + + class HTTP : public NWNXLib::Plugin + { + public: + explicit HTTP(NWNXLib::Services::ProxyServiceList*); + ~HTTP() override; + enum RequestMethod + { + GET = 0, + POST = 1, + DELETE = 2, + PATCH = 3, + PUT = 5, + OPTION = 6, + HEAD = 7 + }; + enum AuthenticationType + { + NONE = 0, + BASIC = 1, + DIGEST = 2, + BEARER_TOKEN = 3 + }; + enum ContentType + { + HTML = 0, + PLAINTEXT = 1, + JSON = 2, + URL_ENCODED = 3, + XML = 4, + }; + + static constexpr const char* ContentTypeToString(const unsigned value) + { + constexpr const char* TYPE_STRINGS[] = + { + "text/html", + "text/plain", + "application/json", + "application/x-www-form-urlencoded", + "application/xml" + }; + return (value > 4) ? "text/html" : TYPE_STRINGS[value]; + } + + private: + std::unique_ptr m_Client; + std::unique_ptr m_RPC; + std::unique_ptr m_Server; + }; + +} diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp new file mode 100644 index 00000000000..e915cb42044 --- /dev/null +++ b/Plugins/HTTP/HTTP/Client.cpp @@ -0,0 +1,242 @@ +#include "HTTP/Client.hpp" + +#include "Services/Config/Config.hpp" +#include "Services/Messaging/Messaging.hpp" +#include "Services/Tasks/Tasks.hpp" + +namespace Core { + extern bool g_CoreShuttingDown; +} + +using namespace NWNXLib; + +namespace HTTP +{ + +TasksProxy* Client::m_servTasks; +MessagingProxy* Client::m_servMessaging; + +int Client::m_clientRequestId; +int Client::m_clientTimeout; +std::unordered_map Client::m_clientRequests; +std::unordered_map> Client::m_clientHostCache; + +Client::Client(ConfigProxy* config, EventsProxy* events, MessagingProxy* messaging, TasksProxy* tasks) +{ + events->RegisterEvent("Client_SendRequest", &SendRequest); + events->RegisterEvent("Client_GetRequest", &GetRequest); + m_servTasks = tasks; + m_servMessaging = messaging; + m_clientRequestId = 0; + m_clientTimeout = config->Get("CLIENT_REQUEST_TIMEOUT", 2000); +} + +Client::~Client() += default; + +std::unique_ptr Client::GetResult(const Client::Request& client_req) +{ + std::unique_ptr result; + auto cli = m_clientHostCache[client_req.host].get(); + switch(client_req.requestMethod) + { + case HTTP::RequestMethod::GET: + result = std::make_unique(cli->Get(client_req.path.c_str(), client_req.headers)); + break; + case HTTP::RequestMethod::POST: + result = std::make_unique(cli->Post(client_req.path.c_str(), client_req.headers, client_req.data,HTTP::ContentTypeToString(client_req.contentType))); + break; + case HTTP::RequestMethod::DELETE: + result = std::make_unique(cli->Delete(client_req.path.c_str(), client_req.headers, client_req.data, HTTP::ContentTypeToString(client_req.contentType))); + break; + case HTTP::RequestMethod::PATCH: + result = std::make_unique(cli->Patch(client_req.path.c_str(), client_req.headers, client_req.data, HTTP::ContentTypeToString(client_req.contentType))); + break; + case HTTP::RequestMethod::PUT: + result = std::make_unique(cli->Put(client_req.path.c_str(), client_req.headers, client_req.data, HTTP::ContentTypeToString(client_req.contentType))); + break; + case HTTP::RequestMethod::OPTION: + result = std::make_unique(cli->Options(client_req.path.c_str(), client_req.headers)); + break; + case HTTP::RequestMethod::HEAD: + result = std::make_unique(cli->Head(client_req.path.c_str(), client_req.headers)); + break; + } + + return result; +} + +void Client::PerformRequest(const Client::Request& client_req) +{ + auto cli = m_clientHostCache.find(client_req.host); + if (cli == std::end(m_clientHostCache)) + { + LOG_DEBUG("Creating new SSL client for host %s.", client_req.host); + cli = m_clientHostCache.insert(std::make_pair(client_req.host, std::make_unique(client_req.host.c_str(), client_req.port))).first; + } + + if (client_req.authType == HTTP::AuthenticationType::BASIC) + cli->second->set_basic_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); + else if (client_req.authType == HTTP::AuthenticationType::DIGEST) + cli->second->set_digest_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); + else if (client_req.authType == HTTP::AuthenticationType::BEARER_TOKEN) + cli->second->set_bearer_token_auth(client_req.authUserToken.c_str()); + + if (Core::g_CoreShuttingDown) + { + // Shorter timeout when shutting down + cli->second->set_connection_timeout(0, 300000); + auto result = GetResult(client_req); + auto res = result->value(); + + if (res.status == 200) + LOG_INFO("Sent webhook '%s' to '%s%s'.", client_req.data, client_req.host, client_req.path); + else + LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.",client_req.data.c_str(), client_req.host.c_str(), client_req.path.c_str(), res.status); + return; + } + m_servTasks->QueueOnAsyncThread([cli, client_req]() + { + cli->second->set_connection_timeout(0, m_clientTimeout * 1000); + auto result = GetResult(client_req); + + auto clientError = result->error(); + if (clientError) + { + m_servTasks->QueueOnMainThread([client_req, clientError]() + { + auto moduleOid = NWNXLib::Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", "Failed to make a client request with server. Is the url/port correct?"}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); + LOG_ERROR("HTTP Client Request to '%s%s' failed, [Error: %d].", client_req.host, client_req.path, clientError); + }); + return; + } + auto res = result->value(); + m_servTasks->QueueOnMainThread([client_req, res]() + { + if (Core::g_CoreShuttingDown) + return; + + auto moduleOid = Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf); + if (res.status) + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"STATUS", std::to_string(res.status)}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", res.body}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); + if (res.status == 200 || res.status == 201 || res.status == 204 || res.status == 429) + { + // Discord sends your rate limit information even on success so you can stagger calls if you want + // This header also lets us know it's Discord not Slack, important because Discord sends RETRY_AFTER + // in milliseconds and Slack sends it as seconds. + if (res.has_header("X-RateLimit-Limit")) + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_LIMIT", res.get_header_value("X-RateLimit-Limit")}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_REMAINING", res.get_header_value("X-RateLimit-Remaining")}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_RESET", res.get_header_value("X-RateLimit-Reset")}); + if (res.has_header("Retry-After")) + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", res.get_header_value("Retry-After")}); + else if (res.has_header("Retry-At")) + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", res.get_header_value("Retry-At")}); + } + } + // Slack rate limited + else if (res.has_header("Retry-After")) + { + float fSlackRetry = stof(res.get_header_value("Retry-After")) * 1000.0f; + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", std::to_string(fSlackRetry)}); + } + if (res.status != 429) + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_SUCCESS", moduleOid}); + LOG_INFO("HTTP Client Request to '%s%s' succeeded.", client_req.host, client_req.path); + } + else + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); + LOG_WARNING("HTTP Client Request to '%s%s' failed, rate limited.", client_req.host, client_req.path); + } + } + else + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); + LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.host, client_req.path, res.status); + } + } + }); + }); +} + +httplib::Headers Client::ParseHeaderString(const std::string& headerStr) +{ + httplib::Headers headers; + if (!headerStr.empty()) + { + std::string::size_type key_pos = 0; + std::string::size_type key_end, val_pos, val_end; + while((key_end = headerStr.find(':', key_pos)) != std::string::npos) + { + if((val_pos = headerStr.find_first_not_of(": ", key_end)) == std::string::npos) + break; + + val_end = headerStr.find('|', val_pos); + headers.emplace(headerStr.substr(key_pos, key_end - key_pos), headerStr.substr(val_pos, val_end - val_pos)); + + key_pos = val_end; + if(key_pos != std::string::npos) + ++key_pos; + } + } + return headers; +} + +Events::ArgumentStack Client::SendRequest(Events::ArgumentStack&& args) +{ + auto clientReq = Request(); + clientReq.id = m_clientRequestId++; + clientReq.oid = Services::Events::ExtractArgument(args); + clientReq.tag = Services::Events::ExtractArgument(args); + clientReq.requestMethod = static_cast(Services::Events::ExtractArgument(args)); + clientReq.host = Services::Events::ExtractArgument(args); + clientReq.path = Services::Events::ExtractArgument(args); + clientReq.contentType = static_cast(Services::Events::ExtractArgument(args)); + clientReq.data = Services::Events::ExtractArgument(args); + clientReq.authType = static_cast(Services::Events::ExtractArgument(args)); + clientReq.authUserToken = Services::Events::ExtractArgument(args); + clientReq.authPassword = Services::Events::ExtractArgument(args); + clientReq.port = Services::Events::ExtractArgument(args); + if (!clientReq.port) clientReq.port = 443; + clientReq.headersString = Services::Events::ExtractArgument(args); + clientReq.headers = ParseHeaderString(clientReq.headersString); + m_clientRequests[clientReq.id] = clientReq; + PerformRequest(clientReq); + + return Services::Events::Arguments(clientReq.id); +} + +Events::ArgumentStack Client::GetRequest(Events::ArgumentStack&& args) +{ + Events::ArgumentStack stack; + auto requestId = Services::Events::ExtractArgument(args); + auto req = m_clientRequests.find(requestId); + ASSERT_OR_THROW(req != std::end(m_clientRequests)); + auto clientReq = req->second; + + Services::Events::InsertArgument(stack, clientReq.headersString); + Services::Events::InsertArgument(stack, (int32_t)clientReq.port); + Services::Events::InsertArgument(stack, clientReq.authPassword); + Services::Events::InsertArgument(stack, clientReq.authUserToken); + Services::Events::InsertArgument(stack, (int32_t)clientReq.authType); + Services::Events::InsertArgument(stack, clientReq.data); + Services::Events::InsertArgument(stack, (int32_t)clientReq.contentType); + Services::Events::InsertArgument(stack, clientReq.path); + Services::Events::InsertArgument(stack, clientReq.host); + Services::Events::InsertArgument(stack, (int32_t)clientReq.requestMethod); + Services::Events::InsertArgument(stack, clientReq.tag); + Services::Events::InsertArgument(stack, (ObjectID)clientReq.oid); + return stack; +} + +} diff --git a/Plugins/HTTP/HTTP/Client.hpp b/Plugins/HTTP/HTTP/Client.hpp new file mode 100644 index 00000000000..b47da162825 --- /dev/null +++ b/Plugins/HTTP/HTTP/Client.hpp @@ -0,0 +1,59 @@ +#pragma once + +#include "HTTP.hpp" +#include "Services/Events/Events.hpp" + +namespace HTTP +{ + +using namespace NWNXLib::Services; + +class Client +{ + struct Request + { + ObjectID oid; + int id; + HTTP::RequestMethod requestMethod; + std::string host; + int port; + std::string path; + HTTP::AuthenticationType authType; + std::string authUserToken; + std::string authPassword; + HTTP::ContentType contentType; + std::string data; + std::string headersString; + httplib::Headers headers; + std::string tag; + + Request() + { + id = -1; + requestMethod = HTTP::RequestMethod::GET; + port = 443; + authType = HTTP::AuthenticationType::NONE; + contentType = HTTP::ContentType::HTML; + oid = NWNXLib::API::Constants::OBJECT_INVALID; + } + }; +public: + explicit Client(ConfigProxy*, EventsProxy*, MessagingProxy*, TasksProxy*); + virtual ~Client(); +private: + static TasksProxy* m_servTasks; + static MessagingProxy* m_servMessaging; + + static Events::ArgumentStack GetRequest(Events::ArgumentStack&&); + static Events::ArgumentStack SendRequest(Events::ArgumentStack&&); + + static void PerformRequest(const Client::Request&); + static std::unique_ptr GetResult(const Client::Request&); + static httplib::Headers ParseHeaderString(const std::string&); + static int m_clientRequestId; + static int m_clientTimeout; + static std::unordered_map> m_clientHostCache; + static std::unordered_map m_clientRequests; +}; + +} diff --git a/Plugins/HTTP/HTTP/RPC.cpp b/Plugins/HTTP/HTTP/RPC.cpp new file mode 100644 index 00000000000..c693725fb87 --- /dev/null +++ b/Plugins/HTTP/HTTP/RPC.cpp @@ -0,0 +1,128 @@ +#include "HTTP/RPC.hpp" + +#include "Services/Config/Config.hpp" +#include "Services/Messaging/Messaging.hpp" +#include "Services/Tasks/Tasks.hpp" + +using namespace NWNXLib; + +namespace HTTP +{ + +TasksProxy* RPC::m_servTasks; +MessagingProxy* RPC::m_servMessaging; + +RPC::RPC(ConfigProxy* config, MessagingProxy* messaging, TasksProxy* tasks) +{ + m_authToken = config->Get("RPC_AUTH_TOKEN", ""); + m_rpcURL = config->Get("RPC_URL", "/rpc"); + if (m_rpcURL.rfind('/', 0) == std::string::npos) + m_rpcURL = "/" + m_rpcURL; + if (m_authToken.empty() && m_rpcURL == "/rpc") + { + LOG_ERROR("You have not set up an authorization token for your RPC server and you're using the default path of /rpc. You must either " + "set an authorization token (NWNX_HTTP_RPC_AUTH_TOKEN) or set a unique URL (NWNX_HTTP_RPC_URL) for your rpc path. The server will not be started."); + return; + } + m_servTasks = tasks; + m_servMessaging = messaging; + + StartRPCServer(); +} + +httplib::Server* RPC::WaitForWebServer(const std::atomic_bool& cancelled) +{ + auto *svr = Server::m_httpServer.get(); + while ((svr == nullptr || !svr->is_running()) && !cancelled) + { + std::this_thread::sleep_for(std::chrono::milliseconds (10)); + svr = Server::m_httpServer.get(); + } + return svr; +} + +void RPC::StartRPCServer() +{ + // RPC needs to wait for the HTTP server to be up and running on its own thread before it can start + auto *svr = Server::m_httpServer.get(); + if (svr == nullptr || !svr->is_running()) + { + std::atomic_bool cancellation_token = false; + auto future = std::async(std::launch::async, WaitForWebServer, std::ref(cancellation_token)); + if (std::future_status::ready == future.wait_for(std::chrono::seconds(3))) + { + svr = future.get(); + } + else + { + cancellation_token = true; + LOG_ERROR("No NWNX web server was detected for RPC to use, not started."); + return; + } + } + LOG_INFO("RPC Server up and available at %s", m_rpcURL.c_str()); + + svr->Post(m_rpcURL.c_str(), [&](const httplib::Request &req, httplib::Response &res) + { + auto requestId = Server::GetNewRequestID(); + + if (!m_authToken.empty() && (!req.has_header("Authorization") || req.get_header_value("Authorization") != m_authToken)) + { + res.status = 401; + } + else + { + auto ct = req.get_header_value("Content-Type"); + std::string json_data; + std::unordered_map params; + int paramCount = 0; + if (ct.find(HTTP::ContentTypeToString(HTTP::ContentType::JSON)) != std::string::npos) + json_data = req.body; + else + { + paramCount = req.params.size(); + for (const auto & param : req.params) + params[param.first] = param.second; + } + m_servTasks->QueueOnMainThread([requestId,json_data,paramCount,params]() + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestId)}); + if (!json_data.empty()) + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"JSON_DATA", json_data}); + else + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"PARAM_COUNT", std::to_string(paramCount)}); + int i = 0; + for (const auto & param : params) + { + std::string sParamKey = "PARAM_KEY_" + std::to_string(i); + std::string sParamValue = "PARAM_VALUE_" + std::to_string(i); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {sParamKey, param.first}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {sParamValue, param.second}); + i++; + } + } + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_POST", Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf)}); + }); + + // Our event was sent to nwscript on the main thread, wait for a response here or timeout after m_responseTimeout seconds + std::atomic_bool cancellation_token = false; + auto future = std::async(std::launch::async, Server::WaitForResponse, requestId, std::ref(cancellation_token)); + if (std::future_status::ready == future.wait_for(Server::m_responseTimeout)) + { + res.status = 200; + auto response = future.get(); + res.set_content(response.message, HTTP::ContentTypeToString(response.contentType)); + } + else + { + cancellation_token = true; + // Confirm the request was received but no response was returned. + res.status = 202; + } + Server::DeleteResponse(requestId); + } + }); +} + +} diff --git a/Plugins/HTTP/HTTP/RPC.hpp b/Plugins/HTTP/HTTP/RPC.hpp new file mode 100644 index 00000000000..8e9a9fdf559 --- /dev/null +++ b/Plugins/HTTP/HTTP/RPC.hpp @@ -0,0 +1,25 @@ +#pragma once +#include "HTTP.hpp" +#include "HTTP/Server.hpp" + +namespace HTTP +{ + +using namespace NWNXLib::Services; + +class RPC +{ +public: + explicit RPC(ConfigProxy*, MessagingProxy*, TasksProxy*); +private: + static TasksProxy* m_servTasks; + static MessagingProxy* m_servMessaging; + + static httplib::Server* WaitForWebServer(const std::atomic_bool&); + void StartRPCServer(); + + std::string m_authToken; + std::string m_rpcURL; +}; + +} diff --git a/Plugins/HTTP/HTTP/Server.cpp b/Plugins/HTTP/HTTP/Server.cpp new file mode 100644 index 00000000000..ef73ee33c09 --- /dev/null +++ b/Plugins/HTTP/HTTP/Server.cpp @@ -0,0 +1,188 @@ +#include "HTTP/Server.hpp" + +#include "Services/Config/Config.hpp" +#include "Services/Messaging/Messaging.hpp" +#include "Services/Tasks/Tasks.hpp" + +using namespace NWNXLib; + +namespace HTTP +{ + +TasksProxy* Server::m_servTasks; +MessagingProxy* Server::m_servMessaging; + +std::unique_ptr Server::m_httpServer; +std::unique_ptr Server::m_httpServerThread; +std::unordered_map Server::m_responses; +std::unordered_map Server::m_cachedResponses; +std::chrono::milliseconds Server::m_responseTimeout; +uint32_t Server::m_servRequestId; + +Server::Server(ConfigProxy* config, EventsProxy* events, MessagingProxy* messaging, TasksProxy* tasks) +{ + events->RegisterEvent("Server_SendResponse", &SendResponse); + + m_servTasks = tasks; + m_servMessaging = messaging; + m_servRequestId = 0; + m_responseTimeout = std::chrono::milliseconds(config->Get("SERVER_RESPONSE_TIMEOUT", 1000)); + auto rootHTML = config->Get("SERVER_ROOT_HTML", "Welcome to nwnx http!

Welcome to nwnx http!

"); + auto rootStatus = config->Get("SERVER_ROOT_STATUS", 403); + auto httpPort = config->Get("SERVER_PORT", 8686); + auto useSSL = config->Get("SERVER_USE_SSL", false); + auto eventURL = config->Get("SERVER_EVENT_URL"); + if (useSSL) + { + auto certFile = config->Get("SERVER_SSL_CERT_FILE", "./cert.pem"); + auto certKey = config->Get("SERVER_SSL_KEY_FILE", "./key.pem"); + m_httpServer = std::make_unique(certFile.c_str(), certKey.c_str()); + if (!m_httpServer->is_valid()) + { + BIO* bio = BIO_new(BIO_s_mem()); + ERR_print_errors(bio); + char *buf = nullptr; + size_t len = BIO_get_mem_data(bio, &buf); + std::string sRet((char*)buf, len); + BIO_free (bio); + LOG_ERROR("Unable to configure SSL Server, not starting. %s", sRet); + return; + } + else + { + // Required to prevent crashing when invalid SSL exchanges take place + signal(SIGPIPE, SIG_IGN); + } + } + else + { + m_httpServer = std::make_unique(); + } + + auto *svr = m_httpServer.get(); + m_httpServerThread = std::make_unique([svr,httpPort,rootStatus,rootHTML,eventURL]() + { + svr->Get("/", [rootStatus,rootHTML](const httplib::Request &, httplib::Response &res) + { + if (rootStatus != 200) + res.status = rootStatus; + else + res.set_content(rootHTML, HTTP::ContentTypeToString(HTTP::ContentType::HTML)); + }); + if (!eventURL->empty()) + { + svr->Get(eventURL->c_str(), [&](const httplib::Request &req, httplib::Response &res) + { + auto path = req.path; + auto requestThreadId = Server::GetNewRequestID(); + if (m_cachedResponses.find(path) != m_cachedResponses.end()) + { + auto now = std::chrono::system_clock::now(); + if (now < m_cachedResponses[path].cacheUntil) + { + res.set_content(m_cachedResponses[path].message, HTTP::ContentTypeToString(m_cachedResponses[path].contentType)); + auto expiresIn = std::chrono::duration_cast(m_cachedResponses[path].cacheUntil - now); + LOG_DEBUG("Cache hit on %s, cached response expires in %d seconds.", path, expiresIn.count()); + Server::DeleteResponse(requestThreadId); + return; + } + else + { + LOG_DEBUG("Cache expired on %s", path); + m_cachedResponses.erase(path); + } + } + m_servTasks->QueueOnMainThread([requestThreadId,path]() + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestThreadId)}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"PATH", path}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_GET", Utils::ObjectIDToString(0)}); + }); + std::atomic_bool cancellation_token = false; + auto future = std::async(std::launch::async, Server::WaitForResponse, requestThreadId, std::ref(cancellation_token)); + if (std::future_status::ready == future.wait_for(m_responseTimeout)) + { + res.status = 200; + auto response = future.get(); + res.set_content(response.message, HTTP::ContentTypeToString(response.contentType)); + auto now = std::chrono::system_clock::now(); + if (response.cacheUntil > now) + { + m_cachedResponses[path] = response; + } + } + else + { + cancellation_token = true; + res.status = 404; + } + Server::DeleteResponse(requestThreadId); + }); + } + svr->set_error_handler([](const httplib::Request &, httplib::Response &res) { + const char *fmt = "%d %s

%d %s

nwnx http
"; + char buf[256]; + snprintf(buf, sizeof(buf), fmt, res.status, httplib::detail::status_message(res.status), res.status, httplib::detail::status_message(res.status)); + res.set_content(buf, HTTP::ContentTypeToString(HTTP::ContentType::HTML)); + }); + svr->listen("0.0.0.0", httpPort); + }); + LOG_INFO("%s Server started, accessible on port %d", useSSL ? "HTTPS" : "HTTP", httpPort); +} + +Server::~Server() +{ + if (m_httpServerThread) + { + if (m_httpServer->is_running()) + { + LOG_INFO("Shutting down HTTP server."); + m_httpServer->stop(); + } + m_httpServerThread->join(); + } +} + +void Server::DeleteResponse(uint32_t requestId) +{ + m_responses.erase(requestId); +} + +uint32_t Server::GetNewRequestID() +{ + return m_servRequestId++; +} + +Server::Response Server::WaitForResponse(uint32_t requestThreadId, const std::atomic_bool& cancelled) +{ + while (m_responses.find(requestThreadId) == m_responses.end() && !cancelled) + std::this_thread::sleep_for(std::chrono::milliseconds (10)); + + if (cancelled) + { + if (m_responses.find(requestThreadId) != m_responses.end()) + m_responses.erase(requestThreadId); + return Server::Response(); + } + + return m_responses[requestThreadId]; +} + +Events::ArgumentStack Server::SendResponse(Events::ArgumentStack&& args) +{ + if (!m_httpServerThread || !m_httpServer->is_running()) + { + LOG_ERROR("Can't send HTTP server response, no server is running!"); + return Services::Events::Arguments(); + } + auto requestId = Services::Events::ExtractArgument(args); + auto response = Services::Events::ExtractArgument(args); + auto contentType = Services::Events::ExtractArgument(args); + auto cacheSeconds = Services::Events::ExtractArgument(args); + auto cacheUntil = std::chrono::system_clock::now() + std::chrono::seconds(cacheSeconds); + m_responses[requestId] = Server::Response(response, static_cast(contentType), cacheUntil); + + return Services::Events::Arguments(); +} + +} diff --git a/Plugins/HTTP/HTTP/Server.hpp b/Plugins/HTTP/HTTP/Server.hpp new file mode 100644 index 00000000000..003a833ba61 --- /dev/null +++ b/Plugins/HTTP/HTTP/Server.hpp @@ -0,0 +1,52 @@ +#pragma once + +#include "HTTP.hpp" +#include "Services/Events/Events.hpp" + +namespace HTTP { + +using namespace NWNXLib::Services; + +class Server +{ + struct Response + { + std::string message; + HTTP::ContentType contentType; + std::chrono::system_clock::time_point cacheUntil; + + Response() + { + message = ""; + contentType = HTTP::ContentType::PLAINTEXT; + cacheUntil = std::chrono::system_clock::now(); + } + Response(std::string message, HTTP::ContentType contentType, std::chrono::system_clock::time_point cacheUntil) + { + this->message = std::move(message); + this->contentType = contentType; + this->cacheUntil = cacheUntil; + } + }; +public: + explicit Server(ConfigProxy*, EventsProxy*, MessagingProxy*, TasksProxy*); + virtual ~Server(); + static Response WaitForResponse(uint32_t, const std::atomic_bool&); + static void DeleteResponse(uint32_t); + static uint32_t GetNewRequestID(); + static std::unique_ptr m_httpServer; + static std::unique_ptr m_httpServerThread; + static std::chrono::milliseconds m_responseTimeout; + +private: + static TasksProxy* m_servTasks; + static MessagingProxy* m_servMessaging; + + static Events::ArgumentStack SendResponse(Events::ArgumentStack&&); + + static std::unordered_map m_responses; + static std::unordered_map m_cachedResponses; + static uint32_t m_servRequestId; +}; + +} diff --git a/Plugins/HTTP/NWScript/nwnx_http.nss b/Plugins/HTTP/NWScript/nwnx_http.nss new file mode 100644 index 00000000000..76a4930a00f --- /dev/null +++ b/Plugins/HTTP/NWScript/nwnx_http.nss @@ -0,0 +1,134 @@ +/// @addtogroup http HTTP +/// @brief NWNX HTTP Server and Client +/// @{ +/// @file nwnx_http.nss +#include "nwnx" + +const string NWNX_HTTP = "NWNX_HTTP"; ///< @private + +/// @name Request Types +/// @anchor request_types +/// +/// @{ +const int NWNX_HTTP_REQUEST_METHOD_GET = 0; +const int NWNX_HTTP_REQUEST_METHOD_POST = 1; +const int NWNX_HTTP_REQUEST_METHOD_DELETE = 2; +const int NWNX_HTTP_REQUEST_METHOD_PATCH = 3; +const int NWNX_HTTP_REQUEST_METHOD_PUT = 4; +const int NWNX_HTTP_REQUEST_METHOD_OPTION = 5; +const int NWNX_HTTP_REQUEST_METHOD_HEAD = 6; +///@} + +/// @name Content Types +/// @anchor content_types +/// +/// @{ +const int NWNX_HTTP_CONTENT_TYPE_HTML = 0; +const int NWNX_HTTP_CONTENT_TYPE_PLAINTEXT = 1; +const int NWNX_HTTP_CONTENT_TYPE_JSON = 2; +const int NWNX_HTTP_CONTENT_TYPE_FORM_URLENCODED = 3; +const int NWNX_HTTP_CONTENT_TYPE_XML = 4; +///@} + +/// @name HTTP Authentication Types +/// @anchor auth_types +/// +/// @{ +const int NWNX_HTTP_AUTH_TYPE_NONE = 0; +const int NWNX_HTTP_AUTH_TYPE_BASIC = 1; +const int NWNX_HTTP_AUTH_TYPE_DIGEST = 2; +const int NWNX_HTTP_AUTH_TYPE_BEARER_TOKEN = 3; +///@} + +/// A structure for an HTTP Client Request +struct NWNX_HTTP_Client_Request +{ + int nRequestMethod; ///< A @ref request_types "Request Type" + object oObject; ///< If this request pertains to a specific game object, can be helpful when retrieving the data in an event + string sTag; ///< A unique tag for this request + string sHost; ///< The host domain name/IP address + string sPath; ///< The path for the url (include the leading /) + string sData; ///< The data being sent + int nContentType; ///< A @ref content_types "Content Type" + int nAuthType; ///< An @ref auth_types "Authentication Type" + string sAuthUserOrToken; ///< The authentication username or token + string sAuthPassword; ///< The authentication password (ignored if just using a token) + int nPort; ///< The host port + string sHeaders; ///< Pipe (|) delimited header pairs, e.g. "User-Agent: My NWNX HTTP Client|Accept: application/vnd.github.v3+json" +}; + +/// @brief Returns a string to the http server +/// @param nRequestId The id of the http server request +/// @param sMessage The message to return +/// @param nContentType The content type from @ref content_types "content_types" +/// @param nCache Length in seconds to cache the response +/// @remark The cache setting does not honour any http client cache related headers, it merely caches an event response on the c++ side. +void NWNX_HTTP_Server_SendResponse(int nRequestId, string sMessage, int nContentType = NWNX_HTTP_CONTENT_TYPE_HTML, int nCache = 0); + +/// @brief Sends an http method to the given host. +/// @param s The structured NWNX_HTTP_Client_Request information. +/// @return A unique identifier for the request for later access in the REQUEST_ID event data. +int NWNX_HTTP_Client_SendRequest(struct NWNX_HTTP_Client_Request s); + +/// @brief Returns an NWNX_HTTP_Client_Request structure +/// @param nRequestId The request id returned from NWNX_HTTP_Client_SendRequest() +/// @return The structured NWNX_HTTP_Client_Request information +struct NWNX_HTTP_Client_Request NWNX_HTTP_Client_GetRequest(int nRequestId); + +/// @} + +void NWNX_HTTP_Server_SendResponse(int nRequestId, string sMessage, int nContentType, int nCache) +{ + string sFunc = "Server_SendResponse"; + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nCache); + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nContentType); + NWNX_PushArgumentString(NWNX_HTTP, sFunc, sMessage); + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nRequestId); + NWNX_CallFunction(NWNX_HTTP, sFunc); +} + +int NWNX_HTTP_Client_SendRequest(struct NWNX_HTTP_Client_Request s) +{ + string sFunc = "Client_SendRequest"; + NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sHeaders); + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nPort); + NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sAuthPassword); + NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sAuthUserOrToken); + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nAuthType); + NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sData); + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nContentType); + NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sPath); + NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sHost); + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nRequestMethod); + NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sTag); + NWNX_PushArgumentObject(NWNX_HTTP, sFunc, s.oObject); + NWNX_CallFunction(NWNX_HTTP, sFunc); + + return NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); +} + +struct NWNX_HTTP_Client_Request NWNX_HTTP_Client_GetRequest(int nRequestId) +{ + + string sFunc = "Client_GetRequest"; + + NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nRequestId); + NWNX_CallFunction(NWNX_HTTP, sFunc); + + struct NWNX_HTTP_Client_Request s; + + s.oObject = NWNX_GetReturnValueObject(NWNX_HTTP, sFunc); + s.sTag = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + s.nRequestMethod = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); + s.sHost = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + s.sPath = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + s.nContentType = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); + s.sData = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + s.nAuthType = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); + s.sAuthUserOrToken = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + s.sAuthPassword = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + s.nPort = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); + s.sHeaders = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + + return s; +} diff --git a/Plugins/HTTP/NWScript/nwnx_http_json.nss b/Plugins/HTTP/NWScript/nwnx_http_json.nss new file mode 100644 index 00000000000..9ba7e7294bd --- /dev/null +++ b/Plugins/HTTP/NWScript/nwnx_http_json.nss @@ -0,0 +1,322 @@ +/// @addtogroup http +/// @{ +/// @file nwnx_http_json.nss +/// @brief Helper script for constructing json data for NWNX_HTTP_Client_SendRequest() + +/// @brief Create a new JSON object. +/// @param isArray TRUE is the object is an array. +/// @return A unique identifier for this object. +int NWNX_HTTP_JSON_NewObject(int isArray = FALSE); + +/// @brief Create a new JSON array. +/// @return A unique identifier for this array. +int NWNX_HTTP_JSON_NewArray(); + +/// @brief Add a JSON object to a JSON object. +/// @param nJSONObjectId The JSON object you're adding to. +/// @param sKey The key name for this object. +/// @param nJSONSubObjectID The JSON object being added. +void NWNX_HTTP_JSON_ObjectAddObject(int nJSONObjectId, string sKey, int nJSONSubObjectID); + +/// @brief Add a JSON array to a JSON object. +/// @param nJSONObjectId The JSON object you're adding to. +/// @param sKey The key name for this array. +/// @param nJSONArrayID The JSON array being added. +void NWNX_HTTP_JSON_ObjectAddArray(int nJSONObjectId, string sKey, int nJSONArrayID); + +/// @brief Add a string to a JSON object. +/// @param nJSONObjectId The JSON object you're adding to. +/// @param sKey The key name for this string. +/// @param sValue The string value being added. +void NWNX_HTTP_JSON_ObjectAddString(int nJSONObjectId, string sKey, string sValue); + +/// @brief Add an integer to a JSON object. +/// @param nJSONObjectId The JSON object you're adding to. +/// @param sKey The key name for this integer. +/// @param nInt The integer value being added. +void NWNX_HTTP_JSON_ObjectAddInt(int nJSONObjectId, string sKey, int nInt); + +/// @brief Add a float to a JSON object. +/// @param nJSONObjectId The JSON object you're adding to. +/// @param sKey The key name for this float. +/// @param fFloat The float value being added. +void NWNX_HTTP_JSON_ObjectAddFloat(int nJSONObjectId, string sKey, float fFloat); + +/// @brief Add a boolean to a JSON object. +/// @param nJSONObjectId The JSON object you're adding to. +/// @param sKey The key name for this boolean. +/// @param bBool The boolean value being added. +void NWNX_HTTP_JSON_ObjectAddBool(int nJSONObjectId, string sKey, int bBool); + +/// @brief Add a NULL value to a JSON object. +/// @param nJSONObjectId The JSON object you're adding to. +/// @param sKey The key name for this NULL value. +void NWNX_HTTP_JSON_ObjectAddNULL(int nJSONObjectId, string sKey); + +/// @brief Internal command to get amount of elements in a JSON array +/// @param nJSONArrayID The JSON array being counted. +/// @return The number of elements. +int NWNX_HTTP_JSON_GetArrayElementCount(int nJSONArrayID); + +/// @brief Internal command to update the element counter fpr a JSON array +/// @param nJSONArrayID The JSON array being updated +void NWNX_HTTP_JSON_UpdateArrayElementCount(int nJSONArrayID); + +/// @brief Add a JSON object to the front of a JSON array. +/// @param nJSONArrayID The JSON array the element is being inserted. +/// @param nJSONObjectId The JSON object being inserted. +void NWNX_HTTP_JSON_ArrayInsertObject(int nJSONArrayID, int nJSONObjectId); + +/// @brief Add an array to the front of a JSON array. +/// @param nJSONArrayID The JSON array the element is being inserted. +/// @param nJSONSubArrayID The JSON array being inserted. +void NWNX_HTTP_JSON_ArrayInsertArray(int nJSONArrayID, int nJSONSubArrayID); + +/// @brief Add a string to the front of a JSON array. +/// @param nJSONArrayID The JSON array the element is being inserted. +/// @param sElement The string value being inserted. +void NWNX_HTTP_JSON_ArrayInsertString(int nJSONArrayID, string sElement); + +/// @brief Add an integer to the front of a JSON array. +/// @param nJSONArrayID The JSON array the element is being inserted. +/// @param nElement The integer value being inserted. +void NWNX_HTTP_JSON_ArrayInsertInt(int nJSONArrayID, int nElement); + +/// @brief Add a float to the front of a JSON array. +/// @param nJSONArrayID The JSON array the element is being inserted. +/// @param fElement The float value being inserted. +void NWNX_HTTP_JSON_ArrayInsertFloat(int nJSONArrayID, float fElement); + +/// @brief Add a boolean to the front of a JSON array. +/// @param nJSONArrayID The JSON array the element is being inserted. +/// @param bBool The boolean value being added. +void NWNX_HTTP_JSON_ArrayInsertBool(int nJSONArrayID, int bBool); + +/// @brief Add a NULL value to the front of a JSON array. +/// @param nJSONArrayID The JSON array the element is being inserted. +void NWNX_HTTP_JSON_ArrayInsertNULL(int nJSONArrayID); + +/// @brief Returns a json string representation of a JSON object. +/// @param nJSONObjectID The JSON object to dump as a string. +/// @return A string representation of the json object. +string NWNX_HTTP_JSON_GetJSONString(int nJSONObjectID); + +/// @} +int NWNX_HTTP_JSON_NewObject(int isArray = FALSE) +{ + object oModule = GetModule(); + + if (!GetLocalInt(oModule, "NWNX_JSON_TABLE_INIT")) + { + string table = "CREATE TABLE IF NOT EXISTS json_build ( json_object_id INTEGER PRIMARY KEY, json_text TEXT )"; + sqlquery sqlQuery = SqlPrepareQueryObject(oModule, table); + SqlStep(sqlQuery); + + table = "CREATE TABLE IF NOT EXISTS json_array_element_counter ( json_array_id INTEGER PRIMARY KEY, count INTEGER DEFAULT 1)"; + sqlQuery = SqlPrepareQueryObject(oModule, table); + SqlStep(sqlQuery); + SetLocalInt(oModule, "NWNX_JSON_TABLE_INIT", 1); + } + + string insert = "INSERT INTO json_build VALUES (NULL, @object_type)"; + sqlquery sqlQuery = SqlPrepareQueryObject(oModule, insert); + SqlBindString(sqlQuery, "@object_type", isArray ? "[]" : "{}"); + SqlStep(sqlQuery); + + string stmt = "SELECT LAST_INSERT_ROWID()"; + sqlQuery = SqlPrepareQueryObject(oModule, stmt); + SqlStep(sqlQuery); + + return SqlGetInt(sqlQuery, 0); +} + +int NWNX_HTTP_JSON_NewArray() +{ + return NWNX_HTTP_JSON_NewObject(TRUE); +} + +void NWNX_HTTP_JSON_ObjectAddObject(int nJSONObjectId, string sKey, int nJSONSubObjectID) +{ + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, (SELECT json(json_text) "+ + "FROM json_build WHERE json_object_id = @json_subobject_id)) WHERE json_object_id = @json_object_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$."+sKey); + SqlBindInt(sqlQuery, "@json_subobject_id", nJSONSubObjectID); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); + SqlStep(sqlQuery); +} + +void NWNX_HTTP_JSON_ObjectAddArray(int nJSONObjectId, string sKey, int nJSONArrayID) +{ + NWNX_HTTP_JSON_ObjectAddObject(nJSONObjectId, sKey, nJSONArrayID); +} + +void NWNX_HTTP_JSON_ObjectAddString(int nJSONObjectId, string sKey, string sValue) +{ + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @string_value) WHERE json_object_id = @json_object_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$." + sKey); + SqlBindString(sqlQuery, "@string_value", sValue); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); + SqlStep(sqlQuery); +} + +void NWNX_HTTP_JSON_ObjectAddInt(int nJSONObjectId, string sKey, int nInt) +{ + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @int_value) WHERE json_object_id = @json_object_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$." + sKey); + SqlBindInt(sqlQuery, "@int_value", nInt); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); + SqlStep(sqlQuery); +} + +void NWNX_HTTP_JSON_ObjectAddFloat(int nJSONObjectId, string sKey, float fFloat) +{ + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @float_value) WHERE json_object_id = @json_object_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$." + sKey); + SqlBindFloat(sqlQuery, "@float_value", fFloat); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); + SqlStep(sqlQuery); +} + +void NWNX_HTTP_JSON_ObjectAddBool(int nJSONObjectId, string sKey, int bBool) +{ + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(@bool_value)) WHERE json_object_id = @json_object_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$." + sKey); + SqlBindString(sqlQuery, "@bool_value", bBool ? "true" : "false"); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); + SqlStep(sqlQuery); +} + +void NWNX_HTTP_JSON_ObjectAddNULL(int nJSONObjectId, string sKey) +{ + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(NULL)) WHERE json_object_id = @json_object_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$." + sKey); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); + SqlStep(sqlQuery); +} + +int NWNX_HTTP_JSON_GetArrayElementCount(int nJSONArrayID) +{ + int array_element_count = 0; + string stmt = "SELECT count FROM json_array_element_counter WHERE json_array_id = @json_array_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + if (SqlStep(sqlQuery)) + array_element_count = SqlGetInt(sqlQuery, 0); + return array_element_count; +} + +void NWNX_HTTP_JSON_UpdateArrayElementCount(int nJSONArrayID) +{ + string stmt = "INSERT INTO json_array_element_counter(json_array_id) VALUES (@json_array_id) ON CONFLICT(json_array_id) DO UPDATE SET count = count + 1"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + SqlStep(sqlQuery); +} + +void NWNX_HTTP_JSON_ArrayInsertObject(int nJSONArrayID, int nJSONObjectId) +{ + int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); + + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, (SELECT json(json_text) "+ + "FROM json_build WHERE json_object_id = @json_object_id)) WHERE json_object_id = @json_array_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + SqlStep(sqlQuery); + + NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); +} + +void NWNX_HTTP_JSON_ArrayInsertArray(int nJSONArrayID, int nJSONSubArrayID) +{ + NWNX_HTTP_JSON_ArrayInsertObject(nJSONArrayID, nJSONSubArrayID); +} + +void NWNX_HTTP_JSON_ArrayInsertString(int nJSONArrayID, string sElement) +{ + int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); + + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @string_value) WHERE json_object_id = @json_array_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); + SqlBindString(sqlQuery, "@string_value", sElement); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + SqlStep(sqlQuery); + + NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); +} + +void NWNX_HTTP_JSON_ArrayInsertInt(int nJSONArrayID, int nElement) +{ + int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); + + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @int_value) WHERE json_object_id = @json_array_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); + SqlBindInt(sqlQuery, "@int_value", nElement); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + SqlStep(sqlQuery); + + NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); +} + +void NWNX_HTTP_JSON_ArrayInsertFloat(int nJSONArrayID, float fElement) +{ + int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); + + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @float_value) WHERE json_object_id = @json_array_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); + SqlBindFloat(sqlQuery, "@float_value", fElement); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + SqlStep(sqlQuery); + + NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); +} + +void NWNX_HTTP_JSON_ArrayInsertBool(int nJSONArrayID, int bBool) +{ + int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); + + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(@bool_value)) WHERE json_object_id = @json_array_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); + SqlBindString(sqlQuery, "@bool_value", bBool ? "true" : "false"); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + SqlStep(sqlQuery); + + NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); +} + +void NWNX_HTTP_JSON_ArrayInsertNULL(int nJSONArrayID) +{ + int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); + + string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(NULL)) WHERE json_object_id = @json_array_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); + SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); + SqlStep(sqlQuery); + + NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); +} + +string NWNX_HTTP_JSON_GetJSONString(int nJSONObjectID) +{ + string stmt = "SELECT json(json_text) FROM json_build WHERE json_object_id = @json_object_id"; + sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); + SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectID); + string sJSON = "{}"; + if ( SqlStep(sqlQuery) ) + { + sJSON = SqlGetString(sqlQuery, 0); + } + return sJSON; +} diff --git a/Plugins/HTTP/README.md b/Plugins/HTTP/README.md new file mode 100644 index 00000000000..e1a7c80e8fd --- /dev/null +++ b/Plugins/HTTP/README.md @@ -0,0 +1,231 @@ +@page http Readme +@ingroup http + +## Introduction +The HTTP Plugin provides access to both a Server and Client to accept and perform requests and return responses. + +## Environment Variables + +| Variable Name | Type | Default Value | +| ----------------------------------| :--------: | ------------------ | +| NWNX_HTTP_CLIENT_REQUEST_TIMEOUT | int | 2000 | +| NWNX_HTTP_SERVER | bool | false | +| NWNX_HTTP_SERVER_PORT | int | 8686 | +| NWNX_HTTP_SERVER_ROOT_STATUS | int | 403 (Forbidden) | +| NWNX_HTTP_SERVER_ROOT_HTML | string | ```Welcome to nwnx http!

Welcome to nwnx http!

``` | +| NWNX_HTTP_SERVER_USE_SSL | bool | false | +| NWNX_HTTP_SERVER_SSL_CERT_FILE | string | ./cert.pem | +| NWNX_HTTP_SERVER_SSL_KEY_FILE | string | ./key.pem | +| NWNX_HTTP_SERVER_EVENT_URL | string | | +| NWNX_HTTP_SERVER_RESPONSE_TIMEOUT | int | 1000 | +| NWNX_HTTP_RPC | bool | false | +| NWNX_HTTP_SERVER_RPC_URL | string | /rpc | +| NWNX_HTTP_SERVER_RPC_AUTH_TOKEN | string | | + +## Setup +### Client +The Client commands are functional by simply loading the plugin. +### Server +The server will run when `NWNX_HTTP_SERVER` is set to `true`. +It will be accessible by default on port 8686 (configured with `NWNX_HTTP_SERVER_PORT`) but further +configuration is necessary as by default visiting http://your.host:8686 will return a `403 Forbidden` error. + +If you wish your server to return information when visiting the root level then you must set the +`NWNX_HTTP_SERVER_ROOT_STATUS` to `200`. By default this returns a simple "Welcome to nwnx http" web page, +but this content can be controlled with the `NWNX_HTTP_SERVER_ROOT_HTML` environment variable. + +The server can also be configured to run on https by setting `NWNX_HTTP_USE_SSL` to `true` and placing +a `cert.pem` and `key.pem` in the same folder as your `NWNX_HTTP.so`. Alternatively, you can configure +the name and path to the certificate and private key with the +`NWNX_HTTP_SERVER_SSL_CERT_FILE` and `NWNX_HTTP_SERVER_SSL_KEY_FILE` environment variables. +**Remember that the user that runs the nwn-server must be able to read both these files.** + +### RPC +In addition to the regular GET protocol that the Server handles, the plugin includes a more robust RPC Server that handles +a POST request event which can accept form-urlencoded or json data. To enable this RPC server set `NWNX_HTTP_RPC` to `true`. + +The RPC server supports an authentication token by setting the `NWNX_HTTP_SERVER_RPC_AUTH_TOKEN` environment variable to a +value of your choosing. Optionally you can simply set the `NWNX_HTTP_SERVER_RPC_URL` to an obscure URL much like Discord +does with their webhooks. An example command to produce either this token or url is +`ruby -rsecurerandom -e 'puts SecureRandom.hex(32)`. You can set both or either but you must set at least one. + +If you do not set an `NWNX_HTTP_SERVER_RPC_URL` environment variable then the url will be `/rpc`. + +## Events +### Server Event Setup +The true utility of the HTTP Server is broadcasting a call to the `NWNX_ON_HTTP_SERVER_GET` event. The builder begins +by setting an environment variable `NWNX_HTTP_SERVER_EVENT_URL` for a path wildcard that accepts requests, +for example `/nwnx/(.*)`. When this is set and an http client visits http://your.site:8686/nwnx/testing an +`NWNX_ON_HTTP_SERVER_GET` event will be signalled. The Event Data is the path `PATH` and a unique integer `REQUEST_ID`. +Once the event is sent to your nwscript you build the response you wish to return and then send it back with the +`NWNX_HTTP_Server_SendResponse()` command. + +Here's an example of the functionality. +1. In your `on_module_load.nss` script subscribe to the `NWNX_ON_HTTP_SERVER_GET` event, for example: + `NWNX_Events_SubscribeEvent("NWNX_ON_HTTP_SERVER_GET", "event_http_get");` +2. In your `event_http_get.nss` script you would have something like below: +```c +#include "nwnx_events" +#include "nwnx_http" + +void main() +{ + object oModule = OBJECT_SELF; + if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTP_SERVER_GET") + { + int nRequestId = StringToInt(NWNX_Events_GetEventData("REQUEST_ID")); + string sPath = NWNX_Events_GetEventData("PATH"); + if (sPath == "/nwnx/testing") + NWNX_HTTP_Server_SendResponse(nRequestId, "TestingThis is a test"); + } +``` +### RPC Event Setup +Much like the HTTP Server, the RPC Server signals an `NWNX_ON_HTTP_SERVER_POST` event. The data included with this event +includes `REQUEST_ID` and either `JSON_DATA` or if using form-urlencoded data it sends `PARAM_COUNT` and `PARAM_KEY_#` and +`PARAM_VALUE_#` pairs for the builder to loop through in the event handler script. + +Here's an example of an RPC event handler. +1. In your `on_module_load.nss` script subscribe to the `NWNX_ON_HTTP_SERVER_POST` event, for example: + `NWNX_Events_SubscribeEvent("NWNX_ON_HTTP_SERVER_POST", "event_http_post");` +2. In your `event_http_post.nss` script you would have something like below. Please note that extracting data + from json is not the intention of this tutorial and the example below is quite sophisticated. + You may wish to use the PARAM_COUNT and looping through PARAM_KEY/VALUE pairs instead but this example is given as a reference + point for understanding how to use sqlite to get json data. + +```c +#include "nwnx_events" +#include "nwnx_http" + +void main() +{ + object oModule = OBJECT_SELF; + if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTP_SERVER_POST") + { + int nRequestId = StringToInt(NWNX_Events_GetEventData("REQUEST_ID")); + string sJSONData = NWNX_Events_GetEventData("JSON_DATA"); + object oModule = GetModule(); + + // Find the json for the functions + string stmt = "SELECT json_extract(@json_data, @key)"; + sqlquery sqlQuery = SqlPrepareQueryObject(oModule, stmt); + SqlBindString(sqlQuery, "@json_data", sJSON_Data); + SqlBindString(sqlQuery, "@key", "$.function"); + string sFunction = ""; + if ( SqlStep(sqlQuery) ) + sFunction = SqlGetString(sqlQuery, 0); + + // Find all functions + stmt = "SELECT key, value FROM json_tree(@json_data) WHERE parent = (SELECT id FROM json_tree(@json_data) WHERE key = 'function')"; + sqlQuery = SqlPrepareQueryObject(oModule, stmt); + SqlBindString(sqlQuery, "@json_data", sJSON_Data); + string sResponse = ""; + while (SqlStep(sqlQuery)) + { + string sFunction = SqlGetString(sqlQuery, 0); + string sData = SqlGetString(sqlQuery, 1); + if (sFunction == "SendMessageToPC") + { + // Find the key value pairs for this function + string subStmt = "SELECT * FROM json_tree(@sub_data) WHERE atom IS NOT NULL"; + sqlquery subSqlQuery = SqlPrepareQueryObject(oModule, subStmt); + SqlBindString(subSqlQuery, "@sub_data", sData); + while (SqlStep(subSqlQuery)) + { + string sName = SqlGetString(subSqlQuery, 0); + object oPC = GetPCWithCommunityName(sName); + string sMessage = SqlGetString(subSqlQuery, 1); + SendMessageToPC(oPC, sMessage); + sResponse = sResponse + " " + GetName(oPC); + } + } + } + NWNX_HTTP_Server_SendResponse(nRequestId, "Message sent to player(s): " + sResponse); + } +``` +3. The builder sends the following request to his server: +```shell +curl -i http://localhost:8686/b547bd34f896325c4f8f28ec34f895105c38b427fdaf2 -H 'Content-Type: application/json' --data-binary @- << EOF +{ + "function": { + "SendMessageToPC": { + "players": [ + { "orth": "Log off." } + ] + } + } +} +EOF +``` +4. The builder receives the response: `Message sent to player(s): ` + +## Client Usage +The HTTP Client contains two functions, `NWNX_HTTP_Client_SendRequest()` and `NWNX_HTTP_Client_GetRequest()` and broadcasts two events, +`NWNX_ON_HTTP_CLIENT_SUCCESS` and `NWNX_ON_HTTP_CLIENT_FAILED`. + +The builder constructs an `NWNX_HTTP_Client_Request` struct with the appropriate information +then passes that struct into `NWNX_HTTP_Client_SendRequest()` which will return a unique request identifier. The +request is then sent to the host and upon success or failure the respective event is called. + +The event data sent is `REQUEST_ID`, `STATUS` and `RESPONSE`. The `REQUEST_ID` +event data is the integer returned with `NWNX_HTTP_Client_SendRequest()`. The structure for that +request can then be queried via `NWNX_HTTP_Client_GetRequest()`. The `STATUS` event data is the +server HTTP status return code, (usually 200 on success) and the `RESPONSE` is the body of text +the server returned. + +Additionally the event data includes Rate Limit information that some servers provide. These are `RATELIMIT_LIMIT` which is how +many requests you can send in a given time period, `RATELIMIT_REMAINING` is how many requests you have left in that +time period and `RATELIMIT_RESET` is an epoch timestamp when the request limit is reset again. There is also `RETRY_AFTER` which +some servers provide which is how long in seconds before you can send another request. + +### JSON Helper +The plugin includes a helper library to construct JSON objects for client requests, `nwnx_http_json.nss`. + +### Example Client Requests +Here is an example of posting an issue to a github repository. +```c + int githubJSON = NWNX_HTTP_JSON_NewObject(); + NWNX_HTTP_JSON_ObjectAddString(githubJSON, "title", "Testing HTTP Client"); + NWNX_HTTP_JSON_ObjectAddString(githubJSON, "body", "Text message. You can use Markdown here. *Italic* **bold** __underline__ ~~strikeout~~ [hyperlink](https://google.com) `code`"); + NWNX_HTTP_JSON_ObjectAddString(githubJSON, "assignee", NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME")); + int labelsArray = NWNX_HTTP_JSON_NewArray(); + NWNX_HTTP_JSON_ArrayInsertString(labelsArray, "bug"); + NWNX_HTTP_JSON_ArrayInsertString(labelsArray, "help wanted"); + NWNX_HTTP_JSON_ObjectAddArray(githubJSON, "labels", labelsArray); + string sJSON = NWNX_HTTP_JSON_GetJSONString(githubJSON); + + struct NWNX_HTTP_Client_Request stGithubPost; + stGithubPost.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_POST; + stGithubPost.sHost = "api.github.com"; + stGithubPost.sPath = NWNX_Util_GetEnvironmentVariable("GITHUB_REPO_PATH") + "/issues"; + stGithubPost.sData = sJSON; + stGithubPost.nAuthType = NWNX_HTTP_AUTH_TYPE_BASIC; + stGithubPost.sAuthUserOrToken = NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"); + stGithubPost.sAuthPassword = NWNX_Util_GetEnvironmentVariable("GITHUB_NWN_PAT"); + stGithubPost.sHeaders = "Accept: application/vnd.github.v3+json"; + NWNX_HTTP_Client_SendRequest(stGithubPost); +``` + +Here's an example of insulting a PC when they enter an area +```c + struct NWNX_HTTP_Client_Request stInsultGen; + stInsultGen.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_GET; + stInsultGen.sHost = "evilinsult.com"; + stInsultGen.sPath = "/generate_insult.php"; + stInsultGen.oObject = GetEnteringObject(); + stInsultGen.sTag = "INSULT_ENTERING_PC"; + int nClientRequestId = NWNX_HTTP_Client_SendRequest(stInsultGen); +``` + +Then set up an event: +```c + if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTP_CLIENT_SUCCESS") + { + int nRequestId = StringToInt(NWNX_Events_GetEventData("REQUEST_ID")); + struct NWNX_HTTP_Client_Request sRequest = NWNX_HTTP_Client_GetRequest(nRequestId); + if (sRequest.sTag == "INSULT_ENTERING_PC") + { + string sResponse = NWNX_Events_GetEventData("RESPONSE"); + SendMessageToPC(sRequest.oObject, sResponse); + } + } +``` \ No newline at end of file From 4ff2fd158220fe0c5cdcbb80376ebe8b0a6fe31b Mon Sep 17 00:00:00 2001 From: plenarius Date: Fri, 15 Jan 2021 22:38:20 -0500 Subject: [PATCH 02/19] Use inline and init in header --- Plugins/HTTP/HTTP/Client.cpp | 6 ------ Plugins/HTTP/HTTP/Client.hpp | 8 ++++---- Plugins/HTTP/HTTP/Server.cpp | 4 ---- Plugins/HTTP/HTTP/Server.hpp | 6 +++--- 4 files changed, 7 insertions(+), 17 deletions(-) diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp index e915cb42044..31b589a4d90 100644 --- a/Plugins/HTTP/HTTP/Client.cpp +++ b/Plugins/HTTP/HTTP/Client.cpp @@ -16,18 +16,12 @@ namespace HTTP TasksProxy* Client::m_servTasks; MessagingProxy* Client::m_servMessaging; -int Client::m_clientRequestId; -int Client::m_clientTimeout; -std::unordered_map Client::m_clientRequests; -std::unordered_map> Client::m_clientHostCache; - Client::Client(ConfigProxy* config, EventsProxy* events, MessagingProxy* messaging, TasksProxy* tasks) { events->RegisterEvent("Client_SendRequest", &SendRequest); events->RegisterEvent("Client_GetRequest", &GetRequest); m_servTasks = tasks; m_servMessaging = messaging; - m_clientRequestId = 0; m_clientTimeout = config->Get("CLIENT_REQUEST_TIMEOUT", 2000); } diff --git a/Plugins/HTTP/HTTP/Client.hpp b/Plugins/HTTP/HTTP/Client.hpp index b47da162825..a98c701f4ae 100644 --- a/Plugins/HTTP/HTTP/Client.hpp +++ b/Plugins/HTTP/HTTP/Client.hpp @@ -50,10 +50,10 @@ class Client static void PerformRequest(const Client::Request&); static std::unique_ptr GetResult(const Client::Request&); static httplib::Headers ParseHeaderString(const std::string&); - static int m_clientRequestId; - static int m_clientTimeout; - static std::unordered_map> m_clientHostCache; - static std::unordered_map m_clientRequests; + static inline int m_clientRequestId = 0; + static inline int m_clientTimeout = 2000; + static inline std::unordered_map> m_clientHostCache; + static inline std::unordered_map m_clientRequests; }; } diff --git a/Plugins/HTTP/HTTP/Server.cpp b/Plugins/HTTP/HTTP/Server.cpp index ef73ee33c09..8517352aac5 100644 --- a/Plugins/HTTP/HTTP/Server.cpp +++ b/Plugins/HTTP/HTTP/Server.cpp @@ -14,10 +14,7 @@ MessagingProxy* Server::m_servMessaging; std::unique_ptr Server::m_httpServer; std::unique_ptr Server::m_httpServerThread; -std::unordered_map Server::m_responses; -std::unordered_map Server::m_cachedResponses; std::chrono::milliseconds Server::m_responseTimeout; -uint32_t Server::m_servRequestId; Server::Server(ConfigProxy* config, EventsProxy* events, MessagingProxy* messaging, TasksProxy* tasks) { @@ -25,7 +22,6 @@ Server::Server(ConfigProxy* config, EventsProxy* events, MessagingProxy* messagi m_servTasks = tasks; m_servMessaging = messaging; - m_servRequestId = 0; m_responseTimeout = std::chrono::milliseconds(config->Get("SERVER_RESPONSE_TIMEOUT", 1000)); auto rootHTML = config->Get("SERVER_ROOT_HTML", "Welcome to nwnx http!

Welcome to nwnx http!

"); auto rootStatus = config->Get("SERVER_ROOT_STATUS", 403); diff --git a/Plugins/HTTP/HTTP/Server.hpp b/Plugins/HTTP/HTTP/Server.hpp index 003a833ba61..f7d3690a58b 100644 --- a/Plugins/HTTP/HTTP/Server.hpp +++ b/Plugins/HTTP/HTTP/Server.hpp @@ -44,9 +44,9 @@ class Server static Events::ArgumentStack SendResponse(Events::ArgumentStack&&); - static std::unordered_map m_responses; - static std::unordered_map m_cachedResponses; - static uint32_t m_servRequestId; + static inline std::unordered_map m_responses; + static inline std::unordered_map m_cachedResponses; + static inline uint32_t m_servRequestId = 0; }; } From b7fa45c773445302ae0f382de1e17fa1d1c4f0a5 Mon Sep 17 00:00:00 2001 From: plenarius Date: Fri, 15 Jan 2021 22:38:58 -0500 Subject: [PATCH 03/19] declaration of default dtor unneeded --- Plugins/HTTP/HTTP/Client.cpp | 3 --- Plugins/HTTP/HTTP/Client.hpp | 1 - 2 files changed, 4 deletions(-) diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp index 31b589a4d90..47409434063 100644 --- a/Plugins/HTTP/HTTP/Client.cpp +++ b/Plugins/HTTP/HTTP/Client.cpp @@ -25,9 +25,6 @@ Client::Client(ConfigProxy* config, EventsProxy* events, MessagingProxy* messagi m_clientTimeout = config->Get("CLIENT_REQUEST_TIMEOUT", 2000); } -Client::~Client() -= default; - std::unique_ptr Client::GetResult(const Client::Request& client_req) { std::unique_ptr result; diff --git a/Plugins/HTTP/HTTP/Client.hpp b/Plugins/HTTP/HTTP/Client.hpp index a98c701f4ae..d578c23f7d3 100644 --- a/Plugins/HTTP/HTTP/Client.hpp +++ b/Plugins/HTTP/HTTP/Client.hpp @@ -39,7 +39,6 @@ class Client }; public: explicit Client(ConfigProxy*, EventsProxy*, MessagingProxy*, TasksProxy*); - virtual ~Client(); private: static TasksProxy* m_servTasks; static MessagingProxy* m_servMessaging; From 697dbb80412eaab14e5b7760f760db54eda1171e Mon Sep 17 00:00:00 2001 From: plenarius Date: Fri, 15 Jan 2021 22:39:34 -0500 Subject: [PATCH 04/19] Rename res to response so as to not confuse with result Handle invalid response better --- Plugins/HTTP/HTTP/Client.cpp | 76 ++++++++++++++++++------------------ 1 file changed, 37 insertions(+), 39 deletions(-) diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp index 47409434063..8ffe169324a 100644 --- a/Plugins/HTTP/HTTP/Client.cpp +++ b/Plugins/HTTP/HTTP/Client.cpp @@ -91,9 +91,9 @@ void Client::PerformRequest(const Client::Request& client_req) cli->second->set_connection_timeout(0, m_clientTimeout * 1000); auto result = GetResult(client_req); - auto clientError = result->error(); - if (clientError) + if (result == nullptr || result->error()) { + auto clientError = result != nullptr ? result->error() : httplib::Error::Unknown; m_servTasks->QueueOnMainThread([client_req, clientError]() { auto moduleOid = NWNXLib::Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf); @@ -104,58 +104,56 @@ void Client::PerformRequest(const Client::Request& client_req) }); return; } - auto res = result->value(); - m_servTasks->QueueOnMainThread([client_req, res]() + auto response = result->value(); + m_servTasks->QueueOnMainThread([client_req, response]() { if (Core::g_CoreShuttingDown) return; auto moduleOid = Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf); - if (res.status) + + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"STATUS", std::to_string(response.status)}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", response.body}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); + if (response.status == 200 || response.status == 201 || response.status == 204 || response.status == 429) { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"STATUS", std::to_string(res.status)}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", res.body}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); - if (res.status == 200 || res.status == 201 || res.status == 204 || res.status == 429) + // Discord sends your rate limit information even on success so you can stagger calls if you want + // This header also lets us know it's Discord not Slack, important because Discord sends RETRY_AFTER + // in milliseconds and Slack sends it as seconds. + if (response.has_header("X-RateLimit-Limit")) { - // Discord sends your rate limit information even on success so you can stagger calls if you want - // This header also lets us know it's Discord not Slack, important because Discord sends RETRY_AFTER - // in milliseconds and Slack sends it as seconds. - if (res.has_header("X-RateLimit-Limit")) - { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_LIMIT", res.get_header_value("X-RateLimit-Limit")}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_REMAINING", res.get_header_value("X-RateLimit-Remaining")}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_RESET", res.get_header_value("X-RateLimit-Reset")}); - if (res.has_header("Retry-After")) - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", res.get_header_value("Retry-After")}); - else if (res.has_header("Retry-At")) - { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", res.get_header_value("Retry-At")}); - } - } - // Slack rate limited - else if (res.has_header("Retry-After")) - { - float fSlackRetry = stof(res.get_header_value("Retry-After")) * 1000.0f; - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", std::to_string(fSlackRetry)}); - } - if (res.status != 429) - { - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_SUCCESS", moduleOid}); - LOG_INFO("HTTP Client Request to '%s%s' succeeded.", client_req.host, client_req.path); - } - else + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_LIMIT", response.get_header_value("X-RateLimit-Limit")}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_REMAINING", response.get_header_value("X-RateLimit-Remaining")}); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_RESET", response.get_header_value("X-RateLimit-Reset")}); + if (response.has_header("Retry-After")) + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-After")}); + else if (response.has_header("Retry-At")) { - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); - LOG_WARNING("HTTP Client Request to '%s%s' failed, rate limited.", client_req.host, client_req.path); + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-At")}); } } + // Slack rate limited + else if (response.has_header("Retry-After")) + { + float fSlackRetry = stof(response.get_header_value("Retry-After")) * 1000.0f; + m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", std::to_string(fSlackRetry)}); + } + if (response.status != 429) + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_SUCCESS", moduleOid}); + LOG_INFO("HTTP Client Request to '%s%s' succeeded.", client_req.host, client_req.path); + } else { m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); - LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.host, client_req.path, res.status); + LOG_WARNING("HTTP Client Request to '%s%s' failed, rate limited.", client_req.host, client_req.path); } } + else + { + m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); + LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.host, client_req.path, response.status); + } }); }); } From e1e19cc2a40c1a5317fe3a372f47ad050d069f8c Mon Sep 17 00:00:00 2001 From: plenarius Date: Sat, 16 Jan 2021 00:03:05 -0500 Subject: [PATCH 05/19] Remove oid as an http struct member --- Plugins/HTTP/HTTP/Client.cpp | 2 -- Plugins/HTTP/HTTP/Client.hpp | 2 -- Plugins/HTTP/NWScript/nwnx_http.nss | 3 --- Plugins/HTTP/README.md | 7 +++++-- 4 files changed, 5 insertions(+), 9 deletions(-) diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp index 8ffe169324a..7bb86bc04ae 100644 --- a/Plugins/HTTP/HTTP/Client.cpp +++ b/Plugins/HTTP/HTTP/Client.cpp @@ -185,7 +185,6 @@ Events::ArgumentStack Client::SendRequest(Events::ArgumentStack&& args) { auto clientReq = Request(); clientReq.id = m_clientRequestId++; - clientReq.oid = Services::Events::ExtractArgument(args); clientReq.tag = Services::Events::ExtractArgument(args); clientReq.requestMethod = static_cast(Services::Events::ExtractArgument(args)); clientReq.host = Services::Events::ExtractArgument(args); @@ -224,7 +223,6 @@ Events::ArgumentStack Client::GetRequest(Events::ArgumentStack&& args) Services::Events::InsertArgument(stack, clientReq.host); Services::Events::InsertArgument(stack, (int32_t)clientReq.requestMethod); Services::Events::InsertArgument(stack, clientReq.tag); - Services::Events::InsertArgument(stack, (ObjectID)clientReq.oid); return stack; } diff --git a/Plugins/HTTP/HTTP/Client.hpp b/Plugins/HTTP/HTTP/Client.hpp index d578c23f7d3..f452807e33d 100644 --- a/Plugins/HTTP/HTTP/Client.hpp +++ b/Plugins/HTTP/HTTP/Client.hpp @@ -12,7 +12,6 @@ class Client { struct Request { - ObjectID oid; int id; HTTP::RequestMethod requestMethod; std::string host; @@ -34,7 +33,6 @@ class Client port = 443; authType = HTTP::AuthenticationType::NONE; contentType = HTTP::ContentType::HTML; - oid = NWNXLib::API::Constants::OBJECT_INVALID; } }; public: diff --git a/Plugins/HTTP/NWScript/nwnx_http.nss b/Plugins/HTTP/NWScript/nwnx_http.nss index 76a4930a00f..00573d83375 100644 --- a/Plugins/HTTP/NWScript/nwnx_http.nss +++ b/Plugins/HTTP/NWScript/nwnx_http.nss @@ -44,7 +44,6 @@ const int NWNX_HTTP_AUTH_TYPE_BEARER_TOKEN = 3; struct NWNX_HTTP_Client_Request { int nRequestMethod; ///< A @ref request_types "Request Type" - object oObject; ///< If this request pertains to a specific game object, can be helpful when retrieving the data in an event string sTag; ///< A unique tag for this request string sHost; ///< The host domain name/IP address string sPath; ///< The path for the url (include the leading /) @@ -101,7 +100,6 @@ int NWNX_HTTP_Client_SendRequest(struct NWNX_HTTP_Client_Request s) NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sHost); NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nRequestMethod); NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sTag); - NWNX_PushArgumentObject(NWNX_HTTP, sFunc, s.oObject); NWNX_CallFunction(NWNX_HTTP, sFunc); return NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); @@ -117,7 +115,6 @@ struct NWNX_HTTP_Client_Request NWNX_HTTP_Client_GetRequest(int nRequestId) struct NWNX_HTTP_Client_Request s; - s.oObject = NWNX_GetReturnValueObject(NWNX_HTTP, sFunc); s.sTag = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); s.nRequestMethod = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); s.sHost = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); diff --git a/Plugins/HTTP/README.md b/Plugins/HTTP/README.md index e1a7c80e8fd..8beeaa280c7 100644 --- a/Plugins/HTTP/README.md +++ b/Plugins/HTTP/README.md @@ -214,6 +214,7 @@ Here's an example of insulting a PC when they enter an area stInsultGen.oObject = GetEnteringObject(); stInsultGen.sTag = "INSULT_ENTERING_PC"; int nClientRequestId = NWNX_HTTP_Client_SendRequest(stInsultGen); + SetLocalObject(GetModule(), "INSULTED_" + IntToString(nClientRequestId), GetEnteringObject()); ``` Then set up an event: @@ -225,7 +226,9 @@ Then set up an event: if (sRequest.sTag == "INSULT_ENTERING_PC") { string sResponse = NWNX_Events_GetEventData("RESPONSE"); - SendMessageToPC(sRequest.oObject, sResponse); + object oInsulted = GetLocalObject(GetModule(), "INSULTED_" + IntToString(nClientRequestId)); + SendMessageToPC(oInsulted, sResponse); + DeleteLocalObject(GetModule(), "INSULTED_" + IntToString(nClientRequestId)); } } -``` \ No newline at end of file +``` From d3a20e51fbed7fbda224a73e16e3e371856ff508 Mon Sep 17 00:00:00 2001 From: plenarius Date: Fri, 8 Apr 2022 00:24:06 -0400 Subject: [PATCH 06/19] HTTP: Bring in line with upstream changes --- Plugins/HTTP/HTTP.cpp | 18 +++--- Plugins/HTTP/HTTP.hpp | 2 +- Plugins/HTTP/HTTP/Client.cpp | 104 ++++++++++++++++------------------- Plugins/HTTP/HTTP/Client.hpp | 11 ++-- Plugins/HTTP/HTTP/RPC.cpp | 30 ++++------ Plugins/HTTP/HTTP/RPC.hpp | 4 +- Plugins/HTTP/HTTP/Server.cpp | 52 ++++++++---------- Plugins/HTTP/HTTP/Server.hpp | 9 ++- 8 files changed, 98 insertions(+), 132 deletions(-) diff --git a/Plugins/HTTP/HTTP.cpp b/Plugins/HTTP/HTTP.cpp index 794e3bdd30a..d40a3fc27dc 100644 --- a/Plugins/HTTP/HTTP.cpp +++ b/Plugins/HTTP/HTTP.cpp @@ -2,9 +2,10 @@ #include "HTTP/Client.hpp" #include "HTTP/RPC.hpp" #include "HTTP/Server.hpp" -#include "Services/Config/Config.hpp" using namespace NWNXLib; +using namespace NWNXLib::API; +using namespace NWNXLib::Services; static HTTP::HTTP* g_plugin; @@ -19,19 +20,14 @@ namespace HTTP { HTTP::HTTP(Services::ProxyServiceList* services) : Plugin(services) { - auto tasks = GetServices()->m_tasks.get(); - auto messaging = GetServices()->m_messaging.get(); - auto events = GetServices()->m_events.get(); - auto config = GetServices()->m_config.get(); - - m_Client = std::make_unique(config, events, messaging, tasks); - bool bRPC = config->Get("RPC", false); - if (config->Get("SERVER", false) || bRPC) + m_Client = std::make_unique(); + bool bRPC = Config::Get("RPC", false); + if (Config::Get("SERVER", false) || bRPC) { - m_Server = std::make_unique(config, events, messaging, tasks); + m_Server = std::make_unique(); if (bRPC) { - m_RPC = std::make_unique(config, messaging, tasks); + m_RPC = std::make_unique(); } } } diff --git a/Plugins/HTTP/HTTP.hpp b/Plugins/HTTP/HTTP.hpp index b070e8b4f29..3e5bf5a65d3 100644 --- a/Plugins/HTTP/HTTP.hpp +++ b/Plugins/HTTP/HTTP.hpp @@ -1,6 +1,6 @@ #pragma once -#include "Plugin.hpp" +#include "nwnx.hpp" #include "External/httplib.h" namespace HTTP { diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp index 7bb86bc04ae..4d3513af4cd 100644 --- a/Plugins/HTTP/HTTP/Client.cpp +++ b/Plugins/HTTP/HTTP/Client.cpp @@ -1,9 +1,5 @@ #include "HTTP/Client.hpp" -#include "Services/Config/Config.hpp" -#include "Services/Messaging/Messaging.hpp" -#include "Services/Tasks/Tasks.hpp" - namespace Core { extern bool g_CoreShuttingDown; } @@ -13,16 +9,11 @@ using namespace NWNXLib; namespace HTTP { -TasksProxy* Client::m_servTasks; -MessagingProxy* Client::m_servMessaging; - -Client::Client(ConfigProxy* config, EventsProxy* events, MessagingProxy* messaging, TasksProxy* tasks) +Client::Client() { - events->RegisterEvent("Client_SendRequest", &SendRequest); - events->RegisterEvent("Client_GetRequest", &GetRequest); - m_servTasks = tasks; - m_servMessaging = messaging; - m_clientTimeout = config->Get("CLIENT_REQUEST_TIMEOUT", 2000); + Events::RegisterEvent(PLUGIN_NAME, "Client_SendRequest", &SendRequest); + Events::RegisterEvent(PLUGIN_NAME, "Client_GetRequest", &GetRequest); + m_clientTimeout = Config::Get("CLIENT_REQUEST_TIMEOUT", 2000); } std::unique_ptr Client::GetResult(const Client::Request& client_req) @@ -86,7 +77,7 @@ void Client::PerformRequest(const Client::Request& client_req) LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.",client_req.data.c_str(), client_req.host.c_str(), client_req.path.c_str(), res.status); return; } - m_servTasks->QueueOnAsyncThread([cli, client_req]() + Tasks::QueueOnAsyncThread([cli, client_req]() { cli->second->set_connection_timeout(0, m_clientTimeout * 1000); auto result = GetResult(client_req); @@ -94,27 +85,26 @@ void Client::PerformRequest(const Client::Request& client_req) if (result == nullptr || result->error()) { auto clientError = result != nullptr ? result->error() : httplib::Error::Unknown; - m_servTasks->QueueOnMainThread([client_req, clientError]() + Tasks::QueueOnMainThread([client_req, clientError]() { - auto moduleOid = NWNXLib::Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", "Failed to make a client request with server. Is the url/port correct?"}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", "Failed to make a client request with server. Is the url/port correct?"}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", "0"}); LOG_ERROR("HTTP Client Request to '%s%s' failed, [Error: %d].", client_req.host, client_req.path, clientError); }); return; } auto response = result->value(); - m_servTasks->QueueOnMainThread([client_req, response]() + Tasks::QueueOnMainThread([client_req, response]() { if (Core::g_CoreShuttingDown) return; - auto moduleOid = Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf); + auto moduleOid = "0"; - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"STATUS", std::to_string(response.status)}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", response.body}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"STATUS", std::to_string(response.status)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", response.body}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); if (response.status == 200 || response.status == 201 || response.status == 204 || response.status == 429) { // Discord sends your rate limit information even on success so you can stagger calls if you want @@ -122,36 +112,36 @@ void Client::PerformRequest(const Client::Request& client_req) // in milliseconds and Slack sends it as seconds. if (response.has_header("X-RateLimit-Limit")) { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_LIMIT", response.get_header_value("X-RateLimit-Limit")}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_REMAINING", response.get_header_value("X-RateLimit-Remaining")}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_RESET", response.get_header_value("X-RateLimit-Reset")}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_LIMIT", response.get_header_value("X-RateLimit-Limit")}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_REMAINING", response.get_header_value("X-RateLimit-Remaining")}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_RESET", response.get_header_value("X-RateLimit-Reset")}); if (response.has_header("Retry-After")) - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-After")}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-After")}); else if (response.has_header("Retry-At")) { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-At")}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-At")}); } } // Slack rate limited else if (response.has_header("Retry-After")) { float fSlackRetry = stof(response.get_header_value("Retry-After")) * 1000.0f; - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", std::to_string(fSlackRetry)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", std::to_string(fSlackRetry)}); } if (response.status != 429) { - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_SUCCESS", moduleOid}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_SUCCESS", moduleOid}); LOG_INFO("HTTP Client Request to '%s%s' succeeded.", client_req.host, client_req.path); } else { - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); LOG_WARNING("HTTP Client Request to '%s%s' failed, rate limited.", client_req.host, client_req.path); } } else { - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.host, client_req.path, response.status); } }); @@ -185,44 +175,44 @@ Events::ArgumentStack Client::SendRequest(Events::ArgumentStack&& args) { auto clientReq = Request(); clientReq.id = m_clientRequestId++; - clientReq.tag = Services::Events::ExtractArgument(args); - clientReq.requestMethod = static_cast(Services::Events::ExtractArgument(args)); - clientReq.host = Services::Events::ExtractArgument(args); - clientReq.path = Services::Events::ExtractArgument(args); - clientReq.contentType = static_cast(Services::Events::ExtractArgument(args)); - clientReq.data = Services::Events::ExtractArgument(args); - clientReq.authType = static_cast(Services::Events::ExtractArgument(args)); - clientReq.authUserToken = Services::Events::ExtractArgument(args); - clientReq.authPassword = Services::Events::ExtractArgument(args); - clientReq.port = Services::Events::ExtractArgument(args); + clientReq.tag = Events::ExtractArgument(args); + clientReq.requestMethod = static_cast(Events::ExtractArgument(args)); + clientReq.host = Events::ExtractArgument(args); + clientReq.path = Events::ExtractArgument(args); + clientReq.contentType = static_cast(Events::ExtractArgument(args)); + clientReq.data = Events::ExtractArgument(args); + clientReq.authType = static_cast(Events::ExtractArgument(args)); + clientReq.authUserToken = Events::ExtractArgument(args); + clientReq.authPassword = Events::ExtractArgument(args); + clientReq.port = Events::ExtractArgument(args); if (!clientReq.port) clientReq.port = 443; - clientReq.headersString = Services::Events::ExtractArgument(args); + clientReq.headersString = Events::ExtractArgument(args); clientReq.headers = ParseHeaderString(clientReq.headersString); m_clientRequests[clientReq.id] = clientReq; PerformRequest(clientReq); - return Services::Events::Arguments(clientReq.id); + return Events::Arguments(clientReq.id); } Events::ArgumentStack Client::GetRequest(Events::ArgumentStack&& args) { Events::ArgumentStack stack; - auto requestId = Services::Events::ExtractArgument(args); + auto requestId = Events::ExtractArgument(args); auto req = m_clientRequests.find(requestId); ASSERT_OR_THROW(req != std::end(m_clientRequests)); auto clientReq = req->second; - Services::Events::InsertArgument(stack, clientReq.headersString); - Services::Events::InsertArgument(stack, (int32_t)clientReq.port); - Services::Events::InsertArgument(stack, clientReq.authPassword); - Services::Events::InsertArgument(stack, clientReq.authUserToken); - Services::Events::InsertArgument(stack, (int32_t)clientReq.authType); - Services::Events::InsertArgument(stack, clientReq.data); - Services::Events::InsertArgument(stack, (int32_t)clientReq.contentType); - Services::Events::InsertArgument(stack, clientReq.path); - Services::Events::InsertArgument(stack, clientReq.host); - Services::Events::InsertArgument(stack, (int32_t)clientReq.requestMethod); - Services::Events::InsertArgument(stack, clientReq.tag); + Events::InsertArgument(stack, clientReq.headersString); + Events::InsertArgument(stack, (int32_t)clientReq.port); + Events::InsertArgument(stack, clientReq.authPassword); + Events::InsertArgument(stack, clientReq.authUserToken); + Events::InsertArgument(stack, (int32_t)clientReq.authType); + Events::InsertArgument(stack, clientReq.data); + Events::InsertArgument(stack, (int32_t)clientReq.contentType); + Events::InsertArgument(stack, clientReq.path); + Events::InsertArgument(stack, clientReq.host); + Events::InsertArgument(stack, (int32_t)clientReq.requestMethod); + Events::InsertArgument(stack, clientReq.tag); return stack; } diff --git a/Plugins/HTTP/HTTP/Client.hpp b/Plugins/HTTP/HTTP/Client.hpp index f452807e33d..a45d35f3d8e 100644 --- a/Plugins/HTTP/HTTP/Client.hpp +++ b/Plugins/HTTP/HTTP/Client.hpp @@ -1,7 +1,8 @@ #pragma once #include "HTTP.hpp" -#include "Services/Events/Events.hpp" + +using ArgumentStack = NWNXLib::Events::ArgumentStack; namespace HTTP { @@ -36,13 +37,11 @@ class Client } }; public: - explicit Client(ConfigProxy*, EventsProxy*, MessagingProxy*, TasksProxy*); + explicit Client(); private: - static TasksProxy* m_servTasks; - static MessagingProxy* m_servMessaging; - static Events::ArgumentStack GetRequest(Events::ArgumentStack&&); - static Events::ArgumentStack SendRequest(Events::ArgumentStack&&); + static ArgumentStack GetRequest(ArgumentStack&&); + static ArgumentStack SendRequest(ArgumentStack&&); static void PerformRequest(const Client::Request&); static std::unique_ptr GetResult(const Client::Request&); diff --git a/Plugins/HTTP/HTTP/RPC.cpp b/Plugins/HTTP/HTTP/RPC.cpp index c693725fb87..df59f2f8236 100644 --- a/Plugins/HTTP/HTTP/RPC.cpp +++ b/Plugins/HTTP/HTTP/RPC.cpp @@ -1,21 +1,15 @@ +#include #include "HTTP/RPC.hpp" -#include "Services/Config/Config.hpp" -#include "Services/Messaging/Messaging.hpp" -#include "Services/Tasks/Tasks.hpp" - using namespace NWNXLib; namespace HTTP { -TasksProxy* RPC::m_servTasks; -MessagingProxy* RPC::m_servMessaging; - -RPC::RPC(ConfigProxy* config, MessagingProxy* messaging, TasksProxy* tasks) +RPC::RPC() { - m_authToken = config->Get("RPC_AUTH_TOKEN", ""); - m_rpcURL = config->Get("RPC_URL", "/rpc"); + m_authToken = Config::Get("RPC_AUTH_TOKEN", ""); + m_rpcURL = Config::Get("RPC_URL", "/rpc"); if (m_rpcURL.rfind('/', 0) == std::string::npos) m_rpcURL = "/" + m_rpcURL; if (m_authToken.empty() && m_rpcURL == "/rpc") @@ -24,8 +18,6 @@ RPC::RPC(ConfigProxy* config, MessagingProxy* messaging, TasksProxy* tasks) "set an authorization token (NWNX_HTTP_RPC_AUTH_TOKEN) or set a unique URL (NWNX_HTTP_RPC_URL) for your rpc path. The server will not be started."); return; } - m_servTasks = tasks; - m_servMessaging = messaging; StartRPCServer(); } @@ -84,25 +76,25 @@ void RPC::StartRPCServer() for (const auto & param : req.params) params[param.first] = param.second; } - m_servTasks->QueueOnMainThread([requestId,json_data,paramCount,params]() + Tasks::QueueOnMainThread([requestId,json_data,paramCount,params]() { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestId)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestId)}); if (!json_data.empty()) - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"JSON_DATA", json_data}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"JSON_DATA", json_data}); else { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"PARAM_COUNT", std::to_string(paramCount)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"PARAM_COUNT", std::to_string(paramCount)}); int i = 0; for (const auto & param : params) { std::string sParamKey = "PARAM_KEY_" + std::to_string(i); std::string sParamValue = "PARAM_VALUE_" + std::to_string(i); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {sParamKey, param.first}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {sParamValue, param.second}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {sParamKey, param.first}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {sParamValue, param.second}); i++; } } - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_POST", Utils::ObjectIDToString(((CGameObject*)Utils::GetModule())->m_idSelf)}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_POST", "0"}); }); // Our event was sent to nwscript on the main thread, wait for a response here or timeout after m_responseTimeout seconds diff --git a/Plugins/HTTP/HTTP/RPC.hpp b/Plugins/HTTP/HTTP/RPC.hpp index 8e9a9fdf559..49bcfbf1252 100644 --- a/Plugins/HTTP/HTTP/RPC.hpp +++ b/Plugins/HTTP/HTTP/RPC.hpp @@ -10,10 +10,8 @@ using namespace NWNXLib::Services; class RPC { public: - explicit RPC(ConfigProxy*, MessagingProxy*, TasksProxy*); + explicit RPC(); private: - static TasksProxy* m_servTasks; - static MessagingProxy* m_servMessaging; static httplib::Server* WaitForWebServer(const std::atomic_bool&); void StartRPCServer(); diff --git a/Plugins/HTTP/HTTP/Server.cpp b/Plugins/HTTP/HTTP/Server.cpp index 8517352aac5..50c54c01cd6 100644 --- a/Plugins/HTTP/HTTP/Server.cpp +++ b/Plugins/HTTP/HTTP/Server.cpp @@ -1,37 +1,29 @@ +#include #include "HTTP/Server.hpp" -#include "Services/Config/Config.hpp" -#include "Services/Messaging/Messaging.hpp" -#include "Services/Tasks/Tasks.hpp" - using namespace NWNXLib; namespace HTTP { -TasksProxy* Server::m_servTasks; -MessagingProxy* Server::m_servMessaging; - std::unique_ptr Server::m_httpServer; std::unique_ptr Server::m_httpServerThread; std::chrono::milliseconds Server::m_responseTimeout; -Server::Server(ConfigProxy* config, EventsProxy* events, MessagingProxy* messaging, TasksProxy* tasks) +Server::Server() { - events->RegisterEvent("Server_SendResponse", &SendResponse); - - m_servTasks = tasks; - m_servMessaging = messaging; - m_responseTimeout = std::chrono::milliseconds(config->Get("SERVER_RESPONSE_TIMEOUT", 1000)); - auto rootHTML = config->Get("SERVER_ROOT_HTML", "Welcome to nwnx http!

Welcome to nwnx http!

"); - auto rootStatus = config->Get("SERVER_ROOT_STATUS", 403); - auto httpPort = config->Get("SERVER_PORT", 8686); - auto useSSL = config->Get("SERVER_USE_SSL", false); - auto eventURL = config->Get("SERVER_EVENT_URL"); + Events::RegisterEvent(PLUGIN_NAME, "Server_SendResponse", &SendResponse); + + m_responseTimeout = std::chrono::milliseconds(Config::Get("SERVER_RESPONSE_TIMEOUT", 1000)); + auto rootHTML = Config::Get("SERVER_ROOT_HTML", "Welcome to nwnx http!

Welcome to nwnx http!

"); + auto rootStatus = Config::Get("SERVER_ROOT_STATUS", 403); + auto httpPort = Config::Get("SERVER_PORT", 8686); + auto useSSL = Config::Get("SERVER_USE_SSL", false); + auto eventURL = Config::Get("SERVER_EVENT_URL"); if (useSSL) { - auto certFile = config->Get("SERVER_SSL_CERT_FILE", "./cert.pem"); - auto certKey = config->Get("SERVER_SSL_KEY_FILE", "./key.pem"); + auto certFile = Config::Get("SERVER_SSL_CERT_FILE", "./cert.pem"); + auto certKey = Config::Get("SERVER_SSL_KEY_FILE", "./key.pem"); m_httpServer = std::make_unique(certFile.c_str(), certKey.c_str()); if (!m_httpServer->is_valid()) { @@ -88,11 +80,11 @@ Server::Server(ConfigProxy* config, EventsProxy* events, MessagingProxy* messagi m_cachedResponses.erase(path); } } - m_servTasks->QueueOnMainThread([requestThreadId,path]() + Tasks::QueueOnMainThread([requestThreadId,path]() { - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestThreadId)}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_PUSH_EVENT_DATA", {"PATH", path}); - m_servMessaging->BroadcastMessage("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_GET", Utils::ObjectIDToString(0)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestThreadId)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"PATH", path}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_GET", Utils::ObjectIDToString(0)}); }); std::atomic_bool cancellation_token = false; auto future = std::async(std::launch::async, Server::WaitForResponse, requestThreadId, std::ref(cancellation_token)); @@ -169,16 +161,16 @@ Events::ArgumentStack Server::SendResponse(Events::ArgumentStack&& args) if (!m_httpServerThread || !m_httpServer->is_running()) { LOG_ERROR("Can't send HTTP server response, no server is running!"); - return Services::Events::Arguments(); + return Events::Arguments(); } - auto requestId = Services::Events::ExtractArgument(args); - auto response = Services::Events::ExtractArgument(args); - auto contentType = Services::Events::ExtractArgument(args); - auto cacheSeconds = Services::Events::ExtractArgument(args); + auto requestId = Events::ExtractArgument(args); + auto response = Events::ExtractArgument(args); + auto contentType = Events::ExtractArgument(args); + auto cacheSeconds = Events::ExtractArgument(args); auto cacheUntil = std::chrono::system_clock::now() + std::chrono::seconds(cacheSeconds); m_responses[requestId] = Server::Response(response, static_cast(contentType), cacheUntil); - return Services::Events::Arguments(); + return Events::Arguments(); } } diff --git a/Plugins/HTTP/HTTP/Server.hpp b/Plugins/HTTP/HTTP/Server.hpp index f7d3690a58b..9c391ae19bb 100644 --- a/Plugins/HTTP/HTTP/Server.hpp +++ b/Plugins/HTTP/HTTP/Server.hpp @@ -1,7 +1,8 @@ #pragma once #include "HTTP.hpp" -#include "Services/Events/Events.hpp" + +using ArgumentStack = NWNXLib::Events::ArgumentStack; namespace HTTP { @@ -29,7 +30,7 @@ class Server } }; public: - explicit Server(ConfigProxy*, EventsProxy*, MessagingProxy*, TasksProxy*); + explicit Server(); virtual ~Server(); static Response WaitForResponse(uint32_t, const std::atomic_bool&); static void DeleteResponse(uint32_t); @@ -39,10 +40,8 @@ class Server static std::chrono::milliseconds m_responseTimeout; private: - static TasksProxy* m_servTasks; - static MessagingProxy* m_servMessaging; - static Events::ArgumentStack SendResponse(Events::ArgumentStack&&); + static ArgumentStack SendResponse(ArgumentStack&&); static inline std::unordered_map m_responses; static inline std::unordered_map m_cachedResponses; From 663e39bcfde0b227cf987e6d67a8a7f277028c49 Mon Sep 17 00:00:00 2001 From: plenarius Date: Fri, 8 Apr 2022 02:31:31 -0400 Subject: [PATCH 07/19] Updates to README and remove JSON helper lib since it's native now in NWN --- Plugins/HTTP/NWScript/nwnx_http_json.nss | 322 ----------------------- Plugins/HTTP/README.md | 102 ++++--- 2 files changed, 49 insertions(+), 375 deletions(-) delete mode 100644 Plugins/HTTP/NWScript/nwnx_http_json.nss diff --git a/Plugins/HTTP/NWScript/nwnx_http_json.nss b/Plugins/HTTP/NWScript/nwnx_http_json.nss deleted file mode 100644 index 9ba7e7294bd..00000000000 --- a/Plugins/HTTP/NWScript/nwnx_http_json.nss +++ /dev/null @@ -1,322 +0,0 @@ -/// @addtogroup http -/// @{ -/// @file nwnx_http_json.nss -/// @brief Helper script for constructing json data for NWNX_HTTP_Client_SendRequest() - -/// @brief Create a new JSON object. -/// @param isArray TRUE is the object is an array. -/// @return A unique identifier for this object. -int NWNX_HTTP_JSON_NewObject(int isArray = FALSE); - -/// @brief Create a new JSON array. -/// @return A unique identifier for this array. -int NWNX_HTTP_JSON_NewArray(); - -/// @brief Add a JSON object to a JSON object. -/// @param nJSONObjectId The JSON object you're adding to. -/// @param sKey The key name for this object. -/// @param nJSONSubObjectID The JSON object being added. -void NWNX_HTTP_JSON_ObjectAddObject(int nJSONObjectId, string sKey, int nJSONSubObjectID); - -/// @brief Add a JSON array to a JSON object. -/// @param nJSONObjectId The JSON object you're adding to. -/// @param sKey The key name for this array. -/// @param nJSONArrayID The JSON array being added. -void NWNX_HTTP_JSON_ObjectAddArray(int nJSONObjectId, string sKey, int nJSONArrayID); - -/// @brief Add a string to a JSON object. -/// @param nJSONObjectId The JSON object you're adding to. -/// @param sKey The key name for this string. -/// @param sValue The string value being added. -void NWNX_HTTP_JSON_ObjectAddString(int nJSONObjectId, string sKey, string sValue); - -/// @brief Add an integer to a JSON object. -/// @param nJSONObjectId The JSON object you're adding to. -/// @param sKey The key name for this integer. -/// @param nInt The integer value being added. -void NWNX_HTTP_JSON_ObjectAddInt(int nJSONObjectId, string sKey, int nInt); - -/// @brief Add a float to a JSON object. -/// @param nJSONObjectId The JSON object you're adding to. -/// @param sKey The key name for this float. -/// @param fFloat The float value being added. -void NWNX_HTTP_JSON_ObjectAddFloat(int nJSONObjectId, string sKey, float fFloat); - -/// @brief Add a boolean to a JSON object. -/// @param nJSONObjectId The JSON object you're adding to. -/// @param sKey The key name for this boolean. -/// @param bBool The boolean value being added. -void NWNX_HTTP_JSON_ObjectAddBool(int nJSONObjectId, string sKey, int bBool); - -/// @brief Add a NULL value to a JSON object. -/// @param nJSONObjectId The JSON object you're adding to. -/// @param sKey The key name for this NULL value. -void NWNX_HTTP_JSON_ObjectAddNULL(int nJSONObjectId, string sKey); - -/// @brief Internal command to get amount of elements in a JSON array -/// @param nJSONArrayID The JSON array being counted. -/// @return The number of elements. -int NWNX_HTTP_JSON_GetArrayElementCount(int nJSONArrayID); - -/// @brief Internal command to update the element counter fpr a JSON array -/// @param nJSONArrayID The JSON array being updated -void NWNX_HTTP_JSON_UpdateArrayElementCount(int nJSONArrayID); - -/// @brief Add a JSON object to the front of a JSON array. -/// @param nJSONArrayID The JSON array the element is being inserted. -/// @param nJSONObjectId The JSON object being inserted. -void NWNX_HTTP_JSON_ArrayInsertObject(int nJSONArrayID, int nJSONObjectId); - -/// @brief Add an array to the front of a JSON array. -/// @param nJSONArrayID The JSON array the element is being inserted. -/// @param nJSONSubArrayID The JSON array being inserted. -void NWNX_HTTP_JSON_ArrayInsertArray(int nJSONArrayID, int nJSONSubArrayID); - -/// @brief Add a string to the front of a JSON array. -/// @param nJSONArrayID The JSON array the element is being inserted. -/// @param sElement The string value being inserted. -void NWNX_HTTP_JSON_ArrayInsertString(int nJSONArrayID, string sElement); - -/// @brief Add an integer to the front of a JSON array. -/// @param nJSONArrayID The JSON array the element is being inserted. -/// @param nElement The integer value being inserted. -void NWNX_HTTP_JSON_ArrayInsertInt(int nJSONArrayID, int nElement); - -/// @brief Add a float to the front of a JSON array. -/// @param nJSONArrayID The JSON array the element is being inserted. -/// @param fElement The float value being inserted. -void NWNX_HTTP_JSON_ArrayInsertFloat(int nJSONArrayID, float fElement); - -/// @brief Add a boolean to the front of a JSON array. -/// @param nJSONArrayID The JSON array the element is being inserted. -/// @param bBool The boolean value being added. -void NWNX_HTTP_JSON_ArrayInsertBool(int nJSONArrayID, int bBool); - -/// @brief Add a NULL value to the front of a JSON array. -/// @param nJSONArrayID The JSON array the element is being inserted. -void NWNX_HTTP_JSON_ArrayInsertNULL(int nJSONArrayID); - -/// @brief Returns a json string representation of a JSON object. -/// @param nJSONObjectID The JSON object to dump as a string. -/// @return A string representation of the json object. -string NWNX_HTTP_JSON_GetJSONString(int nJSONObjectID); - -/// @} -int NWNX_HTTP_JSON_NewObject(int isArray = FALSE) -{ - object oModule = GetModule(); - - if (!GetLocalInt(oModule, "NWNX_JSON_TABLE_INIT")) - { - string table = "CREATE TABLE IF NOT EXISTS json_build ( json_object_id INTEGER PRIMARY KEY, json_text TEXT )"; - sqlquery sqlQuery = SqlPrepareQueryObject(oModule, table); - SqlStep(sqlQuery); - - table = "CREATE TABLE IF NOT EXISTS json_array_element_counter ( json_array_id INTEGER PRIMARY KEY, count INTEGER DEFAULT 1)"; - sqlQuery = SqlPrepareQueryObject(oModule, table); - SqlStep(sqlQuery); - SetLocalInt(oModule, "NWNX_JSON_TABLE_INIT", 1); - } - - string insert = "INSERT INTO json_build VALUES (NULL, @object_type)"; - sqlquery sqlQuery = SqlPrepareQueryObject(oModule, insert); - SqlBindString(sqlQuery, "@object_type", isArray ? "[]" : "{}"); - SqlStep(sqlQuery); - - string stmt = "SELECT LAST_INSERT_ROWID()"; - sqlQuery = SqlPrepareQueryObject(oModule, stmt); - SqlStep(sqlQuery); - - return SqlGetInt(sqlQuery, 0); -} - -int NWNX_HTTP_JSON_NewArray() -{ - return NWNX_HTTP_JSON_NewObject(TRUE); -} - -void NWNX_HTTP_JSON_ObjectAddObject(int nJSONObjectId, string sKey, int nJSONSubObjectID) -{ - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, (SELECT json(json_text) "+ - "FROM json_build WHERE json_object_id = @json_subobject_id)) WHERE json_object_id = @json_object_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$."+sKey); - SqlBindInt(sqlQuery, "@json_subobject_id", nJSONSubObjectID); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); - SqlStep(sqlQuery); -} - -void NWNX_HTTP_JSON_ObjectAddArray(int nJSONObjectId, string sKey, int nJSONArrayID) -{ - NWNX_HTTP_JSON_ObjectAddObject(nJSONObjectId, sKey, nJSONArrayID); -} - -void NWNX_HTTP_JSON_ObjectAddString(int nJSONObjectId, string sKey, string sValue) -{ - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @string_value) WHERE json_object_id = @json_object_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$." + sKey); - SqlBindString(sqlQuery, "@string_value", sValue); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); - SqlStep(sqlQuery); -} - -void NWNX_HTTP_JSON_ObjectAddInt(int nJSONObjectId, string sKey, int nInt) -{ - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @int_value) WHERE json_object_id = @json_object_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$." + sKey); - SqlBindInt(sqlQuery, "@int_value", nInt); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); - SqlStep(sqlQuery); -} - -void NWNX_HTTP_JSON_ObjectAddFloat(int nJSONObjectId, string sKey, float fFloat) -{ - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @float_value) WHERE json_object_id = @json_object_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$." + sKey); - SqlBindFloat(sqlQuery, "@float_value", fFloat); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); - SqlStep(sqlQuery); -} - -void NWNX_HTTP_JSON_ObjectAddBool(int nJSONObjectId, string sKey, int bBool) -{ - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(@bool_value)) WHERE json_object_id = @json_object_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$." + sKey); - SqlBindString(sqlQuery, "@bool_value", bBool ? "true" : "false"); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); - SqlStep(sqlQuery); -} - -void NWNX_HTTP_JSON_ObjectAddNULL(int nJSONObjectId, string sKey) -{ - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(NULL)) WHERE json_object_id = @json_object_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$." + sKey); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); - SqlStep(sqlQuery); -} - -int NWNX_HTTP_JSON_GetArrayElementCount(int nJSONArrayID) -{ - int array_element_count = 0; - string stmt = "SELECT count FROM json_array_element_counter WHERE json_array_id = @json_array_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - if (SqlStep(sqlQuery)) - array_element_count = SqlGetInt(sqlQuery, 0); - return array_element_count; -} - -void NWNX_HTTP_JSON_UpdateArrayElementCount(int nJSONArrayID) -{ - string stmt = "INSERT INTO json_array_element_counter(json_array_id) VALUES (@json_array_id) ON CONFLICT(json_array_id) DO UPDATE SET count = count + 1"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - SqlStep(sqlQuery); -} - -void NWNX_HTTP_JSON_ArrayInsertObject(int nJSONArrayID, int nJSONObjectId) -{ - int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); - - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, (SELECT json(json_text) "+ - "FROM json_build WHERE json_object_id = @json_object_id)) WHERE json_object_id = @json_array_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectId); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - SqlStep(sqlQuery); - - NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); -} - -void NWNX_HTTP_JSON_ArrayInsertArray(int nJSONArrayID, int nJSONSubArrayID) -{ - NWNX_HTTP_JSON_ArrayInsertObject(nJSONArrayID, nJSONSubArrayID); -} - -void NWNX_HTTP_JSON_ArrayInsertString(int nJSONArrayID, string sElement) -{ - int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); - - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @string_value) WHERE json_object_id = @json_array_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); - SqlBindString(sqlQuery, "@string_value", sElement); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - SqlStep(sqlQuery); - - NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); -} - -void NWNX_HTTP_JSON_ArrayInsertInt(int nJSONArrayID, int nElement) -{ - int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); - - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @int_value) WHERE json_object_id = @json_array_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); - SqlBindInt(sqlQuery, "@int_value", nElement); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - SqlStep(sqlQuery); - - NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); -} - -void NWNX_HTTP_JSON_ArrayInsertFloat(int nJSONArrayID, float fElement) -{ - int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); - - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, @float_value) WHERE json_object_id = @json_array_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); - SqlBindFloat(sqlQuery, "@float_value", fElement); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - SqlStep(sqlQuery); - - NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); -} - -void NWNX_HTTP_JSON_ArrayInsertBool(int nJSONArrayID, int bBool) -{ - int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); - - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(@bool_value)) WHERE json_object_id = @json_array_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); - SqlBindString(sqlQuery, "@bool_value", bBool ? "true" : "false"); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - SqlStep(sqlQuery); - - NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); -} - -void NWNX_HTTP_JSON_ArrayInsertNULL(int nJSONArrayID) -{ - int array_element_count = NWNX_HTTP_JSON_GetArrayElementCount(nJSONArrayID); - - string stmt = "UPDATE json_build SET json_text = json_insert(json_text, @key, json(NULL)) WHERE json_object_id = @json_array_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindString(sqlQuery, "@key", "$["+IntToString(array_element_count)+"]"); - SqlBindInt(sqlQuery, "@json_array_id", nJSONArrayID); - SqlStep(sqlQuery); - - NWNX_HTTP_JSON_UpdateArrayElementCount(nJSONArrayID); -} - -string NWNX_HTTP_JSON_GetJSONString(int nJSONObjectID) -{ - string stmt = "SELECT json(json_text) FROM json_build WHERE json_object_id = @json_object_id"; - sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt); - SqlBindInt(sqlQuery, "@json_object_id", nJSONObjectID); - string sJSON = "{}"; - if ( SqlStep(sqlQuery) ) - { - sJSON = SqlGetString(sqlQuery, 0); - } - return sJSON; -} diff --git a/Plugins/HTTP/README.md b/Plugins/HTTP/README.md index 8beeaa280c7..47031333f87 100644 --- a/Plugins/HTTP/README.md +++ b/Plugins/HTTP/README.md @@ -88,9 +88,7 @@ Here's an example of an RPC event handler. 1. In your `on_module_load.nss` script subscribe to the `NWNX_ON_HTTP_SERVER_POST` event, for example: `NWNX_Events_SubscribeEvent("NWNX_ON_HTTP_SERVER_POST", "event_http_post");` 2. In your `event_http_post.nss` script you would have something like below. Please note that extracting data - from json is not the intention of this tutorial and the example below is quite sophisticated. - You may wish to use the PARAM_COUNT and looping through PARAM_KEY/VALUE pairs instead but this example is given as a reference - point for understanding how to use sqlite to get json data. + from json is not the intention of this tutorial. You may wish to use the PARAM_COUNT and looping through PARAM_KEY/VALUE pairs instead. ```c #include "nwnx_events" @@ -102,43 +100,38 @@ void main() if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTP_SERVER_POST") { int nRequestId = StringToInt(NWNX_Events_GetEventData("REQUEST_ID")); - string sJSONData = NWNX_Events_GetEventData("JSON_DATA"); - object oModule = GetModule(); - - // Find the json for the functions - string stmt = "SELECT json_extract(@json_data, @key)"; - sqlquery sqlQuery = SqlPrepareQueryObject(oModule, stmt); - SqlBindString(sqlQuery, "@json_data", sJSON_Data); - SqlBindString(sqlQuery, "@key", "$.function"); - string sFunction = ""; - if ( SqlStep(sqlQuery) ) - sFunction = SqlGetString(sqlQuery, 0); - - // Find all functions - stmt = "SELECT key, value FROM json_tree(@json_data) WHERE parent = (SELECT id FROM json_tree(@json_data) WHERE key = 'function')"; - sqlQuery = SqlPrepareQueryObject(oModule, stmt); - SqlBindString(sqlQuery, "@json_data", sJSON_Data); + json jJSONData = JsonParse(NWNX_Events_GetEventData("JSON_DATA")); + json jFunctionsObject = JsonObjectGet(jJSONData, "functions"); + json jFuncArray = JsonObjectKeys(jFunctionsObject); + int i = 0; + json jFunc = JsonArrayGet(jFuncArray, i); string sResponse = ""; - while (SqlStep(sqlQuery)) + while (JsonGetType(jFunc) != JSON_TYPE_NULL) { - string sFunction = SqlGetString(sqlQuery, 0); - string sData = SqlGetString(sqlQuery, 1); - if (sFunction == "SendMessageToPC") + if (JsonGetString(jFunc) == "SendMessageToPC") { - // Find the key value pairs for this function - string subStmt = "SELECT * FROM json_tree(@sub_data) WHERE atom IS NOT NULL"; - sqlquery subSqlQuery = SqlPrepareQueryObject(oModule, subStmt); - SqlBindString(subSqlQuery, "@sub_data", sData); - while (SqlStep(subSqlQuery)) + json jSMTPC = JsonObjectGet(jFunctionsObject, "SendMessageToPC"); + if (JsonGetType(jSMTPC) != JSON_TYPE_NULL) { - string sName = SqlGetString(subSqlQuery, 0); - object oPC = GetPCWithCommunityName(sName); - string sMessage = SqlGetString(subSqlQuery, 1); - SendMessageToPC(oPC, sMessage); - sResponse = sResponse + " " + GetName(oPC); + json jPlayers = JsonObjectGet(jSMTPC, "players"); + int n = 0; + json jPlayer = JsonArrayGet(jPlayers, n); + while (JsonGetType(jPlayer) != JSON_TYPE_NULL) + { + string sPCName = JsonGetString(JsonArrayGet(JsonObjectKeys(jPlayer), 0)); + string sMessage = JsonGetString(JsonObjectGet(jPlayer, sPCName)); + object oPC = GetPCWithCommunityName(sPCName); + if (oPC != OBJECT_INVALID) + { + SendMessageToPC(oPC, sMessage); + sResponse = sResponse + " " + sPCName; + } + jPlayer = JsonArrayGet(jPlayers, ++n); + } } } - } + jFunc = JsonArrayGet(jFuncArray, ++i); + } NWNX_HTTP_Server_SendResponse(nRequestId, "Message sent to player(s): " + sResponse); } ``` @@ -146,11 +139,9 @@ void main() ```shell curl -i http://localhost:8686/b547bd34f896325c4f8f28ec34f895105c38b427fdaf2 -H 'Content-Type: application/json' --data-binary @- << EOF { - "function": { + "functions": { "SendMessageToPC": { - "players": [ - { "orth": "Log off." } - ] + "players": [{ "orth": "Log off." }, { "Daz": "HI" }] } } } @@ -172,36 +163,41 @@ request can then be queried via `NWNX_HTTP_Client_GetRequest()`. The `STATUS` ev server HTTP status return code, (usually 200 on success) and the `RESPONSE` is the body of text the server returned. -Additionally the event data includes Rate Limit information that some servers provide. These are `RATELIMIT_LIMIT` which is how +Additionally, the event data includes Rate Limit information that some servers provide. These are `RATELIMIT_LIMIT` which is how many requests you can send in a given time period, `RATELIMIT_REMAINING` is how many requests you have left in that time period and `RATELIMIT_RESET` is an epoch timestamp when the request limit is reset again. There is also `RETRY_AFTER` which some servers provide which is how long in seconds before you can send another request. -### JSON Helper -The plugin includes a helper library to construct JSON objects for client requests, `nwnx_http_json.nss`. - ### Example Client Requests Here is an example of posting an issue to a github repository. ```c - int githubJSON = NWNX_HTTP_JSON_NewObject(); - NWNX_HTTP_JSON_ObjectAddString(githubJSON, "title", "Testing HTTP Client"); - NWNX_HTTP_JSON_ObjectAddString(githubJSON, "body", "Text message. You can use Markdown here. *Italic* **bold** __underline__ ~~strikeout~~ [hyperlink](https://google.com) `code`"); - NWNX_HTTP_JSON_ObjectAddString(githubJSON, "assignee", NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME")); - int labelsArray = NWNX_HTTP_JSON_NewArray(); - NWNX_HTTP_JSON_ArrayInsertString(labelsArray, "bug"); - NWNX_HTTP_JSON_ArrayInsertString(labelsArray, "help wanted"); - NWNX_HTTP_JSON_ObjectAddArray(githubJSON, "labels", labelsArray); - string sJSON = NWNX_HTTP_JSON_GetJSONString(githubJSON); - + string sMessage = "This would be the content of your player's bug report captured via chat or such."; + object oReporter = GetFirstPC(); // The bug reporter's PC object would be here + string sAuthorName = GetName(oReporter, TRUE) + " ("+ GetPCPlayerName(oReporter)+")"; + object oArea = GetArea(oReporter); + string sTileModel = NWNX_Area_GetTileModelResRef(oArea, GetPosition(oReporter).x, GetPosition(oReporter).y); + json githubJSON = JsonObject(); + githubJSON = JsonObjectSet(githubJSON, "title", JsonString(GetModuleName() + " NWN Bug Report via "+sAuthorName)); + githubJSON = JsonObjectSet(githubJSON, "body", JsonString(sMessage+"
Area Name: **"+ GetName(oArea) + + "**
Area Tag: **"+ GetTag(oArea) + + "**
Location: **" + NWNXLocationToString(GetLocation(oReporter)) + + "**
Tile Model: **" + sTileModel + "**")); + githubJSON = JsonObjectSet(githubJSON, "assignee", JsonString(NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"))); + json jLabels = JsonArray(); + jLabels = JsonArrayInsert(jLabels, JsonString("bug")); + jLabels = JsonArrayInsert(jLabels, JsonString("help wanted")); + githubJSON = JsonObjectSet(githubJSON, "labels", jLabels); + struct NWNX_HTTP_Client_Request stGithubPost; stGithubPost.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_POST; stGithubPost.sHost = "api.github.com"; stGithubPost.sPath = NWNX_Util_GetEnvironmentVariable("GITHUB_REPO_PATH") + "/issues"; - stGithubPost.sData = sJSON; + stGithubPost.sData = JsonDump(githubJSON); stGithubPost.nAuthType = NWNX_HTTP_AUTH_TYPE_BASIC; stGithubPost.sAuthUserOrToken = NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"); stGithubPost.sAuthPassword = NWNX_Util_GetEnvironmentVariable("GITHUB_NWN_PAT"); stGithubPost.sHeaders = "Accept: application/vnd.github.v3+json"; + stGithubPost.nContentType = NWNX_HTTP_CONTENT_TYPE_JSON; NWNX_HTTP_Client_SendRequest(stGithubPost); ``` From 1d242635e1d7f9efd8f72f1c335a41a8bafeb5b7 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 02:13:41 -0400 Subject: [PATCH 08/19] Simplify to just a Client Plugin --- CHANGELOG.md | 2 +- Plugins/HTTP/CMakeLists.txt | 2 +- Plugins/HTTP/External/httplib.h | 6953 +++++++++++++++++++-------- Plugins/HTTP/HTTP.cpp | 11 - Plugins/HTTP/HTTP.hpp | 4 - Plugins/HTTP/HTTP/Client.cpp | 60 +- Plugins/HTTP/HTTP/Client.hpp | 2 +- Plugins/HTTP/HTTP/RPC.cpp | 120 - Plugins/HTTP/HTTP/RPC.hpp | 23 - Plugins/HTTP/HTTP/Server.cpp | 176 - Plugins/HTTP/HTTP/Server.hpp | 51 - Plugins/HTTP/NWScript/nwnx_http.nss | 18 - Plugins/HTTP/README.md | 191 +- 13 files changed, 4952 insertions(+), 2661 deletions(-) delete mode 100644 Plugins/HTTP/HTTP/RPC.cpp delete mode 100644 Plugins/HTTP/HTTP/RPC.hpp delete mode 100644 Plugins/HTTP/HTTP/Server.cpp delete mode 100644 Plugins/HTTP/HTTP/Server.hpp diff --git a/CHANGELOG.md b/CHANGELOG.md index ce9889f7f6c..7c9389d3c46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -254,7 +254,7 @@ https://github.com/nwnxee/unified/compare/build8193.20...build8193.21 - Optimizations: Added `PlayerLookup` optimization that speeds up some player related functions on highly populated servers. ##### New Plugins -- HTTP: Server and client functionality. +- HTTP: Client functionality. - SWIG: Native Interop support added for DotNET. ##### New NWScript Functions diff --git a/Plugins/HTTP/CMakeLists.txt b/Plugins/HTTP/CMakeLists.txt index 0a56611ea10..6b423b4c854 100644 --- a/Plugins/HTTP/CMakeLists.txt +++ b/Plugins/HTTP/CMakeLists.txt @@ -1,7 +1,7 @@ find_package(OpenSSL) if (${OPENSSL_FOUND}) - add_plugin(HTTP HTTP.cpp HTTP/Client.cpp HTTP/Server.cpp HTTP/RPC.cpp) + add_plugin(HTTP HTTP.cpp HTTP/Client.cpp) add_definitions(-DCPPHTTPLIB_OPENSSL_SUPPORT) target_link_libraries(HTTP ${OPENSSL_LIBRARIES}) target_include_directories(HTTP PUBLIC ${OPENSSL_INCLUDE_DIR}) diff --git a/Plugins/HTTP/External/httplib.h b/Plugins/HTTP/External/httplib.h index 39af3b8070f..117e498fafd 100644 --- a/Plugins/HTTP/External/httplib.h +++ b/Plugins/HTTP/External/httplib.h @@ -1,13 +1,15 @@ // // httplib.h // -// Copyright (c) 2020 Yuji Hirose. All rights reserved. +// Copyright (c) 2024 Yuji Hirose. All rights reserved. // MIT License // #ifndef CPPHTTPLIB_HTTPLIB_H #define CPPHTTPLIB_HTTPLIB_H +#define CPPHTTPLIB_VERSION "0.16.2" + /* * Configuration */ @@ -60,20 +62,36 @@ #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192 #endif +#ifndef CPPHTTPLIB_HEADER_MAX_LENGTH +#define CPPHTTPLIB_HEADER_MAX_LENGTH 8192 +#endif + #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20 #endif +#ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT +#define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024 +#endif + #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH ((std::numeric_limits::max)()) #endif +#ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH +#define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192 +#endif + +#ifndef CPPHTTPLIB_RANGE_MAX_COUNT +#define CPPHTTPLIB_RANGE_MAX_COUNT 1024 +#endif + #ifndef CPPHTTPLIB_TCP_NODELAY #define CPPHTTPLIB_TCP_NODELAY false #endif #ifndef CPPHTTPLIB_RECV_BUFSIZ -#define CPPHTTPLIB_RECV_BUFSIZ size_t(4096u) +#define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u) #endif #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ @@ -95,6 +113,10 @@ #define CPPHTTPLIB_SEND_FLAGS 0 #endif +#ifndef CPPHTTPLIB_LISTEN_BACKLOG +#define CPPHTTPLIB_LISTEN_BACKLOG 5 +#endif + /* * Headers */ @@ -109,23 +131,25 @@ #endif //_CRT_NONSTDC_NO_DEPRECATE #if defined(_MSC_VER) +#if _MSC_VER < 1900 +#error Sorry, Visual Studio versions prior to 2015 are not supported +#endif + +#pragma comment(lib, "ws2_32.lib") + #ifdef _WIN64 using ssize_t = __int64; #else -using ssize_t = int; -#endif - -#if _MSC_VER < 1900 -#define snprintf _snprintf_s +using ssize_t = long; #endif #endif // _MSC_VER #ifndef S_ISREG -#define S_ISREG(m) (((m)&S_IFREG) == S_IFREG) +#define S_ISREG(m) (((m) & S_IFREG) == S_IFREG) #endif // S_ISREG #ifndef S_ISDIR -#define S_ISDIR(m) (((m)&S_IFDIR) == S_IFDIR) +#define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR) #endif // S_ISDIR #ifndef NOMINMAX @@ -134,24 +158,12 @@ using ssize_t = int; #include #include - -#include #include #ifndef WSA_FLAG_NO_HANDLE_INHERIT #define WSA_FLAG_NO_HANDLE_INHERIT 0x80 #endif -#ifdef _MSC_VER -#pragma comment(lib, "ws2_32.lib") -#pragma comment(lib, "crypt32.lib") -#pragma comment(lib, "cryptui.lib") -#endif - -#ifndef strcasecmp -#define strcasecmp _stricmp -#endif // strcasecmp - using socket_t = SOCKET; #ifdef CPPHTTPLIB_USE_POLL #define poll(fds, nfds, timeout) WSAPoll(fds, nfds, timeout) @@ -160,8 +172,16 @@ using socket_t = SOCKET; #else // not _WIN32 #include -#include +#if !defined(_AIX) && !defined(__MVS__) #include +#endif +#ifdef __MVS__ +#include +#ifndef NI_MAXHOST +#define NI_MAXHOST 1025 +#endif +#endif +#include #include #include #ifdef __linux__ @@ -173,12 +193,16 @@ using socket_t = SOCKET; #endif #include #include +#include #include #include +#include #include using socket_t = int; +#ifndef INVALID_SOCKET #define INVALID_SOCKET (-1) +#endif #endif //_WIN32 #include @@ -188,7 +212,9 @@ using socket_t = int; #include #include #include +#include #include +#include #include #include #include @@ -200,14 +226,39 @@ using socket_t = int; #include #include #include +#include #include #include #include #include +#include +#include +#include #ifdef CPPHTTPLIB_OPENSSL_SUPPORT +#ifdef _WIN32 +#include + +// these are defined in wincrypt.h and it breaks compilation if BoringSSL is +// used +#undef X509_NAME +#undef X509_CERT_PAIR +#undef X509_EXTENSIONS +#undef PKCS7_SIGNER_INFO + +#ifdef _MSC_VER +#pragma comment(lib, "crypt32.lib") +#endif +#elif defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && defined(__APPLE__) +#include +#if TARGET_OS_OSX +#include +#include +#endif // TARGET_OS_OSX +#endif // _WIN32 + #include -#include +#include #include #include @@ -218,16 +269,15 @@ using socket_t = int; #include #include -#if OPENSSL_VERSION_NUMBER < 0x1010100fL -#error Sorry, OpenSSL versions prior to 1.1.1 are not supported +#if defined(OPENSSL_IS_BORINGSSL) +#if OPENSSL_VERSION_NUMBER < 0x1010107f +#error Please use OpenSSL or a current version of BoringSSL #endif - -#if OPENSSL_VERSION_NUMBER < 0x10100000L -#include -inline const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *asn1) { - return M_ASN1_STRING_data(asn1); -} +#define SSL_get1_peer_certificate SSL_get_peer_certificate +#elif OPENSSL_VERSION_NUMBER < 0x30000000L +#error Sorry, OpenSSL versions prior to 3.0.0 are not supported #endif + #endif #ifdef CPPHTTPLIB_ZLIB_SUPPORT @@ -256,7 +306,7 @@ namespace detail { template typename std::enable_if::value, std::unique_ptr>::type -make_unique(Args &&... args) { +make_unique(Args &&...args) { return std::unique_ptr(new T(std::forward(args)...)); } @@ -277,8 +327,111 @@ struct ci { } }; +// This is based on +// "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189". + +struct scope_exit { + explicit scope_exit(std::function &&f) + : exit_function(std::move(f)), execute_on_destruction{true} {} + + scope_exit(scope_exit &&rhs) noexcept + : exit_function(std::move(rhs.exit_function)), + execute_on_destruction{rhs.execute_on_destruction} { + rhs.release(); + } + + ~scope_exit() { + if (execute_on_destruction) { this->exit_function(); } + } + + void release() { this->execute_on_destruction = false; } + +private: + scope_exit(const scope_exit &) = delete; + void operator=(const scope_exit &) = delete; + scope_exit &operator=(scope_exit &&) = delete; + + std::function exit_function; + bool execute_on_destruction; +}; + } // namespace detail +enum StatusCode { + // Information responses + Continue_100 = 100, + SwitchingProtocol_101 = 101, + Processing_102 = 102, + EarlyHints_103 = 103, + + // Successful responses + OK_200 = 200, + Created_201 = 201, + Accepted_202 = 202, + NonAuthoritativeInformation_203 = 203, + NoContent_204 = 204, + ResetContent_205 = 205, + PartialContent_206 = 206, + MultiStatus_207 = 207, + AlreadyReported_208 = 208, + IMUsed_226 = 226, + + // Redirection messages + MultipleChoices_300 = 300, + MovedPermanently_301 = 301, + Found_302 = 302, + SeeOther_303 = 303, + NotModified_304 = 304, + UseProxy_305 = 305, + unused_306 = 306, + TemporaryRedirect_307 = 307, + PermanentRedirect_308 = 308, + + // Client error responses + BadRequest_400 = 400, + Unauthorized_401 = 401, + PaymentRequired_402 = 402, + Forbidden_403 = 403, + NotFound_404 = 404, + MethodNotAllowed_405 = 405, + NotAcceptable_406 = 406, + ProxyAuthenticationRequired_407 = 407, + RequestTimeout_408 = 408, + Conflict_409 = 409, + Gone_410 = 410, + LengthRequired_411 = 411, + PreconditionFailed_412 = 412, + PayloadTooLarge_413 = 413, + UriTooLong_414 = 414, + UnsupportedMediaType_415 = 415, + RangeNotSatisfiable_416 = 416, + ExpectationFailed_417 = 417, + ImATeapot_418 = 418, + MisdirectedRequest_421 = 421, + UnprocessableContent_422 = 422, + Locked_423 = 423, + FailedDependency_424 = 424, + TooEarly_425 = 425, + UpgradeRequired_426 = 426, + PreconditionRequired_428 = 428, + TooManyRequests_429 = 429, + RequestHeaderFieldsTooLarge_431 = 431, + UnavailableForLegalReasons_451 = 451, + + // Server error responses + InternalServerError_500 = 500, + NotImplemented_501 = 501, + BadGateway_502 = 502, + ServiceUnavailable_503 = 503, + GatewayTimeout_504 = 504, + HttpVersionNotSupported_505 = 505, + VariantAlsoNegotiates_506 = 506, + InsufficientStorage_507 = 507, + LoopDetected_508 = 508, + NotExtended_510 = 510, + NetworkAuthenticationRequired_511 = 511, +}; + using Headers = std::multimap; using Params = std::multimap; @@ -307,18 +460,19 @@ class DataSink { DataSink(DataSink &&) = delete; DataSink &operator=(DataSink &&) = delete; - std::function write; - std::function done; + std::function write; std::function is_writable; + std::function done; + std::function done_with_trailer; std::ostream os; private: - class data_sink_streambuf : public std::streambuf { + class data_sink_streambuf final : public std::streambuf { public: explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {} protected: - std::streamsize xsputn(const char *s, std::streamsize n) { + std::streamsize xsputn(const char *s, std::streamsize n) override { sink_.write(s, static_cast(n)); return n; } @@ -336,6 +490,16 @@ using ContentProvider = using ContentProviderWithoutLength = std::function; +using ContentProviderResourceReleaser = std::function; + +struct MultipartFormDataProvider { + std::string name; + ContentProviderWithoutLength provider; + std::string filename; + std::string content_type; +}; +using MultipartFormDataProviderItems = std::vector; + using ContentReceiverWithProgress = std::function; @@ -380,6 +544,8 @@ struct Request { std::string remote_addr; int remote_port = -1; + std::string local_addr; + int local_port = -1; // for server std::string version; @@ -388,37 +554,37 @@ struct Request { MultipartFormDataMap files; Ranges ranges; Match matches; + std::unordered_map path_params; // for client + ResponseHandler response_handler; + ContentReceiverWithProgress content_receiver; + Progress progress; #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - const SSL *ssl; + const SSL *ssl = nullptr; #endif - bool has_header(const char *key) const; - std::string get_header_value(const char *key, size_t id = 0) const; - template - T get_header_value(const char *key, size_t id = 0) const; - size_t get_header_value_count(const char *key) const; - void set_header(const char *key, const char *val); - void set_header(const char *key, const std::string &val); + bool has_header(const std::string &key) const; + std::string get_header_value(const std::string &key, size_t id = 0) const; + uint64_t get_header_value_u64(const std::string &key, size_t id = 0) const; + size_t get_header_value_count(const std::string &key) const; + void set_header(const std::string &key, const std::string &val); - bool has_param(const char *key) const; - std::string get_param_value(const char *key, size_t id = 0) const; - size_t get_param_value_count(const char *key) const; + bool has_param(const std::string &key) const; + std::string get_param_value(const std::string &key, size_t id = 0) const; + size_t get_param_value_count(const std::string &key) const; bool is_multipart_form_data() const; - bool has_file(const char *key) const; - MultipartFormData get_file_value(const char *key) const; + bool has_file(const std::string &key) const; + MultipartFormData get_file_value(const std::string &key) const; + std::vector get_file_values(const std::string &key) const; // private members... size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT; - ResponseHandler response_handler_; - ContentReceiverWithProgress content_receiver_; size_t content_length_ = 0; ContentProvider content_provider_; bool is_chunked_content_provider_ = false; - Progress progress_; size_t authorization_count_ = 0; }; @@ -430,30 +596,28 @@ struct Response { std::string body; std::string location; // Redirect location - bool has_header(const char *key) const; - std::string get_header_value(const char *key, size_t id = 0) const; - template - T get_header_value(const char *key, size_t id = 0) const; - size_t get_header_value_count(const char *key) const; - void set_header(const char *key, const char *val); - void set_header(const char *key, const std::string &val); + bool has_header(const std::string &key) const; + std::string get_header_value(const std::string &key, size_t id = 0) const; + uint64_t get_header_value_u64(const std::string &key, size_t id = 0) const; + size_t get_header_value_count(const std::string &key) const; + void set_header(const std::string &key, const std::string &val); - void set_redirect(const char *url, int status = 302); - void set_redirect(const std::string &url, int status = 302); - void set_content(const char *s, size_t n, const char *content_type); - void set_content(const std::string &s, const char *content_type); + void set_redirect(const std::string &url, int status = StatusCode::Found_302); + void set_content(const char *s, size_t n, const std::string &content_type); + void set_content(const std::string &s, const std::string &content_type); + void set_content(std::string &&s, const std::string &content_type); void set_content_provider( - size_t length, const char *content_type, ContentProvider provider, - const std::function &resource_releaser = nullptr); + size_t length, const std::string &content_type, ContentProvider provider, + ContentProviderResourceReleaser resource_releaser = nullptr); void set_content_provider( - const char *content_type, ContentProviderWithoutLength provider, - const std::function &resource_releaser = nullptr); + const std::string &content_type, ContentProviderWithoutLength provider, + ContentProviderResourceReleaser resource_releaser = nullptr); void set_chunked_content_provider( - const char *content_type, ContentProviderWithoutLength provider, - const std::function &resource_releaser = nullptr); + const std::string &content_type, ContentProviderWithoutLength provider, + ContentProviderResourceReleaser resource_releaser = nullptr); Response() = default; Response(const Response &) = default; @@ -462,15 +626,16 @@ struct Response { Response &operator=(Response &&) = default; ~Response() { if (content_provider_resource_releaser_) { - content_provider_resource_releaser_(); + content_provider_resource_releaser_(content_provider_success_); } } // private members... size_t content_length_ = 0; ContentProvider content_provider_; - std::function content_provider_resource_releaser_; + ContentProviderResourceReleaser content_provider_resource_releaser_; bool is_chunked_content_provider_ = false; + bool content_provider_success_ = false; }; class Stream { @@ -483,10 +648,11 @@ class Stream { virtual ssize_t read(char *ptr, size_t size) = 0; virtual ssize_t write(const char *ptr, size_t size) = 0; virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0; + virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0; virtual socket_t socket() const = 0; template - ssize_t write_format(const char *fmt, const Args &... args); + ssize_t write_format(const char *fmt, const Args &...args); ssize_t write(const char *ptr); ssize_t write(const std::string &s); }; @@ -496,15 +662,16 @@ class TaskQueue { TaskQueue() = default; virtual ~TaskQueue() = default; - virtual void enqueue(std::function fn) = 0; + virtual bool enqueue(std::function fn) = 0; virtual void shutdown() = 0; - virtual void on_idle(){}; + virtual void on_idle() {} }; -class ThreadPool : public TaskQueue { +class ThreadPool final : public TaskQueue { public: - explicit ThreadPool(size_t n) : shutdown_(false) { + explicit ThreadPool(size_t n, size_t mqr = 0) + : shutdown_(false), max_queued_requests_(mqr) { while (n) { threads_.emplace_back(worker(*this)); n--; @@ -514,10 +681,17 @@ class ThreadPool : public TaskQueue { ThreadPool(const ThreadPool &) = delete; ~ThreadPool() override = default; - void enqueue(std::function fn) override { - std::unique_lock lock(mutex_); - jobs_.push_back(std::move(fn)); + bool enqueue(std::function fn) override { + { + std::unique_lock lock(mutex_); + if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) { + return false; + } + jobs_.push_back(std::move(fn)); + } + cond_.notify_one(); + return true; } void shutdown() override { @@ -557,6 +731,10 @@ class ThreadPool : public TaskQueue { assert(true == static_cast(fn)); fn(); } + +#if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) + OPENSSL_thread_stop(); +#endif } ThreadPool &pool_; @@ -567,6 +745,7 @@ class ThreadPool : public TaskQueue { std::list> jobs_; bool shutdown_; + size_t max_queued_requests_ = 0; std::condition_variable cond_; std::mutex mutex_; @@ -576,29 +755,101 @@ using Logger = std::function; using SocketOptions = std::function; -inline void default_socket_options(socket_t sock) { - int yes = 1; -#ifdef _WIN32 - setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast(&yes), - sizeof(yes)); - setsockopt(sock, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, - reinterpret_cast(&yes), sizeof(yes)); -#else -#ifdef SO_REUSEPORT - setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, reinterpret_cast(&yes), - sizeof(yes)); -#else - setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast(&yes), - sizeof(yes)); -#endif -#endif -} +void default_socket_options(socket_t sock); + +const char *status_message(int status); + +std::string get_bearer_token_auth(const Request &req); + +namespace detail { + +class MatcherBase { +public: + virtual ~MatcherBase() = default; + + // Match request path and populate its matches and + virtual bool match(Request &request) const = 0; +}; + +/** + * Captures parameters in request path and stores them in Request::path_params + * + * Capture name is a substring of a pattern from : to /. + * The rest of the pattern is matched agains the request path directly + * Parameters are captured starting from the next character after + * the end of the last matched static pattern fragment until the next /. + * + * Example pattern: + * "/path/fragments/:capture/more/fragments/:second_capture" + * Static fragments: + * "/path/fragments/", "more/fragments/" + * + * Given the following request path: + * "/path/fragments/:1/more/fragments/:2" + * the resulting capture will be + * {{"capture", "1"}, {"second_capture", "2"}} + */ +class PathParamsMatcher final : public MatcherBase { +public: + PathParamsMatcher(const std::string &pattern); + + bool match(Request &request) const override; + +private: + static constexpr char marker = ':'; + // Treat segment separators as the end of path parameter capture + // Does not need to handle query parameters as they are parsed before path + // matching + static constexpr char separator = '/'; + + // Contains static path fragments to match against, excluding the '/' after + // path params + // Fragments are separated by path params + std::vector static_fragments_; + // Stores the names of the path parameters to be used as keys in the + // Request::path_params map + std::vector param_names_; +}; + +/** + * Performs std::regex_match on request path + * and stores the result in Request::matches + * + * Note that regex match is performed directly on the whole request. + * This means that wildcard patterns may match multiple path segments with /: + * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end". + */ +class RegexMatcher final : public MatcherBase { +public: + RegexMatcher(const std::string &pattern) : regex_(pattern) {} + + bool match(Request &request) const override; + +private: + std::regex regex_; +}; + +ssize_t write_headers(Stream &strm, const Headers &headers); + +} // namespace detail class Server { public: using Handler = std::function; + + using ExceptionHandler = + std::function; + + enum class HandlerResponse { + Handled, + Unhandled, + }; + using HandlerWithResponse = + std::function; + using HandlerWithContentReader = std::function; + using Expect100ContinueHandler = std::function; @@ -608,47 +859,74 @@ class Server { virtual bool is_valid() const; - Server &Get(const char *pattern, Handler handler); - Server &Post(const char *pattern, Handler handler); - Server &Post(const char *pattern, HandlerWithContentReader handler); - Server &Put(const char *pattern, Handler handler); - Server &Put(const char *pattern, HandlerWithContentReader handler); - Server &Patch(const char *pattern, Handler handler); - Server &Patch(const char *pattern, HandlerWithContentReader handler); - Server &Delete(const char *pattern, Handler handler); - Server &Delete(const char *pattern, HandlerWithContentReader handler); - Server &Options(const char *pattern, Handler handler); - - bool set_base_dir(const char *dir, const char *mount_point = nullptr); - bool set_mount_point(const char *mount_point, const char *dir, + Server &Get(const std::string &pattern, Handler handler); + Server &Post(const std::string &pattern, Handler handler); + Server &Post(const std::string &pattern, HandlerWithContentReader handler); + Server &Put(const std::string &pattern, Handler handler); + Server &Put(const std::string &pattern, HandlerWithContentReader handler); + Server &Patch(const std::string &pattern, Handler handler); + Server &Patch(const std::string &pattern, HandlerWithContentReader handler); + Server &Delete(const std::string &pattern, Handler handler); + Server &Delete(const std::string &pattern, HandlerWithContentReader handler); + Server &Options(const std::string &pattern, Handler handler); + + bool set_base_dir(const std::string &dir, + const std::string &mount_point = std::string()); + bool set_mount_point(const std::string &mount_point, const std::string &dir, Headers headers = Headers()); - bool remove_mount_point(const char *mount_point); - void set_file_extension_and_mimetype_mapping(const char *ext, - const char *mime); - void set_file_request_handler(Handler handler); + bool remove_mount_point(const std::string &mount_point); + Server &set_file_extension_and_mimetype_mapping(const std::string &ext, + const std::string &mime); + Server &set_default_file_mimetype(const std::string &mime); + Server &set_file_request_handler(Handler handler); - void set_error_handler(Handler handler); - void set_expect_100_continue_handler(Expect100ContinueHandler handler); - void set_logger(Logger logger); + template + Server &set_error_handler(ErrorHandlerFunc &&handler) { + return set_error_handler_core( + std::forward(handler), + std::is_convertible{}); + } - void set_tcp_nodelay(bool on); - void set_socket_options(SocketOptions socket_options); + Server &set_exception_handler(ExceptionHandler handler); + Server &set_pre_routing_handler(HandlerWithResponse handler); + Server &set_post_routing_handler(Handler handler); - void set_keep_alive_max_count(size_t count); - void set_keep_alive_timeout(time_t sec); - void set_read_timeout(time_t sec, time_t usec = 0); - void set_write_timeout(time_t sec, time_t usec = 0); - void set_idle_interval(time_t sec, time_t usec = 0); + Server &set_expect_100_continue_handler(Expect100ContinueHandler handler); + Server &set_logger(Logger logger); + + Server &set_address_family(int family); + Server &set_tcp_nodelay(bool on); + Server &set_socket_options(SocketOptions socket_options); + + Server &set_default_headers(Headers headers); + Server & + set_header_writer(std::function const &writer); + + Server &set_keep_alive_max_count(size_t count); + Server &set_keep_alive_timeout(time_t sec); + + Server &set_read_timeout(time_t sec, time_t usec = 0); + template + Server &set_read_timeout(const std::chrono::duration &duration); - void set_payload_max_length(size_t length); + Server &set_write_timeout(time_t sec, time_t usec = 0); + template + Server &set_write_timeout(const std::chrono::duration &duration); - bool bind_to_port(const char *host, int port, int socket_flags = 0); - int bind_to_any_port(const char *host, int socket_flags = 0); + Server &set_idle_interval(time_t sec, time_t usec = 0); + template + Server &set_idle_interval(const std::chrono::duration &duration); + + Server &set_payload_max_length(size_t length); + + bool bind_to_port(const std::string &host, int port, int socket_flags = 0); + int bind_to_any_port(const std::string &host, int socket_flags = 0); bool listen_after_bind(); - bool listen(const char *host, int port, int socket_flags = 0); + bool listen(const std::string &host, int port, int socket_flags = 0); bool is_running() const; + void wait_until_ready() const; void stop(); std::function new_task_queue; @@ -658,7 +936,7 @@ class Server { bool &connection_closed, const std::function &setup_request); - std::atomic svr_sock_; + std::atomic svr_sock_{INVALID_SOCKET}; size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT; time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND; time_t read_timeout_sec_ = CPPHTTPLIB_READ_TIMEOUT_SECOND; @@ -670,27 +948,37 @@ class Server { size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH; private: - using Handlers = std::vector>; + using Handlers = + std::vector, Handler>>; using HandlersForContentReader = - std::vector>; + std::vector, + HandlerWithContentReader>>; + + static std::unique_ptr + make_matcher(const std::string &pattern); + + Server &set_error_handler_core(HandlerWithResponse handler, std::true_type); + Server &set_error_handler_core(Handler handler, std::false_type); - socket_t create_server_socket(const char *host, int port, int socket_flags, + socket_t create_server_socket(const std::string &host, int port, + int socket_flags, SocketOptions socket_options) const; - int bind_internal(const char *host, int port, int socket_flags); + int bind_internal(const std::string &host, int port, int socket_flags); bool listen_internal(); bool routing(Request &req, Response &res, Stream &strm); - bool handle_file_request(Request &req, Response &res, bool head = false); - bool dispatch_request(Request &req, Response &res, const Handlers &handlers); - bool - dispatch_request_for_content_reader(Request &req, Response &res, - ContentReader content_reader, - const HandlersForContentReader &handlers); - - bool parse_request_line(const char *s, Request &req); + bool handle_file_request(const Request &req, Response &res, + bool head = false); + bool dispatch_request(Request &req, Response &res, + const Handlers &handlers) const; + bool dispatch_request_for_content_reader( + Request &req, Response &res, ContentReader content_reader, + const HandlersForContentReader &handlers) const; + + bool parse_request_line(const char *s, Request &req) const; void apply_ranges(const Request &req, Response &res, - std::string &content_type, std::string &boundary); - bool write_response(Stream &strm, bool close_connection, const Request &req, + std::string &content_type, std::string &boundary) const; + bool write_response(Stream &strm, bool close_connection, Request &req, Response &res); bool write_response_with_content(Stream &strm, bool close_connection, const Request &req, Response &res); @@ -708,21 +996,24 @@ class Server { ContentReceiver multipart_receiver); bool read_content_core(Stream &strm, Request &req, Response &res, ContentReceiver receiver, - MultipartContentHeader mulitpart_header, - ContentReceiver multipart_receiver); + MultipartContentHeader multipart_header, + ContentReceiver multipart_receiver) const; virtual bool process_and_close_socket(socket_t sock); + std::atomic is_running_{false}; + std::atomic done_{false}; + struct MountPointEntry { std::string mount_point; std::string base_dir; Headers headers; }; std::vector base_dirs_; - - std::atomic is_running_; std::map file_extension_and_mimetype_map_; + std::string default_file_mimetype_ = "application/octet-stream"; Handler file_request_handler_; + Handlers get_handlers_; Handlers post_handlers_; HandlersForContentReader post_handlers_for_content_reader_; @@ -733,15 +1024,25 @@ class Server { Handlers delete_handlers_; HandlersForContentReader delete_handlers_for_content_reader_; Handlers options_handlers_; - Handler error_handler_; - Logger logger_; + + HandlerWithResponse error_handler_; + ExceptionHandler exception_handler_; + HandlerWithResponse pre_routing_handler_; + Handler post_routing_handler_; Expect100ContinueHandler expect_100_continue_handler_; + Logger logger_; + + int address_family_ = AF_UNSPEC; bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY; SocketOptions socket_options_ = default_socket_options; + + Headers default_headers_; + std::function header_writer_ = + detail::write_headers; }; -enum Error { +enum class Error { Success = 0, Unknown, Connection, @@ -755,12 +1056,25 @@ enum Error { SSLServerVerification, UnsupportedMultipartBoundaryChars, Compression, + ConnectionTimeout, + ProxyConnection, + + // For internal use only + SSLPeerCouldBeClosed_, }; +std::string to_string(Error error); + +std::ostream &operator<<(std::ostream &os, const Error &obj); + class Result { public: - Result(std::unique_ptr res, Error err) - : res_(std::move(res)), err_(err) {} + Result() = default; + Result(std::unique_ptr &&res, Error err, + Headers &&request_headers = Headers{}) + : res_(std::move(res)), err_(err), + request_headers_(std::move(request_headers)) {} + // Response operator bool() const { return res_ != nullptr; } bool operator==(std::nullptr_t) const { return res_ == nullptr; } bool operator!=(std::nullptr_t) const { return res_ != nullptr; } @@ -770,11 +1084,22 @@ class Result { Response &operator*() { return *res_; } const Response *operator->() const { return res_.get(); } Response *operator->() { return res_.get(); } + + // Error Error error() const { return err_; } + // Request Headers + bool has_request_header(const std::string &key) const; + std::string get_request_header_value(const std::string &key, + size_t id = 0) const; + uint64_t get_request_header_value_u64(const std::string &key, + size_t id = 0) const; + size_t get_request_header_value_count(const std::string &key) const; + private: std::unique_ptr res_; - Error err_; + Error err_ = Error::Unknown; + Headers request_headers_; }; class ClientImpl { @@ -791,130 +1116,253 @@ class ClientImpl { virtual bool is_valid() const; - Result Get(const char *path); - Result Get(const char *path, const Headers &headers); - Result Get(const char *path, Progress progress); - Result Get(const char *path, const Headers &headers, Progress progress); - Result Get(const char *path, ContentReceiver content_receiver); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path); + Result Get(const std::string &path, const Headers &headers); + Result Get(const std::string &path, Progress progress); + Result Get(const std::string &path, const Headers &headers, + Progress progress); + Result Get(const std::string &path, ContentReceiver content_receiver); + Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver); - Result Get(const char *path, ContentReceiver content_receiver, + Result Get(const std::string &path, ContentReceiver content_receiver, Progress progress); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, Progress progress); - Result Get(const char *path, ResponseHandler response_handler, + Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver); - Result Get(const char *path, ResponseHandler response_handler, + Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress); - Result Head(const char *path); - Result Head(const char *path, const Headers &headers); - - Result Post(const char *path); - Result Post(const char *path, const std::string &body, - const char *content_type); - Result Post(const char *path, const Headers &headers, const std::string &body, - const char *content_type); - Result Post(const char *path, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Post(const char *path, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Post(const char *path, const Headers &headers, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Post(const char *path, const Headers &headers, + Result Get(const std::string &path, const Params ¶ms, + const Headers &headers, Progress progress = nullptr); + Result Get(const std::string &path, const Params ¶ms, + const Headers &headers, ContentReceiver content_receiver, + Progress progress = nullptr); + Result Get(const std::string &path, const Params ¶ms, + const Headers &headers, ResponseHandler response_handler, + ContentReceiver content_receiver, Progress progress = nullptr); + + Result Head(const std::string &path); + Result Head(const std::string &path, const Headers &headers); + + Result Post(const std::string &path); + Result Post(const std::string &path, const Headers &headers); + Result Post(const std::string &path, const char *body, size_t content_length, + const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type, + Progress progress); + Result Post(const std::string &path, const std::string &body, + const std::string &content_type); + Result Post(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Post(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + Result Post(const std::string &path, size_t content_length, + ContentProvider content_provider, + const std::string &content_type); + Result Post(const std::string &path, + ContentProviderWithoutLength content_provider, + const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, + size_t content_length, ContentProvider content_provider, + const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Post(const char *path, const Params ¶ms); - Result Post(const char *path, const Headers &headers, const Params ¶ms); - Result Post(const char *path, const MultipartFormDataItems &items); - Result Post(const char *path, const Headers &headers, + const std::string &content_type); + Result Post(const std::string &path, const Params ¶ms); + Result Post(const std::string &path, const Headers &headers, + const Params ¶ms); + Result Post(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress); + Result Post(const std::string &path, const MultipartFormDataItems &items); + Result Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items); - Result Post(const char *path, const Headers &headers, + Result Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const std::string &boundary); - - Result Put(const char *path); - Result Put(const char *path, const std::string &body, - const char *content_type); - Result Put(const char *path, const Headers &headers, const std::string &body, - const char *content_type); - Result Put(const char *path, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Put(const char *path, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Put(const char *path, const Headers &headers, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Put(const char *path, const Headers &headers, + Result Post(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items); + + Result Put(const std::string &path); + Result Put(const std::string &path, const char *body, size_t content_length, + const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type, + Progress progress); + Result Put(const std::string &path, const std::string &body, + const std::string &content_type); + Result Put(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Put(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + Result Put(const std::string &path, size_t content_length, + ContentProvider content_provider, const std::string &content_type); + Result Put(const std::string &path, + ContentProviderWithoutLength content_provider, + const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, + size_t content_length, ContentProvider content_provider, + const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Put(const char *path, const Params ¶ms); - Result Put(const char *path, const Headers &headers, const Params ¶ms); - - Result Patch(const char *path, const std::string &body, - const char *content_type); - Result Patch(const char *path, const Headers &headers, - const std::string &body, const char *content_type); - Result Patch(const char *path, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Patch(const char *path, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Patch(const char *path, const Headers &headers, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Patch(const char *path, const Headers &headers, + const std::string &content_type); + Result Put(const std::string &path, const Params ¶ms); + Result Put(const std::string &path, const Headers &headers, + const Params ¶ms); + Result Put(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress); + Result Put(const std::string &path, const MultipartFormDataItems &items); + Result Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items); + Result Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, const std::string &boundary); + Result Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items); + + Result Patch(const std::string &path); + Result Patch(const std::string &path, const char *body, size_t content_length, + const std::string &content_type); + Result Patch(const std::string &path, const char *body, size_t content_length, + const std::string &content_type, Progress progress); + Result Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, Progress progress); + Result Patch(const std::string &path, const std::string &body, + const std::string &content_type); + Result Patch(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Patch(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + Result Patch(const std::string &path, size_t content_length, + ContentProvider content_provider, + const std::string &content_type); + Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type); - - Result Delete(const char *path); - Result Delete(const char *path, const std::string &body, - const char *content_type); - Result Delete(const char *path, const Headers &headers); - Result Delete(const char *path, const Headers &headers, - const std::string &body, const char *content_type); + const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + size_t content_length, ContentProvider content_provider, + const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const std::string &content_type); + + Result Delete(const std::string &path); + Result Delete(const std::string &path, const Headers &headers); + Result Delete(const std::string &path, const char *body, + size_t content_length, const std::string &content_type); + Result Delete(const std::string &path, const char *body, + size_t content_length, const std::string &content_type, + Progress progress); + Result Delete(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type); + Result Delete(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, Progress progress); + Result Delete(const std::string &path, const std::string &body, + const std::string &content_type); + Result Delete(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Delete(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Delete(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + + Result Options(const std::string &path); + Result Options(const std::string &path, const Headers &headers); + + bool send(Request &req, Response &res, Error &error); + Result send(const Request &req); - Result Options(const char *path); - Result Options(const char *path, const Headers &headers); + void stop(); - bool send(const Request &req, Response &res, Error &error); - Result send(const Request &req); + std::string host() const; + int port() const; size_t is_socket_open() const; + socket_t socket() const; - void stop(); + void set_hostname_addr_map(std::map addr_map); void set_default_headers(Headers headers); + void + set_header_writer(std::function const &writer); + + void set_address_family(int family); void set_tcp_nodelay(bool on); void set_socket_options(SocketOptions socket_options); void set_connection_timeout(time_t sec, time_t usec = 0); + template + void + set_connection_timeout(const std::chrono::duration &duration); + void set_read_timeout(time_t sec, time_t usec = 0); + template + void set_read_timeout(const std::chrono::duration &duration); + void set_write_timeout(time_t sec, time_t usec = 0); + template + void set_write_timeout(const std::chrono::duration &duration); - void set_basic_auth(const char *username, const char *password); - void set_bearer_token_auth(const char *token); + void set_basic_auth(const std::string &username, const std::string &password); + void set_bearer_token_auth(const std::string &token); #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - void set_digest_auth(const char *username, const char *password); + void set_digest_auth(const std::string &username, + const std::string &password); #endif void set_keep_alive(bool on); void set_follow_location(bool on); + void set_url_encode(bool on); + void set_compress(bool on); void set_decompress(bool on); - void set_interface(const char *intf); + void set_interface(const std::string &intf); - void set_proxy(const char *host, int port); - void set_proxy_basic_auth(const char *username, const char *password); - void set_proxy_bearer_token_auth(const char *token); + void set_proxy(const std::string &host, int port); + void set_proxy_basic_auth(const std::string &username, + const std::string &password); + void set_proxy_bearer_token_auth(const std::string &token); #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - void set_proxy_digest_auth(const char *username, const char *password); + void set_proxy_digest_auth(const std::string &username, + const std::string &password); +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + void set_ca_cert_path(const std::string &ca_cert_file_path, + const std::string &ca_cert_dir_path = std::string()); + void set_ca_cert_store(X509_STORE *ca_cert_store); + X509_STORE *create_ca_cert_store(const char *ca_cert, std::size_t size) const; #endif #ifdef CPPHTTPLIB_OPENSSL_SUPPORT @@ -943,22 +1391,18 @@ class ClientImpl { // Also, shutdown_ssl and close_socket should also NOT be called concurrently // with a DIFFERENT thread sending requests using that socket. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully); - void shutdown_socket(Socket &socket); + void shutdown_socket(Socket &socket) const; void close_socket(Socket &socket); - // Similar to shutdown_ssl and close_socket, this should NOT be called - // concurrently with a DIFFERENT thread sending requests from the socket - void lock_socket_and_shutdown_and_close(); - - bool process_request(Stream &strm, const Request &req, Response &res, + bool process_request(Stream &strm, Request &req, Response &res, bool close_connection, Error &error); bool write_content_with_provider(Stream &strm, const Request &req, - Error &error); + Error &error) const; void copy_settings(const ClientImpl &rhs); - // Socket endoint information + // Socket endpoint information const std::string host_; const int port_; const std::string host_and_port_; @@ -973,9 +1417,16 @@ class ClientImpl { std::thread::id socket_requests_are_from_thread_ = std::thread::id(); bool socket_should_be_closed_when_request_is_done_ = false; + // Hostname-IP map + std::map addr_map_; + // Default headers Headers default_headers_; + // Header writer + std::function header_writer_ = + detail::write_headers; + // Settings std::string client_cert_path_; std::string client_key_path_; @@ -998,6 +1449,9 @@ class ClientImpl { bool keep_alive_ = false; bool follow_location_ = false; + bool url_encode_ = true; + + int address_family_ = AF_UNSPEC; bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY; SocketOptions socket_options_ = nullptr; @@ -1018,31 +1472,46 @@ class ClientImpl { #endif #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - bool server_certificate_verification_ = false; + std::string ca_cert_file_path_; + std::string ca_cert_dir_path_; + + X509_STORE *ca_cert_store_ = nullptr; +#endif + +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + bool server_certificate_verification_ = true; #endif Logger logger_; private: + bool send_(Request &req, Response &res, Error &error); + Result send_(Request &&req); + socket_t create_client_socket(Error &error) const; - bool read_response_line(Stream &strm, const Request &req, Response &res); - bool write_request(Stream &strm, const Request &req, bool close_connection, + bool read_response_line(Stream &strm, const Request &req, + Response &res) const; + bool write_request(Stream &strm, Request &req, bool close_connection, Error &error); - bool redirect(const Request &req, Response &res, Error &error); - bool handle_request(Stream &strm, const Request &req, Response &res, + bool redirect(Request &req, Response &res, Error &error); + bool handle_request(Stream &strm, Request &req, Response &res, bool close_connection, Error &error); std::unique_ptr send_with_content_provider( - const char *method, const char *path, const Headers &headers, - const std::string &body, size_t content_length, + Request &req, const char *body, size_t content_length, ContentProvider content_provider, ContentProviderWithoutLength content_provider_without_length, - const char *content_type, Error &error); + const std::string &content_type, Error &error); Result send_with_content_provider( - const char *method, const char *path, const Headers &headers, - const std::string &body, size_t content_length, + const std::string &method, const std::string &path, + const Headers &headers, const char *body, size_t content_length, ContentProvider content_provider, ContentProviderWithoutLength content_provider_without_length, - const char *content_type); + const std::string &content_type, Progress progress); + ContentProviderWithoutLength get_multipart_content_provider( + const std::string &boundary, const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items) const; + + std::string adjust_host_string(const std::string &host) const; virtual bool process_socket(const Socket &socket, std::function callback); @@ -1052,9 +1521,9 @@ class ClientImpl { class Client { public: // Universal interface - explicit Client(const char *scheme_host_port); + explicit Client(const std::string &scheme_host_port); - explicit Client(const char *scheme_host_port, + explicit Client(const std::string &scheme_host_port, const std::string &client_cert_path, const std::string &client_key_path); @@ -1065,132 +1534,253 @@ class Client { const std::string &client_cert_path, const std::string &client_key_path); + Client(Client &&) = default; + Client &operator=(Client &&) = default; + ~Client(); bool is_valid() const; - Result Get(const char *path); - Result Get(const char *path, const Headers &headers); - Result Get(const char *path, Progress progress); - Result Get(const char *path, const Headers &headers, Progress progress); - Result Get(const char *path, ContentReceiver content_receiver); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path); + Result Get(const std::string &path, const Headers &headers); + Result Get(const std::string &path, Progress progress); + Result Get(const std::string &path, const Headers &headers, + Progress progress); + Result Get(const std::string &path, ContentReceiver content_receiver); + Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver); - Result Get(const char *path, ContentReceiver content_receiver, + Result Get(const std::string &path, ContentReceiver content_receiver, Progress progress); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, Progress progress); - Result Get(const char *path, ResponseHandler response_handler, + Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver); - Result Get(const char *path, const Headers &headers, + Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress); - Result Get(const char *path, ResponseHandler response_handler, + Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress); - Result Head(const char *path); - Result Head(const char *path, const Headers &headers); - - Result Post(const char *path); - Result Post(const char *path, const std::string &body, - const char *content_type); - Result Post(const char *path, const Headers &headers, const std::string &body, - const char *content_type); - Result Post(const char *path, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Post(const char *path, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Post(const char *path, const Headers &headers, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Post(const char *path, const Headers &headers, + Result Get(const std::string &path, const Params ¶ms, + const Headers &headers, Progress progress = nullptr); + Result Get(const std::string &path, const Params ¶ms, + const Headers &headers, ContentReceiver content_receiver, + Progress progress = nullptr); + Result Get(const std::string &path, const Params ¶ms, + const Headers &headers, ResponseHandler response_handler, + ContentReceiver content_receiver, Progress progress = nullptr); + + Result Head(const std::string &path); + Result Head(const std::string &path, const Headers &headers); + + Result Post(const std::string &path); + Result Post(const std::string &path, const Headers &headers); + Result Post(const std::string &path, const char *body, size_t content_length, + const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type, + Progress progress); + Result Post(const std::string &path, const std::string &body, + const std::string &content_type); + Result Post(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Post(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + Result Post(const std::string &path, size_t content_length, + ContentProvider content_provider, + const std::string &content_type); + Result Post(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Post(const char *path, const Params ¶ms); - Result Post(const char *path, const Headers &headers, const Params ¶ms); - Result Post(const char *path, const MultipartFormDataItems &items); - Result Post(const char *path, const Headers &headers, + const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, + size_t content_length, ContentProvider content_provider, + const std::string &content_type); + Result Post(const std::string &path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const std::string &content_type); + Result Post(const std::string &path, const Params ¶ms); + Result Post(const std::string &path, const Headers &headers, + const Params ¶ms); + Result Post(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress); + Result Post(const std::string &path, const MultipartFormDataItems &items); + Result Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items); - Result Post(const char *path, const Headers &headers, + Result Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const std::string &boundary); - Result Put(const char *path); - Result Put(const char *path, const std::string &body, - const char *content_type); - Result Put(const char *path, const Headers &headers, const std::string &body, - const char *content_type); - Result Put(const char *path, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Put(const char *path, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Put(const char *path, const Headers &headers, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Put(const char *path, const Headers &headers, + Result Post(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items); + + Result Put(const std::string &path); + Result Put(const std::string &path, const char *body, size_t content_length, + const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, const char *body, + size_t content_length, const std::string &content_type, + Progress progress); + Result Put(const std::string &path, const std::string &body, + const std::string &content_type); + Result Put(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Put(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + Result Put(const std::string &path, size_t content_length, + ContentProvider content_provider, const std::string &content_type); + Result Put(const std::string &path, + ContentProviderWithoutLength content_provider, + const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, + size_t content_length, ContentProvider content_provider, + const std::string &content_type); + Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Put(const char *path, const Params ¶ms); - Result Put(const char *path, const Headers &headers, const Params ¶ms); - Result Patch(const char *path, const std::string &body, - const char *content_type); - Result Patch(const char *path, const Headers &headers, - const std::string &body, const char *content_type); - Result Patch(const char *path, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Patch(const char *path, ContentProviderWithoutLength content_provider, - const char *content_type); - Result Patch(const char *path, const Headers &headers, size_t content_length, - ContentProvider content_provider, const char *content_type); - Result Patch(const char *path, const Headers &headers, + const std::string &content_type); + Result Put(const std::string &path, const Params ¶ms); + Result Put(const std::string &path, const Headers &headers, + const Params ¶ms); + Result Put(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress); + Result Put(const std::string &path, const MultipartFormDataItems &items); + Result Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items); + Result Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, const std::string &boundary); + Result Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items); + + Result Patch(const std::string &path); + Result Patch(const std::string &path, const char *body, size_t content_length, + const std::string &content_type); + Result Patch(const std::string &path, const char *body, size_t content_length, + const std::string &content_type, Progress progress); + Result Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, Progress progress); + Result Patch(const std::string &path, const std::string &body, + const std::string &content_type); + Result Patch(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Patch(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + Result Patch(const std::string &path, size_t content_length, + ContentProvider content_provider, + const std::string &content_type); + Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type); - - Result Delete(const char *path); - Result Delete(const char *path, const std::string &body, - const char *content_type); - Result Delete(const char *path, const Headers &headers); - Result Delete(const char *path, const Headers &headers, - const std::string &body, const char *content_type); + const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + size_t content_length, ContentProvider content_provider, + const std::string &content_type); + Result Patch(const std::string &path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const std::string &content_type); + + Result Delete(const std::string &path); + Result Delete(const std::string &path, const Headers &headers); + Result Delete(const std::string &path, const char *body, + size_t content_length, const std::string &content_type); + Result Delete(const std::string &path, const char *body, + size_t content_length, const std::string &content_type, + Progress progress); + Result Delete(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type); + Result Delete(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, Progress progress); + Result Delete(const std::string &path, const std::string &body, + const std::string &content_type); + Result Delete(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress); + Result Delete(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type); + Result Delete(const std::string &path, const Headers &headers, + const std::string &body, const std::string &content_type, + Progress progress); + + Result Options(const std::string &path); + Result Options(const std::string &path, const Headers &headers); + + bool send(Request &req, Response &res, Error &error); + Result send(const Request &req); - Result Options(const char *path); - Result Options(const char *path, const Headers &headers); + void stop(); - bool send(const Request &req, Response &res, Error &error); - Result send(const Request &req); + std::string host() const; + int port() const; size_t is_socket_open() const; + socket_t socket() const; - void stop(); + void set_hostname_addr_map(std::map addr_map); void set_default_headers(Headers headers); + void + set_header_writer(std::function const &writer); + + void set_address_family(int family); void set_tcp_nodelay(bool on); void set_socket_options(SocketOptions socket_options); void set_connection_timeout(time_t sec, time_t usec = 0); + template + void + set_connection_timeout(const std::chrono::duration &duration); + void set_read_timeout(time_t sec, time_t usec = 0); + template + void set_read_timeout(const std::chrono::duration &duration); + void set_write_timeout(time_t sec, time_t usec = 0); + template + void set_write_timeout(const std::chrono::duration &duration); - void set_basic_auth(const char *username, const char *password); - void set_bearer_token_auth(const char *token); + void set_basic_auth(const std::string &username, const std::string &password); + void set_bearer_token_auth(const std::string &token); #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - void set_digest_auth(const char *username, const char *password); + void set_digest_auth(const std::string &username, + const std::string &password); #endif void set_keep_alive(bool on); void set_follow_location(bool on); + void set_url_encode(bool on); + void set_compress(bool on); void set_decompress(bool on); - void set_interface(const char *intf); + void set_interface(const std::string &intf); - void set_proxy(const char *host, int port); - void set_proxy_basic_auth(const char *username, const char *password); - void set_proxy_bearer_token_auth(const char *token); + void set_proxy(const std::string &host, int port); + void set_proxy_basic_auth(const std::string &username, + const std::string &password); + void set_proxy_bearer_token_auth(const std::string &token); #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - void set_proxy_digest_auth(const char *username, const char *password); + void set_proxy_digest_auth(const std::string &username, + const std::string &password); #endif #ifdef CPPHTTPLIB_OPENSSL_SUPPORT @@ -1201,10 +1791,11 @@ class Client { // SSL #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - void set_ca_cert_path(const char *ca_cert_file_path, - const char *ca_cert_dir_path = nullptr); + void set_ca_cert_path(const std::string &ca_cert_file_path, + const std::string &ca_cert_dir_path = std::string()); void set_ca_cert_store(X509_STORE *ca_cert_store); + void load_ca_cert_store(const char *ca_cert, std::size_t size); long get_openssl_verify_result() const; @@ -1224,15 +1815,24 @@ class SSLServer : public Server { public: SSLServer(const char *cert_path, const char *private_key_path, const char *client_ca_cert_file_path = nullptr, - const char *client_ca_cert_dir_path = nullptr); + const char *client_ca_cert_dir_path = nullptr, + const char *private_key_password = nullptr); SSLServer(X509 *cert, EVP_PKEY *private_key, X509_STORE *client_ca_cert_store = nullptr); + SSLServer( + const std::function &setup_ssl_ctx_callback); + ~SSLServer() override; bool is_valid() const override; + SSL_CTX *ssl_context() const; + + void update_certs(X509 *cert, EVP_PKEY *private_key, + X509_STORE *client_ca_cert_store = nullptr); + private: bool process_and_close_socket(socket_t sock) override; @@ -1240,7 +1840,7 @@ class SSLServer : public Server { std::mutex ctx_mutex_; }; -class SSLClient : public ClientImpl { +class SSLClient final : public ClientImpl { public: explicit SSLClient(const std::string &host); @@ -1248,19 +1848,19 @@ class SSLClient : public ClientImpl { explicit SSLClient(const std::string &host, int port, const std::string &client_cert_path, - const std::string &client_key_path); + const std::string &client_key_path, + const std::string &private_key_password = std::string()); explicit SSLClient(const std::string &host, int port, X509 *client_cert, - EVP_PKEY *client_key); + EVP_PKEY *client_key, + const std::string &private_key_password = std::string()); ~SSLClient() override; bool is_valid() const override; - void set_ca_cert_path(const char *ca_cert_file_path, - const char *ca_cert_dir_path = nullptr); - void set_ca_cert_store(X509_STORE *ca_cert_store); + void load_ca_cert_store(const char *ca_cert, std::size_t size); long get_openssl_verify_result() const; @@ -1269,6 +1869,7 @@ class SSLClient : public ClientImpl { private: bool create_and_connect_socket(Socket &socket, Error &error) override; void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override; + void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully); bool process_socket(const Socket &socket, std::function callback) override; @@ -1291,73 +1892,569 @@ class SSLClient : public ClientImpl { std::vector host_components_; - std::string ca_cert_file_path_; - std::string ca_cert_dir_path_; long verify_result_ = 0; friend class ClientImpl; }; #endif -// ---------------------------------------------------------------------------- - /* - * Implementation + * Implementation of template methods. */ namespace detail { -inline bool is_hex(char c, int &v) { - if (0x20 <= c && isdigit(c)) { - v = c - '0'; - return true; - } else if ('A' <= c && c <= 'F') { - v = c - 'A' + 10; - return true; - } else if ('a' <= c && c <= 'f') { - v = c - 'a' + 10; - return true; +template +inline void duration_to_sec_and_usec(const T &duration, U callback) { + auto sec = std::chrono::duration_cast(duration).count(); + auto usec = std::chrono::duration_cast( + duration - std::chrono::seconds(sec)) + .count(); + callback(static_cast(sec), static_cast(usec)); +} + +inline uint64_t get_header_value_u64(const Headers &headers, + const std::string &key, size_t id, + uint64_t def) { + auto rng = headers.equal_range(key); + auto it = rng.first; + std::advance(it, static_cast(id)); + if (it != rng.second) { + return std::strtoull(it->second.data(), nullptr, 10); } - return false; + return def; } -inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt, - int &val) { - if (i >= s.size()) { return false; } +} // namespace detail - val = 0; - for (; cnt; i++, cnt--) { - if (!s[i]) { return false; } - int v = 0; - if (is_hex(s[i], v)) { - val = val * 16 + v; - } else { - return false; - } - } - return true; +inline uint64_t Request::get_header_value_u64(const std::string &key, + size_t id) const { + return detail::get_header_value_u64(headers, key, id, 0); } -inline std::string from_i_to_hex(size_t n) { - const char *charset = "0123456789abcdef"; - std::string ret; - do { - ret = charset[n & 15] + ret; - n >>= 4; - } while (n > 0); - return ret; +inline uint64_t Response::get_header_value_u64(const std::string &key, + size_t id) const { + return detail::get_header_value_u64(headers, key, id, 0); } -inline size_t to_utf8(int code, char *buff) { - if (code < 0x0080) { - buff[0] = (code & 0x7F); - return 1; - } else if (code < 0x0800) { - buff[0] = static_cast(0xC0 | ((code >> 6) & 0x1F)); - buff[1] = static_cast(0x80 | (code & 0x3F)); - return 2; - } else if (code < 0xD800) { - buff[0] = static_cast(0xE0 | ((code >> 12) & 0xF)); +template +inline ssize_t Stream::write_format(const char *fmt, const Args &...args) { + const auto bufsiz = 2048; + std::array buf{}; + + auto sn = snprintf(buf.data(), buf.size() - 1, fmt, args...); + if (sn <= 0) { return sn; } + + auto n = static_cast(sn); + + if (n >= buf.size() - 1) { + std::vector glowable_buf(buf.size()); + + while (n >= glowable_buf.size() - 1) { + glowable_buf.resize(glowable_buf.size() * 2); + n = static_cast( + snprintf(&glowable_buf[0], glowable_buf.size() - 1, fmt, args...)); + } + return write(&glowable_buf[0], n); + } else { + return write(buf.data(), n); + } +} + +inline void default_socket_options(socket_t sock) { + int yes = 1; +#ifdef _WIN32 + setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, + reinterpret_cast(&yes), sizeof(yes)); + setsockopt(sock, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, + reinterpret_cast(&yes), sizeof(yes)); +#else +#ifdef SO_REUSEPORT + setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, + reinterpret_cast(&yes), sizeof(yes)); +#else + setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, + reinterpret_cast(&yes), sizeof(yes)); +#endif +#endif +} + +inline const char *status_message(int status) { + switch (status) { + case StatusCode::Continue_100: return "Continue"; + case StatusCode::SwitchingProtocol_101: return "Switching Protocol"; + case StatusCode::Processing_102: return "Processing"; + case StatusCode::EarlyHints_103: return "Early Hints"; + case StatusCode::OK_200: return "OK"; + case StatusCode::Created_201: return "Created"; + case StatusCode::Accepted_202: return "Accepted"; + case StatusCode::NonAuthoritativeInformation_203: + return "Non-Authoritative Information"; + case StatusCode::NoContent_204: return "No Content"; + case StatusCode::ResetContent_205: return "Reset Content"; + case StatusCode::PartialContent_206: return "Partial Content"; + case StatusCode::MultiStatus_207: return "Multi-Status"; + case StatusCode::AlreadyReported_208: return "Already Reported"; + case StatusCode::IMUsed_226: return "IM Used"; + case StatusCode::MultipleChoices_300: return "Multiple Choices"; + case StatusCode::MovedPermanently_301: return "Moved Permanently"; + case StatusCode::Found_302: return "Found"; + case StatusCode::SeeOther_303: return "See Other"; + case StatusCode::NotModified_304: return "Not Modified"; + case StatusCode::UseProxy_305: return "Use Proxy"; + case StatusCode::unused_306: return "unused"; + case StatusCode::TemporaryRedirect_307: return "Temporary Redirect"; + case StatusCode::PermanentRedirect_308: return "Permanent Redirect"; + case StatusCode::BadRequest_400: return "Bad Request"; + case StatusCode::Unauthorized_401: return "Unauthorized"; + case StatusCode::PaymentRequired_402: return "Payment Required"; + case StatusCode::Forbidden_403: return "Forbidden"; + case StatusCode::NotFound_404: return "Not Found"; + case StatusCode::MethodNotAllowed_405: return "Method Not Allowed"; + case StatusCode::NotAcceptable_406: return "Not Acceptable"; + case StatusCode::ProxyAuthenticationRequired_407: + return "Proxy Authentication Required"; + case StatusCode::RequestTimeout_408: return "Request Timeout"; + case StatusCode::Conflict_409: return "Conflict"; + case StatusCode::Gone_410: return "Gone"; + case StatusCode::LengthRequired_411: return "Length Required"; + case StatusCode::PreconditionFailed_412: return "Precondition Failed"; + case StatusCode::PayloadTooLarge_413: return "Payload Too Large"; + case StatusCode::UriTooLong_414: return "URI Too Long"; + case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type"; + case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable"; + case StatusCode::ExpectationFailed_417: return "Expectation Failed"; + case StatusCode::ImATeapot_418: return "I'm a teapot"; + case StatusCode::MisdirectedRequest_421: return "Misdirected Request"; + case StatusCode::UnprocessableContent_422: return "Unprocessable Content"; + case StatusCode::Locked_423: return "Locked"; + case StatusCode::FailedDependency_424: return "Failed Dependency"; + case StatusCode::TooEarly_425: return "Too Early"; + case StatusCode::UpgradeRequired_426: return "Upgrade Required"; + case StatusCode::PreconditionRequired_428: return "Precondition Required"; + case StatusCode::TooManyRequests_429: return "Too Many Requests"; + case StatusCode::RequestHeaderFieldsTooLarge_431: + return "Request Header Fields Too Large"; + case StatusCode::UnavailableForLegalReasons_451: + return "Unavailable For Legal Reasons"; + case StatusCode::NotImplemented_501: return "Not Implemented"; + case StatusCode::BadGateway_502: return "Bad Gateway"; + case StatusCode::ServiceUnavailable_503: return "Service Unavailable"; + case StatusCode::GatewayTimeout_504: return "Gateway Timeout"; + case StatusCode::HttpVersionNotSupported_505: + return "HTTP Version Not Supported"; + case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates"; + case StatusCode::InsufficientStorage_507: return "Insufficient Storage"; + case StatusCode::LoopDetected_508: return "Loop Detected"; + case StatusCode::NotExtended_510: return "Not Extended"; + case StatusCode::NetworkAuthenticationRequired_511: + return "Network Authentication Required"; + + default: + case StatusCode::InternalServerError_500: return "Internal Server Error"; + } +} + +inline std::string get_bearer_token_auth(const Request &req) { + if (req.has_header("Authorization")) { + static std::string BearerHeaderPrefix = "Bearer "; + return req.get_header_value("Authorization") + .substr(BearerHeaderPrefix.length()); + } + return ""; +} + +template +inline Server & +Server::set_read_timeout(const std::chrono::duration &duration) { + detail::duration_to_sec_and_usec( + duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); }); + return *this; +} + +template +inline Server & +Server::set_write_timeout(const std::chrono::duration &duration) { + detail::duration_to_sec_and_usec( + duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); }); + return *this; +} + +template +inline Server & +Server::set_idle_interval(const std::chrono::duration &duration) { + detail::duration_to_sec_and_usec( + duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); }); + return *this; +} + +inline std::string to_string(const Error error) { + switch (error) { + case Error::Success: return "Success (no error)"; + case Error::Connection: return "Could not establish connection"; + case Error::BindIPAddress: return "Failed to bind IP address"; + case Error::Read: return "Failed to read connection"; + case Error::Write: return "Failed to write connection"; + case Error::ExceedRedirectCount: return "Maximum redirect count exceeded"; + case Error::Canceled: return "Connection handling canceled"; + case Error::SSLConnection: return "SSL connection failed"; + case Error::SSLLoadingCerts: return "SSL certificate loading failed"; + case Error::SSLServerVerification: return "SSL server verification failed"; + case Error::UnsupportedMultipartBoundaryChars: + return "Unsupported HTTP multipart boundary characters"; + case Error::Compression: return "Compression failed"; + case Error::ConnectionTimeout: return "Connection timed out"; + case Error::ProxyConnection: return "Proxy connection failed"; + case Error::Unknown: return "Unknown"; + default: break; + } + + return "Invalid"; +} + +inline std::ostream &operator<<(std::ostream &os, const Error &obj) { + os << to_string(obj); + os << " (" << static_cast::type>(obj) << ')'; + return os; +} + +inline uint64_t Result::get_request_header_value_u64(const std::string &key, + size_t id) const { + return detail::get_header_value_u64(request_headers_, key, id, 0); +} + +template +inline void ClientImpl::set_connection_timeout( + const std::chrono::duration &duration) { + detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) { + set_connection_timeout(sec, usec); + }); +} + +template +inline void ClientImpl::set_read_timeout( + const std::chrono::duration &duration) { + detail::duration_to_sec_and_usec( + duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); }); +} + +template +inline void ClientImpl::set_write_timeout( + const std::chrono::duration &duration) { + detail::duration_to_sec_and_usec( + duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); }); +} + +template +inline void Client::set_connection_timeout( + const std::chrono::duration &duration) { + cli_->set_connection_timeout(duration); +} + +template +inline void +Client::set_read_timeout(const std::chrono::duration &duration) { + cli_->set_read_timeout(duration); +} + +template +inline void +Client::set_write_timeout(const std::chrono::duration &duration) { + cli_->set_write_timeout(duration); +} + +/* + * Forward declarations and types that will be part of the .h file if split into + * .h + .cc. + */ + +std::string hosted_at(const std::string &hostname); + +void hosted_at(const std::string &hostname, std::vector &addrs); + +std::string append_query_params(const std::string &path, const Params ¶ms); + +std::pair make_range_header(const Ranges &ranges); + +std::pair +make_basic_authentication_header(const std::string &username, + const std::string &password, + bool is_proxy = false); + +namespace detail { + +std::string encode_query_param(const std::string &value); + +std::string decode_url(const std::string &s, bool convert_plus_to_space); + +void read_file(const std::string &path, std::string &out); + +std::string trim_copy(const std::string &s); + +void divide( + const char *data, std::size_t size, char d, + std::function + fn); + +void divide( + const std::string &str, char d, + std::function + fn); + +void split(const char *b, const char *e, char d, + std::function fn); + +void split(const char *b, const char *e, char d, size_t m, + std::function fn); + +bool process_client_socket(socket_t sock, time_t read_timeout_sec, + time_t read_timeout_usec, time_t write_timeout_sec, + time_t write_timeout_usec, + std::function callback); + +socket_t create_client_socket( + const std::string &host, const std::string &ip, int port, + int address_family, bool tcp_nodelay, SocketOptions socket_options, + time_t connection_timeout_sec, time_t connection_timeout_usec, + time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec, + time_t write_timeout_usec, const std::string &intf, Error &error); + +const char *get_header_value(const Headers &headers, const std::string &key, + size_t id = 0, const char *def = nullptr); + +std::string params_to_query_str(const Params ¶ms); + +void parse_query_text(const char *data, std::size_t size, Params ¶ms); + +void parse_query_text(const std::string &s, Params ¶ms); + +bool parse_multipart_boundary(const std::string &content_type, + std::string &boundary); + +bool parse_range_header(const std::string &s, Ranges &ranges); + +int close_socket(socket_t sock); + +ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags); + +ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags); + +enum class EncodingType { None = 0, Gzip, Brotli }; + +EncodingType encoding_type(const Request &req, const Response &res); + +class BufferStream final : public Stream { +public: + BufferStream() = default; + ~BufferStream() override = default; + + bool is_readable() const override; + bool is_writable() const override; + ssize_t read(char *ptr, size_t size) override; + ssize_t write(const char *ptr, size_t size) override; + void get_remote_ip_and_port(std::string &ip, int &port) const override; + void get_local_ip_and_port(std::string &ip, int &port) const override; + socket_t socket() const override; + + const std::string &get_buffer() const; + +private: + std::string buffer; + size_t position = 0; +}; + +class compressor { +public: + virtual ~compressor() = default; + + typedef std::function Callback; + virtual bool compress(const char *data, size_t data_length, bool last, + Callback callback) = 0; +}; + +class decompressor { +public: + virtual ~decompressor() = default; + + virtual bool is_valid() const = 0; + + typedef std::function Callback; + virtual bool decompress(const char *data, size_t data_length, + Callback callback) = 0; +}; + +class nocompressor final : public compressor { +public: + ~nocompressor() override = default; + + bool compress(const char *data, size_t data_length, bool /*last*/, + Callback callback) override; +}; + +#ifdef CPPHTTPLIB_ZLIB_SUPPORT +class gzip_compressor final : public compressor { +public: + gzip_compressor(); + ~gzip_compressor() override; + + bool compress(const char *data, size_t data_length, bool last, + Callback callback) override; + +private: + bool is_valid_ = false; + z_stream strm_; +}; + +class gzip_decompressor final : public decompressor { +public: + gzip_decompressor(); + ~gzip_decompressor() override; + + bool is_valid() const override; + + bool decompress(const char *data, size_t data_length, + Callback callback) override; + +private: + bool is_valid_ = false; + z_stream strm_; +}; +#endif + +#ifdef CPPHTTPLIB_BROTLI_SUPPORT +class brotli_compressor final : public compressor { +public: + brotli_compressor(); + ~brotli_compressor(); + + bool compress(const char *data, size_t data_length, bool last, + Callback callback) override; + +private: + BrotliEncoderState *state_ = nullptr; +}; + +class brotli_decompressor final : public decompressor { +public: + brotli_decompressor(); + ~brotli_decompressor(); + + bool is_valid() const override; + + bool decompress(const char *data, size_t data_length, + Callback callback) override; + +private: + BrotliDecoderResult decoder_r; + BrotliDecoderState *decoder_s = nullptr; +}; +#endif + +// NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer` +// to store data. The call can set memory on stack for performance. +class stream_line_reader { +public: + stream_line_reader(Stream &strm, char *fixed_buffer, + size_t fixed_buffer_size); + const char *ptr() const; + size_t size() const; + bool end_with_crlf() const; + bool getline(); + +private: + void append(char c); + + Stream &strm_; + char *fixed_buffer_; + const size_t fixed_buffer_size_; + size_t fixed_buffer_used_size_ = 0; + std::string glowable_buffer_; +}; + +class mmap { +public: + mmap(const char *path); + ~mmap(); + + bool open(const char *path); + void close(); + + bool is_open() const; + size_t size() const; + const char *data() const; + +private: +#if defined(_WIN32) + HANDLE hFile_; + HANDLE hMapping_; +#else + int fd_; +#endif + size_t size_; + void *addr_; +}; + +} // namespace detail + +// ---------------------------------------------------------------------------- + +/* + * Implementation that will be part of the .cc file if split into .h + .cc. + */ + +namespace detail { + +inline bool is_hex(char c, int &v) { + if (0x20 <= c && isdigit(c)) { + v = c - '0'; + return true; + } else if ('A' <= c && c <= 'F') { + v = c - 'A' + 10; + return true; + } else if ('a' <= c && c <= 'f') { + v = c - 'a' + 10; + return true; + } + return false; +} + +inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt, + int &val) { + if (i >= s.size()) { return false; } + + val = 0; + for (; cnt; i++, cnt--) { + if (!s[i]) { return false; } + auto v = 0; + if (is_hex(s[i], v)) { + val = val * 16 + v; + } else { + return false; + } + } + return true; +} + +inline std::string from_i_to_hex(size_t n) { + static const auto charset = "0123456789abcdef"; + std::string ret; + do { + ret = charset[n & 15] + ret; + n >>= 4; + } while (n > 0); + return ret; +} + +inline size_t to_utf8(int code, char *buff) { + if (code < 0x0080) { + buff[0] = static_cast(code & 0x7F); + return 1; + } else if (code < 0x0800) { + buff[0] = static_cast(0xC0 | ((code >> 6) & 0x1F)); + buff[1] = static_cast(0x80 | (code & 0x3F)); + return 2; + } else if (code < 0xD800) { + buff[0] = static_cast(0xE0 | ((code >> 12) & 0xF)); buff[1] = static_cast(0x80 | ((code >> 6) & 0x3F)); buff[2] = static_cast(0x80 | (code & 0x3F)); return 3; @@ -1389,8 +2486,8 @@ inline std::string base64_encode(const std::string &in) { std::string out; out.reserve(in.size()); - int val = 0; - int valb = -6; + auto val = 0; + auto valb = -6; for (auto c : in) { val = (val << 8) + static_cast(c); @@ -1411,8 +2508,12 @@ inline std::string base64_encode(const std::string &in) { } inline bool is_file(const std::string &path) { +#ifdef _WIN32 + return _access_s(path.c_str(), 0) == 0; +#else struct stat st; return stat(path.c_str(), &st) >= 0 && S_ISREG(st.st_mode); +#endif } inline bool is_dir(const std::string &path) { @@ -1433,6 +2534,11 @@ inline bool is_valid_path(const std::string &path) { // Read component auto beg = i; while (i < path.size() && path[i] != '/') { + if (path[i] == '\0') { + return false; + } else if (path[i] == '\\') { + return false; + } i++; } @@ -1462,9 +2568,10 @@ inline std::string encode_query_param(const std::string &value) { escaped.fill('0'); escaped << std::hex; - for (char const &c : value) { - if (std::isalnum(c) || c == '-' || c == '_' || c == '.' || c == '!' || - c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') { + for (auto c : value) { + if (std::isalnum(static_cast(c)) || c == '-' || c == '_' || + c == '.' || c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || + c == ')') { escaped << c; } else { escaped << std::uppercase; @@ -1479,6 +2586,7 @@ inline std::string encode_query_param(const std::string &value) { inline std::string encode_url(const std::string &s) { std::string result; + result.reserve(s.size()); for (size_t i = 0; s[i]; i++) { switch (s[i]) { @@ -1515,7 +2623,7 @@ inline std::string decode_url(const std::string &s, for (size_t i = 0; i < s.size(); i++) { if (s[i] == '%' && i + 1 < s.size()) { if (s[i + 1] == 'u') { - int val = 0; + auto val = 0; if (from_hex_to_i(s, i + 2, 4, val)) { // 4 digits Unicode codes char buff[4]; @@ -1526,7 +2634,7 @@ inline std::string decode_url(const std::string &s, result += s[i]; } } else { - int val = 0; + auto val = 0; if (from_hex_to_i(s, i + 1, 2, val)) { // 2 digits hex codes result += static_cast(val); @@ -1579,15 +2687,51 @@ inline std::string trim_copy(const std::string &s) { return s.substr(r.first, r.second - r.first); } -template void split(const char *b, const char *e, char d, Fn fn) { +inline std::string trim_double_quotes_copy(const std::string &s) { + if (s.length() >= 2 && s.front() == '"' && s.back() == '"') { + return s.substr(1, s.size() - 2); + } + return s; +} + +inline void +divide(const char *data, std::size_t size, char d, + std::function + fn) { + const auto it = std::find(data, data + size, d); + const auto found = static_cast(it != data + size); + const auto lhs_data = data; + const auto lhs_size = static_cast(it - data); + const auto rhs_data = it + found; + const auto rhs_size = size - lhs_size - found; + + fn(lhs_data, lhs_size, rhs_data, rhs_size); +} + +inline void +divide(const std::string &str, char d, + std::function + fn) { + divide(str.data(), str.size(), d, std::move(fn)); +} + +inline void split(const char *b, const char *e, char d, + std::function fn) { + return split(b, e, d, (std::numeric_limits::max)(), std::move(fn)); +} + +inline void split(const char *b, const char *e, char d, size_t m, + std::function fn) { size_t i = 0; size_t beg = 0; + size_t count = 1; while (e ? (b + i < e) : (b[i] != '\0')) { - if (b[i] == d) { + if (b[i] == d && count < m) { auto r = trim(b, e, beg, i); if (r.first < r.second) { fn(&b[r.first], &b[r.second]); } beg = i + 1; + count++; } i++; } @@ -1598,82 +2742,197 @@ template void split(const char *b, const char *e, char d, Fn fn) { } } -// NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer` -// to store data. The call can set memory on stack for performance. -class stream_line_reader { -public: - stream_line_reader(Stream &strm, char *fixed_buffer, size_t fixed_buffer_size) - : strm_(strm), fixed_buffer_(fixed_buffer), - fixed_buffer_size_(fixed_buffer_size) {} +inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer, + size_t fixed_buffer_size) + : strm_(strm), fixed_buffer_(fixed_buffer), + fixed_buffer_size_(fixed_buffer_size) {} - const char *ptr() const { - if (glowable_buffer_.empty()) { - return fixed_buffer_; - } else { - return glowable_buffer_.data(); +inline const char *stream_line_reader::ptr() const { + if (glowable_buffer_.empty()) { + return fixed_buffer_; + } else { + return glowable_buffer_.data(); + } +} + +inline size_t stream_line_reader::size() const { + if (glowable_buffer_.empty()) { + return fixed_buffer_used_size_; + } else { + return glowable_buffer_.size(); + } +} + +inline bool stream_line_reader::end_with_crlf() const { + auto end = ptr() + size(); + return size() >= 2 && end[-2] == '\r' && end[-1] == '\n'; +} + +inline bool stream_line_reader::getline() { + fixed_buffer_used_size_ = 0; + glowable_buffer_.clear(); + + for (size_t i = 0;; i++) { + char byte; + auto n = strm_.read(&byte, 1); + + if (n < 0) { + return false; + } else if (n == 0) { + if (i == 0) { + return false; + } else { + break; + } } + + append(byte); + + if (byte == '\n') { break; } } - size_t size() const { + return true; +} + +inline void stream_line_reader::append(char c) { + if (fixed_buffer_used_size_ < fixed_buffer_size_ - 1) { + fixed_buffer_[fixed_buffer_used_size_++] = c; + fixed_buffer_[fixed_buffer_used_size_] = '\0'; + } else { if (glowable_buffer_.empty()) { - return fixed_buffer_used_size_; - } else { - return glowable_buffer_.size(); + assert(fixed_buffer_[fixed_buffer_used_size_] == '\0'); + glowable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_); } + glowable_buffer_ += c; } +} + +inline mmap::mmap(const char *path) +#if defined(_WIN32) + : hFile_(NULL), hMapping_(NULL) +#else + : fd_(-1) +#endif + , + size_(0), addr_(nullptr) { + open(path); +} + +inline mmap::~mmap() { close(); } - bool end_with_crlf() const { - auto end = ptr() + size(); - return size() >= 2 && end[-2] == '\r' && end[-1] == '\n'; +inline bool mmap::open(const char *path) { + close(); + +#if defined(_WIN32) + std::wstring wpath; + for (size_t i = 0; i < strlen(path); i++) { + wpath += path[i]; } - bool getline() { - fixed_buffer_used_size_ = 0; - glowable_buffer_.clear(); +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | \ + WINAPI_PARTITION_GAMES) && \ + (_WIN32_WINNT >= _WIN32_WINNT_WIN8) + hFile_ = ::CreateFile2(wpath.c_str(), GENERIC_READ, FILE_SHARE_READ, + OPEN_EXISTING, NULL); +#else + hFile_ = ::CreateFileW(wpath.c_str(), GENERIC_READ, FILE_SHARE_READ, NULL, + OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL); +#endif - for (size_t i = 0;; i++) { - char byte; - auto n = strm_.read(&byte, 1); + if (hFile_ == INVALID_HANDLE_VALUE) { return false; } - if (n < 0) { - return false; - } else if (n == 0) { - if (i == 0) { - return false; - } else { - break; - } - } +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | \ + WINAPI_PARTITION_GAMES) + LARGE_INTEGER size{}; + if (!::GetFileSizeEx(hFile_, &size)) { return false; } + size_ = static_cast(size.QuadPart); +#else + DWORD sizeHigh; + DWORD sizeLow; + sizeLow = ::GetFileSize(hFile_, &sizeHigh); + if (sizeLow == INVALID_FILE_SIZE) { return false; } + size_ = (static_cast(sizeHigh) << (sizeof(DWORD) * 8)) | sizeLow; +#endif - append(byte); +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) && \ + (_WIN32_WINNT >= _WIN32_WINNT_WIN8) + hMapping_ = + ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL); +#else + hMapping_ = ::CreateFileMappingW(hFile_, NULL, PAGE_READONLY, size.HighPart, + size.LowPart, NULL); +#endif - if (byte == '\n') { break; } - } + if (hMapping_ == NULL) { + close(); + return false; + } - return true; +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) && \ + (_WIN32_WINNT >= _WIN32_WINNT_WIN8) + addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0); +#else + addr_ = ::MapViewOfFile(hMapping_, FILE_MAP_READ, 0, 0, 0); +#endif +#else + fd_ = ::open(path, O_RDONLY); + if (fd_ == -1) { return false; } + + struct stat sb; + if (fstat(fd_, &sb) == -1) { + close(); + return false; } + size_ = static_cast(sb.st_size); -private: - void append(char c) { - if (fixed_buffer_used_size_ < fixed_buffer_size_ - 1) { - fixed_buffer_[fixed_buffer_used_size_++] = c; - fixed_buffer_[fixed_buffer_used_size_] = '\0'; - } else { - if (glowable_buffer_.empty()) { - assert(fixed_buffer_[fixed_buffer_used_size_] == '\0'); - glowable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_); - } - glowable_buffer_ += c; - } + addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0); +#endif + + if (addr_ == nullptr) { + close(); + return false; } - Stream &strm_; - char *fixed_buffer_; - const size_t fixed_buffer_size_; - size_t fixed_buffer_used_size_ = 0; - std::string glowable_buffer_; -}; + return true; +} + +inline bool mmap::is_open() const { return addr_ != nullptr; } + +inline size_t mmap::size() const { return size_; } + +inline const char *mmap::data() const { + return static_cast(addr_); +} + +inline void mmap::close() { +#if defined(_WIN32) + if (addr_) { + ::UnmapViewOfFile(addr_); + addr_ = nullptr; + } + + if (hMapping_) { + ::CloseHandle(hMapping_); + hMapping_ = NULL; + } + + if (hFile_ != INVALID_HANDLE_VALUE) { + ::CloseHandle(hFile_); + hFile_ = INVALID_HANDLE_VALUE; + } +#else + if (addr_ != nullptr) { + munmap(addr_, size_); + addr_ = nullptr; + } + if (fd_ != -1) { + ::close(fd_); + fd_ = -1; + } +#endif + size_ = 0; +} inline int close_socket(socket_t sock) { #ifdef _WIN32 return closesocket(sock); @@ -1683,7 +2942,7 @@ inline int close_socket(socket_t sock) { } template inline ssize_t handle_EINTR(T fn) { - ssize_t res = false; + ssize_t res = 0; while (true) { res = fn(); if (res < 0 && errno == EINTR) { continue; } @@ -1692,6 +2951,31 @@ template inline ssize_t handle_EINTR(T fn) { return res; } +inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) { + return handle_EINTR([&]() { + return recv(sock, +#ifdef _WIN32 + static_cast(ptr), static_cast(size), +#else + ptr, size, +#endif + flags); + }); +} + +inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size, + int flags) { + return handle_EINTR([&]() { + return send(sock, +#ifdef _WIN32 + static_cast(ptr), static_cast(size), +#else + ptr, size, +#endif + flags); + }); +} + inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) { #ifdef CPPHTTPLIB_USE_POLL struct pollfd pfd_read; @@ -1703,7 +2987,7 @@ inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) { return handle_EINTR([&]() { return poll(&pfd_read, 1, timeout); }); #else #ifndef _WIN32 - if (sock >= FD_SETSIZE) { return 1; } + if (sock >= FD_SETSIZE) { return -1; } #endif fd_set fds; @@ -1731,7 +3015,7 @@ inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) { return handle_EINTR([&]() { return poll(&pfd_read, 1, timeout); }); #else #ifndef _WIN32 - if (sock >= FD_SETSIZE) { return 1; } + if (sock >= FD_SETSIZE) { return -1; } #endif fd_set fds; @@ -1748,7 +3032,8 @@ inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) { #endif } -inline bool wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec) { +inline Error wait_until_socket_is_ready(socket_t sock, time_t sec, + time_t usec) { #ifdef CPPHTTPLIB_USE_POLL struct pollfd pfd_read; pfd_read.fd = sock; @@ -1758,17 +3043,21 @@ inline bool wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec) { auto poll_res = handle_EINTR([&]() { return poll(&pfd_read, 1, timeout); }); + if (poll_res == 0) { return Error::ConnectionTimeout; } + if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) { - int error = 0; + auto error = 0; socklen_t len = sizeof(error); auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR, reinterpret_cast(&error), &len); - return res >= 0 && !error; + auto successful = res >= 0 && !error; + return successful ? Error::Success : Error::Connection; } - return false; + + return Error::Connection; #else #ifndef _WIN32 - if (sock >= FD_SETSIZE) { return false; } + if (sock >= FD_SETSIZE) { return Error::Connection; } #endif fd_set fdsr; @@ -1786,18 +3075,32 @@ inline bool wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec) { return select(static_cast(sock + 1), &fdsr, &fdsw, &fdse, &tv); }); + if (ret == 0) { return Error::ConnectionTimeout; } + if (ret > 0 && (FD_ISSET(sock, &fdsr) || FD_ISSET(sock, &fdsw))) { - int error = 0; + auto error = 0; socklen_t len = sizeof(error); - return getsockopt(sock, SOL_SOCKET, SO_ERROR, - reinterpret_cast(&error), &len) >= 0 && - !error; + auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR, + reinterpret_cast(&error), &len); + auto successful = res >= 0 && !error; + return successful ? Error::Success : Error::Connection; } - return false; + return Error::Connection; #endif } -class SocketStream : public Stream { +inline bool is_socket_alive(socket_t sock) { + const auto val = detail::select_read(sock, 0, 0); + if (val == 0) { + return true; + } else if (val < 0 && errno == EBADF) { + return false; + } + char buf[1]; + return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0; +} + +class SocketStream final : public Stream { public: SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec, time_t write_timeout_usec); @@ -1808,6 +3111,7 @@ class SocketStream : public Stream { ssize_t read(char *ptr, size_t size) override; ssize_t write(const char *ptr, size_t size) override; void get_remote_ip_and_port(std::string &ip, int &port) const override; + void get_local_ip_and_port(std::string &ip, int &port) const override; socket_t socket() const override; private: @@ -1816,10 +3120,16 @@ class SocketStream : public Stream { time_t read_timeout_usec_; time_t write_timeout_sec_; time_t write_timeout_usec_; + + std::vector read_buff_; + size_t read_buff_off_ = 0; + size_t read_buff_content_size_ = 0; + + static const size_t read_buff_size_ = 1024l * 4; }; #ifdef CPPHTTPLIB_OPENSSL_SUPPORT -class SSLSocketStream : public Stream { +class SSLSocketStream final : public Stream { public: SSLSocketStream(socket_t sock, SSL *ssl, time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec, @@ -1831,6 +3141,7 @@ class SSLSocketStream : public Stream { ssize_t read(char *ptr, size_t size) override; ssize_t write(const char *ptr, size_t size) override; void get_remote_ip_and_port(std::string &ip, int &port) const override; + void get_local_ip_and_port(std::string &ip, int &port) const override; socket_t socket() const override; private: @@ -1843,25 +3154,6 @@ class SSLSocketStream : public Stream { }; #endif -class BufferStream : public Stream { -public: - BufferStream() = default; - ~BufferStream() override = default; - - bool is_readable() const override; - bool is_writable() const override; - ssize_t read(char *ptr, size_t size) override; - ssize_t write(const char *ptr, size_t size) override; - void get_remote_ip_and_port(std::string &ip, int &port) const override; - socket_t socket() const override; - - const std::string &get_buffer() const; - -private: - std::string buffer; - size_t position = 0; -}; - inline bool keep_alive(socket_t sock, time_t keep_alive_timeout_sec) { using namespace std::chrono; auto start = steady_clock::now(); @@ -1883,12 +3175,14 @@ inline bool keep_alive(socket_t sock, time_t keep_alive_timeout_sec) { template inline bool -process_server_socket_core(socket_t sock, size_t keep_alive_max_count, +process_server_socket_core(const std::atomic &svr_sock, socket_t sock, + size_t keep_alive_max_count, time_t keep_alive_timeout_sec, T callback) { assert(keep_alive_max_count > 0); auto ret = false; auto count = keep_alive_max_count; - while (count > 0 && keep_alive(sock, keep_alive_timeout_sec)) { + while (svr_sock != INVALID_SOCKET && count > 0 && + keep_alive(sock, keep_alive_timeout_sec)) { auto close_connection = count == 1; auto connection_closed = false; ret = callback(close_connection, connection_closed); @@ -1900,12 +3194,13 @@ process_server_socket_core(socket_t sock, size_t keep_alive_max_count, template inline bool -process_server_socket(socket_t sock, size_t keep_alive_max_count, +process_server_socket(const std::atomic &svr_sock, socket_t sock, + size_t keep_alive_max_count, time_t keep_alive_timeout_sec, time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec, time_t write_timeout_usec, T callback) { return process_server_socket_core( - sock, keep_alive_max_count, keep_alive_timeout_sec, + svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec, [&](bool close_connection, bool &connection_closed) { SocketStream strm(sock, read_timeout_sec, read_timeout_usec, write_timeout_sec, write_timeout_usec); @@ -1913,11 +3208,11 @@ process_server_socket(socket_t sock, size_t keep_alive_max_count, }); } -template inline bool process_client_socket(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec, - time_t write_timeout_usec, T callback) { + time_t write_timeout_usec, + std::function callback) { SocketStream strm(sock, read_timeout_sec, read_timeout_usec, write_timeout_sec, write_timeout_usec); return callback(strm); @@ -1932,23 +3227,70 @@ inline int shutdown_socket(socket_t sock) { } template -socket_t create_socket(const char *host, int port, int socket_flags, - bool tcp_nodelay, SocketOptions socket_options, +socket_t create_socket(const std::string &host, const std::string &ip, int port, + int address_family, int socket_flags, bool tcp_nodelay, + SocketOptions socket_options, BindOrConnect bind_or_connect) { // Get address info + const char *node = nullptr; struct addrinfo hints; struct addrinfo *result; memset(&hints, 0, sizeof(struct addrinfo)); - hints.ai_family = AF_UNSPEC; hints.ai_socktype = SOCK_STREAM; - hints.ai_flags = socket_flags; hints.ai_protocol = 0; + if (!ip.empty()) { + node = ip.c_str(); + // Ask getaddrinfo to convert IP in c-string to address + hints.ai_family = AF_UNSPEC; + hints.ai_flags = AI_NUMERICHOST; + } else { + if (!host.empty()) { node = host.c_str(); } + hints.ai_family = address_family; + hints.ai_flags = socket_flags; + } + +#ifndef _WIN32 + if (hints.ai_family == AF_UNIX) { + const auto addrlen = host.length(); + if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; } + +#ifdef SOCK_CLOEXEC + auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC, + hints.ai_protocol); +#else + auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol); +#endif + + if (sock != INVALID_SOCKET) { + sockaddr_un addr{}; + addr.sun_family = AF_UNIX; + std::copy(host.begin(), host.end(), addr.sun_path); + + hints.ai_addr = reinterpret_cast(&addr); + hints.ai_addrlen = static_cast( + sizeof(addr) - sizeof(addr.sun_path) + addrlen); + +#ifndef SOCK_CLOEXEC + fcntl(sock, F_SETFD, FD_CLOEXEC); +#endif + + if (socket_options) { socket_options(sock); } + + if (!bind_or_connect(sock, hints)) { + close_socket(sock); + sock = INVALID_SOCKET; + } + } + return sock; + } +#endif + auto service = std::to_string(port); - if (getaddrinfo(host, service.c_str(), &hints, &result)) { -#ifdef __linux__ + if (getaddrinfo(node, service.c_str(), &hints, &result)) { +#if defined __linux__ && !defined __ANDROID__ res_init(); #endif return INVALID_SOCKET; @@ -1957,8 +3299,9 @@ socket_t create_socket(const char *host, int port, int socket_flags, for (auto rp = result; rp; rp = rp->ai_next) { // Create a socket #ifdef _WIN32 - auto sock = WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, - nullptr, 0, WSA_FLAG_NO_HANDLE_INHERIT); + auto sock = + WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0, + WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED); /** * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1 * and above the socket creation fails on older Windows Systems. @@ -1977,26 +3320,46 @@ socket_t create_socket(const char *host, int port, int socket_flags, sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol); } #else + +#ifdef SOCK_CLOEXEC + auto sock = + socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol); +#else auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol); +#endif + #endif if (sock == INVALID_SOCKET) { continue; } -#ifndef _WIN32 - if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) { continue; } +#if !defined _WIN32 && !defined SOCK_CLOEXEC + if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) { + close_socket(sock); + continue; + } #endif if (tcp_nodelay) { - int yes = 1; - setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, reinterpret_cast(&yes), - sizeof(yes)); + auto yes = 1; +#ifdef _WIN32 + setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, + reinterpret_cast(&yes), sizeof(yes)); +#else + setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, + reinterpret_cast(&yes), sizeof(yes)); +#endif } if (socket_options) { socket_options(sock); } if (rp->ai_family == AF_INET6) { - int no = 0; - setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, reinterpret_cast(&no), - sizeof(no)); + auto no = 0; +#ifdef _WIN32 + setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, + reinterpret_cast(&no), sizeof(no)); +#else + setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, + reinterpret_cast(&no), sizeof(no)); +#endif } // bind or connect @@ -2031,7 +3394,7 @@ inline bool is_connection_error() { #endif } -inline bool bind_ip_address(socket_t sock, const char *host) { +inline bool bind_ip_address(socket_t sock, const std::string &host) { struct addrinfo hints; struct addrinfo *result; @@ -2040,7 +3403,7 @@ inline bool bind_ip_address(socket_t sock, const char *host) { hints.ai_socktype = SOCK_STREAM; hints.ai_protocol = 0; - if (getaddrinfo(host, "0", &hints, &result)) { return false; } + if (getaddrinfo(host.c_str(), "0", &hints, &result)) { return false; } auto ret = false; for (auto rp = result; rp; rp = rp->ai_next) { @@ -2055,16 +3418,19 @@ inline bool bind_ip_address(socket_t sock, const char *host) { return ret; } -#if !defined _WIN32 && !defined ANDROID +#if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__ #define USE_IF2IP #endif #ifdef USE_IF2IP -inline std::string if2ip(const std::string &ifn) { +inline std::string if2ip(int address_family, const std::string &ifn) { struct ifaddrs *ifap; getifaddrs(&ifap); + std::string addr_candidate; for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) { - if (ifa->ifa_addr && ifn == ifa->ifa_name) { + if (ifa->ifa_addr && ifn == ifa->ifa_name && + (AF_UNSPEC == address_family || + ifa->ifa_addr->sa_family == address_family)) { if (ifa->ifa_addr->sa_family == AF_INET) { auto sa = reinterpret_cast(ifa->ifa_addr); char buf[INET_ADDRSTRLEN]; @@ -2072,48 +3438,96 @@ inline std::string if2ip(const std::string &ifn) { freeifaddrs(ifap); return std::string(buf, INET_ADDRSTRLEN); } + } else if (ifa->ifa_addr->sa_family == AF_INET6) { + auto sa = reinterpret_cast(ifa->ifa_addr); + if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) { + char buf[INET6_ADDRSTRLEN] = {}; + if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) { + // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL + auto s6_addr_head = sa->sin6_addr.s6_addr[0]; + if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) { + addr_candidate = std::string(buf, INET6_ADDRSTRLEN); + } else { + freeifaddrs(ifap); + return std::string(buf, INET6_ADDRSTRLEN); + } + } + } } } } freeifaddrs(ifap); - return std::string(); + return addr_candidate; } #endif -inline socket_t create_client_socket(const char *host, int port, - bool tcp_nodelay, - SocketOptions socket_options, - time_t timeout_sec, time_t timeout_usec, - const std::string &intf, Error &error) { +inline socket_t create_client_socket( + const std::string &host, const std::string &ip, int port, + int address_family, bool tcp_nodelay, SocketOptions socket_options, + time_t connection_timeout_sec, time_t connection_timeout_usec, + time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec, + time_t write_timeout_usec, const std::string &intf, Error &error) { auto sock = create_socket( - host, port, 0, tcp_nodelay, std::move(socket_options), - [&](socket_t sock, struct addrinfo &ai) -> bool { + host, ip, port, address_family, 0, tcp_nodelay, std::move(socket_options), + [&](socket_t sock2, struct addrinfo &ai) -> bool { if (!intf.empty()) { #ifdef USE_IF2IP - auto ip = if2ip(intf); - if (ip.empty()) { ip = intf; } - if (!bind_ip_address(sock, ip.c_str())) { + auto ip_from_if = if2ip(address_family, intf); + if (ip_from_if.empty()) { ip_from_if = intf; } + if (!bind_ip_address(sock2, ip_from_if)) { error = Error::BindIPAddress; return false; } #endif } - set_nonblocking(sock, true); + set_nonblocking(sock2, true); auto ret = - ::connect(sock, ai.ai_addr, static_cast(ai.ai_addrlen)); + ::connect(sock2, ai.ai_addr, static_cast(ai.ai_addrlen)); if (ret < 0) { - if (is_connection_error() || - !wait_until_socket_is_ready(sock, timeout_sec, timeout_usec)) { - close_socket(sock); + if (is_connection_error()) { error = Error::Connection; return false; } + error = wait_until_socket_is_ready(sock2, connection_timeout_sec, + connection_timeout_usec); + if (error != Error::Success) { return false; } + } + + set_nonblocking(sock2, false); + + { +#ifdef _WIN32 + auto timeout = static_cast(read_timeout_sec * 1000 + + read_timeout_usec / 1000); + setsockopt(sock2, SOL_SOCKET, SO_RCVTIMEO, + reinterpret_cast(&timeout), sizeof(timeout)); +#else + timeval tv; + tv.tv_sec = static_cast(read_timeout_sec); + tv.tv_usec = static_cast(read_timeout_usec); + setsockopt(sock2, SOL_SOCKET, SO_RCVTIMEO, + reinterpret_cast(&tv), sizeof(tv)); +#endif + } + { + +#ifdef _WIN32 + auto timeout = static_cast(write_timeout_sec * 1000 + + write_timeout_usec / 1000); + setsockopt(sock2, SOL_SOCKET, SO_SNDTIMEO, + reinterpret_cast(&timeout), sizeof(timeout)); +#else + timeval tv; + tv.tv_sec = static_cast(write_timeout_sec); + tv.tv_usec = static_cast(write_timeout_usec); + setsockopt(sock2, SOL_SOCKET, SO_SNDTIMEO, + reinterpret_cast(&tv), sizeof(tv)); +#endif } - set_nonblocking(sock, false); error = Error::Success; return true; }); @@ -2127,21 +3541,34 @@ inline socket_t create_client_socket(const char *host, int port, return sock; } -inline void get_remote_ip_and_port(const struct sockaddr_storage &addr, - socklen_t addr_len, std::string &ip, - int &port) { +inline bool get_ip_and_port(const struct sockaddr_storage &addr, + socklen_t addr_len, std::string &ip, int &port) { if (addr.ss_family == AF_INET) { port = ntohs(reinterpret_cast(&addr)->sin_port); } else if (addr.ss_family == AF_INET6) { port = ntohs(reinterpret_cast(&addr)->sin6_port); + } else { + return false; } std::array ipstr{}; - if (!getnameinfo(reinterpret_cast(&addr), addr_len, - ipstr.data(), static_cast(ipstr.size()), nullptr, - 0, NI_NUMERICHOST)) { - ip = ipstr.data(); + if (getnameinfo(reinterpret_cast(&addr), addr_len, + ipstr.data(), static_cast(ipstr.size()), nullptr, + 0, NI_NUMERICHOST)) { + return false; + } + + ip = ipstr.data(); + return true; +} + +inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) { + struct sockaddr_storage addr; + socklen_t addr_len = sizeof(addr); + if (!getsockname(sock, reinterpret_cast(&addr), + &addr_len)) { + get_ip_and_port(addr, addr_len, ip, port); } } @@ -2151,15 +3578,38 @@ inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) { if (!getpeername(sock, reinterpret_cast(&addr), &addr_len)) { - get_remote_ip_and_port(addr, addr_len, ip, port); +#ifndef _WIN32 + if (addr.ss_family == AF_UNIX) { +#if defined(__linux__) + struct ucred ucred; + socklen_t len = sizeof(ucred); + if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) { + port = ucred.pid; + } +#elif defined(SOL_LOCAL) && defined(SO_PEERPID) // __APPLE__ + pid_t pid; + socklen_t len = sizeof(pid); + if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) { + port = pid; + } +#endif + return; + } +#endif + get_ip_and_port(addr, addr_len, ip, port); } } inline constexpr unsigned int str2tag_core(const char *s, size_t l, unsigned int h) { - return (l == 0) ? h - : str2tag_core(s + 1, l - 1, - (h * 33) ^ static_cast(*s)); + return (l == 0) + ? h + : str2tag_core( + s + 1, l - 1, + // Unsets the 6 high bits of h, therefore no overflow happens + (((std::numeric_limits::max)() >> 6) & + h * 33) ^ + static_cast(*s)); } inline unsigned int str2tag(const std::string &s) { @@ -2168,157 +3618,96 @@ inline unsigned int str2tag(const std::string &s) { namespace udl { -inline constexpr unsigned int operator"" _(const char *s, size_t l) { +inline constexpr unsigned int operator"" _t(const char *s, size_t l) { return str2tag_core(s, l, 0); } } // namespace udl -inline const char * +inline std::string find_content_type(const std::string &path, - const std::map &user_data) { + const std::map &user_data, + const std::string &default_content_type) { auto ext = file_extension(path); auto it = user_data.find(ext); - if (it != user_data.end()) { return it->second.c_str(); } + if (it != user_data.end()) { return it->second; } - using udl::operator""_; + using udl::operator""_t; switch (str2tag(ext)) { - default: return nullptr; - case "css"_: return "text/css"; - case "csv"_: return "text/csv"; - case "txt"_: return "text/plain"; - case "vtt"_: return "text/vtt"; - case "htm"_: - case "html"_: return "text/html"; - - case "apng"_: return "image/apng"; - case "avif"_: return "image/avif"; - case "bmp"_: return "image/bmp"; - case "gif"_: return "image/gif"; - case "png"_: return "image/png"; - case "svg"_: return "image/svg+xml"; - case "webp"_: return "image/webp"; - case "ico"_: return "image/x-icon"; - case "tif"_: return "image/tiff"; - case "tiff"_: return "image/tiff"; - case "jpg"_: - case "jpeg"_: return "image/jpeg"; - - case "mp4"_: return "video/mp4"; - case "mpeg"_: return "video/mpeg"; - case "webm"_: return "video/webm"; - - case "mp3"_: return "audio/mp3"; - case "mpga"_: return "audio/mpeg"; - case "weba"_: return "audio/webm"; - case "wav"_: return "audio/wave"; - - case "otf"_: return "font/otf"; - case "ttf"_: return "font/ttf"; - case "woff"_: return "font/woff"; - case "woff2"_: return "font/woff2"; - - case "7z"_: return "application/x-7z-compressed"; - case "atom"_: return "application/atom+xml"; - case "pdf"_: return "application/pdf"; - case "js"_: - case "mjs"_: return "application/javascript"; - case "json"_: return "application/json"; - case "rss"_: return "application/rss+xml"; - case "tar"_: return "application/x-tar"; - case "xht"_: - case "xhtml"_: return "application/xhtml+xml"; - case "xslt"_: return "application/xslt+xml"; - case "xml"_: return "application/xml"; - case "gz"_: return "application/gzip"; - case "zip"_: return "application/zip"; - case "wasm"_: return "application/wasm"; + default: return default_content_type; + + case "css"_t: return "text/css"; + case "csv"_t: return "text/csv"; + case "htm"_t: + case "html"_t: return "text/html"; + case "js"_t: + case "mjs"_t: return "text/javascript"; + case "txt"_t: return "text/plain"; + case "vtt"_t: return "text/vtt"; + + case "apng"_t: return "image/apng"; + case "avif"_t: return "image/avif"; + case "bmp"_t: return "image/bmp"; + case "gif"_t: return "image/gif"; + case "png"_t: return "image/png"; + case "svg"_t: return "image/svg+xml"; + case "webp"_t: return "image/webp"; + case "ico"_t: return "image/x-icon"; + case "tif"_t: return "image/tiff"; + case "tiff"_t: return "image/tiff"; + case "jpg"_t: + case "jpeg"_t: return "image/jpeg"; + + case "mp4"_t: return "video/mp4"; + case "mpeg"_t: return "video/mpeg"; + case "webm"_t: return "video/webm"; + + case "mp3"_t: return "audio/mp3"; + case "mpga"_t: return "audio/mpeg"; + case "weba"_t: return "audio/webm"; + case "wav"_t: return "audio/wave"; + + case "otf"_t: return "font/otf"; + case "ttf"_t: return "font/ttf"; + case "woff"_t: return "font/woff"; + case "woff2"_t: return "font/woff2"; + + case "7z"_t: return "application/x-7z-compressed"; + case "atom"_t: return "application/atom+xml"; + case "pdf"_t: return "application/pdf"; + case "json"_t: return "application/json"; + case "rss"_t: return "application/rss+xml"; + case "tar"_t: return "application/x-tar"; + case "xht"_t: + case "xhtml"_t: return "application/xhtml+xml"; + case "xslt"_t: return "application/xslt+xml"; + case "xml"_t: return "application/xml"; + case "gz"_t: return "application/gzip"; + case "zip"_t: return "application/zip"; + case "wasm"_t: return "application/wasm"; } } -inline const char *status_message(int status) { - switch (status) { - case 100: return "Continue"; - case 101: return "Switching Protocol"; - case 102: return "Processing"; - case 103: return "Early Hints"; - case 200: return "OK"; - case 201: return "Created"; - case 202: return "Accepted"; - case 203: return "Non-Authoritative Information"; - case 204: return "No Content"; - case 205: return "Reset Content"; - case 206: return "Partial Content"; - case 207: return "Multi-Status"; - case 208: return "Already Reported"; - case 226: return "IM Used"; - case 300: return "Multiple Choice"; - case 301: return "Moved Permanently"; - case 302: return "Found"; - case 303: return "See Other"; - case 304: return "Not Modified"; - case 305: return "Use Proxy"; - case 306: return "unused"; - case 307: return "Temporary Redirect"; - case 308: return "Permanent Redirect"; - case 400: return "Bad Request"; - case 401: return "Unauthorized"; - case 402: return "Payment Required"; - case 403: return "Forbidden"; - case 404: return "Not Found"; - case 405: return "Method Not Allowed"; - case 406: return "Not Acceptable"; - case 407: return "Proxy Authentication Required"; - case 408: return "Request Timeout"; - case 409: return "Conflict"; - case 410: return "Gone"; - case 411: return "Length Required"; - case 412: return "Precondition Failed"; - case 413: return "Payload Too Large"; - case 414: return "URI Too Long"; - case 415: return "Unsupported Media Type"; - case 416: return "Range Not Satisfiable"; - case 417: return "Expectation Failed"; - case 418: return "I'm a teapot"; - case 421: return "Misdirected Request"; - case 422: return "Unprocessable Entity"; - case 423: return "Locked"; - case 424: return "Failed Dependency"; - case 425: return "Too Early"; - case 426: return "Upgrade Required"; - case 428: return "Precondition Required"; - case 429: return "Too Many Requests"; - case 431: return "Request Header Fields Too Large"; - case 451: return "Unavailable For Legal Reasons"; - case 501: return "Not Implemented"; - case 502: return "Bad Gateway"; - case 503: return "Service Unavailable"; - case 504: return "Gateway Timeout"; - case 505: return "HTTP Version Not Supported"; - case 506: return "Variant Also Negotiates"; - case 507: return "Insufficient Storage"; - case 508: return "Loop Detected"; - case 510: return "Not Extended"; - case 511: return "Network Authentication Required"; +inline bool can_compress_content_type(const std::string &content_type) { + using udl::operator""_t; + + auto tag = str2tag(content_type); + + switch (tag) { + case "image/svg+xml"_t: + case "application/javascript"_t: + case "application/json"_t: + case "application/xml"_t: + case "application/protobuf"_t: + case "application/xhtml+xml"_t: return true; default: - case 500: return "Internal Server Error"; + return !content_type.rfind("text/", 0) && tag != "text/event-stream"_t; } } -inline bool can_compress_content_type(const std::string &content_type) { - return (!content_type.find("text/") && content_type != "text/event-stream") || - content_type == "image/svg+xml" || - content_type == "application/javascript" || - content_type == "application/json" || - content_type == "application/xml" || - content_type == "application/xhtml+xml"; -} - -enum class EncodingType { None = 0, Gzip, Brotli }; - inline EncodingType encoding_type(const Request &req, const Response &res) { auto ret = detail::can_compress_content_type(res.get_header_value("Content-Type")); @@ -2342,120 +3731,105 @@ inline EncodingType encoding_type(const Request &req, const Response &res) { return EncodingType::None; } -class compressor { -public: - virtual ~compressor(){}; - - typedef std::function Callback; - virtual bool compress(const char *data, size_t data_length, bool last, - Callback callback) = 0; -}; - -class decompressor { -public: - virtual ~decompressor() {} - - virtual bool is_valid() const = 0; - - typedef std::function Callback; - virtual bool decompress(const char *data, size_t data_length, - Callback callback) = 0; -}; - -class nocompressor : public compressor { -public: - ~nocompressor(){}; - - bool compress(const char *data, size_t data_length, bool /*last*/, - Callback callback) override { - if (!data_length) { return true; } - return callback(data, data_length); - } -}; +inline bool nocompressor::compress(const char *data, size_t data_length, + bool /*last*/, Callback callback) { + if (!data_length) { return true; } + return callback(data, data_length); +} #ifdef CPPHTTPLIB_ZLIB_SUPPORT -class gzip_compressor : public compressor { -public: - gzip_compressor() { - std::memset(&strm_, 0, sizeof(strm_)); - strm_.zalloc = Z_NULL; - strm_.zfree = Z_NULL; - strm_.opaque = Z_NULL; +inline gzip_compressor::gzip_compressor() { + std::memset(&strm_, 0, sizeof(strm_)); + strm_.zalloc = Z_NULL; + strm_.zfree = Z_NULL; + strm_.opaque = Z_NULL; - is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8, - Z_DEFAULT_STRATEGY) == Z_OK; - } + is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8, + Z_DEFAULT_STRATEGY) == Z_OK; +} - ~gzip_compressor() { deflateEnd(&strm_); } +inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); } - bool compress(const char *data, size_t data_length, bool last, - Callback callback) override { - assert(is_valid_); +inline bool gzip_compressor::compress(const char *data, size_t data_length, + bool last, Callback callback) { + assert(is_valid_); - auto flush = last ? Z_FINISH : Z_NO_FLUSH; + do { + constexpr size_t max_avail_in = + (std::numeric_limits::max)(); - strm_.avail_in = static_cast(data_length); + strm_.avail_in = static_cast( + (std::min)(data_length, max_avail_in)); strm_.next_in = const_cast(reinterpret_cast(data)); - int ret = Z_OK; + data_length -= strm_.avail_in; + data += strm_.avail_in; + + auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH; + auto ret = Z_OK; std::array buff{}; do { - strm_.avail_out = buff.size(); + strm_.avail_out = static_cast(buff.size()); strm_.next_out = reinterpret_cast(buff.data()); ret = deflate(&strm_, flush); - assert(ret != Z_STREAM_ERROR); + if (ret == Z_STREAM_ERROR) { return false; } if (!callback(buff.data(), buff.size() - strm_.avail_out)) { return false; } } while (strm_.avail_out == 0); - assert((last && ret == Z_STREAM_END) || (!last && ret == Z_OK)); + assert((flush == Z_FINISH && ret == Z_STREAM_END) || + (flush == Z_NO_FLUSH && ret == Z_OK)); assert(strm_.avail_in == 0); - return true; - } + } while (data_length > 0); -private: - bool is_valid_ = false; - z_stream strm_; -}; + return true; +} -class gzip_decompressor : public decompressor { -public: - gzip_decompressor() { - std::memset(&strm_, 0, sizeof(strm_)); - strm_.zalloc = Z_NULL; - strm_.zfree = Z_NULL; - strm_.opaque = Z_NULL; +inline gzip_decompressor::gzip_decompressor() { + std::memset(&strm_, 0, sizeof(strm_)); + strm_.zalloc = Z_NULL; + strm_.zfree = Z_NULL; + strm_.opaque = Z_NULL; - // 15 is the value of wbits, which should be at the maximum possible value - // to ensure that any gzip stream can be decoded. The offset of 32 specifies - // that the stream type should be automatically detected either gzip or - // deflate. - is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK; - } + // 15 is the value of wbits, which should be at the maximum possible value + // to ensure that any gzip stream can be decoded. The offset of 32 specifies + // that the stream type should be automatically detected either gzip or + // deflate. + is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK; +} - ~gzip_decompressor() { inflateEnd(&strm_); } +inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); } - bool is_valid() const override { return is_valid_; } +inline bool gzip_decompressor::is_valid() const { return is_valid_; } - bool decompress(const char *data, size_t data_length, - Callback callback) override { - assert(is_valid_); +inline bool gzip_decompressor::decompress(const char *data, size_t data_length, + Callback callback) { + assert(is_valid_); + + auto ret = Z_OK; - int ret = Z_OK; + do { + constexpr size_t max_avail_in = + (std::numeric_limits::max)(); - strm_.avail_in = static_cast(data_length); + strm_.avail_in = static_cast( + (std::min)(data_length, max_avail_in)); strm_.next_in = const_cast(reinterpret_cast(data)); + data_length -= strm_.avail_in; + data += strm_.avail_in; + std::array buff{}; - while (strm_.avail_in > 0) { - strm_.avail_out = buff.size(); + while (strm_.avail_in > 0 && ret == Z_OK) { + strm_.avail_out = static_cast(buff.size()); strm_.next_out = reinterpret_cast(buff.data()); ret = inflate(&strm_, Z_NO_FLUSH); + assert(ret != Z_STREAM_ERROR); switch (ret) { case Z_NEED_DICT: @@ -2468,118 +3842,107 @@ class gzip_decompressor : public decompressor { } } - return ret == Z_OK || ret == Z_STREAM_END; - } + if (ret != Z_OK && ret != Z_STREAM_END) { return false; } -private: - bool is_valid_ = false; - z_stream strm_; -}; + } while (data_length > 0); + + return true; +} #endif #ifdef CPPHTTPLIB_BROTLI_SUPPORT -class brotli_compressor : public compressor { -public: - brotli_compressor() { - state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr); - } - - ~brotli_compressor() { BrotliEncoderDestroyInstance(state_); } +inline brotli_compressor::brotli_compressor() { + state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr); +} - bool compress(const char *data, size_t data_length, bool last, - Callback callback) override { - std::array buff{}; +inline brotli_compressor::~brotli_compressor() { + BrotliEncoderDestroyInstance(state_); +} - auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS; - auto available_in = data_length; - auto next_in = reinterpret_cast(data); +inline bool brotli_compressor::compress(const char *data, size_t data_length, + bool last, Callback callback) { + std::array buff{}; - for (;;) { - if (last) { - if (BrotliEncoderIsFinished(state_)) { break; } - } else { - if (!available_in) { break; } - } + auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS; + auto available_in = data_length; + auto next_in = reinterpret_cast(data); - auto available_out = buff.size(); - auto next_out = buff.data(); + for (;;) { + if (last) { + if (BrotliEncoderIsFinished(state_)) { break; } + } else { + if (!available_in) { break; } + } - if (!BrotliEncoderCompressStream(state_, operation, &available_in, - &next_in, &available_out, &next_out, - nullptr)) { - return false; - } + auto available_out = buff.size(); + auto next_out = buff.data(); - auto output_bytes = buff.size() - available_out; - if (output_bytes) { - callback(reinterpret_cast(buff.data()), output_bytes); - } + if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in, + &available_out, &next_out, nullptr)) { + return false; } - return true; + auto output_bytes = buff.size() - available_out; + if (output_bytes) { + callback(reinterpret_cast(buff.data()), output_bytes); + } } -private: - BrotliEncoderState *state_ = nullptr; -}; - -class brotli_decompressor : public decompressor { -public: - brotli_decompressor() { - decoder_s = BrotliDecoderCreateInstance(0, 0, 0); - decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT - : BROTLI_DECODER_RESULT_ERROR; - } + return true; +} - ~brotli_decompressor() { - if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); } - } +inline brotli_decompressor::brotli_decompressor() { + decoder_s = BrotliDecoderCreateInstance(0, 0, 0); + decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT + : BROTLI_DECODER_RESULT_ERROR; +} - bool is_valid() const override { return decoder_s; } +inline brotli_decompressor::~brotli_decompressor() { + if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); } +} - bool decompress(const char *data, size_t data_length, - Callback callback) override { - if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS || - decoder_r == BROTLI_DECODER_RESULT_ERROR) { - return 0; - } +inline bool brotli_decompressor::is_valid() const { return decoder_s; } - const uint8_t *next_in = (const uint8_t *)data; - size_t avail_in = data_length; - size_t total_out; +inline bool brotli_decompressor::decompress(const char *data, + size_t data_length, + Callback callback) { + if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS || + decoder_r == BROTLI_DECODER_RESULT_ERROR) { + return 0; + } - decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT; + auto next_in = reinterpret_cast(data); + size_t avail_in = data_length; + size_t total_out; - std::array buff{}; - while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) { - char *next_out = buff.data(); - size_t avail_out = buff.size(); + decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT; - decoder_r = BrotliDecoderDecompressStream( - decoder_s, &avail_in, &next_in, &avail_out, - reinterpret_cast(&next_out), &total_out); + std::array buff{}; + while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) { + char *next_out = buff.data(); + size_t avail_out = buff.size(); - if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; } + decoder_r = BrotliDecoderDecompressStream( + decoder_s, &avail_in, &next_in, &avail_out, + reinterpret_cast(&next_out), &total_out); - if (!callback(buff.data(), buff.size() - avail_out)) { return false; } - } + if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; } - return decoder_r == BROTLI_DECODER_RESULT_SUCCESS || - decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT; + if (!callback(buff.data(), buff.size() - avail_out)) { return false; } } -private: - BrotliDecoderResult decoder_r; - BrotliDecoderState *decoder_s = nullptr; -}; + return decoder_r == BROTLI_DECODER_RESULT_SUCCESS || + decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT; +} #endif -inline bool has_header(const Headers &headers, const char *key) { +inline bool has_header(const Headers &headers, const std::string &key) { return headers.find(key) != headers.end(); } -inline const char *get_header_value(const Headers &headers, const char *key, - size_t id = 0, const char *def = nullptr) { +inline const char *get_header_value(const Headers &headers, + const std::string &key, size_t id, + const char *def) { auto rng = headers.equal_range(key); auto it = rng.first; std::advance(it, static_cast(id)); @@ -2587,21 +3950,12 @@ inline const char *get_header_value(const Headers &headers, const char *key, return def; } -template -inline T get_header_value(const Headers & /*headers*/, const char * /*key*/, - size_t /*id*/ = 0, uint64_t /*def*/ = 0) {} - -template <> -inline uint64_t get_header_value(const Headers &headers, - const char *key, size_t id, - uint64_t def) { - auto rng = headers.equal_range(key); - auto it = rng.first; - std::advance(it, static_cast(id)); - if (it != rng.second) { - return std::strtoull(it->second.data(), nullptr, 10); +inline bool compare_case_ignore(const std::string &a, const std::string &b) { + if (a.size() != b.size()) { return false; } + for (size_t i = 0; i < b.size(); i++) { + if (::tolower(a[i]) != ::tolower(b[i])) { return false; } } - return def; + return true; } template @@ -2627,7 +3981,14 @@ inline bool parse_header(const char *beg, const char *end, T fn) { } if (p < end) { - fn(std::string(beg, key_end), decode_url(std::string(p, end), false)); + auto key_len = key_end - beg; + if (!key_len) { return false; } + + auto key = std::string(beg, key_end); + auto val = compare_case_ignore(key, "Location") + ? std::string(p, end) + : decode_url(std::string(p, end), false); + fn(key, val); return true; } @@ -2643,19 +4004,30 @@ inline bool read_headers(Stream &strm, Headers &headers) { if (!line_reader.getline()) { return false; } // Check if the line ends with CRLF. + auto line_terminator_len = 2; if (line_reader.end_with_crlf()) { // Blank line indicates end of headers. if (line_reader.size() == 2) { break; } +#ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR + } else { + // Blank line indicates end of headers. + if (line_reader.size() == 1) { break; } + line_terminator_len = 1; + } +#else } else { continue; // Skip invalid line. } +#endif - // Exclude CRLF - auto end = line_reader.ptr() + line_reader.size() - 2; + if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; } + + // Exclude line terminator + auto end = line_reader.ptr() + line_reader.size() - line_terminator_len; parse_header(line_reader.ptr(), end, - [&](std::string &&key, std::string &&val) { - headers.emplace(std::move(key), std::move(val)); + [&](const std::string &key, const std::string &val) { + headers.emplace(key, val); }); } @@ -2701,11 +4073,7 @@ inline bool read_content_without_length(Stream &strm, uint64_t r = 0; for (;;) { auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ); - if (n < 0) { - return false; - } else if (n == 0) { - return true; - } + if (n <= 0) { return true; } if (!out(buf, static_cast(n), r, 0)) { return false; } r += static_cast(n); @@ -2714,7 +4082,8 @@ inline bool read_content_without_length(Stream &strm, return true; } -inline bool read_content_chunked(Stream &strm, +template +inline bool read_content_chunked(Stream &strm, T &x, ContentReceiverWithProgress out) { const auto bufsiz = 16; char buf[bufsiz]; @@ -2740,23 +4109,37 @@ inline bool read_content_chunked(Stream &strm, if (!line_reader.getline()) { return false; } - if (strcmp(line_reader.ptr(), "\r\n")) { break; } + if (strcmp(line_reader.ptr(), "\r\n") != 0) { return false; } if (!line_reader.getline()) { return false; } } - if (chunk_len == 0) { - // Reader terminator after chunks - if (!line_reader.getline() || strcmp(line_reader.ptr(), "\r\n")) - return false; + assert(chunk_len == 0); + + // Trailer + if (!line_reader.getline()) { return false; } + + while (strcmp(line_reader.ptr(), "\r\n") != 0) { + if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; } + + // Exclude line terminator + constexpr auto line_terminator_len = 2; + auto end = line_reader.ptr() + line_reader.size() - line_terminator_len; + + parse_header(line_reader.ptr(), end, + [&](const std::string &key, const std::string &val) { + x.headers.emplace(key, val); + }); + + if (!line_reader.getline()) { return false; } } return true; } inline bool is_chunked_transfer_encoding(const Headers &headers) { - return !strcasecmp(get_header_value(headers, "Transfer-Encoding", 0, ""), - "chunked"); + return compare_case_ignore( + get_header_value(headers, "Transfer-Encoding", 0, ""), "chunked"); } template @@ -2767,19 +4150,18 @@ bool prepare_content_receiver(T &x, int &status, std::string encoding = x.get_header_value("Content-Encoding"); std::unique_ptr decompressor; - if (encoding.find("gzip") != std::string::npos || - encoding.find("deflate") != std::string::npos) { + if (encoding == "gzip" || encoding == "deflate") { #ifdef CPPHTTPLIB_ZLIB_SUPPORT decompressor = detail::make_unique(); #else - status = 415; + status = StatusCode::UnsupportedMediaType_415; return false; #endif } else if (encoding.find("br") != std::string::npos) { #ifdef CPPHTTPLIB_BROTLI_SUPPORT decompressor = detail::make_unique(); #else - status = 415; + status = StatusCode::UnsupportedMediaType_415; return false; #endif } @@ -2789,13 +4171,13 @@ bool prepare_content_receiver(T &x, int &status, ContentReceiverWithProgress out = [&](const char *buf, size_t n, uint64_t off, uint64_t len) { return decompressor->decompress(buf, n, - [&](const char *buf, size_t n) { - return receiver(buf, n, off, len); + [&](const char *buf2, size_t n2) { + return receiver(buf2, n2, off, len); }); }; return callback(std::move(out)); } else { - status = 500; + status = StatusCode::InternalServerError_500; return false; } } @@ -2819,11 +4201,11 @@ bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status, auto exceed_payload_max_length = false; if (is_chunked_transfer_encoding(x.headers)) { - ret = read_content_chunked(strm, out); + ret = read_content_chunked(strm, x, out); } else if (!has_header(x.headers, "Content-Length")) { ret = read_content_without_length(strm, out); } else { - auto len = get_header_value(x.headers, "Content-Length"); + auto len = get_header_value_u64(x.headers, "Content-Length", 0, 0); if (len > payload_max_length) { exceed_payload_max_length = true; skip_content_with_length(strm, len); @@ -2833,22 +4215,16 @@ bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status, } } - if (!ret) { status = exceed_payload_max_length ? 413 : 400; } + if (!ret) { + status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413 + : StatusCode::BadRequest_400; + } return ret; }); -} +} // namespace detail -template -inline ssize_t write_headers(Stream &strm, const T &info, - const Headers &headers) { +inline ssize_t write_headers(Stream &strm, const Headers &headers) { ssize_t write_len = 0; - for (const auto &x : info.headers) { - if (x.first == "EXCEPTION_WHAT") { continue; } - auto len = - strm.write_format("%s: %s\r\n", x.first.c_str(), x.second.c_str()); - if (len < 0) { return len; } - write_len += len; - } for (const auto &x : headers) { auto len = strm.write_format("%s: %s\r\n", x.first.c_str(), x.second.c_str()); @@ -2879,24 +4255,27 @@ inline bool write_content(Stream &strm, const ContentProvider &content_provider, auto ok = true; DataSink data_sink; - data_sink.write = [&](const char *d, size_t l) { + data_sink.write = [&](const char *d, size_t l) -> bool { if (ok) { - if (write_data(strm, d, l)) { + if (strm.is_writable() && write_data(strm, d, l)) { offset += l; } else { ok = false; } } + return ok; }; - data_sink.is_writable = [&](void) { return ok && strm.is_writable(); }; + data_sink.is_writable = [&]() -> bool { return strm.is_writable(); }; while (offset < end_offset && !is_shutting_down()) { - if (!content_provider(offset, end_offset - offset, data_sink)) { + if (!strm.is_writable()) { + error = Error::Write; + return false; + } else if (!content_provider(offset, end_offset - offset, data_sink)) { error = Error::Canceled; return false; - } - if (!ok) { + } else if (!ok) { error = Error::Write; return false; } @@ -2925,20 +4304,26 @@ write_content_without_length(Stream &strm, auto ok = true; DataSink data_sink; - data_sink.write = [&](const char *d, size_t l) { + data_sink.write = [&](const char *d, size_t l) -> bool { if (ok) { offset += l; - if (!write_data(strm, d, l)) { ok = false; } + if (!strm.is_writable() || !write_data(strm, d, l)) { ok = false; } } + return ok; }; - data_sink.done = [&](void) { data_available = false; }; + data_sink.is_writable = [&]() -> bool { return strm.is_writable(); }; - data_sink.is_writable = [&](void) { return ok && strm.is_writable(); }; + data_sink.done = [&](void) { data_available = false; }; while (data_available && !is_shutting_down()) { - if (!content_provider(offset, 0, data_sink)) { return false; } - if (!ok) { return false; } + if (!strm.is_writable()) { + return false; + } else if (!content_provider(offset, 0, data_sink)) { + return false; + } else if (!ok) { + return false; + } } return true; } @@ -2952,33 +4337,36 @@ write_content_chunked(Stream &strm, const ContentProvider &content_provider, auto ok = true; DataSink data_sink; - data_sink.write = [&](const char *d, size_t l) { - if (!ok) { return; } - - data_available = l > 0; - offset += l; - - std::string payload; - if (!compressor.compress(d, l, false, - [&](const char *data, size_t data_len) { - payload.append(data, data_len); - return true; - })) { - ok = false; - return; - } + data_sink.write = [&](const char *d, size_t l) -> bool { + if (ok) { + data_available = l > 0; + offset += l; - if (!payload.empty()) { - // Emit chunked response header and footer for each chunk - auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n"; - if (!write_data(strm, chunk.data(), chunk.size())) { + std::string payload; + if (compressor.compress(d, l, false, + [&](const char *data, size_t data_len) { + payload.append(data, data_len); + return true; + })) { + if (!payload.empty()) { + // Emit chunked response header and footer for each chunk + auto chunk = + from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n"; + if (!strm.is_writable() || + !write_data(strm, chunk.data(), chunk.size())) { + ok = false; + } + } + } else { ok = false; - return; } } + return ok; }; - data_sink.done = [&](void) { + data_sink.is_writable = [&]() -> bool { return strm.is_writable(); }; + + auto done_with_trailer = [&](const Headers *trailer) { if (!ok) { return; } data_available = false; @@ -2996,26 +4384,46 @@ write_content_chunked(Stream &strm, const ContentProvider &content_provider, if (!payload.empty()) { // Emit chunked response header and footer for each chunk auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n"; - if (!write_data(strm, chunk.data(), chunk.size())) { + if (!strm.is_writable() || + !write_data(strm, chunk.data(), chunk.size())) { ok = false; return; } } - static const std::string done_marker("0\r\n\r\n"); + static const std::string done_marker("0\r\n"); if (!write_data(strm, done_marker.data(), done_marker.size())) { ok = false; } + + // Trailer + if (trailer) { + for (const auto &kv : *trailer) { + std::string field_line = kv.first + ": " + kv.second + "\r\n"; + if (!write_data(strm, field_line.data(), field_line.size())) { + ok = false; + } + } + } + + static const std::string crlf("\r\n"); + if (!write_data(strm, crlf.data(), crlf.size())) { ok = false; } }; - data_sink.is_writable = [&](void) { return ok && strm.is_writable(); }; + data_sink.done = [&](void) { done_with_trailer(nullptr); }; + + data_sink.done_with_trailer = [&](const Headers &trailer) { + done_with_trailer(&trailer); + }; while (data_available && !is_shutting_down()) { - if (!content_provider(offset, 0, data_sink)) { + if (!strm.is_writable()) { + error = Error::Write; + return false; + } else if (!content_provider(offset, 0, data_sink)) { error = Error::Canceled; return false; - } - if (!ok) { + } else if (!ok) { error = Error::Write; return false; } @@ -3035,14 +4443,15 @@ inline bool write_content_chunked(Stream &strm, } template -inline bool redirect(T &cli, const Request &req, Response &res, +inline bool redirect(T &cli, Request &req, Response &res, const std::string &path, const std::string &location, Error &error) { Request new_req = req; new_req.path = path; new_req.redirect_count_ -= 1; - if (res.status == 303 && (req.method != "GET" && req.method != "HEAD")) { + if (res.status == StatusCode::SeeOther_303 && + (req.method != "GET" && req.method != "HEAD")) { new_req.method = "GET"; new_req.body.clear(); new_req.headers.clear(); @@ -3052,26 +4461,71 @@ inline bool redirect(T &cli, const Request &req, Response &res, auto ret = cli.send(new_req, new_res, error); if (ret) { - new_res.location = location; + req = new_req; res = new_res; + + if (res.location.empty()) { res.location = location; } } return ret; } -inline std::string params_to_query_str(const Params ¶ms) { - std::string query; +inline std::string params_to_query_str(const Params ¶ms) { + std::string query; + + for (auto it = params.begin(); it != params.end(); ++it) { + if (it != params.begin()) { query += "&"; } + query += it->first; + query += "="; + query += encode_query_param(it->second); + } + return query; +} + +inline void parse_query_text(const char *data, std::size_t size, + Params ¶ms) { + std::set cache; + split(data, data + size, '&', [&](const char *b, const char *e) { + std::string kv(b, e); + if (cache.find(kv) != cache.end()) { return; } + cache.insert(std::move(kv)); + + std::string key; + std::string val; + divide(b, static_cast(e - b), '=', + [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data, + std::size_t rhs_size) { + key.assign(lhs_data, lhs_size); + val.assign(rhs_data, rhs_size); + }); + + if (!key.empty()) { + params.emplace(decode_url(key, true), decode_url(val, true)); + } + }); +} + +inline void parse_query_text(const std::string &s, Params ¶ms) { + parse_query_text(s.data(), s.size(), params); +} - for (auto it = params.begin(); it != params.end(); ++it) { - if (it != params.begin()) { query += "&"; } - query += it->first; - query += "="; - query += encode_query_param(it->second); - } - return query; +inline bool parse_multipart_boundary(const std::string &content_type, + std::string &boundary) { + auto boundary_keyword = "boundary="; + auto pos = content_type.find(boundary_keyword); + if (pos == std::string::npos) { return false; } + auto end = content_type.find(';', pos); + auto beg = pos + strlen(boundary_keyword); + boundary = trim_double_quotes_copy(content_type.substr(beg, end - beg)); + return !boundary.empty(); } -inline void parse_query_text(const std::string &s, Params ¶ms) { - split(s.data(), s.data() + s.size(), '&', [&](const char *b, const char *e) { +inline void parse_disposition_params(const std::string &s, Params ¶ms) { + std::set cache; + split(s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) { + std::string kv(b, e); + if (cache.find(kv) != cache.end()) { return; } + cache.insert(kv); + std::string key; std::string val; split(b, e, '=', [&](const char *b2, const char *e2) { @@ -3083,86 +4537,87 @@ inline void parse_query_text(const std::string &s, Params ¶ms) { }); if (!key.empty()) { - params.emplace(decode_url(key, true), decode_url(val, true)); + params.emplace(trim_double_quotes_copy((key)), + trim_double_quotes_copy((val))); } }); } -inline bool parse_multipart_boundary(const std::string &content_type, - std::string &boundary) { - auto pos = content_type.find("boundary="); - if (pos == std::string::npos) { return false; } - boundary = content_type.substr(pos + 9); - if (boundary.length() >= 2 && boundary.front() == '"' && - boundary.back() == '"') { - boundary = boundary.substr(1, boundary.size() - 2); - } - return !boundary.empty(); -} - +#ifdef CPPHTTPLIB_NO_EXCEPTIONS +inline bool parse_range_header(const std::string &s, Ranges &ranges) { +#else inline bool parse_range_header(const std::string &s, Ranges &ranges) try { - static auto re_first_range = std::regex(R"(bytes=(\d*-\d*(?:,\s*\d*-\d*)*))"); - std::smatch m; - if (std::regex_match(s, m, re_first_range)) { - auto pos = static_cast(m.position(1)); - auto len = static_cast(m.length(1)); - bool all_valid_ranges = true; +#endif + auto is_valid = [](const std::string &str) { + return std::all_of(str.cbegin(), str.cend(), + [](unsigned char c) { return std::isdigit(c); }); + }; + + if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) { + const auto pos = static_cast(6); + const auto len = static_cast(s.size() - 6); + auto all_valid_ranges = true; split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) { - if (!all_valid_ranges) return; - static auto re_another_range = std::regex(R"(\s*(\d*)-(\d*))"); - std::cmatch cm; - if (std::regex_match(b, e, cm, re_another_range)) { - ssize_t first = -1; - if (!cm.str(1).empty()) { - first = static_cast(std::stoll(cm.str(1))); - } + if (!all_valid_ranges) { return; } - ssize_t last = -1; - if (!cm.str(2).empty()) { - last = static_cast(std::stoll(cm.str(2))); - } + const auto it = std::find(b, e, '-'); + if (it == e) { + all_valid_ranges = false; + return; + } - if (first != -1 && last != -1 && first > last) { - all_valid_ranges = false; - return; - } - ranges.emplace_back(std::make_pair(first, last)); + const auto lhs = std::string(b, it); + const auto rhs = std::string(it + 1, e); + if (!is_valid(lhs) || !is_valid(rhs)) { + all_valid_ranges = false; + return; } + + const auto first = + static_cast(lhs.empty() ? -1 : std::stoll(lhs)); + const auto last = + static_cast(rhs.empty() ? -1 : std::stoll(rhs)); + if ((first == -1 && last == -1) || + (first != -1 && last != -1 && first > last)) { + all_valid_ranges = false; + return; + } + + ranges.emplace_back(first, last); }); - return all_valid_ranges; + return all_valid_ranges && !ranges.empty(); } return false; +#ifdef CPPHTTPLIB_NO_EXCEPTIONS +} +#else } catch (...) { return false; } +#endif class MultipartFormDataParser { public: MultipartFormDataParser() = default; - void set_boundary(std::string &&boundary) { boundary_ = boundary; } + void set_boundary(std::string &&boundary) { + boundary_ = boundary; + dash_boundary_crlf_ = dash_ + boundary_ + crlf_; + crlf_dash_boundary_ = crlf_ + dash_ + boundary_; + } bool is_valid() const { return is_valid_; } bool parse(const char *buf, size_t n, const ContentReceiver &content_callback, const MultipartContentHeader &header_callback) { - static const std::regex re_content_disposition( - "^Content-Disposition:\\s*form-data;\\s*name=\"(.*?)\"(?:;\\s*filename=" - "\"(.*?)\")?\\s*$", - std::regex_constants::icase); - static const std::string dash_ = "--"; - static const std::string crlf_ = "\r\n"; + buf_append(buf, n); - buf_.append(buf, n); // TODO: performance improvement - - while (!buf_.empty()) { + while (buf_size() > 0) { switch (state_) { case 0: { // Initial boundary - auto pattern = dash_ + boundary_ + crlf_; - if (pattern.size() > buf_.size()) { return true; } - auto pos = buf_.find(pattern); - if (pos != 0) { return false; } - buf_.erase(0, pattern.size()); - off_ += pattern.size(); + buf_erase(buf_find(dash_boundary_crlf_)); + if (dash_boundary_crlf_.size() > buf_size()) { return true; } + if (!buf_start_with(dash_boundary_crlf_)) { return false; } + buf_erase(dash_boundary_crlf_.size()); state_ = 1; break; } @@ -3172,104 +4627,116 @@ class MultipartFormDataParser { break; } case 2: { // Headers - auto pos = buf_.find(crlf_); - while (pos != std::string::npos) { + auto pos = buf_find(crlf_); + if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; } + while (pos < buf_size()) { // Empty line if (pos == 0) { if (!header_callback(file_)) { is_valid_ = false; return false; } - buf_.erase(0, crlf_.size()); - off_ += crlf_.size(); + buf_erase(crlf_.size()); state_ = 3; break; } - static const std::string header_name = "content-type:"; - const auto header = buf_.substr(0, pos); - if (start_with_case_ignore(header, header_name)) { - file_.content_type = trim_copy(header.substr(header_name.size())); + const auto header = buf_head(pos); + + if (!parse_header(header.data(), header.data() + header.size(), + [&](const std::string &, const std::string &) {})) { + is_valid_ = false; + return false; + } + + static const std::string header_content_type = "Content-Type:"; + + if (start_with_case_ignore(header, header_content_type)) { + file_.content_type = + trim_copy(header.substr(header_content_type.size())); } else { + static const std::regex re_content_disposition( + R"~(^Content-Disposition:\s*form-data;\s*(.*)$)~", + std::regex_constants::icase); + std::smatch m; if (std::regex_match(header, m, re_content_disposition)) { - file_.name = m[1]; - file_.filename = m[2]; + Params params; + parse_disposition_params(m[1], params); + + auto it = params.find("name"); + if (it != params.end()) { + file_.name = it->second; + } else { + is_valid_ = false; + return false; + } + + it = params.find("filename"); + if (it != params.end()) { file_.filename = it->second; } + + it = params.find("filename*"); + if (it != params.end()) { + // Only allow UTF-8 enconnding... + static const std::regex re_rfc5987_encoding( + R"~(^UTF-8''(.+?)$)~", std::regex_constants::icase); + + std::smatch m2; + if (std::regex_match(it->second, m2, re_rfc5987_encoding)) { + file_.filename = decode_url(m2[1], false); // override... + } else { + is_valid_ = false; + return false; + } + } } } - - buf_.erase(0, pos + crlf_.size()); - off_ += pos + crlf_.size(); - pos = buf_.find(crlf_); + buf_erase(pos + crlf_.size()); + pos = buf_find(crlf_); } if (state_ != 3) { return true; } break; } case 3: { // Body - { - auto pattern = crlf_ + dash_; - if (pattern.size() > buf_.size()) { return true; } - - auto pos = find_string(buf_, pattern); - - if (!content_callback(buf_.data(), pos)) { + if (crlf_dash_boundary_.size() > buf_size()) { return true; } + auto pos = buf_find(crlf_dash_boundary_); + if (pos < buf_size()) { + if (!content_callback(buf_data(), pos)) { is_valid_ = false; return false; } - - off_ += pos; - buf_.erase(0, pos); - } - { - auto pattern = crlf_ + dash_ + boundary_; - if (pattern.size() > buf_.size()) { return true; } - - auto pos = buf_.find(pattern); - if (pos != std::string::npos) { - if (!content_callback(buf_.data(), pos)) { - is_valid_ = false; - return false; - } - - off_ += pos + pattern.size(); - buf_.erase(0, pos + pattern.size()); - state_ = 4; - } else { - if (!content_callback(buf_.data(), pattern.size())) { + buf_erase(pos + crlf_dash_boundary_.size()); + state_ = 4; + } else { + auto len = buf_size() - crlf_dash_boundary_.size(); + if (len > 0) { + if (!content_callback(buf_data(), len)) { is_valid_ = false; return false; } - - off_ += pattern.size(); - buf_.erase(0, pattern.size()); + buf_erase(len); } + return true; } break; } case 4: { // Boundary - if (crlf_.size() > buf_.size()) { return true; } - if (buf_.compare(0, crlf_.size(), crlf_) == 0) { - buf_.erase(0, crlf_.size()); - off_ += crlf_.size(); + if (crlf_.size() > buf_size()) { return true; } + if (buf_start_with(crlf_)) { + buf_erase(crlf_.size()); state_ = 1; } else { - auto pattern = dash_ + crlf_; - if (pattern.size() > buf_.size()) { return true; } - if (buf_.compare(0, pattern.size(), pattern) == 0) { - buf_.erase(0, pattern.size()); - off_ += pattern.size(); + if (dash_.size() > buf_size()) { return true; } + if (buf_start_with(dash_)) { + buf_erase(dash_.size()); is_valid_ = true; - state_ = 5; + buf_erase(buf_size()); // Remove epilogue } else { return true; } } break; } - case 5: { // Done - is_valid_ = false; - return false; - } } } @@ -3292,41 +4759,82 @@ class MultipartFormDataParser { return true; } - bool start_with(const std::string &a, size_t off, + const std::string dash_ = "--"; + const std::string crlf_ = "\r\n"; + std::string boundary_; + std::string dash_boundary_crlf_; + std::string crlf_dash_boundary_; + + size_t state_ = 0; + bool is_valid_ = false; + MultipartFormData file_; + + // Buffer + bool start_with(const std::string &a, size_t spos, size_t epos, const std::string &b) const { - if (a.size() - off < b.size()) { return false; } + if (epos - spos < b.size()) { return false; } for (size_t i = 0; i < b.size(); i++) { - if (a[i + off] != b[i]) { return false; } + if (a[i + spos] != b[i]) { return false; } } return true; } - size_t find_string(const std::string &s, const std::string &pattern) const { - auto c = pattern.front(); + size_t buf_size() const { return buf_epos_ - buf_spos_; } + + const char *buf_data() const { return &buf_[buf_spos_]; } + + std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); } + + bool buf_start_with(const std::string &s) const { + return start_with(buf_, buf_spos_, buf_epos_, s); + } + + size_t buf_find(const std::string &s) const { + auto c = s.front(); - size_t off = 0; - while (off < s.size()) { - auto pos = s.find(c, off); - if (pos == std::string::npos) { return s.size(); } + size_t off = buf_spos_; + while (off < buf_epos_) { + auto pos = off; + while (true) { + if (pos == buf_epos_) { return buf_size(); } + if (buf_[pos] == c) { break; } + pos++; + } - auto rem = s.size() - pos; - if (pattern.size() > rem) { return pos; } + auto remaining_size = buf_epos_ - pos; + if (s.size() > remaining_size) { return buf_size(); } - if (start_with(s, pos, pattern)) { return pos; } + if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; } off = pos + 1; } - return s.size(); + return buf_size(); } - std::string boundary_; + void buf_append(const char *data, size_t n) { + auto remaining_size = buf_size(); + if (remaining_size > 0 && buf_spos_ > 0) { + for (size_t i = 0; i < remaining_size; i++) { + buf_[i] = buf_[buf_spos_ + i]; + } + } + buf_spos_ = 0; + buf_epos_ = remaining_size; + + if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); } + + for (size_t i = 0; i < n; i++) { + buf_[buf_epos_ + i] = data[i]; + } + buf_epos_ += n; + } + + void buf_erase(size_t size) { buf_spos_ += size; } std::string buf_; - size_t state_ = 0; - bool is_valid_ = false; - size_t off_ = 0; - MultipartFormData file_; + size_t buf_spos_ = 0; + size_t buf_epos_ = 0; }; inline std::string to_lower(const char *beg, const char *end) { @@ -3339,64 +4847,174 @@ inline std::string to_lower(const char *beg, const char *end) { return out; } -inline std::string make_multipart_data_boundary() { +inline std::string random_string(size_t length) { static const char data[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"; // std::random_device might actually be deterministic on some // platforms, but due to lack of support in the c++ standard library, // doing better requires either some ugly hacks or breaking portability. - std::random_device seed_gen; + static std::random_device seed_gen; + // Request 128 bits of entropy for initialization - std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()}; - std::mt19937 engine(seed_sequence); + static std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), + seed_gen()}; - std::string result = "--cpp-httplib-multipart-data-"; + static std::mt19937 engine(seed_sequence); - for (auto i = 0; i < 16; i++) { + std::string result; + for (size_t i = 0; i < length; i++) { result += data[engine() % (sizeof(data) - 1)]; } - return result; } -inline std::pair -get_range_offset_and_length(const Request &req, size_t content_length, - size_t index) { - auto r = req.ranges[index]; +inline std::string make_multipart_data_boundary() { + return "--cpp-httplib-multipart-data-" + detail::random_string(16); +} + +inline bool is_multipart_boundary_chars_valid(const std::string &boundary) { + auto valid = true; + for (size_t i = 0; i < boundary.size(); i++) { + auto c = boundary[i]; + if (!std::isalnum(c) && c != '-' && c != '_') { + valid = false; + break; + } + } + return valid; +} + +template +inline std::string +serialize_multipart_formdata_item_begin(const T &item, + const std::string &boundary) { + std::string body = "--" + boundary + "\r\n"; + body += "Content-Disposition: form-data; name=\"" + item.name + "\""; + if (!item.filename.empty()) { + body += "; filename=\"" + item.filename + "\""; + } + body += "\r\n"; + if (!item.content_type.empty()) { + body += "Content-Type: " + item.content_type + "\r\n"; + } + body += "\r\n"; - if (r.first == -1 && r.second == -1) { - return std::make_pair(0, content_length); + return body; +} + +inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; } + +inline std::string +serialize_multipart_formdata_finish(const std::string &boundary) { + return "--" + boundary + "--\r\n"; +} + +inline std::string +serialize_multipart_formdata_get_content_type(const std::string &boundary) { + return "multipart/form-data; boundary=" + boundary; +} + +inline std::string +serialize_multipart_formdata(const MultipartFormDataItems &items, + const std::string &boundary, bool finish = true) { + std::string body; + + for (const auto &item : items) { + body += serialize_multipart_formdata_item_begin(item, boundary); + body += item.content + serialize_multipart_formdata_item_end(); } - auto slen = static_cast(content_length); + if (finish) { body += serialize_multipart_formdata_finish(boundary); } + + return body; +} + +inline bool range_error(Request &req, Response &res) { + if (!req.ranges.empty() && 200 <= res.status && res.status < 300) { + ssize_t contant_len = static_cast( + res.content_length_ ? res.content_length_ : res.body.size()); + + ssize_t prev_first_pos = -1; + ssize_t prev_last_pos = -1; + size_t overwrapping_count = 0; + + // NOTE: The following Range check is based on '14.2. Range' in RFC 9110 + // 'HTTP Semantics' to avoid potential denial-of-service attacks. + // https://www.rfc-editor.org/rfc/rfc9110#section-14.2 + + // Too many ranges + if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; } - if (r.first == -1) { - r.first = (std::max)(static_cast(0), slen - r.second); - r.second = slen - 1; + for (auto &r : req.ranges) { + auto &first_pos = r.first; + auto &last_pos = r.second; + + if (first_pos == -1 && last_pos == -1) { + first_pos = 0; + last_pos = contant_len; + } + + if (first_pos == -1) { + first_pos = contant_len - last_pos; + last_pos = contant_len - 1; + } + + if (last_pos == -1) { last_pos = contant_len - 1; } + + // Range must be within content length + if (!(0 <= first_pos && first_pos <= last_pos && + last_pos <= contant_len - 1)) { + return true; + } + + // Ranges must be in ascending order + if (first_pos <= prev_first_pos) { return true; } + + // Request must not have more than two overlapping ranges + if (first_pos <= prev_last_pos) { + overwrapping_count++; + if (overwrapping_count > 2) { return true; } + } + + prev_first_pos = (std::max)(prev_first_pos, first_pos); + prev_last_pos = (std::max)(prev_last_pos, last_pos); + } } - if (r.second == -1) { r.second = slen - 1; } + return false; +} + +inline std::pair +get_range_offset_and_length(Range r, size_t content_length) { + assert(r.first != -1 && r.second != -1); + assert(0 <= r.first && r.first < static_cast(content_length)); + assert(r.first <= r.second && + r.second < static_cast(content_length)); + (void)(content_length); return std::make_pair(r.first, static_cast(r.second - r.first) + 1); } -inline std::string make_content_range_header_field(size_t offset, size_t length, - size_t content_length) { +inline std::string make_content_range_header_field( + const std::pair &offset_and_length, size_t content_length) { + auto st = offset_and_length.first; + auto ed = st + offset_and_length.second - 1; + std::string field = "bytes "; - field += std::to_string(offset); + field += std::to_string(st); field += "-"; - field += std::to_string(offset + length - 1); + field += std::to_string(ed); field += "/"; field += std::to_string(content_length); return field; } template -bool process_multipart_ranges_data(const Request &req, Response &res, +bool process_multipart_ranges_data(const Request &req, const std::string &boundary, const std::string &content_type, - SToken stoken, CToken ctoken, - Content content) { + size_t content_length, SToken stoken, + CToken ctoken, Content content) { for (size_t i = 0; i < req.ranges.size(); i++) { ctoken("--"); stoken(boundary); @@ -3407,52 +5025,53 @@ bool process_multipart_ranges_data(const Request &req, Response &res, ctoken("\r\n"); } - auto offsets = get_range_offset_and_length(req, res.body.size(), i); - auto offset = offsets.first; - auto length = offsets.second; + auto offset_and_length = + get_range_offset_and_length(req.ranges[i], content_length); ctoken("Content-Range: "); - stoken(make_content_range_header_field(offset, length, res.body.size())); + stoken(make_content_range_header_field(offset_and_length, content_length)); ctoken("\r\n"); ctoken("\r\n"); - if (!content(offset, length)) { return false; } + + if (!content(offset_and_length.first, offset_and_length.second)) { + return false; + } ctoken("\r\n"); } ctoken("--"); stoken(boundary); - ctoken("--\r\n"); + ctoken("--"); return true; } -inline bool make_multipart_ranges_data(const Request &req, Response &res, +inline void make_multipart_ranges_data(const Request &req, Response &res, const std::string &boundary, const std::string &content_type, + size_t content_length, std::string &data) { - return process_multipart_ranges_data( - req, res, boundary, content_type, + process_multipart_ranges_data( + req, boundary, content_type, content_length, + [&](const std::string &token) { data += token; }, [&](const std::string &token) { data += token; }, - [&](const char *token) { data += token; }, [&](size_t offset, size_t length) { - if (offset < res.body.size()) { - data += res.body.substr(offset, length); - return true; - } - return false; + assert(offset + length <= content_length); + data += res.body.substr(offset, length); + return true; }); } -inline size_t -get_multipart_ranges_data_length(const Request &req, Response &res, - const std::string &boundary, - const std::string &content_type) { +inline size_t get_multipart_ranges_data_length(const Request &req, + const std::string &boundary, + const std::string &content_type, + size_t content_length) { size_t data_length = 0; process_multipart_ranges_data( - req, res, boundary, content_type, + req, boundary, content_type, content_length, + [&](const std::string &token) { data_length += token.size(); }, [&](const std::string &token) { data_length += token.size(); }, - [&](const char *token) { data_length += strlen(token); }, [&](size_t /*offset*/, size_t length) { data_length += length; return true; @@ -3462,33 +5081,21 @@ get_multipart_ranges_data_length(const Request &req, Response &res, } template -inline bool write_multipart_ranges_data(Stream &strm, const Request &req, - Response &res, - const std::string &boundary, - const std::string &content_type, - const T &is_shutting_down) { +inline bool +write_multipart_ranges_data(Stream &strm, const Request &req, Response &res, + const std::string &boundary, + const std::string &content_type, + size_t content_length, const T &is_shutting_down) { return process_multipart_ranges_data( - req, res, boundary, content_type, + req, boundary, content_type, content_length, + [&](const std::string &token) { strm.write(token); }, [&](const std::string &token) { strm.write(token); }, - [&](const char *token) { strm.write(token); }, [&](size_t offset, size_t length) { return write_content(strm, res.content_provider_, offset, length, is_shutting_down); }); } -inline std::pair -get_range_offset_and_length(const Request &req, const Response &res, - size_t index) { - auto r = req.ranges[index]; - - if (r.second == -1) { - r.second = static_cast(res.content_length_) - 1; - } - - return std::make_pair(r.first, r.second - r.first + 1); -} - inline bool expect_content(const Request &req) { if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" || req.method == "PRI" || req.method == "DELETE") { @@ -3498,8 +5105,8 @@ inline bool expect_content(const Request &req) { return false; } -inline bool has_crlf(const char *s) { - auto p = s; +inline bool has_crlf(const std::string &s) { + auto p = s.c_str(); while (*p) { if (*p == '\r' || *p == '\n') { return true; } p++; @@ -3508,52 +5115,51 @@ inline bool has_crlf(const char *s) { } #ifdef CPPHTTPLIB_OPENSSL_SUPPORT -template -inline std::string message_digest(const std::string &s, Init init, - Update update, Final final, - size_t digest_length) { - using namespace std; - - std::vector md(digest_length, 0); - CTX ctx; - init(&ctx); - update(&ctx, s.data(), s.size()); - final(md.data(), &ctx); - - stringstream ss; - for (auto c : md) { - ss << setfill('0') << setw(2) << hex << (unsigned int)c; +inline std::string message_digest(const std::string &s, const EVP_MD *algo) { + auto context = std::unique_ptr( + EVP_MD_CTX_new(), EVP_MD_CTX_free); + + unsigned int hash_length = 0; + unsigned char hash[EVP_MAX_MD_SIZE]; + + EVP_DigestInit_ex(context.get(), algo, nullptr); + EVP_DigestUpdate(context.get(), s.c_str(), s.size()); + EVP_DigestFinal_ex(context.get(), hash, &hash_length); + + std::stringstream ss; + for (auto i = 0u; i < hash_length; ++i) { + ss << std::hex << std::setw(2) << std::setfill('0') + << static_cast(hash[i]); } + return ss.str(); } inline std::string MD5(const std::string &s) { - return message_digest(s, MD5_Init, MD5_Update, MD5_Final, - MD5_DIGEST_LENGTH); + return message_digest(s, EVP_md5()); } inline std::string SHA_256(const std::string &s) { - return message_digest(s, SHA256_Init, SHA256_Update, SHA256_Final, - SHA256_DIGEST_LENGTH); + return message_digest(s, EVP_sha256()); } inline std::string SHA_512(const std::string &s) { - return message_digest(s, SHA512_Init, SHA512_Update, SHA512_Final, - SHA512_DIGEST_LENGTH); + return message_digest(s, EVP_sha512()); } #endif -#ifdef _WIN32 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT +#ifdef _WIN32 // NOTE: This code came up with the following stackoverflow post: // https://stackoverflow.com/questions/9507184/can-openssl-on-windows-use-the-system-certificate-store inline bool load_system_certs_on_windows(X509_STORE *store) { auto hStore = CertOpenSystemStoreW((HCRYPTPROV_LEGACY)NULL, L"ROOT"); - if (!hStore) { return false; } + auto result = false; PCCERT_CONTEXT pContext = NULL; - while (pContext = CertEnumCertificatesInStore(hStore, pContext)) { + while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) != + nullptr) { auto encoded_cert = static_cast(pContext->pbCertEncoded); @@ -3561,24 +5167,121 @@ inline bool load_system_certs_on_windows(X509_STORE *store) { if (x509) { X509_STORE_add_cert(store, x509); X509_free(x509); + result = true; } } CertFreeCertificateContext(pContext); CertCloseStore(hStore, 0); + return result; +} +#elif defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && defined(__APPLE__) +#if TARGET_OS_OSX +template +using CFObjectPtr = + std::unique_ptr::type, void (*)(CFTypeRef)>; + +inline void cf_object_ptr_deleter(CFTypeRef obj) { + if (obj) { CFRelease(obj); } +} + +inline bool retrieve_certs_from_keychain(CFObjectPtr &certs) { + CFStringRef keys[] = {kSecClass, kSecMatchLimit, kSecReturnRef}; + CFTypeRef values[] = {kSecClassCertificate, kSecMatchLimitAll, + kCFBooleanTrue}; + + CFObjectPtr query( + CFDictionaryCreate(nullptr, reinterpret_cast(keys), values, + sizeof(keys) / sizeof(keys[0]), + &kCFTypeDictionaryKeyCallBacks, + &kCFTypeDictionaryValueCallBacks), + cf_object_ptr_deleter); + + if (!query) { return false; } + + CFTypeRef security_items = nullptr; + if (SecItemCopyMatching(query.get(), &security_items) != errSecSuccess || + CFArrayGetTypeID() != CFGetTypeID(security_items)) { + return false; + } + + certs.reset(reinterpret_cast(security_items)); return true; } -#endif +inline bool retrieve_root_certs_from_keychain(CFObjectPtr &certs) { + CFArrayRef root_security_items = nullptr; + if (SecTrustCopyAnchorCertificates(&root_security_items) != errSecSuccess) { + return false; + } + + certs.reset(root_security_items); + return true; +} + +inline bool add_certs_to_x509_store(CFArrayRef certs, X509_STORE *store) { + auto result = false; + for (auto i = 0; i < CFArrayGetCount(certs); ++i) { + const auto cert = reinterpret_cast( + CFArrayGetValueAtIndex(certs, i)); + + if (SecCertificateGetTypeID() != CFGetTypeID(cert)) { continue; } + + CFDataRef cert_data = nullptr; + if (SecItemExport(cert, kSecFormatX509Cert, 0, nullptr, &cert_data) != + errSecSuccess) { + continue; + } + + CFObjectPtr cert_data_ptr(cert_data, cf_object_ptr_deleter); + + auto encoded_cert = static_cast( + CFDataGetBytePtr(cert_data_ptr.get())); + + auto x509 = + d2i_X509(NULL, &encoded_cert, CFDataGetLength(cert_data_ptr.get())); + + if (x509) { + X509_STORE_add_cert(store, x509); + X509_free(x509); + result = true; + } + } + + return result; +} + +inline bool load_system_certs_on_macos(X509_STORE *store) { + auto result = false; + CFObjectPtr certs(nullptr, cf_object_ptr_deleter); + if (retrieve_certs_from_keychain(certs) && certs) { + result = add_certs_to_x509_store(certs.get(), store); + } + + if (retrieve_root_certs_from_keychain(certs) && certs) { + result = add_certs_to_x509_store(certs.get(), store) || result; + } + + return result; +} +#endif // TARGET_OS_OSX +#endif // _WIN32 +#endif // CPPHTTPLIB_OPENSSL_SUPPORT + +#ifdef _WIN32 class WSInit { public: WSInit() { WSADATA wsaData; - WSAStartup(0x0002, &wsaData); + if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true; + } + + ~WSInit() { + if (is_valid_) WSACleanup(); } - ~WSInit() { WSACleanup(); } + bool is_valid_ = false; }; static WSInit wsinit_; @@ -3589,45 +5292,57 @@ inline std::pair make_digest_authentication_header( const Request &req, const std::map &auth, size_t cnonce_count, const std::string &cnonce, const std::string &username, const std::string &password, bool is_proxy = false) { - using namespace std; - - string nc; + std::string nc; { - stringstream ss; - ss << setfill('0') << setw(8) << hex << cnonce_count; + std::stringstream ss; + ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count; nc = ss.str(); } - auto qop = auth.at("qop"); - if (qop.find("auth-int") != std::string::npos) { - qop = "auth-int"; - } else { - qop = "auth"; + std::string qop; + if (auth.find("qop") != auth.end()) { + qop = auth.at("qop"); + if (qop.find("auth-int") != std::string::npos) { + qop = "auth-int"; + } else if (qop.find("auth") != std::string::npos) { + qop = "auth"; + } else { + qop.clear(); + } } std::string algo = "MD5"; if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); } - string response; + std::string response; { - auto H = algo == "SHA-256" - ? detail::SHA_256 - : algo == "SHA-512" ? detail::SHA_512 : detail::MD5; + auto H = algo == "SHA-256" ? detail::SHA_256 + : algo == "SHA-512" ? detail::SHA_512 + : detail::MD5; auto A1 = username + ":" + auth.at("realm") + ":" + password; auto A2 = req.method + ":" + req.path; if (qop == "auth-int") { A2 += ":" + H(req.body); } - response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce + - ":" + qop + ":" + H(A2)); + if (qop.empty()) { + response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2)); + } else { + response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce + + ":" + qop + ":" + H(A2)); + } } + auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : ""; + auto field = "Digest username=\"" + username + "\", realm=\"" + auth.at("realm") + "\", nonce=\"" + auth.at("nonce") + "\", uri=\"" + req.path + "\", algorithm=" + algo + - ", qop=" + qop + ", nc=\"" + nc + "\", cnonce=\"" + cnonce + - "\", response=\"" + response + "\""; + (qop.empty() ? ", response=\"" + : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + + cnonce + "\", response=\"") + + response + "\"" + + (opaque.empty() ? "" : ", opaque=\"" + opaque + "\""); auto key = is_proxy ? "Proxy-Authorization" : "Authorization"; return std::make_pair(key, field); @@ -3650,7 +5365,7 @@ inline bool parse_www_authenticate(const Response &res, s = s.substr(pos + 1); auto beg = std::sregex_iterator(s.begin(), s.end(), re); for (auto i = beg; i != std::sregex_iterator(); ++i) { - auto m = *i; + const auto &m = *i; auto key = s.substr(static_cast(m.position(1)), static_cast(m.length(1))); auto val = m.length(2) > 0 @@ -3667,41 +5382,75 @@ inline bool parse_www_authenticate(const Response &res, return false; } -// https://stackoverflow.com/questions/440133/how-do-i-create-a-random-alpha-numeric-string-in-c/440240#answer-440240 -inline std::string random_string(size_t length) { - auto randchar = []() -> char { - const char charset[] = "0123456789" - "ABCDEFGHIJKLMNOPQRSTUVWXYZ" - "abcdefghijklmnopqrstuvwxyz"; - const size_t max_index = (sizeof(charset) - 1); - return charset[static_cast(rand()) % max_index]; - }; - std::string str(length, 0); - std::generate_n(str.begin(), length, randchar); - return str; -} - class ContentProviderAdapter { public: explicit ContentProviderAdapter( ContentProviderWithoutLength &&content_provider) : content_provider_(content_provider) {} - bool operator()(size_t offset, size_t, DataSink &sink) { - return content_provider_(offset, sink); + bool operator()(size_t offset, size_t, DataSink &sink) { + return content_provider_(offset, sink); + } + +private: + ContentProviderWithoutLength content_provider_; +}; + +} // namespace detail + +inline std::string hosted_at(const std::string &hostname) { + std::vector addrs; + hosted_at(hostname, addrs); + if (addrs.empty()) { return std::string(); } + return addrs[0]; +} + +inline void hosted_at(const std::string &hostname, + std::vector &addrs) { + struct addrinfo hints; + struct addrinfo *result; + + memset(&hints, 0, sizeof(struct addrinfo)); + hints.ai_family = AF_UNSPEC; + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = 0; + + if (getaddrinfo(hostname.c_str(), nullptr, &hints, &result)) { +#if defined __linux__ && !defined __ANDROID__ + res_init(); +#endif + return; + } + + for (auto rp = result; rp; rp = rp->ai_next) { + const auto &addr = + *reinterpret_cast(rp->ai_addr); + std::string ip; + auto dummy = -1; + if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip, + dummy)) { + addrs.push_back(ip); + } } -private: - ContentProviderWithoutLength content_provider_; -}; + freeaddrinfo(result); +} -} // namespace detail +inline std::string append_query_params(const std::string &path, + const Params ¶ms) { + std::string path_with_query = path; + const static std::regex re("[^?]+\\?.*"); + auto delm = std::regex_match(path, re) ? '&' : '?'; + path_with_query += delm + detail::params_to_query_str(params); + return path_with_query; +} // Header utilities -inline std::pair make_range_header(Ranges ranges) { +inline std::pair +make_range_header(const Ranges &ranges) { std::string field = "bytes="; auto i = 0; - for (auto r : ranges) { + for (const auto &r : ranges) { if (i != 0) { field += ", "; } if (r.first != -1) { field += std::to_string(r.first); } field += '-'; @@ -3713,8 +5462,7 @@ inline std::pair make_range_header(Ranges ranges) { inline std::pair make_basic_authentication_header(const std::string &username, - const std::string &password, - bool is_proxy = false) { + const std::string &password, bool is_proxy) { auto field = "Basic " + detail::base64_encode(username + ":" + password); auto key = is_proxy ? "Proxy-Authorization" : "Authorization"; return std::make_pair(key, std::move(field)); @@ -3729,41 +5477,33 @@ make_bearer_token_authentication_header(const std::string &token, } // Request implementation -inline bool Request::has_header(const char *key) const { +inline bool Request::has_header(const std::string &key) const { return detail::has_header(headers, key); } -inline std::string Request::get_header_value(const char *key, size_t id) const { +inline std::string Request::get_header_value(const std::string &key, + size_t id) const { return detail::get_header_value(headers, key, id, ""); } -template -inline T Request::get_header_value(const char *key, size_t id) const { - return detail::get_header_value(headers, key, id, 0); -} - -inline size_t Request::get_header_value_count(const char *key) const { +inline size_t Request::get_header_value_count(const std::string &key) const { auto r = headers.equal_range(key); return static_cast(std::distance(r.first, r.second)); } -inline void Request::set_header(const char *key, const char *val) { +inline void Request::set_header(const std::string &key, + const std::string &val) { if (!detail::has_crlf(key) && !detail::has_crlf(val)) { headers.emplace(key, val); } } -inline void Request::set_header(const char *key, const std::string &val) { - if (!detail::has_crlf(key) && !detail::has_crlf(val.c_str())) { - headers.emplace(key, val); - } -} - -inline bool Request::has_param(const char *key) const { +inline bool Request::has_param(const std::string &key) const { return params.find(key) != params.end(); } -inline std::string Request::get_param_value(const char *key, size_t id) const { +inline std::string Request::get_param_value(const std::string &key, + size_t id) const { auto rng = params.equal_range(key); auto it = rng.first; std::advance(it, static_cast(id)); @@ -3771,75 +5511,71 @@ inline std::string Request::get_param_value(const char *key, size_t id) const { return std::string(); } -inline size_t Request::get_param_value_count(const char *key) const { +inline size_t Request::get_param_value_count(const std::string &key) const { auto r = params.equal_range(key); return static_cast(std::distance(r.first, r.second)); } inline bool Request::is_multipart_form_data() const { const auto &content_type = get_header_value("Content-Type"); - return !content_type.find("multipart/form-data"); + return !content_type.rfind("multipart/form-data", 0); } -inline bool Request::has_file(const char *key) const { +inline bool Request::has_file(const std::string &key) const { return files.find(key) != files.end(); } -inline MultipartFormData Request::get_file_value(const char *key) const { +inline MultipartFormData Request::get_file_value(const std::string &key) const { auto it = files.find(key); if (it != files.end()) { return it->second; } return MultipartFormData(); } +inline std::vector +Request::get_file_values(const std::string &key) const { + std::vector values; + auto rng = files.equal_range(key); + for (auto it = rng.first; it != rng.second; it++) { + values.push_back(it->second); + } + return values; +} + // Response implementation -inline bool Response::has_header(const char *key) const { +inline bool Response::has_header(const std::string &key) const { return headers.find(key) != headers.end(); } -inline std::string Response::get_header_value(const char *key, +inline std::string Response::get_header_value(const std::string &key, size_t id) const { return detail::get_header_value(headers, key, id, ""); } -template -inline T Response::get_header_value(const char *key, size_t id) const { - return detail::get_header_value(headers, key, id, 0); -} - -inline size_t Response::get_header_value_count(const char *key) const { +inline size_t Response::get_header_value_count(const std::string &key) const { auto r = headers.equal_range(key); return static_cast(std::distance(r.first, r.second)); } -inline void Response::set_header(const char *key, const char *val) { +inline void Response::set_header(const std::string &key, + const std::string &val) { if (!detail::has_crlf(key) && !detail::has_crlf(val)) { headers.emplace(key, val); } } -inline void Response::set_header(const char *key, const std::string &val) { - if (!detail::has_crlf(key) && !detail::has_crlf(val.c_str())) { - headers.emplace(key, val); - } -} - -inline void Response::set_redirect(const char *url, int stat) { +inline void Response::set_redirect(const std::string &url, int stat) { if (!detail::has_crlf(url)) { set_header("Location", url); if (300 <= stat && stat < 400) { this->status = stat; } else { - this->status = 302; + this->status = StatusCode::Found_302; } } } -inline void Response::set_redirect(const std::string &url, int stat) { - set_redirect(url.c_str(), stat); -} - inline void Response::set_content(const char *s, size_t n, - const char *content_type) { + const std::string &content_type) { body.assign(s, n); auto rng = headers.equal_range("Content-Type"); @@ -3848,84 +5584,72 @@ inline void Response::set_content(const char *s, size_t n, } inline void Response::set_content(const std::string &s, - const char *content_type) { + const std::string &content_type) { set_content(s.data(), s.size(), content_type); } -inline void -Response::set_content_provider(size_t in_length, const char *content_type, - ContentProvider provider, - const std::function &resource_releaser) { - assert(in_length > 0); +inline void Response::set_content(std::string &&s, + const std::string &content_type) { + body = std::move(s); + + auto rng = headers.equal_range("Content-Type"); + headers.erase(rng.first, rng.second); + set_header("Content-Type", content_type); +} + +inline void Response::set_content_provider( + size_t in_length, const std::string &content_type, ContentProvider provider, + ContentProviderResourceReleaser resource_releaser) { set_header("Content-Type", content_type); content_length_ = in_length; - content_provider_ = std::move(provider); - content_provider_resource_releaser_ = resource_releaser; + if (in_length > 0) { content_provider_ = std::move(provider); } + content_provider_resource_releaser_ = std::move(resource_releaser); is_chunked_content_provider_ = false; } -inline void -Response::set_content_provider(const char *content_type, - ContentProviderWithoutLength provider, - const std::function &resource_releaser) { +inline void Response::set_content_provider( + const std::string &content_type, ContentProviderWithoutLength provider, + ContentProviderResourceReleaser resource_releaser) { set_header("Content-Type", content_type); content_length_ = 0; content_provider_ = detail::ContentProviderAdapter(std::move(provider)); - content_provider_resource_releaser_ = resource_releaser; + content_provider_resource_releaser_ = std::move(resource_releaser); is_chunked_content_provider_ = false; } inline void Response::set_chunked_content_provider( - const char *content_type, ContentProviderWithoutLength provider, - const std::function &resource_releaser) { + const std::string &content_type, ContentProviderWithoutLength provider, + ContentProviderResourceReleaser resource_releaser) { set_header("Content-Type", content_type); content_length_ = 0; content_provider_ = detail::ContentProviderAdapter(std::move(provider)); - content_provider_resource_releaser_ = resource_releaser; + content_provider_resource_releaser_ = std::move(resource_releaser); is_chunked_content_provider_ = true; } -// Rstream implementation -inline ssize_t Stream::write(const char *ptr) { - return write(ptr, strlen(ptr)); +// Result implementation +inline bool Result::has_request_header(const std::string &key) const { + return request_headers_.find(key) != request_headers_.end(); } -inline ssize_t Stream::write(const std::string &s) { - return write(s.data(), s.size()); +inline std::string Result::get_request_header_value(const std::string &key, + size_t id) const { + return detail::get_header_value(request_headers_, key, id, ""); } -template -inline ssize_t Stream::write_format(const char *fmt, const Args &... args) { - const auto bufsiz = 2048; - std::array buf; - -#if defined(_MSC_VER) && _MSC_VER < 1900 - auto sn = _snprintf_s(buf.data(), bufsiz - 1, buf.size() - 1, fmt, args...); -#else - auto sn = snprintf(buf.data(), buf.size() - 1, fmt, args...); -#endif - if (sn <= 0) { return sn; } - - auto n = static_cast(sn); +inline size_t +Result::get_request_header_value_count(const std::string &key) const { + auto r = request_headers_.equal_range(key); + return static_cast(std::distance(r.first, r.second)); +} - if (n >= buf.size() - 1) { - std::vector glowable_buf(buf.size()); +// Stream implementation +inline ssize_t Stream::write(const char *ptr) { + return write(ptr, strlen(ptr)); +} - while (n >= glowable_buf.size() - 1) { - glowable_buf.resize(glowable_buf.size() * 2); -#if defined(_MSC_VER) && _MSC_VER < 1900 - n = static_cast(_snprintf_s(&glowable_buf[0], glowable_buf.size(), - glowable_buf.size() - 1, fmt, - args...)); -#else - n = static_cast( - snprintf(&glowable_buf[0], glowable_buf.size() - 1, fmt, args...)); -#endif - } - return write(&glowable_buf[0], n); - } else { - return write(buf.data(), n); - } +inline ssize_t Stream::write(const std::string &s) { + return write(s.data(), s.size()); } namespace detail { @@ -3938,44 +5662,74 @@ inline SocketStream::SocketStream(socket_t sock, time_t read_timeout_sec, : sock_(sock), read_timeout_sec_(read_timeout_sec), read_timeout_usec_(read_timeout_usec), write_timeout_sec_(write_timeout_sec), - write_timeout_usec_(write_timeout_usec) {} + write_timeout_usec_(write_timeout_usec), read_buff_(read_buff_size_, 0) {} -inline SocketStream::~SocketStream() {} +inline SocketStream::~SocketStream() = default; inline bool SocketStream::is_readable() const { return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0; } inline bool SocketStream::is_writable() const { - return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0; + return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 && + is_socket_alive(sock_); } inline ssize_t SocketStream::read(char *ptr, size_t size) { - if (!is_readable()) { return -1; } - #ifdef _WIN32 - if (size > static_cast((std::numeric_limits::max)())) { - return -1; - } - return recv(sock_, ptr, static_cast(size), CPPHTTPLIB_RECV_FLAGS); + size = + (std::min)(size, static_cast((std::numeric_limits::max)())); #else - return handle_EINTR( - [&]() { return recv(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS); }); + size = (std::min)(size, + static_cast((std::numeric_limits::max)())); #endif + + if (read_buff_off_ < read_buff_content_size_) { + auto remaining_size = read_buff_content_size_ - read_buff_off_; + if (size <= remaining_size) { + memcpy(ptr, read_buff_.data() + read_buff_off_, size); + read_buff_off_ += size; + return static_cast(size); + } else { + memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size); + read_buff_off_ += remaining_size; + return static_cast(remaining_size); + } + } + + if (!is_readable()) { return -1; } + + read_buff_off_ = 0; + read_buff_content_size_ = 0; + + if (size < read_buff_size_) { + auto n = read_socket(sock_, read_buff_.data(), read_buff_size_, + CPPHTTPLIB_RECV_FLAGS); + if (n <= 0) { + return n; + } else if (n <= static_cast(size)) { + memcpy(ptr, read_buff_.data(), static_cast(n)); + return n; + } else { + memcpy(ptr, read_buff_.data(), size); + read_buff_off_ = size; + read_buff_content_size_ = static_cast(n); + return static_cast(size); + } + } else { + return read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS); + } } inline ssize_t SocketStream::write(const char *ptr, size_t size) { if (!is_writable()) { return -1; } -#ifdef _WIN32 - if (size > static_cast((std::numeric_limits::max)())) { - return -1; - } - return send(sock_, ptr, static_cast(size), CPPHTTPLIB_SEND_FLAGS); -#else - return handle_EINTR( - [&]() { return send(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS); }); +#if defined(_WIN32) && !defined(_WIN64) + size = + (std::min)(size, static_cast((std::numeric_limits::max)())); #endif + + return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS); } inline void SocketStream::get_remote_ip_and_port(std::string &ip, @@ -3983,6 +5737,11 @@ inline void SocketStream::get_remote_ip_and_port(std::string &ip, return detail::get_remote_ip_and_port(sock_, ip, port); } +inline void SocketStream::get_local_ip_and_port(std::string &ip, + int &port) const { + return detail::get_local_ip_and_port(sock_, ip, port); +} + inline socket_t SocketStream::socket() const { return sock_; } // Buffer stream implementation @@ -3991,7 +5750,7 @@ inline bool BufferStream::is_readable() const { return true; } inline bool BufferStream::is_writable() const { return true; } inline ssize_t BufferStream::read(char *ptr, size_t size) { -#if defined(_MSC_VER) && _MSC_VER <= 1900 +#if defined(_MSC_VER) && _MSC_VER < 1910 auto len_read = buffer._Copy_s(ptr, size, size, position); #else auto len_read = buffer.copy(ptr, size, position); @@ -4008,96 +5767,195 @@ inline ssize_t BufferStream::write(const char *ptr, size_t size) { inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/, int & /*port*/) const {} +inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/, + int & /*port*/) const {} + inline socket_t BufferStream::socket() const { return 0; } inline const std::string &BufferStream::get_buffer() const { return buffer; } +inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern) { + // One past the last ending position of a path param substring + std::size_t last_param_end = 0; + +#ifndef CPPHTTPLIB_NO_EXCEPTIONS + // Needed to ensure that parameter names are unique during matcher + // construction + // If exceptions are disabled, only last duplicate path + // parameter will be set + std::unordered_set param_name_set; +#endif + + while (true) { + const auto marker_pos = pattern.find(marker, last_param_end); + if (marker_pos == std::string::npos) { break; } + + static_fragments_.push_back( + pattern.substr(last_param_end, marker_pos - last_param_end)); + + const auto param_name_start = marker_pos + 1; + + auto sep_pos = pattern.find(separator, param_name_start); + if (sep_pos == std::string::npos) { sep_pos = pattern.length(); } + + auto param_name = + pattern.substr(param_name_start, sep_pos - param_name_start); + +#ifndef CPPHTTPLIB_NO_EXCEPTIONS + if (param_name_set.find(param_name) != param_name_set.cend()) { + std::string msg = "Encountered path parameter '" + param_name + + "' multiple times in route pattern '" + pattern + "'."; + throw std::invalid_argument(msg); + } +#endif + + param_names_.push_back(std::move(param_name)); + + last_param_end = sep_pos + 1; + } + + if (last_param_end < pattern.length()) { + static_fragments_.push_back(pattern.substr(last_param_end)); + } +} + +inline bool PathParamsMatcher::match(Request &request) const { + request.matches = std::smatch(); + request.path_params.clear(); + request.path_params.reserve(param_names_.size()); + + // One past the position at which the path matched the pattern last time + std::size_t starting_pos = 0; + for (size_t i = 0; i < static_fragments_.size(); ++i) { + const auto &fragment = static_fragments_[i]; + + if (starting_pos + fragment.length() > request.path.length()) { + return false; + } + + // Avoid unnecessary allocation by using strncmp instead of substr + + // comparison + if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(), + fragment.length()) != 0) { + return false; + } + + starting_pos += fragment.length(); + + // Should only happen when we have a static fragment after a param + // Example: '/users/:id/subscriptions' + // The 'subscriptions' fragment here does not have a corresponding param + if (i >= param_names_.size()) { continue; } + + auto sep_pos = request.path.find(separator, starting_pos); + if (sep_pos == std::string::npos) { sep_pos = request.path.length(); } + + const auto ¶m_name = param_names_[i]; + + request.path_params.emplace( + param_name, request.path.substr(starting_pos, sep_pos - starting_pos)); + + // Mark everythin up to '/' as matched + starting_pos = sep_pos + 1; + } + // Returns false if the path is longer than the pattern + return starting_pos >= request.path.length(); +} + +inline bool RegexMatcher::match(Request &request) const { + request.path_params.clear(); + return std::regex_match(request.path, request.matches, regex_); +} + } // namespace detail // HTTP server implementation inline Server::Server() : new_task_queue( - [] { return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT); }), - svr_sock_(INVALID_SOCKET), is_running_(false) { + [] { return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT); }) { #ifndef _WIN32 signal(SIGPIPE, SIG_IGN); #endif } -inline Server::~Server() {} +inline Server::~Server() = default; + +inline std::unique_ptr +Server::make_matcher(const std::string &pattern) { + if (pattern.find("/:") != std::string::npos) { + return detail::make_unique(pattern); + } else { + return detail::make_unique(pattern); + } +} -inline Server &Server::Get(const char *pattern, Handler handler) { - get_handlers_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); +inline Server &Server::Get(const std::string &pattern, Handler handler) { + get_handlers_.emplace_back(make_matcher(pattern), std::move(handler)); return *this; } -inline Server &Server::Post(const char *pattern, Handler handler) { - post_handlers_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); +inline Server &Server::Post(const std::string &pattern, Handler handler) { + post_handlers_.emplace_back(make_matcher(pattern), std::move(handler)); return *this; } -inline Server &Server::Post(const char *pattern, +inline Server &Server::Post(const std::string &pattern, HandlerWithContentReader handler) { - post_handlers_for_content_reader_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); + post_handlers_for_content_reader_.emplace_back(make_matcher(pattern), + std::move(handler)); return *this; } -inline Server &Server::Put(const char *pattern, Handler handler) { - put_handlers_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); +inline Server &Server::Put(const std::string &pattern, Handler handler) { + put_handlers_.emplace_back(make_matcher(pattern), std::move(handler)); return *this; } -inline Server &Server::Put(const char *pattern, +inline Server &Server::Put(const std::string &pattern, HandlerWithContentReader handler) { - put_handlers_for_content_reader_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); + put_handlers_for_content_reader_.emplace_back(make_matcher(pattern), + std::move(handler)); return *this; } -inline Server &Server::Patch(const char *pattern, Handler handler) { - patch_handlers_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); +inline Server &Server::Patch(const std::string &pattern, Handler handler) { + patch_handlers_.emplace_back(make_matcher(pattern), std::move(handler)); return *this; } -inline Server &Server::Patch(const char *pattern, +inline Server &Server::Patch(const std::string &pattern, HandlerWithContentReader handler) { - patch_handlers_for_content_reader_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); + patch_handlers_for_content_reader_.emplace_back(make_matcher(pattern), + std::move(handler)); return *this; } -inline Server &Server::Delete(const char *pattern, Handler handler) { - delete_handlers_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); +inline Server &Server::Delete(const std::string &pattern, Handler handler) { + delete_handlers_.emplace_back(make_matcher(pattern), std::move(handler)); return *this; } -inline Server &Server::Delete(const char *pattern, +inline Server &Server::Delete(const std::string &pattern, HandlerWithContentReader handler) { - delete_handlers_for_content_reader_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); + delete_handlers_for_content_reader_.emplace_back(make_matcher(pattern), + std::move(handler)); return *this; } -inline Server &Server::Options(const char *pattern, Handler handler) { - options_handlers_.push_back( - std::make_pair(std::regex(pattern), std::move(handler))); +inline Server &Server::Options(const std::string &pattern, Handler handler) { + options_handlers_.emplace_back(make_matcher(pattern), std::move(handler)); return *this; } -inline bool Server::set_base_dir(const char *dir, const char *mount_point) { +inline bool Server::set_base_dir(const std::string &dir, + const std::string &mount_point) { return set_mount_point(mount_point, dir); } -inline bool Server::set_mount_point(const char *mount_point, const char *dir, - Headers headers) { +inline bool Server::set_mount_point(const std::string &mount_point, + const std::string &dir, Headers headers) { if (detail::is_dir(dir)) { - std::string mnt = mount_point ? mount_point : "/"; + std::string mnt = !mount_point.empty() ? mount_point : "/"; if (!mnt.empty() && mnt[0] == '/') { base_dirs_.push_back({mnt, dir, std::move(headers)}); return true; @@ -4106,7 +5964,7 @@ inline bool Server::set_mount_point(const char *mount_point, const char *dir, return false; } -inline bool Server::remove_mount_point(const char *mount_point) { +inline bool Server::remove_mount_point(const std::string &mount_point) { for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) { if (it->mount_point == mount_point) { base_dirs_.erase(it); @@ -4116,75 +5974,150 @@ inline bool Server::remove_mount_point(const char *mount_point) { return false; } -inline void Server::set_file_extension_and_mimetype_mapping(const char *ext, - const char *mime) { +inline Server & +Server::set_file_extension_and_mimetype_mapping(const std::string &ext, + const std::string &mime) { file_extension_and_mimetype_map_[ext] = mime; + return *this; } -inline void Server::set_file_request_handler(Handler handler) { +inline Server &Server::set_default_file_mimetype(const std::string &mime) { + default_file_mimetype_ = mime; + return *this; +} + +inline Server &Server::set_file_request_handler(Handler handler) { file_request_handler_ = std::move(handler); + return *this; } -inline void Server::set_error_handler(Handler handler) { +inline Server &Server::set_error_handler_core(HandlerWithResponse handler, + std::true_type) { error_handler_ = std::move(handler); + return *this; +} + +inline Server &Server::set_error_handler_core(Handler handler, + std::false_type) { + error_handler_ = [handler](const Request &req, Response &res) { + handler(req, res); + return HandlerResponse::Handled; + }; + return *this; } -inline void Server::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; } +inline Server &Server::set_exception_handler(ExceptionHandler handler) { + exception_handler_ = std::move(handler); + return *this; +} -inline void Server::set_socket_options(SocketOptions socket_options) { - socket_options_ = std::move(socket_options); +inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) { + pre_routing_handler_ = std::move(handler); + return *this; } -inline void Server::set_logger(Logger logger) { logger_ = std::move(logger); } +inline Server &Server::set_post_routing_handler(Handler handler) { + post_routing_handler_ = std::move(handler); + return *this; +} -inline void +inline Server &Server::set_logger(Logger logger) { + logger_ = std::move(logger); + return *this; +} + +inline Server & Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) { expect_100_continue_handler_ = std::move(handler); + return *this; +} + +inline Server &Server::set_address_family(int family) { + address_family_ = family; + return *this; +} + +inline Server &Server::set_tcp_nodelay(bool on) { + tcp_nodelay_ = on; + return *this; +} + +inline Server &Server::set_socket_options(SocketOptions socket_options) { + socket_options_ = std::move(socket_options); + return *this; +} + +inline Server &Server::set_default_headers(Headers headers) { + default_headers_ = std::move(headers); + return *this; +} + +inline Server &Server::set_header_writer( + std::function const &writer) { + header_writer_ = writer; + return *this; } -inline void Server::set_keep_alive_max_count(size_t count) { +inline Server &Server::set_keep_alive_max_count(size_t count) { keep_alive_max_count_ = count; + return *this; } -inline void Server::set_keep_alive_timeout(time_t sec) { +inline Server &Server::set_keep_alive_timeout(time_t sec) { keep_alive_timeout_sec_ = sec; + return *this; } -inline void Server::set_read_timeout(time_t sec, time_t usec) { +inline Server &Server::set_read_timeout(time_t sec, time_t usec) { read_timeout_sec_ = sec; read_timeout_usec_ = usec; + return *this; } -inline void Server::set_write_timeout(time_t sec, time_t usec) { +inline Server &Server::set_write_timeout(time_t sec, time_t usec) { write_timeout_sec_ = sec; write_timeout_usec_ = usec; + return *this; } -inline void Server::set_idle_interval(time_t sec, time_t usec) { +inline Server &Server::set_idle_interval(time_t sec, time_t usec) { idle_interval_sec_ = sec; idle_interval_usec_ = usec; + return *this; } -inline void Server::set_payload_max_length(size_t length) { +inline Server &Server::set_payload_max_length(size_t length) { payload_max_length_ = length; + return *this; } -inline bool Server::bind_to_port(const char *host, int port, int socket_flags) { - if (bind_internal(host, port, socket_flags) < 0) return false; - return true; +inline bool Server::bind_to_port(const std::string &host, int port, + int socket_flags) { + return bind_internal(host, port, socket_flags) >= 0; } -inline int Server::bind_to_any_port(const char *host, int socket_flags) { +inline int Server::bind_to_any_port(const std::string &host, int socket_flags) { return bind_internal(host, 0, socket_flags); } -inline bool Server::listen_after_bind() { return listen_internal(); } +inline bool Server::listen_after_bind() { + auto se = detail::scope_exit([&]() { done_ = true; }); + return listen_internal(); +} -inline bool Server::listen(const char *host, int port, int socket_flags) { +inline bool Server::listen(const std::string &host, int port, + int socket_flags) { + auto se = detail::scope_exit([&]() { done_ = true; }); return bind_to_port(host, port, socket_flags) && listen_internal(); } inline bool Server::is_running() const { return is_running_; } +inline void Server::wait_until_ready() const { + while (!is_running() && !done_) { + std::this_thread::sleep_for(std::chrono::milliseconds{1}); + } +} + inline void Server::stop() { if (is_running_) { assert(svr_sock_ != INVALID_SOCKET); @@ -4194,30 +6127,61 @@ inline void Server::stop() { } } -inline bool Server::parse_request_line(const char *s, Request &req) { - const static std::regex re( - "(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|PRI) " - "(([^? ]+)(?:\\?([^ ]*?))?) +(HTTP/1\\.[01])\r\n"); +inline bool Server::parse_request_line(const char *s, Request &req) const { + auto len = strlen(s); + if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; } + len -= 2; - std::cmatch m; - if (std::regex_match(s, m, re)) { - req.version = std::string(m[5]); - req.method = std::string(m[1]); - req.target = std::string(m[2]); - req.path = detail::decode_url(m[3], false); + { + size_t count = 0; + + detail::split(s, s + len, ' ', [&](const char *b, const char *e) { + switch (count) { + case 0: req.method = std::string(b, e); break; + case 1: req.target = std::string(b, e); break; + case 2: req.version = std::string(b, e); break; + default: break; + } + count++; + }); - // Parse query text - auto len = std::distance(m[4].first, m[4].second); - if (len > 0) { detail::parse_query_text(m[4], req.params); } + if (count != 3) { return false; } + } - return true; + static const std::set methods{ + "GET", "HEAD", "POST", "PUT", "DELETE", + "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"}; + + if (methods.find(req.method) == methods.end()) { return false; } + + if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") { return false; } + + { + // Skip URL fragment + for (size_t i = 0; i < req.target.size(); i++) { + if (req.target[i] == '#') { + req.target.erase(i); + break; + } + } + + detail::divide(req.target, '?', + [&](const char *lhs_data, std::size_t lhs_size, + const char *rhs_data, std::size_t rhs_size) { + req.path = detail::decode_url( + std::string(lhs_data, lhs_size), false); + detail::parse_query_text(rhs_data, rhs_size, req.params); + }); } - return false; + return true; } inline bool Server::write_response(Stream &strm, bool close_connection, - const Request &req, Response &res) { + Request &req, Response &res) { + // NOTE: `req.ranges` should be empty, otherwise it will be applied + // incorrectly to the error content. + req.ranges.clear(); return write_response_core(strm, close_connection, req, res, false); } @@ -4233,13 +6197,16 @@ inline bool Server::write_response_core(Stream &strm, bool close_connection, bool need_apply_ranges) { assert(res.status != -1); - if (400 <= res.status && error_handler_) { error_handler_(req, res); } + if (400 <= res.status && error_handler_ && + error_handler_(req, res) == HandlerResponse::Handled) { + need_apply_ranges = true; + } std::string content_type; std::string boundary; if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); } - // Headers + // Prepare additional headers if (close_connection || req.get_header_value("Connection") == "close") { res.set_header("Connection", "close"); } else { @@ -4263,28 +6230,35 @@ inline bool Server::write_response_core(Stream &strm, bool close_connection, res.set_header("Accept-Ranges", "bytes"); } - detail::BufferStream bstrm; + if (post_routing_handler_) { post_routing_handler_(req, res); } - // Response line - if (!bstrm.write_format("HTTP/1.1 %d %s\r\n", res.status, - detail::status_message(res.status))) { - return false; - } + // Response line and headers + { + detail::BufferStream bstrm; + + if (!bstrm.write_format("HTTP/1.1 %d %s\r\n", res.status, + status_message(res.status))) { + return false; + } - if (!detail::write_headers(bstrm, res, Headers())) { return false; } + if (!header_writer_(bstrm, res.headers)) { return false; } - // Flush buffer - auto &data = bstrm.get_buffer(); - strm.write(data.data(), data.size()); + // Flush buffer + auto &data = bstrm.get_buffer(); + detail::write_data(strm, data.data(), data.size()); + } // Body auto ret = true; if (req.method != "HEAD") { if (!res.body.empty()) { - if (!strm.write(res.body)) { ret = false; } + if (!detail::write_data(strm, res.body.data(), res.body.size())) { + ret = false; + } } else if (res.content_provider_) { - if (!write_content_with_provider(strm, req, res, boundary, - content_type)) { + if (write_content_with_provider(strm, req, res, boundary, content_type)) { + res.content_provider_success_ = true; + } else { ret = false; } } @@ -4309,15 +6283,16 @@ Server::write_content_with_provider(Stream &strm, const Request &req, return detail::write_content(strm, res.content_provider_, 0, res.content_length_, is_shutting_down); } else if (req.ranges.size() == 1) { - auto offsets = - detail::get_range_offset_and_length(req, res.content_length_, 0); - auto offset = offsets.first; - auto length = offsets.second; - return detail::write_content(strm, res.content_provider_, offset, length, - is_shutting_down); + auto offset_and_length = detail::get_range_offset_and_length( + req.ranges[0], res.content_length_); + + return detail::write_content(strm, res.content_provider_, + offset_and_length.first, + offset_and_length.second, is_shutting_down); } else { return detail::write_multipart_ranges_data( - strm, req, res, boundary, content_type, is_shutting_down); + strm, req, res, boundary, content_type, res.content_length_, + is_shutting_down); } } else { if (res.is_chunked_content_provider_) { @@ -4344,11 +6319,11 @@ Server::write_content_with_provider(Stream &strm, const Request &req, is_shutting_down); } } - return true; } inline bool Server::read_content(Stream &strm, Request &req, Response &res) { MultipartFormDataMap::iterator cur; + auto file_count = 0; if (read_content_core( strm, req, res, // Regular @@ -4359,6 +6334,9 @@ inline bool Server::read_content(Stream &strm, Request &req, Response &res) { }, // Multipart [&](const MultipartFormData &file) { + if (file_count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) { + return false; + } cur = req.files.emplace(file.name, file); return true; }, @@ -4370,6 +6348,10 @@ inline bool Server::read_content(Stream &strm, Request &req, Response &res) { })) { const auto &content_type = req.get_header_value("Content-Type"); if (!content_type.find("application/x-www-form-urlencoded")) { + if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) { + res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414? + return false; + } detail::parse_query_text(req.body, req.params); } return true; @@ -4386,10 +6368,11 @@ inline bool Server::read_content_with_content_receiver( std::move(multipart_receiver)); } -inline bool Server::read_content_core(Stream &strm, Request &req, Response &res, - ContentReceiver receiver, - MultipartContentHeader mulitpart_header, - ContentReceiver multipart_receiver) { +inline bool +Server::read_content_core(Stream &strm, Request &req, Response &res, + ContentReceiver receiver, + MultipartContentHeader multipart_header, + ContentReceiver multipart_receiver) const { detail::MultipartFormDataParser multipart_form_data_parser; ContentReceiverWithProgress out; @@ -4397,7 +6380,7 @@ inline bool Server::read_content_core(Stream &strm, Request &req, Response &res, const auto &content_type = req.get_header_value("Content-Type"); std::string boundary; if (!detail::parse_multipart_boundary(content_type, boundary)) { - res.status = 400; + res.status = StatusCode::BadRequest_400; return false; } @@ -4406,16 +6389,16 @@ inline bool Server::read_content_core(Stream &strm, Request &req, Response &res, /* For debug size_t pos = 0; while (pos < n) { - auto read_size = std::min(1, n - pos); + auto read_size = (std::min)(1, n - pos); auto ret = multipart_form_data_parser.parse( - buf + pos, read_size, multipart_receiver, mulitpart_header); + buf + pos, read_size, multipart_receiver, multipart_header); if (!ret) { return false; } pos += read_size; } return true; */ return multipart_form_data_parser.parse(buf, n, multipart_receiver, - mulitpart_header); + multipart_header); }; } else { out = [receiver](const char *buf, size_t n, uint64_t /*off*/, @@ -4433,7 +6416,7 @@ inline bool Server::read_content_core(Stream &strm, Request &req, Response &res, if (req.is_multipart_form_data()) { if (!multipart_form_data_parser.is_valid()) { - res.status = 400; + res.status = StatusCode::BadRequest_400; return false; } } @@ -4441,7 +6424,7 @@ inline bool Server::read_content_core(Stream &strm, Request &req, Response &res, return true; } -inline bool Server::handle_file_request(Request &req, Response &res, +inline bool Server::handle_file_request(const Request &req, Response &res, bool head) { for (const auto &entry : base_dirs_) { // Prefix match @@ -4452,17 +6435,26 @@ inline bool Server::handle_file_request(Request &req, Response &res, if (path.back() == '/') { path += "index.html"; } if (detail::is_file(path)) { - detail::read_file(path, res.body); - auto type = - detail::find_content_type(path, file_extension_and_mimetype_map_); - if (type) { res.set_header("Content-Type", type); } for (const auto &kv : entry.headers) { - res.set_header(kv.first.c_str(), kv.second); + res.set_header(kv.first, kv.second); } - res.status = req.has_header("Range") ? 206 : 200; + + auto mm = std::make_shared(path.c_str()); + if (!mm->is_open()) { return false; } + + res.set_content_provider( + mm->size(), + detail::find_content_type(path, file_extension_and_mimetype_map_, + default_file_mimetype_), + [mm](size_t offset, size_t length, DataSink &sink) -> bool { + sink.write(mm->data() + offset, length); + return true; + }); + if (!head && file_request_handler_) { file_request_handler_(req, res); } + return true; } } @@ -4472,22 +6464,23 @@ inline bool Server::handle_file_request(Request &req, Response &res, } inline socket_t -Server::create_server_socket(const char *host, int port, int socket_flags, +Server::create_server_socket(const std::string &host, int port, + int socket_flags, SocketOptions socket_options) const { return detail::create_socket( - host, port, socket_flags, tcp_nodelay_, std::move(socket_options), + host, std::string(), port, address_family_, socket_flags, tcp_nodelay_, + std::move(socket_options), [](socket_t sock, struct addrinfo &ai) -> bool { if (::bind(sock, ai.ai_addr, static_cast(ai.ai_addrlen))) { return false; } - if (::listen(sock, 5)) { // Listen through 5 channels - return false; - } + if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) { return false; } return true; }); } -inline int Server::bind_internal(const char *host, int port, int socket_flags) { +inline int Server::bind_internal(const std::string &host, int port, + int socket_flags) { if (!is_valid()) { return -1; } svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_); @@ -4515,6 +6508,7 @@ inline int Server::bind_internal(const char *host, int port, int socket_flags) { inline bool Server::listen_internal() { auto ret = true; is_running_ = true; + auto se = detail::scope_exit([&]() { is_running_ = false; }); { std::unique_ptr task_queue(new_task_queue()); @@ -4532,7 +6526,16 @@ inline bool Server::listen_internal() { #ifndef _WIN32 } #endif + +#if defined _WIN32 + // sockets conneced via WASAccept inherit flags NO_HANDLE_INHERIT, + // OVERLAPPED + socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0); +#elif defined SOCK_CLOEXEC + socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC); +#else socket_t sock = accept(svr_sock_, nullptr, nullptr); +#endif if (sock == INVALID_SOCKET) { if (errno == EMFILE) { @@ -4540,6 +6543,8 @@ inline bool Server::listen_internal() { // Try to accept new connections after a short sleep. std::this_thread::sleep_for(std::chrono::milliseconds(1)); continue; + } else if (errno == EINTR || errno == EAGAIN) { + continue; } if (svr_sock_ != INVALID_SOCKET) { detail::close_socket(svr_sock_); @@ -4550,23 +6555,57 @@ inline bool Server::listen_internal() { break; } -#if __cplusplus > 201703L - task_queue->enqueue([=, this]() { process_and_close_socket(sock); }); + { +#ifdef _WIN32 + auto timeout = static_cast(read_timeout_sec_ * 1000 + + read_timeout_usec_ / 1000); + setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, + reinterpret_cast(&timeout), sizeof(timeout)); +#else + timeval tv; + tv.tv_sec = static_cast(read_timeout_sec_); + tv.tv_usec = static_cast(read_timeout_usec_); + setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, + reinterpret_cast(&tv), sizeof(tv)); +#endif + } + { + +#ifdef _WIN32 + auto timeout = static_cast(write_timeout_sec_ * 1000 + + write_timeout_usec_ / 1000); + setsockopt(sock, SOL_SOCKET, SO_SNDTIMEO, + reinterpret_cast(&timeout), sizeof(timeout)); #else - task_queue->enqueue([=]() { process_and_close_socket(sock); }); + timeval tv; + tv.tv_sec = static_cast(write_timeout_sec_); + tv.tv_usec = static_cast(write_timeout_usec_); + setsockopt(sock, SOL_SOCKET, SO_SNDTIMEO, + reinterpret_cast(&tv), sizeof(tv)); #endif + } + + if (!task_queue->enqueue( + [this, sock]() { process_and_close_socket(sock); })) { + detail::shutdown_socket(sock); + detail::close_socket(sock); + } } task_queue->shutdown(); } - is_running_ = false; return ret; } inline bool Server::routing(Request &req, Response &res, Stream &strm) { + if (pre_routing_handler_ && + pre_routing_handler_(req, res) == HandlerResponse::Handled) { + return true; + } + // File handler - bool is_head_request = req.method == "HEAD"; + auto is_head_request = req.method == "HEAD"; if ((req.method == "GET" || is_head_request) && handle_file_request(req, res, is_head_request)) { return true; @@ -4632,46 +6671,38 @@ inline bool Server::routing(Request &req, Response &res, Stream &strm) { return dispatch_request(req, res, patch_handlers_); } - res.status = 400; + res.status = StatusCode::BadRequest_400; return false; } inline bool Server::dispatch_request(Request &req, Response &res, - const Handlers &handlers) { - try { - for (const auto &x : handlers) { - const auto &pattern = x.first; - const auto &handler = x.second; + const Handlers &handlers) const { + for (const auto &x : handlers) { + const auto &matcher = x.first; + const auto &handler = x.second; - if (std::regex_match(req.path, req.matches, pattern)) { - handler(req, res); - return true; - } + if (matcher->match(req)) { + handler(req, res); + return true; } - } catch (const std::exception &ex) { - res.status = 500; - res.set_header("EXCEPTION_WHAT", ex.what()); - } catch (...) { - res.status = 500; - res.set_header("EXCEPTION_WHAT", "UNKNOWN"); } return false; } inline void Server::apply_ranges(const Request &req, Response &res, std::string &content_type, - std::string &boundary) { - if (req.ranges.size() > 1) { - boundary = detail::make_multipart_data_boundary(); - + std::string &boundary) const { + if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) { auto it = res.headers.find("Content-Type"); if (it != res.headers.end()) { content_type = it->second; res.headers.erase(it); } - res.headers.emplace("Content-Type", - "multipart/byteranges; boundary=" + boundary); + boundary = detail::make_multipart_data_boundary(); + + res.set_header("Content-Type", + "multipart/byteranges; boundary=" + boundary); } auto type = detail::encoding_type(req, res); @@ -4679,19 +6710,20 @@ inline void Server::apply_ranges(const Request &req, Response &res, if (res.body.empty()) { if (res.content_length_ > 0) { size_t length = 0; - if (req.ranges.empty()) { + if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) { length = res.content_length_; } else if (req.ranges.size() == 1) { - auto offsets = - detail::get_range_offset_and_length(req, res.content_length_, 0); - auto offset = offsets.first; - length = offsets.second; + auto offset_and_length = detail::get_range_offset_and_length( + req.ranges[0], res.content_length_); + + length = offset_and_length.second; + auto content_range = detail::make_content_range_header_field( - offset, length, res.content_length_); + offset_and_length, res.content_length_); res.set_header("Content-Range", content_range); } else { - length = detail::get_multipart_ranges_data_length(req, res, boundary, - content_type); + length = detail::get_multipart_ranges_data_length( + req, boundary, content_type, res.content_length_); } res.set_header("Content-Length", std::to_string(length)); } else { @@ -4707,31 +6739,25 @@ inline void Server::apply_ranges(const Request &req, Response &res, } } } else { - if (req.ranges.empty()) { + if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) { ; } else if (req.ranges.size() == 1) { - auto offsets = - detail::get_range_offset_and_length(req, res.body.size(), 0); - auto offset = offsets.first; - auto length = offsets.second; + auto offset_and_length = + detail::get_range_offset_and_length(req.ranges[0], res.body.size()); + auto offset = offset_and_length.first; + auto length = offset_and_length.second; + auto content_range = detail::make_content_range_header_field( - offset, length, res.body.size()); + offset_and_length, res.body.size()); res.set_header("Content-Range", content_range); - if (offset < res.body.size()) { - res.body = res.body.substr(offset, length); - } else { - res.body.clear(); - res.status = 416; - } + + assert(offset + length <= res.body.size()); + res.body = res.body.substr(offset, length); } else { std::string data; - if (detail::make_multipart_ranges_data(req, res, boundary, content_type, - data)) { - res.body.swap(data); - } else { - res.body.clear(); - res.status = 416; - } + detail::make_multipart_ranges_data(req, res, boundary, content_type, + res.body.size(), data); + res.body.swap(data); } if (type != detail::EncodingType::None) { @@ -4770,12 +6796,12 @@ inline void Server::apply_ranges(const Request &req, Response &res, inline bool Server::dispatch_request_for_content_reader( Request &req, Response &res, ContentReader content_reader, - const HandlersForContentReader &handlers) { + const HandlersForContentReader &handlers) const { for (const auto &x : handlers) { - const auto &pattern = x.first; + const auto &matcher = x.first; const auto &handler = x.second; - if (std::regex_match(req.path, req.matches, pattern)) { + if (matcher->match(req)) { handler(req, res, content_reader); return true; } @@ -4795,9 +6821,10 @@ Server::process_request(Stream &strm, bool close_connection, if (!line_reader.getline()) { return false; } Request req; - Response res; + Response res; res.version = "HTTP/1.1"; + res.headers = default_headers_; #ifdef _WIN32 // TODO: Increase FD_SETSIZE statically (libzmq), dynamically (MySQL). @@ -4807,7 +6834,7 @@ Server::process_request(Stream &strm, bool close_connection, if (strm.socket() >= FD_SETSIZE) { Headers dummy; detail::read_headers(strm, dummy); - res.status = 500; + res.status = StatusCode::InternalServerError_500; return write_response(strm, close_connection, req, res); } #endif @@ -4817,14 +6844,14 @@ Server::process_request(Stream &strm, bool close_connection, if (line_reader.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) { Headers dummy; detail::read_headers(strm, dummy); - res.status = 414; + res.status = StatusCode::UriTooLong_414; return write_response(strm, close_connection, req, res); } // Request line and headers if (!parse_request_line(line_reader.ptr(), req) || !detail::read_headers(strm, req.headers)) { - res.status = 400; + res.status = StatusCode::BadRequest_400; return write_response(strm, close_connection, req, res); } @@ -4841,10 +6868,14 @@ Server::process_request(Stream &strm, bool close_connection, req.set_header("REMOTE_ADDR", req.remote_addr); req.set_header("REMOTE_PORT", std::to_string(req.remote_port)); + strm.get_local_ip_and_port(req.local_addr, req.local_port); + req.set_header("LOCAL_ADDR", req.local_addr); + req.set_header("LOCAL_PORT", std::to_string(req.local_port)); + if (req.has_header("Range")) { const auto &range_header_value = req.get_header_value("Range"); if (!detail::parse_range_header(range_header_value, req.ranges)) { - res.status = 416; + res.status = StatusCode::RangeNotSatisfiable_416; return write_response(strm, close_connection, req, res); } } @@ -4852,26 +6883,74 @@ Server::process_request(Stream &strm, bool close_connection, if (setup_request) { setup_request(req); } if (req.get_header_value("Expect") == "100-continue") { - auto status = 100; + int status = StatusCode::Continue_100; if (expect_100_continue_handler_) { status = expect_100_continue_handler_(req, res); } switch (status) { - case 100: - case 417: + case StatusCode::Continue_100: + case StatusCode::ExpectationFailed_417: strm.write_format("HTTP/1.1 %d %s\r\n\r\n", status, - detail::status_message(status)); + status_message(status)); break; default: return write_response(strm, close_connection, req, res); } } - // Rounting - if (routing(req, res, strm)) { - if (res.status == -1) { res.status = req.ranges.empty() ? 200 : 206; } + // Routing + auto routed = false; +#ifdef CPPHTTPLIB_NO_EXCEPTIONS + routed = routing(req, res, strm); +#else + try { + routed = routing(req, res, strm); + } catch (std::exception &e) { + if (exception_handler_) { + auto ep = std::current_exception(); + exception_handler_(req, res, ep); + routed = true; + } else { + res.status = StatusCode::InternalServerError_500; + std::string val; + auto s = e.what(); + for (size_t i = 0; s[i]; i++) { + switch (s[i]) { + case '\r': val += "\\r"; break; + case '\n': val += "\\n"; break; + default: val += s[i]; break; + } + } + res.set_header("EXCEPTION_WHAT", val); + } + } catch (...) { + if (exception_handler_) { + auto ep = std::current_exception(); + exception_handler_(req, res, ep); + routed = true; + } else { + res.status = StatusCode::InternalServerError_500; + res.set_header("EXCEPTION_WHAT", "UNKNOWN"); + } + } +#endif + if (routed) { + if (res.status == -1) { + res.status = req.ranges.empty() ? StatusCode::OK_200 + : StatusCode::PartialContent_206; + } + + if (detail::range_error(req, res)) { + res.body.clear(); + res.content_length_ = 0; + res.content_provider_ = nullptr; + res.status = StatusCode::RangeNotSatisfiable_416; + return write_response(strm, close_connection, req, res); + } + return write_response_with_content(strm, close_connection, req, res); } else { - if (res.status == -1) { res.status = 404; } + if (res.status == -1) { res.status = StatusCode::NotFound_404; } + return write_response(strm, close_connection, req, res); } } @@ -4880,8 +6959,9 @@ inline bool Server::is_valid() const { return true; } inline bool Server::process_and_close_socket(socket_t sock) { auto ret = detail::process_server_socket( - sock, keep_alive_max_count_, keep_alive_timeout_sec_, read_timeout_sec_, - read_timeout_usec_, write_timeout_sec_, write_timeout_usec_, + svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_, + read_timeout_sec_, read_timeout_usec_, write_timeout_sec_, + write_timeout_usec_, [this](Stream &strm, bool close_connection, bool &connection_closed) { return process_request(strm, close_connection, connection_closed, nullptr); @@ -4902,12 +6982,15 @@ inline ClientImpl::ClientImpl(const std::string &host, int port) inline ClientImpl::ClientImpl(const std::string &host, int port, const std::string &client_cert_path, const std::string &client_key_path) - // : (Error::Success), host_(host), port_(port), : host_(host), port_(port), - host_and_port_(host_ + ":" + std::to_string(port_)), + host_and_port_(adjust_host_string(host) + ":" + std::to_string(port)), client_cert_path_(client_cert_path), client_key_path_(client_key_path) {} -inline ClientImpl::~ClientImpl() { lock_socket_and_shutdown_and_close(); } +inline ClientImpl::~ClientImpl() { + std::lock_guard guard(socket_mutex_); + shutdown_socket(socket_); + close_socket(socket_); +} inline bool ClientImpl::is_valid() const { return true; } @@ -4928,6 +7011,8 @@ inline void ClientImpl::copy_settings(const ClientImpl &rhs) { #endif keep_alive_ = rhs.keep_alive_; follow_location_ = rhs.follow_location_; + url_encode_ = rhs.url_encode_; + address_family_ = rhs.address_family_; tcp_nodelay_ = rhs.tcp_nodelay_; socket_options_ = rhs.socket_options_; compress_ = rhs.compress_; @@ -4942,6 +7027,11 @@ inline void ClientImpl::copy_settings(const ClientImpl &rhs) { proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_; proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_; #endif +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + ca_cert_file_path_ = rhs.ca_cert_file_path_; + ca_cert_dir_path_ = rhs.ca_cert_dir_path_; + ca_cert_store_ = rhs.ca_cert_store_; +#endif #ifdef CPPHTTPLIB_OPENSSL_SUPPORT server_certificate_verification_ = rhs.server_certificate_verification_; #endif @@ -4951,12 +7041,22 @@ inline void ClientImpl::copy_settings(const ClientImpl &rhs) { inline socket_t ClientImpl::create_client_socket(Error &error) const { if (!proxy_host_.empty() && proxy_port_ != -1) { return detail::create_client_socket( - proxy_host_.c_str(), proxy_port_, tcp_nodelay_, socket_options_, - connection_timeout_sec_, connection_timeout_usec_, interface_, error); + proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_, + socket_options_, connection_timeout_sec_, connection_timeout_usec_, + read_timeout_sec_, read_timeout_usec_, write_timeout_sec_, + write_timeout_usec_, interface_, error); } + + // Check is custom IP specified for host_ + std::string ip; + auto it = addr_map_.find(host_); + if (it != addr_map_.end()) { ip = it->second; } + return detail::create_client_socket( - host_.c_str(), port_, tcp_nodelay_, socket_options_, - connection_timeout_sec_, connection_timeout_usec_, interface_, error); + host_, ip, port_, address_family_, tcp_nodelay_, socket_options_, + connection_timeout_sec_, connection_timeout_usec_, read_timeout_sec_, + read_timeout_usec_, write_timeout_sec_, write_timeout_usec_, interface_, + error); } inline bool ClientImpl::create_and_connect_socket(Socket &socket, @@ -4975,7 +7075,7 @@ inline void ClientImpl::shutdown_ssl(Socket & /*socket*/, socket_requests_are_from_thread_ == std::this_thread::get_id()); } -inline void ClientImpl::shutdown_socket(Socket &socket) { +inline void ClientImpl::shutdown_socket(Socket &socket) const { if (socket.sock == INVALID_SOCKET) { return; } detail::shutdown_socket(socket.sock); } @@ -4999,22 +7099,19 @@ inline void ClientImpl::close_socket(Socket &socket) { socket.sock = INVALID_SOCKET; } -inline void ClientImpl::lock_socket_and_shutdown_and_close() { - std::lock_guard guard(socket_mutex_); - shutdown_ssl(socket_, true); - shutdown_socket(socket_); - close_socket(socket_); -} - inline bool ClientImpl::read_response_line(Stream &strm, const Request &req, - Response &res) { - std::array buf; + Response &res) const { + std::array buf{}; detail::stream_line_reader line_reader(strm, buf.data(), buf.size()); if (!line_reader.getline()) { return false; } - const static std::regex re("(HTTP/1\\.[01]) (\\d{3}) (.*?)\r\n"); +#ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR + const static std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n"); +#else + const static std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n"); +#endif std::cmatch m; if (!std::regex_match(line_reader.ptr(), m, re)) { @@ -5025,7 +7122,7 @@ inline bool ClientImpl::read_response_line(Stream &strm, const Request &req, res.reason = std::string(m[3]); // Ignore '100 Continue' - while (res.status == 100) { + while (res.status == StatusCode::Continue_100) { if (!line_reader.getline()) { return false; } // CRLF if (!line_reader.getline()) { return false; } // next response line @@ -5038,18 +7135,27 @@ inline bool ClientImpl::read_response_line(Stream &strm, const Request &req, return true; } -inline bool ClientImpl::send(const Request &req, Response &res, Error &error) { +inline bool ClientImpl::send(Request &req, Response &res, Error &error) { std::lock_guard request_mutex_guard(request_mutex_); + auto ret = send_(req, res, error); + if (error == Error::SSLPeerCouldBeClosed_) { + assert(!ret); + ret = send_(req, res, error); + } + return ret; +} +inline bool ClientImpl::send_(Request &req, Response &res, Error &error) { { std::lock_guard guard(socket_mutex_); + // Set this to false immediately - if it ever gets set to true by the end of // the request, we know another thread instructed us to close the socket. socket_should_be_closed_when_request_is_done_ = false; auto is_alive = false; if (socket_.is_open()) { - is_alive = detail::select_write(socket_.sock, 0, 0) > 0; + is_alive = detail::is_socket_alive(socket_.sock); if (!is_alive) { // Attempt to avoid sigpipe by shutting down nongracefully if it seems // like the other side has already closed the connection Also, there @@ -5070,7 +7176,7 @@ inline bool ClientImpl::send(const Request &req, Response &res, Error &error) { if (is_ssl()) { auto &scli = static_cast(*this); if (!proxy_host_.empty() && proxy_port_ != -1) { - bool success = false; + auto success = false; if (!scli.connect_with_proxy(socket_, res, success, error)) { return success; } @@ -5091,13 +7197,17 @@ inline bool ClientImpl::send(const Request &req, Response &res, Error &error) { socket_requests_are_from_thread_ = std::this_thread::get_id(); } + for (const auto &header : default_headers_) { + if (req.headers.find(header.first) == req.headers.end()) { + req.headers.insert(header); + } + } + + auto ret = false; auto close_connection = !keep_alive_; - auto ret = process_socket(socket_, [&](Stream &strm) { - return handle_request(strm, req, res, close_connection, error); - }); - // Briefly lock mutex in order to mark that a request is no longer ongoing - { + auto se = detail::scope_exit([&]() { + // Briefly lock mutex in order to mark that a request is no longer ongoing std::lock_guard guard(socket_mutex_); socket_requests_in_flight_ -= 1; if (socket_requests_in_flight_ <= 0) { @@ -5111,7 +7221,11 @@ inline bool ClientImpl::send(const Request &req, Response &res, Error &error) { shutdown_socket(socket_); close_socket(socket_); } - } + }); + + ret = process_socket(socket_, [&](Stream &strm) { + return handle_request(strm, req, res, close_connection, error); + }); if (!ret) { if (error == Error::Success) { error = Error::Unknown; } @@ -5121,13 +7235,18 @@ inline bool ClientImpl::send(const Request &req, Response &res, Error &error) { } inline Result ClientImpl::send(const Request &req) { + auto req2 = req; + return send_(std::move(req2)); +} + +inline Result ClientImpl::send_(Request &&req) { auto res = detail::make_unique(); auto error = Error::Success; auto ret = send(req, *res, error); - return Result{ret ? std::move(res) : nullptr, error}; + return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)}; } -inline bool ClientImpl::handle_request(Stream &strm, const Request &req, +inline bool ClientImpl::handle_request(Stream &strm, Request &req, Response &res, bool close_connection, Error &error) { if (req.path.empty()) { @@ -5135,26 +7254,47 @@ inline bool ClientImpl::handle_request(Stream &strm, const Request &req, return false; } + auto req_save = req; + bool ret; if (!is_ssl() && !proxy_host_.empty() && proxy_port_ != -1) { auto req2 = req; req2.path = "http://" + host_and_port_ + req.path; ret = process_request(strm, req2, res, close_connection, error); + req = req2; + req.path = req_save.path; } else { ret = process_request(strm, req, res, close_connection, error); } if (!ret) { return false; } + if (res.get_header_value("Connection") == "close" || + (res.version == "HTTP/1.0" && res.reason != "Connection established")) { + // TODO this requires a not-entirely-obvious chain of calls to be correct + // for this to be safe. + + // This is safe to call because handle_request is only called by send_ + // which locks the request mutex during the process. It would be a bug + // to call it from a different thread since it's a thread-safety issue + // to do these things to the socket if another thread is using the socket. + std::lock_guard guard(socket_mutex_); + shutdown_ssl(socket_, true); + shutdown_socket(socket_); + close_socket(socket_); + } + if (300 < res.status && res.status < 400 && follow_location_) { + req = req_save; ret = redirect(req, res, error); } #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - if ((res.status == 401 || res.status == 407) && + if ((res.status == StatusCode::Unauthorized_401 || + res.status == StatusCode::ProxyAuthenticationRequired_407) && req.authorization_count_ < 5) { - auto is_proxy = res.status == 407; + auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407; const auto &username = is_proxy ? proxy_digest_auth_username_ : digest_auth_username_; const auto &password = @@ -5165,8 +7305,8 @@ inline bool ClientImpl::handle_request(Stream &strm, const Request &req, if (detail::parse_www_authenticate(res, auth, is_proxy)) { Request new_req = req; new_req.authorization_count_ += 1; - auto key = is_proxy ? "Proxy-Authorization" : "Authorization"; - new_req.headers.erase(key); + new_req.headers.erase(is_proxy ? "Proxy-Authorization" + : "Authorization"); new_req.headers.insert(detail::make_digest_authentication_header( req, auth, new_req.authorization_count_, detail::random_string(10), username, password, is_proxy)); @@ -5183,18 +7323,17 @@ inline bool ClientImpl::handle_request(Stream &strm, const Request &req, return ret; } -inline bool ClientImpl::redirect(const Request &req, Response &res, - Error &error) { +inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) { if (req.redirect_count_ == 0) { error = Error::ExceedRedirectCount; return false; } - auto location = detail::decode_url(res.get_header_value("location"), true); + auto location = res.get_header_value("location"); if (location.empty()) { return false; } const static std::regex re( - R"(^(?:(https?):)?(?://([^:/?#]*)(?::(\d+))?)?([^?#]*(?:\?[^#]*)?)(?:#.*)?)"); + R"((?:(https?):)?(?://(?:\[([a-fA-F\d:]+)\]|([^:/?#]+))(?::(\d+))?)?([^?#]*)(\?[^#]*)?(?:#.*)?)"); std::smatch m; if (!std::regex_match(location, m, re)) { return false; } @@ -5203,8 +7342,10 @@ inline bool ClientImpl::redirect(const Request &req, Response &res, auto next_scheme = m[1].str(); auto next_host = m[2].str(); - auto port_str = m[3].str(); - auto next_path = m[4].str(); + if (next_host.empty()) { next_host = m[3].str(); } + auto port_str = m[4].str(); + auto next_path = m[5].str(); + auto next_query = m[6].str(); auto next_port = port_; if (!port_str.empty()) { @@ -5217,32 +7358,35 @@ inline bool ClientImpl::redirect(const Request &req, Response &res, if (next_host.empty()) { next_host = host_; } if (next_path.empty()) { next_path = "/"; } + auto path = detail::decode_url(next_path, true) + next_query; + if (next_scheme == scheme && next_host == host_ && next_port == port_) { - return detail::redirect(*this, req, res, next_path, location, error); + return detail::redirect(*this, req, res, path, location, error); } else { if (next_scheme == "https") { #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - SSLClient cli(next_host.c_str(), next_port); + SSLClient cli(next_host, next_port); cli.copy_settings(*this); - return detail::redirect(cli, req, res, next_path, location, error); + if (ca_cert_store_) { cli.set_ca_cert_store(ca_cert_store_); } + return detail::redirect(cli, req, res, path, location, error); #else return false; #endif } else { - ClientImpl cli(next_host.c_str(), next_port); + ClientImpl cli(next_host, next_port); cli.copy_settings(*this); - return detail::redirect(cli, req, res, next_path, location, error); + return detail::redirect(cli, req, res, path, location, error); } } } inline bool ClientImpl::write_content_with_provider(Stream &strm, const Request &req, - Error &error) { + Error &error) const { auto is_shutting_down = []() { return false; }; if (req.is_chunked_content_provider_) { - // TODO: Brotli suport + // TODO: Brotli support std::unique_ptr compressor; #ifdef CPPHTTPLIB_ZLIB_SUPPORT if (compress_) { @@ -5259,123 +7403,135 @@ inline bool ClientImpl::write_content_with_provider(Stream &strm, return detail::write_content(strm, req.content_provider_, 0, req.content_length_, is_shutting_down, error); } -} // namespace httplib +} -inline bool ClientImpl::write_request(Stream &strm, const Request &req, +inline bool ClientImpl::write_request(Stream &strm, Request &req, bool close_connection, Error &error) { - detail::BufferStream bstrm; - - // Request line - const auto &path = detail::encode_url(req.path); - - bstrm.write_format("%s %s HTTP/1.1\r\n", req.method.c_str(), path.c_str()); - - // Additonal headers - Headers headers; - if (close_connection) { headers.emplace("Connection", "close"); } + // Prepare additional headers + if (close_connection) { + if (!req.has_header("Connection")) { + req.set_header("Connection", "close"); + } + } if (!req.has_header("Host")) { if (is_ssl()) { if (port_ == 443) { - headers.emplace("Host", host_); + req.set_header("Host", host_); } else { - headers.emplace("Host", host_and_port_); + req.set_header("Host", host_and_port_); } } else { if (port_ == 80) { - headers.emplace("Host", host_); + req.set_header("Host", host_); } else { - headers.emplace("Host", host_and_port_); + req.set_header("Host", host_and_port_); } } } - if (!req.has_header("Accept")) { headers.emplace("Accept", "*/*"); } + if (!req.has_header("Accept")) { req.set_header("Accept", "*/*"); } +#ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT if (!req.has_header("User-Agent")) { - headers.emplace("User-Agent", "cpp-httplib/0.7"); + auto agent = std::string("cpp-httplib/") + CPPHTTPLIB_VERSION; + req.set_header("User-Agent", agent); } +#endif if (req.body.empty()) { if (req.content_provider_) { if (!req.is_chunked_content_provider_) { - auto length = std::to_string(req.content_length_); - headers.emplace("Content-Length", length); + if (!req.has_header("Content-Length")) { + auto length = std::to_string(req.content_length_); + req.set_header("Content-Length", length); + } } } else { if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH") { - headers.emplace("Content-Length", "0"); + req.set_header("Content-Length", "0"); } } } else { if (!req.has_header("Content-Type")) { - headers.emplace("Content-Type", "text/plain"); + req.set_header("Content-Type", "text/plain"); } if (!req.has_header("Content-Length")) { auto length = std::to_string(req.body.size()); - headers.emplace("Content-Length", length); + req.set_header("Content-Length", length); } } - if (!basic_auth_password_.empty()) { - headers.insert(make_basic_authentication_header( - basic_auth_username_, basic_auth_password_, false)); + if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) { + if (!req.has_header("Authorization")) { + req.headers.insert(make_basic_authentication_header( + basic_auth_username_, basic_auth_password_, false)); + } } if (!proxy_basic_auth_username_.empty() && !proxy_basic_auth_password_.empty()) { - headers.insert(make_basic_authentication_header( - proxy_basic_auth_username_, proxy_basic_auth_password_, true)); + if (!req.has_header("Proxy-Authorization")) { + req.headers.insert(make_basic_authentication_header( + proxy_basic_auth_username_, proxy_basic_auth_password_, true)); + } } if (!bearer_token_auth_token_.empty()) { - headers.insert(make_bearer_token_authentication_header( - bearer_token_auth_token_, false)); + if (!req.has_header("Authorization")) { + req.headers.insert(make_bearer_token_authentication_header( + bearer_token_auth_token_, false)); + } } if (!proxy_bearer_token_auth_token_.empty()) { - headers.insert(make_bearer_token_authentication_header( - proxy_bearer_token_auth_token_, true)); + if (!req.has_header("Proxy-Authorization")) { + req.headers.insert(make_bearer_token_authentication_header( + proxy_bearer_token_auth_token_, true)); + } } - detail::write_headers(bstrm, req, headers); + // Request line and headers + { + detail::BufferStream bstrm; + + const auto &path = url_encode_ ? detail::encode_url(req.path) : req.path; + bstrm.write_format("%s %s HTTP/1.1\r\n", req.method.c_str(), path.c_str()); - // Flush buffer - auto &data = bstrm.get_buffer(); - if (!detail::write_data(strm, data.data(), data.size())) { - error = Error::Write; - return false; + header_writer_(bstrm, req.headers); + + // Flush buffer + auto &data = bstrm.get_buffer(); + if (!detail::write_data(strm, data.data(), data.size())) { + error = Error::Write; + return false; + } } // Body if (req.body.empty()) { return write_content_with_provider(strm, req, error); - } else { - return detail::write_data(strm, req.body.data(), req.body.size()); + } + + if (!detail::write_data(strm, req.body.data(), req.body.size())) { + error = Error::Write; + return false; } return true; } inline std::unique_ptr ClientImpl::send_with_content_provider( - const char *method, const char *path, const Headers &headers, - const std::string &body, size_t content_length, + Request &req, const char *body, size_t content_length, ContentProvider content_provider, ContentProviderWithoutLength content_provider_without_length, - const char *content_type, Error &error) { - - Request req; - req.method = method; - req.headers = default_headers_; - req.headers.insert(headers.begin(), headers.end()); - req.path = path; - - if (content_type) { req.headers.emplace("Content-Type", content_type); } + const std::string &content_type, Error &error) { + if (!content_type.empty()) { req.set_header("Content-Type", content_type); } #ifdef CPPHTTPLIB_ZLIB_SUPPORT - if (compress_) { req.headers.emplace("Content-Encoding", "gzip"); } + if (compress_) { req.set_header("Content-Encoding", "gzip"); } #endif #ifdef CPPHTTPLIB_ZLIB_SUPPORT @@ -5388,13 +7544,14 @@ inline std::unique_ptr ClientImpl::send_with_content_provider( size_t offset = 0; DataSink data_sink; - data_sink.write = [&](const char *data, size_t data_len) { + data_sink.write = [&](const char *data, size_t data_len) -> bool { if (ok) { auto last = offset + data_len == content_length; auto ret = compressor.compress( - data, data_len, last, [&](const char *data, size_t data_len) { - req.body.append(data, data_len); + data, data_len, last, + [&](const char *compressed_data, size_t compressed_data_len) { + req.body.append(compressed_data, compressed_data_len); return true; }); @@ -5404,10 +7561,9 @@ inline std::unique_ptr ClientImpl::send_with_content_provider( ok = false; } } + return ok; }; - data_sink.is_writable = [&](void) { return ok && true; }; - while (ok && offset < content_length) { if (!content_provider(offset, content_length - offset, data_sink)) { error = Error::Canceled; @@ -5415,7 +7571,7 @@ inline std::unique_ptr ClientImpl::send_with_content_provider( } } } else { - if (!compressor.compress(body.data(), body.size(), true, + if (!compressor.compress(body, content_length, true, [&](const char *data, size_t data_len) { req.body.append(data, data_len); return true; @@ -5436,9 +7592,9 @@ inline std::unique_ptr ClientImpl::send_with_content_provider( req.content_provider_ = detail::ContentProviderAdapter( std::move(content_provider_without_length)); req.is_chunked_content_provider_ = true; - req.headers.emplace("Transfer-Encoding", "chunked"); + req.set_header("Transfer-Encoding", "chunked"); } else { - req.body = body; + req.body.assign(body, content_length); } } @@ -5447,24 +7603,51 @@ inline std::unique_ptr ClientImpl::send_with_content_provider( } inline Result ClientImpl::send_with_content_provider( - const char *method, const char *path, const Headers &headers, - const std::string &body, size_t content_length, - ContentProvider content_provider, + const std::string &method, const std::string &path, const Headers &headers, + const char *body, size_t content_length, ContentProvider content_provider, ContentProviderWithoutLength content_provider_without_length, - const char *content_type) { + const std::string &content_type, Progress progress) { + Request req; + req.method = method; + req.headers = headers; + req.path = path; + req.progress = progress; + auto error = Error::Success; + auto res = send_with_content_provider( - method, path, headers, body, content_length, std::move(content_provider), + req, body, content_length, std::move(content_provider), std::move(content_provider_without_length), content_type, error); - return Result{std::move(res), error}; + + return Result{std::move(res), error, std::move(req.headers)}; +} + +inline std::string +ClientImpl::adjust_host_string(const std::string &host) const { + if (host.find(':') != std::string::npos) { return "[" + host + "]"; } + return host; } -inline bool ClientImpl::process_request(Stream &strm, const Request &req, +inline bool ClientImpl::process_request(Stream &strm, Request &req, Response &res, bool close_connection, Error &error) { // Send request if (!write_request(strm, req, close_connection, error)) { return false; } +#ifdef CPPHTTPLIB_OPENSSL_SUPPORT + if (is_ssl()) { + auto is_proxy_enabled = !proxy_host_.empty() && proxy_port_ != -1; + if (!is_proxy_enabled) { + char buf[1]; + if (SSL_peek(socket_.ssl, buf, 1) == 0 && + SSL_get_error(socket_.ssl, 0) == SSL_ERROR_ZERO_RETURN) { + error = Error::SSLPeerCouldBeClosed_; + return false; + } + } + } +#endif + // Receive response and headers if (!read_response_line(strm, req, res) || !detail::read_headers(strm, res.headers)) { @@ -5472,20 +7655,24 @@ inline bool ClientImpl::process_request(Stream &strm, const Request &req, return false; } - if (req.response_handler_) { - if (!req.response_handler_(res)) { - error = Error::Canceled; - return false; + // Body + if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" && + req.method != "CONNECT") { + auto redirect = 300 < res.status && res.status < 400 && follow_location_; + + if (req.response_handler && !redirect) { + if (!req.response_handler(res)) { + error = Error::Canceled; + return false; + } } - } - // Body - if (req.method != "HEAD" && req.method != "CONNECT") { auto out = - req.content_receiver_ + req.content_receiver ? static_cast( [&](const char *buf, size_t n, uint64_t off, uint64_t len) { - auto ret = req.content_receiver_(buf, n, off, len); + if (redirect) { return true; } + auto ret = req.content_receiver(buf, n, off, len); if (!ret) { error = Error::Canceled; } return ret; }) @@ -5500,8 +7687,8 @@ inline bool ClientImpl::process_request(Stream &strm, const Request &req, }); auto progress = [&](uint64_t current, uint64_t total) { - if (!req.progress_) { return true; } - auto ret = req.progress_(current, total); + if (!req.progress || redirect) { return true; } + auto ret = req.progress(current, total); if (!ret) { error = Error::Canceled; } return ret; }; @@ -5515,27 +7702,56 @@ inline bool ClientImpl::process_request(Stream &strm, const Request &req, } } - if (res.get_header_value("Connection") == "close" || - (res.version == "HTTP/1.0" && res.reason != "Connection established")) { - // TODO this requires a not-entirely-obvious chain of calls to be correct - // for this to be safe. Maybe a code refactor (such as moving this out to - // the send function and getting rid of the recursiveness of the mutex) - // could make this more obvious. - - // This is safe to call because process_request is only called by - // handle_request which is only called by send, which locks the request - // mutex during the process. It would be a bug to call it from a different - // thread since it's a thread-safety issue to do these things to the socket - // if another thread is using the socket. - lock_socket_and_shutdown_and_close(); - } - // Log if (logger_) { logger_(req, res); } return true; } +inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider( + const std::string &boundary, const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items) const { + size_t cur_item = 0; + size_t cur_start = 0; + // cur_item and cur_start are copied to within the std::function and maintain + // state between successive calls + return [&, cur_item, cur_start](size_t offset, + DataSink &sink) mutable -> bool { + if (!offset && !items.empty()) { + sink.os << detail::serialize_multipart_formdata(items, boundary, false); + return true; + } else if (cur_item < provider_items.size()) { + if (!cur_start) { + const auto &begin = detail::serialize_multipart_formdata_item_begin( + provider_items[cur_item], boundary); + offset += begin.size(); + cur_start = offset; + sink.os << begin; + } + + DataSink cur_sink; + auto has_data = true; + cur_sink.write = sink.write; + cur_sink.done = [&]() { has_data = false; }; + + if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) { + return false; + } + + if (!has_data) { + sink.os << detail::serialize_multipart_formdata_item_end(); + cur_item++; + cur_start = 0; + } + return true; + } else { + sink.os << detail::serialize_multipart_formdata_finish(boundary); + sink.done(); + return true; + } + }; +} + inline bool ClientImpl::process_socket(const Socket &socket, std::function callback) { @@ -5546,69 +7762,68 @@ ClientImpl::process_socket(const Socket &socket, inline bool ClientImpl::is_ssl() const { return false; } -inline Result ClientImpl::Get(const char *path) { +inline Result ClientImpl::Get(const std::string &path) { return Get(path, Headers(), Progress()); } -inline Result ClientImpl::Get(const char *path, Progress progress) { +inline Result ClientImpl::Get(const std::string &path, Progress progress) { return Get(path, Headers(), std::move(progress)); } -inline Result ClientImpl::Get(const char *path, const Headers &headers) { +inline Result ClientImpl::Get(const std::string &path, const Headers &headers) { return Get(path, headers, Progress()); } -inline Result ClientImpl::Get(const char *path, const Headers &headers, +inline Result ClientImpl::Get(const std::string &path, const Headers &headers, Progress progress) { Request req; req.method = "GET"; req.path = path; - req.headers = default_headers_; - req.headers.insert(headers.begin(), headers.end()); - req.progress_ = std::move(progress); + req.headers = headers; + req.progress = std::move(progress); - return send(req); + return send_(std::move(req)); } -inline Result ClientImpl::Get(const char *path, +inline Result ClientImpl::Get(const std::string &path, ContentReceiver content_receiver) { return Get(path, Headers(), nullptr, std::move(content_receiver), nullptr); } -inline Result ClientImpl::Get(const char *path, +inline Result ClientImpl::Get(const std::string &path, ContentReceiver content_receiver, Progress progress) { return Get(path, Headers(), nullptr, std::move(content_receiver), std::move(progress)); } -inline Result ClientImpl::Get(const char *path, const Headers &headers, +inline Result ClientImpl::Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver) { return Get(path, headers, nullptr, std::move(content_receiver), nullptr); } -inline Result ClientImpl::Get(const char *path, const Headers &headers, +inline Result ClientImpl::Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, Progress progress) { return Get(path, headers, nullptr, std::move(content_receiver), std::move(progress)); } -inline Result ClientImpl::Get(const char *path, +inline Result ClientImpl::Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver) { return Get(path, Headers(), std::move(response_handler), std::move(content_receiver), nullptr); } -inline Result ClientImpl::Get(const char *path, const Headers &headers, +inline Result ClientImpl::Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver) { return Get(path, headers, std::move(response_handler), std::move(content_receiver), nullptr); } -inline Result ClientImpl::Get(const char *path, +inline Result ClientImpl::Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress) { @@ -5616,280 +7831,532 @@ inline Result ClientImpl::Get(const char *path, std::move(content_receiver), std::move(progress)); } -inline Result ClientImpl::Get(const char *path, const Headers &headers, +inline Result ClientImpl::Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress) { Request req; req.method = "GET"; req.path = path; - req.headers = default_headers_; - req.headers.insert(headers.begin(), headers.end()); - req.response_handler_ = std::move(response_handler); - req.content_receiver_ = + req.headers = headers; + req.response_handler = std::move(response_handler); + req.content_receiver = [content_receiver](const char *data, size_t data_length, uint64_t /*offset*/, uint64_t /*total_length*/) { return content_receiver(data, data_length); }; - req.progress_ = std::move(progress); + req.progress = std::move(progress); + + return send_(std::move(req)); +} + +inline Result ClientImpl::Get(const std::string &path, const Params ¶ms, + const Headers &headers, Progress progress) { + if (params.empty()) { return Get(path, headers); } + + std::string path_with_query = append_query_params(path, params); + return Get(path_with_query, headers, std::move(progress)); +} + +inline Result ClientImpl::Get(const std::string &path, const Params ¶ms, + const Headers &headers, + ContentReceiver content_receiver, + Progress progress) { + return Get(path, params, headers, nullptr, std::move(content_receiver), + std::move(progress)); +} + +inline Result ClientImpl::Get(const std::string &path, const Params ¶ms, + const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver, + Progress progress) { + if (params.empty()) { + return Get(path, headers, std::move(response_handler), + std::move(content_receiver), std::move(progress)); + } - return send(req); + std::string path_with_query = append_query_params(path, params); + return Get(path_with_query, headers, std::move(response_handler), + std::move(content_receiver), std::move(progress)); } -inline Result ClientImpl::Head(const char *path) { +inline Result ClientImpl::Head(const std::string &path) { return Head(path, Headers()); } -inline Result ClientImpl::Head(const char *path, const Headers &headers) { +inline Result ClientImpl::Head(const std::string &path, + const Headers &headers) { Request req; req.method = "HEAD"; - req.headers = default_headers_; - req.headers.insert(headers.begin(), headers.end()); + req.headers = headers; req.path = path; - return send(req); + return send_(std::move(req)); +} + +inline Result ClientImpl::Post(const std::string &path) { + return Post(path, std::string(), std::string()); +} + +inline Result ClientImpl::Post(const std::string &path, + const Headers &headers) { + return Post(path, headers, nullptr, 0, std::string()); } -inline Result ClientImpl::Post(const char *path) { - return Post(path, std::string(), nullptr); +inline Result ClientImpl::Post(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return Post(path, Headers(), body, content_length, content_type, nullptr); +} + +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type) { + return send_with_content_provider("POST", path, headers, body, content_length, + nullptr, nullptr, content_type, nullptr); +} + +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, + Progress progress) { + return send_with_content_provider("POST", path, headers, body, content_length, + nullptr, nullptr, content_type, progress); } -inline Result ClientImpl::Post(const char *path, const std::string &body, - const char *content_type) { +inline Result ClientImpl::Post(const std::string &path, const std::string &body, + const std::string &content_type) { return Post(path, Headers(), body, content_type); } -inline Result ClientImpl::Post(const char *path, const Headers &headers, +inline Result ClientImpl::Post(const std::string &path, const std::string &body, + const std::string &content_type, + Progress progress) { + return Post(path, Headers(), body, content_type, progress); +} + +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type) { + return send_with_content_provider("POST", path, headers, body.data(), + body.size(), nullptr, nullptr, content_type, + nullptr); +} + +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, const std::string &body, - const char *content_type) { - return send_with_content_provider("POST", path, headers, body, 0, nullptr, - nullptr, content_type); + const std::string &content_type, + Progress progress) { + return send_with_content_provider("POST", path, headers, body.data(), + body.size(), nullptr, nullptr, content_type, + progress); } -inline Result ClientImpl::Post(const char *path, const Params ¶ms) { +inline Result ClientImpl::Post(const std::string &path, const Params ¶ms) { return Post(path, Headers(), params); } -inline Result ClientImpl::Post(const char *path, size_t content_length, +inline Result ClientImpl::Post(const std::string &path, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return Post(path, Headers(), content_length, std::move(content_provider), content_type); } -inline Result ClientImpl::Post(const char *path, +inline Result ClientImpl::Post(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return Post(path, Headers(), std::move(content_provider), content_type); } -inline Result ClientImpl::Post(const char *path, const Headers &headers, +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, - const char *content_type) { - return send_with_content_provider("POST", path, headers, std::string(), + const std::string &content_type) { + return send_with_content_provider("POST", path, headers, nullptr, content_length, std::move(content_provider), - nullptr, content_type); + nullptr, content_type, nullptr); } -inline Result ClientImpl::Post(const char *path, const Headers &headers, +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type) { - return send_with_content_provider("POST", path, headers, std::string(), 0, - nullptr, std::move(content_provider), - content_type); + const std::string &content_type) { + return send_with_content_provider("POST", path, headers, nullptr, 0, nullptr, + std::move(content_provider), content_type, + nullptr); } -inline Result ClientImpl::Post(const char *path, const Headers &headers, +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, const Params ¶ms) { auto query = detail::params_to_query_str(params); return Post(path, headers, query, "application/x-www-form-urlencoded"); } -inline Result ClientImpl::Post(const char *path, +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress) { + auto query = detail::params_to_query_str(params); + return Post(path, headers, query, "application/x-www-form-urlencoded", + progress); +} + +inline Result ClientImpl::Post(const std::string &path, const MultipartFormDataItems &items) { return Post(path, Headers(), items); } -inline Result ClientImpl::Post(const char *path, const Headers &headers, +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items) { - return Post(path, headers, items, detail::make_multipart_data_boundary()); + const auto &boundary = detail::make_multipart_data_boundary(); + const auto &content_type = + detail::serialize_multipart_formdata_get_content_type(boundary); + const auto &body = detail::serialize_multipart_formdata(items, boundary); + return Post(path, headers, body, content_type); } -inline Result ClientImpl::Post(const char *path, const Headers &headers, + +inline Result ClientImpl::Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const std::string &boundary) { - for (size_t i = 0; i < boundary.size(); i++) { - char c = boundary[i]; - if (!std::isalnum(c) && c != '-' && c != '_') { - return Result{nullptr, Error::UnsupportedMultipartBoundaryChars}; - } + if (!detail::is_multipart_boundary_chars_valid(boundary)) { + return Result{nullptr, Error::UnsupportedMultipartBoundaryChars}; } - std::string body; + const auto &content_type = + detail::serialize_multipart_formdata_get_content_type(boundary); + const auto &body = detail::serialize_multipart_formdata(items, boundary); + return Post(path, headers, body, content_type); +} - for (const auto &item : items) { - body += "--" + boundary + "\r\n"; - body += "Content-Disposition: form-data; name=\"" + item.name + "\""; - if (!item.filename.empty()) { - body += "; filename=\"" + item.filename + "\""; - } - body += "\r\n"; - if (!item.content_type.empty()) { - body += "Content-Type: " + item.content_type + "\r\n"; - } - body += "\r\n"; - body += item.content + "\r\n"; - } +inline Result +ClientImpl::Post(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items) { + const auto &boundary = detail::make_multipart_data_boundary(); + const auto &content_type = + detail::serialize_multipart_formdata_get_content_type(boundary); + return send_with_content_provider( + "POST", path, headers, nullptr, 0, nullptr, + get_multipart_content_provider(boundary, items, provider_items), + content_type, nullptr); +} + +inline Result ClientImpl::Put(const std::string &path) { + return Put(path, std::string(), std::string()); +} + +inline Result ClientImpl::Put(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return Put(path, Headers(), body, content_length, content_type); +} + +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type) { + return send_with_content_provider("PUT", path, headers, body, content_length, + nullptr, nullptr, content_type, nullptr); +} + +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, + Progress progress) { + return send_with_content_provider("PUT", path, headers, body, content_length, + nullptr, nullptr, content_type, progress); +} + +inline Result ClientImpl::Put(const std::string &path, const std::string &body, + const std::string &content_type) { + return Put(path, Headers(), body, content_type); +} + +inline Result ClientImpl::Put(const std::string &path, const std::string &body, + const std::string &content_type, + Progress progress) { + return Put(path, Headers(), body, content_type, progress); +} + +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type) { + return send_with_content_provider("PUT", path, headers, body.data(), + body.size(), nullptr, nullptr, content_type, + nullptr); +} + +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type, + Progress progress) { + return send_with_content_provider("PUT", path, headers, body.data(), + body.size(), nullptr, nullptr, content_type, + progress); +} + +inline Result ClientImpl::Put(const std::string &path, size_t content_length, + ContentProvider content_provider, + const std::string &content_type) { + return Put(path, Headers(), content_length, std::move(content_provider), + content_type); +} + +inline Result ClientImpl::Put(const std::string &path, + ContentProviderWithoutLength content_provider, + const std::string &content_type) { + return Put(path, Headers(), std::move(content_provider), content_type); +} + +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + size_t content_length, + ContentProvider content_provider, + const std::string &content_type) { + return send_with_content_provider("PUT", path, headers, nullptr, + content_length, std::move(content_provider), + nullptr, content_type, nullptr); +} + +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + ContentProviderWithoutLength content_provider, + const std::string &content_type) { + return send_with_content_provider("PUT", path, headers, nullptr, 0, nullptr, + std::move(content_provider), content_type, + nullptr); +} + +inline Result ClientImpl::Put(const std::string &path, const Params ¶ms) { + return Put(path, Headers(), params); +} + +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const Params ¶ms) { + auto query = detail::params_to_query_str(params); + return Put(path, headers, query, "application/x-www-form-urlencoded"); +} - body += "--" + boundary + "--\r\n"; +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress) { + auto query = detail::params_to_query_str(params); + return Put(path, headers, query, "application/x-www-form-urlencoded", + progress); +} - std::string content_type = "multipart/form-data; boundary=" + boundary; - return Post(path, headers, body, content_type.c_str()); +inline Result ClientImpl::Put(const std::string &path, + const MultipartFormDataItems &items) { + return Put(path, Headers(), items); } -inline Result ClientImpl::Put(const char *path) { - return Put(path, std::string(), nullptr); +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items) { + const auto &boundary = detail::make_multipart_data_boundary(); + const auto &content_type = + detail::serialize_multipart_formdata_get_content_type(boundary); + const auto &body = detail::serialize_multipart_formdata(items, boundary); + return Put(path, headers, body, content_type); } -inline Result ClientImpl::Put(const char *path, const std::string &body, - const char *content_type) { - return Put(path, Headers(), body, content_type); +inline Result ClientImpl::Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const std::string &boundary) { + if (!detail::is_multipart_boundary_chars_valid(boundary)) { + return Result{nullptr, Error::UnsupportedMultipartBoundaryChars}; + } + + const auto &content_type = + detail::serialize_multipart_formdata_get_content_type(boundary); + const auto &body = detail::serialize_multipart_formdata(items, boundary); + return Put(path, headers, body, content_type); } -inline Result ClientImpl::Put(const char *path, const Headers &headers, - const std::string &body, - const char *content_type) { - return send_with_content_provider("PUT", path, headers, body, 0, nullptr, - nullptr, content_type); +inline Result +ClientImpl::Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items) { + const auto &boundary = detail::make_multipart_data_boundary(); + const auto &content_type = + detail::serialize_multipart_formdata_get_content_type(boundary); + return send_with_content_provider( + "PUT", path, headers, nullptr, 0, nullptr, + get_multipart_content_provider(boundary, items, provider_items), + content_type, nullptr); +} +inline Result ClientImpl::Patch(const std::string &path) { + return Patch(path, std::string(), std::string()); } -inline Result ClientImpl::Put(const char *path, size_t content_length, - ContentProvider content_provider, - const char *content_type) { - return Put(path, Headers(), content_length, std::move(content_provider), - content_type); +inline Result ClientImpl::Patch(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return Patch(path, Headers(), body, content_length, content_type); } -inline Result ClientImpl::Put(const char *path, - ContentProviderWithoutLength content_provider, - const char *content_type) { - return Put(path, Headers(), std::move(content_provider), content_type); +inline Result ClientImpl::Patch(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type, + Progress progress) { + return Patch(path, Headers(), body, content_length, content_type, progress); } -inline Result ClientImpl::Put(const char *path, const Headers &headers, - size_t content_length, - ContentProvider content_provider, - const char *content_type) { - return send_with_content_provider("PUT", path, headers, std::string(), - content_length, std::move(content_provider), - nullptr, content_type); +inline Result ClientImpl::Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type) { + return Patch(path, headers, body, content_length, content_type, nullptr); } -inline Result ClientImpl::Put(const char *path, const Headers &headers, - ContentProviderWithoutLength content_provider, - const char *content_type) { - return send_with_content_provider("PUT", path, headers, std::string(), 0, - nullptr, std::move(content_provider), - content_type); +inline Result ClientImpl::Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, + Progress progress) { + return send_with_content_provider("PATCH", path, headers, body, + content_length, nullptr, nullptr, + content_type, progress); } -inline Result ClientImpl::Put(const char *path, const Params ¶ms) { - return Put(path, Headers(), params); +inline Result ClientImpl::Patch(const std::string &path, + const std::string &body, + const std::string &content_type) { + return Patch(path, Headers(), body, content_type); } -inline Result ClientImpl::Put(const char *path, const Headers &headers, - const Params ¶ms) { - auto query = detail::params_to_query_str(params); - return Put(path, headers, query, "application/x-www-form-urlencoded"); +inline Result ClientImpl::Patch(const std::string &path, + const std::string &body, + const std::string &content_type, + Progress progress) { + return Patch(path, Headers(), body, content_type, progress); } -inline Result ClientImpl::Patch(const char *path, const std::string &body, - const char *content_type) { - return Patch(path, Headers(), body, content_type); +inline Result ClientImpl::Patch(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type) { + return Patch(path, headers, body, content_type, nullptr); } -inline Result ClientImpl::Patch(const char *path, const Headers &headers, +inline Result ClientImpl::Patch(const std::string &path, const Headers &headers, const std::string &body, - const char *content_type) { - return send_with_content_provider("PATCH", path, headers, body, 0, nullptr, - nullptr, content_type); + const std::string &content_type, + Progress progress) { + return send_with_content_provider("PATCH", path, headers, body.data(), + body.size(), nullptr, nullptr, content_type, + progress); } -inline Result ClientImpl::Patch(const char *path, size_t content_length, +inline Result ClientImpl::Patch(const std::string &path, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return Patch(path, Headers(), content_length, std::move(content_provider), content_type); } -inline Result ClientImpl::Patch(const char *path, +inline Result ClientImpl::Patch(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return Patch(path, Headers(), std::move(content_provider), content_type); } -inline Result ClientImpl::Patch(const char *path, const Headers &headers, +inline Result ClientImpl::Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, - const char *content_type) { - return send_with_content_provider("PATCH", path, headers, std::string(), + const std::string &content_type) { + return send_with_content_provider("PATCH", path, headers, nullptr, content_length, std::move(content_provider), - nullptr, content_type); + nullptr, content_type, nullptr); } -inline Result ClientImpl::Patch(const char *path, const Headers &headers, +inline Result ClientImpl::Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type) { - return send_with_content_provider("PATCH", path, headers, std::string(), 0, - nullptr, std::move(content_provider), - content_type); + const std::string &content_type) { + return send_with_content_provider("PATCH", path, headers, nullptr, 0, nullptr, + std::move(content_provider), content_type, + nullptr); +} + +inline Result ClientImpl::Delete(const std::string &path) { + return Delete(path, Headers(), std::string(), std::string()); } -inline Result ClientImpl::Delete(const char *path) { - return Delete(path, Headers(), std::string(), nullptr); +inline Result ClientImpl::Delete(const std::string &path, + const Headers &headers) { + return Delete(path, headers, std::string(), std::string()); } -inline Result ClientImpl::Delete(const char *path, const std::string &body, - const char *content_type) { - return Delete(path, Headers(), body, content_type); +inline Result ClientImpl::Delete(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return Delete(path, Headers(), body, content_length, content_type); } -inline Result ClientImpl::Delete(const char *path, const Headers &headers) { - return Delete(path, headers, std::string(), nullptr); +inline Result ClientImpl::Delete(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type, + Progress progress) { + return Delete(path, Headers(), body, content_length, content_type, progress); } -inline Result ClientImpl::Delete(const char *path, const Headers &headers, - const std::string &body, - const char *content_type) { +inline Result ClientImpl::Delete(const std::string &path, + const Headers &headers, const char *body, + size_t content_length, + const std::string &content_type) { + return Delete(path, headers, body, content_length, content_type, nullptr); +} + +inline Result ClientImpl::Delete(const std::string &path, + const Headers &headers, const char *body, + size_t content_length, + const std::string &content_type, + Progress progress) { Request req; req.method = "DELETE"; - req.headers = default_headers_; - req.headers.insert(headers.begin(), headers.end()); + req.headers = headers; req.path = path; + req.progress = progress; + + if (!content_type.empty()) { req.set_header("Content-Type", content_type); } + req.body.assign(body, content_length); + + return send_(std::move(req)); +} + +inline Result ClientImpl::Delete(const std::string &path, + const std::string &body, + const std::string &content_type) { + return Delete(path, Headers(), body.data(), body.size(), content_type); +} + +inline Result ClientImpl::Delete(const std::string &path, + const std::string &body, + const std::string &content_type, + Progress progress) { + return Delete(path, Headers(), body.data(), body.size(), content_type, + progress); +} - if (content_type) { req.headers.emplace("Content-Type", content_type); } - req.body = body; +inline Result ClientImpl::Delete(const std::string &path, + const Headers &headers, + const std::string &body, + const std::string &content_type) { + return Delete(path, headers, body.data(), body.size(), content_type); +} - return send(req); +inline Result ClientImpl::Delete(const std::string &path, + const Headers &headers, + const std::string &body, + const std::string &content_type, + Progress progress) { + return Delete(path, headers, body.data(), body.size(), content_type, + progress); } -inline Result ClientImpl::Options(const char *path) { +inline Result ClientImpl::Options(const std::string &path) { return Options(path, Headers()); } -inline Result ClientImpl::Options(const char *path, const Headers &headers) { +inline Result ClientImpl::Options(const std::string &path, + const Headers &headers) { Request req; req.method = "OPTIONS"; - req.headers = default_headers_; - req.headers.insert(headers.begin(), headers.end()); + req.headers = headers; req.path = path; - return send(req); -} - -inline size_t ClientImpl::is_socket_open() const { - std::lock_guard guard(socket_mutex_); - return socket_.is_open(); + return send_(std::move(req)); } inline void ClientImpl::stop() { @@ -5909,12 +8376,23 @@ inline void ClientImpl::stop() { return; } - // Otherwise, sitll holding the mutex, we can shut everything down ourselves + // Otherwise, still holding the mutex, we can shut everything down ourselves shutdown_ssl(socket_, true); shutdown_socket(socket_); close_socket(socket_); } +inline std::string ClientImpl::host() const { return host_; } + +inline int ClientImpl::port() const { return port_; } + +inline size_t ClientImpl::is_socket_open() const { + std::lock_guard guard(socket_mutex_); + return socket_.is_open(); +} + +inline socket_t ClientImpl::socket() const { return socket_.sock; } + inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) { connection_timeout_sec_ = sec; connection_timeout_usec_ = usec; @@ -5930,19 +8408,19 @@ inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) { write_timeout_usec_ = usec; } -inline void ClientImpl::set_basic_auth(const char *username, - const char *password) { +inline void ClientImpl::set_basic_auth(const std::string &username, + const std::string &password) { basic_auth_username_ = username; basic_auth_password_ = password; } -inline void ClientImpl::set_bearer_token_auth(const char *token) { +inline void ClientImpl::set_bearer_token_auth(const std::string &token) { bearer_token_auth_token_ = token; } #ifdef CPPHTTPLIB_OPENSSL_SUPPORT -inline void ClientImpl::set_digest_auth(const char *username, - const char *password) { +inline void ClientImpl::set_digest_auth(const std::string &username, + const std::string &password) { digest_auth_username_ = username; digest_auth_password_ = password; } @@ -5952,10 +8430,26 @@ inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; } inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; } +inline void ClientImpl::set_url_encode(bool on) { url_encode_ = on; } + +inline void +ClientImpl::set_hostname_addr_map(std::map addr_map) { + addr_map_ = std::move(addr_map); +} + inline void ClientImpl::set_default_headers(Headers headers) { default_headers_ = std::move(headers); } +inline void ClientImpl::set_header_writer( + std::function const &writer) { + header_writer_ = writer; +} + +inline void ClientImpl::set_address_family(int family) { + address_family_ = family; +} + inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; } inline void ClientImpl::set_socket_options(SocketOptions socket_options) { @@ -5966,32 +8460,71 @@ inline void ClientImpl::set_compress(bool on) { compress_ = on; } inline void ClientImpl::set_decompress(bool on) { decompress_ = on; } -inline void ClientImpl::set_interface(const char *intf) { interface_ = intf; } +inline void ClientImpl::set_interface(const std::string &intf) { + interface_ = intf; +} -inline void ClientImpl::set_proxy(const char *host, int port) { +inline void ClientImpl::set_proxy(const std::string &host, int port) { proxy_host_ = host; proxy_port_ = port; } -inline void ClientImpl::set_proxy_basic_auth(const char *username, - const char *password) { +inline void ClientImpl::set_proxy_basic_auth(const std::string &username, + const std::string &password) { proxy_basic_auth_username_ = username; proxy_basic_auth_password_ = password; } -inline void ClientImpl::set_proxy_bearer_token_auth(const char *token) { +inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) { proxy_bearer_token_auth_token_ = token; } #ifdef CPPHTTPLIB_OPENSSL_SUPPORT -inline void ClientImpl::set_proxy_digest_auth(const char *username, - const char *password) { +inline void ClientImpl::set_proxy_digest_auth(const std::string &username, + const std::string &password) { proxy_digest_auth_username_ = username; proxy_digest_auth_password_ = password; } -#endif -#ifdef CPPHTTPLIB_OPENSSL_SUPPORT +inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path, + const std::string &ca_cert_dir_path) { + ca_cert_file_path_ = ca_cert_file_path; + ca_cert_dir_path_ = ca_cert_dir_path; +} + +inline void ClientImpl::set_ca_cert_store(X509_STORE *ca_cert_store) { + if (ca_cert_store && ca_cert_store != ca_cert_store_) { + ca_cert_store_ = ca_cert_store; + } +} + +inline X509_STORE *ClientImpl::create_ca_cert_store(const char *ca_cert, + std::size_t size) const { + auto mem = BIO_new_mem_buf(ca_cert, static_cast(size)); + if (!mem) { return nullptr; } + + auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr); + if (!inf) { + BIO_free_all(mem); + return nullptr; + } + + auto cts = X509_STORE_new(); + if (cts) { + for (auto i = 0; i < static_cast(sk_X509_INFO_num(inf)); i++) { + auto itmp = sk_X509_INFO_value(inf, i); + if (!itmp) { continue; } + + if (itmp->x509) { X509_STORE_add_cert(cts, itmp->x509); } + if (itmp->crl) { X509_STORE_add_crl(cts, itmp->crl); } + } + } + + sk_X509_INFO_pop_free(inf, X509_INFO_free); + BIO_free_all(mem); + return cts; +} + inline void ClientImpl::enable_server_certificate_verification(bool enabled) { server_certificate_verification_ = enabled; } @@ -6038,13 +8571,29 @@ inline SSL *ssl_new(socket_t sock, SSL_CTX *ctx, std::mutex &ctx_mutex, return ssl; } -inline void ssl_delete(std::mutex &ctx_mutex, SSL *ssl, +inline void ssl_delete(std::mutex &ctx_mutex, SSL *ssl, socket_t sock, bool shutdown_gracefully) { // sometimes we may want to skip this to try to avoid SIGPIPE if we know // the remote has closed the network connection // Note that it is not always possible to avoid SIGPIPE, this is merely a // best-efforts. - if (shutdown_gracefully) { SSL_shutdown(ssl); } + if (shutdown_gracefully) { +#ifdef _WIN32 + SSL_shutdown(ssl); +#else + timeval tv; + tv.tv_sec = 1; + tv.tv_usec = 0; + setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, + reinterpret_cast(&tv), sizeof(tv)); + + auto ret = SSL_shutdown(ssl); + while (ret == 0) { + std::this_thread::sleep_for(std::chrono::milliseconds(100)); + ret = SSL_shutdown(ssl); + } +#endif + } std::lock_guard guard(ctx_mutex); SSL_free(ssl); @@ -6055,7 +8604,7 @@ bool ssl_connect_or_accept_nonblocking(socket_t sock, SSL *ssl, U ssl_connect_or_accept, time_t timeout_sec, time_t timeout_usec) { - int res = 0; + auto res = 0; while ((res = ssl_connect_or_accept(ssl)) != 1) { auto err = SSL_get_error(ssl, res); switch (err) { @@ -6073,14 +8622,13 @@ bool ssl_connect_or_accept_nonblocking(socket_t sock, SSL *ssl, } template -inline bool -process_server_socket_ssl(SSL *ssl, socket_t sock, size_t keep_alive_max_count, - time_t keep_alive_timeout_sec, - time_t read_timeout_sec, time_t read_timeout_usec, - time_t write_timeout_sec, time_t write_timeout_usec, - T callback) { +inline bool process_server_socket_ssl( + const std::atomic &svr_sock, SSL *ssl, socket_t sock, + size_t keep_alive_max_count, time_t keep_alive_timeout_sec, + time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec, + time_t write_timeout_usec, T callback) { return process_server_socket_core( - sock, keep_alive_max_count, keep_alive_timeout_sec, + svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec, [&](bool close_connection, bool &connection_closed) { SSLSocketStream strm(sock, ssl, read_timeout_sec, read_timeout_usec, write_timeout_sec, write_timeout_usec); @@ -6098,55 +8646,12 @@ process_client_socket_ssl(SSL *ssl, socket_t sock, time_t read_timeout_sec, return callback(strm); } -#if OPENSSL_VERSION_NUMBER < 0x10100000L -static std::shared_ptr> openSSL_locks_; - -class SSLThreadLocks { -public: - SSLThreadLocks() { - openSSL_locks_ = - std::make_shared>(CRYPTO_num_locks()); - CRYPTO_set_locking_callback(locking_callback); - } - - ~SSLThreadLocks() { CRYPTO_set_locking_callback(nullptr); } - -private: - static void locking_callback(int mode, int type, const char * /*file*/, - int /*line*/) { - auto &lk = (*openSSL_locks_)[static_cast(type)]; - if (mode & CRYPTO_LOCK) { - lk.lock(); - } else { - lk.unlock(); - } - } -}; - -#endif - class SSLInit { public: SSLInit() { -#if OPENSSL_VERSION_NUMBER < 0x1010001fL - SSL_load_error_strings(); - SSL_library_init(); -#else OPENSSL_init_ssl( OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL); -#endif - } - - ~SSLInit() { -#if OPENSSL_VERSION_NUMBER < 0x1010001fL - ERR_free_strings(); -#endif } - -private: -#if OPENSSL_VERSION_NUMBER < 0x10100000L - SSLThreadLocks thread_init_; -#endif }; // SSL socket stream implementation @@ -6162,15 +8667,15 @@ inline SSLSocketStream::SSLSocketStream(socket_t sock, SSL *ssl, SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY); } -inline SSLSocketStream::~SSLSocketStream() {} +inline SSLSocketStream::~SSLSocketStream() = default; inline bool SSLSocketStream::is_readable() const { return detail::select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0; } inline bool SSLSocketStream::is_writable() const { - return detail::select_write(sock_, write_timeout_sec_, write_timeout_usec_) > - 0; + return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 && + is_socket_alive(sock_); } inline ssize_t SSLSocketStream::read(char *ptr, size_t size) { @@ -6180,10 +8685,18 @@ inline ssize_t SSLSocketStream::read(char *ptr, size_t size) { auto ret = SSL_read(ssl_, ptr, static_cast(size)); if (ret < 0) { auto err = SSL_get_error(ssl_, ret); - while (err == SSL_ERROR_WANT_READ) { + auto n = 1000; +#ifdef _WIN32 + while (--n >= 0 && (err == SSL_ERROR_WANT_READ || + (err == SSL_ERROR_SYSCALL && + WSAGetLastError() == WSAETIMEDOUT))) { +#else + while (--n >= 0 && err == SSL_ERROR_WANT_READ) { +#endif if (SSL_pending(ssl_) > 0) { return SSL_read(ssl_, ptr, static_cast(size)); } else if (is_readable()) { + std::this_thread::sleep_for(std::chrono::milliseconds(1)); ret = SSL_read(ssl_, ptr, static_cast(size)); if (ret >= 0) { return ret; } err = SSL_get_error(ssl_, ret); @@ -6198,7 +8711,33 @@ inline ssize_t SSLSocketStream::read(char *ptr, size_t size) { } inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) { - if (is_writable()) { return SSL_write(ssl_, ptr, static_cast(size)); } + if (is_writable()) { + auto handle_size = static_cast( + std::min(size, (std::numeric_limits::max)())); + + auto ret = SSL_write(ssl_, ptr, static_cast(handle_size)); + if (ret < 0) { + auto err = SSL_get_error(ssl_, ret); + auto n = 1000; +#ifdef _WIN32 + while (--n >= 0 && (err == SSL_ERROR_WANT_WRITE || + (err == SSL_ERROR_SYSCALL && + WSAGetLastError() == WSAETIMEDOUT))) { +#else + while (--n >= 0 && err == SSL_ERROR_WANT_WRITE) { +#endif + if (is_writable()) { + std::this_thread::sleep_for(std::chrono::milliseconds(1)); + ret = SSL_write(ssl_, ptr, static_cast(handle_size)); + if (ret >= 0) { return ret; } + err = SSL_get_error(ssl_, ret); + } else { + return -1; + } + } + } + return ret; + } return -1; } @@ -6207,6 +8746,11 @@ inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip, detail::get_remote_ip_and_port(sock_, ip, port); } +inline void SSLSocketStream::get_local_ip_and_port(std::string &ip, + int &port) const { + detail::get_local_ip_and_port(sock_, ip, port); +} + inline socket_t SSLSocketStream::socket() const { return sock_; } static SSLInit sslinit_; @@ -6216,18 +8760,22 @@ static SSLInit sslinit_; // SSL HTTP server implementation inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path, const char *client_ca_cert_file_path, - const char *client_ca_cert_dir_path) { - ctx_ = SSL_CTX_new(SSLv23_server_method()); + const char *client_ca_cert_dir_path, + const char *private_key_password) { + ctx_ = SSL_CTX_new(TLS_server_method()); if (ctx_) { SSL_CTX_set_options(ctx_, - SSL_OP_ALL | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | - SSL_OP_NO_COMPRESSION | + SSL_OP_NO_COMPRESSION | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION); - // auto ecdh = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1); - // SSL_CTX_set_tmp_ecdh(ctx_, ecdh); - // EC_KEY_free(ecdh); + SSL_CTX_set_min_proto_version(ctx_, TLS1_2_VERSION); + + if (private_key_password != nullptr && (private_key_password[0] != '\0')) { + SSL_CTX_set_default_passwd_cb_userdata( + ctx_, + reinterpret_cast(const_cast(private_key_password))); + } if (SSL_CTX_use_certificate_chain_file(ctx_, cert_path) != 1 || SSL_CTX_use_PrivateKey_file(ctx_, private_key_path, SSL_FILETYPE_PEM) != @@ -6235,46 +8783,46 @@ inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path, SSL_CTX_free(ctx_); ctx_ = nullptr; } else if (client_ca_cert_file_path || client_ca_cert_dir_path) { - // if (client_ca_cert_file_path) { - // auto list = SSL_load_client_CA_file(client_ca_cert_file_path); - // SSL_CTX_set_client_CA_list(ctx_, list); - // } - SSL_CTX_load_verify_locations(ctx_, client_ca_cert_file_path, client_ca_cert_dir_path); SSL_CTX_set_verify( - ctx_, - SSL_VERIFY_PEER | - SSL_VERIFY_FAIL_IF_NO_PEER_CERT, // SSL_VERIFY_CLIENT_ONCE, - nullptr); + ctx_, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT, nullptr); } } } inline SSLServer::SSLServer(X509 *cert, EVP_PKEY *private_key, X509_STORE *client_ca_cert_store) { - ctx_ = SSL_CTX_new(SSLv23_server_method()); + ctx_ = SSL_CTX_new(TLS_server_method()); if (ctx_) { SSL_CTX_set_options(ctx_, - SSL_OP_ALL | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | - SSL_OP_NO_COMPRESSION | + SSL_OP_NO_COMPRESSION | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION); + SSL_CTX_set_min_proto_version(ctx_, TLS1_2_VERSION); + if (SSL_CTX_use_certificate(ctx_, cert) != 1 || SSL_CTX_use_PrivateKey(ctx_, private_key) != 1) { SSL_CTX_free(ctx_); ctx_ = nullptr; } else if (client_ca_cert_store) { - SSL_CTX_set_cert_store(ctx_, client_ca_cert_store); SSL_CTX_set_verify( - ctx_, - SSL_VERIFY_PEER | - SSL_VERIFY_FAIL_IF_NO_PEER_CERT, // SSL_VERIFY_CLIENT_ONCE, - nullptr); + ctx_, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT, nullptr); + } + } +} + +inline SSLServer::SSLServer( + const std::function &setup_ssl_ctx_callback) { + ctx_ = SSL_CTX_new(TLS_method()); + if (ctx_) { + if (!setup_ssl_ctx_callback(*ctx_)) { + SSL_CTX_free(ctx_); + ctx_ = nullptr; } } } @@ -6285,19 +8833,34 @@ inline SSLServer::~SSLServer() { inline bool SSLServer::is_valid() const { return ctx_; } +inline SSL_CTX *SSLServer::ssl_context() const { return ctx_; } + +inline void SSLServer::update_certs(X509 *cert, EVP_PKEY *private_key, + X509_STORE *client_ca_cert_store) { + + std::lock_guard guard(ctx_mutex_); + + SSL_CTX_use_certificate(ctx_, cert); + SSL_CTX_use_PrivateKey(ctx_, private_key); + + if (client_ca_cert_store != nullptr) { + SSL_CTX_set_cert_store(ctx_, client_ca_cert_store); + } +} + inline bool SSLServer::process_and_close_socket(socket_t sock) { auto ssl = detail::ssl_new( sock, ctx_, ctx_mutex_, - [&](SSL *ssl) { + [&](SSL *ssl2) { return detail::ssl_connect_or_accept_nonblocking( - sock, ssl, SSL_accept, read_timeout_sec_, read_timeout_usec_); + sock, ssl2, SSL_accept, read_timeout_sec_, read_timeout_usec_); }, - [](SSL * /*ssl*/) { return true; }); + [](SSL * /*ssl2*/) { return true; }); - bool ret = false; + auto ret = false; if (ssl) { ret = detail::process_server_socket_ssl( - ssl, sock, keep_alive_max_count_, keep_alive_timeout_sec_, + svr_sock_, ssl, sock, keep_alive_max_count_, keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_, write_timeout_usec_, [this, ssl](Stream &strm, bool close_connection, @@ -6309,7 +8872,7 @@ inline bool SSLServer::process_and_close_socket(socket_t sock) { // Shutdown gracefully if the result seemed successful, non-gracefully if // the connection appeared to be closed. const bool shutdown_gracefully = ret; - detail::ssl_delete(ctx_mutex_, ssl, shutdown_gracefully); + detail::ssl_delete(ctx_mutex_, ssl, sock, shutdown_gracefully); } detail::shutdown_socket(sock); @@ -6326,15 +8889,23 @@ inline SSLClient::SSLClient(const std::string &host, int port) inline SSLClient::SSLClient(const std::string &host, int port, const std::string &client_cert_path, - const std::string &client_key_path) + const std::string &client_key_path, + const std::string &private_key_password) : ClientImpl(host, port, client_cert_path, client_key_path) { - ctx_ = SSL_CTX_new(SSLv23_client_method()); + ctx_ = SSL_CTX_new(TLS_client_method()); detail::split(&host_[0], &host_[host_.size()], '.', [&](const char *b, const char *e) { - host_components_.emplace_back(std::string(b, e)); + host_components_.emplace_back(b, e); }); + if (!client_cert_path.empty() && !client_key_path.empty()) { + if (!private_key_password.empty()) { + SSL_CTX_set_default_passwd_cb_userdata( + ctx_, reinterpret_cast( + const_cast(private_key_password.c_str()))); + } + if (SSL_CTX_use_certificate_file(ctx_, client_cert_path.c_str(), SSL_FILETYPE_PEM) != 1 || SSL_CTX_use_PrivateKey_file(ctx_, client_key_path.c_str(), @@ -6346,15 +8917,23 @@ inline SSLClient::SSLClient(const std::string &host, int port, } inline SSLClient::SSLClient(const std::string &host, int port, - X509 *client_cert, EVP_PKEY *client_key) + X509 *client_cert, EVP_PKEY *client_key, + const std::string &private_key_password) : ClientImpl(host, port) { - ctx_ = SSL_CTX_new(SSLv23_client_method()); + ctx_ = SSL_CTX_new(TLS_client_method()); detail::split(&host_[0], &host_[host_.size()], '.', [&](const char *b, const char *e) { - host_components_.emplace_back(std::string(b, e)); + host_components_.emplace_back(b, e); }); + if (client_cert != nullptr && client_key != nullptr) { + if (!private_key_password.empty()) { + SSL_CTX_set_default_passwd_cb_userdata( + ctx_, reinterpret_cast( + const_cast(private_key_password.c_str()))); + } + if (SSL_CTX_use_certificate(ctx_, client_cert) != 1 || SSL_CTX_use_PrivateKey(ctx_, client_key) != 1) { SSL_CTX_free(ctx_); @@ -6368,17 +8947,11 @@ inline SSLClient::~SSLClient() { // Make sure to shut down SSL since shutdown_ssl will resolve to the // base function rather than the derived function once we get to the // base class destructor, and won't free the SSL (causing a leak). - SSLClient::shutdown_ssl(socket_, true); + shutdown_ssl_impl(socket_, true); } inline bool SSLClient::is_valid() const { return ctx_; } -inline void SSLClient::set_ca_cert_path(const char *ca_cert_file_path, - const char *ca_cert_dir_path) { - if (ca_cert_file_path) { ca_cert_file_path_ = ca_cert_file_path; } - if (ca_cert_dir_path) { ca_cert_dir_path_ = ca_cert_dir_path; } -} - inline void SSLClient::set_ca_cert_store(X509_STORE *ca_cert_store) { if (ca_cert_store) { if (ctx_) { @@ -6392,6 +8965,11 @@ inline void SSLClient::set_ca_cert_store(X509_STORE *ca_cert_store) { } } +inline void SSLClient::load_ca_cert_store(const char *ca_cert, + std::size_t size) { + set_ca_cert_store(ClientImpl::create_ca_cert_store(ca_cert, size)); +} + inline long SSLClient::get_openssl_verify_result() const { return verify_result_; } @@ -6406,14 +8984,14 @@ inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) { inline bool SSLClient::connect_with_proxy(Socket &socket, Response &res, bool &success, Error &error) { success = true; - Response res2; + Response proxy_res; if (!detail::process_client_socket( socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_, write_timeout_usec_, [&](Stream &strm) { Request req2; req2.method = "CONNECT"; req2.path = host_and_port_; - return process_request(strm, req2, res2, false, error); + return process_request(strm, req2, proxy_res, false, error); })) { // Thread-safe to close everything because we are assuming there are no // requests in flight @@ -6424,12 +9002,12 @@ inline bool SSLClient::connect_with_proxy(Socket &socket, Response &res, return false; } - if (res2.status == 407) { + if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) { if (!proxy_digest_auth_username_.empty() && !proxy_digest_auth_password_.empty()) { std::map auth; - if (detail::parse_www_authenticate(res2, auth, true)) { - Response res3; + if (detail::parse_www_authenticate(proxy_res, auth, true)) { + proxy_res = Response(); if (!detail::process_client_socket( socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_, write_timeout_usec_, [&](Stream &strm) { @@ -6440,7 +9018,7 @@ inline bool SSLClient::connect_with_proxy(Socket &socket, Response &res, req3, auth, 1, detail::random_string(10), proxy_digest_auth_username_, proxy_digest_auth_password_, true)); - return process_request(strm, req3, res3, false, error); + return process_request(strm, req3, proxy_res, false, error); })) { // Thread-safe to close everything because we are assuming there are // no requests in flight @@ -6451,17 +9029,28 @@ inline bool SSLClient::connect_with_proxy(Socket &socket, Response &res, return false; } } - } else { - res = res2; - return false; } } + // If status code is not 200, proxy request is failed. + // Set error to ProxyConnection and return proxy response + // as the response of the request + if (proxy_res.status != StatusCode::OK_200) { + error = Error::ProxyConnection; + res = std::move(proxy_res); + // Thread-safe to close everything because we are assuming there are + // no requests in flight + shutdown_ssl(socket, true); + shutdown_socket(socket); + close_socket(socket); + return false; + } + return true; } inline bool SSLClient::load_certs() { - bool ret = true; + auto ret = true; std::call_once(initialize_cert_, [&]() { std::lock_guard guard(ctx_mutex_); @@ -6476,11 +9065,16 @@ inline bool SSLClient::load_certs() { ret = false; } } else { + auto loaded = false; #ifdef _WIN32 - detail::load_system_certs_on_windows(SSL_CTX_get_cert_store(ctx_)); -#else - SSL_CTX_set_default_verify_paths(ctx_); -#endif + loaded = + detail::load_system_certs_on_windows(SSL_CTX_get_cert_store(ctx_)); +#elif defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && defined(__APPLE__) +#if TARGET_OS_OSX + loaded = detail::load_system_certs_on_macos(SSL_CTX_get_cert_store(ctx_)); +#endif // TARGET_OS_OSX +#endif // _WIN32 + if (!loaded) { SSL_CTX_set_default_verify_paths(ctx_); } } }); @@ -6490,31 +9084,31 @@ inline bool SSLClient::load_certs() { inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) { auto ssl = detail::ssl_new( socket.sock, ctx_, ctx_mutex_, - [&](SSL *ssl) { + [&](SSL *ssl2) { if (server_certificate_verification_) { if (!load_certs()) { error = Error::SSLLoadingCerts; return false; } - SSL_set_verify(ssl, SSL_VERIFY_NONE, nullptr); + SSL_set_verify(ssl2, SSL_VERIFY_NONE, nullptr); } if (!detail::ssl_connect_or_accept_nonblocking( - socket.sock, ssl, SSL_connect, connection_timeout_sec_, + socket.sock, ssl2, SSL_connect, connection_timeout_sec_, connection_timeout_usec_)) { error = Error::SSLConnection; return false; } if (server_certificate_verification_) { - verify_result_ = SSL_get_verify_result(ssl); + verify_result_ = SSL_get_verify_result(ssl2); if (verify_result_ != X509_V_OK) { error = Error::SSLServerVerification; return false; } - auto server_cert = SSL_get_peer_certificate(ssl); + auto server_cert = SSL_get1_peer_certificate(ssl2); if (server_cert == nullptr) { error = Error::SSLServerVerification; @@ -6531,8 +9125,15 @@ inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) { return true; }, - [&](SSL *ssl) { - SSL_set_tlsext_host_name(ssl, host_.c_str()); + [&](SSL *ssl2) { +#if defined(OPENSSL_IS_BORINGSSL) + SSL_set_tlsext_host_name(ssl2, host_.c_str()); +#else + // NOTE: Direct call instead of using the OpenSSL macro to suppress + // -Wold-style-cast warning + SSL_ctrl(ssl2, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name, + static_cast(const_cast(host_.c_str()))); +#endif return true; }); @@ -6547,12 +9148,18 @@ inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) { } inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) { + shutdown_ssl_impl(socket, shutdown_gracefully); +} + +inline void SSLClient::shutdown_ssl_impl(Socket &socket, + bool shutdown_gracefully) { if (socket.sock == INVALID_SOCKET) { assert(socket.ssl == nullptr); return; } if (socket.ssl) { - detail::ssl_delete(ctx_mutex_, socket.ssl, shutdown_gracefully); + detail::ssl_delete(ctx_mutex_, socket.ssl, socket.sock, + shutdown_gracefully); socket.ssl = nullptr; } assert(socket.ssl == nullptr); @@ -6601,8 +9208,8 @@ SSLClient::verify_host_with_subject_alt_name(X509 *server_cert) const { auto type = GEN_DNS; - struct in6_addr addr6; - struct in_addr addr; + struct in6_addr addr6 {}; + struct in_addr addr {}; size_t addr_len = 0; #ifndef __MINGW32__ @@ -6620,15 +9227,16 @@ SSLClient::verify_host_with_subject_alt_name(X509 *server_cert) const { if (alt_names) { auto dsn_matched = false; - auto ip_mached = false; + auto ip_matched = false; auto count = sk_GENERAL_NAME_num(alt_names); for (decltype(count) i = 0; i < count && !dsn_matched; i++) { auto val = sk_GENERAL_NAME_value(alt_names, i); if (val->type == type) { - auto name = (const char *)ASN1_STRING_get0_data(val->d.ia5); - auto name_len = (size_t)ASN1_STRING_length(val->d.ia5); + auto name = + reinterpret_cast(ASN1_STRING_get0_data(val->d.ia5)); + auto name_len = static_cast(ASN1_STRING_length(val->d.ia5)); switch (type) { case GEN_DNS: dsn_matched = check_host_name(name, name_len); break; @@ -6636,17 +9244,18 @@ SSLClient::verify_host_with_subject_alt_name(X509 *server_cert) const { case GEN_IPADD: if (!memcmp(&addr6, name, addr_len) || !memcmp(&addr, name, addr_len)) { - ip_mached = true; + ip_matched = true; } break; } } } - if (dsn_matched || ip_mached) { ret = true; } + if (dsn_matched || ip_matched) { ret = true; } } - GENERAL_NAMES_free((STACK_OF(GENERAL_NAME) *)alt_names); + GENERAL_NAMES_free(const_cast( + reinterpret_cast(alt_names))); return ret; } @@ -6675,7 +9284,7 @@ inline bool SSLClient::check_host_name(const char *pattern, std::vector pattern_components; detail::split(&pattern[0], &pattern[pattern_len], '.', [&](const char *b, const char *e) { - pattern_components.emplace_back(std::string(b, e)); + pattern_components.emplace_back(b, e); }); if (host_components_.size() != pattern_components.size()) { return false; } @@ -6696,15 +9305,16 @@ inline bool SSLClient::check_host_name(const char *pattern, #endif // Universal client implementation -inline Client::Client(const char *scheme_host_port) +inline Client::Client(const std::string &scheme_host_port) : Client(scheme_host_port, std::string(), std::string()) {} -inline Client::Client(const char *scheme_host_port, +inline Client::Client(const std::string &scheme_host_port, const std::string &client_cert_path, const std::string &client_key_path) { - const static std::regex re(R"(^(?:([a-z]+)://)?([^:/?#]+)(?::(\d+))?)"); + const static std::regex re( + R"((?:([a-z]+):\/\/)?(?:\[([a-fA-F\d:]+)\]|([^:/?#]+))(?::(\d+))?)"); - std::cmatch m; + std::smatch m; if (std::regex_match(scheme_host_port, m, re)) { auto scheme = m[1].str(); @@ -6713,33 +9323,38 @@ inline Client::Client(const char *scheme_host_port, #else if (!scheme.empty() && scheme != "http") { #endif +#ifndef CPPHTTPLIB_NO_EXCEPTIONS std::string msg = "'" + scheme + "' scheme is not supported."; throw std::invalid_argument(msg); +#endif return; } auto is_ssl = scheme == "https"; auto host = m[2].str(); + if (host.empty()) { host = m[3].str(); } - auto port_str = m[3].str(); + auto port_str = m[4].str(); auto port = !port_str.empty() ? std::stoi(port_str) : (is_ssl ? 443 : 80); if (is_ssl) { #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - cli_ = detail::make_unique(host.c_str(), port, - client_cert_path, client_key_path); + cli_ = detail::make_unique(host, port, client_cert_path, + client_key_path); is_ssl_ = is_ssl; #endif } else { - cli_ = detail::make_unique(host.c_str(), port, - client_cert_path, client_key_path); + cli_ = detail::make_unique(host, port, client_cert_path, + client_key_path); } } else { + // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress) + // if port param below changes. cli_ = detail::make_unique(scheme_host_port, 80, client_cert_path, client_key_path); } -} +} // namespace detail inline Client::Client(const std::string &host, int port) : cli_(detail::make_unique(host, port)) {} @@ -6750,222 +9365,426 @@ inline Client::Client(const std::string &host, int port, : cli_(detail::make_unique(host, port, client_cert_path, client_key_path)) {} -inline Client::~Client() {} +inline Client::~Client() = default; inline bool Client::is_valid() const { return cli_ != nullptr && cli_->is_valid(); } -inline Result Client::Get(const char *path) { return cli_->Get(path); } -inline Result Client::Get(const char *path, const Headers &headers) { +inline Result Client::Get(const std::string &path) { return cli_->Get(path); } +inline Result Client::Get(const std::string &path, const Headers &headers) { return cli_->Get(path, headers); } -inline Result Client::Get(const char *path, Progress progress) { +inline Result Client::Get(const std::string &path, Progress progress) { return cli_->Get(path, std::move(progress)); } -inline Result Client::Get(const char *path, const Headers &headers, +inline Result Client::Get(const std::string &path, const Headers &headers, Progress progress) { return cli_->Get(path, headers, std::move(progress)); } -inline Result Client::Get(const char *path, ContentReceiver content_receiver) { +inline Result Client::Get(const std::string &path, + ContentReceiver content_receiver) { return cli_->Get(path, std::move(content_receiver)); } -inline Result Client::Get(const char *path, const Headers &headers, +inline Result Client::Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver) { return cli_->Get(path, headers, std::move(content_receiver)); } -inline Result Client::Get(const char *path, ContentReceiver content_receiver, - Progress progress) { +inline Result Client::Get(const std::string &path, + ContentReceiver content_receiver, Progress progress) { return cli_->Get(path, std::move(content_receiver), std::move(progress)); } -inline Result Client::Get(const char *path, const Headers &headers, +inline Result Client::Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, Progress progress) { return cli_->Get(path, headers, std::move(content_receiver), std::move(progress)); } -inline Result Client::Get(const char *path, ResponseHandler response_handler, +inline Result Client::Get(const std::string &path, + ResponseHandler response_handler, ContentReceiver content_receiver) { return cli_->Get(path, std::move(response_handler), std::move(content_receiver)); } -inline Result Client::Get(const char *path, const Headers &headers, +inline Result Client::Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver) { return cli_->Get(path, headers, std::move(response_handler), std::move(content_receiver)); } -inline Result Client::Get(const char *path, ResponseHandler response_handler, +inline Result Client::Get(const std::string &path, + ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress) { return cli_->Get(path, std::move(response_handler), std::move(content_receiver), std::move(progress)); } -inline Result Client::Get(const char *path, const Headers &headers, +inline Result Client::Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress) { return cli_->Get(path, headers, std::move(response_handler), std::move(content_receiver), std::move(progress)); } +inline Result Client::Get(const std::string &path, const Params ¶ms, + const Headers &headers, Progress progress) { + return cli_->Get(path, params, headers, std::move(progress)); +} +inline Result Client::Get(const std::string &path, const Params ¶ms, + const Headers &headers, + ContentReceiver content_receiver, Progress progress) { + return cli_->Get(path, params, headers, std::move(content_receiver), + std::move(progress)); +} +inline Result Client::Get(const std::string &path, const Params ¶ms, + const Headers &headers, + ResponseHandler response_handler, + ContentReceiver content_receiver, Progress progress) { + return cli_->Get(path, params, headers, std::move(response_handler), + std::move(content_receiver), std::move(progress)); +} -inline Result Client::Head(const char *path) { return cli_->Head(path); } -inline Result Client::Head(const char *path, const Headers &headers) { +inline Result Client::Head(const std::string &path) { return cli_->Head(path); } +inline Result Client::Head(const std::string &path, const Headers &headers) { return cli_->Head(path, headers); } -inline Result Client::Post(const char *path) { return cli_->Post(path); } -inline Result Client::Post(const char *path, const std::string &body, - const char *content_type) { +inline Result Client::Post(const std::string &path) { return cli_->Post(path); } +inline Result Client::Post(const std::string &path, const Headers &headers) { + return cli_->Post(path, headers); +} +inline Result Client::Post(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return cli_->Post(path, body, content_length, content_type); +} +inline Result Client::Post(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type) { + return cli_->Post(path, headers, body, content_length, content_type); +} +inline Result Client::Post(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, Progress progress) { + return cli_->Post(path, headers, body, content_length, content_type, + progress); +} +inline Result Client::Post(const std::string &path, const std::string &body, + const std::string &content_type) { return cli_->Post(path, body, content_type); } -inline Result Client::Post(const char *path, const Headers &headers, - const std::string &body, const char *content_type) { +inline Result Client::Post(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress) { + return cli_->Post(path, body, content_type, progress); +} +inline Result Client::Post(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type) { return cli_->Post(path, headers, body, content_type); } -inline Result Client::Post(const char *path, size_t content_length, +inline Result Client::Post(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type, Progress progress) { + return cli_->Post(path, headers, body, content_type, progress); +} +inline Result Client::Post(const std::string &path, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Post(path, content_length, std::move(content_provider), content_type); } -inline Result Client::Post(const char *path, +inline Result Client::Post(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Post(path, std::move(content_provider), content_type); } -inline Result Client::Post(const char *path, const Headers &headers, +inline Result Client::Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Post(path, headers, content_length, std::move(content_provider), content_type); } -inline Result Client::Post(const char *path, const Headers &headers, +inline Result Client::Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Post(path, headers, std::move(content_provider), content_type); } -inline Result Client::Post(const char *path, const Params ¶ms) { +inline Result Client::Post(const std::string &path, const Params ¶ms) { return cli_->Post(path, params); } -inline Result Client::Post(const char *path, const Headers &headers, +inline Result Client::Post(const std::string &path, const Headers &headers, const Params ¶ms) { return cli_->Post(path, headers, params); } -inline Result Client::Post(const char *path, +inline Result Client::Post(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress) { + return cli_->Post(path, headers, params, progress); +} +inline Result Client::Post(const std::string &path, const MultipartFormDataItems &items) { return cli_->Post(path, items); } -inline Result Client::Post(const char *path, const Headers &headers, +inline Result Client::Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items) { return cli_->Post(path, headers, items); } -inline Result Client::Post(const char *path, const Headers &headers, +inline Result Client::Post(const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const std::string &boundary) { return cli_->Post(path, headers, items, boundary); } -inline Result Client::Put(const char *path) { return cli_->Put(path); } -inline Result Client::Put(const char *path, const std::string &body, - const char *content_type) { +inline Result +Client::Post(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items) { + return cli_->Post(path, headers, items, provider_items); +} +inline Result Client::Put(const std::string &path) { return cli_->Put(path); } +inline Result Client::Put(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return cli_->Put(path, body, content_length, content_type); +} +inline Result Client::Put(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type) { + return cli_->Put(path, headers, body, content_length, content_type); +} +inline Result Client::Put(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, Progress progress) { + return cli_->Put(path, headers, body, content_length, content_type, progress); +} +inline Result Client::Put(const std::string &path, const std::string &body, + const std::string &content_type) { return cli_->Put(path, body, content_type); } -inline Result Client::Put(const char *path, const Headers &headers, - const std::string &body, const char *content_type) { +inline Result Client::Put(const std::string &path, const std::string &body, + const std::string &content_type, Progress progress) { + return cli_->Put(path, body, content_type, progress); +} +inline Result Client::Put(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type) { return cli_->Put(path, headers, body, content_type); } -inline Result Client::Put(const char *path, size_t content_length, +inline Result Client::Put(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type, Progress progress) { + return cli_->Put(path, headers, body, content_type, progress); +} +inline Result Client::Put(const std::string &path, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Put(path, content_length, std::move(content_provider), content_type); } -inline Result Client::Put(const char *path, +inline Result Client::Put(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Put(path, std::move(content_provider), content_type); } -inline Result Client::Put(const char *path, const Headers &headers, +inline Result Client::Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Put(path, headers, content_length, std::move(content_provider), content_type); } -inline Result Client::Put(const char *path, const Headers &headers, +inline Result Client::Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Put(path, headers, std::move(content_provider), content_type); } -inline Result Client::Put(const char *path, const Params ¶ms) { +inline Result Client::Put(const std::string &path, const Params ¶ms) { return cli_->Put(path, params); } -inline Result Client::Put(const char *path, const Headers &headers, +inline Result Client::Put(const std::string &path, const Headers &headers, const Params ¶ms) { return cli_->Put(path, headers, params); } -inline Result Client::Patch(const char *path, const std::string &body, - const char *content_type) { +inline Result Client::Put(const std::string &path, const Headers &headers, + const Params ¶ms, Progress progress) { + return cli_->Put(path, headers, params, progress); +} +inline Result Client::Put(const std::string &path, + const MultipartFormDataItems &items) { + return cli_->Put(path, items); +} +inline Result Client::Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items) { + return cli_->Put(path, headers, items); +} +inline Result Client::Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const std::string &boundary) { + return cli_->Put(path, headers, items, boundary); +} +inline Result +Client::Put(const std::string &path, const Headers &headers, + const MultipartFormDataItems &items, + const MultipartFormDataProviderItems &provider_items) { + return cli_->Put(path, headers, items, provider_items); +} +inline Result Client::Patch(const std::string &path) { + return cli_->Patch(path); +} +inline Result Client::Patch(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return cli_->Patch(path, body, content_length, content_type); +} +inline Result Client::Patch(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type, + Progress progress) { + return cli_->Patch(path, body, content_length, content_type, progress); +} +inline Result Client::Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type) { + return cli_->Patch(path, headers, body, content_length, content_type); +} +inline Result Client::Patch(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, + Progress progress) { + return cli_->Patch(path, headers, body, content_length, content_type, + progress); +} +inline Result Client::Patch(const std::string &path, const std::string &body, + const std::string &content_type) { return cli_->Patch(path, body, content_type); } -inline Result Client::Patch(const char *path, const Headers &headers, - const std::string &body, const char *content_type) { +inline Result Client::Patch(const std::string &path, const std::string &body, + const std::string &content_type, + Progress progress) { + return cli_->Patch(path, body, content_type, progress); +} +inline Result Client::Patch(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type) { return cli_->Patch(path, headers, body, content_type); } -inline Result Client::Patch(const char *path, size_t content_length, +inline Result Client::Patch(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type, + Progress progress) { + return cli_->Patch(path, headers, body, content_type, progress); +} +inline Result Client::Patch(const std::string &path, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Patch(path, content_length, std::move(content_provider), content_type); } -inline Result Client::Patch(const char *path, +inline Result Client::Patch(const std::string &path, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Patch(path, std::move(content_provider), content_type); } -inline Result Client::Patch(const char *path, const Headers &headers, +inline Result Client::Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Patch(path, headers, content_length, std::move(content_provider), content_type); } -inline Result Client::Patch(const char *path, const Headers &headers, +inline Result Client::Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, - const char *content_type) { + const std::string &content_type) { return cli_->Patch(path, headers, std::move(content_provider), content_type); } -inline Result Client::Delete(const char *path) { return cli_->Delete(path); } -inline Result Client::Delete(const char *path, const std::string &body, - const char *content_type) { - return cli_->Delete(path, body, content_type); +inline Result Client::Delete(const std::string &path) { + return cli_->Delete(path); } -inline Result Client::Delete(const char *path, const Headers &headers) { +inline Result Client::Delete(const std::string &path, const Headers &headers) { return cli_->Delete(path, headers); } -inline Result Client::Delete(const char *path, const Headers &headers, +inline Result Client::Delete(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type) { + return cli_->Delete(path, body, content_length, content_type); +} +inline Result Client::Delete(const std::string &path, const char *body, + size_t content_length, + const std::string &content_type, + Progress progress) { + return cli_->Delete(path, body, content_length, content_type, progress); +} +inline Result Client::Delete(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type) { + return cli_->Delete(path, headers, body, content_length, content_type); +} +inline Result Client::Delete(const std::string &path, const Headers &headers, + const char *body, size_t content_length, + const std::string &content_type, + Progress progress) { + return cli_->Delete(path, headers, body, content_length, content_type, + progress); +} +inline Result Client::Delete(const std::string &path, const std::string &body, + const std::string &content_type) { + return cli_->Delete(path, body, content_type); +} +inline Result Client::Delete(const std::string &path, const std::string &body, + const std::string &content_type, + Progress progress) { + return cli_->Delete(path, body, content_type, progress); +} +inline Result Client::Delete(const std::string &path, const Headers &headers, const std::string &body, - const char *content_type) { + const std::string &content_type) { return cli_->Delete(path, headers, body, content_type); } -inline Result Client::Options(const char *path) { return cli_->Options(path); } -inline Result Client::Options(const char *path, const Headers &headers) { +inline Result Client::Delete(const std::string &path, const Headers &headers, + const std::string &body, + const std::string &content_type, + Progress progress) { + return cli_->Delete(path, headers, body, content_type, progress); +} +inline Result Client::Options(const std::string &path) { + return cli_->Options(path); +} +inline Result Client::Options(const std::string &path, const Headers &headers) { return cli_->Options(path, headers); } -inline bool Client::send(const Request &req, Response &res, Error &error) { +inline bool Client::send(Request &req, Response &res, Error &error) { return cli_->send(req, res, error); } inline Result Client::send(const Request &req) { return cli_->send(req); } +inline void Client::stop() { cli_->stop(); } + +inline std::string Client::host() const { return cli_->host(); } + +inline int Client::port() const { return cli_->port(); } + inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); } -inline void Client::stop() { cli_->stop(); } +inline socket_t Client::socket() const { return cli_->socket(); } + +inline void +Client::set_hostname_addr_map(std::map addr_map) { + cli_->set_hostname_addr_map(std::move(addr_map)); +} inline void Client::set_default_headers(Headers headers) { cli_->set_default_headers(std::move(headers)); } +inline void Client::set_header_writer( + std::function const &writer) { + cli_->set_header_writer(writer); +} + +inline void Client::set_address_family(int family) { + cli_->set_address_family(family); +} + inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); } + inline void Client::set_socket_options(SocketOptions socket_options) { cli_->set_socket_options(std::move(socket_options)); } @@ -6973,22 +9792,25 @@ inline void Client::set_socket_options(SocketOptions socket_options) { inline void Client::set_connection_timeout(time_t sec, time_t usec) { cli_->set_connection_timeout(sec, usec); } + inline void Client::set_read_timeout(time_t sec, time_t usec) { cli_->set_read_timeout(sec, usec); } + inline void Client::set_write_timeout(time_t sec, time_t usec) { cli_->set_write_timeout(sec, usec); } -inline void Client::set_basic_auth(const char *username, const char *password) { +inline void Client::set_basic_auth(const std::string &username, + const std::string &password) { cli_->set_basic_auth(username, password); } -inline void Client::set_bearer_token_auth(const char *token) { +inline void Client::set_bearer_token_auth(const std::string &token) { cli_->set_bearer_token_auth(token); } #ifdef CPPHTTPLIB_OPENSSL_SUPPORT -inline void Client::set_digest_auth(const char *username, - const char *password) { +inline void Client::set_digest_auth(const std::string &username, + const std::string &password) { cli_->set_digest_auth(username, password); } #endif @@ -6998,27 +9820,29 @@ inline void Client::set_follow_location(bool on) { cli_->set_follow_location(on); } +inline void Client::set_url_encode(bool on) { cli_->set_url_encode(on); } + inline void Client::set_compress(bool on) { cli_->set_compress(on); } inline void Client::set_decompress(bool on) { cli_->set_decompress(on); } -inline void Client::set_interface(const char *intf) { +inline void Client::set_interface(const std::string &intf) { cli_->set_interface(intf); } -inline void Client::set_proxy(const char *host, int port) { +inline void Client::set_proxy(const std::string &host, int port) { cli_->set_proxy(host, port); } -inline void Client::set_proxy_basic_auth(const char *username, - const char *password) { +inline void Client::set_proxy_basic_auth(const std::string &username, + const std::string &password) { cli_->set_proxy_basic_auth(username, password); } -inline void Client::set_proxy_bearer_token_auth(const char *token) { +inline void Client::set_proxy_bearer_token_auth(const std::string &token) { cli_->set_proxy_bearer_token_auth(token); } #ifdef CPPHTTPLIB_OPENSSL_SUPPORT -inline void Client::set_proxy_digest_auth(const char *username, - const char *password) { +inline void Client::set_proxy_digest_auth(const std::string &username, + const std::string &password) { cli_->set_proxy_digest_auth(username, password); } #endif @@ -7029,23 +9853,28 @@ inline void Client::enable_server_certificate_verification(bool enabled) { } #endif -inline void Client::set_logger(Logger logger) { cli_->set_logger(logger); } +inline void Client::set_logger(Logger logger) { + cli_->set_logger(std::move(logger)); +} #ifdef CPPHTTPLIB_OPENSSL_SUPPORT -inline void Client::set_ca_cert_path(const char *ca_cert_file_path, - const char *ca_cert_dir_path) { - if (is_ssl_) { - static_cast(*cli_).set_ca_cert_path(ca_cert_file_path, - ca_cert_dir_path); - } +inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path, + const std::string &ca_cert_dir_path) { + cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path); } inline void Client::set_ca_cert_store(X509_STORE *ca_cert_store) { if (is_ssl_) { static_cast(*cli_).set_ca_cert_store(ca_cert_store); + } else { + cli_->set_ca_cert_store(ca_cert_store); } } +inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) { + set_ca_cert_store(cli_->create_ca_cert_store(ca_cert, size)); +} + inline long Client::get_openssl_verify_result() const { if (is_ssl_) { return static_cast(*cli_).get_openssl_verify_result(); @@ -7063,4 +9892,8 @@ inline SSL_CTX *Client::ssl_context() const { } // namespace httplib +#if defined(_WIN32) && defined(CPPHTTPLIB_USE_POLL) +#undef poll +#endif + #endif // CPPHTTPLIB_HTTPLIB_H diff --git a/Plugins/HTTP/HTTP.cpp b/Plugins/HTTP/HTTP.cpp index d40a3fc27dc..d5a56de03b3 100644 --- a/Plugins/HTTP/HTTP.cpp +++ b/Plugins/HTTP/HTTP.cpp @@ -1,7 +1,5 @@ #include "HTTP.hpp" #include "HTTP/Client.hpp" -#include "HTTP/RPC.hpp" -#include "HTTP/Server.hpp" using namespace NWNXLib; using namespace NWNXLib::API; @@ -21,15 +19,6 @@ HTTP::HTTP(Services::ProxyServiceList* services) : Plugin(services) { m_Client = std::make_unique(); - bool bRPC = Config::Get("RPC", false); - if (Config::Get("SERVER", false) || bRPC) - { - m_Server = std::make_unique(); - if (bRPC) - { - m_RPC = std::make_unique(); - } - } } HTTP::~HTTP() diff --git a/Plugins/HTTP/HTTP.hpp b/Plugins/HTTP/HTTP.hpp index 3e5bf5a65d3..0750dfc93fb 100644 --- a/Plugins/HTTP/HTTP.hpp +++ b/Plugins/HTTP/HTTP.hpp @@ -5,8 +5,6 @@ namespace HTTP { class Client; - class RPC; - class Server; class HTTP : public NWNXLib::Plugin { @@ -54,8 +52,6 @@ namespace HTTP { private: std::unique_ptr m_Client; - std::unique_ptr m_RPC; - std::unique_ptr m_Server; }; } diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp index 4d3513af4cd..d32c460fc83 100644 --- a/Plugins/HTTP/HTTP/Client.cpp +++ b/Plugins/HTTP/HTTP/Client.cpp @@ -11,8 +11,8 @@ namespace HTTP Client::Client() { - Events::RegisterEvent(PLUGIN_NAME, "Client_SendRequest", &SendRequest); - Events::RegisterEvent(PLUGIN_NAME, "Client_GetRequest", &GetRequest); + ScriptAPI::RegisterEvent(PLUGIN_NAME, "Client_SendRequest", &SendRequest); + ScriptAPI::RegisterEvent(PLUGIN_NAME, "Client_GetRequest", &GetRequest); m_clientTimeout = Config::Get("CLIENT_REQUEST_TIMEOUT", 2000); } @@ -82,7 +82,7 @@ void Client::PerformRequest(const Client::Request& client_req) cli->second->set_connection_timeout(0, m_clientTimeout * 1000); auto result = GetResult(client_req); - if (result == nullptr || result->error()) + if (result == nullptr || result->error() != httplib::Error::Success) { auto clientError = result != nullptr ? result->error() : httplib::Error::Unknown; Tasks::QueueOnMainThread([client_req, clientError]() @@ -171,48 +171,48 @@ httplib::Headers Client::ParseHeaderString(const std::string& headerStr) return headers; } -Events::ArgumentStack Client::SendRequest(Events::ArgumentStack&& args) +ScriptAPI::ArgumentStack Client::SendRequest(ScriptAPI::ArgumentStack&& args) { auto clientReq = Request(); clientReq.id = m_clientRequestId++; - clientReq.tag = Events::ExtractArgument(args); - clientReq.requestMethod = static_cast(Events::ExtractArgument(args)); - clientReq.host = Events::ExtractArgument(args); - clientReq.path = Events::ExtractArgument(args); - clientReq.contentType = static_cast(Events::ExtractArgument(args)); - clientReq.data = Events::ExtractArgument(args); - clientReq.authType = static_cast(Events::ExtractArgument(args)); - clientReq.authUserToken = Events::ExtractArgument(args); - clientReq.authPassword = Events::ExtractArgument(args); - clientReq.port = Events::ExtractArgument(args); + clientReq.tag = ScriptAPI::ExtractArgument(args); + clientReq.requestMethod = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.host = ScriptAPI::ExtractArgument(args); + clientReq.path = ScriptAPI::ExtractArgument(args); + clientReq.contentType = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.data = ScriptAPI::ExtractArgument(args); + clientReq.authType = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.authUserToken = ScriptAPI::ExtractArgument(args); + clientReq.authPassword = ScriptAPI::ExtractArgument(args); + clientReq.port = ScriptAPI::ExtractArgument(args); if (!clientReq.port) clientReq.port = 443; - clientReq.headersString = Events::ExtractArgument(args); + clientReq.headersString = ScriptAPI::ExtractArgument(args); clientReq.headers = ParseHeaderString(clientReq.headersString); m_clientRequests[clientReq.id] = clientReq; PerformRequest(clientReq); - return Events::Arguments(clientReq.id); + return ScriptAPI::Arguments(clientReq.id); } -Events::ArgumentStack Client::GetRequest(Events::ArgumentStack&& args) +ScriptAPI::ArgumentStack Client::GetRequest(ScriptAPI::ArgumentStack&& args) { - Events::ArgumentStack stack; - auto requestId = Events::ExtractArgument(args); + ScriptAPI::ArgumentStack stack; + auto requestId = ScriptAPI::ExtractArgument(args); auto req = m_clientRequests.find(requestId); ASSERT_OR_THROW(req != std::end(m_clientRequests)); auto clientReq = req->second; - Events::InsertArgument(stack, clientReq.headersString); - Events::InsertArgument(stack, (int32_t)clientReq.port); - Events::InsertArgument(stack, clientReq.authPassword); - Events::InsertArgument(stack, clientReq.authUserToken); - Events::InsertArgument(stack, (int32_t)clientReq.authType); - Events::InsertArgument(stack, clientReq.data); - Events::InsertArgument(stack, (int32_t)clientReq.contentType); - Events::InsertArgument(stack, clientReq.path); - Events::InsertArgument(stack, clientReq.host); - Events::InsertArgument(stack, (int32_t)clientReq.requestMethod); - Events::InsertArgument(stack, clientReq.tag); + ScriptAPI::InsertArgument(stack, clientReq.headersString); + ScriptAPI::InsertArgument(stack, (int32_t)clientReq.port); + ScriptAPI::InsertArgument(stack, clientReq.authPassword); + ScriptAPI::InsertArgument(stack, clientReq.authUserToken); + ScriptAPI::InsertArgument(stack, (int32_t)clientReq.authType); + ScriptAPI::InsertArgument(stack, clientReq.data); + ScriptAPI::InsertArgument(stack, (int32_t)clientReq.contentType); + ScriptAPI::InsertArgument(stack, clientReq.path); + ScriptAPI::InsertArgument(stack, clientReq.host); + ScriptAPI::InsertArgument(stack, (int32_t)clientReq.requestMethod); + ScriptAPI::InsertArgument(stack, clientReq.tag); return stack; } diff --git a/Plugins/HTTP/HTTP/Client.hpp b/Plugins/HTTP/HTTP/Client.hpp index a45d35f3d8e..eef81fb4440 100644 --- a/Plugins/HTTP/HTTP/Client.hpp +++ b/Plugins/HTTP/HTTP/Client.hpp @@ -2,7 +2,7 @@ #include "HTTP.hpp" -using ArgumentStack = NWNXLib::Events::ArgumentStack; +using ArgumentStack = NWNXLib::ArgumentStack; namespace HTTP { diff --git a/Plugins/HTTP/HTTP/RPC.cpp b/Plugins/HTTP/HTTP/RPC.cpp deleted file mode 100644 index df59f2f8236..00000000000 --- a/Plugins/HTTP/HTTP/RPC.cpp +++ /dev/null @@ -1,120 +0,0 @@ -#include -#include "HTTP/RPC.hpp" - -using namespace NWNXLib; - -namespace HTTP -{ - -RPC::RPC() -{ - m_authToken = Config::Get("RPC_AUTH_TOKEN", ""); - m_rpcURL = Config::Get("RPC_URL", "/rpc"); - if (m_rpcURL.rfind('/', 0) == std::string::npos) - m_rpcURL = "/" + m_rpcURL; - if (m_authToken.empty() && m_rpcURL == "/rpc") - { - LOG_ERROR("You have not set up an authorization token for your RPC server and you're using the default path of /rpc. You must either " - "set an authorization token (NWNX_HTTP_RPC_AUTH_TOKEN) or set a unique URL (NWNX_HTTP_RPC_URL) for your rpc path. The server will not be started."); - return; - } - - StartRPCServer(); -} - -httplib::Server* RPC::WaitForWebServer(const std::atomic_bool& cancelled) -{ - auto *svr = Server::m_httpServer.get(); - while ((svr == nullptr || !svr->is_running()) && !cancelled) - { - std::this_thread::sleep_for(std::chrono::milliseconds (10)); - svr = Server::m_httpServer.get(); - } - return svr; -} - -void RPC::StartRPCServer() -{ - // RPC needs to wait for the HTTP server to be up and running on its own thread before it can start - auto *svr = Server::m_httpServer.get(); - if (svr == nullptr || !svr->is_running()) - { - std::atomic_bool cancellation_token = false; - auto future = std::async(std::launch::async, WaitForWebServer, std::ref(cancellation_token)); - if (std::future_status::ready == future.wait_for(std::chrono::seconds(3))) - { - svr = future.get(); - } - else - { - cancellation_token = true; - LOG_ERROR("No NWNX web server was detected for RPC to use, not started."); - return; - } - } - LOG_INFO("RPC Server up and available at %s", m_rpcURL.c_str()); - - svr->Post(m_rpcURL.c_str(), [&](const httplib::Request &req, httplib::Response &res) - { - auto requestId = Server::GetNewRequestID(); - - if (!m_authToken.empty() && (!req.has_header("Authorization") || req.get_header_value("Authorization") != m_authToken)) - { - res.status = 401; - } - else - { - auto ct = req.get_header_value("Content-Type"); - std::string json_data; - std::unordered_map params; - int paramCount = 0; - if (ct.find(HTTP::ContentTypeToString(HTTP::ContentType::JSON)) != std::string::npos) - json_data = req.body; - else - { - paramCount = req.params.size(); - for (const auto & param : req.params) - params[param.first] = param.second; - } - Tasks::QueueOnMainThread([requestId,json_data,paramCount,params]() - { - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestId)}); - if (!json_data.empty()) - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"JSON_DATA", json_data}); - else - { - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"PARAM_COUNT", std::to_string(paramCount)}); - int i = 0; - for (const auto & param : params) - { - std::string sParamKey = "PARAM_KEY_" + std::to_string(i); - std::string sParamValue = "PARAM_VALUE_" + std::to_string(i); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {sParamKey, param.first}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {sParamValue, param.second}); - i++; - } - } - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_POST", "0"}); - }); - - // Our event was sent to nwscript on the main thread, wait for a response here or timeout after m_responseTimeout seconds - std::atomic_bool cancellation_token = false; - auto future = std::async(std::launch::async, Server::WaitForResponse, requestId, std::ref(cancellation_token)); - if (std::future_status::ready == future.wait_for(Server::m_responseTimeout)) - { - res.status = 200; - auto response = future.get(); - res.set_content(response.message, HTTP::ContentTypeToString(response.contentType)); - } - else - { - cancellation_token = true; - // Confirm the request was received but no response was returned. - res.status = 202; - } - Server::DeleteResponse(requestId); - } - }); -} - -} diff --git a/Plugins/HTTP/HTTP/RPC.hpp b/Plugins/HTTP/HTTP/RPC.hpp deleted file mode 100644 index 49bcfbf1252..00000000000 --- a/Plugins/HTTP/HTTP/RPC.hpp +++ /dev/null @@ -1,23 +0,0 @@ -#pragma once -#include "HTTP.hpp" -#include "HTTP/Server.hpp" - -namespace HTTP -{ - -using namespace NWNXLib::Services; - -class RPC -{ -public: - explicit RPC(); -private: - - static httplib::Server* WaitForWebServer(const std::atomic_bool&); - void StartRPCServer(); - - std::string m_authToken; - std::string m_rpcURL; -}; - -} diff --git a/Plugins/HTTP/HTTP/Server.cpp b/Plugins/HTTP/HTTP/Server.cpp deleted file mode 100644 index 50c54c01cd6..00000000000 --- a/Plugins/HTTP/HTTP/Server.cpp +++ /dev/null @@ -1,176 +0,0 @@ -#include -#include "HTTP/Server.hpp" - -using namespace NWNXLib; - -namespace HTTP -{ - -std::unique_ptr Server::m_httpServer; -std::unique_ptr Server::m_httpServerThread; -std::chrono::milliseconds Server::m_responseTimeout; - -Server::Server() -{ - Events::RegisterEvent(PLUGIN_NAME, "Server_SendResponse", &SendResponse); - - m_responseTimeout = std::chrono::milliseconds(Config::Get("SERVER_RESPONSE_TIMEOUT", 1000)); - auto rootHTML = Config::Get("SERVER_ROOT_HTML", "Welcome to nwnx http!

Welcome to nwnx http!

"); - auto rootStatus = Config::Get("SERVER_ROOT_STATUS", 403); - auto httpPort = Config::Get("SERVER_PORT", 8686); - auto useSSL = Config::Get("SERVER_USE_SSL", false); - auto eventURL = Config::Get("SERVER_EVENT_URL"); - if (useSSL) - { - auto certFile = Config::Get("SERVER_SSL_CERT_FILE", "./cert.pem"); - auto certKey = Config::Get("SERVER_SSL_KEY_FILE", "./key.pem"); - m_httpServer = std::make_unique(certFile.c_str(), certKey.c_str()); - if (!m_httpServer->is_valid()) - { - BIO* bio = BIO_new(BIO_s_mem()); - ERR_print_errors(bio); - char *buf = nullptr; - size_t len = BIO_get_mem_data(bio, &buf); - std::string sRet((char*)buf, len); - BIO_free (bio); - LOG_ERROR("Unable to configure SSL Server, not starting. %s", sRet); - return; - } - else - { - // Required to prevent crashing when invalid SSL exchanges take place - signal(SIGPIPE, SIG_IGN); - } - } - else - { - m_httpServer = std::make_unique(); - } - - auto *svr = m_httpServer.get(); - m_httpServerThread = std::make_unique([svr,httpPort,rootStatus,rootHTML,eventURL]() - { - svr->Get("/", [rootStatus,rootHTML](const httplib::Request &, httplib::Response &res) - { - if (rootStatus != 200) - res.status = rootStatus; - else - res.set_content(rootHTML, HTTP::ContentTypeToString(HTTP::ContentType::HTML)); - }); - if (!eventURL->empty()) - { - svr->Get(eventURL->c_str(), [&](const httplib::Request &req, httplib::Response &res) - { - auto path = req.path; - auto requestThreadId = Server::GetNewRequestID(); - if (m_cachedResponses.find(path) != m_cachedResponses.end()) - { - auto now = std::chrono::system_clock::now(); - if (now < m_cachedResponses[path].cacheUntil) - { - res.set_content(m_cachedResponses[path].message, HTTP::ContentTypeToString(m_cachedResponses[path].contentType)); - auto expiresIn = std::chrono::duration_cast(m_cachedResponses[path].cacheUntil - now); - LOG_DEBUG("Cache hit on %s, cached response expires in %d seconds.", path, expiresIn.count()); - Server::DeleteResponse(requestThreadId); - return; - } - else - { - LOG_DEBUG("Cache expired on %s", path); - m_cachedResponses.erase(path); - } - } - Tasks::QueueOnMainThread([requestThreadId,path]() - { - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(requestThreadId)}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"PATH", path}); - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_SERVER_GET", Utils::ObjectIDToString(0)}); - }); - std::atomic_bool cancellation_token = false; - auto future = std::async(std::launch::async, Server::WaitForResponse, requestThreadId, std::ref(cancellation_token)); - if (std::future_status::ready == future.wait_for(m_responseTimeout)) - { - res.status = 200; - auto response = future.get(); - res.set_content(response.message, HTTP::ContentTypeToString(response.contentType)); - auto now = std::chrono::system_clock::now(); - if (response.cacheUntil > now) - { - m_cachedResponses[path] = response; - } - } - else - { - cancellation_token = true; - res.status = 404; - } - Server::DeleteResponse(requestThreadId); - }); - } - svr->set_error_handler([](const httplib::Request &, httplib::Response &res) { - const char *fmt = "%d %s

%d %s

nwnx http
"; - char buf[256]; - snprintf(buf, sizeof(buf), fmt, res.status, httplib::detail::status_message(res.status), res.status, httplib::detail::status_message(res.status)); - res.set_content(buf, HTTP::ContentTypeToString(HTTP::ContentType::HTML)); - }); - svr->listen("0.0.0.0", httpPort); - }); - LOG_INFO("%s Server started, accessible on port %d", useSSL ? "HTTPS" : "HTTP", httpPort); -} - -Server::~Server() -{ - if (m_httpServerThread) - { - if (m_httpServer->is_running()) - { - LOG_INFO("Shutting down HTTP server."); - m_httpServer->stop(); - } - m_httpServerThread->join(); - } -} - -void Server::DeleteResponse(uint32_t requestId) -{ - m_responses.erase(requestId); -} - -uint32_t Server::GetNewRequestID() -{ - return m_servRequestId++; -} - -Server::Response Server::WaitForResponse(uint32_t requestThreadId, const std::atomic_bool& cancelled) -{ - while (m_responses.find(requestThreadId) == m_responses.end() && !cancelled) - std::this_thread::sleep_for(std::chrono::milliseconds (10)); - - if (cancelled) - { - if (m_responses.find(requestThreadId) != m_responses.end()) - m_responses.erase(requestThreadId); - return Server::Response(); - } - - return m_responses[requestThreadId]; -} - -Events::ArgumentStack Server::SendResponse(Events::ArgumentStack&& args) -{ - if (!m_httpServerThread || !m_httpServer->is_running()) - { - LOG_ERROR("Can't send HTTP server response, no server is running!"); - return Events::Arguments(); - } - auto requestId = Events::ExtractArgument(args); - auto response = Events::ExtractArgument(args); - auto contentType = Events::ExtractArgument(args); - auto cacheSeconds = Events::ExtractArgument(args); - auto cacheUntil = std::chrono::system_clock::now() + std::chrono::seconds(cacheSeconds); - m_responses[requestId] = Server::Response(response, static_cast(contentType), cacheUntil); - - return Events::Arguments(); -} - -} diff --git a/Plugins/HTTP/HTTP/Server.hpp b/Plugins/HTTP/HTTP/Server.hpp deleted file mode 100644 index 9c391ae19bb..00000000000 --- a/Plugins/HTTP/HTTP/Server.hpp +++ /dev/null @@ -1,51 +0,0 @@ -#pragma once - -#include "HTTP.hpp" - -using ArgumentStack = NWNXLib::Events::ArgumentStack; - -namespace HTTP { - -using namespace NWNXLib::Services; - -class Server -{ - struct Response - { - std::string message; - HTTP::ContentType contentType; - std::chrono::system_clock::time_point cacheUntil; - - Response() - { - message = ""; - contentType = HTTP::ContentType::PLAINTEXT; - cacheUntil = std::chrono::system_clock::now(); - } - Response(std::string message, HTTP::ContentType contentType, std::chrono::system_clock::time_point cacheUntil) - { - this->message = std::move(message); - this->contentType = contentType; - this->cacheUntil = cacheUntil; - } - }; -public: - explicit Server(); - virtual ~Server(); - static Response WaitForResponse(uint32_t, const std::atomic_bool&); - static void DeleteResponse(uint32_t); - static uint32_t GetNewRequestID(); - static std::unique_ptr m_httpServer; - static std::unique_ptr m_httpServerThread; - static std::chrono::milliseconds m_responseTimeout; - -private: - - static ArgumentStack SendResponse(ArgumentStack&&); - - static inline std::unordered_map m_responses; - static inline std::unordered_map m_cachedResponses; - static inline uint32_t m_servRequestId = 0; -}; - -} diff --git a/Plugins/HTTP/NWScript/nwnx_http.nss b/Plugins/HTTP/NWScript/nwnx_http.nss index 00573d83375..5d4ba4b9d1a 100644 --- a/Plugins/HTTP/NWScript/nwnx_http.nss +++ b/Plugins/HTTP/NWScript/nwnx_http.nss @@ -56,14 +56,6 @@ struct NWNX_HTTP_Client_Request string sHeaders; ///< Pipe (|) delimited header pairs, e.g. "User-Agent: My NWNX HTTP Client|Accept: application/vnd.github.v3+json" }; -/// @brief Returns a string to the http server -/// @param nRequestId The id of the http server request -/// @param sMessage The message to return -/// @param nContentType The content type from @ref content_types "content_types" -/// @param nCache Length in seconds to cache the response -/// @remark The cache setting does not honour any http client cache related headers, it merely caches an event response on the c++ side. -void NWNX_HTTP_Server_SendResponse(int nRequestId, string sMessage, int nContentType = NWNX_HTTP_CONTENT_TYPE_HTML, int nCache = 0); - /// @brief Sends an http method to the given host. /// @param s The structured NWNX_HTTP_Client_Request information. /// @return A unique identifier for the request for later access in the REQUEST_ID event data. @@ -76,16 +68,6 @@ struct NWNX_HTTP_Client_Request NWNX_HTTP_Client_GetRequest(int nRequestId); /// @} -void NWNX_HTTP_Server_SendResponse(int nRequestId, string sMessage, int nContentType, int nCache) -{ - string sFunc = "Server_SendResponse"; - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nCache); - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nContentType); - NWNX_PushArgumentString(NWNX_HTTP, sFunc, sMessage); - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nRequestId); - NWNX_CallFunction(NWNX_HTTP, sFunc); -} - int NWNX_HTTP_Client_SendRequest(struct NWNX_HTTP_Client_Request s) { string sFunc = "Client_SendRequest"; diff --git a/Plugins/HTTP/README.md b/Plugins/HTTP/README.md index 47031333f87..e7cf41959bb 100644 --- a/Plugins/HTTP/README.md +++ b/Plugins/HTTP/README.md @@ -2,152 +2,17 @@ @ingroup http ## Introduction -The HTTP Plugin provides access to both a Server and Client to accept and perform requests and return responses. +The HTTP Plugin provides access to a Client to perform requests and return responses. ## Environment Variables | Variable Name | Type | Default Value | | ----------------------------------| :--------: | ------------------ | | NWNX_HTTP_CLIENT_REQUEST_TIMEOUT | int | 2000 | -| NWNX_HTTP_SERVER | bool | false | -| NWNX_HTTP_SERVER_PORT | int | 8686 | -| NWNX_HTTP_SERVER_ROOT_STATUS | int | 403 (Forbidden) | -| NWNX_HTTP_SERVER_ROOT_HTML | string | ```Welcome to nwnx http!

Welcome to nwnx http!

``` | -| NWNX_HTTP_SERVER_USE_SSL | bool | false | -| NWNX_HTTP_SERVER_SSL_CERT_FILE | string | ./cert.pem | -| NWNX_HTTP_SERVER_SSL_KEY_FILE | string | ./key.pem | -| NWNX_HTTP_SERVER_EVENT_URL | string | | -| NWNX_HTTP_SERVER_RESPONSE_TIMEOUT | int | 1000 | -| NWNX_HTTP_RPC | bool | false | -| NWNX_HTTP_SERVER_RPC_URL | string | /rpc | -| NWNX_HTTP_SERVER_RPC_AUTH_TOKEN | string | | ## Setup ### Client The Client commands are functional by simply loading the plugin. -### Server -The server will run when `NWNX_HTTP_SERVER` is set to `true`. -It will be accessible by default on port 8686 (configured with `NWNX_HTTP_SERVER_PORT`) but further -configuration is necessary as by default visiting http://your.host:8686 will return a `403 Forbidden` error. - -If you wish your server to return information when visiting the root level then you must set the -`NWNX_HTTP_SERVER_ROOT_STATUS` to `200`. By default this returns a simple "Welcome to nwnx http" web page, -but this content can be controlled with the `NWNX_HTTP_SERVER_ROOT_HTML` environment variable. - -The server can also be configured to run on https by setting `NWNX_HTTP_USE_SSL` to `true` and placing -a `cert.pem` and `key.pem` in the same folder as your `NWNX_HTTP.so`. Alternatively, you can configure -the name and path to the certificate and private key with the -`NWNX_HTTP_SERVER_SSL_CERT_FILE` and `NWNX_HTTP_SERVER_SSL_KEY_FILE` environment variables. -**Remember that the user that runs the nwn-server must be able to read both these files.** - -### RPC -In addition to the regular GET protocol that the Server handles, the plugin includes a more robust RPC Server that handles -a POST request event which can accept form-urlencoded or json data. To enable this RPC server set `NWNX_HTTP_RPC` to `true`. - -The RPC server supports an authentication token by setting the `NWNX_HTTP_SERVER_RPC_AUTH_TOKEN` environment variable to a -value of your choosing. Optionally you can simply set the `NWNX_HTTP_SERVER_RPC_URL` to an obscure URL much like Discord -does with their webhooks. An example command to produce either this token or url is -`ruby -rsecurerandom -e 'puts SecureRandom.hex(32)`. You can set both or either but you must set at least one. - -If you do not set an `NWNX_HTTP_SERVER_RPC_URL` environment variable then the url will be `/rpc`. - -## Events -### Server Event Setup -The true utility of the HTTP Server is broadcasting a call to the `NWNX_ON_HTTP_SERVER_GET` event. The builder begins -by setting an environment variable `NWNX_HTTP_SERVER_EVENT_URL` for a path wildcard that accepts requests, -for example `/nwnx/(.*)`. When this is set and an http client visits http://your.site:8686/nwnx/testing an -`NWNX_ON_HTTP_SERVER_GET` event will be signalled. The Event Data is the path `PATH` and a unique integer `REQUEST_ID`. -Once the event is sent to your nwscript you build the response you wish to return and then send it back with the -`NWNX_HTTP_Server_SendResponse()` command. - -Here's an example of the functionality. -1. In your `on_module_load.nss` script subscribe to the `NWNX_ON_HTTP_SERVER_GET` event, for example: - `NWNX_Events_SubscribeEvent("NWNX_ON_HTTP_SERVER_GET", "event_http_get");` -2. In your `event_http_get.nss` script you would have something like below: -```c -#include "nwnx_events" -#include "nwnx_http" - -void main() -{ - object oModule = OBJECT_SELF; - if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTP_SERVER_GET") - { - int nRequestId = StringToInt(NWNX_Events_GetEventData("REQUEST_ID")); - string sPath = NWNX_Events_GetEventData("PATH"); - if (sPath == "/nwnx/testing") - NWNX_HTTP_Server_SendResponse(nRequestId, "TestingThis is a test"); - } -``` -### RPC Event Setup -Much like the HTTP Server, the RPC Server signals an `NWNX_ON_HTTP_SERVER_POST` event. The data included with this event -includes `REQUEST_ID` and either `JSON_DATA` or if using form-urlencoded data it sends `PARAM_COUNT` and `PARAM_KEY_#` and -`PARAM_VALUE_#` pairs for the builder to loop through in the event handler script. - -Here's an example of an RPC event handler. -1. In your `on_module_load.nss` script subscribe to the `NWNX_ON_HTTP_SERVER_POST` event, for example: - `NWNX_Events_SubscribeEvent("NWNX_ON_HTTP_SERVER_POST", "event_http_post");` -2. In your `event_http_post.nss` script you would have something like below. Please note that extracting data - from json is not the intention of this tutorial. You may wish to use the PARAM_COUNT and looping through PARAM_KEY/VALUE pairs instead. - -```c -#include "nwnx_events" -#include "nwnx_http" - -void main() -{ - object oModule = OBJECT_SELF; - if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTP_SERVER_POST") - { - int nRequestId = StringToInt(NWNX_Events_GetEventData("REQUEST_ID")); - json jJSONData = JsonParse(NWNX_Events_GetEventData("JSON_DATA")); - json jFunctionsObject = JsonObjectGet(jJSONData, "functions"); - json jFuncArray = JsonObjectKeys(jFunctionsObject); - int i = 0; - json jFunc = JsonArrayGet(jFuncArray, i); - string sResponse = ""; - while (JsonGetType(jFunc) != JSON_TYPE_NULL) - { - if (JsonGetString(jFunc) == "SendMessageToPC") - { - json jSMTPC = JsonObjectGet(jFunctionsObject, "SendMessageToPC"); - if (JsonGetType(jSMTPC) != JSON_TYPE_NULL) - { - json jPlayers = JsonObjectGet(jSMTPC, "players"); - int n = 0; - json jPlayer = JsonArrayGet(jPlayers, n); - while (JsonGetType(jPlayer) != JSON_TYPE_NULL) - { - string sPCName = JsonGetString(JsonArrayGet(JsonObjectKeys(jPlayer), 0)); - string sMessage = JsonGetString(JsonObjectGet(jPlayer, sPCName)); - object oPC = GetPCWithCommunityName(sPCName); - if (oPC != OBJECT_INVALID) - { - SendMessageToPC(oPC, sMessage); - sResponse = sResponse + " " + sPCName; - } - jPlayer = JsonArrayGet(jPlayers, ++n); - } - } - } - jFunc = JsonArrayGet(jFuncArray, ++i); - } - NWNX_HTTP_Server_SendResponse(nRequestId, "Message sent to player(s): " + sResponse); - } -``` -3. The builder sends the following request to his server: -```shell -curl -i http://localhost:8686/b547bd34f896325c4f8f28ec34f895105c38b427fdaf2 -H 'Content-Type: application/json' --data-binary @- << EOF -{ - "functions": { - "SendMessageToPC": { - "players": [{ "orth": "Log off." }, { "Daz": "HI" }] - } - } -} -EOF -``` -4. The builder receives the response: `Message sent to player(s): ` ## Client Usage The HTTP Client contains two functions, `NWNX_HTTP_Client_SendRequest()` and `NWNX_HTTP_Client_GetRequest()` and broadcasts two events, @@ -163,7 +28,7 @@ request can then be queried via `NWNX_HTTP_Client_GetRequest()`. The `STATUS` ev server HTTP status return code, (usually 200 on success) and the `RESPONSE` is the body of text the server returned. -Additionally, the event data includes Rate Limit information that some servers provide. These are `RATELIMIT_LIMIT` which is how +Additionally the event data includes Rate Limit information that some servers provide. These are `RATELIMIT_LIMIT` which is how many requests you can send in a given time period, `RATELIMIT_REMAINING` is how many requests you have left in that time period and `RATELIMIT_RESET` is an epoch timestamp when the request limit is reset again. There is also `RETRY_AFTER` which some servers provide which is how long in seconds before you can send another request. @@ -171,34 +36,30 @@ some servers provide which is how long in seconds before you can send another re ### Example Client Requests Here is an example of posting an issue to a github repository. ```c - string sMessage = "This would be the content of your player's bug report captured via chat or such."; - object oReporter = GetFirstPC(); // The bug reporter's PC object would be here - string sAuthorName = GetName(oReporter, TRUE) + " ("+ GetPCPlayerName(oReporter)+")"; - object oArea = GetArea(oReporter); - string sTileModel = NWNX_Area_GetTileModelResRef(oArea, GetPosition(oReporter).x, GetPosition(oReporter).y); - json githubJSON = JsonObject(); - githubJSON = JsonObjectSet(githubJSON, "title", JsonString(GetModuleName() + " NWN Bug Report via "+sAuthorName)); - githubJSON = JsonObjectSet(githubJSON, "body", JsonString(sMessage+"
Area Name: **"+ GetName(oArea) + - "**
Area Tag: **"+ GetTag(oArea) + - "**
Location: **" + NWNXLocationToString(GetLocation(oReporter)) + - "**
Tile Model: **" + sTileModel + "**")); - githubJSON = JsonObjectSet(githubJSON, "assignee", JsonString(NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"))); - json jLabels = JsonArray(); - jLabels = JsonArrayInsert(jLabels, JsonString("bug")); - jLabels = JsonArrayInsert(jLabels, JsonString("help wanted")); - githubJSON = JsonObjectSet(githubJSON, "labels", jLabels); - - struct NWNX_HTTP_Client_Request stGithubPost; - stGithubPost.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_POST; - stGithubPost.sHost = "api.github.com"; - stGithubPost.sPath = NWNX_Util_GetEnvironmentVariable("GITHUB_REPO_PATH") + "/issues"; - stGithubPost.sData = JsonDump(githubJSON); - stGithubPost.nAuthType = NWNX_HTTP_AUTH_TYPE_BASIC; - stGithubPost.sAuthUserOrToken = NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"); - stGithubPost.sAuthPassword = NWNX_Util_GetEnvironmentVariable("GITHUB_NWN_PAT"); - stGithubPost.sHeaders = "Accept: application/vnd.github.v3+json"; - stGithubPost.nContentType = NWNX_HTTP_CONTENT_TYPE_JSON; - NWNX_HTTP_Client_SendRequest(stGithubPost); + json githubJSON = JsonObject(); + githubJSON = JsonObjectSet(githubJSON, "title", JsonString(GetModuleName() + " NWN Bug Report via "+sAuthorName)); + githubJSON = JsonObjectSet(githubJSON, "body", JsonString(sMessage+"
Area Name: **"+ GetName(oArea) + + "**
Area Tag: **"+ GetTag(oArea) + + "**
Location: **" + NWNXLocationToString(GetLocation(oReporter)) + + "**
Tile Model: **" + sTileModel + "**")); + githubJSON = JsonObjectSet(githubJSON, "assignee", JsonString(NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"))); + json jLabels = JsonArray(); + jLabels = JsonArrayInsert(jLabels, JsonString("bug")); + jLabels = JsonArrayInsert(jLabels, JsonString("help wanted")); + githubJSON = JsonObjectSet(githubJSON, "labels", jLabels); + + + struct NWNX_HTTP_Client_Request stGithubPost; + stGithubPost.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_POST; + stGithubPost.sHost = "api.github.com"; + stGithubPost.sPath = NWNX_Util_GetEnvironmentVariable("GITHUB_REPO_PATH") + "/issues"; + stGithubPost.sData = JsonDump(githubJSON); + stGithubPost.nAuthType = NWNX_HTTP_AUTH_TYPE_BASIC; + stGithubPost.sAuthUserOrToken = NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"); + stGithubPost.sAuthPassword = NWNX_Util_GetEnvironmentVariable("GITHUB_NWN_PAT"); + stGithubPost.sHeaders = "Accept: application/vnd.github.v3+json"; + stGithubPost.nContentType = NWNX_HTTP_CONTENT_TYPE_JSON; + NWNX_HTTP_Client_SendRequest(stGithubPost); ``` Here's an example of insulting a PC when they enter an area From c130a84af37372686f104d210efa02893553f406 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 02:33:24 -0400 Subject: [PATCH 09/19] openssl 1.1 support --- Plugins/HTTP/External/httplib.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Plugins/HTTP/External/httplib.h b/Plugins/HTTP/External/httplib.h index 117e498fafd..57951acca32 100644 --- a/Plugins/HTTP/External/httplib.h +++ b/Plugins/HTTP/External/httplib.h @@ -273,9 +273,8 @@ using socket_t = int; #if OPENSSL_VERSION_NUMBER < 0x1010107f #error Please use OpenSSL or a current version of BoringSSL #endif -#define SSL_get1_peer_certificate SSL_get_peer_certificate #elif OPENSSL_VERSION_NUMBER < 0x30000000L -#error Sorry, OpenSSL versions prior to 3.0.0 are not supported +#define SSL_get1_peer_certificate SSL_get_peer_certificate #endif #endif From 820f19d60fa2b114088da550c75de58b060a39a4 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 03:01:17 -0400 Subject: [PATCH 10/19] Fix plugin changelog entry location --- CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c9389d3c46..a351edb7e80 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ https://github.com/nwnxee/unified/compare/build8193.34...HEAD - Events: added skippable event `NWNX_ON_DEBUG_PLAY_VISUAL_EFFECT_{BEFORE|AFTER}` which fires when the dm_visualeffect console command is used. ##### New Plugins -- N/A +- HTTP: Client functionality ##### New NWScript Functions - Area: GetTileInfoByTileIndex() @@ -254,7 +254,6 @@ https://github.com/nwnxee/unified/compare/build8193.20...build8193.21 - Optimizations: Added `PlayerLookup` optimization that speeds up some player related functions on highly populated servers. ##### New Plugins -- HTTP: Client functionality. - SWIG: Native Interop support added for DotNET. ##### New NWScript Functions From 91491858b35340176f9f1953a7127292cff97eac Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 08:28:19 -0400 Subject: [PATCH 11/19] rename plugin to HTTPClient plus refactor --- Plugins/HTTP/CMakeLists.txt | 8 - Plugins/HTTP/HTTP.cpp | 27 -- Plugins/HTTP/HTTP.hpp | 57 --- Plugins/HTTP/HTTP/Client.cpp | 219 ----------- Plugins/HTTP/HTTP/Client.hpp | 55 --- Plugins/HTTPClient/CMakeLists.txt | 8 + .../{HTTP => HTTPClient}/External/httplib.h | 0 Plugins/HTTPClient/HTTPClient.cpp | 355 ++++++++++++++++++ .../NWScript/nwnx_http.nss | 0 Plugins/{HTTP => HTTPClient}/README.md | 30 +- 10 files changed, 378 insertions(+), 381 deletions(-) delete mode 100644 Plugins/HTTP/CMakeLists.txt delete mode 100644 Plugins/HTTP/HTTP.cpp delete mode 100644 Plugins/HTTP/HTTP.hpp delete mode 100644 Plugins/HTTP/HTTP/Client.cpp delete mode 100644 Plugins/HTTP/HTTP/Client.hpp create mode 100644 Plugins/HTTPClient/CMakeLists.txt rename Plugins/{HTTP => HTTPClient}/External/httplib.h (100%) create mode 100644 Plugins/HTTPClient/HTTPClient.cpp rename Plugins/{HTTP => HTTPClient}/NWScript/nwnx_http.nss (100%) rename Plugins/{HTTP => HTTPClient}/README.md (76%) diff --git a/Plugins/HTTP/CMakeLists.txt b/Plugins/HTTP/CMakeLists.txt deleted file mode 100644 index 6b423b4c854..00000000000 --- a/Plugins/HTTP/CMakeLists.txt +++ /dev/null @@ -1,8 +0,0 @@ -find_package(OpenSSL) - -if (${OPENSSL_FOUND}) - add_plugin(HTTP HTTP.cpp HTTP/Client.cpp) - add_definitions(-DCPPHTTPLIB_OPENSSL_SUPPORT) - target_link_libraries(HTTP ${OPENSSL_LIBRARIES}) - target_include_directories(HTTP PUBLIC ${OPENSSL_INCLUDE_DIR}) -endif() diff --git a/Plugins/HTTP/HTTP.cpp b/Plugins/HTTP/HTTP.cpp deleted file mode 100644 index d5a56de03b3..00000000000 --- a/Plugins/HTTP/HTTP.cpp +++ /dev/null @@ -1,27 +0,0 @@ -#include "HTTP.hpp" -#include "HTTP/Client.hpp" - -using namespace NWNXLib; -using namespace NWNXLib::API; -using namespace NWNXLib::Services; - -static HTTP::HTTP* g_plugin; - -NWNX_PLUGIN_ENTRY Plugin* PluginLoad(Services::ProxyServiceList* services) -{ - g_plugin = new HTTP::HTTP(services); - return g_plugin; -} - -namespace HTTP { - -HTTP::HTTP(Services::ProxyServiceList* services) - : Plugin(services) -{ - m_Client = std::make_unique(); -} - -HTTP::~HTTP() -= default; - -} diff --git a/Plugins/HTTP/HTTP.hpp b/Plugins/HTTP/HTTP.hpp deleted file mode 100644 index 0750dfc93fb..00000000000 --- a/Plugins/HTTP/HTTP.hpp +++ /dev/null @@ -1,57 +0,0 @@ -#pragma once - -#include "nwnx.hpp" -#include "External/httplib.h" - -namespace HTTP { - class Client; - - class HTTP : public NWNXLib::Plugin - { - public: - explicit HTTP(NWNXLib::Services::ProxyServiceList*); - ~HTTP() override; - enum RequestMethod - { - GET = 0, - POST = 1, - DELETE = 2, - PATCH = 3, - PUT = 5, - OPTION = 6, - HEAD = 7 - }; - enum AuthenticationType - { - NONE = 0, - BASIC = 1, - DIGEST = 2, - BEARER_TOKEN = 3 - }; - enum ContentType - { - HTML = 0, - PLAINTEXT = 1, - JSON = 2, - URL_ENCODED = 3, - XML = 4, - }; - - static constexpr const char* ContentTypeToString(const unsigned value) - { - constexpr const char* TYPE_STRINGS[] = - { - "text/html", - "text/plain", - "application/json", - "application/x-www-form-urlencoded", - "application/xml" - }; - return (value > 4) ? "text/html" : TYPE_STRINGS[value]; - } - - private: - std::unique_ptr m_Client; - }; - -} diff --git a/Plugins/HTTP/HTTP/Client.cpp b/Plugins/HTTP/HTTP/Client.cpp deleted file mode 100644 index d32c460fc83..00000000000 --- a/Plugins/HTTP/HTTP/Client.cpp +++ /dev/null @@ -1,219 +0,0 @@ -#include "HTTP/Client.hpp" - -namespace Core { - extern bool g_CoreShuttingDown; -} - -using namespace NWNXLib; - -namespace HTTP -{ - -Client::Client() -{ - ScriptAPI::RegisterEvent(PLUGIN_NAME, "Client_SendRequest", &SendRequest); - ScriptAPI::RegisterEvent(PLUGIN_NAME, "Client_GetRequest", &GetRequest); - m_clientTimeout = Config::Get("CLIENT_REQUEST_TIMEOUT", 2000); -} - -std::unique_ptr Client::GetResult(const Client::Request& client_req) -{ - std::unique_ptr result; - auto cli = m_clientHostCache[client_req.host].get(); - switch(client_req.requestMethod) - { - case HTTP::RequestMethod::GET: - result = std::make_unique(cli->Get(client_req.path.c_str(), client_req.headers)); - break; - case HTTP::RequestMethod::POST: - result = std::make_unique(cli->Post(client_req.path.c_str(), client_req.headers, client_req.data,HTTP::ContentTypeToString(client_req.contentType))); - break; - case HTTP::RequestMethod::DELETE: - result = std::make_unique(cli->Delete(client_req.path.c_str(), client_req.headers, client_req.data, HTTP::ContentTypeToString(client_req.contentType))); - break; - case HTTP::RequestMethod::PATCH: - result = std::make_unique(cli->Patch(client_req.path.c_str(), client_req.headers, client_req.data, HTTP::ContentTypeToString(client_req.contentType))); - break; - case HTTP::RequestMethod::PUT: - result = std::make_unique(cli->Put(client_req.path.c_str(), client_req.headers, client_req.data, HTTP::ContentTypeToString(client_req.contentType))); - break; - case HTTP::RequestMethod::OPTION: - result = std::make_unique(cli->Options(client_req.path.c_str(), client_req.headers)); - break; - case HTTP::RequestMethod::HEAD: - result = std::make_unique(cli->Head(client_req.path.c_str(), client_req.headers)); - break; - } - - return result; -} - -void Client::PerformRequest(const Client::Request& client_req) -{ - auto cli = m_clientHostCache.find(client_req.host); - if (cli == std::end(m_clientHostCache)) - { - LOG_DEBUG("Creating new SSL client for host %s.", client_req.host); - cli = m_clientHostCache.insert(std::make_pair(client_req.host, std::make_unique(client_req.host.c_str(), client_req.port))).first; - } - - if (client_req.authType == HTTP::AuthenticationType::BASIC) - cli->second->set_basic_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); - else if (client_req.authType == HTTP::AuthenticationType::DIGEST) - cli->second->set_digest_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); - else if (client_req.authType == HTTP::AuthenticationType::BEARER_TOKEN) - cli->second->set_bearer_token_auth(client_req.authUserToken.c_str()); - - if (Core::g_CoreShuttingDown) - { - // Shorter timeout when shutting down - cli->second->set_connection_timeout(0, 300000); - auto result = GetResult(client_req); - auto res = result->value(); - - if (res.status == 200) - LOG_INFO("Sent webhook '%s' to '%s%s'.", client_req.data, client_req.host, client_req.path); - else - LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.",client_req.data.c_str(), client_req.host.c_str(), client_req.path.c_str(), res.status); - return; - } - Tasks::QueueOnAsyncThread([cli, client_req]() - { - cli->second->set_connection_timeout(0, m_clientTimeout * 1000); - auto result = GetResult(client_req); - - if (result == nullptr || result->error() != httplib::Error::Success) - { - auto clientError = result != nullptr ? result->error() : httplib::Error::Unknown; - Tasks::QueueOnMainThread([client_req, clientError]() - { - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", "Failed to make a client request with server. Is the url/port correct?"}); - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", "0"}); - LOG_ERROR("HTTP Client Request to '%s%s' failed, [Error: %d].", client_req.host, client_req.path, clientError); - }); - return; - } - auto response = result->value(); - Tasks::QueueOnMainThread([client_req, response]() - { - if (Core::g_CoreShuttingDown) - return; - - auto moduleOid = "0"; - - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"STATUS", std::to_string(response.status)}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RESPONSE", response.body}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"REQUEST_ID", std::to_string(client_req.id)}); - if (response.status == 200 || response.status == 201 || response.status == 204 || response.status == 429) - { - // Discord sends your rate limit information even on success so you can stagger calls if you want - // This header also lets us know it's Discord not Slack, important because Discord sends RETRY_AFTER - // in milliseconds and Slack sends it as seconds. - if (response.has_header("X-RateLimit-Limit")) - { - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_LIMIT", response.get_header_value("X-RateLimit-Limit")}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_REMAINING", response.get_header_value("X-RateLimit-Remaining")}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RATELIMIT_RESET", response.get_header_value("X-RateLimit-Reset")}); - if (response.has_header("Retry-After")) - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-After")}); - else if (response.has_header("Retry-At")) - { - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", response.get_header_value("Retry-At")}); - } - } - // Slack rate limited - else if (response.has_header("Retry-After")) - { - float fSlackRetry = stof(response.get_header_value("Retry-After")) * 1000.0f; - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", std::to_string(fSlackRetry)}); - } - if (response.status != 429) - { - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_SUCCESS", moduleOid}); - LOG_INFO("HTTP Client Request to '%s%s' succeeded.", client_req.host, client_req.path); - } - else - { - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); - LOG_WARNING("HTTP Client Request to '%s%s' failed, rate limited.", client_req.host, client_req.path); - } - } - else - { - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", {"NWNX_ON_HTTP_CLIENT_FAILED", moduleOid}); - LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.host, client_req.path, response.status); - } - }); - }); -} - -httplib::Headers Client::ParseHeaderString(const std::string& headerStr) -{ - httplib::Headers headers; - if (!headerStr.empty()) - { - std::string::size_type key_pos = 0; - std::string::size_type key_end, val_pos, val_end; - while((key_end = headerStr.find(':', key_pos)) != std::string::npos) - { - if((val_pos = headerStr.find_first_not_of(": ", key_end)) == std::string::npos) - break; - - val_end = headerStr.find('|', val_pos); - headers.emplace(headerStr.substr(key_pos, key_end - key_pos), headerStr.substr(val_pos, val_end - val_pos)); - - key_pos = val_end; - if(key_pos != std::string::npos) - ++key_pos; - } - } - return headers; -} - -ScriptAPI::ArgumentStack Client::SendRequest(ScriptAPI::ArgumentStack&& args) -{ - auto clientReq = Request(); - clientReq.id = m_clientRequestId++; - clientReq.tag = ScriptAPI::ExtractArgument(args); - clientReq.requestMethod = static_cast(ScriptAPI::ExtractArgument(args)); - clientReq.host = ScriptAPI::ExtractArgument(args); - clientReq.path = ScriptAPI::ExtractArgument(args); - clientReq.contentType = static_cast(ScriptAPI::ExtractArgument(args)); - clientReq.data = ScriptAPI::ExtractArgument(args); - clientReq.authType = static_cast(ScriptAPI::ExtractArgument(args)); - clientReq.authUserToken = ScriptAPI::ExtractArgument(args); - clientReq.authPassword = ScriptAPI::ExtractArgument(args); - clientReq.port = ScriptAPI::ExtractArgument(args); - if (!clientReq.port) clientReq.port = 443; - clientReq.headersString = ScriptAPI::ExtractArgument(args); - clientReq.headers = ParseHeaderString(clientReq.headersString); - m_clientRequests[clientReq.id] = clientReq; - PerformRequest(clientReq); - - return ScriptAPI::Arguments(clientReq.id); -} - -ScriptAPI::ArgumentStack Client::GetRequest(ScriptAPI::ArgumentStack&& args) -{ - ScriptAPI::ArgumentStack stack; - auto requestId = ScriptAPI::ExtractArgument(args); - auto req = m_clientRequests.find(requestId); - ASSERT_OR_THROW(req != std::end(m_clientRequests)); - auto clientReq = req->second; - - ScriptAPI::InsertArgument(stack, clientReq.headersString); - ScriptAPI::InsertArgument(stack, (int32_t)clientReq.port); - ScriptAPI::InsertArgument(stack, clientReq.authPassword); - ScriptAPI::InsertArgument(stack, clientReq.authUserToken); - ScriptAPI::InsertArgument(stack, (int32_t)clientReq.authType); - ScriptAPI::InsertArgument(stack, clientReq.data); - ScriptAPI::InsertArgument(stack, (int32_t)clientReq.contentType); - ScriptAPI::InsertArgument(stack, clientReq.path); - ScriptAPI::InsertArgument(stack, clientReq.host); - ScriptAPI::InsertArgument(stack, (int32_t)clientReq.requestMethod); - ScriptAPI::InsertArgument(stack, clientReq.tag); - return stack; -} - -} diff --git a/Plugins/HTTP/HTTP/Client.hpp b/Plugins/HTTP/HTTP/Client.hpp deleted file mode 100644 index eef81fb4440..00000000000 --- a/Plugins/HTTP/HTTP/Client.hpp +++ /dev/null @@ -1,55 +0,0 @@ -#pragma once - -#include "HTTP.hpp" - -using ArgumentStack = NWNXLib::ArgumentStack; - -namespace HTTP -{ - -using namespace NWNXLib::Services; - -class Client -{ - struct Request - { - int id; - HTTP::RequestMethod requestMethod; - std::string host; - int port; - std::string path; - HTTP::AuthenticationType authType; - std::string authUserToken; - std::string authPassword; - HTTP::ContentType contentType; - std::string data; - std::string headersString; - httplib::Headers headers; - std::string tag; - - Request() - { - id = -1; - requestMethod = HTTP::RequestMethod::GET; - port = 443; - authType = HTTP::AuthenticationType::NONE; - contentType = HTTP::ContentType::HTML; - } - }; -public: - explicit Client(); -private: - - static ArgumentStack GetRequest(ArgumentStack&&); - static ArgumentStack SendRequest(ArgumentStack&&); - - static void PerformRequest(const Client::Request&); - static std::unique_ptr GetResult(const Client::Request&); - static httplib::Headers ParseHeaderString(const std::string&); - static inline int m_clientRequestId = 0; - static inline int m_clientTimeout = 2000; - static inline std::unordered_map> m_clientHostCache; - static inline std::unordered_map m_clientRequests; -}; - -} diff --git a/Plugins/HTTPClient/CMakeLists.txt b/Plugins/HTTPClient/CMakeLists.txt new file mode 100644 index 00000000000..db330ac7654 --- /dev/null +++ b/Plugins/HTTPClient/CMakeLists.txt @@ -0,0 +1,8 @@ +find_package(OpenSSL) + +if (${OPENSSL_FOUND}) + add_plugin(HTTPClient HTTPClient.cpp) + add_definitions(-DCPPHTTPLIB_OPENSSL_SUPPORT) + target_link_libraries(HTTPClient ${OPENSSL_LIBRARIES}) + target_include_directories(HTTPClient PUBLIC ${OPENSSL_INCLUDE_DIR}) +endif() diff --git a/Plugins/HTTP/External/httplib.h b/Plugins/HTTPClient/External/httplib.h similarity index 100% rename from Plugins/HTTP/External/httplib.h rename to Plugins/HTTPClient/External/httplib.h diff --git a/Plugins/HTTPClient/HTTPClient.cpp b/Plugins/HTTPClient/HTTPClient.cpp new file mode 100644 index 00000000000..a40532c2e14 --- /dev/null +++ b/Plugins/HTTPClient/HTTPClient.cpp @@ -0,0 +1,355 @@ +#include "nwnx.hpp" +#include "External/httplib.h" + +enum RequestMethod +{ + GET = 0, + POST = 1, + DEL = 2, + PATCH = 3, + PUT = 5, + OPTION = 6, + HEAD = 7 +}; +enum AuthenticationType +{ + NONE = 0, + BASIC = 1, + DIGEST = 2, + BEARER_TOKEN = 3 +}; +enum ContentType +{ + HTML = 0, + PLAINTEXT = 1, + JSON = 2, + URL_ENCODED = 3, + XML = 4, +}; + +struct Request +{ + int id; + RequestMethod requestMethod; + std::string host; + int port; + std::string path; + AuthenticationType authType; + std::string authUserToken; + std::string authPassword; + ContentType contentType; + std::string data; + std::string headersString; + httplib::Headers headers; + std::string tag; + + Request() + { + id = -1; + requestMethod = RequestMethod::GET; + port = 443; + authType = AuthenticationType::NONE; + contentType = ContentType::HTML; + } +}; + +static std::unique_ptr GetResult(const Request&); +static httplib::Headers ParseHeaderString(const std::string&); +static inline int m_clientRequestId = 0; +static inline int m_clientTimeout = 2000; +static inline std::unordered_map> m_clientHostCache; +static inline std::unordered_map m_clientRequests; + +static constexpr const char* ContentTypeToString(const unsigned value) +{ + constexpr const char* TYPE_STRINGS[] = + { + "text/html", + "text/plain", + "application/json", + "application/x-www-form-urlencoded", + "application/xml" + }; + return (value > 4) ? "text/html" : TYPE_STRINGS[value]; +} + +namespace Core { + extern bool g_CoreShuttingDown; +} + +using namespace NWNXLib; +using namespace NWNXLib::API; + + + + + std::unique_ptr GetResult(const Request &client_req) + { + std::unique_ptr result; + auto cli = m_clientHostCache[client_req.host].get(); + switch (client_req.requestMethod) + { + case RequestMethod::GET: + result = std::make_unique(cli->Get(client_req.path.c_str(), client_req.headers)); + break; + case RequestMethod::POST: + result = std::make_unique( + cli->Post(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::DEL: + result = std::make_unique( + cli->Delete(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::PATCH: + result = std::make_unique( + cli->Patch(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::PUT: + result = std::make_unique( + cli->Put(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::OPTION: + result = std::make_unique(cli->Options(client_req.path.c_str(), client_req.headers)); + break; + case RequestMethod::HEAD: + result = std::make_unique(cli->Head(client_req.path.c_str(), client_req.headers)); + break; + } + + return result; + } + + void PerformRequest(const Request &client_req) + { + auto cli = m_clientHostCache.find(client_req.host); + if (cli == std::end(m_clientHostCache)) + { + LOG_DEBUG("Creating new SSL client for host %s.", client_req.host); + cli = m_clientHostCache.insert(std::make_pair(client_req.host, + std::make_unique(client_req.host.c_str(), + client_req.port))).first; + } + + if (client_req.authType == AuthenticationType::BASIC) + cli->second->set_basic_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); + else if (client_req.authType == AuthenticationType::DIGEST) + cli->second->set_digest_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); + else if (client_req.authType == AuthenticationType::BEARER_TOKEN) + cli->second->set_bearer_token_auth(client_req.authUserToken.c_str()); + + if (Core::g_CoreShuttingDown) + { + // Shorter timeout when shutting down + cli->second->set_connection_timeout(0, 300000); + auto result = GetResult(client_req); + auto res = result->value(); + + if (res.status == 200) + LOG_INFO("Sent webhook '%s' to '%s%s'.", client_req.data, client_req.host, client_req.path); + else + LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.data.c_str(), + client_req.host.c_str(), client_req.path.c_str(), res.status); + return; + } + Tasks::QueueOnAsyncThread([cli, client_req]() + { + cli->second->set_connection_timeout(0, m_clientTimeout * 1000); + auto result = GetResult(client_req); + + if (result == nullptr || result->error() != httplib::Error::Success) + { + auto clientError = + result != nullptr ? result->error() : httplib::Error::Unknown; + Tasks::QueueOnMainThread([client_req, clientError]() + { + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"REQUEST_ID", + std::to_string(client_req.id)}); + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RESPONSE", + "Failed to make a client request with server. Is the url/port correct?"}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_FAILED", + "0"}); + LOG_ERROR( + "HTTP Client Request to '%s%s' failed, [Error: %d].", + client_req.host, client_req.path, + clientError); + }); + return; + } + auto response = result->value(); + Tasks::QueueOnMainThread([client_req, response]() + { + if (Core::g_CoreShuttingDown) + return; + + auto moduleOid = "0"; + + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", + {"STATUS", std::to_string( + response.status)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", + {"RESPONSE", response.body}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", + {"REQUEST_ID", std::to_string( + client_req.id)}); + if (response.status == 200 || + response.status == 201 || + response.status == 204 || response.status == 429) + { + // Discord sends your rate limit information even on success so you can stagger calls if you want + // This header also lets us know it's Discord not Slack, important because Discord sends RETRY_AFTER + // in milliseconds and Slack sends it as seconds. + if (response.has_header("X-RateLimit-Limit")) + { + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RATELIMIT_LIMIT", + response.get_header_value( + "X-RateLimit-Limit")}); + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RATELIMIT_REMAINING", + response.get_header_value( + "X-RateLimit-Remaining")}); + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RATELIMIT_RESET", + response.get_header_value( + "X-RateLimit-Reset")}); + if (response.has_header("Retry-After")) + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RETRY_AFTER", + response.get_header_value( + "Retry-After")}); + else if (response.has_header("Retry-At")) + { + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RETRY_AFTER", + response.get_header_value( + "Retry-At")}); + } + } + // Slack rate limited + else if (response.has_header("Retry-After")) + { + float fSlackRetry = + stof(response.get_header_value( + "Retry-After")) * 1000.0f; + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RETRY_AFTER", + std::to_string(fSlackRetry)}); + } + if (response.status != 429) + { + MessageBus::Broadcast( + "NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_SUCCESS", + moduleOid}); + LOG_INFO( + "HTTP Client Request to '%s%s' succeeded.", + client_req.host, client_req.path); + } + else + { + MessageBus::Broadcast( + "NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_FAILED", + moduleOid}); + LOG_WARNING( + "HTTP Client Request to '%s%s' failed, rate limited.", + client_req.host, client_req.path); + } + } + else + { + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_FAILED", + moduleOid}); + LOG_WARNING( + "HTTP Client Request to '%s%s' failed, status code '%d'.", + client_req.host, client_req.path, + response.status); + } + }); + }); + } + + httplib::Headers ParseHeaderString(const std::string &headerStr) + { + httplib::Headers headers; + if (!headerStr.empty()) + { + std::string::size_type key_pos = 0; + std::string::size_type key_end, val_pos, val_end; + while ((key_end = headerStr.find(':', key_pos)) != std::string::npos) + { + if ((val_pos = headerStr.find_first_not_of(": ", key_end)) == std::string::npos) + break; + + val_end = headerStr.find('|', val_pos); + headers.emplace(headerStr.substr(key_pos, key_end - key_pos), + headerStr.substr(val_pos, val_end - val_pos)); + + key_pos = val_end; + if (key_pos != std::string::npos) + ++key_pos; + } + } + return headers; + } + + NWNX_EXPORT ArgumentStack SendRequest(ArgumentStack &&args) + { + auto clientReq = Request(); + clientReq.id = m_clientRequestId++; + clientReq.tag = ScriptAPI::ExtractArgument(args); + clientReq.requestMethod = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.host = ScriptAPI::ExtractArgument(args); + clientReq.path = ScriptAPI::ExtractArgument(args); + clientReq.contentType = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.data = ScriptAPI::ExtractArgument(args); + clientReq.authType = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.authUserToken = ScriptAPI::ExtractArgument(args); + clientReq.authPassword = ScriptAPI::ExtractArgument(args); + clientReq.port = ScriptAPI::ExtractArgument(args); + if (!clientReq.port) clientReq.port = 443; + clientReq.headersString = ScriptAPI::ExtractArgument(args); + clientReq.headers = ParseHeaderString(clientReq.headersString); + m_clientRequests[clientReq.id] = clientReq; + PerformRequest(clientReq); + + return ScriptAPI::Arguments(clientReq.id); + } + + NWNX_EXPORT ArgumentStack GetRequest(ArgumentStack &&args) + { + ScriptAPI::ArgumentStack stack; + auto requestId = ScriptAPI::ExtractArgument(args); + auto req = m_clientRequests.find(requestId); + ASSERT_OR_THROW(req != std::end(m_clientRequests)); + auto clientReq = req->second; + + ScriptAPI::InsertArgument(stack, clientReq.headersString); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.port); + ScriptAPI::InsertArgument(stack, clientReq.authPassword); + ScriptAPI::InsertArgument(stack, clientReq.authUserToken); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.authType); + ScriptAPI::InsertArgument(stack, clientReq.data); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.contentType); + ScriptAPI::InsertArgument(stack, clientReq.path); + ScriptAPI::InsertArgument(stack, clientReq.host); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.requestMethod); + ScriptAPI::InsertArgument(stack, clientReq.tag); + return stack; + } \ No newline at end of file diff --git a/Plugins/HTTP/NWScript/nwnx_http.nss b/Plugins/HTTPClient/NWScript/nwnx_http.nss similarity index 100% rename from Plugins/HTTP/NWScript/nwnx_http.nss rename to Plugins/HTTPClient/NWScript/nwnx_http.nss diff --git a/Plugins/HTTP/README.md b/Plugins/HTTPClient/README.md similarity index 76% rename from Plugins/HTTP/README.md rename to Plugins/HTTPClient/README.md index e7cf41959bb..3d39869af91 100644 --- a/Plugins/HTTP/README.md +++ b/Plugins/HTTPClient/README.md @@ -1,5 +1,5 @@ -@page http Readme -@ingroup http +@page httpclient Readme +@ingroup httpclient ## Introduction The HTTP Plugin provides access to a Client to perform requests and return responses. @@ -8,23 +8,23 @@ The HTTP Plugin provides access to a Client to perform requests and return respo | Variable Name | Type | Default Value | | ----------------------------------| :--------: | ------------------ | -| NWNX_HTTP_CLIENT_REQUEST_TIMEOUT | int | 2000 | +| NWNX_HTTPCLIENT_REQUEST_TIMEOUT | int | 2000 | ## Setup ### Client The Client commands are functional by simply loading the plugin. ## Client Usage -The HTTP Client contains two functions, `NWNX_HTTP_Client_SendRequest()` and `NWNX_HTTP_Client_GetRequest()` and broadcasts two events, -`NWNX_ON_HTTP_CLIENT_SUCCESS` and `NWNX_ON_HTTP_CLIENT_FAILED`. +The HTTP Client contains two functions, `NWNX_HTTPClient_SendRequest()` and `NWNX_HTTPClient_GetRequest()` and broadcasts two events, +`NWNX_ON_HTTPCLIENT_SUCCESS` and `NWNX_ON_HTTPCLIENT_FAILED`. -The builder constructs an `NWNX_HTTP_Client_Request` struct with the appropriate information -then passes that struct into `NWNX_HTTP_Client_SendRequest()` which will return a unique request identifier. The +The builder constructs an `NWNX_HTTPClient_Request` struct with the appropriate information +then passes that struct into `NWNX_HTTPClient_SendRequest()` which will return a unique request identifier. The request is then sent to the host and upon success or failure the respective event is called. The event data sent is `REQUEST_ID`, `STATUS` and `RESPONSE`. The `REQUEST_ID` -event data is the integer returned with `NWNX_HTTP_Client_SendRequest()`. The structure for that -request can then be queried via `NWNX_HTTP_Client_GetRequest()`. The `STATUS` event data is the +event data is the integer returned with `NWNX_HTTPClient_SendRequest()`. The structure for that +request can then be queried via `NWNX_HTTPClient_GetRequest()`. The `STATUS` event data is the server HTTP status return code, (usually 200 on success) and the `RESPONSE` is the body of text the server returned. @@ -49,7 +49,7 @@ Here is an example of posting an issue to a github repository. githubJSON = JsonObjectSet(githubJSON, "labels", jLabels); - struct NWNX_HTTP_Client_Request stGithubPost; + struct NWNX_HTTPClient_Request stGithubPost; stGithubPost.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_POST; stGithubPost.sHost = "api.github.com"; stGithubPost.sPath = NWNX_Util_GetEnvironmentVariable("GITHUB_REPO_PATH") + "/issues"; @@ -59,27 +59,27 @@ Here is an example of posting an issue to a github repository. stGithubPost.sAuthPassword = NWNX_Util_GetEnvironmentVariable("GITHUB_NWN_PAT"); stGithubPost.sHeaders = "Accept: application/vnd.github.v3+json"; stGithubPost.nContentType = NWNX_HTTP_CONTENT_TYPE_JSON; - NWNX_HTTP_Client_SendRequest(stGithubPost); + NWNX_HTTPClient_SendRequest(stGithubPost); ``` Here's an example of insulting a PC when they enter an area ```c - struct NWNX_HTTP_Client_Request stInsultGen; + struct NWNX_HTTPClient_Request stInsultGen; stInsultGen.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_GET; stInsultGen.sHost = "evilinsult.com"; stInsultGen.sPath = "/generate_insult.php"; stInsultGen.oObject = GetEnteringObject(); stInsultGen.sTag = "INSULT_ENTERING_PC"; - int nClientRequestId = NWNX_HTTP_Client_SendRequest(stInsultGen); + int nClientRequestId = NWNX_HTTPClient_SendRequest(stInsultGen); SetLocalObject(GetModule(), "INSULTED_" + IntToString(nClientRequestId), GetEnteringObject()); ``` Then set up an event: ```c - if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTP_CLIENT_SUCCESS") + if (NWNX_Events_GetCurrentEvent() == "NWNX_ON_HTTPCLIENT_SUCCESS") { int nRequestId = StringToInt(NWNX_Events_GetEventData("REQUEST_ID")); - struct NWNX_HTTP_Client_Request sRequest = NWNX_HTTP_Client_GetRequest(nRequestId); + struct NWNX_HTTPClient_Request sRequest = NWNX_HTTPClient_GetRequest(nRequestId); if (sRequest.sTag == "INSULT_ENTERING_PC") { string sResponse = NWNX_Events_GetEventData("RESPONSE"); From eb1013680372d6d721a3b6d4a91f7d46f886618c Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 08:35:41 -0400 Subject: [PATCH 12/19] whitespace cleanup, initialize timeout from config --- Plugins/HTTPClient/HTTPClient.cpp | 478 +++++++++++++++--------------- 1 file changed, 238 insertions(+), 240 deletions(-) diff --git a/Plugins/HTTPClient/HTTPClient.cpp b/Plugins/HTTPClient/HTTPClient.cpp index a40532c2e14..3a541ac7380 100644 --- a/Plugins/HTTPClient/HTTPClient.cpp +++ b/Plugins/HTTPClient/HTTPClient.cpp @@ -53,13 +53,6 @@ struct Request } }; -static std::unique_ptr GetResult(const Request&); -static httplib::Headers ParseHeaderString(const std::string&); -static inline int m_clientRequestId = 0; -static inline int m_clientTimeout = 2000; -static inline std::unordered_map> m_clientHostCache; -static inline std::unordered_map m_clientRequests; - static constexpr const char* ContentTypeToString(const unsigned value) { constexpr const char* TYPE_STRINGS[] = @@ -80,276 +73,281 @@ namespace Core { using namespace NWNXLib; using namespace NWNXLib::API; +static std::unique_ptr GetResult(const Request&); +static httplib::Headers ParseHeaderString(const std::string&); +static inline int m_clientRequestId = 0; +static inline int m_clientTimeout = Config::Get("CLIENT_REQUEST_TIMEOUT", 2000); +static inline std::unordered_map> m_clientHostCache; +static inline std::unordered_map m_clientRequests; - - std::unique_ptr GetResult(const Request &client_req) +std::unique_ptr GetResult(const Request &client_req) +{ + std::unique_ptr result; + auto cli = m_clientHostCache[client_req.host].get(); + switch (client_req.requestMethod) { - std::unique_ptr result; - auto cli = m_clientHostCache[client_req.host].get(); - switch (client_req.requestMethod) - { - case RequestMethod::GET: - result = std::make_unique(cli->Get(client_req.path.c_str(), client_req.headers)); - break; - case RequestMethod::POST: - result = std::make_unique( - cli->Post(client_req.path.c_str(), client_req.headers, client_req.data, - ContentTypeToString(client_req.contentType))); - break; - case RequestMethod::DEL: - result = std::make_unique( - cli->Delete(client_req.path.c_str(), client_req.headers, client_req.data, - ContentTypeToString(client_req.contentType))); - break; - case RequestMethod::PATCH: - result = std::make_unique( - cli->Patch(client_req.path.c_str(), client_req.headers, client_req.data, - ContentTypeToString(client_req.contentType))); - break; - case RequestMethod::PUT: - result = std::make_unique( - cli->Put(client_req.path.c_str(), client_req.headers, client_req.data, - ContentTypeToString(client_req.contentType))); - break; - case RequestMethod::OPTION: - result = std::make_unique(cli->Options(client_req.path.c_str(), client_req.headers)); - break; - case RequestMethod::HEAD: - result = std::make_unique(cli->Head(client_req.path.c_str(), client_req.headers)); - break; - } - - return result; + case RequestMethod::GET: + result = std::make_unique(cli->Get(client_req.path.c_str(), client_req.headers)); + break; + case RequestMethod::POST: + result = std::make_unique( + cli->Post(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::DEL: + result = std::make_unique( + cli->Delete(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::PATCH: + result = std::make_unique( + cli->Patch(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::PUT: + result = std::make_unique( + cli->Put(client_req.path.c_str(), client_req.headers, client_req.data, + ContentTypeToString(client_req.contentType))); + break; + case RequestMethod::OPTION: + result = std::make_unique(cli->Options(client_req.path.c_str(), client_req.headers)); + break; + case RequestMethod::HEAD: + result = std::make_unique(cli->Head(client_req.path.c_str(), client_req.headers)); + break; } - void PerformRequest(const Request &client_req) + return result; +} + +void PerformRequest(const Request &client_req) +{ + auto cli = m_clientHostCache.find(client_req.host); + if (cli == std::end(m_clientHostCache)) { - auto cli = m_clientHostCache.find(client_req.host); - if (cli == std::end(m_clientHostCache)) - { - LOG_DEBUG("Creating new SSL client for host %s.", client_req.host); - cli = m_clientHostCache.insert(std::make_pair(client_req.host, - std::make_unique(client_req.host.c_str(), - client_req.port))).first; - } + LOG_DEBUG("Creating new SSL client for host %s.", client_req.host); + cli = m_clientHostCache.insert(std::make_pair(client_req.host, + std::make_unique(client_req.host.c_str(), + client_req.port))).first; + } - if (client_req.authType == AuthenticationType::BASIC) - cli->second->set_basic_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); - else if (client_req.authType == AuthenticationType::DIGEST) - cli->second->set_digest_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); - else if (client_req.authType == AuthenticationType::BEARER_TOKEN) - cli->second->set_bearer_token_auth(client_req.authUserToken.c_str()); + if (client_req.authType == AuthenticationType::BASIC) + cli->second->set_basic_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); + else if (client_req.authType == AuthenticationType::DIGEST) + cli->second->set_digest_auth(client_req.authUserToken.c_str(), client_req.authPassword.c_str()); + else if (client_req.authType == AuthenticationType::BEARER_TOKEN) + cli->second->set_bearer_token_auth(client_req.authUserToken.c_str()); - if (Core::g_CoreShuttingDown) - { - // Shorter timeout when shutting down - cli->second->set_connection_timeout(0, 300000); - auto result = GetResult(client_req); - auto res = result->value(); + if (Core::g_CoreShuttingDown) + { + // Shorter timeout when shutting down + cli->second->set_connection_timeout(0, 300000); + auto result = GetResult(client_req); + auto res = result->value(); - if (res.status == 200) - LOG_INFO("Sent webhook '%s' to '%s%s'.", client_req.data, client_req.host, client_req.path); - else - LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.data.c_str(), - client_req.host.c_str(), client_req.path.c_str(), res.status); - return; - } - Tasks::QueueOnAsyncThread([cli, client_req]() + if (res.status == 200) + LOG_INFO("Sent webhook '%s' to '%s%s'.", client_req.data, client_req.host, client_req.path); + else + LOG_WARNING("HTTP Client Request to '%s%s' failed, status code '%d'.", client_req.data.c_str(), + client_req.host.c_str(), client_req.path.c_str(), res.status); + return; + } + Tasks::QueueOnAsyncThread([cli, client_req]() + { + cli->second->set_connection_timeout(0, m_clientTimeout * 1000); + auto result = GetResult(client_req); + + if (result == nullptr || result->error() != httplib::Error::Success) { - cli->second->set_connection_timeout(0, m_clientTimeout * 1000); - auto result = GetResult(client_req); + auto clientError = + result != nullptr ? result->error() : httplib::Error::Unknown; + Tasks::QueueOnMainThread([client_req, clientError]() + { + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"REQUEST_ID", + std::to_string(client_req.id)}); + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RESPONSE", + "Failed to make a client request with server. Is the url/port correct?"}); + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_FAILED", + "0"}); + LOG_ERROR( + "HTTP Client Request to '%s%s' failed, [Error: %d].", + client_req.host, client_req.path, + clientError); + }); + return; + } + auto response = result->value(); + Tasks::QueueOnMainThread([client_req, response]() + { + if (Core::g_CoreShuttingDown) + return; + + auto moduleOid = "0"; - if (result == nullptr || result->error() != httplib::Error::Success) - { - auto clientError = - result != nullptr ? result->error() : httplib::Error::Unknown; - Tasks::QueueOnMainThread([client_req, clientError]() + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", + {"STATUS", std::to_string( + response.status)}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", + {"RESPONSE", response.body}); + MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", + {"REQUEST_ID", std::to_string( + client_req.id)}); + if (response.status == 200 || + response.status == 201 || + response.status == 204 || response.status == 429) + { + // Discord sends your rate limit information even on success so you can stagger calls if you want + // This header also lets us know it's Discord not Slack, important because Discord sends RETRY_AFTER + // in milliseconds and Slack sends it as seconds. + if (response.has_header("X-RateLimit-Limit")) { MessageBus::Broadcast( "NWNX_EVENT_PUSH_EVENT_DATA", - {"REQUEST_ID", - std::to_string(client_req.id)}); + {"RATELIMIT_LIMIT", + response.get_header_value( + "X-RateLimit-Limit")}); MessageBus::Broadcast( "NWNX_EVENT_PUSH_EVENT_DATA", - {"RESPONSE", - "Failed to make a client request with server. Is the url/port correct?"}); - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", - {"NWNX_ON_HTTP_CLIENT_FAILED", - "0"}); - LOG_ERROR( - "HTTP Client Request to '%s%s' failed, [Error: %d].", - client_req.host, client_req.path, - clientError); - }); - return; - } - auto response = result->value(); - Tasks::QueueOnMainThread([client_req, response]() - { - if (Core::g_CoreShuttingDown) - return; - - auto moduleOid = "0"; - - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", - {"STATUS", std::to_string( - response.status)}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", - {"RESPONSE", response.body}); - MessageBus::Broadcast("NWNX_EVENT_PUSH_EVENT_DATA", - {"REQUEST_ID", std::to_string( - client_req.id)}); - if (response.status == 200 || - response.status == 201 || - response.status == 204 || response.status == 429) - { - // Discord sends your rate limit information even on success so you can stagger calls if you want - // This header also lets us know it's Discord not Slack, important because Discord sends RETRY_AFTER - // in milliseconds and Slack sends it as seconds. - if (response.has_header("X-RateLimit-Limit")) - { - MessageBus::Broadcast( - "NWNX_EVENT_PUSH_EVENT_DATA", - {"RATELIMIT_LIMIT", - response.get_header_value( - "X-RateLimit-Limit")}); - MessageBus::Broadcast( - "NWNX_EVENT_PUSH_EVENT_DATA", - {"RATELIMIT_REMAINING", - response.get_header_value( - "X-RateLimit-Remaining")}); + {"RATELIMIT_REMAINING", + response.get_header_value( + "X-RateLimit-Remaining")}); + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RATELIMIT_RESET", + response.get_header_value( + "X-RateLimit-Reset")}); + if (response.has_header("Retry-After")) MessageBus::Broadcast( "NWNX_EVENT_PUSH_EVENT_DATA", - {"RATELIMIT_RESET", + {"RETRY_AFTER", response.get_header_value( - "X-RateLimit-Reset")}); - if (response.has_header("Retry-After")) - MessageBus::Broadcast( - "NWNX_EVENT_PUSH_EVENT_DATA", - {"RETRY_AFTER", - response.get_header_value( - "Retry-After")}); - else if (response.has_header("Retry-At")) - { - MessageBus::Broadcast( - "NWNX_EVENT_PUSH_EVENT_DATA", - {"RETRY_AFTER", - response.get_header_value( - "Retry-At")}); - } - } - // Slack rate limited - else if (response.has_header("Retry-After")) + "Retry-After")}); + else if (response.has_header("Retry-At")) { - float fSlackRetry = - stof(response.get_header_value( - "Retry-After")) * 1000.0f; MessageBus::Broadcast( "NWNX_EVENT_PUSH_EVENT_DATA", {"RETRY_AFTER", - std::to_string(fSlackRetry)}); - } - if (response.status != 429) - { - MessageBus::Broadcast( - "NWNX_EVENT_SIGNAL_EVENT", - {"NWNX_ON_HTTP_CLIENT_SUCCESS", - moduleOid}); - LOG_INFO( - "HTTP Client Request to '%s%s' succeeded.", - client_req.host, client_req.path); - } - else - { - MessageBus::Broadcast( - "NWNX_EVENT_SIGNAL_EVENT", - {"NWNX_ON_HTTP_CLIENT_FAILED", - moduleOid}); - LOG_WARNING( - "HTTP Client Request to '%s%s' failed, rate limited.", - client_req.host, client_req.path); + response.get_header_value( + "Retry-At")}); } + } + // Slack rate limited + else if (response.has_header("Retry-After")) + { + float fSlackRetry = + stof(response.get_header_value( + "Retry-After")) * 1000.0f; + MessageBus::Broadcast( + "NWNX_EVENT_PUSH_EVENT_DATA", + {"RETRY_AFTER", + std::to_string(fSlackRetry)}); + } + if (response.status != 429) + { + MessageBus::Broadcast( + "NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_SUCCESS", + moduleOid}); + LOG_INFO( + "HTTP Client Request to '%s%s' succeeded.", + client_req.host, client_req.path); } else { - MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", - {"NWNX_ON_HTTP_CLIENT_FAILED", - moduleOid}); + MessageBus::Broadcast( + "NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_FAILED", + moduleOid}); LOG_WARNING( - "HTTP Client Request to '%s%s' failed, status code '%d'.", - client_req.host, client_req.path, - response.status); + "HTTP Client Request to '%s%s' failed, rate limited.", + client_req.host, client_req.path); } - }); - }); - } + } + else + { + MessageBus::Broadcast("NWNX_EVENT_SIGNAL_EVENT", + {"NWNX_ON_HTTP_CLIENT_FAILED", + moduleOid}); + LOG_WARNING( + "HTTP Client Request to '%s%s' failed, status code '%d'.", + client_req.host, client_req.path, + response.status); + } + }); + }); +} - httplib::Headers ParseHeaderString(const std::string &headerStr) +httplib::Headers ParseHeaderString(const std::string &headerStr) +{ + httplib::Headers headers; + if (!headerStr.empty()) { - httplib::Headers headers; - if (!headerStr.empty()) + std::string::size_type key_pos = 0; + std::string::size_type key_end, val_pos, val_end; + while ((key_end = headerStr.find(':', key_pos)) != std::string::npos) { - std::string::size_type key_pos = 0; - std::string::size_type key_end, val_pos, val_end; - while ((key_end = headerStr.find(':', key_pos)) != std::string::npos) - { - if ((val_pos = headerStr.find_first_not_of(": ", key_end)) == std::string::npos) - break; + if ((val_pos = headerStr.find_first_not_of(": ", key_end)) == std::string::npos) + break; - val_end = headerStr.find('|', val_pos); - headers.emplace(headerStr.substr(key_pos, key_end - key_pos), - headerStr.substr(val_pos, val_end - val_pos)); + val_end = headerStr.find('|', val_pos); + headers.emplace(headerStr.substr(key_pos, key_end - key_pos), + headerStr.substr(val_pos, val_end - val_pos)); - key_pos = val_end; - if (key_pos != std::string::npos) - ++key_pos; - } + key_pos = val_end; + if (key_pos != std::string::npos) + ++key_pos; } - return headers; } + return headers; +} - NWNX_EXPORT ArgumentStack SendRequest(ArgumentStack &&args) - { - auto clientReq = Request(); - clientReq.id = m_clientRequestId++; - clientReq.tag = ScriptAPI::ExtractArgument(args); - clientReq.requestMethod = static_cast(ScriptAPI::ExtractArgument(args)); - clientReq.host = ScriptAPI::ExtractArgument(args); - clientReq.path = ScriptAPI::ExtractArgument(args); - clientReq.contentType = static_cast(ScriptAPI::ExtractArgument(args)); - clientReq.data = ScriptAPI::ExtractArgument(args); - clientReq.authType = static_cast(ScriptAPI::ExtractArgument(args)); - clientReq.authUserToken = ScriptAPI::ExtractArgument(args); - clientReq.authPassword = ScriptAPI::ExtractArgument(args); - clientReq.port = ScriptAPI::ExtractArgument(args); - if (!clientReq.port) clientReq.port = 443; - clientReq.headersString = ScriptAPI::ExtractArgument(args); - clientReq.headers = ParseHeaderString(clientReq.headersString); - m_clientRequests[clientReq.id] = clientReq; - PerformRequest(clientReq); +NWNX_EXPORT ArgumentStack SendRequest(ArgumentStack &&args) +{ + auto clientReq = Request(); + clientReq.id = m_clientRequestId++; + clientReq.tag = ScriptAPI::ExtractArgument(args); + clientReq.requestMethod = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.host = ScriptAPI::ExtractArgument(args); + clientReq.path = ScriptAPI::ExtractArgument(args); + clientReq.contentType = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.data = ScriptAPI::ExtractArgument(args); + clientReq.authType = static_cast(ScriptAPI::ExtractArgument(args)); + clientReq.authUserToken = ScriptAPI::ExtractArgument(args); + clientReq.authPassword = ScriptAPI::ExtractArgument(args); + clientReq.port = ScriptAPI::ExtractArgument(args); + if (!clientReq.port) clientReq.port = 443; + clientReq.headersString = ScriptAPI::ExtractArgument(args); + clientReq.headers = ParseHeaderString(clientReq.headersString); + m_clientRequests[clientReq.id] = clientReq; + PerformRequest(clientReq); - return ScriptAPI::Arguments(clientReq.id); - } + return ScriptAPI::Arguments(clientReq.id); +} - NWNX_EXPORT ArgumentStack GetRequest(ArgumentStack &&args) - { - ScriptAPI::ArgumentStack stack; - auto requestId = ScriptAPI::ExtractArgument(args); - auto req = m_clientRequests.find(requestId); - ASSERT_OR_THROW(req != std::end(m_clientRequests)); - auto clientReq = req->second; +NWNX_EXPORT ArgumentStack GetRequest(ArgumentStack &&args) +{ + ScriptAPI::ArgumentStack stack; + auto requestId = ScriptAPI::ExtractArgument(args); + auto req = m_clientRequests.find(requestId); + ASSERT_OR_THROW(req != std::end(m_clientRequests)); + auto clientReq = req->second; - ScriptAPI::InsertArgument(stack, clientReq.headersString); - ScriptAPI::InsertArgument(stack, (int32_t) clientReq.port); - ScriptAPI::InsertArgument(stack, clientReq.authPassword); - ScriptAPI::InsertArgument(stack, clientReq.authUserToken); - ScriptAPI::InsertArgument(stack, (int32_t) clientReq.authType); - ScriptAPI::InsertArgument(stack, clientReq.data); - ScriptAPI::InsertArgument(stack, (int32_t) clientReq.contentType); - ScriptAPI::InsertArgument(stack, clientReq.path); - ScriptAPI::InsertArgument(stack, clientReq.host); - ScriptAPI::InsertArgument(stack, (int32_t) clientReq.requestMethod); - ScriptAPI::InsertArgument(stack, clientReq.tag); - return stack; - } \ No newline at end of file + ScriptAPI::InsertArgument(stack, clientReq.headersString); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.port); + ScriptAPI::InsertArgument(stack, clientReq.authPassword); + ScriptAPI::InsertArgument(stack, clientReq.authUserToken); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.authType); + ScriptAPI::InsertArgument(stack, clientReq.data); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.contentType); + ScriptAPI::InsertArgument(stack, clientReq.path); + ScriptAPI::InsertArgument(stack, clientReq.host); + ScriptAPI::InsertArgument(stack, (int32_t) clientReq.requestMethod); + ScriptAPI::InsertArgument(stack, clientReq.tag); + return stack; +} From 36b2dcdce2b15dfb12c54486a5f9ebe3c05fb325 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 08:45:12 -0400 Subject: [PATCH 13/19] update nwscript and readme --- Plugins/HTTPClient/NWScript/nwnx_http.nss | 56 +++++++++++------------ Plugins/HTTPClient/README.md | 2 +- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/Plugins/HTTPClient/NWScript/nwnx_http.nss b/Plugins/HTTPClient/NWScript/nwnx_http.nss index 5d4ba4b9d1a..944e3c6d242 100644 --- a/Plugins/HTTPClient/NWScript/nwnx_http.nss +++ b/Plugins/HTTPClient/NWScript/nwnx_http.nss @@ -1,47 +1,47 @@ -/// @addtogroup http HTTP -/// @brief NWNX HTTP Server and Client +/// @addtogroup httpclient HTTPClient +/// @brief NWNX HTTP Client /// @{ -/// @file nwnx_http.nss +/// @file nwnx_httpclient.nss #include "nwnx" -const string NWNX_HTTP = "NWNX_HTTP"; ///< @private +const string NWNX_HTTPClient = "NWNX_HTTPClient"; ///< @private /// @name Request Types /// @anchor request_types /// /// @{ -const int NWNX_HTTP_REQUEST_METHOD_GET = 0; -const int NWNX_HTTP_REQUEST_METHOD_POST = 1; -const int NWNX_HTTP_REQUEST_METHOD_DELETE = 2; -const int NWNX_HTTP_REQUEST_METHOD_PATCH = 3; -const int NWNX_HTTP_REQUEST_METHOD_PUT = 4; -const int NWNX_HTTP_REQUEST_METHOD_OPTION = 5; -const int NWNX_HTTP_REQUEST_METHOD_HEAD = 6; +const int NWNX_HTTPCLIENT_REQUEST_METHOD_GET = 0; +const int NWNX_HTTPCLIENT_REQUEST_METHOD_POST = 1; +const int NWNX_HTTPCLIENT_REQUEST_METHOD_DELETE = 2; +const int NWNX_HTTPCLIENT_REQUEST_METHOD_PATCH = 3; +const int NWNX_HTTPCLIENT_REQUEST_METHOD_PUT = 4; +const int NWNX_HTTPCLIENT_REQUEST_METHOD_OPTION = 5; +const int NWNX_HTTPCLIENT_REQUEST_METHOD_HEAD = 6; ///@} /// @name Content Types /// @anchor content_types /// /// @{ -const int NWNX_HTTP_CONTENT_TYPE_HTML = 0; -const int NWNX_HTTP_CONTENT_TYPE_PLAINTEXT = 1; -const int NWNX_HTTP_CONTENT_TYPE_JSON = 2; -const int NWNX_HTTP_CONTENT_TYPE_FORM_URLENCODED = 3; -const int NWNX_HTTP_CONTENT_TYPE_XML = 4; +const int NWNX_HTTPCLIENT_CONTENT_TYPE_HTML = 0; +const int NWNX_HTTPCLIENT_CONTENT_TYPE_PLAINTEXT = 1; +const int NWNX_HTTPCLIENT_CONTENT_TYPE_JSON = 2; +const int NWNX_HTTPCLIENT_CONTENT_TYPE_FORM_URLENCODED = 3; +const int NWNX_HTTPCLIENT_CONTENT_TYPE_XML = 4; ///@} /// @name HTTP Authentication Types /// @anchor auth_types /// /// @{ -const int NWNX_HTTP_AUTH_TYPE_NONE = 0; -const int NWNX_HTTP_AUTH_TYPE_BASIC = 1; -const int NWNX_HTTP_AUTH_TYPE_DIGEST = 2; -const int NWNX_HTTP_AUTH_TYPE_BEARER_TOKEN = 3; +const int NWNX_HTTPCLIENT_AUTH_TYPE_NONE = 0; +const int NWNX_HTTPCLIENT_AUTH_TYPE_BASIC = 1; +const int NWNX_HTTPCLIENT_AUTH_TYPE_DIGEST = 2; +const int NWNX_HTTPCLIENT_AUTH_TYPE_BEARER_TOKEN = 3; ///@} /// A structure for an HTTP Client Request -struct NWNX_HTTP_Client_Request +struct NWNX_HTTPClient_Request { int nRequestMethod; ///< A @ref request_types "Request Type" string sTag; ///< A unique tag for this request @@ -59,18 +59,18 @@ struct NWNX_HTTP_Client_Request /// @brief Sends an http method to the given host. /// @param s The structured NWNX_HTTP_Client_Request information. /// @return A unique identifier for the request for later access in the REQUEST_ID event data. -int NWNX_HTTP_Client_SendRequest(struct NWNX_HTTP_Client_Request s); +int NWNX_HTTPClient_SendRequest(struct NWNX_HTTPClient_Request s); /// @brief Returns an NWNX_HTTP_Client_Request structure /// @param nRequestId The request id returned from NWNX_HTTP_Client_SendRequest() /// @return The structured NWNX_HTTP_Client_Request information -struct NWNX_HTTP_Client_Request NWNX_HTTP_Client_GetRequest(int nRequestId); +struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId); /// @} -int NWNX_HTTP_Client_SendRequest(struct NWNX_HTTP_Client_Request s) +int NWNX_HTTPClient_SendRequest(struct NWNX_HTTPClient_Request s) { - string sFunc = "Client_SendRequest"; + string sFunc = "SendRequest"; NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sHeaders); NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nPort); NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sAuthPassword); @@ -87,15 +87,15 @@ int NWNX_HTTP_Client_SendRequest(struct NWNX_HTTP_Client_Request s) return NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); } -struct NWNX_HTTP_Client_Request NWNX_HTTP_Client_GetRequest(int nRequestId) +struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId) { - string sFunc = "Client_GetRequest"; + string sFunc = "GetRequest"; NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nRequestId); NWNX_CallFunction(NWNX_HTTP, sFunc); - struct NWNX_HTTP_Client_Request s; + struct NWNX_HTTPClient_Request s; s.sTag = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); s.nRequestMethod = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); diff --git a/Plugins/HTTPClient/README.md b/Plugins/HTTPClient/README.md index 3d39869af91..e5f5a0d6d55 100644 --- a/Plugins/HTTPClient/README.md +++ b/Plugins/HTTPClient/README.md @@ -2,7 +2,7 @@ @ingroup httpclient ## Introduction -The HTTP Plugin provides access to a Client to perform requests and return responses. +The HTTPClient Plugin provides access to an HTTP Client to perform requests and return responses. ## Environment Variables From b79edd070d740de9f4c9bdbe41b2d385d0c2a454 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 08:47:26 -0400 Subject: [PATCH 14/19] more README fixes --- Plugins/HTTPClient/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Plugins/HTTPClient/README.md b/Plugins/HTTPClient/README.md index e5f5a0d6d55..209b96bb1db 100644 --- a/Plugins/HTTPClient/README.md +++ b/Plugins/HTTPClient/README.md @@ -50,22 +50,22 @@ Here is an example of posting an issue to a github repository. struct NWNX_HTTPClient_Request stGithubPost; - stGithubPost.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_POST; + stGithubPost.nRequestMethod = NWNX_HTTPCLIENT_REQUEST_METHOD_POST; stGithubPost.sHost = "api.github.com"; stGithubPost.sPath = NWNX_Util_GetEnvironmentVariable("GITHUB_REPO_PATH") + "/issues"; stGithubPost.sData = JsonDump(githubJSON); - stGithubPost.nAuthType = NWNX_HTTP_AUTH_TYPE_BASIC; + stGithubPost.nAuthType = NWNX_HTTPCLIENT_AUTH_TYPE_BASIC; stGithubPost.sAuthUserOrToken = NWNX_Util_GetEnvironmentVariable("GITHUB_USERNAME"); stGithubPost.sAuthPassword = NWNX_Util_GetEnvironmentVariable("GITHUB_NWN_PAT"); stGithubPost.sHeaders = "Accept: application/vnd.github.v3+json"; - stGithubPost.nContentType = NWNX_HTTP_CONTENT_TYPE_JSON; + stGithubPost.nContentType = NWNX_HTTPCLIENT_CONTENT_TYPE_JSON; NWNX_HTTPClient_SendRequest(stGithubPost); ``` Here's an example of insulting a PC when they enter an area ```c struct NWNX_HTTPClient_Request stInsultGen; - stInsultGen.nRequestMethod = NWNX_HTTP_REQUEST_METHOD_GET; + stInsultGen.nRequestMethod = NWNX_HTTPCLIENT_REQUEST_METHOD_GET; stInsultGen.sHost = "evilinsult.com"; stInsultGen.sPath = "/generate_insult.php"; stInsultGen.oObject = GetEnteringObject(); From 311a89f7bef8d5ee402565cee1ec00d461aff912 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 08:53:37 -0400 Subject: [PATCH 15/19] rename nwscript file --- .../HTTPClient/NWScript/{nwnx_http.nss => nwnx_httpclient.nss} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Plugins/HTTPClient/NWScript/{nwnx_http.nss => nwnx_httpclient.nss} (100%) diff --git a/Plugins/HTTPClient/NWScript/nwnx_http.nss b/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss similarity index 100% rename from Plugins/HTTPClient/NWScript/nwnx_http.nss rename to Plugins/HTTPClient/NWScript/nwnx_httpclient.nss From 872a66e53bad8c4ab052d25b21892175973d430d Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 08:56:27 -0400 Subject: [PATCH 16/19] Update CHANGELOG --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b9ded4bb53..4a6e0974809 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ https://github.com/nwnxee/unified/compare/build8193.36.12...HEAD ##### New Plugins - Store: Enables getting and setting store data. -- HTTP: Client functionality. +- HTTPClient: Perform HTTP Action like POST and GET and return responses. ##### New NWScript Functions - Util: GetModuleTlkFile() From 4b82c1a5175c3df428e588bd740ff1bb42ae14b2 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 09:39:05 -0400 Subject: [PATCH 17/19] update nwscript to latest changes --- .../HTTPClient/NWScript/nwnx_httpclient.nss | 54 +++++++++---------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss b/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss index 944e3c6d242..b52a3f92e42 100644 --- a/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss +++ b/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss @@ -71,20 +71,20 @@ struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId); int NWNX_HTTPClient_SendRequest(struct NWNX_HTTPClient_Request s) { string sFunc = "SendRequest"; - NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sHeaders); - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nPort); - NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sAuthPassword); - NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sAuthUserOrToken); - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nAuthType); - NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sData); - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nContentType); - NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sPath); - NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sHost); - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, s.nRequestMethod); - NWNX_PushArgumentString(NWNX_HTTP, sFunc, s.sTag); - NWNX_CallFunction(NWNX_HTTP, sFunc); - - return NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); + NWNX_PushArgumentString(s.sHeaders); + NWNX_PushArgumentInt(s.nPort); + NWNX_PushArgumentString(s.sAuthPassword); + NWNX_PushArgumentString(s.sAuthUserOrToken); + NWNX_PushArgumentInt(s.nAuthType); + NWNX_PushArgumentString(s.sData); + NWNX_PushArgumentInt(s.nContentType); + NWNX_PushArgumentString(s.sPath); + NWNX_PushArgumentString(s.sHost); + NWNX_PushArgumentInt(s.nRequestMethod); + NWNX_PushArgumentString(s.sTag); + NWNX_CallFunction(NWNX_HTTPClient, sFunc); + + return NWNX_GetReturnValueInt(); } struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId) @@ -92,22 +92,22 @@ struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId) string sFunc = "GetRequest"; - NWNX_PushArgumentInt(NWNX_HTTP, sFunc, nRequestId); - NWNX_CallFunction(NWNX_HTTP, sFunc); + NWNX_PushArgumentInt(nRequestId); + NWNX_CallFunction(NWNX_HTTPClient, sFunc); struct NWNX_HTTPClient_Request s; - s.sTag = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); - s.nRequestMethod = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); - s.sHost = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); - s.sPath = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); - s.nContentType = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); - s.sData = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); - s.nAuthType = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); - s.sAuthUserOrToken = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); - s.sAuthPassword = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); - s.nPort = NWNX_GetReturnValueInt(NWNX_HTTP, sFunc); - s.sHeaders = NWNX_GetReturnValueString(NWNX_HTTP, sFunc); + s.sTag = NWNX_GetReturnValueString(); + s.nRequestMethod = NWNX_GetReturnValueInt(); + s.sHost = NWNX_GetReturnValueString(); + s.sPath = NWNX_GetReturnValueString(); + s.nContentType = NWNX_GetReturnValueInt(); + s.sData = NWNX_GetReturnValueString(); + s.nAuthType = NWNX_GetReturnValueInt(); + s.sAuthUserOrToken = NWNX_GetReturnValueString(); + s.sAuthPassword = NWNX_GetReturnValueString(); + s.nPort = NWNX_GetReturnValueInt(); + s.sHeaders = NWNX_GetReturnValueString(); return s; } From 39b91a29269bc4189eb0895cb90ed978a97f3ed5 Mon Sep 17 00:00:00 2001 From: plenarius Date: Thu, 15 Aug 2024 13:34:42 -0400 Subject: [PATCH 18/19] update nwscript, default to no cert validation to test --- Plugins/HTTPClient/External/httplib.h | 8 +++----- Plugins/HTTPClient/NWScript/nwnx_httpclient.nss | 8 ++++---- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/Plugins/HTTPClient/External/httplib.h b/Plugins/HTTPClient/External/httplib.h index 57951acca32..63fd9b098ef 100644 --- a/Plugins/HTTPClient/External/httplib.h +++ b/Plugins/HTTPClient/External/httplib.h @@ -269,10 +269,8 @@ using socket_t = int; #include #include -#if defined(OPENSSL_IS_BORINGSSL) -#if OPENSSL_VERSION_NUMBER < 0x1010107f -#error Please use OpenSSL or a current version of BoringSSL -#endif +#if OPENSSL_VERSION_NUMBER < 0x1010100fL +#error Sorry, OpenSSL versions prior to 1.1.1 are not supported #elif OPENSSL_VERSION_NUMBER < 0x30000000L #define SSL_get1_peer_certificate SSL_get_peer_certificate #endif @@ -1478,7 +1476,7 @@ class ClientImpl { #endif #ifdef CPPHTTPLIB_OPENSSL_SUPPORT - bool server_certificate_verification_ = true; + bool server_certificate_verification_ = false; #endif Logger logger_; diff --git a/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss b/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss index b52a3f92e42..ea10d20a0e5 100644 --- a/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss +++ b/Plugins/HTTPClient/NWScript/nwnx_httpclient.nss @@ -1,5 +1,5 @@ /// @addtogroup httpclient HTTPClient -/// @brief NWNX HTTP Client +/// @brief NWNX HTTPClient /// @{ /// @file nwnx_httpclient.nss #include "nwnx" @@ -57,13 +57,13 @@ struct NWNX_HTTPClient_Request }; /// @brief Sends an http method to the given host. -/// @param s The structured NWNX_HTTP_Client_Request information. +/// @param s The structured NWNX_HTTPClient_Request information. /// @return A unique identifier for the request for later access in the REQUEST_ID event data. int NWNX_HTTPClient_SendRequest(struct NWNX_HTTPClient_Request s); /// @brief Returns an NWNX_HTTP_Client_Request structure -/// @param nRequestId The request id returned from NWNX_HTTP_Client_SendRequest() -/// @return The structured NWNX_HTTP_Client_Request information +/// @param nRequestId The request id returned from NWNX_HTTPClient_SendRequest() +/// @return The structured NWNX_HTTPClient_Request information struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId); /// @} From 5b4fb65810bc58b30f317bfb1d1c8e65f2c791db Mon Sep 17 00:00:00 2001 From: plenarius Date: Fri, 16 Aug 2024 17:00:59 -0400 Subject: [PATCH 19/19] chore: follow naming convention and remove unneeded inline --- Plugins/HTTPClient/HTTPClient.cpp | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/Plugins/HTTPClient/HTTPClient.cpp b/Plugins/HTTPClient/HTTPClient.cpp index 3a541ac7380..d1bf9faa868 100644 --- a/Plugins/HTTPClient/HTTPClient.cpp +++ b/Plugins/HTTPClient/HTTPClient.cpp @@ -75,16 +75,16 @@ using namespace NWNXLib::API; static std::unique_ptr GetResult(const Request&); static httplib::Headers ParseHeaderString(const std::string&); -static inline int m_clientRequestId = 0; -static inline int m_clientTimeout = Config::Get("CLIENT_REQUEST_TIMEOUT", 2000); -static inline std::unordered_map> m_clientHostCache; -static inline std::unordered_map m_clientRequests; +static int s_clientRequestId = 0; +static int s_clientTimeout = Config::Get("CLIENT_REQUEST_TIMEOUT", 2000); +static std::unordered_map> s_clientHostCache; +static std::unordered_map s_clientRequests; std::unique_ptr GetResult(const Request &client_req) { std::unique_ptr result; - auto cli = m_clientHostCache[client_req.host].get(); + auto cli = s_clientHostCache[client_req.host].get(); switch (client_req.requestMethod) { case RequestMethod::GET: @@ -123,11 +123,11 @@ std::unique_ptr GetResult(const Request &client_req) void PerformRequest(const Request &client_req) { - auto cli = m_clientHostCache.find(client_req.host); - if (cli == std::end(m_clientHostCache)) + auto cli = s_clientHostCache.find(client_req.host); + if (cli == std::end(s_clientHostCache)) { LOG_DEBUG("Creating new SSL client for host %s.", client_req.host); - cli = m_clientHostCache.insert(std::make_pair(client_req.host, + cli = s_clientHostCache.insert(std::make_pair(client_req.host, std::make_unique(client_req.host.c_str(), client_req.port))).first; } @@ -155,7 +155,7 @@ void PerformRequest(const Request &client_req) } Tasks::QueueOnAsyncThread([cli, client_req]() { - cli->second->set_connection_timeout(0, m_clientTimeout * 1000); + cli->second->set_connection_timeout(0, s_clientTimeout * 1000); auto result = GetResult(client_req); if (result == nullptr || result->error() != httplib::Error::Success) @@ -310,7 +310,7 @@ httplib::Headers ParseHeaderString(const std::string &headerStr) NWNX_EXPORT ArgumentStack SendRequest(ArgumentStack &&args) { auto clientReq = Request(); - clientReq.id = m_clientRequestId++; + clientReq.id = s_clientRequestId++; clientReq.tag = ScriptAPI::ExtractArgument(args); clientReq.requestMethod = static_cast(ScriptAPI::ExtractArgument(args)); clientReq.host = ScriptAPI::ExtractArgument(args); @@ -324,7 +324,7 @@ NWNX_EXPORT ArgumentStack SendRequest(ArgumentStack &&args) if (!clientReq.port) clientReq.port = 443; clientReq.headersString = ScriptAPI::ExtractArgument(args); clientReq.headers = ParseHeaderString(clientReq.headersString); - m_clientRequests[clientReq.id] = clientReq; + s_clientRequests[clientReq.id] = clientReq; PerformRequest(clientReq); return ScriptAPI::Arguments(clientReq.id); @@ -334,8 +334,8 @@ NWNX_EXPORT ArgumentStack GetRequest(ArgumentStack &&args) { ScriptAPI::ArgumentStack stack; auto requestId = ScriptAPI::ExtractArgument(args); - auto req = m_clientRequests.find(requestId); - ASSERT_OR_THROW(req != std::end(m_clientRequests)); + auto req = s_clientRequests.find(requestId); + ASSERT_OR_THROW(req != std::end(s_clientRequests)); auto clientReq = req->second; ScriptAPI::InsertArgument(stack, clientReq.headersString);