12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904 |
- //
- // httplib.h
- //
- // Copyright (c) 2022 Yuji Hirose. All rights reserved.
- // MIT License
- //
- #ifndef CPPHTTPLIB_HTTPLIB_H
- #define CPPHTTPLIB_HTTPLIB_H
- #define CPPHTTPLIB_VERSION "0.11.1"
- /*
- * 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_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<size_t>::max)())
- #endif
- #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
- #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
- #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
- #ifndef CPPHTTPLIB_LISTEN_BACKLOG
- #define CPPHTTPLIB_LISTEN_BACKLOG 5
- #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)
- #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 = long;
- #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 <io.h>
- #include <winsock2.h>
- #include <ws2tcpip.h>
- #ifndef WSA_FLAG_NO_HANDLE_INHERIT
- #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
- #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 <arpa/inet.h>
- #include <ifaddrs.h>
- #include <net/if.h>
- #include <netdb.h>
- #include <netinet/in.h>
- #ifdef __linux__
- #include <resolv.h>
- #endif
- #include <netinet/tcp.h>
- #ifdef CPPHTTPLIB_USE_POLL
- #include <poll.h>
- #endif
- #include <csignal>
- #include <pthread.h>
- #include <sys/select.h>
- #include <sys/socket.h>
- #include <sys/un.h>
- #include <unistd.h>
- using socket_t = int;
- #ifndef INVALID_SOCKET
- #define INVALID_SOCKET (-1)
- #endif
- #endif //_WIN32
- #include <algorithm>
- #include <array>
- #include <atomic>
- #include <cassert>
- #include <cctype>
- #include <climits>
- #include <condition_variable>
- #include <cstring>
- #include <errno.h>
- #include <fcntl.h>
- #include <fstream>
- #include <functional>
- #include <iomanip>
- #include <iostream>
- #include <list>
- #include <map>
- #include <memory>
- #include <mutex>
- #include <random>
- #include <regex>
- #include <set>
- #include <sstream>
- #include <string>
- #include <sys/stat.h>
- #include <thread>
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- #ifdef _WIN32
- #include <wincrypt.h>
- // 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")
- #pragma comment(lib, "cryptui.lib")
- #endif
- #endif //_WIN32
- #include <openssl/err.h>
- #include <openssl/evp.h>
- #include <openssl/ssl.h>
- #include <openssl/x509v3.h>
- #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
- #include <openssl/applink.c>
- #endif
- #include <iostream>
- #include <sstream>
- #if OPENSSL_VERSION_NUMBER < 0x1010100fL
- #error Sorry, OpenSSL versions prior to 1.1.1 are not supported
- #endif
- #if OPENSSL_VERSION_NUMBER < 0x10100000L
- #include <openssl/crypto.h>
- 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 <zlib.h>
- #endif
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- #include <brotli/decode.h>
- #include <brotli/encode.h>
- #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 <class T, class... Args>
- typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
- make_unique(Args &&...args) {
- return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
- }
- template <class T>
- typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
- make_unique(std::size_t n) {
- typedef typename std::remove_extent<T>::type RT;
- return std::unique_ptr<T>(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<std::string, std::string, detail::ci>;
- using Params = std::multimap<std::string, std::string>;
- using Match = std::smatch;
- using Progress = std::function<bool(uint64_t current, uint64_t total)>;
- struct Response;
- using ResponseHandler = std::function<bool(const Response &response)>;
- struct MultipartFormData {
- std::string name;
- std::string content;
- std::string filename;
- std::string content_type;
- };
- using MultipartFormDataItems = std::vector<MultipartFormData>;
- using MultipartFormDataMap = std::multimap<std::string, MultipartFormData>;
- 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<bool(const char *data, size_t data_len)> write;
- std::function<void()> done;
- std::function<bool()> 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<size_t>(n));
- return n;
- }
- private:
- DataSink &sink_;
- };
- data_sink_streambuf sb_;
- };
- using ContentProvider =
- std::function<bool(size_t offset, size_t length, DataSink &sink)>;
- using ContentProviderWithoutLength =
- std::function<bool(size_t offset, DataSink &sink)>;
- using ContentProviderResourceReleaser = std::function<void(bool success)>;
- using ContentReceiverWithProgress =
- std::function<bool(const char *data, size_t data_length, uint64_t offset,
- uint64_t total_length)>;
- using ContentReceiver =
- std::function<bool(const char *data, size_t data_length)>;
- using MultipartContentHeader =
- std::function<bool(const MultipartFormData &file)>;
- class ContentReader {
- public:
- using Reader = std::function<bool(ContentReceiver receiver)>;
- using MultipartReader = std::function<bool(MultipartContentHeader header,
- ContentReceiver receiver)>;
- 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<ssize_t, ssize_t>;
- using Ranges = std::vector<Range>;
- 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
- ResponseHandler response_handler;
- ContentReceiverWithProgress content_receiver;
- Progress progress;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- const SSL *ssl = nullptr;
- #endif
- bool has_header(const std::string &key) const;
- std::string get_header_value(const std::string &key, size_t id = 0) const;
- template <typename T>
- T get_header_value(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 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 std::string &key) const;
- MultipartFormData get_file_value(const std::string &key) const;
- // private members...
- size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
- size_t content_length_ = 0;
- ContentProvider content_provider_;
- bool is_chunked_content_provider_ = false;
- 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 std::string &key) const;
- std::string get_header_value(const std::string &key, size_t id = 0) const;
- template <typename T>
- T get_header_value(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 std::string &url, int status = 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_provider(
- size_t length, const std::string &content_type, ContentProvider provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_chunked_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser 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_(content_provider_success_);
- }
- }
- // private members...
- size_t content_length_ = 0;
- ContentProvider content_provider_;
- ContentProviderResourceReleaser content_provider_resource_releaser_;
- bool is_chunked_content_provider_ = false;
- bool content_provider_success_ = 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 <typename... Args>
- 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<void()> 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<void()> fn) override {
- std::unique_lock<std::mutex> lock(mutex_);
- jobs_.push_back(std::move(fn));
- cond_.notify_one();
- }
- void shutdown() override {
- // Stop all worker threads...
- {
- std::unique_lock<std::mutex> 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<void()> fn;
- {
- std::unique_lock<std::mutex> 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<bool>(fn));
- fn();
- }
- }
- ThreadPool &pool_;
- };
- friend struct worker;
- std::vector<std::thread> threads_;
- std::list<std::function<void()>> jobs_;
- bool shutdown_;
- std::condition_variable cond_;
- std::mutex mutex_;
- };
- using Logger = std::function<void(const Request &, const Response &)>;
- using SocketOptions = std::function<void(socket_t sock)>;
- void default_socket_options(socket_t sock);
- class Server {
- public:
- using Handler = std::function<void(const Request &, Response &)>;
- using ExceptionHandler =
- std::function<void(const Request &, Response &, std::exception_ptr ep)>;
- enum class HandlerResponse {
- Handled,
- Unhandled,
- };
- using HandlerWithResponse =
- std::function<HandlerResponse(const Request &, Response &)>;
- using HandlerWithContentReader = std::function<void(
- const Request &, Response &, const ContentReader &content_reader)>;
- using Expect100ContinueHandler =
- std::function<int(const Request &, Response &)>;
- Server();
- virtual ~Server();
- virtual bool is_valid() const;
- 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 std::string &mount_point);
- Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
- const std::string &mime);
- Server &set_file_request_handler(Handler handler);
- Server &set_error_handler(HandlerWithResponse handler);
- Server &set_error_handler(Handler handler);
- Server &set_exception_handler(ExceptionHandler handler);
- Server &set_pre_routing_handler(HandlerWithResponse handler);
- Server &set_post_routing_handler(Handler handler);
- 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_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 <class Rep, class Period>
- Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- Server &set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- Server &set_idle_interval(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_idle_interval(const std::chrono::duration<Rep, Period> &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 std::string &host, int port, int socket_flags = 0);
- bool is_running() const;
- void stop();
- std::function<TaskQueue *(void)> new_task_queue;
- protected:
- bool process_request(Stream &strm, bool close_connection,
- bool &connection_closed,
- const std::function<void(Request &)> &setup_request);
- std::atomic<socket_t> 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<std::pair<std::regex, Handler>>;
- using HandlersForContentReader =
- std::vector<std::pair<std::regex, HandlerWithContentReader>>;
- socket_t create_server_socket(const std::string &host, int port,
- int socket_flags,
- SocketOptions socket_options) const;
- 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(const 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<MountPointEntry> base_dirs_;
- std::atomic<bool> is_running_;
- std::map<std::string, std::string> 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_;
- HandlerWithResponse error_handler_;
- ExceptionHandler exception_handler_;
- HandlerWithResponse pre_routing_handler_;
- Handler post_routing_handler_;
- Logger logger_;
- Expect100ContinueHandler expect_100_continue_handler_;
- int address_family_ = AF_UNSPEC;
- bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
- SocketOptions socket_options_ = default_socket_options;
- Headers default_headers_;
- };
- enum class Error {
- Success = 0,
- Unknown,
- Connection,
- BindIPAddress,
- Read,
- Write,
- ExceedRedirectCount,
- Canceled,
- SSLConnection,
- SSLLoadingCerts,
- SSLServerVerification,
- UnsupportedMultipartBoundaryChars,
- Compression,
- ConnectionTimeout,
- };
- std::string to_string(const Error error);
- std::ostream &operator<<(std::ostream &os, const Error &obj);
- class Result {
- public:
- Result(std::unique_ptr<Response> &&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; }
- 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 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;
- template <typename T>
- T get_request_header_value(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<Response> res_;
- Error err_;
- Headers request_headers_;
- };
- 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 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 std::string &path, ContentReceiver content_receiver,
- Progress progress);
- Result Get(const std::string &path, const Headers &headers,
- ContentReceiver content_receiver, Progress progress);
- Result Get(const std::string &path, ResponseHandler response_handler,
- ContentReceiver content_receiver);
- Result Get(const std::string &path, const Headers &headers,
- ResponseHandler response_handler,
- ContentReceiver content_receiver);
- Result Get(const std::string &path, ResponseHandler response_handler,
- ContentReceiver content_receiver, Progress progress);
- Result Get(const std::string &path, const Headers &headers,
- ResponseHandler response_handler, ContentReceiver content_receiver,
- Progress progress);
- 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 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 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);
- 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 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 MultipartFormDataItems &items);
- Result Post(const std::string &path, const Headers &headers,
- const MultipartFormDataItems &items);
- Result Post(const std::string &path, const Headers &headers,
- const MultipartFormDataItems &items, const std::string &boundary);
- 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 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);
- 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 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 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 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 Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type);
- Result Patch(const std::string &path, 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);
- 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 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 Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type);
- Result Delete(const std::string &path, 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);
- 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);
- size_t is_socket_open() const;
- socket_t socket() const;
- void stop();
- void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
- void set_default_headers(Headers headers);
- 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 <class Rep, class Period>
- void
- set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- 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 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 std::string &intf);
- 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 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);
- #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; }
- };
- Result send_(Request &&req);
- 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);
- 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);
- 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;
- // Hostname-IP map
- std::map<std::string, std::string> addr_map_;
- // 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 url_encode_ = true;
- int address_family_ = AF_UNSPEC;
- 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
- 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:
- socket_t create_client_socket(Error &error) const;
- bool read_response_line(Stream &strm, const Request &req, Response &res);
- bool write_request(Stream &strm, Request &req, bool close_connection,
- Error &error);
- 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<Response> send_with_content_provider(
- Request &req, const char *body, size_t content_length,
- ContentProvider content_provider,
- ContentProviderWithoutLength content_provider_without_length,
- const std::string &content_type, Error &error);
- Result send_with_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 std::string &content_type);
- std::string adjust_host_string(const std::string &host) const;
- virtual bool process_socket(const Socket &socket,
- std::function<bool(Stream &strm)> callback);
- virtual bool is_ssl() const;
- };
- class Client {
- public:
- // Universal interface
- explicit Client(const std::string &scheme_host_port);
- explicit Client(const std::string &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(Client &&) = default;
- ~Client();
- bool is_valid() const;
- 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 std::string &path, ContentReceiver content_receiver,
- Progress progress);
- Result Get(const std::string &path, const Headers &headers,
- ContentReceiver content_receiver, Progress progress);
- Result Get(const std::string &path, ResponseHandler response_handler,
- ContentReceiver content_receiver);
- Result Get(const std::string &path, const Headers &headers,
- ResponseHandler response_handler,
- ContentReceiver content_receiver);
- Result Get(const std::string &path, const Headers &headers,
- ResponseHandler response_handler, ContentReceiver content_receiver,
- Progress progress);
- Result Get(const std::string &path, ResponseHandler response_handler,
- ContentReceiver content_receiver, Progress progress);
- 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 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 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);
- 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 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 MultipartFormDataItems &items);
- Result Post(const std::string &path, const Headers &headers,
- const MultipartFormDataItems &items);
- Result Post(const std::string &path, const Headers &headers,
- const MultipartFormDataItems &items, const std::string &boundary);
- 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 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);
- 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 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 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 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 Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type);
- Result Patch(const std::string &path, 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);
- 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 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 Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type);
- Result Delete(const std::string &path, 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);
- 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);
- size_t is_socket_open() const;
- socket_t socket() const;
- void stop();
- void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
- void set_default_headers(Headers headers);
- 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 <class Rep, class Period>
- void
- set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- 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 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 std::string &intf);
- 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 std::string &username,
- const std::string &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 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);
- long get_openssl_verify_result() const;
- SSL_CTX *ssl_context() const;
- #endif
- private:
- std::unique_ptr<ClientImpl> 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,
- const char *private_key_password = nullptr);
- SSLServer(X509 *cert, EVP_PKEY *private_key,
- X509_STORE *client_ca_cert_store = nullptr);
- SSLServer(
- const std::function<bool(SSL_CTX &ssl_ctx)> &setup_ssl_ctx_callback);
- ~SSLServer() override;
- bool is_valid() const override;
- SSL_CTX *ssl_context() const;
- 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_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;
- void shutdown_ssl_impl(Socket &socket, bool shutdown_socket);
- bool process_socket(const Socket &socket,
- std::function<bool(Stream &strm)> 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<std::string> host_components_;
- long verify_result_ = 0;
- friend class ClientImpl;
- };
- #endif
- /*
- * Implementation of template methods.
- */
- namespace detail {
- template <typename T, typename U>
- inline void duration_to_sec_and_usec(const T &duration, U callback) {
- auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
- auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
- duration - std::chrono::seconds(sec))
- .count();
- callback(sec, usec);
- }
- template <typename T>
- inline T get_header_value(const Headers & /*headers*/,
- const std::string & /*key*/, size_t /*id*/ = 0,
- uint64_t /*def*/ = 0) {}
- template <>
- inline uint64_t get_header_value<uint64_t>(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<ssize_t>(id));
- if (it != rng.second) {
- return std::strtoull(it->second.data(), nullptr, 10);
- }
- return def;
- }
- } // namespace detail
- template <typename T>
- inline T Request::get_header_value(const std::string &key, size_t id) const {
- return detail::get_header_value<T>(headers, key, id, 0);
- }
- template <typename T>
- inline T Response::get_header_value(const std::string &key, size_t id) const {
- return detail::get_header_value<T>(headers, key, id, 0);
- }
- template <typename... Args>
- inline ssize_t Stream::write_format(const char *fmt, const Args &...args) {
- const auto bufsiz = 2048;
- std::array<char, bufsiz> buf{};
- auto sn = snprintf(buf.data(), buf.size() - 1, fmt, args...);
- if (sn <= 0) { return sn; }
- auto n = static_cast<size_t>(sn);
- if (n >= buf.size() - 1) {
- std::vector<char> glowable_buf(buf.size());
- while (n >= glowable_buf.size() - 1) {
- glowable_buf.resize(glowable_buf.size() * 2);
- n = static_cast<size_t>(
- 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<char *>(&yes),
- sizeof(yes));
- setsockopt(sock, SOL_SOCKET, SO_EXCLUSIVEADDRUSE,
- reinterpret_cast<char *>(&yes), sizeof(yes));
- #else
- #ifdef SO_REUSEPORT
- setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, reinterpret_cast<void *>(&yes),
- sizeof(yes));
- #else
- setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast<void *>(&yes),
- sizeof(yes));
- #endif
- #endif
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
- return *this;
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
- return *this;
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_idle_interval(const std::chrono::duration<Rep, Period> &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";
- case Error::Connection: return "Connection";
- case Error::BindIPAddress: return "BindIPAddress";
- case Error::Read: return "Read";
- case Error::Write: return "Write";
- case Error::ExceedRedirectCount: return "ExceedRedirectCount";
- case Error::Canceled: return "Canceled";
- case Error::SSLConnection: return "SSLConnection";
- case Error::SSLLoadingCerts: return "SSLLoadingCerts";
- case Error::SSLServerVerification: return "SSLServerVerification";
- case Error::UnsupportedMultipartBoundaryChars:
- return "UnsupportedMultipartBoundaryChars";
- case Error::Compression: return "Compression";
- case Error::ConnectionTimeout: return "ConnectionTimeout";
- 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<std::underlying_type<Error>::type>(obj) << ')';
- return os;
- }
- template <typename T>
- inline T Result::get_request_header_value(const std::string &key,
- size_t id) const {
- return detail::get_header_value<T>(request_headers_, key, id, 0);
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_connection_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
- set_connection_timeout(sec, usec);
- });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_read_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_write_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void Client::set_connection_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_connection_timeout(duration);
- }
- template <class Rep, class Period>
- inline void
- Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_read_timeout(duration);
- }
- template <class Rep, class Period>
- inline void
- Client::set_write_timeout(const std::chrono::duration<Rep, Period> &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<std::string> &addrs);
- std::string append_query_params(const std::string &path, const Params ¶ms);
- std::pair<std::string, std::string> make_range_header(Ranges ranges);
- std::pair<std::string, std::string>
- 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 split(const char *b, const char *e, char d,
- std::function<void(const char *, const char *)> 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<bool(Stream &)> 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 std::string &s, Params ¶ms);
- 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 : 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;
- };
- class compressor {
- public:
- virtual ~compressor() = default;
- typedef std::function<bool(const char *data, size_t data_len)> 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<bool(const char *data, size_t data_len)> Callback;
- virtual bool decompress(const char *data, size_t data_length,
- Callback callback) = 0;
- };
- class nocompressor : public compressor {
- public:
- virtual ~nocompressor() = default;
- bool compress(const char *data, size_t data_length, bool /*last*/,
- Callback callback) override;
- };
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- class gzip_compressor : public compressor {
- public:
- gzip_compressor();
- ~gzip_compressor();
- 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 : public decompressor {
- public:
- gzip_decompressor();
- ~gzip_decompressor();
- 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 : 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 : 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_;
- };
- } // namespace detail
- } // namespace httplib
- #endif // CPPHTTPLIB_HTTPLIB_H
|