HttpRequest Class Reference

Forward declaration for potential routing needs. More...

#include <HttpRequest.h>

Collaboration diagram for HttpRequest:

Public Member Functions
	HttpRequest (const char *rawHeaders, const std::string &reqMethod, const std::string &reqPath)
	Construct a HttpRequest from raw headers, method, and path.
	HttpRequest (const std::string &raw, const std::string &method, const std::string &path)
	HttpRequest (Tcp *connection, const std::string rawHeaders, const std::string &method, const std::string &path)
	HttpRequest ()=default
	HttpRequest (const HttpRequest &)=default
HttpRequest &	setRootCACertificate (const std::string &certData)
	Set the root CA certificate to use for TLS.
HttpResponse	send ()
	Send the request and return the response.
HttpResponse	get ()
	Send a GETPOST/PUT/DEL request.
HttpResponse	get (const std::string &url)
HttpResponse	post ()
HttpResponse	post (const std::string &url, const std::string &body)
HttpResponse	put ()
HttpResponse	put (const std::string &url, const std::string &body)
HttpResponse	del ()
HttpResponse	del (const std::string &url)
std::string	getHeader (const std::string &field) const
	Get a specific header field (case-insensitive).
const std::map< std::string, std::string > &	getHeaders () const
	Get all request headers.
void	printHeaders () const
	Print all headers to the standard output.
void	setHeaderEnd (size_t end)
	Set the position marking the end of headers.
size_t	getHeaderEnd ()
	Get the header end offset (used for body parsing).
const std::string &	getHost () const
	Get the Host header value.
const std::string &	getProtocol () const
bool	isFormUrlEncoded () const
	Check if content-type is application/x-www-form-urlencoded.
bool	isJson () const
	Check if content-type is application/json.
const std::string	getContentType () const
	Get the raw Content-Type string.
const std::string	getBoundary () const
	Get the boundary string (for multipart/form-data).
bool	isMultipart () const
	Check whether the request is multipart/form-data.
const std::string &	getBody () const
	Get the request body (copy).
bool	isBodyTruncated () const
	Check if the request body was truncated due to memory limits.
void	markBodyTruncated ()
HttpRequest &	setBody (const std::string &body)
	Set the body of the request.
HttpRequest &	setJson (const nlohmann::json &json)
	Set the body of the request as JSON.
HttpRequest &	setJson (const std::string &json)
	Set the body of the request as JSON.
int	getContentLength () const
	Get the Content-Length header as integer.
nlohmann::json	json () const
	Safely parse the request body as JSON (non-throwing).
HttpRequest &	setMethod (const std::string &method)
	Set the HTTP method (e.g., GET, POST).
HttpRequest &	setPath (const std::string &path)
	Set the request path.
const std::string &	getMethod () const
	Get the HTTP method.
const std::string &	getPath () const
	Get the parsed request path (without query string).
const std::string &	getUri () const
	Get the original URL from the request line.
const std::string &	getQuery () const
	Get the parsed query string from the URL.
Tcp *	getTcp () const
const std::unordered_map< std::string, std::string >	getCookies () const
	Get all parsed cookies.
const std::string	getCookie (const std::string &name) const
	Get a specific cookie value.
const std::unordered_multimap< std::string, std::string >	getQueryParams ()
	Get parsed query string parameters.
const std::unordered_multimap< std::string, std::string >	getFormParams ()
	Get parsed form fields (application/x-www-form-urlencoded).
bool	appendRemainingBody (int expectedLength)
int	handle_multipart (HttpResponse &res)
	Handle multipart/form-data uploads.
HttpRequest &	setUri (const std::string &uri)
	Set the URI for the request.
HttpRequest &	setHost (const std::string &host)
HttpRequest &	setProtocol (const std::string &protocol)
HttpRequest &	setHeaders (const std::map< std::string, std::string > &headers)
HttpRequest &	setHeader (const std::string &key, const std::string &value)
HttpRequest &	setUserAgent (const std::string &userAgent)
HttpRequest &	setAcceptEncoding (const std::string &encoding)
HttpRequest &	toFile (const std::string &path)
std::string	getOutputFilePath () const
bool	wantsToFile () const
const std::string &	getRootCACertificate () const
	Get the root CA certificate string, if set.

Static Public Member Functions
static HttpRequest	receive (Tcp *tcp)
	Receive and parse an HTTP request from a socket.
static std::optional< std::pair< std::string, std::string > >	receiveUntilHeadersComplete (Tcp *conn)
static bool	getMethodAndPath (const std::string &data, std::string &method, std::string &path)
	Parse the HTTP method and path from the first request line.
static HttpRequest	create ()

Private Member Functions
void	parseHeaders (const char *raw)
void	appendToBody (const char *data, size_t len)
void	setQueryString (const std::string &query)

Private Attributes
Tcp *	tcp = nullptr
std::string	clientIp
std::string	method
std::string	uri
std::string	path
std::string	query
std::string	host
std::string	protocol
std::map< std::string, std::string >	headers
std::string	body
std::string	rootCACertificate
size_t	headerEnd = 0
bool	bodyTruncated = false
std::string	outputFilePath

Detailed Description

Represents a parsed HTTP request, providing access to headers, method, path, body, etc.

Examples

/home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/http/Middleware.h.

Definition at line 31 of file HttpRequest.h.

Constructor & Destructor Documentation

HttpRequest() [1/5]

HttpRequest::HttpRequest	(	const char *	rawHeaders,
		const std::string &	reqMethod,
		const std::string &	reqPath
	)

Construct a HttpRequest object and parse the URL and headers.

Parameters

rawHeaders	Raw HTTP headers as a C-string.
reqMethod	HTTP method.
reqPath	HttpRequest path.
rawHeaders	Raw header string.
reqMethod	HTTP method (GET, POST, etc.).
reqPath	HttpRequest URL path.

Definition at line 120 of file HttpRequest.cpp.

    : method(reqMethod), path(reqPath)
{
 
    uri = reqPath; // Store the original URL
    // Parse the URL to separate path and query string
    size_t pos = uri.find('?');
    if (pos != std::string::npos)
    {
        path = uri.substr(0, pos);
        query = uri.substr(pos + 1);
    }
    else
    {
        path = uri;
        query = "";
    }
    parseHeaders(rawHeaders);
}

References parseHeaders(), path, query, and uri.

Here is the call graph for this function:

HttpRequest() [2/5]

HttpRequest::HttpRequest ( const std::string &  raw, const std::string &  method, const std::string &  path  )

inline

Definition at line 47 of file HttpRequest.h.

        : method(method), uri(path), path(path) {}

HttpRequest() [3/5]

HttpRequest::HttpRequest ( Tcp *  connection, const std::string  rawHeaders, const std::string &  method, const std::string &  path  )

inline

Definition at line 51 of file HttpRequest.h.

        : tcp(connection), method(method), uri(path), path(path)
    {
        parseHeaders(rawHeaders.c_str());
    }

References parseHeaders().

Here is the call graph for this function:

HttpRequest() [4/5]

HttpRequest::HttpRequest ( )

default

Referenced by create(), and receive().

Here is the caller graph for this function:

HttpRequest() [5/5]

HttpRequest::HttpRequest ( const HttpRequest &  )

default

Member Function Documentation

appendRemainingBody()

bool HttpRequest::appendRemainingBody

(

int

expectedLength

)

Definition at line 224 of file HttpRequest.cpp.

                                                        {
    size_t remaining = expectedLength - body.size();
    char buffer[HTTP_BUFFER_SIZE];
 
    while (remaining > 0) {
        size_t toRead = std::min(remaining, sizeof(buffer));
        int received = tcp->recv(buffer, toRead, HTTP_RECEIVE_TIMEOUT); 
        if (received <= 0) {
            printf("Error receiving body chunk\n");
            return false;
        }
        size_t currentSize = body.size();
        if (currentSize >= MAX_HTTP_BODY_LENGTH) {
            TRACE("Body exceeds max length. Truncating.\n");
            markBodyTruncated();
            break;
        }
        size_t allowed = MAX_HTTP_BODY_LENGTH - currentSize;
        size_t toAppend = std::min(static_cast<size_t>(received), allowed);
        body.append(buffer, toAppend);
 
        if (toAppend < static_cast<size_t>(received)) {
            TRACE("Body chunk truncated due to size limit.\n");
            markBodyTruncated();
            break;
        }
        remaining -= received;
    }
    return true;
}

References body, HTTP_BUFFER_SIZE, HTTP_RECEIVE_TIMEOUT, markBodyTruncated(), MAX_HTTP_BODY_LENGTH, Tcp::recv(), tcp, and TRACE.

Referenced by receive().

Here is the call graph for this function:

Here is the caller graph for this function:

appendToBody()

void HttpRequest::appendToBody ( const char *  data, size_t  len  )

private

create()

HttpRequest HttpRequest::create ( )

static

Definition at line 412 of file HttpRequest.cpp.

{
    return HttpRequest("", "", "");
}

References HttpRequest().

Here is the call graph for this function:

del() [1/2]

HttpResponse HttpRequest::del

(

)

Definition at line 71 of file HttpRequest.cpp.

{
    setMethod("DELETE");
    return send();
}

References send(), and setMethod().

Here is the call graph for this function:

del() [2/2]

HttpResponse HttpRequest::del

(

const std::string &

url

)

Definition at line 93 of file HttpRequest.cpp.

{
    setMethod("DELETE");
    setUri(url);
    return send();
}

References send(), setMethod(), and setUri().

Here is the call graph for this function:

get() [1/2]

HttpResponse HttpRequest::get

(

)

Parameters

url	The URL to send the request to.

Returns

HttpResponse object containing the response.

Definition at line 46 of file HttpRequest.cpp.

{
    setMethod("GET");
    return send();
}

References send(), and setMethod().

Referenced by TimeManager::fetchAndApplyTimezoneFromOpenMeteo(), and TimeManager::getLocationFromIp().

Here is the call graph for this function:

Here is the caller graph for this function:

get() [2/2]

HttpResponse HttpRequest::get

(

const std::string &

url

)

Definition at line 52 of file HttpRequest.cpp.

{
    setMethod("GET");
    setUri(url);
    return send();
}

References send(), setMethod(), and setUri().

Here is the call graph for this function:

getBody()

const std::string & HttpRequest::getBody ( ) const

inline

Definition at line 232 of file HttpRequest.h.

    {
        return body;
    }

References body.

Referenced by JsonRequestHelper::getFullJson(), HttpServer::handleClient(), MultipartParser::handleMultipart(), and json().

Here is the caller graph for this function:

getBoundary()

const std::string HttpRequest::getBoundary ( ) const

inline

Returns

Boundary string or empty string if not present.

Definition at line 205 of file HttpRequest.h.

    {
        auto contentType = getContentType();
        auto boundaryPos = contentType.find("boundary=");
        if (boundaryPos != std::string::npos)
        {
            return contentType.substr(boundaryPos + 9);
        }
        return "";
    }

References getContentType().

Referenced by HttpServer::handleClient().

Here is the call graph for this function:

Here is the caller graph for this function:

getContentLength()

int HttpRequest::getContentLength ( ) const

inline

Returns

Content length in bytes, or 0 if absent.

Definition at line 263 of file HttpRequest.h.

    {
        std::string content_length_str = getHeader("content-length");
        int contentLength = 0;
        if (!content_length_str.empty())
        {
            contentLength = std::stoi(content_length_str);
        }
        return contentLength;
    }

References getHeader().

Referenced by HttpServer::handleClient(), and receive().

Here is the call graph for this function:

Here is the caller graph for this function:

getContentType()

const std::string HttpRequest::getContentType ( ) const

inline

Definition at line 196 of file HttpRequest.h.

    {
        return getHeader("content-type");
    }

References getHeader().

Referenced by getBoundary(), and HttpServer::handleClient().

Here is the call graph for this function:

Here is the caller graph for this function:

getCookie()

const std::string HttpRequest::getCookie

(

const std::string &

name

)

const

Get a specific cookie by name.

Parameters

name	Cookie name.

Returns

Cookie value or empty string.

Parameters

name	Cookie name.

Returns

std::string Value of the cookie or empty string.

Definition at line 381 of file HttpRequest.cpp.

{
    auto cookies = getCookies();
    auto it = cookies.find(name);
    return (it != cookies.end()) ? it->second : "";
}

References getCookies().

Here is the call graph for this function:

getCookies()

const std::unordered_map< std::string, std::string > HttpRequest::getCookies

(

)

const

Extract and return all cookies from the Cookie header.

Returns

A map of cookie names to values.

std::unordered_map<std::string, std::string> Map of cookie name-value pairs.

Definition at line 354 of file HttpRequest.cpp.

{
    std::unordered_map<std::string, std::string> cookies;
    std::string cookieHeader = getHeader("cookie");
    std::istringstream stream(cookieHeader);
    std::string pair;
    while (std::getline(stream, pair, ';'))
    {
        size_t eq = pair.find('=');
        if (eq != std::string::npos)
        {
            std::string key = pair.substr(0, eq);
            std::string value = pair.substr(eq + 1);
            key.erase(0, key.find_first_not_of(" \t"));
            value.erase(0, value.find_first_not_of(" \t"));
            cookies[key] = value;
        }
    }
    return cookies;
}

References getHeader().

Referenced by getCookie(), and HttpServer::handleClient().

Here is the call graph for this function:

Here is the caller graph for this function:

getFormParams()

const std::unordered_multimap< std::string, std::string > HttpRequest::getFormParams

(

)

Parse the request body as form-urlencoded content.

Returns

Map of form parameters.

Definition at line 403 of file HttpRequest.cpp.

{
    return parseUrlEncoded(body);
}

References body, and parseUrlEncoded().

Referenced by HttpServer::handleClient().

Here is the call graph for this function:

Here is the caller graph for this function:

getHeader()

std::string HttpRequest::getHeader ( const std::string &  field ) const

inline

Parameters

field

Header field name.

Returns

The header value or empty string if not found.

Definition at line 114 of file HttpRequest.h.

    {
        auto it = headers.find(toLower(field));
        return (it != headers.end()) ? it->second : "";
    }

References headers, and toLower().

Referenced by Router::getAuthorizationToken(), getContentLength(), getContentType(), getCookies(), HttpServer::handleClient(), MultipartParser::handleMultipart(), isMultipart(), and FrameworkManager::warmUp().

Here is the call graph for this function:

Here is the caller graph for this function:

getHeaderEnd()

size_t HttpRequest::getHeaderEnd ( )

inline

Returns

Byte offset.

Definition at line 153 of file HttpRequest.h.

    {
        return headerEnd;
    }

References headerEnd.

Referenced by HttpServer::handleClient().

Here is the caller graph for this function:

getHeaders()

const std::map< std::string, std::string > & HttpRequest::getHeaders ( ) const

inline

Returns

Map of header key-value pairs.

Definition at line 124 of file HttpRequest.h.

    {
        return headers;
    }

References headers.

Referenced by HttpServer::handleClient(), and receive().

Here is the caller graph for this function:

getHost()

const std::string & HttpRequest::getHost ( ) const

inline

Definition at line 161 of file HttpRequest.h.

    {
        return host;
    }

References host.

getMethod()

const std::string & HttpRequest::getMethod ( ) const

inline

Definition at line 311 of file HttpRequest.h.

    {
        return method;
    }

References method.

Referenced by HttpServer::handleClient(), and Router::handleRequest().

Here is the caller graph for this function:

getMethodAndPath()

bool HttpRequest::getMethodAndPath ( const std::string &  rawHeaders, std::string &  method, std::string &  path  )

static

Extract HTTP method and path from request line.

Parameters

buffer	Raw request buffer.
method	Output buffer for method.
path	Output buffer for path.

Returns

True on success.

Parameters

buffer	The raw request buffer.
clientSocket	The client socket (not used, included for consistency).
method	Output buffer for method.
path	Output buffer for path.

Returns

true on success, false on failure.

Definition at line 174 of file HttpRequest.cpp.

{
    TRACE("Parsing request data: %s\n", rawHeaders.c_str());
    std::istringstream stream(rawHeaders);
    std::string requestLine;
    if (!std::getline(stream, requestLine)) {
        printf("Failed to read request line\n");
        return false;
    }
    
    std::istringstream lineStream(requestLine);
    if (!(lineStream >> method >> path)) {
        printf("Error parsing HTTP request method and path\n");
        return false;
    }
    return true;
}

References method, path, and TRACE.

Referenced by receive().

Here is the caller graph for this function:

getOutputFilePath()

std::string HttpRequest::getOutputFilePath

(

)

const

Definition at line 530 of file HttpRequest.cpp.

                                               {
    return outputFilePath;
}

References outputFilePath.

getPath()

const std::string & HttpRequest::getPath ( ) const

inline

Definition at line 319 of file HttpRequest.h.

    {
        return path;
    }

References path.

Referenced by HttpFileserver::handle_list_directory(), HttpFileserver::handle_static_request(), HttpServer::handleClient(), and Router::handleRequest().

Here is the caller graph for this function:

getProtocol()

const std::string & HttpRequest::getProtocol ( ) const

inline

Definition at line 166 of file HttpRequest.h.

    {
        return protocol;
    }

References protocol.

getQuery()

const std::string & HttpRequest::getQuery ( ) const

inline

Definition at line 335 of file HttpRequest.h.

    {
        return query;
    }

References query.

Referenced by HttpServer::handleClient().

Here is the caller graph for this function:

getQueryParams()

const std::unordered_multimap< std::string, std::string > HttpRequest::getQueryParams

(

)

Parse the query string into a key-value map.

Returns

Map of query parameters.

Definition at line 393 of file HttpRequest.cpp.

{
    return parseUrlEncoded(query);
}

References parseUrlEncoded(), and query.

Referenced by HttpServer::handleClient(), and GpioController::handleGetMultipleGpios().

Here is the call graph for this function:

Here is the caller graph for this function:

getRootCACertificate()

const std::string & HttpRequest::getRootCACertificate ( ) const

inline

Returns

const std::string& PEM-encoded root certificate.

Definition at line 444 of file HttpRequest.h.

    {
        return rootCACertificate;
    }

References rootCACertificate.

getTcp()

Tcp * HttpRequest::getTcp ( ) const

inline

Definition at line 344 of file HttpRequest.h.

    {
        return tcp;
    }

References tcp.

Referenced by MultipartParser::handleMultipart().

Here is the caller graph for this function:

getUri()

const std::string & HttpRequest::getUri ( ) const

inline

Definition at line 327 of file HttpRequest.h.

    {
        return uri;
    }

References uri.

Referenced by HttpServer::handleClient().

Here is the caller graph for this function:

handle_multipart()

int HttpRequest::handle_multipart

(

HttpResponse &

res

)

Handle multipart/form-data content using MultipartParser.

Parameters

res	Reference to the response.

Returns

0 on success, -1 on failure.

Parameters

clientSocket	The client socket.
req	Reference to this request.

Returns

int 0 on success, -1 on failure.

Definition at line 343 of file HttpRequest.cpp.

{
    MultipartParser parser;
    return parser.handleMultipart(*this, res) ? 0 : -1;
}

References MultipartParser::handleMultipart().

Referenced by DashboardController::uploadHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

isBodyTruncated()

bool HttpRequest::isBodyTruncated ( ) const

inline

Definition at line 238 of file HttpRequest.h.

{ return bodyTruncated; }

References bodyTruncated.

isFormUrlEncoded()

bool HttpRequest::isFormUrlEncoded ( ) const

inline

Definition at line 178 of file HttpRequest.h.

    {
        auto it = headers.find("content-type");
        return it != headers.end() && it->second.find("application/x-www-form-urlencoded") != std::string::npos;
    }

References headers.

isJson()

bool HttpRequest::isJson ( ) const

inline

Definition at line 187 of file HttpRequest.h.

    {
        auto it = headers.find("content-type");
        return it != headers.end() && it->second.find("application/json") != std::string::npos;
    }

References headers.

Referenced by JsonRequestHelper::getFullJson().

Here is the caller graph for this function:

isMultipart()

bool HttpRequest::isMultipart ( ) const

inline

Definition at line 219 of file HttpRequest.h.

    {
        auto contentType = getHeader("content-type");
        return contentType.find("multipart/form-data") != std::string::npos;
    }

References getHeader().

Referenced by HttpServer::handleClient(), and receive().

Here is the call graph for this function:

Here is the caller graph for this function:

json()

nlohmann::json HttpRequest::json ( ) const

inline

Returns an empty object if parsing fails.

Returns

nlohmann::json Parsed JSON object or empty on failure.

Definition at line 281 of file HttpRequest.h.

    {
        return nlohmann::json::parse(getBody(), nullptr, false);
    }

References getBody().

Referenced by setJson().

Here is the call graph for this function:

Here is the caller graph for this function:

markBodyTruncated()

void HttpRequest::markBodyTruncated ( )

inline

Definition at line 239 of file HttpRequest.h.

{ bodyTruncated = true; }

References bodyTruncated.

Referenced by appendRemainingBody().

Here is the caller graph for this function:

parseHeaders()

void HttpRequest::parseHeaders ( const char *  raw )

private

Definition at line 160 of file HttpRequest.cpp.

{
    headers = HttpParser::parseHeaders(raw);
}

References headers, and HttpParser::parseHeaders().

Referenced by HttpRequest(), and HttpRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

post() [1/2]

HttpResponse HttpRequest::post

(

)

Definition at line 59 of file HttpRequest.cpp.

{
    setMethod("POST");
    return send();
}

References send(), and setMethod().

Here is the call graph for this function:

post() [2/2]

HttpResponse HttpRequest::post	(	const std::string &	url,
		const std::string &	body
	)

Definition at line 77 of file HttpRequest.cpp.

{
    setMethod("POST");
    setUri(url);
    setBody(body);
    return send();
}

References body, send(), setBody(), setMethod(), and setUri().

Here is the call graph for this function:

printHeaders()

void HttpRequest::printHeaders ( ) const

inline

Definition at line 132 of file HttpRequest.h.

    {
        for (const auto &header : headers)
        {
            std::cout << header.first << ": " << header.second << std::endl;
        }
    }

References headers.

put() [1/2]

HttpResponse HttpRequest::put

(

)

Definition at line 65 of file HttpRequest.cpp.

{
    setMethod("PUT");
    return send();
}

References send(), and setMethod().

Here is the call graph for this function:

put() [2/2]

HttpResponse HttpRequest::put	(	const std::string &	url,
		const std::string &	body
	)

Definition at line 85 of file HttpRequest.cpp.

{
    setMethod("PUT");
    setUri(url);
    setBody(body);
    return send();
}

References body, send(), setBody(), setMethod(), and setUri().

Here is the call graph for this function:

receive()

HttpRequest HttpRequest::receive ( Tcp *  tcp )

static

Receive raw bytes from the client socket into a buffer.

Parameters

Instance

of tcp

Returns

A fully populated HttpRequest object.

Parameters

Tcp*	The TCP connection to read from.

Returns

HttpRequest Parsed HttpRequest object containing method, path, headers, and body.

Note

This function reads the request line, headers, and body from the TCP socket. It handles both multipart and non-multipart requests, parsing headers and body accordingly.

Definition at line 266 of file HttpRequest.cpp.

{
    TRACE("Receiving request on socket %d\n", tcp->getSocketFd());
 
    char buffer[BUFFER_SIZE];                   // Declare buffer size
    std::string body = "";                      // Initialize empty body
    std::map<std::string, std::string> headers; // Initialize empty headers
    std::string method = {0};                      // Initialize method buffer
    std::string path = {0};               // Initialize path buffer
 
    auto result = receiveUntilHeadersComplete(tcp);
    if (!result) {
        return HttpRequest("", "", "");
    }
    
    const auto& [rawHeaders, initialBody] = *result;
 
    if (!getMethodAndPath(rawHeaders, method, path)) {
        return HttpRequest("", "", "");
    }
 
    // Create the request which will parse the headers
    TRACE("Raw headers: %s\n", rawHeaders.c_str());
 
    HttpRequest request(tcp, rawHeaders, std::string(method), std::string(path));
    request.setBody(initialBody); // Set the initial body if any
 
    // NOW split path and query
    std::string cleanPath = path;
    std::string queryString = "";
 
    size_t qpos = cleanPath.find('?');
    if (qpos != std::string::npos)
    {
        queryString = cleanPath.substr(qpos + 1);
        cleanPath = cleanPath.substr(0, qpos);
    }
    request.setPath(cleanPath); // Set the cleaned path as the URI
    request.setQueryString(queryString); // Set the query string
 
    // Get headers from the HttpRequest object
    headers = request.getHeaders();
 
    TRACE("Parsed headers:\n");
    for (const auto &header : headers)
    {
        TRACE("%s: %s\n", header.first.c_str(), header.second.c_str());
    }
 
    int contentLength = request.getContentLength();
    TRACE("Content-Length: %d\n", contentLength);
 
    if (contentLength > 0)
    {
        TRACE("Content-Length is greater than 0\n");
        if (request.isMultipart())
        {
            TRACE("Multipart request detected\n");
            return request;
        }
 
        TRACE("Non-multipart request detected\n");
 
        request.appendRemainingBody(contentLength);
        TRACE("Final body length: %zu\n", body.length());
        TRACE("HttpRequest object constructed\n");
    }
    return request;
}

References appendRemainingBody(), body, BUFFER_SIZE, getContentLength(), getHeaders(), getMethodAndPath(), Tcp::getSocketFd(), headers, HttpRequest(), isMultipart(), method, path, receiveUntilHeadersComplete(), setBody(), setPath(), setQueryString(), tcp, and TRACE.

Referenced by HttpServer::handleClient().

Here is the call graph for this function:

Here is the caller graph for this function:

receiveUntilHeadersComplete()

std::optional< std::pair< std::string, std::string > > HttpRequest::receiveUntilHeadersComplete ( Tcp *  conn )

static

Definition at line 194 of file HttpRequest.cpp.

                                                                                             {
    std::string requestText;
    char buffer[HTTP_BUFFER_SIZE];
 
    while (true) {
        int received = conn->recv(buffer, sizeof(buffer), HTTP_RECEIVE_TIMEOUT);
        if (received <= 0) {
            printf("[HttpRequest] Failed to receive header - usually Safari reusing socket it shouldn't\n");
            return std::nullopt;
        }
 
        requestText.append(buffer, received);
 
        size_t headerEnd = requestText.find("\r\n\r\n");
        if (headerEnd != std::string::npos) {
            size_t bodyStart = headerEnd + 4;
            std::string headers = requestText.substr(0, headerEnd);
            std::string leftover = (bodyStart < requestText.size())
                ? requestText.substr(bodyStart)
                : "";
            return std::make_pair(std::move(headers), std::move(leftover));
        }
 
        if (requestText.size() > MAX_HEADER_BYTES) {
            printf("[HttpRequest] Headers exceeded %zu bytes, rejecting\n", MAX_HEADER_BYTES);
            return std::nullopt;
        }
    }
}

References headerEnd, headers, HTTP_BUFFER_SIZE, HTTP_RECEIVE_TIMEOUT, MAX_HEADER_BYTES, and Tcp::recv().

Referenced by receive().

Here is the call graph for this function:

Here is the caller graph for this function:

send()

HttpResponse HttpRequest::send

(

)

Returns

HttpResponse object containing the response.

Definition at line 100 of file HttpRequest.cpp.

{
#ifdef PICO_HTTP_ENABLE_HTTP_CLIENT
    HttpResponse response;
    HttpClient client;
    client.sendRequest(*this, response);
    return response;
#else
    // If HTTP client is not enabled, return an empty response
    return HttpResponse(nullptr);
#endif
}

Referenced by del(), del(), get(), get(), post(), post(), put(), and put().

Here is the caller graph for this function:

setAcceptEncoding()

HttpRequest & HttpRequest::setAcceptEncoding

(

const std::string &

encoding

)

Definition at line 485 of file HttpRequest.cpp.

{
    headers["Accept-Encoding"] = encoding;
    return *this;
}

References headers.

setBody()

HttpRequest & HttpRequest::setBody

(

const std::string &

body

)

Parameters

aBody

The full request body content.

Definition at line 140 of file HttpRequest.cpp.

{
    body = b;
    return *this;
}

References body.

Referenced by post(), put(), and receive().

Here is the caller graph for this function:

setHeader()

HttpRequest & HttpRequest::setHeader	(	const std::string &	key,
		const std::string &	value
	)

Definition at line 473 of file HttpRequest.cpp.

{
    headers[key] = value;
    return *this;
}

References headers.

Referenced by setJson(), setJson(), and FrameworkManager::warmUp().

Here is the caller graph for this function:

setHeaderEnd()

void HttpRequest::setHeaderEnd ( size_t  end )

inline

Parameters

end	Offset into the raw request.

Definition at line 144 of file HttpRequest.h.

    {
        headerEnd = end;
    }

References headerEnd.

setHeaders()

HttpRequest & HttpRequest::setHeaders

(

const std::map< std::string, std::string > &

headers

)

Definition at line 464 of file HttpRequest.cpp.

{
    for (const auto &[k, v] : headers)
    {
        this->headers[k] = v;
    }
    return *this;
}

References headers.

setHost()

HttpRequest & HttpRequest::setHost

(

const std::string &

host

)

Definition at line 452 of file HttpRequest.cpp.

{
    host = h;
    return *this;
}

References host.

setJson() [1/2]

HttpRequest & HttpRequest::setJson

(

const nlohmann::json &

json

)

Parameters

json	JSON object to set as body.

Definition at line 153 of file HttpRequest.cpp.

{
    setHeader("Content-Type", "application/json");
    body = json.dump();
    return *this;
}

References body, and setHeader().

Here is the call graph for this function:

setJson() [2/2]

HttpRequest & HttpRequest::setJson

(

const std::string &

json

)

Parameters

json	JSON string to set as body.

Definition at line 146 of file HttpRequest.cpp.

{
    setHeader("Content-Type", "application/json");
    body = json;
    return *this;
}

References body, json(), and setHeader().

Here is the call graph for this function:

setMethod()

HttpRequest & HttpRequest::setMethod ( const std::string &  method )

inline

Definition at line 293 of file HttpRequest.h.

    {
        this->method = method;
        return *this;
    }

References method.

Referenced by del(), del(), get(), get(), post(), post(), put(), put(), and FrameworkManager::warmUp().

Here is the caller graph for this function:

setPath()

HttpRequest & HttpRequest::setPath ( const std::string &  path )

inline

Definition at line 302 of file HttpRequest.h.

    {
        this->path = path;
        return *this;
    }

References path.

Referenced by receive(), and FrameworkManager::warmUp().

Here is the caller graph for this function:

setProtocol()

HttpRequest & HttpRequest::setProtocol

(

const std::string &

protocol

)

Definition at line 458 of file HttpRequest.cpp.

{
    protocol = p;
    return *this;
}

References protocol.

setQueryString()

void HttpRequest::setQueryString ( const std::string &  query )

inlineprivate

Definition at line 457 of file HttpRequest.h.

    {
        this->query = query;
    }

References query.

Referenced by receive().

Here is the caller graph for this function:

setRootCACertificate()

HttpRequest & HttpRequest::setRootCACertificate

(

const std::string &

certData

)

Parameters

certData

PEM-encoded certificate.

Definition at line 490 of file HttpRequest.cpp.

{
    rootCACertificate = certData;
    return *this;
}

References rootCACertificate.

setUri()

HttpRequest & HttpRequest::setUri

(

const std::string &

uri

)

Parses the uri into protocol, host, and path. But not if it is just a /path

Parameters

uri	The URI to set.

Returns

Reference to this request.

Definition at line 423 of file HttpRequest.cpp.

{
    const auto proto_end = uri.find("://");
    if (proto_end == std::string::npos)
    {
        // Relative URI — just set it, do not overwrite protocol or host
        this->uri = uri;
        return *this;
    }
 
    // Full URL — parse into protocol, host, and path
    protocol = uri.substr(0, proto_end);
    std::string rest = uri.substr(proto_end + 3); // skip "://"
 
    const auto path_start = rest.find('/');
    if (path_start == std::string::npos)
    {
        host = rest;
        this->uri = "/";
    }
    else
    {
        host = rest.substr(0, path_start);
        this->uri = rest.substr(path_start);
    }
 
    return *this;
}

References host, protocol, and uri.

Referenced by del(), get(), post(), and put().

Here is the caller graph for this function:

setUserAgent()

HttpRequest & HttpRequest::setUserAgent

(

const std::string &

userAgent

)

Definition at line 479 of file HttpRequest.cpp.

{
    headers["User-Agent"] = userAgent;
    return *this;
}

References headers.

toFile()

HttpRequest & HttpRequest::toFile

(

const std::string &

path

)

Definition at line 521 of file HttpRequest.cpp.

                                                      {
    this->outputFilePath = path;
    return *this;
}

References outputFilePath, and path.

wantsToFile()

bool HttpRequest::wantsToFile

(

)

const

Definition at line 526 of file HttpRequest.cpp.

                                    {
    return !outputFilePath.empty();
}

References outputFilePath.

Member Data Documentation

body

std::string HttpRequest::body

private

Definition at line 472 of file HttpRequest.h.

Referenced by appendRemainingBody(), getBody(), getFormParams(), post(), put(), receive(), setBody(), setJson(), and setJson().

bodyTruncated

bool HttpRequest::bodyTruncated = false

private

Definition at line 475 of file HttpRequest.h.

Referenced by isBodyTruncated(), and markBodyTruncated().

clientIp

std::string HttpRequest::clientIp

private

Definition at line 464 of file HttpRequest.h.

headerEnd

size_t HttpRequest::headerEnd = 0

private

Definition at line 474 of file HttpRequest.h.

Referenced by getHeaderEnd(), receiveUntilHeadersComplete(), and setHeaderEnd().

headers

std::map<std::string, std::string> HttpRequest::headers

private

Definition at line 471 of file HttpRequest.h.

Referenced by getHeader(), getHeaders(), isFormUrlEncoded(), isJson(), parseHeaders(), printHeaders(), receive(), receiveUntilHeadersComplete(), setAcceptEncoding(), setHeader(), setHeaders(), and setUserAgent().

host

std::string HttpRequest::host

private

Definition at line 469 of file HttpRequest.h.

Referenced by getHost(), setHost(), and setUri().

method

std::string HttpRequest::method

private

Definition at line 465 of file HttpRequest.h.

Referenced by getMethod(), getMethodAndPath(), receive(), and setMethod().

outputFilePath

std::string HttpRequest::outputFilePath

private

Definition at line 476 of file HttpRequest.h.

Referenced by getOutputFilePath(), toFile(), and wantsToFile().

path

std::string HttpRequest::path

private

Definition at line 467 of file HttpRequest.h.

Referenced by getMethodAndPath(), getPath(), HttpRequest(), receive(), setPath(), and toFile().

protocol

std::string HttpRequest::protocol

private

Definition at line 470 of file HttpRequest.h.

Referenced by getProtocol(), setProtocol(), and setUri().

query

std::string HttpRequest::query

private

Definition at line 468 of file HttpRequest.h.

Referenced by getQuery(), getQueryParams(), HttpRequest(), and setQueryString().

rootCACertificate

std::string HttpRequest::rootCACertificate

private

Definition at line 473 of file HttpRequest.h.

Referenced by getRootCACertificate(), and setRootCACertificate().

tcp

Tcp* HttpRequest::tcp = nullptr

private

Definition at line 462 of file HttpRequest.h.

Referenced by appendRemainingBody(), getTcp(), and receive().

uri

std::string HttpRequest::uri

private

Definition at line 466 of file HttpRequest.h.

Referenced by getUri(), HttpRequest(), and setUri().

---

The documentation for this class was generated from the following files:

• HttpRequest.h
• HttpRequest.cpp