#pragma once #include #include #include #include #include /* needed for ssize_t */ #include "httpd-platform.h" #include "httpd-types.h" #include "httpd-routes.h" #include "httpd-config.h" /** * Get the server version string * * @return version */ const char *httpdGetVersion(void); /** * Set server name (Should not be on stack - the pointer must live as long as the server! Const is preferable.) * * @param name - new server name */ void httpdSetName(const char *name); /** * Redirect to the given URL. * * Sets the status code to 302, adds the Location header and a simple redirect text body. * * @param conn - connection * @param newUrl - URL to redirect to */ void httpdRedirect(HttpdConnData *conn, const char *newUrl); /** * Start the HTTP server * * @param fixedUrls - array of defined URLs * @param options - server options * @return server thread handle or NULL on error */ httpd_thread_handle_t *httpdStart(const HttpdBuiltInUrl *fixedUrls, struct httpd_init_options *options); /** * Shutdown the server & wait for the thread to end. * * @param handle */ void httpdShutdown(httpd_thread_handle_t *handle); /** * Join the server thread. * This is mainly useful in the posix build to block while the server runs. * * @param handle */ void httpdJoin(httpd_thread_handle_t *handle); /** * Set transfer mode for the current connection * * @param conn * @param mode - transfer mode */ void httdSetTransferMode(HttpdConnData *conn, httpd_transfer_opt mode); /** * Start a HTTP response. Sends the HTTP line and common headers. * More headers can be added before starting the message body. * * @param conn * @param code - HTTP status code */ void httpdStartResponse(HttpdConnData *conn, int code); /** * Add a HTTP header * * @param conn * @param field - name * @param val - value */ void httpdHeader(HttpdConnData *conn, const char *field, const char *val); /** * End headers, start sending body * * @param conn */ void httpdEndHeaders(HttpdConnData *conn); /** * Read value of a request header * * @param conn * @param header - name * @param[out] buff - buffer for the header value, will be zero terminated * @param buffLen - capacity of the buffer * @return 1 = OK */ int httpdGetHeader(HttpdConnData *conn, const char *header, char *buff, size_t buffLen); /** * Get pointer to a request header's value, if found. This is a way to read headers without * copying or being limited by the copy buffer length. * * The returned string is a view into the headers buffer. The header is 0-terminated. * * @param conn * @param header - name * @return pointer to the header value, or NULL */ const char * httpdGetHeaderPtr(HttpdConnData *conn, const char *header); /** * Queue a header to be sent with the response. * * @param conn * @param header - name * @param value - value * @return 1 = OK */ void httpdQueueHeader(HttpdConnData *conn, const char *header, const char *value); /** * Queue a header to be sent with the response. This is a variant of `httpdQueueHeader()` * which uses the raw internal struct to avoid re-alloc. * * The variable length field of the struct must contain `HeaderName: HeaderValue + CR LF` * * @param conn * @param queEntry * @return 1 = OK */ bool httpdQueueHeaderRaw(HttpdConnData *conn, HttpdQueuedHeader *queEntry); /** * Set cookie. This queues the cookie header - can only be called before headers are sent. * * @param conn * @param parm * @return */ bool httpdSetCookie(HttpdConnData *conn, const SetCookie *parm); /** * Get cookie value, if present * * @param conn * @param name - cookie name * @param buff - copy buf * @param buffLen - buf len * @return 1 = OK */ bool httpdGetCookie(HttpdConnData *conn, const char *name, char *buff, size_t buffLen); /** * Send binary data * * @param conn * @param data - data to send * @param len - num bytes. -1 to use strlen. * @return 1 = OK */ int httpdSend(HttpdConnData *conn, const uint8_t *data, size_t len); /** * Send a string. The length is measured using strlen. * * @param conn * @param data - string * @return 1 = OK */ static inline int httpdSendStr(HttpdConnData *conn, const char *data) { return httpdSend(conn, (const uint8_t *) data, strlen(data)); } /** * Send a string with custom length. This is a slight optimization over httpdSendStr when the length is known. * * @param conn * @param data - string * @param len - num bytes * @return 1 = OK */ static inline int httpdSendStrN(HttpdConnData *conn, const char *data, size_t len) { return httpdSend(conn, (const uint8_t *) data, len); } // TODO convert to a general escaped send function /** * Send text with JSON escaping * * @param conn * @param data - string * @param len - string length, -1 to use strlen() * @return 1 = OK */ int httpdSend_js(HttpdConnData *conn, const char *data, ssize_t len); /** * Send text with HTML escaping. Escapes quotes and angle brackets. * * @param conn * @param data - string * @param len - string length, -1 to use strlen() * @return 1 = OK */ int httpdSend_html(HttpdConnData *conn, const char *data, ssize_t len); /** * Function to send any data in conn->priv->sendBuff. Do not use in CGIs unless you know what you * are doing! Also, if you do set conn->cgi to NULL to indicate the connection is closed, do it BEFORE * calling this. * Returns false if data could not be sent nor put in backlog. * * @param conn * @return 1 = OK */ bool httpdFlushSendBuffer(HttpdConnData *conn); /** * Can be called after a CGI function has returned HTTPD_CGI_MORE to * resume handling an open connection asynchronously * * @param conn */ void httpdContinue(HttpdConnData *conn); /** * Make a connection 'live' so we can do all the things a cgi can do to it. * * @param conn */ void httpdConnSendStart(HttpdConnData *conn); /** * Finish the live-ness of a connection. Always call this after httpdConnStart * * @param conn */ void httpdConnSendFinish(HttpdConnData *conn); /** * Add sensible cache control headers to avoid needless asset reloading. * * @param connData * @param mime - mime type string */ void httpdAddCacheHeaders(HttpdConnData *connData, const char *mime); /** * Get current HTTP backlog size * * @param connData * @return bytes */ size_t httpGetBacklogSize(const HttpdConnData *connData); /** * Set HTTP response options * * @param conn * @param cors 0 = don't add CORS header */ void httdResponseOptions(HttpdConnData *conn, int cors); //Platform dependent code should call these. /** * Callback called when the data on a socket has been successfully sent. * * @param conn * @param remIp - remote IP (4 bytes) * @param remPort - remote port */ void httpdSentCb(ConnTypePtr conn, httpd_ipaddr_t remIp, uint16_t remPort); /** * Callback called when there's data available on a socket. * * @param conn * @param remIp - remote IP (4 bytes) * @param remPort - remote port * @param data - data received. This is a mutable buffer * @param len - data len */ void httpdRecvCb(ConnTypePtr conn, httpd_ipaddr_t remIp, uint16_t remPort, uint8_t *data, size_t len); /** * The platform layer should ALWAYS call this function, regardless if the connection is closed by the server * or by the client. * * @param conn * @param remIp - remote IP (4 bytes) * @param remPort - remote port */ void httpdDisconCb(ConnTypePtr conn, httpd_ipaddr_t remIp, uint16_t remPort); /** * Connect callback - a client connected * * @param conn * @param remIp - remote IP (4 bytes) * @param remPort - remote port * @return 1 = OK, 0 = client couldn't be served */ int httpdConnectCb(ConnTypePtr conn, httpd_ipaddr_t remIp, uint16_t remPort); /** * Low level function to close & release a connection * * @param conn */ void httpdConnRelease(ConnTypePtr conn); /** * Close and retire all sockets. * Called during httpd shutdown. * * @internal */ void httpdInternalCloseAllSockets(void);